com.klarna.rest.api.checkout.CheckoutOrdersApi 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.checkout;

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

import com.klarna.rest.api.checkout.model.*;

import javax.ws.rs.core.Response.Status;
import javax.ws.rs.core.MediaType;

import java.io.IOException;

/**
 * Checkout API: Orders resource.
 * The checkout API is used to create a checkout with Klarna and update the checkout order during the purchase.
 *
 * As soon as the purchase is completed the order should be read and handled using the
 * {@link OrderManagementOrdersApi Order Management API}
 */
public class CheckoutOrdersApi extends BaseApi {
    protected String PATH = "/checkout/v3/orders";

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

    /**
     * Use this API call to create a new order.
     * The response body will contain the full order object and the location header will contain the
     * URL at which the newly created order can be found.
     *
     * @see examples.CheckoutExample.CreateExample
     *
     * @param order Order data
     * @return server response
     * @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 CheckoutOrder create(final CheckoutOrder order) throws ApiException, IOException {
        final byte[] data = objectMapper.writeValueAsBytes(order);
        final ApiResponse response = this.post(PATH, data);

        response.expectSuccessful()
                .expectStatusCode(Status.CREATED)
                .expectContentType(MediaType.APPLICATION_JSON);

        return fromJson(response.getBody(), CheckoutOrder.class);
    }

    /**
     * Use this API call to read an order from Klarna.
     *
     * 
     *  Note that orders should only be read from the checkout API until the order is completed.
     *  Completed orders should be read using the order management API
     * 
     *
     * @see examples.CheckoutExample.FetchExample
     *
     * @param orderId Order ID
     * @return server response
     * @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 CheckoutOrder fetch(final String orderId) throws ApiException, IOException {
        final ApiResponse response = this.get(PATH + '/' + orderId);

        response.expectSuccessful()
                .expectStatusCode(Status.OK)
                .expectContentType(MediaType.APPLICATION_JSON);

        return fromJson(response.getBody(), CheckoutOrder.class);
    }

    /**
     * Use this API call to read an order from Klarna using Location header got from the API server.
     *
     * @see examples.CheckoutExample.FetchExample
     *
     * @return server response
     * @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 CheckoutOrder fetch() throws ApiException, IOException {
        if (this.location == null) {
            throw new IOException("Unknown location");
        }
        final ApiResponse response = this.get(this.location);

        response.expectSuccessful()
                .expectStatusCode(Status.OK)
                .expectContentType(MediaType.APPLICATION_JSON);

        return fromJson(response.getBody(), CheckoutOrder.class);
    }

    /**
     * To update an order simply provide an object with the properties you want to update.
     * Properties not provided in the request will stay the same.
     *
     * 
     *  Please note: an order can only be updated when the status is checkout_incomplete
     * 
     *
     * @see examples.CheckoutExample.UpdateExample
     *
     * @param orderId Order ID
     * @param order Order data
     * @return server response
     * @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 CheckoutOrder update(final String orderId, final CheckoutOrder order) throws ApiException, IOException {
        final byte[] data = objectMapper.writeValueAsBytes(order);
        final ApiResponse response = this.post(PATH + '/' + orderId, data);

        response.expectSuccessful()
                .expectStatusCode(Status.OK)
                .expectContentType(MediaType.APPLICATION_JSON);

        return fromJson(response.getBody(), CheckoutOrder.class);
    }
}