com.adyen.service.balanceplatform.GrantOffersApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of adyen-java-api-library Show documentation
Adyen API Client Library for Java
There is a newer version: 38.1.0
Show newest version
/*
 * Configuration API
 *
 * The version of the OpenAPI document: 2
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

package com.adyen.service.balanceplatform;

import com.adyen.Client;
import com.adyen.Service;
import com.adyen.constants.ApiConstants;
import com.adyen.model.balanceplatform.GrantOffer;
import com.adyen.model.balanceplatform.GrantOffers;
import com.adyen.model.balanceplatform.RestServiceError;
import com.adyen.model.RequestOptions;
import com.adyen.service.exception.ApiException;
import com.adyen.service.resource.Resource;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

public class GrantOffersApi extends Service {

    public static final String API_VERSION = "2";

    protected String baseURL;

    /**
    * Grant offers constructor in {@link com.adyen.service.balanceplatform package}.
    * @param client {@link Client } (required)
    */
    public GrantOffersApi(Client client) {
        super(client);
        this.baseURL = createBaseURL("https://balanceplatform-api-test.adyen.com/bcl/v2");
    }

    /**
    * Grant offers constructor in {@link com.adyen.service.balanceplatform package}.
    * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.
    * @param client {@link Client } (required)
    * @param baseURL {@link String } (required)
    */
    public GrantOffersApi(Client client, String baseURL) {
        super(client);
        this.baseURL = baseURL;
    }

    /**
    * Get all available grant offers
    *
    * @param accountHolderId {@link String } The unique identifier of the grant account. (required)
    * @return {@link GrantOffers }
    * @throws ApiException if fails to make API call
    * @deprecated since Configuration API v2
    * Use the `/grantOffers` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/get/grantOffers) instead.
    */
    @Deprecated
    public GrantOffers getAllAvailableGrantOffers(String accountHolderId) throws ApiException, IOException {
        return getAllAvailableGrantOffers(accountHolderId,  null);
    }

    /**
    * Get all available grant offers
    *
    * @param accountHolderId {@link String } Query: The unique identifier of the grant account. (required)
    * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional)
    * @return {@link GrantOffers }
    * @throws ApiException if fails to make API call
    * @deprecated since Configuration API v2
    * Use the `/grantOffers` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/get/grantOffers) instead.
    */
   @Deprecated
    public GrantOffers getAllAvailableGrantOffers(String accountHolderId, RequestOptions requestOptions) throws ApiException, IOException {
        //Add query params
        Map queryParams = new HashMap<>();
        if (accountHolderId != null) {
        queryParams.put("accountHolderId", accountHolderId);
        }

        String requestBody = null;
        Resource resource = new Resource(this, this.baseURL + "/grantOffers", null);
        String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, null, queryParams);
        return GrantOffers.fromJson(jsonResult);
    }

    /**
    * Get a grant offer
    *
    * @param grantOfferId {@link String } The unique identifier of the grant offer. (required)
    * @return {@link GrantOffer }
    * @throws ApiException if fails to make API call
    * @deprecated since Configuration API v2
    * Use the `/grantOffers/{id}` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/get/grantOffers/(id)) instead.
    */
    @Deprecated
    public GrantOffer getGrantOffer(String grantOfferId) throws ApiException, IOException {
        return getGrantOffer(grantOfferId, null);
    }

    /**
    * Get a grant offer
    *
    * @param grantOfferId {@link String } The unique identifier of the grant offer. (required)
    * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional)
    * @return {@link GrantOffer }
    * @throws ApiException if fails to make API call
    * @deprecated since Configuration API v2
    * Use the `/grantOffers/{id}` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/get/grantOffers/(id)) instead.
    */
   @Deprecated
    public GrantOffer getGrantOffer(String grantOfferId, RequestOptions requestOptions) throws ApiException, IOException {
        //Add path params
        Map pathParams = new HashMap<>();
        if (grantOfferId == null) {
            throw new IllegalArgumentException("Please provide the grantOfferId path parameter");
        }
        pathParams.put("grantOfferId", grantOfferId);

        String requestBody = null;
        Resource resource = new Resource(this, this.baseURL + "/grantOffers/{grantOfferId}", null);
        String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams);
        return GrantOffer.fromJson(jsonResult);
    }
}