Package com.adyen.model.management

Class ScheduleTerminalActionsResponse

java.lang.Object

com.adyen.model.management.ScheduleTerminalActionsResponse

public class ScheduleTerminalActionsResponse
extends Object

ScheduleTerminalActionsResponse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScheduleTerminalActionsResponse.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_ACTION_DETAILS
static String	SERIALIZED_NAME_ITEMS
static String	SERIALIZED_NAME_SCHEDULED_AT
static String	SERIALIZED_NAME_STORE_ID
static String	SERIALIZED_NAME_TERMINAL_IDS
static String	SERIALIZED_NAME_TERMINALS_WITH_ERRORS
static String	SERIALIZED_NAME_TOTAL_ERRORS
static String	SERIALIZED_NAME_TOTAL_SCHEDULED

Constructor Summary

Constructors

Constructor	Description
ScheduleTerminalActionsResponse()

Method Summary

Modifier and Type	Method	Description
ScheduleTerminalActionsResponse	actionDetails(ScheduleTerminalActionsRequestActionDetails actionDetails)
ScheduleTerminalActionsResponse	addItemsItem(TerminalActionScheduleDetail itemsItem)
ScheduleTerminalActionsResponse	addTerminalIdsItem(String terminalIdsItem)
boolean	equals(Object o)
static ScheduleTerminalActionsResponse	fromJson(String jsonString)	Create an instance of ScheduleTerminalActionsResponse given an JSON string
ScheduleTerminalActionsRequestActionDetails	getActionDetails()	Get actionDetails
List<TerminalActionScheduleDetail>	getItems()	A list containing a terminal ID and an action ID for each terminal that the action was scheduled for.
String	getScheduledAt()	The date and time when the action should happen.
String	getStoreId()	The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores).
List<String>	getTerminalIds()	Deprecated.
Map<String,List<String>>	getTerminalsWithErrors()	The validation errors that occurred in the list of terminals, and for each error the IDs of the terminals that the error applies to.
Integer	getTotalErrors()	The number of terminals for which scheduling the action failed.
Integer	getTotalScheduled()	The number of terminals for which the action was successfully scheduled.
int	hashCode()
ScheduleTerminalActionsResponse	items(List<TerminalActionScheduleDetail> items)
ScheduleTerminalActionsResponse	putTerminalsWithErrorsItem(String key, List<String> terminalsWithErrorsItem)
ScheduleTerminalActionsResponse	scheduledAt(String scheduledAt)
void	setActionDetails(ScheduleTerminalActionsRequestActionDetails actionDetails)
void	setItems(List<TerminalActionScheduleDetail> items)
void	setScheduledAt(String scheduledAt)
void	setStoreId(String storeId)
void	setTerminalIds(List<String> terminalIds)	Deprecated.
void	setTerminalsWithErrors(Map<String,List<String>> terminalsWithErrors)
void	setTotalErrors(Integer totalErrors)
void	setTotalScheduled(Integer totalScheduled)
ScheduleTerminalActionsResponse	storeId(String storeId)
ScheduleTerminalActionsResponse	terminalIds(List<String> terminalIds)	Deprecated.
ScheduleTerminalActionsResponse	terminalsWithErrors(Map<String,List<String>> terminalsWithErrors)
String	toJson()	Convert an instance of ScheduleTerminalActionsResponse to an JSON string
String	toString()
ScheduleTerminalActionsResponse	totalErrors(Integer totalErrors)
ScheduleTerminalActionsResponse	totalScheduled(Integer totalScheduled)
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_ACTION_DETAILS

public static final String SERIALIZED_NAME_ACTION_DETAILS

See Also:

Constant Field Values

SERIALIZED_NAME_ITEMS

public static final String SERIALIZED_NAME_ITEMS

See Also:

Constant Field Values

SERIALIZED_NAME_SCHEDULED_AT

public static final String SERIALIZED_NAME_SCHEDULED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_STORE_ID

public static final String SERIALIZED_NAME_STORE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_TERMINAL_IDS

public static final String SERIALIZED_NAME_TERMINAL_IDS

See Also:

Constant Field Values

SERIALIZED_NAME_TERMINALS_WITH_ERRORS

public static final String SERIALIZED_NAME_TERMINALS_WITH_ERRORS

See Also:

Constant Field Values

SERIALIZED_NAME_TOTAL_ERRORS

public static final String SERIALIZED_NAME_TOTAL_ERRORS

See Also:

Constant Field Values

SERIALIZED_NAME_TOTAL_SCHEDULED

public static final String SERIALIZED_NAME_TOTAL_SCHEDULED

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

ScheduleTerminalActionsResponse

public ScheduleTerminalActionsResponse()

Method Detail

actionDetails

public ScheduleTerminalActionsResponse actionDetails(ScheduleTerminalActionsRequestActionDetails actionDetails)

getActionDetails

public ScheduleTerminalActionsRequestActionDetails getActionDetails()

Get actionDetails

Returns:

actionDetails

setActionDetails

public void setActionDetails(ScheduleTerminalActionsRequestActionDetails actionDetails)

items

public ScheduleTerminalActionsResponse items(List<TerminalActionScheduleDetail> items)

addItemsItem

public ScheduleTerminalActionsResponse addItemsItem(TerminalActionScheduleDetail itemsItem)

getItems

public List<TerminalActionScheduleDetail> getItems()

A list containing a terminal ID and an action ID for each terminal that the action was scheduled for.

Returns:

items

setItems

public void setItems(List<TerminalActionScheduleDetail> items)

scheduledAt

public ScheduleTerminalActionsResponse scheduledAt(String scheduledAt)

getScheduledAt

public String getScheduledAt()

The date and time when the action should happen. Format: [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339), but without the **Z** before the time offset. For example, **2021-11-15T12:16:21+01:00** The action is sent with the first [maintenance call](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api#when-actions-take-effect) after the specified date and time in the time zone of the terminal. An empty value causes the action to be sent as soon as possible: at the next maintenance call.

Returns:

scheduledAt

setScheduledAt

public void setScheduledAt(String scheduledAt)

storeId

public ScheduleTerminalActionsResponse storeId(String storeId)

getStoreId

public String getStoreId()

The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores). If present, all terminals in the `terminalIds` list must be assigned to this store.

Returns:

storeId

setStoreId

public void setStoreId(String storeId)

terminalIds

@Deprecated
public ScheduleTerminalActionsResponse terminalIds(List<String> terminalIds)

Deprecated.

addTerminalIdsItem

public ScheduleTerminalActionsResponse addTerminalIdsItem(String terminalIdsItem)

getTerminalIds

@Deprecated
public List<String> getTerminalIds()

Deprecated.

A list of unique IDs of the terminals that the action applies to.

Returns:

terminalIds

setTerminalIds

@Deprecated
public void setTerminalIds(List<String> terminalIds)

Deprecated.

terminalsWithErrors

public ScheduleTerminalActionsResponse terminalsWithErrors(Map<String,List<String>> terminalsWithErrors)

putTerminalsWithErrorsItem

public ScheduleTerminalActionsResponse putTerminalsWithErrorsItem(String key,
                                                                  List<String> terminalsWithErrorsItem)

getTerminalsWithErrors

public Map<String,List<String>> getTerminalsWithErrors()

The validation errors that occurred in the list of terminals, and for each error the IDs of the terminals that the error applies to.

Returns:

terminalsWithErrors

setTerminalsWithErrors

public void setTerminalsWithErrors(Map<String,List<String>> terminalsWithErrors)

totalErrors

public ScheduleTerminalActionsResponse totalErrors(Integer totalErrors)

getTotalErrors

public Integer getTotalErrors()

The number of terminals for which scheduling the action failed.

Returns:

totalErrors

setTotalErrors

public void setTotalErrors(Integer totalErrors)

totalScheduled

public ScheduleTerminalActionsResponse totalScheduled(Integer totalScheduled)

getTotalScheduled

public Integer getTotalScheduled()

The number of terminals for which the action was successfully scheduled. This doesn't mean the action has happened yet.

Returns:

totalScheduled

setTotalScheduled

public void setTotalScheduled(Integer totalScheduled)

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 ScheduleTerminalActionsResponse

fromJson

public static ScheduleTerminalActionsResponse fromJson(String jsonString)
                                                throws IOException

Create an instance of ScheduleTerminalActionsResponse given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of ScheduleTerminalActionsResponse

Throws:

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

toJson

public String toJson()

Convert an instance of ScheduleTerminalActionsResponse to an JSON string

Returns:

JSON string