Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.affinda.api.client.AffindaAPI Maven / Gradle / Ivy
package com.affinda.api.client;
import com.affinda.api.client.models.Annotation;
import com.affinda.api.client.models.AnnotationBatchUpdate;
import com.affinda.api.client.models.AnnotationCreate;
import com.affinda.api.client.models.AnnotationUpdate;
import com.affinda.api.client.models.AnnotationWithValidationResults;
import com.affinda.api.client.models.AnotationDelete;
import com.affinda.api.client.models.ApiUserCreate;
import com.affinda.api.client.models.ApiUserUpdate;
import com.affinda.api.client.models.ApiUserWithKey;
import com.affinda.api.client.models.ApiUserWithoutKey;
import com.affinda.api.client.models.BatchAddTagRequest;
import com.affinda.api.client.models.BatchDeleteAnnotationsResponse;
import com.affinda.api.client.models.BatchRemoveTagRequest;
import com.affinda.api.client.models.CollectionField;
import com.affinda.api.client.models.DataField;
import com.affinda.api.client.models.DataFieldCreate;
import com.affinda.api.client.models.DataPoint;
import com.affinda.api.client.models.DataPointChoice;
import com.affinda.api.client.models.DataPointChoiceCreate;
import com.affinda.api.client.models.DataPointChoiceReplaceRequest;
import com.affinda.api.client.models.DataPointChoiceReplaceResponse;
import com.affinda.api.client.models.DataPointChoiceUpdate;
import com.affinda.api.client.models.DataPointCreate;
import com.affinda.api.client.models.DataPointUpdate;
import com.affinda.api.client.models.DateRange;
import com.affinda.api.client.models.Document;
import com.affinda.api.client.models.DocumentCollection;
import com.affinda.api.client.models.DocumentCollectionCreate;
import com.affinda.api.client.models.DocumentCollectionUpdate;
import com.affinda.api.client.models.DocumentCreate;
import com.affinda.api.client.models.DocumentEditRequest;
import com.affinda.api.client.models.DocumentFormat;
import com.affinda.api.client.models.DocumentState;
import com.affinda.api.client.models.DocumentUpdate;
import com.affinda.api.client.models.Enum20;
import com.affinda.api.client.models.Extractor;
import com.affinda.api.client.models.ExtractorCreate;
import com.affinda.api.client.models.ExtractorUpdate;
import com.affinda.api.client.models.Index;
import com.affinda.api.client.models.IndexCreate;
import com.affinda.api.client.models.IndexUpdate;
import com.affinda.api.client.models.Invitation;
import com.affinda.api.client.models.InvitationCreate;
import com.affinda.api.client.models.InvitationResponse;
import com.affinda.api.client.models.InvitationStatus;
import com.affinda.api.client.models.InvitationUpdate;
import com.affinda.api.client.models.JobDescriptionSearch;
import com.affinda.api.client.models.JobDescriptionSearchConfig;
import com.affinda.api.client.models.JobDescriptionSearchDetail;
import com.affinda.api.client.models.JobDescriptionSearchEmbed;
import com.affinda.api.client.models.JobDescriptionSearchParameters;
import com.affinda.api.client.models.Mapping;
import com.affinda.api.client.models.MappingCreate;
import com.affinda.api.client.models.MappingDataSource;
import com.affinda.api.client.models.MappingDataSourceCreate;
import com.affinda.api.client.models.MappingUpdate;
import com.affinda.api.client.models.Meta;
import com.affinda.api.client.models.OccupationGroup;
import com.affinda.api.client.models.Organization;
import com.affinda.api.client.models.OrganizationCreate;
import com.affinda.api.client.models.OrganizationMembership;
import com.affinda.api.client.models.OrganizationMembershipUpdate;
import com.affinda.api.client.models.OrganizationRole;
import com.affinda.api.client.models.Paths11QdcofV3MappingDataSourcesGetResponses200ContentApplicationJsonSchema;
import com.affinda.api.client.models.Paths18Wh2VcV3InvitationsGetResponses200ContentApplicationJsonSchema;
import com.affinda.api.client.models.Paths1Czpnk1V3ResumeSearchEmbedPostRequestbodyContentApplicationJsonSchema;
import com.affinda.api.client.models.Paths1D5Zg6MV3AnnotationsGetResponses200ContentApplicationJsonSchema;
import com.affinda.api.client.models.Paths1Dpvb2PV3MappingsGetResponses200ContentApplicationJsonSchema;
import com.affinda.api.client.models.Paths1Qr7BnyV3MappingDataSourcesIdentifierValuesGetResponses200ContentApplicationJsonSchema;
import com.affinda.api.client.models.Paths26Civ0V3ApiUsersGetResponses200ContentApplicationJsonSchema;
import com.affinda.api.client.models.PathsCl024WV3IndexNameDocumentsPostRequestbodyContentApplicationJsonSchema;
import com.affinda.api.client.models.PathsDvrcp3V3IndexGetResponses200ContentApplicationJsonSchema;
import com.affinda.api.client.models.PathsFte27NV3IndexNameDocumentsPostResponses201ContentApplicationJsonSchema;
import com.affinda.api.client.models.PathsM3DzbgV3JobDescriptionSearchEmbedPostRequestbodyContentApplicationJsonSchema;
import com.affinda.api.client.models.PathsMnwxgV3DataPointChoicesGetResponses200ContentApplicationJsonSchema;
import com.affinda.api.client.models.PathsO7SnenV3IndexNameDocumentsGetResponses200ContentApplicationJsonSchema;
import com.affinda.api.client.models.PathsOxm5M7V3DocumentsGetResponses200ContentApplicationJsonSchema;
import com.affinda.api.client.models.PathsQ5Os5RV3OrganizationMembershipsGetResponses200ContentApplicationJsonSchema;
import com.affinda.api.client.models.PathsVz5Kj2V3ResthookSubscriptionsGetResponses200ContentApplicationJsonSchema;
import com.affinda.api.client.models.PathsZ1JuagV3WorkspaceMembershipsGetResponses200ContentApplicationJsonSchema;
import com.affinda.api.client.models.Region;
import com.affinda.api.client.models.RequestErrorException;
import com.affinda.api.client.models.ResthookSubscription;
import com.affinda.api.client.models.ResthookSubscriptionCreate;
import com.affinda.api.client.models.ResthookSubscriptionUpdate;
import com.affinda.api.client.models.ResumeSearch;
import com.affinda.api.client.models.ResumeSearchConfig;
import com.affinda.api.client.models.ResumeSearchDetail;
import com.affinda.api.client.models.ResumeSearchEmbed;
import com.affinda.api.client.models.ResumeSearchMatch;
import com.affinda.api.client.models.ResumeSearchParameters;
import com.affinda.api.client.models.Tag;
import com.affinda.api.client.models.TagCreate;
import com.affinda.api.client.models.TagUpdate;
import com.affinda.api.client.models.UsageByCollection;
import com.affinda.api.client.models.UsageByWorkspace;
import com.affinda.api.client.models.ValidationResult;
import com.affinda.api.client.models.ValidationResultCreate;
import com.affinda.api.client.models.ValidationResultUpdate;
import com.affinda.api.client.models.ValidationToolConfig;
import com.affinda.api.client.models.Workspace;
import com.affinda.api.client.models.WorkspaceCreate;
import com.affinda.api.client.models.WorkspaceMembership;
import com.affinda.api.client.models.WorkspaceMembershipCreate;
import com.affinda.api.client.models.WorkspaceUpdate;
import com.azure.core.annotation.BodyParam;
import com.azure.core.annotation.Delete;
import com.azure.core.annotation.ExpectedResponses;
import com.azure.core.annotation.Get;
import com.azure.core.annotation.HeaderParam;
import com.azure.core.annotation.Host;
import com.azure.core.annotation.HostParam;
import com.azure.core.annotation.Patch;
import com.azure.core.annotation.PathParam;
import com.azure.core.annotation.Post;
import com.azure.core.annotation.Put;
import com.azure.core.annotation.QueryParam;
import com.azure.core.annotation.ReturnType;
import com.azure.core.annotation.ServiceInterface;
import com.azure.core.annotation.ServiceMethod;
import com.azure.core.annotation.UnexpectedResponseExceptionType;
import com.azure.core.http.HttpPipeline;
import com.azure.core.http.HttpPipelineBuilder;
import com.azure.core.http.policy.CookiePolicy;
import com.azure.core.http.policy.RetryPolicy;
import com.azure.core.http.policy.UserAgentPolicy;
import com.azure.core.http.rest.Response;
import com.azure.core.http.rest.RestProxy;
import com.azure.core.util.serializer.CollectionFormat;
import com.azure.core.util.serializer.JacksonAdapter;
import com.azure.core.util.serializer.SerializerAdapter;
import java.nio.ByteBuffer;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
/** Initializes a new instance of the AffindaAPI type. */
public final class AffindaAPI {
/** The proxy service used to perform REST calls. */
private final AffindaAPIService service;
/** region - server parameter. */
private final Region region;
/**
* Gets region - server parameter.
*
* @return the region value.
*/
public Region getRegion() {
return this.region;
}
/** The HTTP pipeline to send requests through. */
private final HttpPipeline httpPipeline;
/**
* Gets The HTTP pipeline to send requests through.
*
* @return the httpPipeline value.
*/
public HttpPipeline getHttpPipeline() {
return this.httpPipeline;
}
/** The serializer to serialize an object into a string. */
private final SerializerAdapter serializerAdapter;
/**
* Gets The serializer to serialize an object into a string.
*
* @return the serializerAdapter value.
*/
public SerializerAdapter getSerializerAdapter() {
return this.serializerAdapter;
}
/**
* Initializes an instance of AffindaAPI client.
*
* @param region region - server parameter.
*/
AffindaAPI(Region region) {
this(
new HttpPipelineBuilder()
.policies(new UserAgentPolicy(), new RetryPolicy(), new CookiePolicy())
.build(),
JacksonAdapter.createDefaultSerializerAdapter(),
region);
}
/**
* Initializes an instance of AffindaAPI client.
*
* @param httpPipeline The HTTP pipeline to send requests through.
* @param region region - server parameter.
*/
AffindaAPI(HttpPipeline httpPipeline, Region region) {
this(httpPipeline, JacksonAdapter.createDefaultSerializerAdapter(), region);
}
/**
* Initializes an instance of AffindaAPI client.
*
* @param httpPipeline The HTTP pipeline to send requests through.
* @param serializerAdapter The serializer to serialize an object into a string.
* @param region region - server parameter.
*/
AffindaAPI(HttpPipeline httpPipeline, SerializerAdapter serializerAdapter, Region region) {
this.httpPipeline = httpPipeline;
this.serializerAdapter = serializerAdapter;
this.region = region;
this.service = RestProxy.create(AffindaAPIService.class, this.httpPipeline, this.getSerializerAdapter());
}
/** The interface defining all the services for AffindaAPI to be used by the proxy service to perform REST calls. */
@Host("https://{region}.affinda.com")
@ServiceInterface(name = "AffindaAPI")
public interface AffindaAPIService {
@Get("/v3/workspaces")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>> getAllWorkspaces(
@HostParam("region") Region region,
@QueryParam("organization") String organization,
@QueryParam("name") String name,
@HeaderParam("Accept") String accept);
@Post("/v3/workspaces")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createWorkspace(
@HostParam("region") Region region,
@BodyParam("application/json") WorkspaceCreate body,
@HeaderParam("Accept") String accept);
@Get("/v3/workspaces/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getWorkspace(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Patch("/v3/workspaces/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateWorkspace(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@BodyParam("application/json") WorkspaceUpdate body,
@HeaderParam("Accept") String accept);
@Delete("/v3/workspaces/{identifier}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteWorkspace(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Get("/v3/workspaces/{identifier}/usage")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>> getUsageByWorkspace(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@QueryParam("start") String start,
@QueryParam("end") String end,
@HeaderParam("Accept") String accept);
@Get("/v3/workspace_memberships")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>
getAllWorkspaceMemberships(
@HostParam("region") Region region,
@QueryParam("offset") Integer offset,
@QueryParam("limit") Integer limit,
@QueryParam("workspace") String workspace,
@QueryParam("user") String user,
@HeaderParam("Accept") String accept);
@Post("/v3/workspace_memberships")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createWorkspaceMembership(
@HostParam("region") Region region,
@BodyParam("application/json") WorkspaceMembershipCreate body,
@HeaderParam("Accept") String accept);
@Get("/v3/workspace_memberships/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getWorkspaceMembership(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Delete("/v3/workspace_memberships/{identifier}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteWorkspaceMembership(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Get("/v3/collections")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>> getAllCollections(
@HostParam("region") Region region,
@QueryParam("workspace") String workspace,
@HeaderParam("Accept") String accept);
@Post("/v3/collections")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createCollection(
@HostParam("region") Region region,
@BodyParam("application/json") DocumentCollectionCreate body,
@HeaderParam("Accept") String accept);
@Get("/v3/collections/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getCollection(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Patch("/v3/collections/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateCollection(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@BodyParam("application/json") DocumentCollectionUpdate body,
@HeaderParam("Accept") String accept);
@Delete("/v3/collections/{identifier}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteCollection(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Post("/v3/collections/{identifier}/create_data_field")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createDataFieldForCollection(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@BodyParam("application/json") DataFieldCreate body,
@HeaderParam("Accept") String accept);
@Get("/v3/collections/{identifier}/fields/{datapoint_identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getDataFieldForCollection(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@PathParam("datapoint_identifier") String datapointIdentifier,
@HeaderParam("Accept") String accept);
@Patch("/v3/collections/{identifier}/fields/{datapoint_identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateDataFieldForCollection(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@PathParam("datapoint_identifier") String datapointIdentifier,
@BodyParam("application/json") CollectionField body,
@HeaderParam("Accept") String accept);
@Get("/v3/collections/{identifier}/usage")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>> getUsageByCollection(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@QueryParam("start") String start,
@QueryParam("end") String end,
@HeaderParam("Accept") String accept);
@Get("/v3/documents")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getAllDocuments(
@HostParam("region") Region region,
@QueryParam("offset") Integer offset,
@QueryParam("limit") Integer limit,
@QueryParam("workspace") String workspace,
@QueryParam("collection") String collection,
@QueryParam("state") DocumentState state,
@QueryParam("tags") String tags,
@QueryParam("created_dt") DateRange createdDt,
@QueryParam("search") String search,
@QueryParam("ordering") String ordering,
@QueryParam("include_data") Boolean includeData,
@QueryParam("exclude") String exclude,
@QueryParam("in_review") Boolean inReview,
@QueryParam("failed") Boolean failed,
@QueryParam("ready") Boolean ready,
@QueryParam("validatable") Boolean validatable,
@QueryParam("has_challenges") Boolean hasChallenges,
@QueryParam("custom_identifier") String customIdentifier,
@QueryParam("compact") Boolean compact,
@QueryParam("count") Boolean count,
@HeaderParam("Accept") String accept);
@Post("/v3/documents")
@ExpectedResponses({200, 201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createDocument(
@HostParam("region") Region region,
@BodyParam("application/json") DocumentCreate body,
@HeaderParam("Accept") String accept);
@Get("/v3/documents/{identifier}")
@ExpectedResponses({200, 200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getDocument(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@QueryParam("format") DocumentFormat format,
@QueryParam("compact") Boolean compact,
@HeaderParam("Accept") String accept);
@Patch("/v3/documents/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateDocument(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@BodyParam("application/json") DocumentUpdate body,
@HeaderParam("Accept") String accept);
@Delete("/v3/documents/{identifier}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteDocument(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Post("/v3/documents/{identifier}/update_data")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateDocumentData(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@BodyParam("application/json") Object body,
@HeaderParam("Accept") String accept);
@Post("/v3/documents/batch_add_tag")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> batchAddTag(
@HostParam("region") Region region,
@BodyParam("application/json") BatchAddTagRequest body,
@HeaderParam("Accept") String accept);
@Post("/v3/documents/batch_remove_tag")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> batchRemoveTag(
@HostParam("region") Region region,
@BodyParam("application/json") BatchRemoveTagRequest body,
@HeaderParam("Accept") String accept);
@Post("/v3/validate/{identifier}/split")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>> editDocumentPages(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@BodyParam("application/json") DocumentEditRequest body,
@HeaderParam("Accept") String accept);
@Get("/v3/validation_results")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>> getAllValidationResults(
@HostParam("region") Region region,
@QueryParam("offset") Integer offset,
@QueryParam("limit") Integer limit,
@QueryParam("document") String document,
@HeaderParam("Accept") String accept);
@Post("/v3/validation_results")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createValidationResult(
@HostParam("region") Region region,
@BodyParam("application/json") ValidationResultCreate body,
@HeaderParam("Accept") String accept);
@Get("/v3/validation_results/{id}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getValidationResult(
@HostParam("region") Region region, @PathParam("id") int id, @HeaderParam("Accept") String accept);
@Patch("/v3/validation_results/{id}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateValidationResult(
@HostParam("region") Region region,
@PathParam("id") int id,
@BodyParam("application/json") ValidationResultUpdate body,
@HeaderParam("Accept") String accept);
@Delete("/v3/validation_results/{id}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteValidationResult(
@HostParam("region") Region region, @PathParam("id") int id, @HeaderParam("Accept") String accept);
@Get("/v3/extractors")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>> getAllExtractors(
@HostParam("region") Region region,
@QueryParam("organization") String organization,
@QueryParam("include_public_extractors") Boolean includePublicExtractors,
@QueryParam("name") String name,
@QueryParam("validatable") Boolean validatable,
@HeaderParam("Accept") String accept);
@Post("/v3/extractors")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createExtractor(
@HostParam("region") Region region,
@BodyParam("application/json") ExtractorCreate body,
@HeaderParam("Accept") String accept);
@Get("/v3/extractors/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getExtractor(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Patch("/v3/extractors/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateExtractor(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@BodyParam("application/json") ExtractorUpdate body,
@HeaderParam("Accept") String accept);
@Delete("/v3/extractors/{identifier}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteExtractor(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Get("/v3/data_points")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>> getAllDataPoints(
@HostParam("region") Region region,
@QueryParam("offset") Integer offset,
@QueryParam("limit") Integer limit,
@QueryParam("organization") String organization,
@QueryParam("include_public") Boolean includePublic,
@QueryParam("extractor") String extractor,
@QueryParam("slug") String slug,
@QueryParam("description") String description,
@QueryParam("annotation_content_type") String annotationContentType,
@QueryParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Post("/v3/data_points")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createDataPoint(
@HostParam("region") Region region,
@BodyParam("application/json") DataPointCreate body,
@HeaderParam("Accept") String accept);
@Get("/v3/data_points/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getDataPoint(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Patch("/v3/data_points/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateDataPoint(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@BodyParam("application/json") DataPointUpdate body,
@HeaderParam("Accept") String accept);
@Delete("/v3/data_points/{identifier}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteDataPoint(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Get("/v3/data_point_choices")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getDataPointChoices(
@HostParam("region") Region region,
@QueryParam("offset") Integer offset,
@QueryParam("limit") Integer limit,
@QueryParam("data_point") String dataPoint,
@QueryParam("collection") String collection,
@QueryParam("search") String search,
@HeaderParam("Accept") String accept);
@Post("/v3/data_point_choices")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createDataPointChoice(
@HostParam("region") Region region,
@BodyParam("application/json") DataPointChoiceCreate body,
@HeaderParam("Accept") String accept);
@Get("/v3/data_point_choices/{id}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getDataPointChoice(
@HostParam("region") Region region, @PathParam("id") int id, @HeaderParam("Accept") String accept);
@Patch("/v3/data_point_choices/{id}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateDataPointChoice(
@HostParam("region") Region region,
@PathParam("id") int id,
@BodyParam("application/json") DataPointChoiceUpdate body,
@HeaderParam("Accept") String accept);
@Delete("/v3/data_point_choices/{id}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteDataPointChoice(
@HostParam("region") Region region, @PathParam("id") int id, @HeaderParam("Accept") String accept);
@Post("/v3/data_point_choices/replace")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> replaceDataPointChoices(
@HostParam("region") Region region,
@BodyParam("application/json") DataPointChoiceReplaceRequest body,
@HeaderParam("Accept") String accept);
@Get("/v3/annotations")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getAllAnnotations(
@HostParam("region") Region region,
@QueryParam("document") String document,
@HeaderParam("Accept") String accept);
@Post("/v3/annotations")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createAnnotation(
@HostParam("region") Region region,
@BodyParam("application/json") AnnotationCreate body,
@HeaderParam("Accept") String accept);
@Get("/v3/annotations/{id}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getAnnotation(
@HostParam("region") Region region, @PathParam("id") int id, @HeaderParam("Accept") String accept);
@Patch("/v3/annotations/{id}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateAnnotation(
@HostParam("region") Region region,
@PathParam("id") int id,
@BodyParam("application/json") AnnotationUpdate body,
@HeaderParam("Accept") String accept);
@Delete("/v3/annotations/{id}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteAnnotation(
@HostParam("region") Region region, @PathParam("id") int id, @HeaderParam("Accept") String accept);
@Post("/v3/annotations/batch_create")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>> batchCreateAnnotations(
@HostParam("region") Region region,
@BodyParam("application/json") List body,
@HeaderParam("Accept") String accept);
@Post("/v3/annotations/batch_update")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>> batchUpdateAnnotations(
@HostParam("region") Region region,
@BodyParam("application/json") List body,
@HeaderParam("Accept") String accept);
@Post("/v3/annotations/batch_delete")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> batchDeleteAnnotations(
@HostParam("region") Region region,
@BodyParam("application/json") List body,
@HeaderParam("Accept") String accept);
@Post("/v3/mapping_data_sources")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createMappingDataSource(
@HostParam("region") Region region,
@BodyParam("application/json") MappingDataSourceCreate body,
@HeaderParam("Accept") String accept);
@Get("/v3/mapping_data_sources")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>
listMappingDataSources(
@HostParam("region") Region region,
@QueryParam("offset") Integer offset,
@QueryParam("limit") Integer limit,
@HeaderParam("Accept") String accept);
@Get("/v3/mapping_data_sources/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getMappingDataSource(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Delete("/v3/mapping_data_sources/{identifier}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteMappingDataSource(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Get("/v3/mapping_data_sources/{identifier}/values")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>
listMappingDataSourceValues(
@HostParam("region") Region region,
@QueryParam("limit") Integer limit,
@QueryParam("offset") Integer offset,
@QueryParam("search") String search,
@QueryParam("annotation") Integer annotation,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Put("/v3/mapping_data_sources/{identifier}/values")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>> replaceMappingDataSourceValues(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@BodyParam("application/json") List body,
@HeaderParam("Accept") String accept);
@Post("/v3/mapping_data_sources/{identifier}/values")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> addMappingDataSourceValue(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@BodyParam("application/json") Object body,
@HeaderParam("Accept") String accept);
@Get("/v3/mapping_data_sources/{identifier}/values/{value}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getMappingDataSourceValue(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@PathParam("value") String value,
@HeaderParam("Accept") String accept);
@Delete("/v3/mapping_data_sources/{identifier}/values/{value}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteMappingDataSourceValue(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@PathParam("value") String value,
@HeaderParam("Accept") String accept);
@Post("/v3/mappings")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createMapping(
@HostParam("region") Region region,
@BodyParam("application/json") MappingCreate body,
@HeaderParam("Accept") String accept);
@Get("/v3/mappings")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> listMappings(
@HostParam("region") Region region,
@QueryParam("offset") Integer offset,
@QueryParam("limit") Integer limit,
@QueryParam("mapping_data_source") String mappingDataSource,
@HeaderParam("Accept") String accept);
@Get("/v3/mappings/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getMapping(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Delete("/v3/mappings/{identifier}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteMapping(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Patch("/v3/mappings/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateMapping(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@BodyParam("application/json") MappingUpdate body,
@HeaderParam("Accept") String accept);
@Get("/v3/tags")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>> getAllTags(
@HostParam("region") Region region,
@QueryParam("limit") Integer limit,
@QueryParam("offset") Integer offset,
@QueryParam("workspace") String workspace,
@HeaderParam("Accept") String accept);
@Post("/v3/tags")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createTag(
@HostParam("region") Region region,
@BodyParam("application/json") TagCreate body,
@HeaderParam("Accept") String accept);
@Get("/v3/tags/{id}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getTag(
@HostParam("region") Region region, @PathParam("id") int id, @HeaderParam("Accept") String accept);
@Patch("/v3/tags/{id}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateTag(
@HostParam("region") Region region,
@PathParam("id") int id,
@BodyParam("application/json") TagUpdate body,
@HeaderParam("Accept") String accept);
@Delete("/v3/tags/{id}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteTag(
@HostParam("region") Region region, @PathParam("id") int id, @HeaderParam("Accept") String accept);
@Get("/v3/organizations")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>> getAllOrganizations(
@HostParam("region") Region region, @HeaderParam("Accept") String accept);
@Post("/v3/organizations")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createOrganization(
@HostParam("region") Region region,
@BodyParam("application/json") OrganizationCreate body,
@HeaderParam("Accept") String accept);
@Get("/v3/organizations/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getOrganization(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
// @Multipart not supported by RestProxy
@Patch("/v3/organizations/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateOrganization(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@BodyParam("multipart/form-data") String name,
@BodyParam("multipart/form-data") Flux avatar,
@HeaderParam("Content-Length") Long contentLength,
@BodyParam("multipart/form-data") String resthookSignatureKey,
@BodyParam("multipart/form-data") ValidationToolConfig validationToolConfig,
@HeaderParam("Accept") String accept);
@Delete("/v3/organizations/{identifier}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteOrganization(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Get("/v3/organization_memberships")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>
getAllOrganizationMemberships(
@HostParam("region") Region region,
@QueryParam("offset") Integer offset,
@QueryParam("limit") Integer limit,
@QueryParam("organization") String organization,
@QueryParam("role") OrganizationRole role,
@HeaderParam("Accept") String accept);
@Get("/v3/organization_memberships/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getOrganizationMembership(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Patch("/v3/organization_memberships/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateOrganizationMembership(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@BodyParam("application/json") OrganizationMembershipUpdate body,
@HeaderParam("Accept") String accept);
@Delete("/v3/organization_memberships/{identifier}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteOrganizationMembership(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Get("/v3/invitations")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getAllInvitations(
@HostParam("region") Region region,
@QueryParam("offset") Integer offset,
@QueryParam("limit") Integer limit,
@QueryParam("organization") String organization,
@QueryParam("status") InvitationStatus status,
@QueryParam("role") OrganizationRole role,
@HeaderParam("Accept") String accept);
@Post("/v3/invitations")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createInvitation(
@HostParam("region") Region region,
@BodyParam("application/json") InvitationCreate body,
@HeaderParam("Accept") String accept);
@Get("/v3/invitations/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getInvitation(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Patch("/v3/invitations/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateInvitation(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@BodyParam("application/json") InvitationUpdate body,
@HeaderParam("Accept") String accept);
@Delete("/v3/invitations/{identifier}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteInvitation(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Get("/v3/invitations/token/{token}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getInvitationByToken(
@HostParam("region") Region region,
@PathParam("token") String token,
@HeaderParam("Accept") String accept);
@Patch("/v3/invitations/token/{token}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> respondToInvitation(
@HostParam("region") Region region,
@PathParam("token") String token,
@BodyParam("application/json") InvitationResponse body,
@HeaderParam("Accept") String accept);
@Get("/v3/api_users")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getAllApiUsers(
@HostParam("region") Region region,
@QueryParam("organization") String organization,
@HeaderParam("Accept") String accept);
@Post("/v3/api_users")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createApiUser(
@HostParam("region") Region region,
@BodyParam("application/json") ApiUserCreate body,
@HeaderParam("Accept") String accept);
@Get("/v3/api_users/{id}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getApiUser(
@HostParam("region") Region region, @PathParam("id") int id, @HeaderParam("Accept") String accept);
@Patch("/v3/api_users/{id}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateApiUser(
@HostParam("region") Region region,
@PathParam("id") int id,
@BodyParam("application/json") ApiUserUpdate body,
@HeaderParam("Accept") String accept);
@Delete("/v3/api_users/{id}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteApiUser(
@HostParam("region") Region region, @PathParam("id") int id, @HeaderParam("Accept") String accept);
@Post("/v3/api_users/{id}/regenerate_api_key")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> regenerateApiKeyForApiUser(
@HostParam("region") Region region, @PathParam("id") int id, @HeaderParam("Accept") String accept);
@Get("/v3/resthook_subscriptions")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>
getAllResthookSubscriptions(
@HostParam("region") Region region,
@QueryParam("offset") Integer offset,
@QueryParam("limit") Integer limit,
@HeaderParam("Accept") String accept);
@Post("/v3/resthook_subscriptions")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createResthookSubscription(
@HostParam("region") Region region,
@BodyParam("application/json") ResthookSubscriptionCreate body,
@HeaderParam("Accept") String accept);
@Get("/v3/resthook_subscriptions/{id}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getResthookSubscription(
@HostParam("region") Region region, @PathParam("id") int id, @HeaderParam("Accept") String accept);
@Patch("/v3/resthook_subscriptions/{id}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateResthookSubscription(
@HostParam("region") Region region,
@PathParam("id") int id,
@BodyParam("application/json") ResthookSubscriptionUpdate body,
@HeaderParam("Accept") String accept);
@Delete("/v3/resthook_subscriptions/{id}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteResthookSubscription(
@HostParam("region") Region region, @PathParam("id") int id, @HeaderParam("Accept") String accept);
@Post("/v3/resthook_subscriptions/activate")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> activateResthookSubscription(
@HostParam("region") Region region,
@HeaderParam("X-Hook-Secret") String xHookSecret,
@HeaderParam("Accept") String accept);
@Get("/v3/occupation_groups")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>> listOccupationGroups(
@HostParam("region") Region region, @HeaderParam("Accept") String accept);
@Post("/v3/job_description_search")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createJobDescriptionSearch(
@HostParam("region") Region region,
@QueryParam("offset") Integer offset,
@QueryParam("limit") Integer limit,
@BodyParam("application/json") JobDescriptionSearchParameters body,
@HeaderParam("Accept") String accept);
@Post("/v3/job_description_search/details/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getJobDescriptionSearchDetail(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@BodyParam("application/json") JobDescriptionSearchParameters body,
@HeaderParam("Accept") String accept);
@Get("/v3/job_description_search/config")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getJobDescriptionSearchConfig(
@HostParam("region") Region region, @HeaderParam("Accept") String accept);
@Patch("/v3/job_description_search/config")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateJobDescriptionSearchConfig(
@HostParam("region") Region region,
@BodyParam("application/json") JobDescriptionSearchConfig body,
@HeaderParam("Accept") String accept);
@Post("/v3/job_description_search/embed")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createJobDescriptionSearchEmbedUrl(
@HostParam("region") Region region,
@BodyParam("application/json")
PathsM3DzbgV3JobDescriptionSearchEmbedPostRequestbodyContentApplicationJsonSchema body,
@HeaderParam("Accept") String accept);
@Get("/v3/index")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getAllIndexes(
@HostParam("region") Region region,
@QueryParam("offset") Integer offset,
@QueryParam("limit") Integer limit,
@QueryParam("document_type") Enum20 documentType,
@HeaderParam("Accept") String accept);
@Post("/v3/index")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createIndex(
@HostParam("region") Region region,
@BodyParam("application/json") IndexCreate body,
@HeaderParam("Accept") String accept);
@Patch("/v3/index/{name}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateIndex(
@HostParam("region") Region region,
@PathParam("name") String name,
@BodyParam("application/json") IndexUpdate body,
@HeaderParam("Accept") String accept);
@Delete("/v3/index/{name}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteIndex(
@HostParam("region") Region region,
@PathParam("name") String name,
@HeaderParam("Accept") String accept);
@Get("/v3/index/{name}/documents")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getAllIndexDocuments(
@HostParam("region") Region region,
@QueryParam("offset") Integer offset,
@QueryParam("limit") Integer limit,
@PathParam("name") String name,
@HeaderParam("Accept") String accept);
@Post("/v3/index/{name}/documents")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createIndexDocument(
@HostParam("region") Region region,
@PathParam("name") String name,
@BodyParam("application/json")
PathsCl024WV3IndexNameDocumentsPostRequestbodyContentApplicationJsonSchema body,
@HeaderParam("Accept") String accept);
@Delete("/v3/index/{name}/documents/{identifier}")
@ExpectedResponses({204})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> deleteIndexDocument(
@HostParam("region") Region region,
@PathParam("name") String name,
@PathParam("identifier") String identifier,
@HeaderParam("Accept") String accept);
@Post("/v3/resume_search")
@ExpectedResponses({201})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createResumeSearch(
@HostParam("region") Region region,
@QueryParam("offset") Integer offset,
@QueryParam("limit") Integer limit,
@BodyParam("application/json") ResumeSearchParameters body,
@HeaderParam("Accept") String accept);
@Post("/v3/resume_search/details/{identifier}")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getResumeSearchDetail(
@HostParam("region") Region region,
@PathParam("identifier") String identifier,
@BodyParam("application/json") ResumeSearchParameters body,
@HeaderParam("Accept") String accept);
@Get("/v3/resume_search/match")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getResumeSearchMatch(
@HostParam("region") Region region,
@QueryParam("resume") String resume,
@QueryParam("job_description") String jobDescription,
@QueryParam("index") String index,
@QueryParam("search_expression") String searchExpression,
@QueryParam("job_titles_weight") Float jobTitlesWeight,
@QueryParam("years_experience_weight") Float yearsExperienceWeight,
@QueryParam("locations_weight") Float locationsWeight,
@QueryParam("languages_weight") Float languagesWeight,
@QueryParam("skills_weight") Float skillsWeight,
@QueryParam("education_weight") Float educationWeight,
@QueryParam("search_expression_weight") Float searchExpressionWeight,
@QueryParam("soc_codes_weight") Float socCodesWeight,
@QueryParam("management_level_weight") Float managementLevelWeight,
@HeaderParam("Accept") String accept);
@Get("/v3/resume_search/config")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> getResumeSearchConfig(
@HostParam("region") Region region, @HeaderParam("Accept") String accept);
@Patch("/v3/resume_search/config")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> updateResumeSearchConfig(
@HostParam("region") Region region,
@BodyParam("application/json") ResumeSearchConfig body,
@HeaderParam("Accept") String accept);
@Post("/v3/resume_search/embed")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono> createResumeSearchEmbedUrl(
@HostParam("region") Region region,
@BodyParam("application/json")
Paths1Czpnk1V3ResumeSearchEmbedPostRequestbodyContentApplicationJsonSchema body,
@HeaderParam("Accept") String accept);
@Get("/v3/resume_search/suggestion_job_title")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>> getResumeSearchSuggestionJobTitle(
@HostParam("region") Region region,
@QueryParam(value = "job_titles", multipleQueryParams = true) List jobTitles,
@HeaderParam("Accept") String accept);
@Get("/v3/resume_search/suggestion_skill")
@ExpectedResponses({200})
@UnexpectedResponseExceptionType(
value = RequestErrorException.class,
code = {400, 401})
@UnexpectedResponseExceptionType(RequestErrorException.class)
Mono>> getResumeSearchSuggestionSkill(
@HostParam("region") Region region,
@QueryParam(value = "skills", multipleQueryParams = true) List skills,
@HeaderParam("Accept") String accept);
}
/**
* Returns your workspaces.
*
* @param organization Filter by organization.
* @param name Filter by name.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return array of Workspace along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono>> getAllWorkspacesWithResponseAsync(String organization, String name) {
final String accept = "application/json";
return service.getAllWorkspaces(this.getRegion(), organization, name, accept);
}
/**
* Returns your workspaces.
*
* @param organization Filter by organization.
* @param name Filter by name.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return array of Workspace on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> getAllWorkspacesAsync(String organization, String name) {
return getAllWorkspacesWithResponseAsync(organization, name)
.flatMap(
(Response> res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Returns your workspaces.
*
* @param organization Filter by organization.
* @param name Filter by name.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return array of Workspace.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public List getAllWorkspaces(String organization, String name) {
return getAllWorkspacesAsync(organization, name).block();
}
/**
* Create a workspace.
*
* @param body Workspace to create.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> createWorkspaceWithResponseAsync(WorkspaceCreate body) {
final String accept = "application/json";
return service.createWorkspace(this.getRegion(), body, accept);
}
/**
* Create a workspace.
*
* @param body Workspace to create.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono createWorkspaceAsync(WorkspaceCreate body) {
return createWorkspaceWithResponseAsync(body)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Create a workspace.
*
* @param body Workspace to create.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Workspace createWorkspace(WorkspaceCreate body) {
return createWorkspaceAsync(body).block();
}
/**
* Return a specific workspace.
*
* @param identifier Workspace's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> getWorkspaceWithResponseAsync(String identifier) {
final String accept = "application/json";
return service.getWorkspace(this.getRegion(), identifier, accept);
}
/**
* Return a specific workspace.
*
* @param identifier Workspace's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono getWorkspaceAsync(String identifier) {
return getWorkspaceWithResponseAsync(identifier)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Return a specific workspace.
*
* @param identifier Workspace's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Workspace getWorkspace(String identifier) {
return getWorkspaceAsync(identifier).block();
}
/**
* Update a workspace.
*
* @param identifier Workspace's identifier.
* @param body Workspace data to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> updateWorkspaceWithResponseAsync(String identifier, WorkspaceUpdate body) {
final String accept = "application/json";
return service.updateWorkspace(this.getRegion(), identifier, body, accept);
}
/**
* Update a workspace.
*
* @param identifier Workspace's identifier.
* @param body Workspace data to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono updateWorkspaceAsync(String identifier, WorkspaceUpdate body) {
return updateWorkspaceWithResponseAsync(identifier, body)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Update a workspace.
*
* @param identifier Workspace's identifier.
* @param body Workspace data to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Workspace updateWorkspace(String identifier, WorkspaceUpdate body) {
return updateWorkspaceAsync(identifier, body).block();
}
/**
* Deletes the specified workspace from the database.
*
* @param identifier Workspace's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> deleteWorkspaceWithResponseAsync(String identifier) {
final String accept = "application/json";
return service.deleteWorkspace(this.getRegion(), identifier, accept);
}
/**
* Deletes the specified workspace from the database.
*
* @param identifier Workspace's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return A {@link Mono} that completes when a successful response is received.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono deleteWorkspaceAsync(String identifier) {
return deleteWorkspaceWithResponseAsync(identifier).flatMap((Response res) -> Mono.empty());
}
/**
* Deletes the specified workspace from the database.
*
* @param identifier Workspace's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public void deleteWorkspace(String identifier) {
deleteWorkspaceAsync(identifier).block();
}
/**
* Return monthly credits consumption of a workspace.
*
* @param identifier Workspace's identifier.
* @param start Start date of the period to retrieve. Format: YYYY-MM.
* @param end End date of the period to retrieve. Format: YYYY-MM.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return monthly credits consumption along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono>> getUsageByWorkspaceWithResponseAsync(
String identifier, String start, String end) {
final String accept = "application/json";
return service.getUsageByWorkspace(this.getRegion(), identifier, start, end, accept);
}
/**
* Return monthly credits consumption of a workspace.
*
* @param identifier Workspace's identifier.
* @param start Start date of the period to retrieve. Format: YYYY-MM.
* @param end End date of the period to retrieve. Format: YYYY-MM.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return monthly credits consumption on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> getUsageByWorkspaceAsync(String identifier, String start, String end) {
return getUsageByWorkspaceWithResponseAsync(identifier, start, end)
.flatMap(
(Response> res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Return monthly credits consumption of a workspace.
*
* @param identifier Workspace's identifier.
* @param start Start date of the period to retrieve. Format: YYYY-MM.
* @param end End date of the period to retrieve. Format: YYYY-MM.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return monthly credits consumption.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public List getUsageByWorkspace(String identifier, String start, String end) {
return getUsageByWorkspaceAsync(identifier, start, end).block();
}
/**
* Returns the memberships of your workspaces.
*
* @param offset The number of documents to skip before starting to collect the result set.
* @param limit The numbers of results to return.
* @param workspace Filter by workspace.
* @param user Partial text match on user's email, case-insensitive.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono>
getAllWorkspaceMembershipsWithResponseAsync(Integer offset, Integer limit, String workspace, String user) {
final String accept = "application/json";
return service.getAllWorkspaceMemberships(this.getRegion(), offset, limit, workspace, user, accept);
}
/**
* Returns the memberships of your workspaces.
*
* @param offset The number of documents to skip before starting to collect the result set.
* @param limit The numbers of results to return.
* @param workspace Filter by workspace.
* @param user Partial text match on user's email, case-insensitive.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono
getAllWorkspaceMembershipsAsync(Integer offset, Integer limit, String workspace, String user) {
return getAllWorkspaceMembershipsWithResponseAsync(offset, limit, workspace, user)
.flatMap(
(Response
res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Returns the memberships of your workspaces.
*
* @param offset The number of documents to skip before starting to collect the result set.
* @param limit The numbers of results to return.
* @param workspace Filter by workspace.
* @param user Partial text match on user's email, case-insensitive.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public PathsZ1JuagV3WorkspaceMembershipsGetResponses200ContentApplicationJsonSchema getAllWorkspaceMemberships(
Integer offset, Integer limit, String workspace, String user) {
return getAllWorkspaceMembershipsAsync(offset, limit, workspace, user).block();
}
/**
* Create a workspace membership.
*
* @param body The body parameter.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> createWorkspaceMembershipWithResponseAsync(
WorkspaceMembershipCreate body) {
final String accept = "application/json";
return service.createWorkspaceMembership(this.getRegion(), body, accept);
}
/**
* Create a workspace membership.
*
* @param body The body parameter.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono createWorkspaceMembershipAsync(WorkspaceMembershipCreate body) {
return createWorkspaceMembershipWithResponseAsync(body)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Create a workspace membership.
*
* @param body The body parameter.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public WorkspaceMembership createWorkspaceMembership(WorkspaceMembershipCreate body) {
return createWorkspaceMembershipAsync(body).block();
}
/**
* Return a specific workspace membership.
*
* @param identifier Workspace membership's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> getWorkspaceMembershipWithResponseAsync(String identifier) {
final String accept = "application/json";
return service.getWorkspaceMembership(this.getRegion(), identifier, accept);
}
/**
* Return a specific workspace membership.
*
* @param identifier Workspace membership's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono getWorkspaceMembershipAsync(String identifier) {
return getWorkspaceMembershipWithResponseAsync(identifier)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Return a specific workspace membership.
*
* @param identifier Workspace membership's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public WorkspaceMembership getWorkspaceMembership(String identifier) {
return getWorkspaceMembershipAsync(identifier).block();
}
/**
* Remove an user from a workspace.
*
* @param identifier Workspace membership's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> deleteWorkspaceMembershipWithResponseAsync(String identifier) {
final String accept = "application/json";
return service.deleteWorkspaceMembership(this.getRegion(), identifier, accept);
}
/**
* Remove an user from a workspace.
*
* @param identifier Workspace membership's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return A {@link Mono} that completes when a successful response is received.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono deleteWorkspaceMembershipAsync(String identifier) {
return deleteWorkspaceMembershipWithResponseAsync(identifier).flatMap((Response res) -> Mono.empty());
}
/**
* Remove an user from a workspace.
*
* @param identifier Workspace membership's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public void deleteWorkspaceMembership(String identifier) {
deleteWorkspaceMembershipAsync(identifier).block();
}
/**
* Returns your collections.
*
* @param workspace Filter by workspace.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return array of DocumentCollection along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono>> getAllCollectionsWithResponseAsync(String workspace) {
final String accept = "application/json";
return service.getAllCollections(this.getRegion(), workspace, accept);
}
/**
* Returns your collections.
*
* @param workspace Filter by workspace.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return array of DocumentCollection on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> getAllCollectionsAsync(String workspace) {
return getAllCollectionsWithResponseAsync(workspace)
.flatMap(
(Response> res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Returns your collections.
*
* @param workspace Filter by workspace.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return array of DocumentCollection.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public List getAllCollections(String workspace) {
return getAllCollectionsAsync(workspace).block();
}
/**
* Create a collection.
*
* @param body The body parameter.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> createCollectionWithResponseAsync(DocumentCollectionCreate body) {
final String accept = "application/json";
return service.createCollection(this.getRegion(), body, accept);
}
/**
* Create a collection.
*
* @param body The body parameter.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono createCollectionAsync(DocumentCollectionCreate body) {
return createCollectionWithResponseAsync(body)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Create a collection.
*
* @param body The body parameter.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public DocumentCollection createCollection(DocumentCollectionCreate body) {
return createCollectionAsync(body).block();
}
/**
* Return a specific collection.
*
* @param identifier Collection's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> getCollectionWithResponseAsync(String identifier) {
final String accept = "application/json";
return service.getCollection(this.getRegion(), identifier, accept);
}
/**
* Return a specific collection.
*
* @param identifier Collection's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono getCollectionAsync(String identifier) {
return getCollectionWithResponseAsync(identifier)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Return a specific collection.
*
* @param identifier Collection's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public DocumentCollection getCollection(String identifier) {
return getCollectionAsync(identifier).block();
}
/**
* Update data of a collection.
*
* @param identifier Collection's identifier.
* @param body Collection data to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> updateCollectionWithResponseAsync(
String identifier, DocumentCollectionUpdate body) {
final String accept = "application/json";
return service.updateCollection(this.getRegion(), identifier, body, accept);
}
/**
* Update data of a collection.
*
* @param identifier Collection's identifier.
* @param body Collection data to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono updateCollectionAsync(String identifier, DocumentCollectionUpdate body) {
return updateCollectionWithResponseAsync(identifier, body)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Update data of a collection.
*
* @param identifier Collection's identifier.
* @param body Collection data to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public DocumentCollection updateCollection(String identifier, DocumentCollectionUpdate body) {
return updateCollectionAsync(identifier, body).block();
}
/**
* Deletes the specified collection from the database.
*
* @param identifier Collection's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> deleteCollectionWithResponseAsync(String identifier) {
final String accept = "application/json";
return service.deleteCollection(this.getRegion(), identifier, accept);
}
/**
* Deletes the specified collection from the database.
*
* @param identifier Collection's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return A {@link Mono} that completes when a successful response is received.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono deleteCollectionAsync(String identifier) {
return deleteCollectionWithResponseAsync(identifier).flatMap((Response res) -> Mono.empty());
}
/**
* Deletes the specified collection from the database.
*
* @param identifier Collection's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public void deleteCollection(String identifier) {
deleteCollectionAsync(identifier).block();
}
/**
* Create data field for a collection along with a new data point.
*
* @param identifier Collection's identifier.
* @param body The data field and data point to be created.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> createDataFieldForCollectionWithResponseAsync(
String identifier, DataFieldCreate body) {
final String accept = "application/json";
return service.createDataFieldForCollection(this.getRegion(), identifier, body, accept);
}
/**
* Create data field for a collection along with a new data point.
*
* @param identifier Collection's identifier.
* @param body The data field and data point to be created.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono createDataFieldForCollectionAsync(String identifier, DataFieldCreate body) {
return createDataFieldForCollectionWithResponseAsync(identifier, body)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Create data field for a collection along with a new data point.
*
* @param identifier Collection's identifier.
* @param body The data field and data point to be created.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public DataField createDataFieldForCollection(String identifier, DataFieldCreate body) {
return createDataFieldForCollectionAsync(identifier, body).block();
}
/**
* Get a data field for a collection assosciated with a data point.
*
* @param identifier Collection's identifier.
* @param datapointIdentifier Datapoint's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return a data field for a collection assosciated with a data point along with {@link Response} on successful
* completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> getDataFieldForCollectionWithResponseAsync(
String identifier, String datapointIdentifier) {
final String accept = "application/json";
return service.getDataFieldForCollection(this.getRegion(), identifier, datapointIdentifier, accept);
}
/**
* Get a data field for a collection assosciated with a data point.
*
* @param identifier Collection's identifier.
* @param datapointIdentifier Datapoint's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return a data field for a collection assosciated with a data point on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono getDataFieldForCollectionAsync(String identifier, String datapointIdentifier) {
return getDataFieldForCollectionWithResponseAsync(identifier, datapointIdentifier)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Get a data field for a collection assosciated with a data point.
*
* @param identifier Collection's identifier.
* @param datapointIdentifier Datapoint's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return a data field for a collection assosciated with a data point.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public CollectionField getDataFieldForCollection(String identifier, String datapointIdentifier) {
return getDataFieldForCollectionAsync(identifier, datapointIdentifier).block();
}
/**
* Update data field for a collection assosciated with a data point.
*
* @param identifier Collection's identifier.
* @param datapointIdentifier Datapoint's identifier.
* @param body Data field properties to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> updateDataFieldForCollectionWithResponseAsync(
String identifier, String datapointIdentifier, CollectionField body) {
final String accept = "application/json";
return service.updateDataFieldForCollection(this.getRegion(), identifier, datapointIdentifier, body, accept);
}
/**
* Update data field for a collection assosciated with a data point.
*
* @param identifier Collection's identifier.
* @param datapointIdentifier Datapoint's identifier.
* @param body Data field properties to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono updateDataFieldForCollectionAsync(
String identifier, String datapointIdentifier, CollectionField body) {
return updateDataFieldForCollectionWithResponseAsync(identifier, datapointIdentifier, body)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Update data field for a collection assosciated with a data point.
*
* @param identifier Collection's identifier.
* @param datapointIdentifier Datapoint's identifier.
* @param body Data field properties to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public CollectionField updateDataFieldForCollection(
String identifier, String datapointIdentifier, CollectionField body) {
return updateDataFieldForCollectionAsync(identifier, datapointIdentifier, body).block();
}
/**
* Return monthly credits consumption of a collection.
*
* @param identifier Collection's identifier.
* @param start Start date of the period to retrieve. Format: YYYY-MM.
* @param end End date of the period to retrieve. Format: YYYY-MM.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return monthly credits consumption along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono>> getUsageByCollectionWithResponseAsync(
String identifier, String start, String end) {
final String accept = "application/json";
return service.getUsageByCollection(this.getRegion(), identifier, start, end, accept);
}
/**
* Return monthly credits consumption of a collection.
*
* @param identifier Collection's identifier.
* @param start Start date of the period to retrieve. Format: YYYY-MM.
* @param end End date of the period to retrieve. Format: YYYY-MM.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return monthly credits consumption on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> getUsageByCollectionAsync(String identifier, String start, String end) {
return getUsageByCollectionWithResponseAsync(identifier, start, end)
.flatMap(
(Response> res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Return monthly credits consumption of a collection.
*
* @param identifier Collection's identifier.
* @param start Start date of the period to retrieve. Format: YYYY-MM.
* @param end End date of the period to retrieve. Format: YYYY-MM.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return monthly credits consumption.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public List getUsageByCollection(String identifier, String start, String end) {
return getUsageByCollectionAsync(identifier, start, end).block();
}
/**
* Returns all the document summaries for that user, limited to 300 per page.
*
* @param offset The number of documents to skip before starting to collect the result set.
* @param limit The numbers of results to return.
* @param workspace Filter by workspace.
* @param collection Filter by collection.
* @param state Filter by the document's state.
* @param tags Filter by tag's IDs.
* @param createdDt Filter by created datetime.
* @param search Partial, case-insensitive match with file name or tag name.
* @param ordering Sort the result set. A "-" at the beginning denotes DESC sort, e.g. -created_dt. Sort by multiple
* fields is supported. Supported values include: 'file_name', 'extractor', 'created_dt', 'validated_dt',
* 'archived_dt' and 'parsed__<dataPointSlug>'.
* @param includeData By default, this endpoint returns only the meta data of the documents. Set this to `true` will
* return a summary of the data that was parsed. If you want to retrieve the full set of data for a document,
* use the `GET /documents/{identifier}` endpoint.
* @param exclude Exclude some documents from the result.
* @param inReview Exclude documents that are currently being reviewed.
* @param failed Filter by failed status.
* @param ready Filter by ready status.
* @param validatable Filter for validatable documents.
* @param hasChallenges Filter for documents with challenges.
* @param customIdentifier Filter for documents with this custom identifier.
* @param compact If "true", the response is compacted to annotations' parsed data. Annotations' meta data are
* excluded. Default is "false".
* @param count If "false", the documents count is not computed, thus saving time for large collections. Default is
* "true".
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono>
getAllDocumentsWithResponseAsync(
Integer offset,
Integer limit,
String workspace,
String collection,
DocumentState state,
List tags,
DateRange createdDt,
String search,
List ordering,
Boolean includeData,
List exclude,
Boolean inReview,
Boolean failed,
Boolean ready,
Boolean validatable,
Boolean hasChallenges,
String customIdentifier,
Boolean compact,
Boolean count) {
final String accept = "application/json";
String tagsConverted =
JacksonAdapter.createDefaultSerializerAdapter().serializeList(tags, CollectionFormat.CSV);
String orderingConverted =
JacksonAdapter.createDefaultSerializerAdapter().serializeList(ordering, CollectionFormat.CSV);
String excludeConverted =
JacksonAdapter.createDefaultSerializerAdapter().serializeList(exclude, CollectionFormat.CSV);
return service.getAllDocuments(
this.getRegion(),
offset,
limit,
workspace,
collection,
state,
tagsConverted,
createdDt,
search,
orderingConverted,
includeData,
excludeConverted,
inReview,
failed,
ready,
validatable,
hasChallenges,
customIdentifier,
compact,
count,
accept);
}
/**
* Returns all the document summaries for that user, limited to 300 per page.
*
* @param offset The number of documents to skip before starting to collect the result set.
* @param limit The numbers of results to return.
* @param workspace Filter by workspace.
* @param collection Filter by collection.
* @param state Filter by the document's state.
* @param tags Filter by tag's IDs.
* @param createdDt Filter by created datetime.
* @param search Partial, case-insensitive match with file name or tag name.
* @param ordering Sort the result set. A "-" at the beginning denotes DESC sort, e.g. -created_dt. Sort by multiple
* fields is supported. Supported values include: 'file_name', 'extractor', 'created_dt', 'validated_dt',
* 'archived_dt' and 'parsed__<dataPointSlug>'.
* @param includeData By default, this endpoint returns only the meta data of the documents. Set this to `true` will
* return a summary of the data that was parsed. If you want to retrieve the full set of data for a document,
* use the `GET /documents/{identifier}` endpoint.
* @param exclude Exclude some documents from the result.
* @param inReview Exclude documents that are currently being reviewed.
* @param failed Filter by failed status.
* @param ready Filter by ready status.
* @param validatable Filter for validatable documents.
* @param hasChallenges Filter for documents with challenges.
* @param customIdentifier Filter for documents with this custom identifier.
* @param compact If "true", the response is compacted to annotations' parsed data. Annotations' meta data are
* excluded. Default is "false".
* @param count If "false", the documents count is not computed, thus saving time for large collections. Default is
* "true".
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono getAllDocumentsAsync(
Integer offset,
Integer limit,
String workspace,
String collection,
DocumentState state,
List tags,
DateRange createdDt,
String search,
List ordering,
Boolean includeData,
List exclude,
Boolean inReview,
Boolean failed,
Boolean ready,
Boolean validatable,
Boolean hasChallenges,
String customIdentifier,
Boolean compact,
Boolean count) {
return getAllDocumentsWithResponseAsync(
offset,
limit,
workspace,
collection,
state,
tags,
createdDt,
search,
ordering,
includeData,
exclude,
inReview,
failed,
ready,
validatable,
hasChallenges,
customIdentifier,
compact,
count)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Returns all the document summaries for that user, limited to 300 per page.
*
* @param offset The number of documents to skip before starting to collect the result set.
* @param limit The numbers of results to return.
* @param workspace Filter by workspace.
* @param collection Filter by collection.
* @param state Filter by the document's state.
* @param tags Filter by tag's IDs.
* @param createdDt Filter by created datetime.
* @param search Partial, case-insensitive match with file name or tag name.
* @param ordering Sort the result set. A "-" at the beginning denotes DESC sort, e.g. -created_dt. Sort by multiple
* fields is supported. Supported values include: 'file_name', 'extractor', 'created_dt', 'validated_dt',
* 'archived_dt' and 'parsed__<dataPointSlug>'.
* @param includeData By default, this endpoint returns only the meta data of the documents. Set this to `true` will
* return a summary of the data that was parsed. If you want to retrieve the full set of data for a document,
* use the `GET /documents/{identifier}` endpoint.
* @param exclude Exclude some documents from the result.
* @param inReview Exclude documents that are currently being reviewed.
* @param failed Filter by failed status.
* @param ready Filter by ready status.
* @param validatable Filter for validatable documents.
* @param hasChallenges Filter for documents with challenges.
* @param customIdentifier Filter for documents with this custom identifier.
* @param compact If "true", the response is compacted to annotations' parsed data. Annotations' meta data are
* excluded. Default is "false".
* @param count If "false", the documents count is not computed, thus saving time for large collections. Default is
* "true".
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public PathsOxm5M7V3DocumentsGetResponses200ContentApplicationJsonSchema getAllDocuments(
Integer offset,
Integer limit,
String workspace,
String collection,
DocumentState state,
List tags,
DateRange createdDt,
String search,
List ordering,
Boolean includeData,
List exclude,
Boolean inReview,
Boolean failed,
Boolean ready,
Boolean validatable,
Boolean hasChallenges,
String customIdentifier,
Boolean compact,
Boolean count) {
return getAllDocumentsAsync(
offset,
limit,
workspace,
collection,
state,
tags,
createdDt,
search,
ordering,
includeData,
exclude,
inReview,
failed,
ready,
validatable,
hasChallenges,
customIdentifier,
compact,
count)
.block();
}
/**
* Uploads a document for parsing. When successful, returns an `identifier` in the response for subsequent use with
* the [/documents/{identifier}](#get-/v3/documents/-identifier-) endpoint to check processing status and retrieve
* results.<br/>.
*
* @param body Document to upload, either via file upload or URL to a file.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> createDocumentWithResponseAsync(DocumentCreate body) {
final String accept = "application/json";
return service.createDocument(this.getRegion(), body, accept);
}
/**
* Uploads a document for parsing. When successful, returns an `identifier` in the response for subsequent use with
* the [/documents/{identifier}](#get-/v3/documents/-identifier-) endpoint to check processing status and retrieve
* results.<br/>.
*
* @param body Document to upload, either via file upload or URL to a file.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono createDocumentAsync(DocumentCreate body) {
return createDocumentWithResponseAsync(body)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Uploads a document for parsing. When successful, returns an `identifier` in the response for subsequent use with
* the [/documents/{identifier}](#get-/v3/documents/-identifier-) endpoint to check processing status and retrieve
* results.<br/>.
*
* @param body Document to upload, either via file upload or URL to a file.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Document createDocument(DocumentCreate body) {
return createDocumentAsync(body).block();
}
/**
* Return a specific document.
*
* @param identifier Document's identifier.
* @param format Specify which format you want the response to be. Default is "json".
* @param compact If "true", the response is compacted to annotations' parsed data. Annotations' meta data are
* excluded. Default is "false".
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> getDocumentWithResponseAsync(
String identifier, DocumentFormat format, Boolean compact) {
final String accept = "application/json, application/xml";
return service.getDocument(this.getRegion(), identifier, format, compact, accept);
}
/**
* Return a specific document.
*
* @param identifier Document's identifier.
* @param format Specify which format you want the response to be. Default is "json".
* @param compact If "true", the response is compacted to annotations' parsed data. Annotations' meta data are
* excluded. Default is "false".
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono getDocumentAsync(String identifier, DocumentFormat format, Boolean compact) {
return getDocumentWithResponseAsync(identifier, format, compact)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Return a specific document.
*
* @param identifier Document's identifier.
* @param format Specify which format you want the response to be. Default is "json".
* @param compact If "true", the response is compacted to annotations' parsed data. Annotations' meta data are
* excluded. Default is "false".
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Document getDocument(String identifier, DocumentFormat format, Boolean compact) {
return getDocumentAsync(identifier, format, compact).block();
}
/**
* Update file name, expiry time, or move to another collection, etc.
*
* @param identifier Document's identifier.
* @param body Document data to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> updateDocumentWithResponseAsync(String identifier, DocumentUpdate body) {
final String accept = "application/json";
return service.updateDocument(this.getRegion(), identifier, body, accept);
}
/**
* Update file name, expiry time, or move to another collection, etc.
*
* @param identifier Document's identifier.
* @param body Document data to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono updateDocumentAsync(String identifier, DocumentUpdate body) {
return updateDocumentWithResponseAsync(identifier, body)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Update file name, expiry time, or move to another collection, etc.
*
* @param identifier Document's identifier.
* @param body Document data to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Document updateDocument(String identifier, DocumentUpdate body) {
return updateDocumentAsync(identifier, body).block();
}
/**
* Deletes the specified document from the database.
*
* @param identifier Document's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> deleteDocumentWithResponseAsync(String identifier) {
final String accept = "application/json";
return service.deleteDocument(this.getRegion(), identifier, accept);
}
/**
* Deletes the specified document from the database.
*
* @param identifier Document's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return A {@link Mono} that completes when a successful response is received.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono deleteDocumentAsync(String identifier) {
return deleteDocumentWithResponseAsync(identifier).flatMap((Response res) -> Mono.empty());
}
/**
* Deletes the specified document from the database.
*
* @param identifier Document's identifier.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public void deleteDocument(String identifier) {
deleteDocumentAsync(identifier).block();
}
/**
* Update data of a document. Only applicable for resumes and job descriptions. For other document types, please use
* the `PATCH /annotations/{id}` endpoint or the `POST /annotations/batch_update` endpoint.
*
* @param identifier Resume or Job Description identifier.
* @param body Resume data to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> updateDocumentDataWithResponseAsync(String identifier, Object body) {
final String accept = "application/json";
return service.updateDocumentData(this.getRegion(), identifier, body, accept);
}
/**
* Update data of a document. Only applicable for resumes and job descriptions. For other document types, please use
* the `PATCH /annotations/{id}` endpoint or the `POST /annotations/batch_update` endpoint.
*
* @param identifier Resume or Job Description identifier.
* @param body Resume data to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono updateDocumentDataAsync(String identifier, Object body) {
return updateDocumentDataWithResponseAsync(identifier, body)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Update data of a document. Only applicable for resumes and job descriptions. For other document types, please use
* the `PATCH /annotations/{id}` endpoint or the `POST /annotations/batch_update` endpoint.
*
* @param identifier Resume or Job Description identifier.
* @param body Resume data to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Document updateDocumentData(String identifier, Object body) {
return updateDocumentDataAsync(identifier, body).block();
}
/**
* Add a tag to documents. Tags are used to group documents together. Tags can be used to filter documents.
*
* @param body Specify the tag and the documents to tag.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> batchAddTagWithResponseAsync(BatchAddTagRequest body) {
final String accept = "application/json";
return service.batchAddTag(this.getRegion(), body, accept);
}
/**
* Add a tag to documents. Tags are used to group documents together. Tags can be used to filter documents.
*
* @param body Specify the tag and the documents to tag.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return A {@link Mono} that completes when a successful response is received.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono batchAddTagAsync(BatchAddTagRequest body) {
return batchAddTagWithResponseAsync(body).flatMap((Response res) -> Mono.empty());
}
/**
* Add a tag to documents. Tags are used to group documents together. Tags can be used to filter documents.
*
* @param body Specify the tag and the documents to tag.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public void batchAddTag(BatchAddTagRequest body) {
batchAddTagAsync(body).block();
}
/**
* Remove a tag from documents.
*
* @param body Specify the tag and the documents to remove the tag from.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> batchRemoveTagWithResponseAsync(BatchRemoveTagRequest body) {
final String accept = "application/json";
return service.batchRemoveTag(this.getRegion(), body, accept);
}
/**
* Remove a tag from documents.
*
* @param body Specify the tag and the documents to remove the tag from.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return A {@link Mono} that completes when a successful response is received.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono batchRemoveTagAsync(BatchRemoveTagRequest body) {
return batchRemoveTagWithResponseAsync(body).flatMap((Response res) -> Mono.empty());
}
/**
* Remove a tag from documents.
*
* @param body Specify the tag and the documents to remove the tag from.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public void batchRemoveTag(BatchRemoveTagRequest body) {
batchRemoveTagAsync(body).block();
}
/**
* Split / merge / rotate / delete pages of a document. Documents with multiple pages can be splitted into multiple
* documents, or merged into one document. Each page can also be rotated. Edit operations will trigger re-parsing of
* the documents involved.
*
* @param identifier Document's identifier.
* @param body Describe how the pages should be edited.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return array of Meta along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono>> editDocumentPagesWithResponseAsync(String identifier, DocumentEditRequest body) {
final String accept = "application/json";
return service.editDocumentPages(this.getRegion(), identifier, body, accept);
}
/**
* Split / merge / rotate / delete pages of a document. Documents with multiple pages can be splitted into multiple
* documents, or merged into one document. Each page can also be rotated. Edit operations will trigger re-parsing of
* the documents involved.
*
* @param identifier Document's identifier.
* @param body Describe how the pages should be edited.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return array of Meta on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> editDocumentPagesAsync(String identifier, DocumentEditRequest body) {
return editDocumentPagesWithResponseAsync(identifier, body)
.flatMap(
(Response> res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Split / merge / rotate / delete pages of a document. Documents with multiple pages can be splitted into multiple
* documents, or merged into one document. Each page can also be rotated. Edit operations will trigger re-parsing of
* the documents involved.
*
* @param identifier Document's identifier.
* @param body Describe how the pages should be edited.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return array of Meta.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public List>> getAllValidationResultsWithResponseAsync(
String document, Integer offset, Integer limit) {
final String accept = "application/json";
return service.getAllValidationResults(this.getRegion(), offset, limit, document, accept);
}
/**
* Returns the validation results of a document.
*
* @param document Filter by document.
* @param offset The number of documents to skip before starting to collect the result set.
* @param limit The numbers of results to return.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return array of ValidationResult on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> getAllValidationResultsAsync(String document, Integer offset, Integer limit) {
return getAllValidationResultsWithResponseAsync(document, offset, limit)
.flatMap(
(Response> res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Returns the validation results of a document.
*
* @param document Filter by document.
* @param offset The number of documents to skip before starting to collect the result set.
* @param limit The numbers of results to return.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return array of ValidationResult.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public List getAllValidationResults(String document, Integer offset, Integer limit) {
return getAllValidationResultsAsync(document, offset, limit).block();
}
/**
* Create a validation result.
*
* @param body The body parameter.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return validation result arising from a ValidationRule along with {@link Response} on successful completion of
* {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> createValidationResultWithResponseAsync(ValidationResultCreate body) {
final String accept = "application/json";
return service.createValidationResult(this.getRegion(), body, accept);
}
/**
* Create a validation result.
*
* @param body The body parameter.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return validation result arising from a ValidationRule on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono createValidationResultAsync(ValidationResultCreate body) {
return createValidationResultWithResponseAsync(body)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Create a validation result.
*
* @param body The body parameter.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return validation result arising from a ValidationRule.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public ValidationResult createValidationResult(ValidationResultCreate body) {
return createValidationResultAsync(body).block();
}
/**
* Return a specific validation result.
*
* @param id Validation result's ID.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return validation result arising from a ValidationRule along with {@link Response} on successful completion of
* {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> getValidationResultWithResponseAsync(int id) {
final String accept = "application/json";
return service.getValidationResult(this.getRegion(), id, accept);
}
/**
* Return a specific validation result.
*
* @param id Validation result's ID.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return validation result arising from a ValidationRule on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono getValidationResultAsync(int id) {
return getValidationResultWithResponseAsync(id)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Return a specific validation result.
*
* @param id Validation result's ID.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return validation result arising from a ValidationRule.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public ValidationResult getValidationResult(int id) {
return getValidationResultAsync(id).block();
}
/**
* Update a validation result.
*
* @param id Validation result's ID.
* @param body Validation result data to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return validation result arising from a ValidationRule along with {@link Response} on successful completion of
* {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> updateValidationResultWithResponseAsync(
int id, ValidationResultUpdate body) {
final String accept = "application/json";
return service.updateValidationResult(this.getRegion(), id, body, accept);
}
/**
* Update a validation result.
*
* @param id Validation result's ID.
* @param body Validation result data to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return validation result arising from a ValidationRule on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono updateValidationResultAsync(int id, ValidationResultUpdate body) {
return updateValidationResultWithResponseAsync(id, body)
.flatMap(
(Response res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Update a validation result.
*
* @param id Validation result's ID.
* @param body Validation result data to update.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return validation result arising from a ValidationRule.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public ValidationResult updateValidationResult(int id, ValidationResultUpdate body) {
return updateValidationResultAsync(id, body).block();
}
/**
* Remove validation result.
*
* @param id Validation result's ID.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> deleteValidationResultWithResponseAsync(int id) {
final String accept = "application/json";
return service.deleteValidationResult(this.getRegion(), id, accept);
}
/**
* Remove validation result.
*
* @param id Validation result's ID.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return A {@link Mono} that completes when a successful response is received.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono deleteValidationResultAsync(int id) {
return deleteValidationResultWithResponseAsync(id).flatMap((Response res) -> Mono.empty());
}
/**
* Remove validation result.
*
* @param id Validation result's ID.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public void deleteValidationResult(int id) {
deleteValidationResultAsync(id).block();
}
/**
* Returns your custom extractors as well as Affinda's off-the-shelf extractors.
*
* @param organization Filter by organization.
* @param includePublicExtractors Whether to include Affinda's off-the-shelf extractors.
* @param name Filter by name.
* @param validatable Filter by validatable.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return array of Extractor along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono>> getAllExtractorsWithResponseAsync(
String organization, Boolean includePublicExtractors, String name, Boolean validatable) {
final String accept = "application/json";
return service.getAllExtractors(
this.getRegion(), organization, includePublicExtractors, name, validatable, accept);
}
/**
* Returns your custom extractors as well as Affinda's off-the-shelf extractors.
*
* @param organization Filter by organization.
* @param includePublicExtractors Whether to include Affinda's off-the-shelf extractors.
* @param name Filter by name.
* @param validatable Filter by validatable.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return array of Extractor on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono> getAllExtractorsAsync(
String organization, Boolean includePublicExtractors, String name, Boolean validatable) {
return getAllExtractorsWithResponseAsync(organization, includePublicExtractors, name, validatable)
.flatMap(
(Response> res) -> {
if (res.getValue() != null) {
return Mono.just(res.getValue());
} else {
return Mono.empty();
}
});
}
/**
* Returns your custom extractors as well as Affinda's off-the-shelf extractors.
*
* @param organization Filter by organization.
* @param includePublicExtractors Whether to include Affinda's off-the-shelf extractors.
* @param name Filter by name.
* @param validatable Filter by validatable.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return array of Extractor.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public List getAllExtractors(
String organization, Boolean includePublicExtractors, String name, Boolean validatable) {
return getAllExtractorsAsync(organization, includePublicExtractors, name, validatable).block();
}
/**
* Create a custom extractor.
*
* @param body The body parameter.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws RequestErrorException thrown if the request is rejected by server.
* @throws RequestErrorException thrown if the request is rejected by server on status code 400, 401.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono 