com.symphony.api.agent.UtilApi Maven / Gradle / Ivy

Go to download
package com.symphony.api.agent;

import com.symphony.api.model.Error;
import com.symphony.api.model.SimpleMessage;

import java.io.InputStream;
import java.io.OutputStream;
import java.util.List;
import java.util.Map;
import javax.ws.rs.*;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.MediaType;
import org.apache.cxf.jaxrs.ext.multipart.*;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.media.ArraySchema;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;

/**
 * Agent API
 *
 * This document refers to Symphony API calls to send and receive messages and content. They need the on-premise Agent installed to perform decryption/encryption of content.  - sessionToken and keyManagerToken can be obtained by calling the authenticationAPI on the symphony back end and the key manager respectively. Refer to the methods described in authenticatorAPI.yaml. - Actions are defined to be atomic, ie will succeed in their entirety or fail and have changed nothing. - If it returns a 40X status then it will have sent no message to any stream even if a request to aome subset of the requested streams would have succeeded. - If this contract cannot be met for any reason then this is an error and the response code will be 50X. - MessageML is a markup language for messages. See reference here: https://rest-api.symphony.com/docs/messagemlv2 - **Real Time Events**: The following events are returned when reading from a real time messages and events stream (\"datafeed\"). These events will be returned for datafeeds created with the v5 endpoints. To know more about the endpoints, refer to Create Messages/Events Stream and Read Messages/Events Stream. Unless otherwise specified, all events were added in 1.46. 
 *
 */
@Path("/")
public interface UtilApi  {

    /**
     * Test endpoint, returns input.
     *
     */
    @POST
    @Path("/v1/util/echo")
    @Consumes({ "application/json" })
    @Produces({ "application/json" })
    @Operation(summary = "Test endpoint, returns input.", tags={  })
    @ApiResponses(value = { 
        @ApiResponse(responseCode = "200", description = "Message sent.", content = @Content(schema = @Schema(implementation = SimpleMessage.class))),
        @ApiResponse(responseCode = "400", description = "Client error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))),
        @ApiResponse(responseCode = "401", description = "Unauthorized: Session tokens invalid.", content = @Content(schema = @Schema(implementation = Error.class))),
        @ApiResponse(responseCode = "403", description = "Forbidden: Caller lacks necessary entitlement.", content = @Content(schema = @Schema(implementation = Error.class))),
        @ApiResponse(responseCode = "500", description = "Server error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))) })
    public SimpleMessage v1UtilEchoPost(SimpleMessage body, @HeaderParam("sessionToken") String sessionToken, @HeaderParam("keyManagerToken") String keyManagerToken);

    /**
     * Example of a deprecated endpoint, returns input.
     *
     */
    @POST
    @Path("/v1/util/obsolete")
    @Consumes({ "application/json" })
    @Produces({ "application/json" })
    @Operation(summary = "Example of a deprecated endpoint, returns input.", tags={  })
    @ApiResponses(value = { 
        @ApiResponse(responseCode = "200", description = "Message sent.", content = @Content(schema = @Schema(implementation = SimpleMessage.class))),
        @ApiResponse(responseCode = "400", description = "Client error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))),
        @ApiResponse(responseCode = "401", description = "Unauthorized: Session tokens invalid.", content = @Content(schema = @Schema(implementation = Error.class))),
        @ApiResponse(responseCode = "403", description = "Forbidden: Caller lacks necessary entitlement.", content = @Content(schema = @Schema(implementation = Error.class))),
        @ApiResponse(responseCode = "420", description = "Gone. Returned when the option to hard fail deprecated methods is enabled", content = @Content(schema = @Schema(implementation = Error.class))),
        @ApiResponse(responseCode = "500", description = "Server error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))) })
    public SimpleMessage v1UtilObsoletePost(SimpleMessage body, @HeaderParam("sessionToken") String sessionToken, @HeaderParam("keyManagerToken") String keyManagerToken);
}