Skip to content

feat(api): document the expiry_date contract and allow boolean patch values #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mikemilla merged 1 commit into from
Sep 4, 2026
Merged

feat(api): document the expiry_date contract and allow boolean patch values #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 25 additions & 10 deletions courier-java-core/src/main/kotlin/com/courier/models/users/tokens/TokenAddSingleParams.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,11 @@ private constructor(
fun device(): Optional<Device> = body.device()

/**
* ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to disable
* expiration.
* When the token expires. Accepts a date, or the boolean `false` to disable expiration
* entirely. ISO 8601 is recommended (for example `2026-10-25T00:00:00.000Z`). A value that
* cannot be parsed as a date is rejected; it is not treated as "no expiration" and does not
* fall back to the default. `true` is not a supported value. Omit the field to use the default,
* which expires a token that has not been re-registered for 60 days.
*
* @throws CourierInvalidDataException if the JSON field has an unexpected type (e.g. if the
* server responded with an unexpected value).
Expand Down Expand Up @@ -209,8 +212,11 @@ private constructor(
fun device(device: JsonField<Device>) = apply { body.device(device) }

/**
* ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to disable
* expiration.
* When the token expires. Accepts a date, or the boolean `false` to disable expiration
* entirely. ISO 8601 is recommended (for example `2026-10-25T00:00:00.000Z`). A value that
* cannot be parsed as a date is rejected; it is not treated as "no expiration" and does not
* fall back to the default. `true` is not a supported value. Omit the field to use the
* default, which expires a token that has not been re-registered for 60 days.
*/
fun expiryDate(expiryDate: ExpiryDate?) = apply { body.expiryDate(expiryDate) }

Expand Down Expand Up @@ -448,8 +454,11 @@ private constructor(
fun device(): Optional<Device> = device.getOptional("device")

/**
* ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to disable
* expiration.
* When the token expires. Accepts a date, or the boolean `false` to disable expiration
* entirely. ISO 8601 is recommended (for example `2026-10-25T00:00:00.000Z`). A value that
* cannot be parsed as a date is rejected; it is not treated as "no expiration" and does not
* fall back to the default. `true` is not a supported value. Omit the field to use the
* default, which expires a token that has not been re-registered for 60 days.
*
* @throws CourierInvalidDataException if the JSON field has an unexpected type (e.g. if the
* server responded with an unexpected value).
Expand Down Expand Up @@ -580,8 +589,11 @@ private constructor(
fun device(device: JsonField<Device>) = apply { this.device = device }

/**
* ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to
* disable expiration.
* When the token expires. Accepts a date, or the boolean `false` to disable expiration
* entirely. ISO 8601 is recommended (for example `2026-10-25T00:00:00.000Z`). A value
* that cannot be parsed as a date is rejected; it is not treated as "no expiration" and
* does not fall back to the default. `true` is not a supported value. Omit the field to
* use the default, which expires a token that has not been re-registered for 60 days.
*/
fun expiryDate(expiryDate: ExpiryDate?) = expiryDate(JsonField.ofNullable(expiryDate))

Expand Down Expand Up @@ -1253,8 +1265,11 @@ private constructor(
}

/**
* ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to disable
* expiration.
* When the token expires. Accepts a date, or the boolean `false` to disable expiration
* entirely. ISO 8601 is recommended (for example `2026-10-25T00:00:00.000Z`). A value that
* cannot be parsed as a date is rejected; it is not treated as "no expiration" and does not
* fall back to the default. `true` is not a supported value. Omit the field to use the default,
* which expires a token that has not been re-registered for 60 days.
*/
@JsonDeserialize(using = ExpiryDate.Deserializer::class)
@JsonSerialize(using = ExpiryDate.Serializer::class)
Expand Down
14 changes: 10 additions & 4 deletions courier-java-core/src/main/kotlin/com/courier/models/users/tokens/TokenRetrieveResponse.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,11 @@ private constructor(
fun device(): Optional<UserToken.Device> = device.getOptional("device")

/**
* ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to disable
* expiration.
* When the token expires. Accepts a date, or the boolean `false` to disable expiration
* entirely. ISO 8601 is recommended (for example `2026-10-25T00:00:00.000Z`). A value that
* cannot be parsed as a date is rejected; it is not treated as "no expiration" and does not
* fall back to the default. `true` is not a supported value. Omit the field to use the default,
* which expires a token that has not been re-registered for 60 days.
*
* @throws CourierInvalidDataException if the JSON field has an unexpected type (e.g. if the
* server responded with an unexpected value).
Expand Down Expand Up @@ -286,8 +289,11 @@ private constructor(
fun device(device: JsonField<UserToken.Device>) = apply { this.device = device }

/**
* ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to disable
* expiration.
* When the token expires. Accepts a date, or the boolean `false` to disable expiration
* entirely. ISO 8601 is recommended (for example `2026-10-25T00:00:00.000Z`). A value that
* cannot be parsed as a date is rejected; it is not treated as "no expiration" and does not
* fall back to the default. `true` is not a supported value. Omit the field to use the
* default, which expires a token that has not been re-registered for 60 days.
*/
fun expiryDate(expiryDate: UserToken.ExpiryDate?) =
expiryDate(JsonField.ofNullable(expiryDate))
Expand Down
Loading
Loading