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.math.BigDecimal;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import lombok.Getter;
@Getter
public class CreditNoteCreateParams extends ApiRequestParams {
/**
* The integer amount in cents (or local equivalent) representing the total amount of the credit
* note.
*/
@SerializedName("amount")
Long amount;
/**
* The integer amount in cents (or local equivalent) representing the amount to credit the
* customer's balance, which will be automatically applied to their next invoice.
*/
@SerializedName("credit_amount")
Long creditAmount;
/**
* The date when this credit note is in effect. Same as {@code created} unless overwritten. When
* defined, this value replaces the system-generated 'Date of issue' printed on the credit note
* PDF.
*/
@SerializedName("effective_at")
Long effectiveAt;
/**
* Type of email to send to the customer, one of {@code credit_note} or {@code none} and the
* default is {@code credit_note}.
*/
@SerializedName("email_type")
EmailType emailType;
/** 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;
/** Required. ID of the invoice. */
@SerializedName("invoice")
String invoice;
/** Line items that make up the credit note. */
@SerializedName("lines")
List lines;
/** The credit note's memo appears on the credit note PDF. */
@SerializedName("memo")
String memo;
/**
* 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")
Map metadata;
/**
* The integer amount in cents (or local equivalent) representing the amount that is credited
* outside of Stripe.
*/
@SerializedName("out_of_band_amount")
Long outOfBandAmount;
/**
* Reason for issuing this credit note, one of {@code duplicate}, {@code fraudulent}, {@code
* order_change}, or {@code product_unsatisfactory}.
*/
@SerializedName("reason")
Reason reason;
/** ID of an existing refund to link this credit note to. */
@SerializedName("refund")
String refund;
/**
* The integer amount in cents (or local equivalent) representing the amount to refund. If set, a
* refund will be created for the charge associated with the invoice.
*/
@SerializedName("refund_amount")
Long refundAmount;
/** Refunds to link to this credit note. */
@SerializedName("refunds")
List refunds;
/**
* When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included
* in the credit note.
*/
@SerializedName("shipping_cost")
ShippingCost shippingCost;
private CreditNoteCreateParams(
Long amount,
Long creditAmount,
Long effectiveAt,
EmailType emailType,
List expand,
Map extraParams,
String invoice,
List lines,
String memo,
Map metadata,
Long outOfBandAmount,
Reason reason,
String refund,
Long refundAmount,
List refunds,
ShippingCost shippingCost) {
this.amount = amount;
this.creditAmount = creditAmount;
this.effectiveAt = effectiveAt;
this.emailType = emailType;
this.expand = expand;
this.extraParams = extraParams;
this.invoice = invoice;
this.lines = lines;
this.memo = memo;
this.metadata = metadata;
this.outOfBandAmount = outOfBandAmount;
this.reason = reason;
this.refund = refund;
this.refundAmount = refundAmount;
this.refunds = refunds;
this.shippingCost = shippingCost;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amount;
private Long creditAmount;
private Long effectiveAt;
private EmailType emailType;
private List expand;
private Map extraParams;
private String invoice;
private List lines;
private String memo;
private Map metadata;
private Long outOfBandAmount;
private Reason reason;
private String refund;
private Long refundAmount;
private List refunds;
private ShippingCost shippingCost;
/** Finalize and obtain parameter instance from this builder. */
public CreditNoteCreateParams build() {
return new CreditNoteCreateParams(
this.amount,
this.creditAmount,
this.effectiveAt,
this.emailType,
this.expand,
this.extraParams,
this.invoice,
this.lines,
this.memo,
this.metadata,
this.outOfBandAmount,
this.reason,
this.refund,
this.refundAmount,
this.refunds,
this.shippingCost);
}
/**
* The integer amount in cents (or local equivalent) representing the total amount of the credit
* note.
*/
public Builder setAmount(Long amount) {
this.amount = amount;
return this;
}
/**
* The integer amount in cents (or local equivalent) representing the amount to credit the
* customer's balance, which will be automatically applied to their next invoice.
*/
public Builder setCreditAmount(Long creditAmount) {
this.creditAmount = creditAmount;
return this;
}
/**
* The date when this credit note is in effect. Same as {@code created} unless overwritten. When
* defined, this value replaces the system-generated 'Date of issue' printed on the credit note
* PDF.
*/
public Builder setEffectiveAt(Long effectiveAt) {
this.effectiveAt = effectiveAt;
return this;
}
/**
* Type of email to send to the customer, one of {@code credit_note} or {@code none} and the
* default is {@code credit_note}.
*/
public Builder setEmailType(CreditNoteCreateParams.EmailType emailType) {
this.emailType = emailType;
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
* CreditNoteCreateParams#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
* CreditNoteCreateParams#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
* CreditNoteCreateParams#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 CreditNoteCreateParams#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. ID of the invoice. */
public Builder setInvoice(String invoice) {
this.invoice = invoice;
return this;
}
/**
* Add an element to `lines` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* CreditNoteCreateParams#lines} for the field documentation.
*/
public Builder addLine(CreditNoteCreateParams.Line element) {
if (this.lines == null) {
this.lines = new ArrayList<>();
}
this.lines.add(element);
return this;
}
/**
* Add all elements to `lines` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* CreditNoteCreateParams#lines} for the field documentation.
*/
public Builder addAllLine(List elements) {
if (this.lines == null) {
this.lines = new ArrayList<>();
}
this.lines.addAll(elements);
return this;
}
/** The credit note's memo appears on the credit note PDF. */
public Builder setMemo(String memo) {
this.memo = memo;
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
* CreditNoteCreateParams#metadata} for the field documentation.
*/
public Builder putMetadata(String key, String value) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
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 CreditNoteCreateParams#metadata} for the field documentation.
*/
public Builder putAllMetadata(Map map) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.putAll(map);
return this;
}
/**
* The integer amount in cents (or local equivalent) representing the amount that is credited
* outside of Stripe.
*/
public Builder setOutOfBandAmount(Long outOfBandAmount) {
this.outOfBandAmount = outOfBandAmount;
return this;
}
/**
* Reason for issuing this credit note, one of {@code duplicate}, {@code fraudulent}, {@code
* order_change}, or {@code product_unsatisfactory}.
*/
public Builder setReason(CreditNoteCreateParams.Reason reason) {
this.reason = reason;
return this;
}
/** ID of an existing refund to link this credit note to. */
public Builder setRefund(String refund) {
this.refund = refund;
return this;
}
/**
* The integer amount in cents (or local equivalent) representing the amount to refund. If set,
* a refund will be created for the charge associated with the invoice.
*/
public Builder setRefundAmount(Long refundAmount) {
this.refundAmount = refundAmount;
return this;
}
/**
* Add an element to `refunds` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* CreditNoteCreateParams#refunds} for the field documentation.
*/
public Builder addRefund(CreditNoteCreateParams.Refund element) {
if (this.refunds == null) {
this.refunds = new ArrayList<>();
}
this.refunds.add(element);
return this;
}
/**
* Add all elements to `refunds` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* CreditNoteCreateParams#refunds} for the field documentation.
*/
public Builder addAllRefund(List elements) {
if (this.refunds == null) {
this.refunds = new ArrayList<>();
}
this.refunds.addAll(elements);
return this;
}
/**
* When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included
* in the credit note.
*/
public Builder setShippingCost(CreditNoteCreateParams.ShippingCost shippingCost) {
this.shippingCost = shippingCost;
return this;
}
}
@Getter
public static class Line {
/**
* The line item amount to credit. Only valid when {@code type} is {@code invoice_line_item}.
*/
@SerializedName("amount")
Long amount;
/**
* The description of the credit note line item. Only valid when the {@code type} is {@code
* custom_line_item}.
*/
@SerializedName("description")
String 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 invoice line item to credit. Only valid when the {@code type} is {@code
* invoice_line_item}.
*/
@SerializedName("invoice_line_item")
String invoiceLineItem;
/** The line item quantity to credit. */
@SerializedName("quantity")
Long quantity;
/**
* A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with {@code
* tax_rates}.
*/
@SerializedName("tax_amounts")
Object taxAmounts;
/**
* The tax rates which apply to the credit note line item. Only valid when the {@code type} is
* {@code custom_line_item} and cannot be mixed with {@code tax_amounts}.
*/
@SerializedName("tax_rates")
Object taxRates;
/**
* Required. Type of the credit note line item, one of {@code
* invoice_line_item} or {@code custom_line_item}
*/
@SerializedName("type")
Type type;
/**
* The integer unit amount in cents (or local equivalent) of the credit note line item. This
* {@code unit_amount} will be multiplied by the quantity to get the full amount to credit for
* this line item. Only valid when {@code type} is {@code custom_line_item}.
*/
@SerializedName("unit_amount")
Long unitAmount;
/**
* Same as {@code unit_amount}, but accepts a decimal value in cents (or local equivalent) with
* at most 12 decimal places. Only one of {@code unit_amount} and {@code unit_amount_decimal}
* can be set.
*/
@SerializedName("unit_amount_decimal")
BigDecimal unitAmountDecimal;
private Line(
Long amount,
String description,
Map extraParams,
String invoiceLineItem,
Long quantity,
Object taxAmounts,
Object taxRates,
Type type,
Long unitAmount,
BigDecimal unitAmountDecimal) {
this.amount = amount;
this.description = description;
this.extraParams = extraParams;
this.invoiceLineItem = invoiceLineItem;
this.quantity = quantity;
this.taxAmounts = taxAmounts;
this.taxRates = taxRates;
this.type = type;
this.unitAmount = unitAmount;
this.unitAmountDecimal = unitAmountDecimal;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amount;
private String description;
private Map extraParams;
private String invoiceLineItem;
private Long quantity;
private Object taxAmounts;
private Object taxRates;
private Type type;
private Long unitAmount;
private BigDecimal unitAmountDecimal;
/** Finalize and obtain parameter instance from this builder. */
public CreditNoteCreateParams.Line build() {
return new CreditNoteCreateParams.Line(
this.amount,
this.description,
this.extraParams,
this.invoiceLineItem,
this.quantity,
this.taxAmounts,
this.taxRates,
this.type,
this.unitAmount,
this.unitAmountDecimal);
}
/**
* The line item amount to credit. Only valid when {@code type} is {@code invoice_line_item}.
*/
public Builder setAmount(Long amount) {
this.amount = amount;
return this;
}
/**
* The description of the credit note line item. Only valid when the {@code type} is {@code
* custom_line_item}.
*/
public Builder setDescription(String 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
* CreditNoteCreateParams.Line#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 CreditNoteCreateParams.Line#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 invoice line item to credit. Only valid when the {@code type} is {@code
* invoice_line_item}.
*/
public Builder setInvoiceLineItem(String invoiceLineItem) {
this.invoiceLineItem = invoiceLineItem;
return this;
}
/** The line item quantity to credit. */
public Builder setQuantity(Long quantity) {
this.quantity = quantity;
return this;
}
/**
* Add an element to `taxAmounts` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* CreditNoteCreateParams.Line#taxAmounts} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addTaxAmount(CreditNoteCreateParams.Line.TaxAmount element) {
if (this.taxAmounts == null || this.taxAmounts instanceof EmptyParam) {
this.taxAmounts = new ArrayList();
}
((List) this.taxAmounts).add(element);
return this;
}
/**
* Add all elements to `taxAmounts` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* CreditNoteCreateParams.Line#taxAmounts} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllTaxAmount(List elements) {
if (this.taxAmounts == null || this.taxAmounts instanceof EmptyParam) {
this.taxAmounts = new ArrayList();
}
((List) this.taxAmounts).addAll(elements);
return this;
}
/**
* A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with {@code
* tax_rates}.
*/
public Builder setTaxAmounts(EmptyParam taxAmounts) {
this.taxAmounts = taxAmounts;
return this;
}
/**
* A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with {@code
* tax_rates}.
*/
public Builder setTaxAmounts(List taxAmounts) {
this.taxAmounts = taxAmounts;
return this;
}
/**
* Add an element to `taxRates` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* CreditNoteCreateParams.Line#taxRates} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addTaxRate(String element) {
if (this.taxRates == null || this.taxRates instanceof EmptyParam) {
this.taxRates = new ArrayList();
}
((List) this.taxRates).add(element);
return this;
}
/**
* Add all elements to `taxRates` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* CreditNoteCreateParams.Line#taxRates} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllTaxRate(List elements) {
if (this.taxRates == null || this.taxRates instanceof EmptyParam) {
this.taxRates = new ArrayList();
}
((List) this.taxRates).addAll(elements);
return this;
}
/**
* The tax rates which apply to the credit note line item. Only valid when the {@code type} is
* {@code custom_line_item} and cannot be mixed with {@code tax_amounts}.
*/
public Builder setTaxRates(EmptyParam taxRates) {
this.taxRates = taxRates;
return this;
}
/**
* The tax rates which apply to the credit note line item. Only valid when the {@code type} is
* {@code custom_line_item} and cannot be mixed with {@code tax_amounts}.
*/
public Builder setTaxRates(List taxRates) {
this.taxRates = taxRates;
return this;
}
/**
* Required. Type of the credit note line item, one of {@code
* invoice_line_item} or {@code custom_line_item}
*/
public Builder setType(CreditNoteCreateParams.Line.Type type) {
this.type = type;
return this;
}
/**
* The integer unit amount in cents (or local equivalent) of the credit note line item. This
* {@code unit_amount} will be multiplied by the quantity to get the full amount to credit for
* this line item. Only valid when {@code type} is {@code custom_line_item}.
*/
public Builder setUnitAmount(Long unitAmount) {
this.unitAmount = unitAmount;
return this;
}
/**
* Same as {@code unit_amount}, but accepts a decimal value in cents (or local equivalent)
* with at most 12 decimal places. Only one of {@code unit_amount} and {@code
* unit_amount_decimal} can be set.
*/
public Builder setUnitAmountDecimal(BigDecimal unitAmountDecimal) {
this.unitAmountDecimal = unitAmountDecimal;
return this;
}
}
@Getter
public static class TaxAmount {
/** Required. The amount, in cents (or local equivalent), of the tax. */
@SerializedName("amount")
Long amount;
/**
* 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. The id of the tax rate for this tax amount. The tax rate must
* have been automatically created by Stripe.
*/
@SerializedName("tax_rate")
String taxRate;
/**
* Required. The amount on which tax is calculated, in cents (or local
* equivalent).
*/
@SerializedName("taxable_amount")
Long taxableAmount;
private TaxAmount(
Long amount, Map extraParams, String taxRate, Long taxableAmount) {
this.amount = amount;
this.extraParams = extraParams;
this.taxRate = taxRate;
this.taxableAmount = taxableAmount;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amount;
private Map extraParams;
private String taxRate;
private Long taxableAmount;
/** Finalize and obtain parameter instance from this builder. */
public CreditNoteCreateParams.Line.TaxAmount build() {
return new CreditNoteCreateParams.Line.TaxAmount(
this.amount, this.extraParams, this.taxRate, this.taxableAmount);
}
/** Required. The amount, in cents (or local equivalent), of the tax. */
public Builder setAmount(Long amount) {
this.amount = amount;
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 CreditNoteCreateParams.Line.TaxAmount#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 CreditNoteCreateParams.Line.TaxAmount#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. The id of the tax rate for this tax amount. The tax rate must
* have been automatically created by Stripe.
*/
public Builder setTaxRate(String taxRate) {
this.taxRate = taxRate;
return this;
}
/**
* Required. The amount on which tax is calculated, in cents (or local
* equivalent).
*/
public Builder setTaxableAmount(Long taxableAmount) {
this.taxableAmount = taxableAmount;
return this;
}
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("custom_line_item")
CUSTOM_LINE_ITEM("custom_line_item"),
@SerializedName("invoice_line_item")
INVOICE_LINE_ITEM("invoice_line_item");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
@Getter
public static class Refund {
/**
* Amount of the refund that applies to this credit note, in cents (or local equivalent).
* Defaults to the entire refund amount.
*/
@SerializedName("amount_refunded")
Long amountRefunded;
/**
* 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;
/** ID of an existing refund to link this credit note to. */
@SerializedName("refund")
String refund;
private Refund(Long amountRefunded, Map extraParams, String refund) {
this.amountRefunded = amountRefunded;
this.extraParams = extraParams;
this.refund = refund;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amountRefunded;
private Map extraParams;
private String refund;
/** Finalize and obtain parameter instance from this builder. */
public CreditNoteCreateParams.Refund build() {
return new CreditNoteCreateParams.Refund(
this.amountRefunded, this.extraParams, this.refund);
}
/**
* Amount of the refund that applies to this credit note, in cents (or local equivalent).
* Defaults to the entire refund amount.
*/
public Builder setAmountRefunded(Long amountRefunded) {
this.amountRefunded = amountRefunded;
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
* CreditNoteCreateParams.Refund#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 CreditNoteCreateParams.Refund#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** ID of an existing refund to link this credit note to. */
public Builder setRefund(String refund) {
this.refund = refund;
return this;
}
}
}
@Getter
public static class ShippingCost {
/**
* 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 shipping rate to use for this order. */
@SerializedName("shipping_rate")
String shippingRate;
private ShippingCost(Map extraParams, String shippingRate) {
this.extraParams = extraParams;
this.shippingRate = shippingRate;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private String shippingRate;
/** Finalize and obtain parameter instance from this builder. */
public CreditNoteCreateParams.ShippingCost build() {
return new CreditNoteCreateParams.ShippingCost(this.extraParams, this.shippingRate);
}
/**
* 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
* CreditNoteCreateParams.ShippingCost#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 CreditNoteCreateParams.ShippingCost#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 shipping rate to use for this order. */
public Builder setShippingRate(String shippingRate) {
this.shippingRate = shippingRate;
return this;
}
}
}
public enum EmailType implements ApiRequestParams.EnumParam {
@SerializedName("credit_note")
CREDIT_NOTE("credit_note"),
@SerializedName("none")
NONE("none");
@Getter(onMethod_ = {@Override})
private final String value;
EmailType(String value) {
this.value = value;
}
}
public enum Reason implements ApiRequestParams.EnumParam {
@SerializedName("duplicate")
DUPLICATE("duplicate"),
@SerializedName("fraudulent")
FRAUDULENT("fraudulent"),
@SerializedName("order_change")
ORDER_CHANGE("order_change"),
@SerializedName("product_unsatisfactory")
PRODUCT_UNSATISFACTORY("product_unsatisfactory");
@Getter(onMethod_ = {@Override})
private final String value;
Reason(String value) {
this.value = value;
}
}
}
