com.gocardless.services.TransferredMandateService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gocardless-pro Show documentation

Client library for accessing the GoCardless Pro API

There is a newer version: 6.0.0

package com.gocardless.services;

import com.gocardless.http.*;
import com.gocardless.resources.TransferredMandate;
import com.google.common.collect.ImmutableMap;
import java.util.Map;

/**
 * Service class for working with transferred mandate resources.
 *
 * Mandates that have been transferred using Current Account Switch Service
 */
public class TransferredMandateService {
    private final HttpClient httpClient;

    /**
     * Constructor. Users of this library should have no need to call this - an instance of this
     * class can be obtained by calling
     * {@link com.gocardless.GoCardlessClient#transferredMandates() }.
     */
    public TransferredMandateService(HttpClient httpClient) {
        this.httpClient = httpClient;
    }

    /**
     * Returns new customer bank details for a mandate that's been recently transferred
     */
    public TransferredMandateTransferredMandatesRequest transferredMandates(String identity) {
        return new TransferredMandateTransferredMandatesRequest(httpClient, identity);
    }

    /**
     * Request class for {@link TransferredMandateService#transferredMandates }.
     *
     * Returns new customer bank details for a mandate that's been recently transferred
     */
    public static final class TransferredMandateTransferredMandatesRequest
            extends GetRequest {
        @PathParam
        private final String identity;

        private TransferredMandateTransferredMandatesRequest(HttpClient httpClient,
                String identity) {
            super(httpClient);
            this.identity = identity;
        }

        public TransferredMandateTransferredMandatesRequest withHeader(String headerName,
                String headerValue) {
            this.addHeader(headerName, headerValue);
            return this;
        }

        @Override
        protected Map getPathParams() {
            ImmutableMap.Builder params = ImmutableMap.builder();
            params.put("identity", identity);
            return params.build();
        }

        @Override
        protected Map getQueryParams() {
            ImmutableMap.Builder params = ImmutableMap.builder();
            params.putAll(super.getQueryParams());
            return params.build();
        }

        @Override
        protected String getPathTemplate() {
            return "transferred_mandates/:identity";
        }

        @Override
        protected String getEnvelope() {
            return "transferred_mandates";
        }

        @Override
        protected Class getResponseClass() {
            return TransferredMandate.class;
        }
    }
}