Package com.adyen.model.management
Class ScheduleTerminalActionsResponse
- java.lang.Object
-
- com.adyen.model.management.ScheduleTerminalActionsResponse
-
public class ScheduleTerminalActionsResponse extends Object
ScheduleTerminalActionsResponse
-
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ACTION_DETAILSstatic StringJSON_PROPERTY_ITEMSstatic StringJSON_PROPERTY_SCHEDULED_ATstatic StringJSON_PROPERTY_STORE_IDstatic StringJSON_PROPERTY_TERMINALS_WITH_ERRORSstatic StringJSON_PROPERTY_TOTAL_ERRORSstatic StringJSON_PROPERTY_TOTAL_SCHEDULED
-
Constructor Summary
Constructors Constructor Description ScheduleTerminalActionsResponse()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ScheduleTerminalActionsResponseactionDetails(ScheduleTerminalActionsRequestActionDetails actionDetails)actionDetailsScheduleTerminalActionsResponseaddItemsItem(TerminalActionScheduleDetail itemsItem)booleanequals(Object o)Return true if this ScheduleTerminalActionsResponse object is equal to o.static ScheduleTerminalActionsResponsefromJson(String jsonString)Create an instance of ScheduleTerminalActionsResponse given an JSON stringScheduleTerminalActionsRequestActionDetailsgetActionDetails()actionDetailsList<TerminalActionScheduleDetail>getItems()A list containing a terminal ID and an action ID for each terminal that the action was scheduled for.StringgetScheduledAt()The date and time when the action should happen.StringgetStoreId()The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores).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.IntegergetTotalErrors()The number of terminals for which scheduling the action failed.IntegergetTotalScheduled()The number of terminals for which the action was successfully scheduled.inthashCode()ScheduleTerminalActionsResponseitems(List<TerminalActionScheduleDetail> items)A list containing a terminal ID and an action ID for each terminal that the action was scheduled for.ScheduleTerminalActionsResponseputTerminalsWithErrorsItem(String key, List<String> terminalsWithErrorsItem)ScheduleTerminalActionsResponsescheduledAt(String scheduledAt)The date and time when the action should happen.voidsetActionDetails(ScheduleTerminalActionsRequestActionDetails actionDetails)actionDetailsvoidsetItems(List<TerminalActionScheduleDetail> items)A list containing a terminal ID and an action ID for each terminal that the action was scheduled for.voidsetScheduledAt(String scheduledAt)The date and time when the action should happen.voidsetStoreId(String storeId)The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores).voidsetTerminalsWithErrors(Map<String,List<String>> terminalsWithErrors)The validation errors that occurred in the list of terminals, and for each error the IDs of the terminals that the error applies to.voidsetTotalErrors(Integer totalErrors)The number of terminals for which scheduling the action failed.voidsetTotalScheduled(Integer totalScheduled)The number of terminals for which the action was successfully scheduled.ScheduleTerminalActionsResponsestoreId(String storeId)The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores).ScheduleTerminalActionsResponseterminalsWithErrors(Map<String,List<String>> terminalsWithErrors)The validation errors that occurred in the list of terminals, and for each error the IDs of the terminals that the error applies to.StringtoJson()Convert an instance of ScheduleTerminalActionsResponse to an JSON stringStringtoString()ScheduleTerminalActionsResponsetotalErrors(Integer totalErrors)The number of terminals for which scheduling the action failed.ScheduleTerminalActionsResponsetotalScheduled(Integer totalScheduled)The number of terminals for which the action was successfully scheduled.
-
-
-
Field Detail
-
JSON_PROPERTY_ACTION_DETAILS
public static final String JSON_PROPERTY_ACTION_DETAILS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ITEMS
public static final String JSON_PROPERTY_ITEMS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SCHEDULED_AT
public static final String JSON_PROPERTY_SCHEDULED_AT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STORE_ID
public static final String JSON_PROPERTY_STORE_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TERMINALS_WITH_ERRORS
public static final String JSON_PROPERTY_TERMINALS_WITH_ERRORS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TOTAL_ERRORS
public static final String JSON_PROPERTY_TOTAL_ERRORS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TOTAL_SCHEDULED
public static final String JSON_PROPERTY_TOTAL_SCHEDULED
- See Also:
- Constant Field Values
-
-
Method Detail
-
actionDetails
public ScheduleTerminalActionsResponse actionDetails(ScheduleTerminalActionsRequestActionDetails actionDetails)
actionDetails- Parameters:
actionDetails-- Returns:
- the current
ScheduleTerminalActionsResponseinstance, allowing for method chaining
-
getActionDetails
public ScheduleTerminalActionsRequestActionDetails getActionDetails()
actionDetails- Returns:
- actionDetails
-
setActionDetails
public void setActionDetails(ScheduleTerminalActionsRequestActionDetails actionDetails)
actionDetails- Parameters:
actionDetails-
-
items
public ScheduleTerminalActionsResponse items(List<TerminalActionScheduleDetail> items)
A list containing a terminal ID and an action ID for each terminal that the action was scheduled for.- Parameters:
items-- Returns:
- the current
ScheduleTerminalActionsResponseinstance, allowing for method chaining
-
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)
A list containing a terminal ID and an action ID for each terminal that the action was scheduled for.- Parameters:
items-
-
scheduledAt
public ScheduleTerminalActionsResponse scheduledAt(String scheduledAt)
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+0100** 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.- Parameters:
scheduledAt-- Returns:
- the current
ScheduleTerminalActionsResponseinstance, allowing for method chaining
-
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+0100** 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)
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+0100** 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.- Parameters:
scheduledAt-
-
storeId
public ScheduleTerminalActionsResponse storeId(String storeId)
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.- Parameters:
storeId-- Returns:
- the current
ScheduleTerminalActionsResponseinstance, allowing for method chaining
-
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)
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.- Parameters:
storeId-
-
terminalsWithErrors
public ScheduleTerminalActionsResponse terminalsWithErrors(Map<String,List<String>> terminalsWithErrors)
The validation errors that occurred in the list of terminals, and for each error the IDs of the terminals that the error applies to.- Parameters:
terminalsWithErrors-- Returns:
- the current
ScheduleTerminalActionsResponseinstance, allowing for method chaining
-
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)
The validation errors that occurred in the list of terminals, and for each error the IDs of the terminals that the error applies to.- Parameters:
terminalsWithErrors-
-
totalErrors
public ScheduleTerminalActionsResponse totalErrors(Integer totalErrors)
The number of terminals for which scheduling the action failed.- Parameters:
totalErrors-- Returns:
- the current
ScheduleTerminalActionsResponseinstance, allowing for method chaining
-
getTotalErrors
public Integer getTotalErrors()
The number of terminals for which scheduling the action failed.- Returns:
- totalErrors
-
setTotalErrors
public void setTotalErrors(Integer totalErrors)
The number of terminals for which scheduling the action failed.- Parameters:
totalErrors-
-
totalScheduled
public ScheduleTerminalActionsResponse totalScheduled(Integer totalScheduled)
The number of terminals for which the action was successfully scheduled. This doesn't mean the action has happened yet.- Parameters:
totalScheduled-- Returns:
- the current
ScheduleTerminalActionsResponseinstance, allowing for method chaining
-
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)
The number of terminals for which the action was successfully scheduled. This doesn't mean the action has happened yet.- Parameters:
totalScheduled-
-
equals
public boolean equals(Object o)
Return true if this ScheduleTerminalActionsResponse object is equal to o.
-
fromJson
public static ScheduleTerminalActionsResponse fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of ScheduleTerminalActionsResponse given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of ScheduleTerminalActionsResponse
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to ScheduleTerminalActionsResponse
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of ScheduleTerminalActionsResponse to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-