com.squareup.square.models.BulkUpdateCustomersResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of square Show documentation
Java client library for the Square API
There is a newer version: 41.2.0.20241017

package com.squareup.square.models;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.squareup.square.http.client.HttpContext;
import java.util.List;
import java.util.Map;
import java.util.Objects;

/**
 * This is a model class for BulkUpdateCustomersResponse type.
 */
public class BulkUpdateCustomersResponse {
    private HttpContext httpContext;
    private final Map responses;
    private final List errors;

    /**
     * Initialization constructor.
     * @param  responses  Map of String, value for responses.
     * @param  errors  List of Error value for errors.
     */
    @JsonCreator
    public BulkUpdateCustomersResponse(
            @JsonProperty("responses") Map responses,
            @JsonProperty("errors") List errors) {
        this.responses = responses;
        this.errors = errors;
    }

    @JsonIgnore
    public HttpContext getContext() {
        return httpContext;
    }

    /**
     * Getter for Responses.
     * A map of responses that correspond to individual update requests, represented by key-value
     * pairs. Each key is the customer ID that was specified for an update request and each value is
     * the corresponding response. If the request succeeds, the value is the updated customer
     * profile. If the request fails, the value contains any errors that occurred during the
     * request.
     * @return Returns the Map of String, UpdateCustomerResponse
     */
    @JsonGetter("responses")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public Map getResponses() {
        return responses;
    }

    /**
     * Getter for Errors.
     * Any top-level errors that prevented the bulk operation from running.
     * @return Returns the List of Error
     */
    @JsonGetter("errors")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public List getErrors() {
        return errors;
    }

    @Override
    public int hashCode() {
        return Objects.hash(responses, errors);
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == this) {
            return true;
        }
        if (!(obj instanceof BulkUpdateCustomersResponse)) {
            return false;
        }
        BulkUpdateCustomersResponse other = (BulkUpdateCustomersResponse) obj;
        return Objects.equals(responses, other.responses)
            && Objects.equals(errors, other.errors);
    }

    /**
     * Converts this BulkUpdateCustomersResponse into string format.
     * @return String representation of this class
     */
    @Override
    public String toString() {
        return "BulkUpdateCustomersResponse [" + "responses=" + responses + ", errors=" + errors
                + "]";
    }

    /**
     * Builds a new {@link BulkUpdateCustomersResponse.Builder} object.
     * Creates the instance with the state of the current model.
     * @return a new {@link BulkUpdateCustomersResponse.Builder} object
     */
    public Builder toBuilder() {
        Builder builder = new Builder()
                .responses(getResponses())
                .errors(getErrors());
        return builder;
    }

    /**
     * Class to build instances of {@link BulkUpdateCustomersResponse}.
     */
    public static class Builder {
        private HttpContext httpContext;
        private Map responses;
        private List errors;



        /**
         * Setter for httpContext.
         * @param  httpContext  HttpContext value for httpContext.
         * @return Builder
         */
        public Builder httpContext(HttpContext httpContext) {
            this.httpContext = httpContext;
            return this;
        }

        /**
         * Setter for responses.
         * @param  responses  Map of String, value for responses.
         * @return Builder
         */
        public Builder responses(Map responses) {
            this.responses = responses;
            return this;
        }

        /**
         * Setter for errors.
         * @param  errors  List of Error value for errors.
         * @return Builder
         */
        public Builder errors(List errors) {
            this.errors = errors;
            return this;
        }

        /**
         * Builds a new {@link BulkUpdateCustomersResponse} object using the set fields.
         * @return {@link BulkUpdateCustomersResponse}
         */
        public BulkUpdateCustomersResponse build() {
            BulkUpdateCustomersResponse model =
                    new BulkUpdateCustomersResponse(responses, errors);
            model.httpContext = httpContext;
            return model;
        }
    }
}