com.klarna.rest.api.settlements.SettlementsReportsApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kco-rest Show documentation
Klarna REST Java SDK
The newest version!
/*
 * Copyright 2018 Klarna AB
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.klarna.rest.api.settlements;

import com.klarna.rest.api.BaseApi;
import com.klarna.rest.http_transport.HttpTransport;
import com.klarna.rest.model.ApiException;
import com.klarna.rest.model.ApiResponse;

import javax.ws.rs.core.Response;
import java.io.IOException;
import java.util.Map;

/**
 * Settlements API: Reports resource.
 *
 * This API gives you access to your payouts and transactions.
 *
 * Resources are split into two broad types:
 *
 * 
 *  Collections, including pagination information: collections are queryable,
 *      typically by the attributes of the sub-resource as well as pagination
 *  Entity resources containing a single entity
 * 
 */
public class SettlementsReportsApi extends BaseApi {
    protected String PATH = "/settlements/v1/reports";

    public SettlementsReportsApi(final HttpTransport transport) {
        super(transport);
    }

    /**
     * Gets CSV payout report.
     *
     * More information about this CSV format is available at:
     * Settlement-files
     *
     * @see URL params
     * @see examples.SettlementsExample.GetCSVPayoutReportExample
     *
     * @param urlParams extra URL params
     * @return CSV binary content
     * @throws ApiException if API server returned non-20x HTTP CODE and response contains
     *                      a Error
     * @throws IOException if an error occurred when connecting to the server or when parsing a response.
     */
    public byte[] getCSVPayoutReport(final Map urlParams) throws ApiException, IOException {
        final String path = String.format("%s/%s?%s",
                PATH,
                "payout-with-transactions",
                BaseApi.buildQueryString(urlParams)
        );
        final ApiResponse response = this.get(path);
        response.expectSuccessful()
                .expectStatusCode(Response.Status.OK)
                .expectContentType("text/csv");

        return response.getBody();
    }

    /**
     * Gets CSV summary report.
     *
     * More information about this CSV format is available at:
     * Settlement-files
     *
     * @see URL params
     * @see examples.SettlementsExample.GetCSVSummaryExample
     *
     * @param urlParams extra URL params
     * @return CSV binary content
     * @throws ApiException if API server returned non-20x HTTP CODE and response contains
     *                      a Error
     * @throws IOException if an error occurred when connecting to the server or when parsing a response.
     */
    public byte[] getCSVSummary(final Map urlParams) throws ApiException, IOException {
        final String path = String.format("%s/%s?%s",
                PATH,
                "payouts-summary-with-transactions",
                BaseApi.buildQueryString(urlParams)
        );
        final ApiResponse response = this.get(path);
        response.expectSuccessful()
                .expectStatusCode(Response.Status.OK)
                .expectContentType("text/csv");

        return response.getBody();
    }

    /**
     * Gets PDF payout summary report.
     *
     * @see URL params
     * @see examples.SettlementsExample.GetPDFPayoutReportExample
     *
     * @param urlParams extra URL params
     * @return PDF binary content
     * @throws ApiException if API server returned non-20x HTTP CODE and response contains
     *                      a Error
     * @throws IOException if an error occurred when connecting to the server or when parsing a response.
     */
    public byte[] getPDFPayoutsSummaryReport(final Map urlParams) throws ApiException, IOException {
        final String path = String.format("%s/%s?%s", PATH, "payout", BaseApi.buildQueryString(urlParams));
        final ApiResponse response = this.get(path);
        response.expectSuccessful()
                .expectStatusCode(Response.Status.OK)
                .expectContentType("application/pdf");

        return response.getBody();
    }

    /**
     * Gets PDF summary.
     *
     * @see URL params
     * @see examples.SettlementsExample.GetPDFSummaryExample
     *
     * @param urlParams extra URL params
     * @return PDF binary content
     * @throws ApiException if API server returned non-20x HTTP CODE and response contains
     *                      a Error
     * @throws IOException if an error occurred when connecting to the server or when parsing a response.
     */
    public byte[] getPDFSummary(final Map urlParams) throws ApiException, IOException {
        final String path = String.format("%s/%s?%s", PATH, "payouts-summary", BaseApi.buildQueryString(urlParams));
        final ApiResponse response = this.get(path);
        response.expectSuccessful()
                .expectStatusCode(Response.Status.OK)
                .expectContentType("application/pdf");

        return response.getBody();
    }
}