Add additional updatedAtBeginTime, updatedAtEndTime, and sortField query parameters to listPaymentRefuns endpoint.

Author: eyw520

doc/api/refunds.md

@@ -10,24 +10,27 @@ RefundsApi refundsApi = client.getRefundsApi();
 
 ## Methods
 
-* [List Payment Refunds](../../doc/api/refunds.md#list-payment-refunds)
-* [Refund Payment](../../doc/api/refunds.md#refund-payment)
+* [List Payment Refunds](../../doc/api/refunds.md#list-payment-refunds)
+* [Refund Payment](../../doc/api/refunds.md#refund-payment)
 * [Get Payment Refund](../../doc/api/refunds.md#get-payment-refund)
 
 
 # List Payment Refunds
 
-Retrieves a list of refunds for the account making the request.
-
-Results are eventually consistent, and new refunds or changes to refunds might take several
-seconds to appear.
-
+Retrieves a list of refunds for the account making the request.
+
+Results are eventually consistent, and new refunds or changes to refunds might take several
+seconds to appear.
+
 The maximum results per page is 100.
 
 ```java
 CompletableFuture<ListPaymentRefundsResponse> listPaymentRefundsAsync(
     final String beginTime,
     final String endTime,
+    final String updatedAtBeginTime,
+    final String updatedAtEndTime,
+    final String sortField,
     final String sortOrder,
     final String cursor,
     final String locationId,
@@ -42,6 +45,9 @@ CompletableFuture<ListPaymentRefundsResponse> listPaymentRefundsAsync(
 |  --- | --- | --- | --- |
 | `beginTime` | `String` | Query, Optional | Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339<br>format.  The range is determined using the `created_at` field for each `PaymentRefund`.<br><br>Default: The current time minus one year. |
 | `endTime` | `String` | Query, Optional | Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339<br>format.  The range is determined using the `created_at` field for each `PaymentRefund`.<br><br>Default: The current time. |
+| `updatedAtBeginTime` | `string` | Query, Optional | Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339<br>format.  The range is determined using the `updated_at` field for each `PaymentRefund`.<br><br>Default: if omitted, the time range starts at `beginTime`. |
+| `updatedAtEndTime` | `string` | Query, Optional | Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339<br>format.  The range is determined using the `updated_at` field for each `PaymentRefund`.<br><br>Default: The current time. |
+| `sortField` | `string` | Query, Optional | The field used to sort results by. The default is `CREATED_AT`.<br>Current values include `CREATED_AT` and `UPDATED_AT`.<br> |
 | `sortOrder` | `String` | Query, Optional | The order in which results are listed by `PaymentRefund.created_at`:<br><br>- `ASC` - Oldest to newest.<br>- `DESC` - Newest to oldest (default). |
 | `cursor` | `String` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this cursor to retrieve the next set of results for the original query.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |
 | `locationId` | `String` | Query, Optional | Limit results to the location supplied. By default, results are returned<br>for all locations associated with the seller. |
@@ -56,22 +62,22 @@ CompletableFuture<ListPaymentRefundsResponse> listPaymentRefundsAsync(
 ## Example Usage
 
 ```java
-refundsApi.listPaymentRefundsAsync(null, null, null, null, null, null, null, null).thenAccept(result -> {
-    // TODO success callback handler
-    System.out.println(result);
-}).exceptionally(exception -> {
-    // TODO failure callback handler
-    exception.printStackTrace();
-    return null;
+refundsApi.listPaymentRefundsAsync(null, null, null, null, null, null, null, null).thenAccept(result -> {
+    // TODO success callback handler
+    System.out.println(result);
+}).exceptionally(exception -> {
+    // TODO failure callback handler
+    exception.printStackTrace();
+    return null;
 });
 ```
 
 
 # Refund Payment
 
-Refunds a payment. You can refund the entire payment amount or a
-portion of it. You can use this endpoint to refund a card payment or record a
-refund of a cash or external payment. For more information, see
+Refunds a payment. You can refund the entire payment amount or a
+portion of it. You can use this endpoint to refund a card payment or record a
+refund of a cash or external payment. For more information, see
 [Refund Payment](https://developer.squareup.com/docs/payments-api/refund-payments).
 
 ```java
@@ -92,28 +98,28 @@ CompletableFuture<RefundPaymentResponse> refundPaymentAsync(
 ## Example Usage
 
 ```java
-RefundPaymentRequest body = new RefundPaymentRequest.Builder(
-    "9b7f2dcf-49da-4411-b23e-a2d6af21333a",
-    new Money.Builder()
-        .amount(1000L)
-        .currency("USD")
-        .build()
-)
-.appFeeMoney(new Money.Builder()
-        .amount(10L)
-        .currency("USD")
-        .build())
-.paymentId("R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY")
-.reason("Example")
-.build();
-
-refundsApi.refundPaymentAsync(body).thenAccept(result -> {
-    // TODO success callback handler
-    System.out.println(result);
-}).exceptionally(exception -> {
-    // TODO failure callback handler
-    exception.printStackTrace();
-    return null;
+RefundPaymentRequest body = new RefundPaymentRequest.Builder(
+    "9b7f2dcf-49da-4411-b23e-a2d6af21333a",
+    new Money.Builder()
+        .amount(1000L)
+        .currency("USD")
+        .build()
+)
+.appFeeMoney(new Money.Builder()
+        .amount(10L)
+        .currency("USD")
+        .build())
+.paymentId("R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY")
+.reason("Example")
+.build();
+
+refundsApi.refundPaymentAsync(body).thenAccept(result -> {
+    // TODO success callback handler
+    System.out.println(result);
+}).exceptionally(exception -> {
+    // TODO failure callback handler
+    exception.printStackTrace();
+    return null;
 });
 ```
 
@@ -140,15 +146,15 @@ CompletableFuture<GetPaymentRefundResponse> getPaymentRefundAsync(
 ## Example Usage
 
 ```java
-String refundId = "refund_id4";
-
-refundsApi.getPaymentRefundAsync(refundId).thenAccept(result -> {
-    // TODO success callback handler
-    System.out.println(result);
-}).exceptionally(exception -> {
-    // TODO failure callback handler
-    exception.printStackTrace();
-    return null;
+String refundId = "refund_id4";
+
+refundsApi.getPaymentRefundAsync(refundId).thenAccept(result -> {
+    // TODO success callback handler
+    System.out.println(result);
+}).exceptionally(exception -> {
+    // TODO failure callback handler
+    exception.printStackTrace();
+    return null;
 });
 ```
 

doc/client.md

@@ -5,7 +5,7 @@ The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `squareVersion` | `String` | Square Connect API versions<br>*Default*: `"2025-01-23"` |
+| `squareVersion` | `String` | Square Connect API versions<br>*Default*: `"2025-02-17"` |
 | `customUrl` | `String` | Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`<br>*Default*: `"https://connect.squareup.com"` |
 | `environment` | `string` | The API environment. <br> **Default: `production`** |
 | `httpClientConfig` | [`Consumer<HttpClientConfiguration.Builder>`](http-client-configuration-builder.md) | Set up Http Client Configuration instance. |
@@ -19,7 +19,7 @@ The API client can be initialized as follows:
 SquareClient client = new SquareClient.Builder()
     .httpClientConfig(configBuilder -> configBuilder
             .timeout(0))
-    .squareVersion("2025-01-23")
+    .squareVersion("2025-02-17")
     .bearerAuthCredentials(new BearerAuthModel.Builder(
             "AccessToken"
         )
@@ -45,7 +45,7 @@ public class Program {
         SquareClient client = new SquareClient.Builder()
             .httpClientConfig(configBuilder -> configBuilder
                     .timeout(0))
-            .squareVersion("2025-01-23")
+            .squareVersion("2025-02-17")
             .bearerAuthCredentials(new BearerAuthModel.Builder(
                     "AccessToken"
                 )

doc/models/list-payment-refunds-request.md

@@ -1,9 +1,9 @@
 
 # List Payment Refunds Request
 
-Describes a request to list refunds using
-[ListPaymentRefunds](../../doc/api/refunds.md#list-payment-refunds).
-
+Describes a request to list refunds using
+[ListPaymentRefunds](../../doc/api/refunds.md#list-payment-refunds).
+
 The maximum results per page is 100.
 
 ## Structure
@@ -16,6 +16,9 @@ The maximum results per page is 100.
 |  --- | --- | --- | --- | --- |
 | `BeginTime` | `String` | Optional | Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339<br>format.  The range is determined using the `created_at` field for each `PaymentRefund`.<br><br>Default: The current time minus one year. | String getBeginTime() |
 | `EndTime` | `String` | Optional | Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339<br>format.  The range is determined using the `created_at` field for each `PaymentRefund`.<br><br>Default: The current time. | String getEndTime() |
+| `UpdatedAtBeginTime` | `string` | Optional | Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339<br>format.  The range is determined using the `updated_at` field for each `PaymentRefund`.<br><br>Default: if omitted, the time range starts at `beginTime`. |
+| `UpdatedAtEndTime` | `string` | Optional | Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339<br>format.  The range is determined using the `updated_at` field for each `PaymentRefund`.<br><br>Default: The current time. |
+| `SortField` | `string` | Optional | The field used to sort results by. The default is `CREATED_AT`.<br>Current values include `CREATED_AT` and `UPDATED_AT`.<br> |
 | `SortOrder` | `String` | Optional | The order in which results are listed by `PaymentRefund.created_at`:<br><br>- `ASC` - Oldest to newest.<br>- `DESC` - Newest to oldest (default). | String getSortOrder() |
 | `Cursor` | `String` | Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this cursor to retrieve the next set of results for the original query.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | String getCursor() |
 | `LocationId` | `String` | Optional | Limit results to the location supplied. By default, results are returned<br>for all locations associated with the seller. | String getLocationId() |

src/main/java/com/squareup/square/SquareClient.java

@@ -157,7 +157,7 @@ public final class SquareClient implements SquareClientInterface {
 
     private static final CompatibilityFactory compatibilityFactory = new CompatibilityFactoryImpl();
 
-    private static String userAgent = "Square-Java-SDK/43.0.0.20250123 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}";
+    private static String userAgent = "Square-Java-SDK/43.1.0.20250220 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}";
 
     /**
      * Current API environment.
@@ -719,7 +719,7 @@ public String getAccessToken() {
      * @return sdkVersion
      */
     public String getSdkVersion() {
-        return "43.0.0.20250123";
+        return "43.1.0.20250220";
     }
 
     /**
@@ -832,7 +832,7 @@ public static class Builder {
 
         private Environment environment = Environment.PRODUCTION;
         private String customUrl = "https://connect.squareup.com";
-        private String squareVersion = "2025-01-23";
+        private String squareVersion = "2025-02-17";
         private HttpClient httpClient;
         private Headers additionalHeaders = new Headers();
         private String userAgentDetail = null;

src/main/java/com/squareup/square/api/DefaultRefundsApi.java

@@ -41,6 +41,14 @@ public DefaultRefundsApi(GlobalConfiguration globalConfig) {
      * @param  endTime  Optional parameter: Indicates the end of the time range to retrieve each
      *         `PaymentRefund` for, in RFC 3339 format. The range is determined using the
      *         `created_at` field for each `PaymentRefund`. Default: The current time.
+     * @param  updatedAtBeginTime  Optional parameter: Indicates the start of the time range to retrieve each
+     *         `PaymentRefund` for, in RFC 3339 format. The range is determined using the
+     *         `updated_at` field for each `PaymentRefund`. Default: if omitted, the time range starts at `beginTime`.
+     * @param  updatedAtEndTime  Optional parameter: Indicates the end of the time range to retrieve each
+     *         `PaymentRefund` for, in RFC 3339 format. The range is determined using the
+     *         `updated_at` field for each `PaymentRefund`. Default: The current time.
+     * @param  sortField  Optional parameter: The field used to sort results by. The default is `CREATED_AT`.
+     *         Current values include `CREATED_AT` and `UPDATED_AT`.
      * @param  sortOrder  Optional parameter: The order in which results are listed by
      *         `PaymentRefund.created_at`: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest
      *         (default).
@@ -70,6 +78,9 @@ public DefaultRefundsApi(GlobalConfiguration globalConfig) {
     public ListPaymentRefundsResponse listPaymentRefunds(
             final String beginTime,
             final String endTime,
+            final String updatedAtBeginTime,
+            final String updatedAtEndTime,
+            final String sortField,
             final String sortOrder,
             final String cursor,
             final String locationId,
@@ -91,6 +102,14 @@ public ListPaymentRefundsResponse listPaymentRefunds(
      * @param  endTime  Optional parameter: Indicates the end of the time range to retrieve each
      *         `PaymentRefund` for, in RFC 3339 format. The range is determined using the
      *         `created_at` field for each `PaymentRefund`. Default: The current time.
+     * @param  updatedAtBeginTime  Optional parameter: Indicates the start of the time range to retrieve each
+     *         `PaymentRefund` for, in RFC 3339 format. The range is determined using the
+     *         `updated_at` field for each `PaymentRefund`. Default: if omitted, the time range starts at `beginTime`.
+     * @param  updatedAtEndTime  Optional parameter: Indicates the end of the time range to retrieve each
+     *         `PaymentRefund` for, in RFC 3339 format. The range is determined using the
+     *         `updated_at` field for each `PaymentRefund`. Default: The current time.
+     * @param  sortField  Optional parameter: The field used to sort results by. The default is `CREATED_AT`.
+     *         Current values include `CREATED_AT` and `UPDATED_AT`.
      * @param  sortOrder  Optional parameter: The order in which results are listed by
      *         `PaymentRefund.created_at`: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest
      *         (default).
@@ -118,14 +137,17 @@ public ListPaymentRefundsResponse listPaymentRefunds(
     public CompletableFuture<ListPaymentRefundsResponse> listPaymentRefundsAsync(
             final String beginTime,
             final String endTime,
+            final String updatedAtBeginTime,
+            final String updatedAtEndTime,
+            final String sortField,
             final String sortOrder,
             final String cursor,
             final String locationId,
             final String status,
             final String sourceType,
             final Integer limit) {
         try { 
-            return prepareListPaymentRefundsRequest(beginTime, endTime, sortOrder, cursor, locationId,
+            return prepareListPaymentRefundsRequest(beginTime, endTime, updatedAtBeginTime, updatedAtEndTime, sortField, sortOrder, cursor, locationId,
             status, sourceType, limit).executeAsync(); 
         } catch (Exception e) {  
             throw new CompletionException(e); 
@@ -138,6 +160,9 @@ public CompletableFuture<ListPaymentRefundsResponse> listPaymentRefundsAsync(
     private ApiCall<ListPaymentRefundsResponse, ApiException> prepareListPaymentRefundsRequest(
             final String beginTime,
             final String endTime,
+            final String updatedAtBeginTime,
+            final String updatedAtEndTime,
+            final String sortField,
             final String sortOrder,
             final String cursor,
             final String locationId,
@@ -153,6 +178,12 @@ private ApiCall<ListPaymentRefundsResponse, ApiException> prepareListPaymentRefu
                                 .value(beginTime).isRequired(false))
                         .queryParam(param -> param.key("end_time")
                                 .value(endTime).isRequired(false))
+                        .queryParam(param -> param.key("updated_at_begin_time")
+                                .value(updatedAtBeginTime).isRequired(false))
+                        .queryParam(param -> param.key("updated_at_end_time")
+                                .value(updatedAtEndTime).isRequired(false))
+                        .queryParam(param -> param.key("sort_field")
+                                .value(sortField).isRequired(false))
                         .queryParam(param -> param.key("sort_order")
                                 .value(sortOrder).isRequired(false))
                         .queryParam(param -> param.key("cursor")