com.twilio.twiml.voice.Pay Maven / Gradle / Ivy

/**
 * This code was generated by
 * \ / _    _  _|   _  _
 *  | (_)\/(_)(_|\/| |(/_  v1.0.0
 *       /       /
 */

package com.twilio.twiml.voice;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
import com.twilio.converter.Promoter;
import com.twilio.twiml.TwiML;
import com.twilio.twiml.TwiMLException;

import java.net.URI;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

/**
 * TwiML wrapper for {@code }
 */
@JsonDeserialize(builder = Pay.Builder.class)
public class Pay extends TwiML {
    public enum Input {
        DTMF("dtmf");

        private final String value;

        private Input(final String value) {
            this.value = value;
        }

        public String toString() {
            return value;
        }
    }

    public enum StatusCallbackMethod {
        GET("GET"),
        POST("POST");

        private final String value;

        private StatusCallbackMethod(final String value) {
            this.value = value;
        }

        public String toString() {
            return value;
        }
    }

    public enum TokenType {
        ONE_TIME("one-time"),
        REUSABLE("reusable");

        private final String value;

        private TokenType(final String value) {
            this.value = value;
        }

        public String toString() {
            return value;
        }
    }

    public enum ValidCardTypes {
        VISA("visa"),
        MASTERCARD("mastercard"),
        AMEX("amex"),
        MAESTRO("maestro"),
        DISCOVER("discover"),
        OPTIMA("optima"),
        JCB("jcb"),
        DINERS_CLUB("diners-club"),
        ENROUTE("enroute");

        private final String value;

        private ValidCardTypes(final String value) {
            this.value = value;
        }

        public String toString() {
            return value;
        }
    }

    public enum Language {
        DE_DE("de-DE"),
        EN_AU("en-AU"),
        EN_CA("en-CA"),
        EN_GB("en-GB"),
        EN_IN("en-IN"),
        EN_IE("en-IE"),
        EN_NZ("en-NZ"),
        EN_PH("en-PH"),
        EN_ZA("en-ZA"),
        EN_US("en-US"),
        ES_ES("es-ES"),
        ES_US("es-US"),
        FR_CA("fr-CA"),
        FR_FR("fr-FR"),
        IT_IT("it-IT");

        private final String value;

        private Language(final String value) {
            this.value = value;
        }

        public String toString() {
            return value;
        }
    }

    public enum BankAccountType {
        CONSUMER_CHECKING("consumer-checking"),
        CONSUMER_SAVINGS("consumer-savings"),
        COMMERCIAL_CHECKING("commercial-checking"),
        COMMERCIAL_SAVINGS("commercial-savings");

        private final String value;

        private BankAccountType(final String value) {
            this.value = value;
        }

        public String toString() {
            return value;
        }
    }

    public enum PaymentMethod {
        ACH_DEBIT("ach-debit"),
        CREDIT_CARD("credit-card");

        private final String value;

        private PaymentMethod(final String value) {
            this.value = value;
        }

        public String toString() {
            return value;
        }
    }

    private final Pay.Input input;
    private final URI action;
    private final Pay.BankAccountType bankAccountType;
    private final URI statusCallback;
    private final Pay.StatusCallbackMethod statusCallbackMethod;
    private final Integer timeout;
    private final Integer maxAttempts;
    private final Boolean securityCode;
    private final String postalCode;
    private final Integer minPostalCodeLength;
    private final String paymentConnector;
    private final Pay.PaymentMethod paymentMethod;
    private final Pay.TokenType tokenType;
    private final String chargeAmount;
    private final String currency;
    private final String description;
    private final List validCardTypes;
    private final Pay.Language language;

    /**
     * For XML Serialization/Deserialization
     */
    private Pay() {
        this(new Builder());
    }

    /**
     * Create a new {@code } element
     */
    private Pay(Builder b) {
        super("Pay", b);
        this.input = b.input;
        this.action = b.action;
        this.bankAccountType = b.bankAccountType;
        this.statusCallback = b.statusCallback;
        this.statusCallbackMethod = b.statusCallbackMethod;
        this.timeout = b.timeout;
        this.maxAttempts = b.maxAttempts;
        this.securityCode = b.securityCode;
        this.postalCode = b.postalCode;
        this.minPostalCodeLength = b.minPostalCodeLength;
        this.paymentConnector = b.paymentConnector;
        this.paymentMethod = b.paymentMethod;
        this.tokenType = b.tokenType;
        this.chargeAmount = b.chargeAmount;
        this.currency = b.currency;
        this.description = b.description;
        this.validCardTypes = b.validCardTypes;
        this.language = b.language;
    }

    /**
     * Attributes to set on the generated XML element
     *
     * @return A Map of attribute keys to values
     */
    protected Map getElementAttributes() {
        // Preserve order of attributes
        Map attrs = new HashMap<>();

        if (this.getInput() != null) {
            attrs.put("input", this.getInput().toString());
        }
        if (this.getAction() != null) {
            attrs.put("action", this.getAction().toString());
        }
        if (this.getBankAccountType() != null) {
            attrs.put("bankAccountType", this.getBankAccountType().toString());
        }
        if (this.getStatusCallback() != null) {
            attrs.put("statusCallback", this.getStatusCallback().toString());
        }
        if (this.getStatusCallbackMethod() != null) {
            attrs.put("statusCallbackMethod", this.getStatusCallbackMethod().toString());
        }
        if (this.getTimeout() != null) {
            attrs.put("timeout", this.getTimeout().toString());
        }
        if (this.getMaxAttempts() != null) {
            attrs.put("maxAttempts", this.getMaxAttempts().toString());
        }
        if (this.isSecurityCode() != null) {
            attrs.put("securityCode", this.isSecurityCode().toString());
        }
        if (this.getPostalCode() != null) {
            attrs.put("postalCode", this.getPostalCode());
        }
        if (this.getMinPostalCodeLength() != null) {
            attrs.put("minPostalCodeLength", this.getMinPostalCodeLength().toString());
        }
        if (this.getPaymentConnector() != null) {
            attrs.put("paymentConnector", this.getPaymentConnector());
        }
        if (this.getPaymentMethod() != null) {
            attrs.put("paymentMethod", this.getPaymentMethod().toString());
        }
        if (this.getTokenType() != null) {
            attrs.put("tokenType", this.getTokenType().toString());
        }
        if (this.getChargeAmount() != null) {
            attrs.put("chargeAmount", this.getChargeAmount());
        }
        if (this.getCurrency() != null) {
            attrs.put("currency", this.getCurrency());
        }
        if (this.getDescription() != null) {
            attrs.put("description", this.getDescription());
        }
        if (this.getValidCardTypess() != null) {
            attrs.put("validCardTypes", this.getValidCardTypessAsString());
        }
        if (this.getLanguage() != null) {
            attrs.put("language", this.getLanguage().toString());
        }

        return attrs;
    }

    /**
     * Input type Twilio should accept
     *
     * @return Input type Twilio should accept
     */
    public Pay.Input getInput() {
        return input;
    }

    /**
     * Action URL
     *
     * @return Action URL
     */
    public URI getAction() {
        return action;
    }

    /**
     * Bank account type for ach transactions. If set, payment method attribute must
     * be provided and value should be set to ach-debit. defaults to
     * consumer-checking
     *
     * @return Bank account type for ach transactions. If set, payment method
     *         attribute must be provided and value should be set to ach-debit.
     *         defaults to consumer-checking
     */
    public Pay.BankAccountType getBankAccountType() {
        return bankAccountType;
    }

    /**
     * Status callback URL
     *
     * @return Status callback URL
     */
    public URI getStatusCallback() {
        return statusCallback;
    }

    /**
     * Status callback method
     *
     * @return Status callback method
     */
    public Pay.StatusCallbackMethod getStatusCallbackMethod() {
        return statusCallbackMethod;
    }

    /**
     * Time to wait to gather input
     *
     * @return Time to wait to gather input
     */
    public Integer getTimeout() {
        return timeout;
    }

    /**
     * Maximum number of allowed retries when gathering input
     *
     * @return Maximum number of allowed retries when gathering input
     */
    public Integer getMaxAttempts() {
        return maxAttempts;
    }

    /**
     * Prompt for security code
     *
     * @return Prompt for security code
     */
    public Boolean isSecurityCode() {
        return securityCode;
    }

    /**
     * Prompt for postal code and it should be true/false or default postal code
     *
     * @return Prompt for postal code and it should be true/false or default postal
     *         code
     */
    public String getPostalCode() {
        return postalCode;
    }

    /**
     * Prompt for minimum postal code length
     *
     * @return Prompt for minimum postal code length
     */
    public Integer getMinPostalCodeLength() {
        return minPostalCodeLength;
    }

    /**
     * Unique name for payment connector
     *
     * @return Unique name for payment connector
     */
    public String getPaymentConnector() {
        return paymentConnector;
    }

    /**
     * Payment method to be used. defaults to credit-card
     *
     * @return Payment method to be used. defaults to credit-card
     */
    public Pay.PaymentMethod getPaymentMethod() {
        return paymentMethod;
    }

    /**
     * Type of token
     *
     * @return Type of token
     */
    public Pay.TokenType getTokenType() {
        return tokenType;
    }

    /**
     * Amount to process. If value is greater than 0 then make the payment else
     * create a payment token
     *
     * @return Amount to process. If value is greater than 0 then make the payment
     *         else create a payment token
     */
    public String getChargeAmount() {
        return chargeAmount;
    }

    /**
     * Currency of the amount attribute
     *
     * @return Currency of the amount attribute
     */
    public String getCurrency() {
        return currency;
    }

    /**
     * Details regarding the payment
     *
     * @return Details regarding the payment
     */
    public String getDescription() {
        return description;
    }

    /**
     * Comma separated accepted card types
     *
     * @return Comma separated accepted card types
     */
    public List getValidCardTypess() {
        return validCardTypes;
    }

    protected String getValidCardTypessAsString() {
        StringBuilder sb = new StringBuilder();
        Iterator iter = this.getValidCardTypess().iterator();
        while (iter.hasNext()) {
            sb.append(iter.next().toString());
            if (iter.hasNext()) {
                sb.append(" ");
            }
        }
        return sb.toString();
    }

    /**
     * Language to use
     *
     * @return Language to use
     */
    public Pay.Language getLanguage() {
        return language;
    }

    /**
     * Create a new {@code } element
     */
    @JsonPOJOBuilder(withPrefix = "")
    public static class Builder extends TwiML.Builder {
        /**
         * Create and return a {@code } from an XML string
         */
        public static Builder fromXml(final String xml) throws TwiMLException {
            try {
                return OBJECT_MAPPER.readValue(xml, Builder.class);
            } catch (final JsonProcessingException jpe) {
                throw new TwiMLException(
                    "Failed to deserialize a Pay.Builder from the provided XML string: " + jpe.getMessage());
            } catch (final Exception e) {
                throw new TwiMLException("Unhandled exception: " + e.getMessage());
            }
        }

        private Pay.Input input;
        private URI action;
        private Pay.BankAccountType bankAccountType;
        private URI statusCallback;
        private Pay.StatusCallbackMethod statusCallbackMethod;
        private Integer timeout;
        private Integer maxAttempts;
        private Boolean securityCode;
        private String postalCode;
        private Integer minPostalCodeLength;
        private String paymentConnector;
        private Pay.PaymentMethod paymentMethod;
        private Pay.TokenType tokenType;
        private String chargeAmount;
        private String currency;
        private String description;
        private List validCardTypes;
        private Pay.Language language;

        /**
         * Input type Twilio should accept
         */
        @JacksonXmlProperty(isAttribute = true, localName = "input")
        public Builder input(Pay.Input input) {
            this.input = input;
            return this;
        }

        /**
         * Action URL
         */
        @JacksonXmlProperty(isAttribute = true, localName = "action")
        public Builder action(URI action) {
            this.action = action;
            return this;
        }

        /**
         * Action URL
         */
        public Builder action(String action) {
            this.action = Promoter.uriFromString(action);
            return this;
        }

        /**
         * Bank account type for ach transactions. If set, payment method attribute must
         * be provided and value should be set to ach-debit. defaults to
         * consumer-checking
         */
        @JacksonXmlProperty(isAttribute = true, localName = "bankAccountType")
        public Builder bankAccountType(Pay.BankAccountType bankAccountType) {
            this.bankAccountType = bankAccountType;
            return this;
        }

        /**
         * Status callback URL
         */
        @JacksonXmlProperty(isAttribute = true, localName = "statusCallback")
        public Builder statusCallback(URI statusCallback) {
            this.statusCallback = statusCallback;
            return this;
        }

        /**
         * Status callback URL
         */
        public Builder statusCallback(String statusCallback) {
            this.statusCallback = Promoter.uriFromString(statusCallback);
            return this;
        }

        /**
         * Status callback method
         */
        @JacksonXmlProperty(isAttribute = true, localName = "statusCallbackMethod")
        public Builder statusCallbackMethod(Pay.StatusCallbackMethod statusCallbackMethod) {
            this.statusCallbackMethod = statusCallbackMethod;
            return this;
        }

        /**
         * Time to wait to gather input
         */
        @JacksonXmlProperty(isAttribute = true, localName = "timeout")
        public Builder timeout(Integer timeout) {
            this.timeout = timeout;
            return this;
        }

        /**
         * Maximum number of allowed retries when gathering input
         */
        @JacksonXmlProperty(isAttribute = true, localName = "maxAttempts")
        public Builder maxAttempts(Integer maxAttempts) {
            this.maxAttempts = maxAttempts;
            return this;
        }

        /**
         * Prompt for security code
         */
        @JacksonXmlProperty(isAttribute = true, localName = "securityCode")
        public Builder securityCode(Boolean securityCode) {
            this.securityCode = securityCode;
            return this;
        }

        /**
         * Prompt for postal code and it should be true/false or default postal code
         */
        @JacksonXmlProperty(isAttribute = true, localName = "postalCode")
        public Builder postalCode(String postalCode) {
            this.postalCode = postalCode;
            return this;
        }

        /**
         * Prompt for minimum postal code length
         */
        @JacksonXmlProperty(isAttribute = true, localName = "minPostalCodeLength")
        public Builder minPostalCodeLength(Integer minPostalCodeLength) {
            this.minPostalCodeLength = minPostalCodeLength;
            return this;
        }

        /**
         * Unique name for payment connector
         */
        @JacksonXmlProperty(isAttribute = true, localName = "paymentConnector")
        public Builder paymentConnector(String paymentConnector) {
            this.paymentConnector = paymentConnector;
            return this;
        }

        /**
         * Payment method to be used. defaults to credit-card
         */
        @JacksonXmlProperty(isAttribute = true, localName = "paymentMethod")
        public Builder paymentMethod(Pay.PaymentMethod paymentMethod) {
            this.paymentMethod = paymentMethod;
            return this;
        }

        /**
         * Type of token
         */
        @JacksonXmlProperty(isAttribute = true, localName = "tokenType")
        public Builder tokenType(Pay.TokenType tokenType) {
            this.tokenType = tokenType;
            return this;
        }

        /**
         * Amount to process. If value is greater than 0 then make the payment else
         * create a payment token
         */
        @JacksonXmlProperty(isAttribute = true, localName = "chargeAmount")
        public Builder chargeAmount(String chargeAmount) {
            this.chargeAmount = chargeAmount;
            return this;
        }

        /**
         * Currency of the amount attribute
         */
        @JacksonXmlProperty(isAttribute = true, localName = "currency")
        public Builder currency(String currency) {
            this.currency = currency;
            return this;
        }

        /**
         * Details regarding the payment
         */
        @JacksonXmlProperty(isAttribute = true, localName = "description")
        public Builder description(String description) {
            this.description = description;
            return this;
        }

        /**
         * Comma separated accepted card types
         */
        @JacksonXmlProperty(isAttribute = true, localName = "validCardTypes")
        public Builder validCardTypes(List validCardTypes) {
            this.validCardTypes = validCardTypes;
            return this;
        }

        /**
         * Comma separated accepted card types
         */
        public Builder validCardTypes(Pay.ValidCardTypes validCardTypes) {
            this.validCardTypes = Promoter.listOfOne(validCardTypes);
            return this;
        }

        /**
         * Language to use
         */
        @JacksonXmlProperty(isAttribute = true, localName = "language")
        public Builder language(Pay.Language language) {
            this.language = language;
            return this;
        }

        /**
         * Add a child {@code } element
         */
        @JacksonXmlProperty(isAttribute = false, localName = "Prompt")
        public Builder prompt(Prompt prompt) {
            this.children.add(prompt);
            return this;
        }

        /**
         * Add a child {@code } element
         */
        @JacksonXmlProperty(isAttribute = false, localName = "Parameter")
        public Builder parameter(Parameter parameter) {
            this.children.add(parameter);
            return this;
        }

        /**
         * Create and return resulting {@code } element
         */
        public Pay build() {
            return new Pay(this);
        }
    }
}