Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// File generated from our OpenAPI spec
package com.stripe.param;
import com.google.gson.annotations.SerializedName;
import com.stripe.net.ApiRequestParams;
import com.stripe.param.common.EmptyParam;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import lombok.Getter;
@Getter
public class SourceUpdateParams extends ApiRequestParams {
/** Amount associated with the source. */
@SerializedName("amount")
Long amount;
/** Specifies which fields in the response should be expanded. */
@SerializedName("expand")
List expand;
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/**
* Information about a mandate possibility attached to a source object (generally for bank debits)
* as well as its acceptance status.
*/
@SerializedName("mandate")
Mandate mandate;
/**
* 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. Individual keys can be unset by posting an empty value to them. All keys can
* be unset by posting an empty value to {@code metadata}.
*/
@SerializedName("metadata")
Object metadata;
/**
* Information about the owner of the payment instrument that may be used or required by
* particular source types.
*/
@SerializedName("owner")
Owner owner;
/**
* Information about the items and shipping associated with the source. Required for transactional
* credit (for example Klarna) sources before you can charge it.
*/
@SerializedName("source_order")
SourceOrder sourceOrder;
private SourceUpdateParams(
Long amount,
List expand,
Map extraParams,
Mandate mandate,
Object metadata,
Owner owner,
SourceOrder sourceOrder) {
this.amount = amount;
this.expand = expand;
this.extraParams = extraParams;
this.mandate = mandate;
this.metadata = metadata;
this.owner = owner;
this.sourceOrder = sourceOrder;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amount;
private List expand;
private Map extraParams;
private Mandate mandate;
private Object metadata;
private Owner owner;
private SourceOrder sourceOrder;
/** Finalize and obtain parameter instance from this builder. */
public SourceUpdateParams build() {
return new SourceUpdateParams(
this.amount,
this.expand,
this.extraParams,
this.mandate,
this.metadata,
this.owner,
this.sourceOrder);
}
/** Amount associated with the source. */
public Builder setAmount(Long amount) {
this.amount = amount;
return this;
}
/**
* Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* SourceUpdateParams#expand} for the field documentation.
*/
public Builder addExpand(String element) {
if (this.expand == null) {
this.expand = new ArrayList<>();
}
this.expand.add(element);
return this;
}
/**
* Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* SourceUpdateParams#expand} for the field documentation.
*/
public Builder addAllExpand(List elements) {
if (this.expand == null) {
this.expand = new ArrayList<>();
}
this.expand.addAll(elements);
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll`
* call, and subsequent calls add additional key/value pairs to the original map. See {@link
* SourceUpdateParams#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link SourceUpdateParams#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Information about a mandate possibility attached to a source object (generally for bank
* debits) as well as its acceptance status.
*/
public Builder setMandate(SourceUpdateParams.Mandate mandate) {
this.mandate = mandate;
return this;
}
/**
* Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call,
* and subsequent calls add additional key/value pairs to the original map. See {@link
* SourceUpdateParams#metadata} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder putMetadata(String key, String value) {
if (this.metadata == null || this.metadata instanceof EmptyParam) {
this.metadata = new HashMap();
}
((Map) this.metadata).put(key, value);
return this;
}
/**
* Add all map key/value pairs to `metadata` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link SourceUpdateParams#metadata} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder putAllMetadata(Map map) {
if (this.metadata == null || this.metadata instanceof EmptyParam) {
this.metadata = new HashMap();
}
((Map) this.metadata).putAll(map);
return this;
}
/**
* 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. Individual keys can be unset by posting an empty value to them. All keys
* can be unset by posting an empty value to {@code metadata}.
*/
public Builder setMetadata(EmptyParam metadata) {
this.metadata = metadata;
return this;
}
/**
* 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. Individual keys can be unset by posting an empty value to them. All keys
* can be unset by posting an empty value to {@code metadata}.
*/
public Builder setMetadata(Map metadata) {
this.metadata = metadata;
return this;
}
/**
* Information about the owner of the payment instrument that may be used or required by
* particular source types.
*/
public Builder setOwner(SourceUpdateParams.Owner owner) {
this.owner = owner;
return this;
}
/**
* Information about the items and shipping associated with the source. Required for
* transactional credit (for example Klarna) sources before you can charge it.
*/
public Builder setSourceOrder(SourceUpdateParams.SourceOrder sourceOrder) {
this.sourceOrder = sourceOrder;
return this;
}
}
@Getter
public static class Mandate {
/**
* The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
*/
@SerializedName("acceptance")
Acceptance acceptance;
/** The amount specified by the mandate. (Leave null for a mandate covering all amounts) */
@SerializedName("amount")
Object amount;
/** The currency specified by the mandate. (Must match {@code currency} of the source) */
@SerializedName("currency")
Object currency;
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/**
* The interval of debits permitted by the mandate. Either {@code one_time} (just permitting a
* single debit), {@code scheduled} (with debits on an agreed schedule or for clearly-defined
* events), or {@code variable}(for debits with any frequency)
*/
@SerializedName("interval")
Interval interval;
/**
* The method Stripe should use to notify the customer of upcoming debit instructions and/or
* mandate confirmation as required by the underlying debit network. Either {@code email} (an
* email is sent directly to the customer), {@code manual} (a {@code
* source.mandate_notification} event is sent to your webhooks endpoint and you should handle
* the notification) or {@code none} (the underlying debit network does not require any
* notification).
*/
@SerializedName("notification_method")
NotificationMethod notificationMethod;
private Mandate(
Acceptance acceptance,
Object amount,
Object currency,
Map extraParams,
Interval interval,
NotificationMethod notificationMethod) {
this.acceptance = acceptance;
this.amount = amount;
this.currency = currency;
this.extraParams = extraParams;
this.interval = interval;
this.notificationMethod = notificationMethod;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Acceptance acceptance;
private Object amount;
private Object currency;
private Map extraParams;
private Interval interval;
private NotificationMethod notificationMethod;
/** Finalize and obtain parameter instance from this builder. */
public SourceUpdateParams.Mandate build() {
return new SourceUpdateParams.Mandate(
this.acceptance,
this.amount,
this.currency,
this.extraParams,
this.interval,
this.notificationMethod);
}
/**
* The parameters required to notify Stripe of a mandate acceptance or refusal by the
* customer.
*/
public Builder setAcceptance(SourceUpdateParams.Mandate.Acceptance acceptance) {
this.acceptance = acceptance;
return this;
}
/** The amount specified by the mandate. (Leave null for a mandate covering all amounts) */
public Builder setAmount(Long amount) {
this.amount = amount;
return this;
}
/** The amount specified by the mandate. (Leave null for a mandate covering all amounts) */
public Builder setAmount(EmptyParam amount) {
this.amount = amount;
return this;
}
/** The currency specified by the mandate. (Must match {@code currency} of the source) */
public Builder setCurrency(String currency) {
this.currency = currency;
return this;
}
/** The currency specified by the mandate. (Must match {@code currency} of the source) */
public Builder setCurrency(EmptyParam currency) {
this.currency = currency;
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll`
* call, and subsequent calls add additional key/value pairs to the original map. See {@link
* SourceUpdateParams.Mandate#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link SourceUpdateParams.Mandate#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* The interval of debits permitted by the mandate. Either {@code one_time} (just permitting a
* single debit), {@code scheduled} (with debits on an agreed schedule or for clearly-defined
* events), or {@code variable}(for debits with any frequency)
*/
public Builder setInterval(SourceUpdateParams.Mandate.Interval interval) {
this.interval = interval;
return this;
}
/**
* The method Stripe should use to notify the customer of upcoming debit instructions and/or
* mandate confirmation as required by the underlying debit network. Either {@code email} (an
* email is sent directly to the customer), {@code manual} (a {@code
* source.mandate_notification} event is sent to your webhooks endpoint and you should handle
* the notification) or {@code none} (the underlying debit network does not require any
* notification).
*/
public Builder setNotificationMethod(
SourceUpdateParams.Mandate.NotificationMethod notificationMethod) {
this.notificationMethod = notificationMethod;
return this;
}
}
@Getter
public static class Acceptance {
/**
* The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
*/
@SerializedName("date")
Long date;
/**
* Map of extra parameters for custom features not available in this client library. The
* content in this map is not serialized under this field's {@code @SerializedName} value.
* Instead, each key/value pair is serialized as if the key is a root-level field (serialized)
* name in this param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/** The IP address from which the mandate was accepted or refused by the customer. */
@SerializedName("ip")
Object ip;
/**
* The parameters required to store a mandate accepted offline. Should only be set if {@code
* mandate[type]} is {@code offline}
*/
@SerializedName("offline")
Offline offline;
/**
* The parameters required to store a mandate accepted online. Should only be set if {@code
* mandate[type]} is {@code online}
*/
@SerializedName("online")
Online online;
/**
* Required. The status of the mandate acceptance. Either {@code accepted}
* (the mandate was accepted) or {@code refused} (the mandate was refused).
*/
@SerializedName("status")
Status status;
/**
* The type of acceptance information included with the mandate. Either {@code online} or
* {@code offline}
*/
@SerializedName("type")
Type type;
/**
* The user agent of the browser from which the mandate was accepted or refused by the
* customer.
*/
@SerializedName("user_agent")
Object userAgent;
private Acceptance(
Long date,
Map extraParams,
Object ip,
Offline offline,
Online online,
Status status,
Type type,
Object userAgent) {
this.date = date;
this.extraParams = extraParams;
this.ip = ip;
this.offline = offline;
this.online = online;
this.status = status;
this.type = type;
this.userAgent = userAgent;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long date;
private Map extraParams;
private Object ip;
private Offline offline;
private Online online;
private Status status;
private Type type;
private Object userAgent;
/** Finalize and obtain parameter instance from this builder. */
public SourceUpdateParams.Mandate.Acceptance build() {
return new SourceUpdateParams.Mandate.Acceptance(
this.date,
this.extraParams,
this.ip,
this.offline,
this.online,
this.status,
this.type,
this.userAgent);
}
/**
* The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
*/
public Builder setDate(Long date) {
this.date = date;
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original
* map. See {@link SourceUpdateParams.Mandate.Acceptance#extraParams} for the field
* documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original
* map. See {@link SourceUpdateParams.Mandate.Acceptance#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** The IP address from which the mandate was accepted or refused by the customer. */
public Builder setIp(String ip) {
this.ip = ip;
return this;
}
/** The IP address from which the mandate was accepted or refused by the customer. */
public Builder setIp(EmptyParam ip) {
this.ip = ip;
return this;
}
/**
* The parameters required to store a mandate accepted offline. Should only be set if {@code
* mandate[type]} is {@code offline}
*/
public Builder setOffline(SourceUpdateParams.Mandate.Acceptance.Offline offline) {
this.offline = offline;
return this;
}
/**
* The parameters required to store a mandate accepted online. Should only be set if {@code
* mandate[type]} is {@code online}
*/
public Builder setOnline(SourceUpdateParams.Mandate.Acceptance.Online online) {
this.online = online;
return this;
}
/**
* Required. The status of the mandate acceptance. Either {@code accepted}
* (the mandate was accepted) or {@code refused} (the mandate was refused).
*/
public Builder setStatus(SourceUpdateParams.Mandate.Acceptance.Status status) {
this.status = status;
return this;
}
/**
* The type of acceptance information included with the mandate. Either {@code online} or
* {@code offline}
*/
public Builder setType(SourceUpdateParams.Mandate.Acceptance.Type type) {
this.type = type;
return this;
}
/**
* The user agent of the browser from which the mandate was accepted or refused by the
* customer.
*/
public Builder setUserAgent(String userAgent) {
this.userAgent = userAgent;
return this;
}
/**
* The user agent of the browser from which the mandate was accepted or refused by the
* customer.
*/
public Builder setUserAgent(EmptyParam userAgent) {
this.userAgent = userAgent;
return this;
}
}
@Getter
public static class Offline {
/**
* Required. An email to contact you with if a copy of the mandate is
* requested, required if {@code type} is {@code offline}.
*/
@SerializedName("contact_email")
Object contactEmail;
/**
* Map of extra parameters for custom features not available in this client library. The
* content in this map is not serialized under this field's {@code @SerializedName} value.
* Instead, each key/value pair is serialized as if the key is a root-level field
* (serialized) name in this param object. Effectively, this map is flattened to its parent
* instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
private Offline(Object contactEmail, Map extraParams) {
this.contactEmail = contactEmail;
this.extraParams = extraParams;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Object contactEmail;
private Map extraParams;
/** Finalize and obtain parameter instance from this builder. */
public SourceUpdateParams.Mandate.Acceptance.Offline build() {
return new SourceUpdateParams.Mandate.Acceptance.Offline(
this.contactEmail, this.extraParams);
}
/**
* Required. An email to contact you with if a copy of the mandate is
* requested, required if {@code type} is {@code offline}.
*/
public Builder setContactEmail(String contactEmail) {
this.contactEmail = contactEmail;
return this;
}
/**
* Required. An email to contact you with if a copy of the mandate is
* requested, required if {@code type} is {@code offline}.
*/
public Builder setContactEmail(EmptyParam contactEmail) {
this.contactEmail = contactEmail;
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original
* map. See {@link SourceUpdateParams.Mandate.Acceptance.Offline#extraParams} for the
* field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original
* map. See {@link SourceUpdateParams.Mandate.Acceptance.Offline#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
}
}
@Getter
public static class Online {
/**
* The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
*/
@SerializedName("date")
Long date;
/**
* Map of extra parameters for custom features not available in this client library. The
* content in this map is not serialized under this field's {@code @SerializedName} value.
* Instead, each key/value pair is serialized as if the key is a root-level field
* (serialized) name in this param object. Effectively, this map is flattened to its parent
* instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/** The IP address from which the mandate was accepted or refused by the customer. */
@SerializedName("ip")
Object ip;
/**
* The user agent of the browser from which the mandate was accepted or refused by the
* customer.
*/
@SerializedName("user_agent")
Object userAgent;
private Online(Long date, Map extraParams, Object ip, Object userAgent) {
this.date = date;
this.extraParams = extraParams;
this.ip = ip;
this.userAgent = userAgent;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long date;
private Map extraParams;
private Object ip;
private Object userAgent;
/** Finalize and obtain parameter instance from this builder. */
public SourceUpdateParams.Mandate.Acceptance.Online build() {
return new SourceUpdateParams.Mandate.Acceptance.Online(
this.date, this.extraParams, this.ip, this.userAgent);
}
/**
* The Unix timestamp (in seconds) when the mandate was accepted or refused by the
* customer.
*/
public Builder setDate(Long date) {
this.date = date;
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original
* map. See {@link SourceUpdateParams.Mandate.Acceptance.Online#extraParams} for the field
* documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original
* map. See {@link SourceUpdateParams.Mandate.Acceptance.Online#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** The IP address from which the mandate was accepted or refused by the customer. */
public Builder setIp(String ip) {
this.ip = ip;
return this;
}
/** The IP address from which the mandate was accepted or refused by the customer. */
public Builder setIp(EmptyParam ip) {
this.ip = ip;
return this;
}
/**
* The user agent of the browser from which the mandate was accepted or refused by the
* customer.
*/
public Builder setUserAgent(String userAgent) {
this.userAgent = userAgent;
return this;
}
/**
* The user agent of the browser from which the mandate was accepted or refused by the
* customer.
*/
public Builder setUserAgent(EmptyParam userAgent) {
this.userAgent = userAgent;
return this;
}
}
}
public enum Status implements ApiRequestParams.EnumParam {
@SerializedName("accepted")
ACCEPTED("accepted"),
@SerializedName("pending")
PENDING("pending"),
@SerializedName("refused")
REFUSED("refused"),
@SerializedName("revoked")
REVOKED("revoked");
@Getter(onMethod_ = {@Override})
private final String value;
Status(String value) {
this.value = value;
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("offline")
OFFLINE("offline"),
@SerializedName("online")
ONLINE("online");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
public enum Interval implements ApiRequestParams.EnumParam {
@SerializedName("one_time")
ONE_TIME("one_time"),
@SerializedName("scheduled")
SCHEDULED("scheduled"),
@SerializedName("variable")
VARIABLE("variable");
@Getter(onMethod_ = {@Override})
private final String value;
Interval(String value) {
this.value = value;
}
}
public enum NotificationMethod implements ApiRequestParams.EnumParam {
@SerializedName("deprecated_none")
DEPRECATED_NONE("deprecated_none"),
@SerializedName("email")
EMAIL("email"),
@SerializedName("manual")
MANUAL("manual"),
@SerializedName("none")
NONE("none"),
@SerializedName("stripe_email")
STRIPE_EMAIL("stripe_email");
@Getter(onMethod_ = {@Override})
private final String value;
NotificationMethod(String value) {
this.value = value;
}
}
}
@Getter
public static class Owner {
/** Owner's address. */
@SerializedName("address")
Address address;
/** Owner's email address. */
@SerializedName("email")
Object email;
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/** Owner's full name. */
@SerializedName("name")
Object name;
/** Owner's phone number. */
@SerializedName("phone")
Object phone;
private Owner(
Address address, Object email, Map extraParams, Object name, Object phone) {
this.address = address;
this.email = email;
this.extraParams = extraParams;
this.name = name;
this.phone = phone;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Address address;
private Object email;
private Map extraParams;
private Object name;
private Object phone;
/** Finalize and obtain parameter instance from this builder. */
public SourceUpdateParams.Owner build() {
return new SourceUpdateParams.Owner(
this.address, this.email, this.extraParams, this.name, this.phone);
}
/** Owner's address. */
public Builder setAddress(SourceUpdateParams.Owner.Address address) {
this.address = address;
return this;
}
/** Owner's email address. */
public Builder setEmail(String email) {
this.email = email;
return this;
}
/** Owner's email address. */
public Builder setEmail(EmptyParam email) {
this.email = email;
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll`
* call, and subsequent calls add additional key/value pairs to the original map. See {@link
* SourceUpdateParams.Owner#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link SourceUpdateParams.Owner#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Owner's full name. */
public Builder setName(String name) {
this.name = name;
return this;
}
/** Owner's full name. */
public Builder setName(EmptyParam name) {
this.name = name;
return this;
}
/** Owner's phone number. */
public Builder setPhone(String phone) {
this.phone = phone;
return this;
}
/** Owner's phone number. */
public Builder setPhone(EmptyParam phone) {
this.phone = phone;
return this;
}
}
@Getter
public static class Address {
/** City, district, suburb, town, or village. */
@SerializedName("city")
Object city;
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
@SerializedName("country")
Object country;
/**
* Map of extra parameters for custom features not available in this client library. The
* content in this map is not serialized under this field's {@code @SerializedName} value.
* Instead, each key/value pair is serialized as if the key is a root-level field (serialized)
* name in this param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/** Address line 1 (e.g., street, PO Box, or company name). */
@SerializedName("line1")
Object line1;
/** Address line 2 (e.g., apartment, suite, unit, or building). */
@SerializedName("line2")
Object line2;
/** ZIP or postal code. */
@SerializedName("postal_code")
Object postalCode;
/** State, county, province, or region. */
@SerializedName("state")
Object state;
private Address(
Object city,
Object country,
Map extraParams,
Object line1,
Object line2,
Object postalCode,
Object state) {
this.city = city;
this.country = country;
this.extraParams = extraParams;
this.line1 = line1;
this.line2 = line2;
this.postalCode = postalCode;
this.state = state;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Object city;
private Object country;
private Map extraParams;
private Object line1;
private Object line2;
private Object postalCode;
private Object state;
/** Finalize and obtain parameter instance from this builder. */
public SourceUpdateParams.Owner.Address build() {
return new SourceUpdateParams.Owner.Address(
this.city,
this.country,
this.extraParams,
this.line1,
this.line2,
this.postalCode,
this.state);
}
/** City, district, suburb, town, or village. */
public Builder setCity(String city) {
this.city = city;
return this;
}
/** City, district, suburb, town, or village. */
public Builder setCity(EmptyParam city) {
this.city = city;
return this;
}
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
public Builder setCountry(String country) {
this.country = country;
return this;
}
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
public Builder setCountry(EmptyParam country) {
this.country = country;
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original
* map. See {@link SourceUpdateParams.Owner.Address#extraParams} for the field
* documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original
* map. See {@link SourceUpdateParams.Owner.Address#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Address line 1 (e.g., street, PO Box, or company name). */
public Builder setLine1(String line1) {
this.line1 = line1;
return this;
}
/** Address line 1 (e.g., street, PO Box, or company name). */
public Builder setLine1(EmptyParam line1) {
this.line1 = line1;
return this;
}
/** Address line 2 (e.g., apartment, suite, unit, or building). */
public Builder setLine2(String line2) {
this.line2 = line2;
return this;
}
/** Address line 2 (e.g., apartment, suite, unit, or building). */
public Builder setLine2(EmptyParam line2) {
this.line2 = line2;
return this;
}
/** ZIP or postal code. */
public Builder setPostalCode(String postalCode) {
this.postalCode = postalCode;
return this;
}
/** ZIP or postal code. */
public Builder setPostalCode(EmptyParam postalCode) {
this.postalCode = postalCode;
return this;
}
/** State, county, province, or region. */
public Builder setState(String state) {
this.state = state;
return this;
}
/** State, county, province, or region. */
public Builder setState(EmptyParam state) {
this.state = state;
return this;
}
}
}
}
@Getter
public static class SourceOrder {
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/** List of items constituting the order. */
@SerializedName("items")
List items;
/**
* Shipping address for the order. Required if any of the SKUs are for products that have {@code
* shippable} set to true.
*/
@SerializedName("shipping")
Shipping shipping;
private SourceOrder(
Map extraParams,
List items,
Shipping shipping) {
this.extraParams = extraParams;
this.items = items;
this.shipping = shipping;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private List items;
private Shipping shipping;
/** Finalize and obtain parameter instance from this builder. */
public SourceUpdateParams.SourceOrder build() {
return new SourceUpdateParams.SourceOrder(this.extraParams, this.items, this.shipping);
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll`
* call, and subsequent calls add additional key/value pairs to the original map. See {@link
* SourceUpdateParams.SourceOrder#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link SourceUpdateParams.SourceOrder#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Add an element to `items` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* SourceUpdateParams.SourceOrder#items} for the field documentation.
*/
public Builder addItem(SourceUpdateParams.SourceOrder.Item element) {
if (this.items == null) {
this.items = new ArrayList<>();
}
this.items.add(element);
return this;
}
/**
* Add all elements to `items` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* SourceUpdateParams.SourceOrder#items} for the field documentation.
*/
public Builder addAllItem(List elements) {
if (this.items == null) {
this.items = new ArrayList<>();
}
this.items.addAll(elements);
return this;
}
/**
* Shipping address for the order. Required if any of the SKUs are for products that have
* {@code shippable} set to true.
*/
public Builder setShipping(SourceUpdateParams.SourceOrder.Shipping shipping) {
this.shipping = shipping;
return this;
}
}
@Getter
public static class Item {
@SerializedName("amount")
Long amount;
@SerializedName("currency")
Object currency;
@SerializedName("description")
Object description;
/**
* Map of extra parameters for custom features not available in this client library. The
* content in this map is not serialized under this field's {@code @SerializedName} value.
* Instead, each key/value pair is serialized as if the key is a root-level field (serialized)
* name in this param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/** The ID of the SKU being ordered. */
@SerializedName("parent")
Object parent;
/**
* The quantity of this order item. When type is {@code sku}, this is the number of instances
* of the SKU to be ordered.
*/
@SerializedName("quantity")
Long quantity;
@SerializedName("type")
Type type;
private Item(
Long amount,
Object currency,
Object description,
Map extraParams,
Object parent,
Long quantity,
Type type) {
this.amount = amount;
this.currency = currency;
this.description = description;
this.extraParams = extraParams;
this.parent = parent;
this.quantity = quantity;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amount;
private Object currency;
private Object description;
private Map extraParams;
private Object parent;
private Long quantity;
private Type type;
/** Finalize and obtain parameter instance from this builder. */
public SourceUpdateParams.SourceOrder.Item build() {
return new SourceUpdateParams.SourceOrder.Item(
this.amount,
this.currency,
this.description,
this.extraParams,
this.parent,
this.quantity,
this.type);
}
public Builder setAmount(Long amount) {
this.amount = amount;
return this;
}
public Builder setCurrency(String currency) {
this.currency = currency;
return this;
}
public Builder setCurrency(EmptyParam currency) {
this.currency = currency;
return this;
}
public Builder setDescription(String description) {
this.description = description;
return this;
}
public Builder setDescription(EmptyParam description) {
this.description = description;
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original
* map. See {@link SourceUpdateParams.SourceOrder.Item#extraParams} for the field
* documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original
* map. See {@link SourceUpdateParams.SourceOrder.Item#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** The ID of the SKU being ordered. */
public Builder setParent(String parent) {
this.parent = parent;
return this;
}
/** The ID of the SKU being ordered. */
public Builder setParent(EmptyParam parent) {
this.parent = parent;
return this;
}
/**
* The quantity of this order item. When type is {@code sku}, this is the number of
* instances of the SKU to be ordered.
*/
public Builder setQuantity(Long quantity) {
this.quantity = quantity;
return this;
}
public Builder setType(SourceUpdateParams.SourceOrder.Item.Type type) {
this.type = type;
return this;
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("discount")
DISCOUNT("discount"),
@SerializedName("shipping")
SHIPPING("shipping"),
@SerializedName("sku")
SKU("sku"),
@SerializedName("tax")
TAX("tax");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
@Getter
public static class Shipping {
/** Required. Shipping address. */
@SerializedName("address")
Address address;
/** The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. */
@SerializedName("carrier")
Object carrier;
/**
* Map of extra parameters for custom features not available in this client library. The
* content in this map is not serialized under this field's {@code @SerializedName} value.
* Instead, each key/value pair is serialized as if the key is a root-level field (serialized)
* name in this param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/** Recipient name. */
@SerializedName("name")
Object name;
/** Recipient phone (including extension). */
@SerializedName("phone")
Object phone;
/**
* The tracking number for a physical product, obtained from the delivery service. If multiple
* tracking numbers were generated for this purchase, please separate them with commas.
*/
@SerializedName("tracking_number")
Object trackingNumber;
private Shipping(
Address address,
Object carrier,
Map extraParams,
Object name,
Object phone,
Object trackingNumber) {
this.address = address;
this.carrier = carrier;
this.extraParams = extraParams;
this.name = name;
this.phone = phone;
this.trackingNumber = trackingNumber;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Address address;
private Object carrier;
private Map extraParams;
private Object name;
private Object phone;
private Object trackingNumber;
/** Finalize and obtain parameter instance from this builder. */
public SourceUpdateParams.SourceOrder.Shipping build() {
return new SourceUpdateParams.SourceOrder.Shipping(
this.address,
this.carrier,
this.extraParams,
this.name,
this.phone,
this.trackingNumber);
}
/** Required. Shipping address. */
public Builder setAddress(SourceUpdateParams.SourceOrder.Shipping.Address address) {
this.address = address;
return this;
}
/** The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. */
public Builder setCarrier(String carrier) {
this.carrier = carrier;
return this;
}
/** The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. */
public Builder setCarrier(EmptyParam carrier) {
this.carrier = carrier;
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original
* map. See {@link SourceUpdateParams.SourceOrder.Shipping#extraParams} for the field
* documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original
* map. See {@link SourceUpdateParams.SourceOrder.Shipping#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Recipient name. */
public Builder setName(String name) {
this.name = name;
return this;
}
/** Recipient name. */
public Builder setName(EmptyParam name) {
this.name = name;
return this;
}
/** Recipient phone (including extension). */
public Builder setPhone(String phone) {
this.phone = phone;
return this;
}
/** Recipient phone (including extension). */
public Builder setPhone(EmptyParam phone) {
this.phone = phone;
return this;
}
/**
* The tracking number for a physical product, obtained from the delivery service. If
* multiple tracking numbers were generated for this purchase, please separate them with
* commas.
*/
public Builder setTrackingNumber(String trackingNumber) {
this.trackingNumber = trackingNumber;
return this;
}
/**
* The tracking number for a physical product, obtained from the delivery service. If
* multiple tracking numbers were generated for this purchase, please separate them with
* commas.
*/
public Builder setTrackingNumber(EmptyParam trackingNumber) {
this.trackingNumber = trackingNumber;
return this;
}
}
@Getter
public static class Address {
/** City, district, suburb, town, or village. */
@SerializedName("city")
Object city;
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
@SerializedName("country")
Object country;
/**
* Map of extra parameters for custom features not available in this client library. The
* content in this map is not serialized under this field's {@code @SerializedName} value.
* Instead, each key/value pair is serialized as if the key is a root-level field
* (serialized) name in this param object. Effectively, this map is flattened to its parent
* instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/** Required. Address line 1 (e.g., street, PO Box, or company name). */
@SerializedName("line1")
Object line1;
/** Address line 2 (e.g., apartment, suite, unit, or building). */
@SerializedName("line2")
Object line2;
/** ZIP or postal code. */
@SerializedName("postal_code")
Object postalCode;
/** State, county, province, or region. */
@SerializedName("state")
Object state;
private Address(
Object city,
Object country,
Map extraParams,
Object line1,
Object line2,
Object postalCode,
Object state) {
this.city = city;
this.country = country;
this.extraParams = extraParams;
this.line1 = line1;
this.line2 = line2;
this.postalCode = postalCode;
this.state = state;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Object city;
private Object country;
private Map extraParams;
private Object line1;
private Object line2;
private Object postalCode;
private Object state;
/** Finalize and obtain parameter instance from this builder. */
public SourceUpdateParams.SourceOrder.Shipping.Address build() {
return new SourceUpdateParams.SourceOrder.Shipping.Address(
this.city,
this.country,
this.extraParams,
this.line1,
this.line2,
this.postalCode,
this.state);
}
/** City, district, suburb, town, or village. */
public Builder setCity(String city) {
this.city = city;
return this;
}
/** City, district, suburb, town, or village. */
public Builder setCity(EmptyParam city) {
this.city = city;
return this;
}
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
public Builder setCountry(String country) {
this.country = country;
return this;
}
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
public Builder setCountry(EmptyParam country) {
this.country = country;
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original
* map. See {@link SourceUpdateParams.SourceOrder.Shipping.Address#extraParams} for the
* field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original
* map. See {@link SourceUpdateParams.SourceOrder.Shipping.Address#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Required. Address line 1 (e.g., street, PO Box, or company name). */
public Builder setLine1(String line1) {
this.line1 = line1;
return this;
}
/** Required. Address line 1 (e.g., street, PO Box, or company name). */
public Builder setLine1(EmptyParam line1) {
this.line1 = line1;
return this;
}
/** Address line 2 (e.g., apartment, suite, unit, or building). */
public Builder setLine2(String line2) {
this.line2 = line2;
return this;
}
/** Address line 2 (e.g., apartment, suite, unit, or building). */
public Builder setLine2(EmptyParam line2) {
this.line2 = line2;
return this;
}
/** ZIP or postal code. */
public Builder setPostalCode(String postalCode) {
this.postalCode = postalCode;
return this;
}
/** ZIP or postal code. */
public Builder setPostalCode(EmptyParam postalCode) {
this.postalCode = postalCode;
return this;
}
/** State, county, province, or region. */
public Builder setState(String state) {
this.state = state;
return this;
}
/** State, county, province, or region. */
public Builder setState(EmptyParam state) {
this.state = state;
return this;
}
}
}
}
}
}
