Package model

Class CreateSubscriptionScheduleRequest

java.lang.Object

model.CreateSubscriptionScheduleRequest

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateSubscriptionScheduleRequest.CustomTypeAdapterFactory
static enum	CreateSubscriptionScheduleRequest.LineItemTypeEnum	Subscription Schedule type.
static enum	CreateSubscriptionScheduleRequest.SubscriptionTypeEnum	Specify the type of schedule: - **FIXED\\_TIME\\_INTERVAL**: Charges a Merchant on a fixed hourly interval.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_FIXED_TIME_INTERVAL_OFFSET
static final String	SERIALIZED_NAME_LINE_ITEM_TYPE
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

Constructor Summary

Constructors

Constructor	Description
CreateSubscriptionScheduleRequest()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
CreateSubscriptionScheduleRequest	fixedTimeIntervalOffset(CreateSubscriptionScheduleRequestFixedTimeIntervalOffset fixedTimeIntervalOffset)
static CreateSubscriptionScheduleRequest	fromJson(String jsonString)	Create an instance of CreateSubscriptionScheduleRequest given an JSON string
CreateSubscriptionScheduleRequestFixedTimeIntervalOffset	getFixedTimeIntervalOffset()	Get fixedTimeIntervalOffset
CreateSubscriptionScheduleRequest.LineItemTypeEnum	getLineItemType()	Subscription Schedule type.
String	getNickname()	Human readable name.
CreateSubscriptionScheduleRequestPeriodOffset	getPeriodOffset()	Get periodOffset
CreateSubscriptionScheduleRequest.SubscriptionTypeEnum	getSubscriptionType()	Specify the type of schedule: - **FIXED\\_TIME\\_INTERVAL**: Charges a Merchant on a fixed hourly interval.
Map<String,String>	getTags()	Key value pair for annotating custom meta data (e.g.
int	hashCode()
CreateSubscriptionScheduleRequest	lineItemType(CreateSubscriptionScheduleRequest.LineItemTypeEnum lineItemType)
CreateSubscriptionScheduleRequest	nickname(String nickname)
CreateSubscriptionScheduleRequest	periodOffset(CreateSubscriptionScheduleRequestPeriodOffset periodOffset)
CreateSubscriptionScheduleRequest	putTagsItem(String key, String tagsItem)
void	setFixedTimeIntervalOffset(CreateSubscriptionScheduleRequestFixedTimeIntervalOffset fixedTimeIntervalOffset)
void	setLineItemType(CreateSubscriptionScheduleRequest.LineItemTypeEnum lineItemType)
void	setNickname(String nickname)
void	setPeriodOffset(CreateSubscriptionScheduleRequestPeriodOffset periodOffset)
void	setSubscriptionType(CreateSubscriptionScheduleRequest.SubscriptionTypeEnum subscriptionType)
void	setTags(Map<String,String> tags)
CreateSubscriptionScheduleRequest	subscriptionType(CreateSubscriptionScheduleRequest.SubscriptionTypeEnum subscriptionType)
CreateSubscriptionScheduleRequest	tags(Map<String,String> tags)
String	toJson()	Convert an instance of CreateSubscriptionScheduleRequest to an JSON string
String	toString()
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_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_FIXED_TIME_INTERVAL_OFFSET

public static final String SERIALIZED_NAME_FIXED_TIME_INTERVAL_OFFSET

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

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

CreateSubscriptionScheduleRequest

public CreateSubscriptionScheduleRequest()

Method Details

lineItemType

public CreateSubscriptionScheduleRequest lineItemType(CreateSubscriptionScheduleRequest.LineItemTypeEnum lineItemType)

getLineItemType

@Nonnull
public CreateSubscriptionScheduleRequest.LineItemTypeEnum getLineItemType()

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

Returns:

lineItemType

setLineItemType

public void setLineItemType(CreateSubscriptionScheduleRequest.LineItemTypeEnum lineItemType)

nickname

public CreateSubscriptionScheduleRequest nickname(String nickname)

getNickname

@Nonnull
public String getNickname()

Human readable name.

Returns:

nickname

setNickname

public void setNickname(String nickname)

fixedTimeIntervalOffset

public CreateSubscriptionScheduleRequest fixedTimeIntervalOffset(CreateSubscriptionScheduleRequestFixedTimeIntervalOffset fixedTimeIntervalOffset)

getFixedTimeIntervalOffset

@Nullable
public CreateSubscriptionScheduleRequestFixedTimeIntervalOffset getFixedTimeIntervalOffset()

Get fixedTimeIntervalOffset

Returns:

fixedTimeIntervalOffset

setFixedTimeIntervalOffset

public void setFixedTimeIntervalOffset(CreateSubscriptionScheduleRequestFixedTimeIntervalOffset fixedTimeIntervalOffset)

periodOffset

public CreateSubscriptionScheduleRequest periodOffset(CreateSubscriptionScheduleRequestPeriodOffset periodOffset)

getPeriodOffset

@Nullable
public CreateSubscriptionScheduleRequestPeriodOffset getPeriodOffset()

Get periodOffset

Returns:

periodOffset

setPeriodOffset

public void setPeriodOffset(CreateSubscriptionScheduleRequestPeriodOffset periodOffset)

subscriptionType

public CreateSubscriptionScheduleRequest subscriptionType(CreateSubscriptionScheduleRequest.SubscriptionTypeEnum subscriptionType)

getSubscriptionType

@Nonnull
public CreateSubscriptionScheduleRequest.SubscriptionTypeEnum getSubscriptionType()

Specify the type of schedule: - **FIXED\\_TIME\\_INTERVAL**: Charges a Merchant on a fixed hourly interval. - **PERIODIC\\_MONTHLY**: Charges a Merchant once a month on a specific day. - **PERIODIC\\_YEARLY**: Charges a Merchant once a year on a specific day and month.

Returns:

subscriptionType

setSubscriptionType

public void setSubscriptionType(CreateSubscriptionScheduleRequest.SubscriptionTypeEnum subscriptionType)

tags

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

putTagsItem

public CreateSubscriptionScheduleRequest 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)

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 CreateSubscriptionScheduleRequest

fromJson

public static CreateSubscriptionScheduleRequest fromJson(String jsonString)
                                                  throws IOException

Create an instance of CreateSubscriptionScheduleRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CreateSubscriptionScheduleRequest

Throws:

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

toJson

public String toJson()

Convert an instance of CreateSubscriptionScheduleRequest to an JSON string

Returns:

JSON string