com.eligible.net.EligibleResponseGetter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eligible-java Show documentation

Java bindings for Eligible APIs (https://eligible.com).

There is a newer version: 1.13.13

package com.eligible.net;

import com.eligible.exception.APIConnectionException;
import com.eligible.exception.APIException;
import com.eligible.exception.AuthenticationException;
import com.eligible.exception.InvalidRequestException;

import java.lang.reflect.Type;
import java.util.Map;

/**
 * Interface for making Eligible API calls.
 *
 * It is primarily used for mocking API calls while testing.
 */
public interface EligibleResponseGetter {

    /**
     * Make an Eligible API call to {@code url} and return the deserialized Java Model of {@link Type} {@code type}.
     *
     * @param method HTTP method of API call
     * @param url {@link java.net.URL} of API call
     * @param params request parameters
     * @param typeOfT {@link Type} of response for deserializing
     * @param type Type of HTTP request
     * @param options {@link RequestOptions} of making API call. {@code RequestOptions.getDefault()} will be used if
     *                                      {@code null} is provided.
     * @param  Type of Response
     * @return API Response
     * @throws AuthenticationException if api key is invalid
     * @throws InvalidRequestException if input parameters has issues
     * @throws APIConnectionException if issue with Eligible API connection
     * @throws APIException if issues with Eligible API
     */
     T request(
            RequestMethod method,
            String url,
            Map params,
            Type typeOfT,
            RequestType type,
            RequestOptions options)
        throws AuthenticationException, InvalidRequestException, APIConnectionException, APIException;

    /**
     * Make an Eligible API call to {@code url} and return the raw response.
     *
     * @param method HTTP method of API call
     * @param url {@link java.net.URL} of API call
     * @param params request parameters
     * @param type Type of HTTP request
     * @param options {@link RequestOptions} of making API call. {@code RequestOptions.getDefault()} will be used if
     *                                      {@code null} is provided.
     * @return API Response
     * @throws AuthenticationException if api key is invalid
     * @throws InvalidRequestException if input parameters has issues
     * @throws APIConnectionException if issue with Eligible API connection
     * @throws APIException if issues with Eligible API
     */
    EligibleResponse request(
            RequestMethod method,
            String url,
            Map params,
            RequestType type,
            RequestOptions options)
        throws AuthenticationException, InvalidRequestException, APIConnectionException, APIException;
}