All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.cashfree.pg.model.CFRefundRequest Maven / Gradle / Ivy

There is a newer version: 2.1.7
Show newest version
/*
 * New Payment Gateway APIs
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 2022-01-01
 * Contact: [email protected]
 *
 * 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.cashfree.pg.model;


import com.cashfree.pg.JSON;
import com.google.gson.Gson;
import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.TypeAdapter;
import com.google.gson.TypeAdapterFactory;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.reflect.TypeToken;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Map.Entry;
import java.util.Objects;
import java.util.Set;

/** CFRefundRequest */
@javax.annotation.Generated(
        value = "org.openapitools.codegen.languages.JavaClientCodegen",
        date = "2023-03-16T14:01:52.135917+05:30[Asia/Kolkata]")
public class CFRefundRequest {
    public static final String SERIALIZED_NAME_REFUND_AMOUNT = "refund_amount";

    @SerializedName(SERIALIZED_NAME_REFUND_AMOUNT)
    private Double refundAmount;

    public static final String SERIALIZED_NAME_REFUND_ID = "refund_id";

    @SerializedName(SERIALIZED_NAME_REFUND_ID)
    private String refundId;

    public static final String SERIALIZED_NAME_REFUND_NOTE = "refund_note";

    @SerializedName(SERIALIZED_NAME_REFUND_NOTE)
    private String refundNote;

    /**
     * Speed at which the refund is processed. It's an optional field with default being
     * STANDARD
     */
    @JsonAdapter(RefundSpeedEnum.Adapter.class)
    public enum RefundSpeedEnum {
        STANDARD("STANDARD"),

        INSTANT("INSTANT");

        private String value;

        RefundSpeedEnum(String value) {
            this.value = value;
        }

        public String getValue() {
            return value;
        }

        @Override
        public String toString() {
            return String.valueOf(value);
        }

        public static RefundSpeedEnum fromValue(String value) {
            for (RefundSpeedEnum b : RefundSpeedEnum.values()) {
                if (b.value.equals(value)) {
                    return b;
                }
            }
            throw new IllegalArgumentException("Unexpected value '" + value + "'");
        }

        public static class Adapter extends TypeAdapter {
            @Override
            public void write(final JsonWriter jsonWriter, final RefundSpeedEnum enumeration)
                    throws IOException {
                jsonWriter.value(enumeration.getValue());
            }

            @Override
            public RefundSpeedEnum read(final JsonReader jsonReader) throws IOException {
                String value = jsonReader.nextString();
                return RefundSpeedEnum.fromValue(value);
            }
        }
    }

    public static final String SERIALIZED_NAME_REFUND_SPEED = "refund_speed";

    @SerializedName(SERIALIZED_NAME_REFUND_SPEED)
    private RefundSpeedEnum refundSpeed;

    public static final String SERIALIZED_NAME_REFUND_SPLITS = "refund_splits";

    @SerializedName(SERIALIZED_NAME_REFUND_SPLITS)
    private List refundSplits = new ArrayList<>();

    public CFRefundRequest() {}

    public CFRefundRequest refundAmount(Double refundAmount) {

        this.refundAmount = refundAmount;
        return this;
    }

    /**
     * Amount to be refunded. Should be lesser than or equal to the transaction amount. (Decimals
     * allowed)
     *
     * @return refundAmount
     */
    @javax.annotation.Nonnull
    public Double getRefundAmount() {
        return refundAmount;
    }

    public void setRefundAmount(Double refundAmount) {
        this.refundAmount = refundAmount;
    }

    public CFRefundRequest refundId(String refundId) {

        this.refundId = refundId;
        return this;
    }

    /**
     * An unique ID to associate the refund with. Provie alphanumeric values
     *
     * @return refundId
     */
    @javax.annotation.Nonnull
    public String getRefundId() {
        return refundId;
    }

    public void setRefundId(String refundId) {
        this.refundId = refundId;
    }

    public CFRefundRequest refundNote(String refundNote) {

        this.refundNote = refundNote;
        return this;
    }

    /**
     * A refund note for your reference.
     *
     * @return refundNote
     */
    @javax.annotation.Nullable
    public String getRefundNote() {
        return refundNote;
    }

    public void setRefundNote(String refundNote) {
        this.refundNote = refundNote;
    }

    public CFRefundRequest refundSpeed(RefundSpeedEnum refundSpeed) {

        this.refundSpeed = refundSpeed;
        return this;
    }

    /**
     * Speed at which the refund is processed. It's an optional field with default being
     * STANDARD
     *
     * @return refundSpeed
     */
    @javax.annotation.Nullable
    public RefundSpeedEnum getRefundSpeed() {
        return refundSpeed;
    }

    public void setRefundSpeed(RefundSpeedEnum refundSpeed) {
        this.refundSpeed = refundSpeed;
    }

    public CFRefundRequest refundSplits(List refundSplits) {

        this.refundSplits = refundSplits;
        return this;
    }

    public CFRefundRequest addRefundSplitsItem(CFVendorSplit refundSplitsItem) {
        if (this.refundSplits == null) {
            this.refundSplits = new ArrayList<>();
        }
        this.refundSplits.add(refundSplitsItem);
        return this;
    }

    /**
     * Get refundSplits
     *
     * @return refundSplits
     */
    @javax.annotation.Nullable
    public List getRefundSplits() {
        return refundSplits;
    }

    public void setRefundSplits(List refundSplits) {
        this.refundSplits = refundSplits;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        CFRefundRequest cfRefundRequest = (CFRefundRequest) o;
        return Objects.equals(this.refundAmount, cfRefundRequest.refundAmount)
                && Objects.equals(this.refundId, cfRefundRequest.refundId)
                && Objects.equals(this.refundNote, cfRefundRequest.refundNote)
                && Objects.equals(this.refundSpeed, cfRefundRequest.refundSpeed)
                && Objects.equals(this.refundSplits, cfRefundRequest.refundSplits);
    }

    @Override
    public int hashCode() {
        return Objects.hash(refundAmount, refundId, refundNote, refundSpeed, refundSplits);
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("class CFRefundRequest {\n");
        sb.append("    refundAmount: ").append(toIndentedString(refundAmount)).append("\n");
        sb.append("    refundId: ").append(toIndentedString(refundId)).append("\n");
        sb.append("    refundNote: ").append(toIndentedString(refundNote)).append("\n");
        sb.append("    refundSpeed: ").append(toIndentedString(refundSpeed)).append("\n");
        sb.append("    refundSplits: ").append(toIndentedString(refundSplits)).append("\n");
        sb.append("}");
        return sb.toString();
    }

    /**
     * Convert the given object to string with each line indented by 4 spaces (except the first
     * line).
     */
    private String toIndentedString(Object o) {
        if (o == null) {
            return "null";
        }
        return o.toString().replace("\n", "\n    ");
    }

    public static HashSet openapiFields;
    public static HashSet openapiRequiredFields;

    static {
        // a set of all properties/fields (JSON key names)
        openapiFields = new HashSet();
        openapiFields.add("refund_amount");
        openapiFields.add("refund_id");
        openapiFields.add("refund_note");
        openapiFields.add("refund_speed");
        openapiFields.add("refund_splits");

        // a set of required properties/fields (JSON key names)
        openapiRequiredFields = new HashSet();
        openapiRequiredFields.add("refund_amount");
        openapiRequiredFields.add("refund_id");
    }

    /**
     * Validates the JSON Object and throws an exception if issues found
     *
     * @param jsonObj JSON Object
     * @throws IOException if the JSON Object is invalid with respect to CFRefundRequest
     */
    public static void validateJsonObject(JsonObject jsonObj) throws IOException {
        if (jsonObj == null) {
            if (!CFRefundRequest.openapiRequiredFields
                    .isEmpty()) { // has required fields but JSON object is null
                throw new IllegalArgumentException(
                        String.format(
                                "The required field(s) %s in CFRefundRequest is not found in the"
                                        + " empty JSON string",
                                CFRefundRequest.openapiRequiredFields.toString()));
            }
        }

        Set> entries = jsonObj.entrySet();
        // check to see if the JSON string contains additional fields
        for (Entry entry : entries) {
            if (!CFRefundRequest.openapiFields.contains(entry.getKey())) {
                throw new IllegalArgumentException(
                        String.format(
                                "The field `%s` in the JSON string is not defined in the"
                                        + " `CFRefundRequest` properties. JSON: %s",
                                entry.getKey(), jsonObj.toString()));
            }
        }

        // check to make sure all required properties/fields are present in the JSON string
        for (String requiredField : CFRefundRequest.openapiRequiredFields) {
            if (jsonObj.get(requiredField) == null) {
                throw new IllegalArgumentException(
                        String.format(
                                "The required field `%s` is not found in the JSON string: %s",
                                requiredField, jsonObj.toString()));
            }
        }
        if (!jsonObj.get("refund_id").isJsonPrimitive()) {
            throw new IllegalArgumentException(
                    String.format(
                            "Expected the field `refund_id` to be a primitive type in the JSON"
                                    + " string but got `%s`",
                            jsonObj.get("refund_id").toString()));
        }
        if ((jsonObj.get("refund_note") != null && !jsonObj.get("refund_note").isJsonNull())
                && !jsonObj.get("refund_note").isJsonPrimitive()) {
            throw new IllegalArgumentException(
                    String.format(
                            "Expected the field `refund_note` to be a primitive type in the JSON"
                                    + " string but got `%s`",
                            jsonObj.get("refund_note").toString()));
        }
        if ((jsonObj.get("refund_speed") != null && !jsonObj.get("refund_speed").isJsonNull())
                && !jsonObj.get("refund_speed").isJsonPrimitive()) {
            throw new IllegalArgumentException(
                    String.format(
                            "Expected the field `refund_speed` to be a primitive type in the JSON"
                                    + " string but got `%s`",
                            jsonObj.get("refund_speed").toString()));
        }
        if (jsonObj.get("refund_splits") != null && !jsonObj.get("refund_splits").isJsonNull()) {
            JsonArray jsonArrayrefundSplits = jsonObj.getAsJsonArray("refund_splits");
            if (jsonArrayrefundSplits != null) {
                // ensure the json data is an array
                if (!jsonObj.get("refund_splits").isJsonArray()) {
                    throw new IllegalArgumentException(
                            String.format(
                                    "Expected the field `refund_splits` to be an array in the JSON"
                                            + " string but got `%s`",
                                    jsonObj.get("refund_splits").toString()));
                }

                // validate the optional field `refund_splits` (array)
                for (int i = 0; i < jsonArrayrefundSplits.size(); i++) {
                    CFVendorSplit.validateJsonObject(
                            jsonArrayrefundSplits.get(i).getAsJsonObject());
                }
                ;
            }
        }
    }

    public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
        @SuppressWarnings("unchecked")
        @Override
        public  TypeAdapter create(Gson gson, TypeToken type) {
            if (!CFRefundRequest.class.isAssignableFrom(type.getRawType())) {
                return null; // this class only serializes 'CFRefundRequest' and its subtypes
            }
            final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
            final TypeAdapter thisAdapter =
                    gson.getDelegateAdapter(this, TypeToken.get(CFRefundRequest.class));

            return (TypeAdapter)
                    new TypeAdapter() {
                        @Override
                        public void write(JsonWriter out, CFRefundRequest value)
                                throws IOException {
                            JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
                            elementAdapter.write(out, obj);
                        }

                        @Override
                        public CFRefundRequest read(JsonReader in) throws IOException {
                            JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
                            validateJsonObject(jsonObj);
                            return thisAdapter.fromJsonTree(jsonObj);
                        }
                    }.nullSafe();
        }
    }

    /**
     * Create an instance of CFRefundRequest given an JSON string
     *
     * @param jsonString JSON string
     * @return An instance of CFRefundRequest
     * @throws IOException if the JSON string is invalid with respect to CFRefundRequest
     */
    public static CFRefundRequest fromJson(String jsonString) throws IOException {
        return JSON.getGson().fromJson(jsonString, CFRefundRequest.class);
    }

    /**
     * Convert an instance of CFRefundRequest to an JSON string
     *
     * @return JSON string
     */
    public String toJson() {
        return JSON.getGson().toJson(this);
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy