com.stripe.model.terminal.Configuration Maven / Gradle / Ivy
// File generated from our OpenAPI spec
package com.stripe.model.terminal;
import com.google.gson.annotations.SerializedName;
import com.stripe.exception.StripeException;
import com.stripe.model.ExpandableField;
import com.stripe.model.File;
import com.stripe.model.HasId;
import com.stripe.model.StripeObject;
import com.stripe.net.ApiRequest;
import com.stripe.net.ApiRequestParams;
import com.stripe.net.ApiResource;
import com.stripe.net.BaseAddress;
import com.stripe.net.RequestOptions;
import com.stripe.net.StripeResponseGetter;
import com.stripe.param.terminal.ConfigurationCreateParams;
import com.stripe.param.terminal.ConfigurationListParams;
import com.stripe.param.terminal.ConfigurationRetrieveParams;
import com.stripe.param.terminal.ConfigurationUpdateParams;
import java.util.List;
import java.util.Map;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
/** A Configurations object represents how features should be configured for terminal readers. */
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public class Configuration extends ApiResource implements HasId {
@SerializedName("bbpos_wisepos_e")
BbposWiseposE bbposWiseposE;
/** Always true for a deleted object. */
@SerializedName("deleted")
Boolean deleted;
/** Unique identifier for the object. */
@Getter(onMethod_ = {@Override})
@SerializedName("id")
String id;
/** Whether this Configuration is the default for your account. */
@SerializedName("is_account_default")
Boolean isAccountDefault;
/**
* 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;
/** String indicating the name of the Configuration object, set by the user. */
@SerializedName("name")
String name;
/**
* String representing the object's type. Objects of the same type share the same value.
*
* Equal to {@code terminal.configuration}.
*/
@SerializedName("object")
String object;
@SerializedName("offline")
Offline offline;
@SerializedName("reboot_window")
RebootWindow rebootWindow;
@SerializedName("stripe_s700")
StripeS700 stripeS700;
@SerializedName("tipping")
Tipping tipping;
@SerializedName("verifone_p400")
VerifoneP400 verifoneP400;
/** Creates a new {@code Configuration} object. */
public static Configuration create(Map params) throws StripeException {
return create(params, (RequestOptions) null);
}
/** Creates a new {@code Configuration} object. */
public static Configuration create(Map params, RequestOptions options)
throws StripeException {
String path = "/v1/terminal/configurations";
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getGlobalResponseGetter().request(request, Configuration.class);
}
/** Creates a new {@code Configuration} object. */
public static Configuration create(ConfigurationCreateParams params) throws StripeException {
return create(params, (RequestOptions) null);
}
/** Creates a new {@code Configuration} object. */
public static Configuration create(ConfigurationCreateParams params, RequestOptions options)
throws StripeException {
String path = "/v1/terminal/configurations";
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, Configuration.class);
}
/** Deletes a {@code Configuration} object. */
public Configuration delete() throws StripeException {
return delete((Map) null, (RequestOptions) null);
}
/** Deletes a {@code Configuration} object. */
public Configuration delete(RequestOptions options) throws StripeException {
return delete((Map) null, options);
}
/** Deletes a {@code Configuration} object. */
public Configuration delete(Map params) throws StripeException {
return delete(params, (RequestOptions) null);
}
/** Deletes a {@code Configuration} object. */
public Configuration delete(Map params, RequestOptions options)
throws StripeException {
String path =
String.format("/v1/terminal/configurations/%s", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.DELETE, path, params, options);
return getResponseGetter().request(request, Configuration.class);
}
/** Returns a list of {@code Configuration} objects. */
public static ConfigurationCollection list(Map params) throws StripeException {
return list(params, (RequestOptions) null);
}
/** Returns a list of {@code Configuration} objects. */
public static ConfigurationCollection list(Map params, RequestOptions options)
throws StripeException {
String path = "/v1/terminal/configurations";
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options);
return getGlobalResponseGetter().request(request, ConfigurationCollection.class);
}
/** Returns a list of {@code Configuration} objects. */
public static ConfigurationCollection list(ConfigurationListParams params)
throws StripeException {
return list(params, (RequestOptions) null);
}
/** Returns a list of {@code Configuration} objects. */
public static ConfigurationCollection list(ConfigurationListParams params, RequestOptions options)
throws StripeException {
String path = "/v1/terminal/configurations";
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, ConfigurationCollection.class);
}
/** Retrieves a {@code Configuration} object. */
public static Configuration retrieve(String configuration) throws StripeException {
return retrieve(configuration, (Map) null, (RequestOptions) null);
}
/** Retrieves a {@code Configuration} object. */
public static Configuration retrieve(String configuration, RequestOptions options)
throws StripeException {
return retrieve(configuration, (Map) null, options);
}
/** Retrieves a {@code Configuration} object. */
public static Configuration retrieve(
String configuration, Map params, RequestOptions options)
throws StripeException {
String path =
String.format("/v1/terminal/configurations/%s", ApiResource.urlEncodeId(configuration));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options);
return getGlobalResponseGetter().request(request, Configuration.class);
}
/** Retrieves a {@code Configuration} object. */
public static Configuration retrieve(
String configuration, ConfigurationRetrieveParams params, RequestOptions options)
throws StripeException {
String path =
String.format("/v1/terminal/configurations/%s", ApiResource.urlEncodeId(configuration));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, Configuration.class);
}
/** Updates a new {@code Configuration} object. */
public Configuration update(Map params) throws StripeException {
return update(params, (RequestOptions) null);
}
/** Updates a new {@code Configuration} object. */
public Configuration update(Map params, RequestOptions options)
throws StripeException {
String path =
String.format("/v1/terminal/configurations/%s", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Configuration.class);
}
/** Updates a new {@code Configuration} object. */
public Configuration update(ConfigurationUpdateParams params) throws StripeException {
return update(params, (RequestOptions) null);
}
/** Updates a new {@code Configuration} object. */
public Configuration update(ConfigurationUpdateParams params, RequestOptions options)
throws StripeException {
String path =
String.format("/v1/terminal/configurations/%s", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Configuration.class);
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class BbposWiseposE extends StripeObject {
/** A File ID representing an image you would like displayed on the reader. */
@SerializedName("splashscreen")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField splashscreen;
/** Get ID of expandable {@code splashscreen} object. */
public String getSplashscreen() {
return (this.splashscreen != null) ? this.splashscreen.getId() : null;
}
public void setSplashscreen(String id) {
this.splashscreen = ApiResource.setExpandableFieldId(id, this.splashscreen);
}
/** Get expanded {@code splashscreen}. */
public File getSplashscreenObject() {
return (this.splashscreen != null) ? this.splashscreen.getExpanded() : null;
}
public void setSplashscreenObject(File expandableObject) {
this.splashscreen = new ExpandableField(expandableObject.getId(), expandableObject);
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Offline extends StripeObject {
/**
* Determines whether to allow transactions to be collected while reader is offline. Defaults to
* false.
*/
@SerializedName("enabled")
Boolean enabled;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class RebootWindow extends StripeObject {
/**
* Integer between 0 to 23 that represents the end hour of the reboot time window. The value
* must be different than the start_hour.
*/
@SerializedName("end_hour")
Long endHour;
/** Integer between 0 to 23 that represents the start hour of the reboot time window. */
@SerializedName("start_hour")
Long startHour;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class StripeS700 extends StripeObject {
/** A File ID representing an image you would like displayed on the reader. */
@SerializedName("splashscreen")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField splashscreen;
/** Get ID of expandable {@code splashscreen} object. */
public String getSplashscreen() {
return (this.splashscreen != null) ? this.splashscreen.getId() : null;
}
public void setSplashscreen(String id) {
this.splashscreen = ApiResource.setExpandableFieldId(id, this.splashscreen);
}
/** Get expanded {@code splashscreen}. */
public File getSplashscreenObject() {
return (this.splashscreen != null) ? this.splashscreen.getExpanded() : null;
}
public void setSplashscreenObject(File expandableObject) {
this.splashscreen = new ExpandableField(expandableObject.getId(), expandableObject);
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Tipping extends StripeObject {
@SerializedName("aud")
Aud aud;
@SerializedName("cad")
Cad cad;
@SerializedName("chf")
Chf chf;
@SerializedName("czk")
Czk czk;
@SerializedName("dkk")
Dkk dkk;
@SerializedName("eur")
Eur eur;
@SerializedName("gbp")
Gbp gbp;
@SerializedName("hkd")
Hkd hkd;
@SerializedName("myr")
Myr myr;
@SerializedName("nok")
Nok nok;
@SerializedName("nzd")
Nzd nzd;
@SerializedName("sek")
Sek sek;
@SerializedName("sgd")
Sgd sgd;
@SerializedName("usd")
Usd usd;
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Aud extends StripeObject {
/** Fixed amounts displayed when collecting a tip. */
@SerializedName("fixed_amounts")
List fixedAmounts;
/** Percentages displayed when collecting a tip. */
@SerializedName("percentages")
List percentages;
/**
* Below this amount, fixed amounts will be displayed; above it, percentages will be
* displayed.
*/
@SerializedName("smart_tip_threshold")
Long smartTipThreshold;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Cad extends StripeObject {
/** Fixed amounts displayed when collecting a tip. */
@SerializedName("fixed_amounts")
List fixedAmounts;
/** Percentages displayed when collecting a tip. */
@SerializedName("percentages")
List percentages;
/**
* Below this amount, fixed amounts will be displayed; above it, percentages will be
* displayed.
*/
@SerializedName("smart_tip_threshold")
Long smartTipThreshold;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Chf extends StripeObject {
/** Fixed amounts displayed when collecting a tip. */
@SerializedName("fixed_amounts")
List fixedAmounts;
/** Percentages displayed when collecting a tip. */
@SerializedName("percentages")
List percentages;
/**
* Below this amount, fixed amounts will be displayed; above it, percentages will be
* displayed.
*/
@SerializedName("smart_tip_threshold")
Long smartTipThreshold;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Czk extends StripeObject {
/** Fixed amounts displayed when collecting a tip. */
@SerializedName("fixed_amounts")
List fixedAmounts;
/** Percentages displayed when collecting a tip. */
@SerializedName("percentages")
List percentages;
/**
* Below this amount, fixed amounts will be displayed; above it, percentages will be
* displayed.
*/
@SerializedName("smart_tip_threshold")
Long smartTipThreshold;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Dkk extends StripeObject {
/** Fixed amounts displayed when collecting a tip. */
@SerializedName("fixed_amounts")
List fixedAmounts;
/** Percentages displayed when collecting a tip. */
@SerializedName("percentages")
List percentages;
/**
* Below this amount, fixed amounts will be displayed; above it, percentages will be
* displayed.
*/
@SerializedName("smart_tip_threshold")
Long smartTipThreshold;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Eur extends StripeObject {
/** Fixed amounts displayed when collecting a tip. */
@SerializedName("fixed_amounts")
List fixedAmounts;
/** Percentages displayed when collecting a tip. */
@SerializedName("percentages")
List percentages;
/**
* Below this amount, fixed amounts will be displayed; above it, percentages will be
* displayed.
*/
@SerializedName("smart_tip_threshold")
Long smartTipThreshold;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Gbp extends StripeObject {
/** Fixed amounts displayed when collecting a tip. */
@SerializedName("fixed_amounts")
List fixedAmounts;
/** Percentages displayed when collecting a tip. */
@SerializedName("percentages")
List percentages;
/**
* Below this amount, fixed amounts will be displayed; above it, percentages will be
* displayed.
*/
@SerializedName("smart_tip_threshold")
Long smartTipThreshold;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Hkd extends StripeObject {
/** Fixed amounts displayed when collecting a tip. */
@SerializedName("fixed_amounts")
List fixedAmounts;
/** Percentages displayed when collecting a tip. */
@SerializedName("percentages")
List percentages;
/**
* Below this amount, fixed amounts will be displayed; above it, percentages will be
* displayed.
*/
@SerializedName("smart_tip_threshold")
Long smartTipThreshold;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Myr extends StripeObject {
/** Fixed amounts displayed when collecting a tip. */
@SerializedName("fixed_amounts")
List fixedAmounts;
/** Percentages displayed when collecting a tip. */
@SerializedName("percentages")
List percentages;
/**
* Below this amount, fixed amounts will be displayed; above it, percentages will be
* displayed.
*/
@SerializedName("smart_tip_threshold")
Long smartTipThreshold;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Nok extends StripeObject {
/** Fixed amounts displayed when collecting a tip. */
@SerializedName("fixed_amounts")
List fixedAmounts;
/** Percentages displayed when collecting a tip. */
@SerializedName("percentages")
List percentages;
/**
* Below this amount, fixed amounts will be displayed; above it, percentages will be
* displayed.
*/
@SerializedName("smart_tip_threshold")
Long smartTipThreshold;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Nzd extends StripeObject {
/** Fixed amounts displayed when collecting a tip. */
@SerializedName("fixed_amounts")
List fixedAmounts;
/** Percentages displayed when collecting a tip. */
@SerializedName("percentages")
List percentages;
/**
* Below this amount, fixed amounts will be displayed; above it, percentages will be
* displayed.
*/
@SerializedName("smart_tip_threshold")
Long smartTipThreshold;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Sek extends StripeObject {
/** Fixed amounts displayed when collecting a tip. */
@SerializedName("fixed_amounts")
List fixedAmounts;
/** Percentages displayed when collecting a tip. */
@SerializedName("percentages")
List percentages;
/**
* Below this amount, fixed amounts will be displayed; above it, percentages will be
* displayed.
*/
@SerializedName("smart_tip_threshold")
Long smartTipThreshold;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Sgd extends StripeObject {
/** Fixed amounts displayed when collecting a tip. */
@SerializedName("fixed_amounts")
List fixedAmounts;
/** Percentages displayed when collecting a tip. */
@SerializedName("percentages")
List percentages;
/**
* Below this amount, fixed amounts will be displayed; above it, percentages will be
* displayed.
*/
@SerializedName("smart_tip_threshold")
Long smartTipThreshold;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Usd extends StripeObject {
/** Fixed amounts displayed when collecting a tip. */
@SerializedName("fixed_amounts")
List fixedAmounts;
/** Percentages displayed when collecting a tip. */
@SerializedName("percentages")
List percentages;
/**
* Below this amount, fixed amounts will be displayed; above it, percentages will be
* displayed.
*/
@SerializedName("smart_tip_threshold")
Long smartTipThreshold;
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class VerifoneP400 extends StripeObject {
/** A File ID representing an image you would like displayed on the reader. */
@SerializedName("splashscreen")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField splashscreen;
/** Get ID of expandable {@code splashscreen} object. */
public String getSplashscreen() {
return (this.splashscreen != null) ? this.splashscreen.getId() : null;
}
public void setSplashscreen(String id) {
this.splashscreen = ApiResource.setExpandableFieldId(id, this.splashscreen);
}
/** Get expanded {@code splashscreen}. */
public File getSplashscreenObject() {
return (this.splashscreen != null) ? this.splashscreen.getExpanded() : null;
}
public void setSplashscreenObject(File expandableObject) {
this.splashscreen = new ExpandableField(expandableObject.getId(), expandableObject);
}
}
@Override
public void setResponseGetter(StripeResponseGetter responseGetter) {
super.setResponseGetter(responseGetter);
trySetResponseGetter(bbposWiseposE, responseGetter);
trySetResponseGetter(offline, responseGetter);
trySetResponseGetter(rebootWindow, responseGetter);
trySetResponseGetter(stripeS700, responseGetter);
trySetResponseGetter(tipping, responseGetter);
trySetResponseGetter(verifoneP400, responseGetter);
}
}