java.lang.Object
- com.adyen.model.recurring.Permit

```
public class Permit
extends Object
```
Permit

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_PARTNER_ID`
`static String`	`JSON_PROPERTY_PROFILE_REFERENCE`
`static String`	`JSON_PROPERTY_RESTRICTION`
`static String`	`JSON_PROPERTY_RESULT_KEY`
`static String`	`JSON_PROPERTY_VALID_TILL_DATE`

Constructor Summary

Constructors
Constructor Description

Permit()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`	Return true if this Permit object is equal to o.
`static Permit`	`fromJson(String jsonString)`	Create an instance of Permit given an JSON string
`Map<String,Object>`	`getExplicitNulls()`	Returns a map of properties to be merged into the JSON payload as explicit null values.
`String`	`getPartnerId()`	Partner ID (when using the permit-per-partner token sharing model).
`String`	`getProfileReference()`	The profile to apply to this permit (when using the shared permits model).
`PermitRestriction`	`getRestriction()`	Get restriction
`String`	`getResultKey()`	The key to link permit requests to permit results.
`OffsetDateTime`	`getValidTillDate()`	The expiry date for this permit.
`int`	`hashCode()`
`Permit`	`includeNullValues(boolean includeNullValues)`	Configures whether null values are explicitly serialized in the JSON payload.
`boolean`	`isIncludeNullValues()`	Returns whether null values are explicitly serialized in the JSON payload.
`Permit`	`partnerId(String partnerId)`	Partner ID (when using the permit-per-partner token sharing model).
`Permit`	`profileReference(String profileReference)`	The profile to apply to this permit (when using the shared permits model).
`Permit`	`restriction(PermitRestriction restriction)`	restriction
`Permit`	`resultKey(String resultKey)`	The key to link permit requests to permit results.
`void`	`setIncludeNullValues(boolean includeNullValues)`	Sets whether null values should be explicitly serialized in the JSON payload.
`void`	`setPartnerId(String partnerId)`	Partner ID (when using the permit-per-partner token sharing model).
`void`	`setProfileReference(String profileReference)`	The profile to apply to this permit (when using the shared permits model).
`void`	`setRestriction(PermitRestriction restriction)`	restriction
`void`	`setResultKey(String resultKey)`	The key to link permit requests to permit results.
`void`	`setValidTillDate(OffsetDateTime validTillDate)`	The expiry date for this permit.
`String`	`toJson()`	Convert an instance of Permit to an JSON string
`String`	`toString()`
`Permit`	`validTillDate(OffsetDateTime validTillDate)`	The expiry date for this permit.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JSON_PROPERTY_PARTNER_ID
```
public static final String JSON_PROPERTY_PARTNER_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PROFILE_REFERENCE
```
public static final String JSON_PROPERTY_PROFILE_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_RESTRICTION
```
public static final String JSON_PROPERTY_RESTRICTION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_RESULT_KEY
```
public static final String JSON_PROPERTY_RESULT_KEY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_VALID_TILL_DATE
```
public static final String JSON_PROPERTY_VALID_TILL_DATE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Permit
```
public Permit()
```
- Method Detail
  - partnerId
```
public Permit partnerId(String partnerId)
```
    Partner ID (when using the permit-per-partner token sharing model).
    
    Parameters:
    
    partnerId - Partner ID (when using the permit-per-partner token sharing model).
    
    Returns:
    
    the current Permit instance, allowing for method chaining
  - getPartnerId
```
public String getPartnerId()
```
    Partner ID (when using the permit-per-partner token sharing model).
    
    Returns:
    
    partnerId Partner ID (when using the permit-per-partner token sharing model).
  - setPartnerId
```
public void setPartnerId(String partnerId)
```
    Partner ID (when using the permit-per-partner token sharing model).
    
    Parameters:
    
    partnerId - Partner ID (when using the permit-per-partner token sharing model).
  - profileReference
```
public Permit profileReference(String profileReference)
```
    The profile to apply to this permit (when using the shared permits model).
    
    Parameters:
    
    profileReference - The profile to apply to this permit (when using the shared permits model).
    
    Returns:
    
    the current Permit instance, allowing for method chaining
  - getProfileReference
```
public String getProfileReference()
```
    The profile to apply to this permit (when using the shared permits model).
    
    Returns:
    
    profileReference The profile to apply to this permit (when using the shared permits model).
  - setProfileReference
```
public void setProfileReference(String profileReference)
```
    The profile to apply to this permit (when using the shared permits model).
    
    Parameters:
    
    profileReference - The profile to apply to this permit (when using the shared permits model).
  - restriction
```
public Permit restriction(PermitRestriction restriction)
```
    restriction
    
    Parameters:
    
    restriction -
    
    Returns:
    
    the current Permit instance, allowing for method chaining
  - getRestriction
```
public PermitRestriction getRestriction()
```
    Get restriction
    
    Returns:
    
    restriction
  - setRestriction
```
public void setRestriction(PermitRestriction restriction)
```
    restriction
    
    Parameters:
    
    restriction -
  - resultKey
```
public Permit resultKey(String resultKey)
```
    The key to link permit requests to permit results.
    
    Parameters:
    
    resultKey - The key to link permit requests to permit results.
    
    Returns:
    
    the current Permit instance, allowing for method chaining
  - getResultKey
```
public String getResultKey()
```
    The key to link permit requests to permit results.
    
    Returns:
    
    resultKey The key to link permit requests to permit results.
  - setResultKey
```
public void setResultKey(String resultKey)
```
    The key to link permit requests to permit results.
    
    Parameters:
    
    resultKey - The key to link permit requests to permit results.
  - validTillDate
```
public Permit validTillDate(OffsetDateTime validTillDate)
```
    The expiry date for this permit.
    
    Parameters:
    
    validTillDate - The expiry date for this permit.
    
    Returns:
    
    the current Permit instance, allowing for method chaining
  - getValidTillDate
```
public OffsetDateTime getValidTillDate()
```
    The expiry date for this permit.
    
    Returns:
    
    validTillDate The expiry date for this permit.
  - setValidTillDate
```
public void setValidTillDate(OffsetDateTime validTillDate)
```
    The expiry date for this permit.
    
    Parameters:
    
    validTillDate - The expiry date for this permit.
  - includeNullValues
```
public Permit includeNullValues(boolean includeNullValues)
```
    Configures whether null values are explicitly serialized in the JSON payload. Default is false.
  - isIncludeNullValues
```
public boolean isIncludeNullValues()
```
    Returns whether null values are explicitly serialized in the JSON payload.
  - setIncludeNullValues
```
public void setIncludeNullValues(boolean includeNullValues)
```
    Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
  - equals
```
public boolean equals(Object o)
```
    Return true if this Permit object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getExplicitNulls
```
public Map<String,Object> getExplicitNulls()
```
    Returns a map of properties to be merged into the JSON payload as explicit null values.
  - fromJson
```
public static Permit fromJson(String jsonString)
                       throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of Permit given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of Permit
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to Permit
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of Permit to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class Permit

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_PARTNER_ID

JSON_PROPERTY_PROFILE_REFERENCE

JSON_PROPERTY_RESTRICTION

JSON_PROPERTY_RESULT_KEY

JSON_PROPERTY_VALID_TILL_DATE

Constructor Detail

Permit

Method Detail

partnerId

getPartnerId

setPartnerId

profileReference

getProfileReference

setProfileReference

restriction

getRestriction

setRestriction

resultKey

getResultKey

setResultKey

validTillDate

getValidTillDate

setValidTillDate

includeNullValues

isIncludeNullValues

setIncludeNullValues

equals

hashCode

toString

getExplicitNulls

fromJson

toJson