com.squareup.square.models

Class LoyaltyPromotionAvailableTimeData

java.lang.Object

com.squareup.square.models.LoyaltyPromotionAvailableTimeData

public class LoyaltyPromotionAvailableTimeData
extends Object

This is a model class for LoyaltyPromotionAvailableTimeData type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoyaltyPromotionAvailableTimeData.Builder Class to build instances of LoyaltyPromotionAvailableTimeData.

Constructor Summary

Constructors

Constructor and Description
LoyaltyPromotionAvailableTimeData(List<String> timePeriods, String startDate, String endDate) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getEndDate() Getter for EndDate.
String	getStartDate() Getter for StartDate.
List<String>	getTimePeriods() Getter for TimePeriods.
int	hashCode()
LoyaltyPromotionAvailableTimeData.Builder	toBuilder() Builds a new LoyaltyPromotionAvailableTimeData.Builder object.
String	toString() Converts this LoyaltyPromotionAvailableTimeData into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoyaltyPromotionAvailableTimeData

public LoyaltyPromotionAvailableTimeData(List<String> timePeriods,
                                         String startDate,
                                         String endDate)

Initialization constructor.

Parameters:

timePeriods - List of String value for timePeriods.

startDate - String value for startDate.

endDate - String value for endDate.

Method Detail

getStartDate

public String getStartDate()

Getter for StartDate. The date that the promotion starts, in `YYYY-MM-DD` format. Square populates this field based on the provided `time_periods`.

Returns:

Returns the String

getEndDate

public String getEndDate()

Getter for EndDate. The date that the promotion ends, in `YYYY-MM-DD` format. Square populates this field based on the provided `time_periods`. If an end date is not specified, an `ACTIVE` promotion remains available until it is canceled.

Returns:

Returns the String

getTimePeriods

public List<String> getTimePeriods()

Getter for TimePeriods. A list of [iCalendar (RFC 5545) events](https://tools.ietf.org/html/rfc5545#section-3.6.1) (`VEVENT`). Each event represents an available time period per day or days of the week. A day can have a maximum of one available time period. Only `DTSTART`, `DURATION`, and `RRULE` are supported. `DTSTART` and `DURATION` are required and timestamps must be in local (unzoned) time format. Include `RRULE` to specify recurring promotions, an end date (using the `UNTIL` keyword), or both. For more information, see [Available time](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#available-time). Note that `BEGIN:VEVENT` and `END:VEVENT` are optional in a `CreateLoyaltyPromotion` request but are always included in the response.

Returns:

Returns the List of String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this LoyaltyPromotionAvailableTimeData into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public LoyaltyPromotionAvailableTimeData.Builder toBuilder()

Builds a new LoyaltyPromotionAvailableTimeData.Builder object. Creates the instance with the state of the current model.

Returns:

a new LoyaltyPromotionAvailableTimeData.Builder object