Package model

Class Fee

java.lang.Object

model.Fee

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class Fee
extends Object

An out of flow `fee` that is added to a `settlement`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Fee.CustomTypeAdapterFactory
static class	Fee.FeeSubtypeEnum	Subtype of the `fee`.
static class	Fee.FeeTypeEnum	The type of `fee`.
static class	Fee.LinkedTypeEnum	The type of entity the `fee` is linked to (**null** by default).

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_AMOUNT
static String	SERIALIZED_NAME_CREATED_AT
static String	SERIALIZED_NAME_CURRENCY
static String	SERIALIZED_NAME_DISPLAY_NAME
static String	SERIALIZED_NAME_FEE_SUBTYPE
static String	SERIALIZED_NAME_FEE_TYPE
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_LABEL
static String	SERIALIZED_NAME_LINKED_ID
static String	SERIALIZED_NAME_LINKED_TYPE
static String	SERIALIZED_NAME_LINKS
static String	SERIALIZED_NAME_MERCHANT
static String	SERIALIZED_NAME_TAGS
static String	SERIALIZED_NAME_UPDATED_AT

Constructor Summary

Constructors

Constructor	Description
Fee()

Method Summary

Modifier and Type	Method	Description
Fee	amount(Long amount)
Fee	createdAt(OffsetDateTime createdAt)
Fee	currency(Currency currency)
Fee	displayName(String displayName)
boolean	equals(Object o)
Fee	feeSubtype(Fee.FeeSubtypeEnum feeSubtype)
Fee	feeType(Fee.FeeTypeEnum feeType)
static Fee	fromJson(String jsonString)	Create an instance of Fee given an JSON string
Long	getAmount()	The amount of the fee in cents.
OffsetDateTime	getCreatedAt()	Timestamp of when the object was created.
Currency	getCurrency()	Get currency
String	getDisplayName()	The name of the `fee` object that was include in `display_name` when creating the fee.
Fee.FeeSubtypeEnum	getFeeSubtype()	Subtype of the `fee`.
Fee.FeeTypeEnum	getFeeType()	The type of `fee`.
String	getId()	The ID of the `fee` resource.
String	getLabel()	The name of the `fee` object that was include in `label` when creating the fee.
String	getLinkedId()	ID of the linked resource.
Fee.LinkedTypeEnum	getLinkedType()	The type of entity the `fee` is linked to (**null** by default).
FeeLinks	getLinks()	Get links
String	getMerchant()	The `Merchant` ID that the fee is being debited from.
Map<String,String>	getTags()	Key value pair for annotating custom meta data (e.g.
OffsetDateTime	getUpdatedAt()	Timestamp of when the object was last updated.
int	hashCode()
Fee	id(String id)
Fee	label(String label)
Fee	linkedId(String linkedId)
Fee	linkedType(Fee.LinkedTypeEnum linkedType)
Fee	links(FeeLinks links)
Fee	merchant(String merchant)
Fee	putTagsItem(String key, String tagsItem)
void	setAmount(Long amount)
void	setCreatedAt(OffsetDateTime createdAt)
void	setCurrency(Currency currency)
void	setDisplayName(String displayName)
void	setFeeSubtype(Fee.FeeSubtypeEnum feeSubtype)
void	setFeeType(Fee.FeeTypeEnum feeType)
void	setId(String id)
void	setLabel(String label)
void	setLinkedId(String linkedId)
void	setLinkedType(Fee.LinkedTypeEnum linkedType)
void	setLinks(FeeLinks links)
void	setMerchant(String merchant)
void	setTags(Map<String,String> tags)
void	setUpdatedAt(OffsetDateTime updatedAt)
Fee	tags(Map<String,String> tags)
String	toJson()	Convert an instance of Fee to an JSON string
String	toString()
Fee	updatedAt(OffsetDateTime updatedAt)
static void	validateJsonObject(com.google.gson.JsonObject jsonObj)	Validates the JSON Object and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_AMOUNT

public static final String SERIALIZED_NAME_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_CURRENCY

public static final String SERIALIZED_NAME_CURRENCY

See Also:

Constant Field Values

SERIALIZED_NAME_DISPLAY_NAME

public static final String SERIALIZED_NAME_DISPLAY_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_FEE_SUBTYPE

public static final String SERIALIZED_NAME_FEE_SUBTYPE

See Also:

Constant Field Values

SERIALIZED_NAME_FEE_TYPE

public static final String SERIALIZED_NAME_FEE_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_LABEL

public static final String SERIALIZED_NAME_LABEL

See Also:

Constant Field Values

SERIALIZED_NAME_LINKED_ID

public static final String SERIALIZED_NAME_LINKED_ID

See Also:

Constant Field Values

SERIALIZED_NAME_LINKED_TYPE

public static final String SERIALIZED_NAME_LINKED_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_MERCHANT

public static final String SERIALIZED_NAME_MERCHANT

See Also:

Constant Field Values

SERIALIZED_NAME_TAGS

public static final String SERIALIZED_NAME_TAGS

See Also:

Constant Field Values

SERIALIZED_NAME_LINKS

public static final String SERIALIZED_NAME_LINKS

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

Fee

public Fee()

Method Detail

id

public Fee id(String id)

getId

@Nullable
public String getId()

The ID of the `fee` resource.

Returns:

id

setId

public void setId(String id)

createdAt

public Fee createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

Timestamp of when the object was created.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public Fee updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

Timestamp of when the object was last updated.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

amount

public Fee amount(Long amount)

getAmount

@Nullable
public Long getAmount()

The amount of the fee in cents.

Returns:

amount

setAmount

public void setAmount(Long amount)

currency

public Fee currency(Currency currency)

getCurrency

@Nullable
public Currency getCurrency()

Get currency

Returns:

currency

setCurrency

public void setCurrency(Currency currency)

displayName

public Fee displayName(String displayName)

getDisplayName

@Nullable
public String getDisplayName()

The name of the `fee` object that was include in `display_name` when creating the fee.

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

feeSubtype

public Fee feeSubtype(Fee.FeeSubtypeEnum feeSubtype)

getFeeSubtype

@Nullable
public Fee.FeeSubtypeEnum getFeeSubtype()

Subtype of the `fee`.

Returns:

feeSubtype

setFeeSubtype

public void setFeeSubtype(Fee.FeeSubtypeEnum feeSubtype)

feeType

public Fee feeType(Fee.FeeTypeEnum feeType)

getFeeType

@Nullable
public Fee.FeeTypeEnum getFeeType()

The type of `fee`.

Returns:

feeType

setFeeType

public void setFeeType(Fee.FeeTypeEnum feeType)

label

public Fee label(String label)

getLabel

@Nullable
public String getLabel()

The name of the `fee` object that was include in `label` when creating the fee.

Returns:

label

setLabel

public void setLabel(String label)

linkedId

public Fee linkedId(String linkedId)

getLinkedId

@Nullable
public String getLinkedId()

ID of the linked resource.

Returns:

linkedId

setLinkedId

public void setLinkedId(String linkedId)

linkedType

public Fee linkedType(Fee.LinkedTypeEnum linkedType)

getLinkedType

@Nullable
public Fee.LinkedTypeEnum getLinkedType()

The type of entity the `fee` is linked to (**null** by default).

Returns:

linkedType

setLinkedType

public void setLinkedType(Fee.LinkedTypeEnum linkedType)

merchant

public Fee merchant(String merchant)

getMerchant

@Nullable
public String getMerchant()

The `Merchant` ID that the fee is being debited from.

Returns:

merchant

setMerchant

public void setMerchant(String merchant)

tags

public Fee tags(Map<String,String> tags)

putTagsItem

public Fee putTagsItem(String key,
                       String tagsItem)

getTags

@Nullable
public Map<String,String> getTags()

Key value pair for annotating custom meta data (e.g. order numbers).

Returns:

tags

setTags

public void setTags(Map<String,String> tags)

links

public Fee links(FeeLinks links)

getLinks

@Nullable
public FeeLinks getLinks()

Get links

Returns:

links

setLinks

public void setLinks(FeeLinks links)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonObject

public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException

Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

IOException - if the JSON Object is invalid with respect to Fee

fromJson

public static Fee fromJson(String jsonString)
                    throws IOException

Create an instance of Fee given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of Fee

Throws:

IOException - if the JSON string is invalid with respect to Fee

toJson

public String toJson()

Convert an instance of Fee to an JSON string

Returns:

JSON string