com.stripe.model.Topup Maven / Gradle / Ivy
// Generated by delombok at Thu Mar 12 08:35:04 PDT 2020
package com.stripe.model;
import com.google.gson.annotations.SerializedName;
import com.stripe.Stripe;
import com.stripe.exception.StripeException;
import com.stripe.net.ApiResource;
import com.stripe.net.RequestOptions;
import com.stripe.param.TopupCancelParams;
import com.stripe.param.TopupCreateParams;
import com.stripe.param.TopupListParams;
import com.stripe.param.TopupRetrieveParams;
import com.stripe.param.TopupUpdateParams;
import java.util.Map;
public class Topup extends ApiResource implements MetadataStore, BalanceTransactionSource {
/**
* Amount transferred.
*/
@SerializedName("amount")
Long amount;
/**
* ID of the balance transaction that describes the impact of this top-up on your account balance.
* May not be specified depending on status of top-up.
*/
@SerializedName("balance_transaction")
ExpandableField balanceTransaction;
/**
* Time at which the object was created. Measured in seconds since the Unix epoch.
*/
@SerializedName("created")
Long created;
/**
* Three-letter ISO currency code,
* in lowercase. Must be a supported currency.
*/
@SerializedName("currency")
String currency;
/**
* An arbitrary string attached to the object. Often useful for displaying to users.
*/
@SerializedName("description")
String description;
/**
* Date the funds are expected to arrive in your Stripe account for payouts. This factors in
* delays like weekends or bank holidays. May not be specified depending on status of top-up.
*/
@SerializedName("expected_availability_date")
Long expectedAvailabilityDate;
/**
* Error code explaining reason for top-up failure if available (see the errors section for a list of codes).
*/
@SerializedName("failure_code")
String failureCode;
/**
* Message to user further explaining reason for top-up failure if available.
*/
@SerializedName("failure_message")
String failureMessage;
/**
* Unique identifier for the object.
*/
@SerializedName("id")
String id;
/**
* Has the value {@code true} if the object exists in live mode or the value {@code false} if the
* object exists in test mode.
*/
@SerializedName("livemode")
Boolean livemode;
/**
* Set of key-value pairs that you can attach to an object. This can be useful for storing
* additional information about the object in a structured format.
*/
@SerializedName("metadata")
Map metadata;
/**
* String representing the object's type. Objects of the same type share the same value.
*
* Equal to {@code topup}.
*/
@SerializedName("object")
String object;
/**
* {@code Source} objects allow you to accept a variety of payment methods. They represent a
* customer's payment instrument, and can be used with the Stripe API just like a {@code Card}
* object: once chargeable, they can be charged, or can be attached to customers.
*
*
Related guides: Sources API and Sources & Customers.
*/
@SerializedName("source")
Source source;
/**
* Extra information about a top-up. This will appear on your source's bank statement. It must
* contain at least one letter.
*/
@SerializedName("statement_descriptor")
String statementDescriptor;
/**
* The status of the top-up is either {@code canceled}, {@code failed}, {@code pending}, {@code
* reversed}, or {@code succeeded}.
*
*
One of {@code canceled}, {@code failed}, {@code pending}, {@code reversed}, or {@code
* succeeded}.
*/
@SerializedName("status")
String status;
/**
* A string that identifies this top-up as part of a group.
*/
@SerializedName("transfer_group")
String transferGroup;
/**
* Get ID of expandable {@code balanceTransaction} object.
*/
public String getBalanceTransaction() {
return (this.balanceTransaction != null) ? this.balanceTransaction.getId() : null;
}
public void setBalanceTransaction(String id) {
this.balanceTransaction = ApiResource.setExpandableFieldId(id, this.balanceTransaction);
}
/**
* Get expanded {@code balanceTransaction}.
*/
public BalanceTransaction getBalanceTransactionObject() {
return (this.balanceTransaction != null) ? this.balanceTransaction.getExpanded() : null;
}
public void setBalanceTransactionObject(BalanceTransaction expandableObject) {
this.balanceTransaction = new ExpandableField(expandableObject.getId(), expandableObject);
}
/**
* Top up the balance of an account.
*/
public static Topup create(Map params) throws StripeException {
return create(params, (RequestOptions) null);
}
/**
* Top up the balance of an account.
*/
public static Topup create(Map params, RequestOptions options) throws StripeException {
String url = String.format("%s%s", Stripe.getApiBase(), "/v1/topups");
return ApiResource.request(ApiResource.RequestMethod.POST, url, params, Topup.class, options);
}
/**
* Top up the balance of an account.
*/
public static Topup create(TopupCreateParams params) throws StripeException {
return create(params, (RequestOptions) null);
}
/**
* Top up the balance of an account.
*/
public static Topup create(TopupCreateParams params, RequestOptions options) throws StripeException {
String url = String.format("%s%s", Stripe.getApiBase(), "/v1/topups");
return ApiResource.request(ApiResource.RequestMethod.POST, url, params, Topup.class, options);
}
/**
* Returns a list of top-ups.
*/
public static TopupCollection list(Map params) throws StripeException {
return list(params, (RequestOptions) null);
}
/**
* Returns a list of top-ups.
*/
public static TopupCollection list(Map params, RequestOptions options) throws StripeException {
String url = String.format("%s%s", Stripe.getApiBase(), "/v1/topups");
return ApiResource.requestCollection(url, params, TopupCollection.class, options);
}
/**
* Returns a list of top-ups.
*/
public static TopupCollection list(TopupListParams params) throws StripeException {
return list(params, (RequestOptions) null);
}
/**
* Returns a list of top-ups.
*/
public static TopupCollection list(TopupListParams params, RequestOptions options) throws StripeException {
String url = String.format("%s%s", Stripe.getApiBase(), "/v1/topups");
return ApiResource.requestCollection(url, params, TopupCollection.class, options);
}
/**
* Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID
* that was returned from your previous request, and Stripe will return the corresponding top-up
* information.
*/
public static Topup retrieve(String topup) throws StripeException {
return retrieve(topup, (Map) null, (RequestOptions) null);
}
/**
* Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID
* that was returned from your previous request, and Stripe will return the corresponding top-up
* information.
*/
public static Topup retrieve(String topup, RequestOptions options) throws StripeException {
return retrieve(topup, (Map) null, options);
}
/**
* Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID
* that was returned from your previous request, and Stripe will return the corresponding top-up
* information.
*/
public static Topup retrieve(String topup, Map params, RequestOptions options) throws StripeException {
String url = String.format("%s%s", Stripe.getApiBase(), String.format("/v1/topups/%s", ApiResource.urlEncodeId(topup)));
return ApiResource.request(ApiResource.RequestMethod.GET, url, params, Topup.class, options);
}
/**
* Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID
* that was returned from your previous request, and Stripe will return the corresponding top-up
* information.
*/
public static Topup retrieve(String topup, TopupRetrieveParams params, RequestOptions options) throws StripeException {
String url = String.format("%s%s", Stripe.getApiBase(), String.format("/v1/topups/%s", ApiResource.urlEncodeId(topup)));
return ApiResource.request(ApiResource.RequestMethod.GET, url, params, Topup.class, options);
}
/**
* Updates the metadata of a top-up. Other top-up details are not editable by design.
*/
@Override
public Topup update(Map params) throws StripeException {
return update(params, (RequestOptions) null);
}
/**
* Updates the metadata of a top-up. Other top-up details are not editable by design.
*/
@Override
public Topup update(Map params, RequestOptions options) throws StripeException {
String url = String.format("%s%s", Stripe.getApiBase(), String.format("/v1/topups/%s", ApiResource.urlEncodeId(this.getId())));
return ApiResource.request(ApiResource.RequestMethod.POST, url, params, Topup.class, options);
}
/**
* Updates the metadata of a top-up. Other top-up details are not editable by design.
*/
public Topup update(TopupUpdateParams params) throws StripeException {
return update(params, (RequestOptions) null);
}
/**
* Updates the metadata of a top-up. Other top-up details are not editable by design.
*/
public Topup update(TopupUpdateParams params, RequestOptions options) throws StripeException {
String url = String.format("%s%s", Stripe.getApiBase(), String.format("/v1/topups/%s", ApiResource.urlEncodeId(this.getId())));
return ApiResource.request(ApiResource.RequestMethod.POST, url, params, Topup.class, options);
}
/**
* Cancels a top-up. Only pending top-ups can be canceled.
*/
public Topup cancel() throws StripeException {
return cancel((Map) null, (RequestOptions) null);
}
/**
* Cancels a top-up. Only pending top-ups can be canceled.
*/
public Topup cancel(RequestOptions options) throws StripeException {
return cancel((Map) null, options);
}
/**
* Cancels a top-up. Only pending top-ups can be canceled.
*/
public Topup cancel(Map params) throws StripeException {
return cancel(params, (RequestOptions) null);
}
/**
* Cancels a top-up. Only pending top-ups can be canceled.
*/
public Topup cancel(Map params, RequestOptions options) throws StripeException {
String url = String.format("%s%s", Stripe.getApiBase(), String.format("/v1/topups/%s/cancel", ApiResource.urlEncodeId(this.getId())));
return ApiResource.request(ApiResource.RequestMethod.POST, url, params, Topup.class, options);
}
/**
* Cancels a top-up. Only pending top-ups can be canceled.
*/
public Topup cancel(TopupCancelParams params) throws StripeException {
return cancel(params, (RequestOptions) null);
}
/**
* Cancels a top-up. Only pending top-ups can be canceled.
*/
public Topup cancel(TopupCancelParams params, RequestOptions options) throws StripeException {
String url = String.format("%s%s", Stripe.getApiBase(), String.format("/v1/topups/%s/cancel", ApiResource.urlEncodeId(this.getId())));
return ApiResource.request(ApiResource.RequestMethod.POST, url, params, Topup.class, options);
}
/**
* Amount transferred.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getAmount() {
return this.amount;
}
/**
* Time at which the object was created. Measured in seconds since the Unix epoch.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getCreated() {
return this.created;
}
/**
* Three-letter ISO currency code,
* in lowercase. Must be a supported currency.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getCurrency() {
return this.currency;
}
/**
* An arbitrary string attached to the object. Often useful for displaying to users.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getDescription() {
return this.description;
}
/**
* Date the funds are expected to arrive in your Stripe account for payouts. This factors in
* delays like weekends or bank holidays. May not be specified depending on status of top-up.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getExpectedAvailabilityDate() {
return this.expectedAvailabilityDate;
}
/**
* Error code explaining reason for top-up failure if available (see the errors section for a list of codes).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getFailureCode() {
return this.failureCode;
}
/**
* Message to user further explaining reason for top-up failure if available.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getFailureMessage() {
return this.failureMessage;
}
/**
* Has the value {@code true} if the object exists in live mode or the value {@code false} if the
* object exists in test mode.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Boolean getLivemode() {
return this.livemode;
}
/**
* String representing the object's type. Objects of the same type share the same value.
*
* Equal to {@code topup}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getObject() {
return this.object;
}
/**
* {@code Source} objects allow you to accept a variety of payment methods. They represent a
* customer's payment instrument, and can be used with the Stripe API just like a {@code Card}
* object: once chargeable, they can be charged, or can be attached to customers.
*
*
Related guides: Sources API and Sources & Customers.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Source getSource() {
return this.source;
}
/**
* Extra information about a top-up. This will appear on your source's bank statement. It must
* contain at least one letter.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getStatementDescriptor() {
return this.statementDescriptor;
}
/**
* The status of the top-up is either {@code canceled}, {@code failed}, {@code pending}, {@code
* reversed}, or {@code succeeded}.
*
*
One of {@code canceled}, {@code failed}, {@code pending}, {@code reversed}, or {@code
* succeeded}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getStatus() {
return this.status;
}
/**
* A string that identifies this top-up as part of a group.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getTransferGroup() {
return this.transferGroup;
}
/**
* Amount transferred.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setAmount(final Long amount) {
this.amount = amount;
}
/**
* Time at which the object was created. Measured in seconds since the Unix epoch.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setCreated(final Long created) {
this.created = created;
}
/**
* Three-letter ISO currency code,
* in lowercase. Must be a supported currency.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setCurrency(final String currency) {
this.currency = currency;
}
/**
* An arbitrary string attached to the object. Often useful for displaying to users.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setDescription(final String description) {
this.description = description;
}
/**
* Date the funds are expected to arrive in your Stripe account for payouts. This factors in
* delays like weekends or bank holidays. May not be specified depending on status of top-up.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setExpectedAvailabilityDate(final Long expectedAvailabilityDate) {
this.expectedAvailabilityDate = expectedAvailabilityDate;
}
/**
* Error code explaining reason for top-up failure if available (see the errors section for a list of codes).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setFailureCode(final String failureCode) {
this.failureCode = failureCode;
}
/**
* Message to user further explaining reason for top-up failure if available.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setFailureMessage(final String failureMessage) {
this.failureMessage = failureMessage;
}
/**
* Unique identifier for the object.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setId(final String id) {
this.id = id;
}
/**
* Has the value {@code true} if the object exists in live mode or the value {@code false} if the
* object exists in test mode.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setLivemode(final Boolean livemode) {
this.livemode = livemode;
}
/**
* Set of key-value pairs that you can attach to an object. This can be useful for storing
* additional information about the object in a structured format.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setMetadata(final Map metadata) {
this.metadata = metadata;
}
/**
* String representing the object's type. Objects of the same type share the same value.
*
* Equal to {@code topup}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setObject(final String object) {
this.object = object;
}
/**
* {@code Source} objects allow you to accept a variety of payment methods. They represent a
* customer's payment instrument, and can be used with the Stripe API just like a {@code Card}
* object: once chargeable, they can be charged, or can be attached to customers.
*
*
Related guides: Sources API and Sources & Customers.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setSource(final Source source) {
this.source = source;
}
/**
* Extra information about a top-up. This will appear on your source's bank statement. It must
* contain at least one letter.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setStatementDescriptor(final String statementDescriptor) {
this.statementDescriptor = statementDescriptor;
}
/**
* The status of the top-up is either {@code canceled}, {@code failed}, {@code pending}, {@code
* reversed}, or {@code succeeded}.
*
*
One of {@code canceled}, {@code failed}, {@code pending}, {@code reversed}, or {@code
* succeeded}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setStatus(final String status) {
this.status = status;
}
/**
* A string that identifies this top-up as part of a group.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setTransferGroup(final String transferGroup) {
this.transferGroup = transferGroup;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public boolean equals(final java.lang.Object o) {
if (o == this) return true;
if (!(o instanceof Topup)) return false;
final Topup other = (Topup) o;
if (!other.canEqual((java.lang.Object) this)) return false;
final java.lang.Object this$amount = this.getAmount();
final java.lang.Object other$amount = other.getAmount();
if (this$amount == null ? other$amount != null : !this$amount.equals(other$amount)) return false;
final java.lang.Object this$balanceTransaction = this.getBalanceTransaction();
final java.lang.Object other$balanceTransaction = other.getBalanceTransaction();
if (this$balanceTransaction == null ? other$balanceTransaction != null : !this$balanceTransaction.equals(other$balanceTransaction)) return false;
final java.lang.Object this$created = this.getCreated();
final java.lang.Object other$created = other.getCreated();
if (this$created == null ? other$created != null : !this$created.equals(other$created)) return false;
final java.lang.Object this$currency = this.getCurrency();
final java.lang.Object other$currency = other.getCurrency();
if (this$currency == null ? other$currency != null : !this$currency.equals(other$currency)) return false;
final java.lang.Object this$description = this.getDescription();
final java.lang.Object other$description = other.getDescription();
if (this$description == null ? other$description != null : !this$description.equals(other$description)) return false;
final java.lang.Object this$expectedAvailabilityDate = this.getExpectedAvailabilityDate();
final java.lang.Object other$expectedAvailabilityDate = other.getExpectedAvailabilityDate();
if (this$expectedAvailabilityDate == null ? other$expectedAvailabilityDate != null : !this$expectedAvailabilityDate.equals(other$expectedAvailabilityDate)) return false;
final java.lang.Object this$failureCode = this.getFailureCode();
final java.lang.Object other$failureCode = other.getFailureCode();
if (this$failureCode == null ? other$failureCode != null : !this$failureCode.equals(other$failureCode)) return false;
final java.lang.Object this$failureMessage = this.getFailureMessage();
final java.lang.Object other$failureMessage = other.getFailureMessage();
if (this$failureMessage == null ? other$failureMessage != null : !this$failureMessage.equals(other$failureMessage)) return false;
final java.lang.Object this$id = this.getId();
final java.lang.Object other$id = other.getId();
if (this$id == null ? other$id != null : !this$id.equals(other$id)) return false;
final java.lang.Object this$livemode = this.getLivemode();
final java.lang.Object other$livemode = other.getLivemode();
if (this$livemode == null ? other$livemode != null : !this$livemode.equals(other$livemode)) return false;
final java.lang.Object this$metadata = this.getMetadata();
final java.lang.Object other$metadata = other.getMetadata();
if (this$metadata == null ? other$metadata != null : !this$metadata.equals(other$metadata)) return false;
final java.lang.Object this$object = this.getObject();
final java.lang.Object other$object = other.getObject();
if (this$object == null ? other$object != null : !this$object.equals(other$object)) return false;
final java.lang.Object this$source = this.getSource();
final java.lang.Object other$source = other.getSource();
if (this$source == null ? other$source != null : !this$source.equals(other$source)) return false;
final java.lang.Object this$statementDescriptor = this.getStatementDescriptor();
final java.lang.Object other$statementDescriptor = other.getStatementDescriptor();
if (this$statementDescriptor == null ? other$statementDescriptor != null : !this$statementDescriptor.equals(other$statementDescriptor)) return false;
final java.lang.Object this$status = this.getStatus();
final java.lang.Object other$status = other.getStatus();
if (this$status == null ? other$status != null : !this$status.equals(other$status)) return false;
final java.lang.Object this$transferGroup = this.getTransferGroup();
final java.lang.Object other$transferGroup = other.getTransferGroup();
if (this$transferGroup == null ? other$transferGroup != null : !this$transferGroup.equals(other$transferGroup)) return false;
return true;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected boolean canEqual(final java.lang.Object other) {
return other instanceof Topup;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public int hashCode() {
final int PRIME = 59;
int result = 1;
final java.lang.Object $amount = this.getAmount();
result = result * PRIME + ($amount == null ? 43 : $amount.hashCode());
final java.lang.Object $balanceTransaction = this.getBalanceTransaction();
result = result * PRIME + ($balanceTransaction == null ? 43 : $balanceTransaction.hashCode());
final java.lang.Object $created = this.getCreated();
result = result * PRIME + ($created == null ? 43 : $created.hashCode());
final java.lang.Object $currency = this.getCurrency();
result = result * PRIME + ($currency == null ? 43 : $currency.hashCode());
final java.lang.Object $description = this.getDescription();
result = result * PRIME + ($description == null ? 43 : $description.hashCode());
final java.lang.Object $expectedAvailabilityDate = this.getExpectedAvailabilityDate();
result = result * PRIME + ($expectedAvailabilityDate == null ? 43 : $expectedAvailabilityDate.hashCode());
final java.lang.Object $failureCode = this.getFailureCode();
result = result * PRIME + ($failureCode == null ? 43 : $failureCode.hashCode());
final java.lang.Object $failureMessage = this.getFailureMessage();
result = result * PRIME + ($failureMessage == null ? 43 : $failureMessage.hashCode());
final java.lang.Object $id = this.getId();
result = result * PRIME + ($id == null ? 43 : $id.hashCode());
final java.lang.Object $livemode = this.getLivemode();
result = result * PRIME + ($livemode == null ? 43 : $livemode.hashCode());
final java.lang.Object $metadata = this.getMetadata();
result = result * PRIME + ($metadata == null ? 43 : $metadata.hashCode());
final java.lang.Object $object = this.getObject();
result = result * PRIME + ($object == null ? 43 : $object.hashCode());
final java.lang.Object $source = this.getSource();
result = result * PRIME + ($source == null ? 43 : $source.hashCode());
final java.lang.Object $statementDescriptor = this.getStatementDescriptor();
result = result * PRIME + ($statementDescriptor == null ? 43 : $statementDescriptor.hashCode());
final java.lang.Object $status = this.getStatus();
result = result * PRIME + ($status == null ? 43 : $status.hashCode());
final java.lang.Object $transferGroup = this.getTransferGroup();
result = result * PRIME + ($transferGroup == null ? 43 : $transferGroup.hashCode());
return result;
}
/**
* Unique identifier for the object.
*/
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getId() {
return this.id;
}
/**
* Set of key-value pairs that you can attach to an object. This can be useful for storing
* additional information about the object in a structured format.
*/
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getMetadata() {
return this.metadata;
}
}