com.squareup.square.legacy.models.Transaction Maven / Gradle / Ivy
package com.squareup.square.legacy.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.fasterxml.jackson.databind.annotation.JsonSerialize;
import io.apimatic.core.types.OptionalNullable;
import java.util.List;
import java.util.Objects;
/**
* This is a model class for Transaction type.
*/
public class Transaction {
private final String id;
private final OptionalNullable locationId;
private final String createdAt;
private final OptionalNullable> tenders;
private final OptionalNullable> refunds;
private final OptionalNullable referenceId;
private final String product;
private final OptionalNullable clientId;
private final Address shippingAddress;
private final OptionalNullable orderId;
/**
* Initialization constructor.
* @param id String value for id.
* @param locationId String value for locationId.
* @param createdAt String value for createdAt.
* @param tenders List of Tender value for tenders.
* @param refunds List of Refund value for refunds.
* @param referenceId String value for referenceId.
* @param product String value for product.
* @param clientId String value for clientId.
* @param shippingAddress Address value for shippingAddress.
* @param orderId String value for orderId.
*/
@JsonCreator
public Transaction(
@JsonProperty("id") String id,
@JsonProperty("location_id") String locationId,
@JsonProperty("created_at") String createdAt,
@JsonProperty("tenders") List tenders,
@JsonProperty("refunds") List refunds,
@JsonProperty("reference_id") String referenceId,
@JsonProperty("product") String product,
@JsonProperty("client_id") String clientId,
@JsonProperty("shipping_address") Address shippingAddress,
@JsonProperty("order_id") String orderId) {
this.id = id;
this.locationId = OptionalNullable.of(locationId);
this.createdAt = createdAt;
this.tenders = OptionalNullable.of(tenders);
this.refunds = OptionalNullable.of(refunds);
this.referenceId = OptionalNullable.of(referenceId);
this.product = product;
this.clientId = OptionalNullable.of(clientId);
this.shippingAddress = shippingAddress;
this.orderId = OptionalNullable.of(orderId);
}
/**
* Initialization constructor.
* @param id String value for id.
* @param locationId String value for locationId.
* @param createdAt String value for createdAt.
* @param tenders List of Tender value for tenders.
* @param refunds List of Refund value for refunds.
* @param referenceId String value for referenceId.
* @param product String value for product.
* @param clientId String value for clientId.
* @param shippingAddress Address value for shippingAddress.
* @param orderId String value for orderId.
*/
protected Transaction(
String id,
OptionalNullable locationId,
String createdAt,
OptionalNullable> tenders,
OptionalNullable> refunds,
OptionalNullable referenceId,
String product,
OptionalNullable clientId,
Address shippingAddress,
OptionalNullable orderId) {
this.id = id;
this.locationId = locationId;
this.createdAt = createdAt;
this.tenders = tenders;
this.refunds = refunds;
this.referenceId = referenceId;
this.product = product;
this.clientId = clientId;
this.shippingAddress = shippingAddress;
this.orderId = orderId;
}
/**
* Getter for Id.
* The transaction's unique ID, issued by Square payments servers.
* @return Returns the String
*/
@JsonGetter("id")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getId() {
return id;
}
/**
* Internal Getter for LocationId.
* The ID of the transaction's associated location.
* @return Returns the Internal String
*/
@JsonGetter("location_id")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetLocationId() {
return this.locationId;
}
/**
* Getter for LocationId.
* The ID of the transaction's associated location.
* @return Returns the String
*/
@JsonIgnore
public String getLocationId() {
return OptionalNullable.getFrom(locationId);
}
/**
* Getter for CreatedAt.
* The timestamp for when the transaction was created, in RFC 3339 format.
* @return Returns the String
*/
@JsonGetter("created_at")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getCreatedAt() {
return createdAt;
}
/**
* Internal Getter for Tenders.
* The tenders used to pay in the transaction.
* @return Returns the Internal List of Tender
*/
@JsonGetter("tenders")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable> internalGetTenders() {
return this.tenders;
}
/**
* Getter for Tenders.
* The tenders used to pay in the transaction.
* @return Returns the List of Tender
*/
@JsonIgnore
public List getTenders() {
return OptionalNullable.getFrom(tenders);
}
/**
* Internal Getter for Refunds.
* Refunds that have been applied to any tender in the transaction.
* @return Returns the Internal List of Refund
*/
@JsonGetter("refunds")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable> internalGetRefunds() {
return this.refunds;
}
/**
* Getter for Refunds.
* Refunds that have been applied to any tender in the transaction.
* @return Returns the List of Refund
*/
@JsonIgnore
public List getRefunds() {
return OptionalNullable.getFrom(refunds);
}
/**
* Internal Getter for ReferenceId.
* If the transaction was created with the [Charge](api-endpoint:Transactions-Charge) endpoint,
* this value is the same as the value provided for the `reference_id` parameter in the request
* to that endpoint. Otherwise, it is not set.
* @return Returns the Internal String
*/
@JsonGetter("reference_id")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetReferenceId() {
return this.referenceId;
}
/**
* Getter for ReferenceId.
* If the transaction was created with the [Charge](api-endpoint:Transactions-Charge) endpoint,
* this value is the same as the value provided for the `reference_id` parameter in the request
* to that endpoint. Otherwise, it is not set.
* @return Returns the String
*/
@JsonIgnore
public String getReferenceId() {
return OptionalNullable.getFrom(referenceId);
}
/**
* Getter for Product.
* Indicates the Square product used to process a transaction.
* @return Returns the String
*/
@JsonGetter("product")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getProduct() {
return product;
}
/**
* Internal Getter for ClientId.
* If the transaction was created in the Square Point of Sale app, this value is the ID
* generated for the transaction by Square Point of Sale. This ID has no relationship to the
* transaction's canonical `id`, which is generated by Square's backend servers. This value is
* generated for bookkeeping purposes, in case the transaction cannot immediately be completed
* (for example, if the transaction is processed in offline mode). It is not currently possible
* with the Connect API to perform a transaction lookup by this value.
* @return Returns the Internal String
*/
@JsonGetter("client_id")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetClientId() {
return this.clientId;
}
/**
* Getter for ClientId.
* If the transaction was created in the Square Point of Sale app, this value is the ID
* generated for the transaction by Square Point of Sale. This ID has no relationship to the
* transaction's canonical `id`, which is generated by Square's backend servers. This value is
* generated for bookkeeping purposes, in case the transaction cannot immediately be completed
* (for example, if the transaction is processed in offline mode). It is not currently possible
* with the Connect API to perform a transaction lookup by this value.
* @return Returns the String
*/
@JsonIgnore
public String getClientId() {
return OptionalNullable.getFrom(clientId);
}
/**
* Getter for ShippingAddress.
* Represents a postal address in a country. For more information, see [Working with
* Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).
* @return Returns the Address
*/
@JsonGetter("shipping_address")
@JsonInclude(JsonInclude.Include.NON_NULL)
public Address getShippingAddress() {
return shippingAddress;
}
/**
* Internal Getter for OrderId.
* The order_id is an identifier for the order associated with this transaction, if any.
* @return Returns the Internal String
*/
@JsonGetter("order_id")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetOrderId() {
return this.orderId;
}
/**
* Getter for OrderId.
* The order_id is an identifier for the order associated with this transaction, if any.
* @return Returns the String
*/
@JsonIgnore
public String getOrderId() {
return OptionalNullable.getFrom(orderId);
}
@Override
public int hashCode() {
return Objects.hash(
id, locationId, createdAt, tenders, refunds, referenceId, product, clientId, shippingAddress, orderId);
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof Transaction)) {
return false;
}
Transaction other = (Transaction) obj;
return Objects.equals(id, other.id)
&& Objects.equals(locationId, other.locationId)
&& Objects.equals(createdAt, other.createdAt)
&& Objects.equals(tenders, other.tenders)
&& Objects.equals(refunds, other.refunds)
&& Objects.equals(referenceId, other.referenceId)
&& Objects.equals(product, other.product)
&& Objects.equals(clientId, other.clientId)
&& Objects.equals(shippingAddress, other.shippingAddress)
&& Objects.equals(orderId, other.orderId);
}
/**
* Converts this Transaction into string format.
* @return String representation of this class
*/
@Override
public String toString() {
return "Transaction [" + "id=" + id + ", locationId=" + locationId + ", createdAt="
+ createdAt + ", tenders=" + tenders + ", refunds=" + refunds + ", referenceId="
+ referenceId + ", product=" + product + ", clientId=" + clientId
+ ", shippingAddress=" + shippingAddress + ", orderId=" + orderId + "]";
}
/**
* Builds a new {@link Transaction.Builder} object.
* Creates the instance with the state of the current model.
* @return a new {@link Transaction.Builder} object
*/
public Builder toBuilder() {
Builder builder = new Builder()
.id(getId())
.createdAt(getCreatedAt())
.product(getProduct())
.shippingAddress(getShippingAddress());
builder.locationId = internalGetLocationId();
builder.tenders = internalGetTenders();
builder.refunds = internalGetRefunds();
builder.referenceId = internalGetReferenceId();
builder.clientId = internalGetClientId();
builder.orderId = internalGetOrderId();
return builder;
}
/**
* Class to build instances of {@link Transaction}.
*/
public static class Builder {
private String id;
private OptionalNullable locationId;
private String createdAt;
private OptionalNullable> tenders;
private OptionalNullable> refunds;
private OptionalNullable referenceId;
private String product;
private OptionalNullable clientId;
private Address shippingAddress;
private OptionalNullable orderId;
/**
* Setter for id.
* @param id String value for id.
* @return Builder
*/
public Builder id(String id) {
this.id = id;
return this;
}
/**
* Setter for locationId.
* @param locationId String value for locationId.
* @return Builder
*/
public Builder locationId(String locationId) {
this.locationId = OptionalNullable.of(locationId);
return this;
}
/**
* UnSetter for locationId.
* @return Builder
*/
public Builder unsetLocationId() {
locationId = null;
return this;
}
/**
* Setter for createdAt.
* @param createdAt String value for createdAt.
* @return Builder
*/
public Builder createdAt(String createdAt) {
this.createdAt = createdAt;
return this;
}
/**
* Setter for tenders.
* @param tenders List of Tender value for tenders.
* @return Builder
*/
public Builder tenders(List tenders) {
this.tenders = OptionalNullable.of(tenders);
return this;
}
/**
* UnSetter for tenders.
* @return Builder
*/
public Builder unsetTenders() {
tenders = null;
return this;
}
/**
* Setter for refunds.
* @param refunds List of Refund value for refunds.
* @return Builder
*/
public Builder refunds(List refunds) {
this.refunds = OptionalNullable.of(refunds);
return this;
}
/**
* UnSetter for refunds.
* @return Builder
*/
public Builder unsetRefunds() {
refunds = null;
return this;
}
/**
* Setter for referenceId.
* @param referenceId String value for referenceId.
* @return Builder
*/
public Builder referenceId(String referenceId) {
this.referenceId = OptionalNullable.of(referenceId);
return this;
}
/**
* UnSetter for referenceId.
* @return Builder
*/
public Builder unsetReferenceId() {
referenceId = null;
return this;
}
/**
* Setter for product.
* @param product String value for product.
* @return Builder
*/
public Builder product(String product) {
this.product = product;
return this;
}
/**
* Setter for clientId.
* @param clientId String value for clientId.
* @return Builder
*/
public Builder clientId(String clientId) {
this.clientId = OptionalNullable.of(clientId);
return this;
}
/**
* UnSetter for clientId.
* @return Builder
*/
public Builder unsetClientId() {
clientId = null;
return this;
}
/**
* Setter for shippingAddress.
* @param shippingAddress Address value for shippingAddress.
* @return Builder
*/
public Builder shippingAddress(Address shippingAddress) {
this.shippingAddress = shippingAddress;
return this;
}
/**
* Setter for orderId.
* @param orderId String value for orderId.
* @return Builder
*/
public Builder orderId(String orderId) {
this.orderId = OptionalNullable.of(orderId);
return this;
}
/**
* UnSetter for orderId.
* @return Builder
*/
public Builder unsetOrderId() {
orderId = null;
return this;
}
/**
* Builds a new {@link Transaction} object using the set fields.
* @return {@link Transaction}
*/
public Transaction build() {
return new Transaction(
id,
locationId,
createdAt,
tenders,
refunds,
referenceId,
product,
clientId,
shippingAddress,
orderId);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy