com.foresee.api.sdk.clients.PublicAPIsVersionClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of public-api-sdk Show documentation
SDK to access Foresee data over Public API
There is a newer version: 1.2.4-M3
package com.foresee.api.sdk.clients;

import com.foresee.api.sdk.model.*;

public interface PublicAPIsVersionClient {
    /**
     * A generic invoker to invoke any API Gateway endpoint.
     *
     * @param request
     * @return ApiResponse
     */
    com.amazonaws.mobileconnectors.apigateway.ApiResponse execute(com.amazonaws.mobileconnectors.apigateway.ApiRequest request);

    /**
     * @return Empty
     */
    @com.amazonaws.mobileconnectors.apigateway.annotation.Operation(path = "/", method = "OPTIONS")
    Empty rootOptions();

    /**
     * @param contentType
     * @param accept
     * @param xDebugEnabled
     * @param authorization
     * @return MeasuresCollection
     */
    @com.amazonaws.mobileconnectors.apigateway.annotation.Operation(path = "/measures", method = "GET")
    MeasuresCollection measuresGet(
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "Content-Type", location = "header")
            String contentType,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "Accept", location = "header")
            String accept,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "x-debug-enabled", location = "header")
            String xDebugEnabled,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "Authorization", location = "header")
            String authorization);

    /**
     * @param measurementKey
     * @param excludeLatentScores
     * @param excludeResponseDetails
     * @param contentType
     * @param disablePaging
     * @param excludeMQ
     * @param from
     * @param to
     * @param excludeOpenEnds
     * @param excludeCQ
     * @param accept
     * @param limit
     * @param offset
     * @param authorization
     * @param excludePassedParams
     * @param xDebugEnabled
     * @return MeasureData
     */
    @com.amazonaws.mobileconnectors.apigateway.annotation.Operation(path = "/measures/{measurementKey}/data", method = "GET")
    MeasureData measuresMeasurementKeyDataGet(
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "measurementKey", location = "path")
            String measurementKey,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "excludeLatentScores", location = "query")
            String excludeLatentScores,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "excludeResponseDetails", location = "query")
            String excludeResponseDetails,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "Content-Type", location = "header")
            String contentType,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "disablePaging", location = "query")
            String disablePaging,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "excludeMQ", location = "query")
            String excludeMQ,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "from", location = "query")
            String from,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "to", location = "query")
            String to,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "excludeOpenEnds", location = "query")
            String excludeOpenEnds,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "excludeCQ", location = "query")
            String excludeCQ,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "Accept", location = "header")
            String accept,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "limit", location = "query")
            String limit,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "offset", location = "query")
            String offset,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "Authorization", location = "header")
            String authorization,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "excludePassedParams", location = "query")
            String excludePassedParams,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "x-debug-enabled", location = "header")
            String xDebugEnabled);

    /**
     * @param measurementKey
     * @param accept
     * @param excludeQuestions
     * @param authorization
     * @param contentType
     * @param xDebugEnabled
     * @param excludeAnswers
     * @return MeasureDefinition
     */
    @com.amazonaws.mobileconnectors.apigateway.annotation.Operation(path = "/measures/{measurementKey}/definition", method = "GET")
    MeasureDefinition measuresMeasurementKeyDefinitionGet(
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "measurementKey", location = "path")
            String measurementKey,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "Accept", location = "header")
            String accept,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "excludeQuestions", location = "query")
            String excludeQuestions,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "Authorization", location = "header")
            String authorization,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "Content-Type", location = "header")
            String contentType,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "x-debug-enabled", location = "header")
            String xDebugEnabled,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "excludeAnswers", location = "query")
            String excludeAnswers);

    /**
     * @param contentType
     * @param accept
     * @param scope
     * @param grantType
     * @param xDebugEnabled
     * @param authorization
     * @return OAuth2TokenResponse
     */
    @com.amazonaws.mobileconnectors.apigateway.annotation.Operation(path = "/token", method = "POST")
    OAuth2TokenResponse tokenPost(
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "Content-Type", location = "header")
            String contentType,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "Accept", location = "header")
            String accept,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "scope", location = "query")
            String scope,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "grant_type", location = "query")
            String grantType,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "x-debug-enabled", location = "header")
            String xDebugEnabled,
            @com.amazonaws.mobileconnectors.apigateway.annotation.Parameter(name = "Authorization", location = "header")
            String authorization);
}