Package model

Class SubscriptionSchedule

java.lang.Object

model.SubscriptionSchedule

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-06-24T13:03:18.088665-07:00[America/Los_Angeles]")
public class SubscriptionSchedule
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubscriptionSchedule.CustomTypeAdapterFactory
static enum	SubscriptionSchedule.LineItemTypeEnum	`Subscription Schedule` type.
static enum	SubscriptionSchedule.SubscriptionTypeEnum	`Subscription Schedule` type.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_CREATED_AT
static final String	SERIALIZED_NAME_CREATED_BY
static final String	SERIALIZED_NAME_FIXED_TIME_INTERVAL_OFFSET
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_LINE_ITEM_TYPE
static final String	SERIALIZED_NAME_LINKS
static final String	SERIALIZED_NAME_NICKNAME
static final String	SERIALIZED_NAME_PERIOD_OFFSET
static final String	SERIALIZED_NAME_SUBSCRIPTION_TYPE
static final String	SERIALIZED_NAME_TAGS
static final String	SERIALIZED_NAME_UPDATED_AT

Constructor Summary

Constructors

Constructor	Description
SubscriptionSchedule()

Method Summary

Modifier and Type	Method	Description
SubscriptionSchedule	createdAt(OffsetDateTime createdAt)
SubscriptionSchedule	createdBy(String createdBy)
boolean	equals(Object o)
SubscriptionSchedule	fixedTimeIntervalOffset(SubscriptionScheduleFixedTimeIntervalOffset fixedTimeIntervalOffset)
static SubscriptionSchedule	fromJson(String jsonString)	Create an instance of SubscriptionSchedule given an JSON string
OffsetDateTime	getCreatedAt()	Timestamp of when the object was created.
String	getCreatedBy()	`User` ID who created the schedule.
SubscriptionScheduleFixedTimeIntervalOffset	getFixedTimeIntervalOffset()	Get fixedTimeIntervalOffset
String	getId()	ID of the `Subscription Schedule`.
SubscriptionSchedule.LineItemTypeEnum	getLineItemType()	`Subscription Schedule` type.
SubscriptionScheduleLinks	getLinks()	Get links
String	getNickname()	Human readable name.
SubscriptionSchedulePeriodOffset	getPeriodOffset()	Get periodOffset
SubscriptionSchedule.SubscriptionTypeEnum	getSubscriptionType()	`Subscription Schedule` type.
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()
SubscriptionSchedule	id(String id)
SubscriptionSchedule	lineItemType(SubscriptionSchedule.LineItemTypeEnum lineItemType)
SubscriptionSchedule	links(SubscriptionScheduleLinks links)
SubscriptionSchedule	nickname(String nickname)
SubscriptionSchedule	periodOffset(SubscriptionSchedulePeriodOffset periodOffset)
SubscriptionSchedule	putTagsItem(String key, String tagsItem)
void	setCreatedAt(OffsetDateTime createdAt)
void	setCreatedBy(String createdBy)
void	setFixedTimeIntervalOffset(SubscriptionScheduleFixedTimeIntervalOffset fixedTimeIntervalOffset)
void	setId(String id)
void	setLineItemType(SubscriptionSchedule.LineItemTypeEnum lineItemType)
void	setLinks(SubscriptionScheduleLinks links)
void	setNickname(String nickname)
void	setPeriodOffset(SubscriptionSchedulePeriodOffset periodOffset)
void	setSubscriptionType(SubscriptionSchedule.SubscriptionTypeEnum subscriptionType)
void	setTags(Map<String,String> tags)
void	setUpdatedAt(OffsetDateTime updatedAt)
SubscriptionSchedule	subscriptionType(SubscriptionSchedule.SubscriptionTypeEnum subscriptionType)
SubscriptionSchedule	tags(Map<String,String> tags)
String	toJson()	Convert an instance of SubscriptionSchedule to an JSON string
String	toString()
SubscriptionSchedule	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 Details

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_CREATED_BY

public static final String SERIALIZED_NAME_CREATED_BY

See Also:

• Constant Field Values

SERIALIZED_NAME_FIXED_TIME_INTERVAL_OFFSET

public static final String SERIALIZED_NAME_FIXED_TIME_INTERVAL_OFFSET

See Also:

• Constant Field Values

SERIALIZED_NAME_LINE_ITEM_TYPE

public static final String SERIALIZED_NAME_LINE_ITEM_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_NICKNAME

public static final String SERIALIZED_NAME_NICKNAME

See Also:

• Constant Field Values

SERIALIZED_NAME_PERIOD_OFFSET

public static final String SERIALIZED_NAME_PERIOD_OFFSET

See Also:

• Constant Field Values

SERIALIZED_NAME_SUBSCRIPTION_TYPE

public static final String SERIALIZED_NAME_SUBSCRIPTION_TYPE

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 Details

SubscriptionSchedule

public SubscriptionSchedule()

Method Details

id

public SubscriptionSchedule id(String id)

getId

@Nullable
public String getId()

ID of the `Subscription Schedule`.

Returns:

id

setId

public void setId(String id)

createdAt

public SubscriptionSchedule 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 SubscriptionSchedule updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

Timestamp of when the object was last updated.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

createdBy

public SubscriptionSchedule createdBy(String createdBy)

getCreatedBy

@Nullable
public String getCreatedBy()

`User` ID who created the schedule.

Returns:

createdBy

setCreatedBy

public void setCreatedBy(String createdBy)

fixedTimeIntervalOffset

public SubscriptionSchedule fixedTimeIntervalOffset(SubscriptionScheduleFixedTimeIntervalOffset fixedTimeIntervalOffset)

getFixedTimeIntervalOffset

@Nullable
public SubscriptionScheduleFixedTimeIntervalOffset getFixedTimeIntervalOffset()

Get fixedTimeIntervalOffset

Returns:

fixedTimeIntervalOffset

setFixedTimeIntervalOffset

public void setFixedTimeIntervalOffset(SubscriptionScheduleFixedTimeIntervalOffset fixedTimeIntervalOffset)

lineItemType

public SubscriptionSchedule lineItemType(SubscriptionSchedule.LineItemTypeEnum lineItemType)

getLineItemType

@Nullable
public SubscriptionSchedule.LineItemTypeEnum getLineItemType()

`Subscription Schedule` type. For subscriptions, the type is **FEE**.

Returns:

lineItemType

setLineItemType

public void setLineItemType(SubscriptionSchedule.LineItemTypeEnum lineItemType)

nickname

public SubscriptionSchedule nickname(String nickname)

getNickname

@Nullable
public String getNickname()

Human readable name.

Returns:

nickname

setNickname

public void setNickname(String nickname)

periodOffset

public SubscriptionSchedule periodOffset(SubscriptionSchedulePeriodOffset periodOffset)

getPeriodOffset

@Nullable
public SubscriptionSchedulePeriodOffset getPeriodOffset()

Get periodOffset

Returns:

periodOffset

setPeriodOffset

public void setPeriodOffset(SubscriptionSchedulePeriodOffset periodOffset)

subscriptionType

public SubscriptionSchedule subscriptionType(SubscriptionSchedule.SubscriptionTypeEnum subscriptionType)

getSubscriptionType

@Nullable
public SubscriptionSchedule.SubscriptionTypeEnum getSubscriptionType()

`Subscription Schedule` type.

Returns:

subscriptionType

setSubscriptionType

public void setSubscriptionType(SubscriptionSchedule.SubscriptionTypeEnum subscriptionType)

tags

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

putTagsItem

public SubscriptionSchedule 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 SubscriptionSchedule links(SubscriptionScheduleLinks links)

getLinks

@Nullable
public SubscriptionScheduleLinks getLinks()

Get links

Returns:

links

setLinks

public void setLinks(SubscriptionScheduleLinks 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 SubscriptionSchedule

fromJson

public static SubscriptionSchedule fromJson(String jsonString)
                                     throws IOException

Create an instance of SubscriptionSchedule given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of SubscriptionSchedule

Throws:

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

toJson

public String toJson()

Convert an instance of SubscriptionSchedule to an JSON string

Returns:

JSON string