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

Author: eyw520

doc/api/refunds.md

@@ -28,6 +28,9 @@ The maximum results per page is 100.
 def list_payment_refunds(self,
                         begin_time=None,
                         end_time=None,
+                        updated_at_begin_time=None,
+                        updated_at_end_time=None,
+                        sort_field=None,
                         sort_order=None,
                         cursor=None,
                         location_id=None,
@@ -42,6 +45,9 @@ def list_payment_refunds(self,
 |  --- | --- | --- | --- |
 | `begin_time` | `str` | 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. |
 | `end_time` | `str` | 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. |
+| `updated_at_begin_time` | `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`. |
+| `updated_at_end_time` | `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. |
+| `sort_field` | `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> |
 | `sort_order` | `str` | 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` | `str` | 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). |
 | `location_id` | `str` | Query, Optional | Limit results to the location supplied. By default, results are returned<br>for all locations associated with the seller. |

doc/client.md

@@ -5,7 +5,7 @@ The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `square_version` | `str` | Square Connect API versions<br>*Default*: `'2025-01-23'` |
+| `square_version` | `str` | Square Connect API versions<br>*Default*: `'2025-02-20'` |
 | `custom_url` | `str` | 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`** |
 | `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |
@@ -24,7 +24,7 @@ The API client can be initialized as follows:
 
 ```python
 client = Client(
-    square_version='2025-01-23',
+    square_version='2025-02-20',
     bearer_auth_credentials=BearerAuthCredentials(
         access_token='AccessToken'
     ),
@@ -53,7 +53,7 @@ from square.http.auth.o_auth_2 import BearerAuthCredentials
 from square.client import Client
 
 client = Client(
-    square_version='2025-01-23',
+    square_version='2025-02-20',
     bearer_auth_credentials=BearerAuthCredentials(
         access_token='AccessToken'
     ),

pyproject.toml

@@ -4,7 +4,7 @@ requires = ["setuptools>=61.0"]
 [project]
 name = "squareup"
 description = "Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management."
-version = "40.0.0.220250123"
+version = "40.1.0.220250220"
 readme = "README.md"
 requires-python = ">=3.7"
 authors = [{name = "Square Developer Platform", email = "[email protected]"}]

square/api/base_api.py

@@ -22,7 +22,7 @@ class BaseApi(object):
 
     @staticmethod
     def user_agent():
-        return 'Square-Python-SDK/40.0.0.220250123 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+        return 'Square-Python-SDK/40.1.0.220250220 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
 
     @staticmethod
     def user_agent_parameters():

square/api/refunds_api.py

@@ -19,6 +19,9 @@ def __init__(self, config):
     def list_payment_refunds(self,
                              begin_time=None,
                              end_time=None,
+                             updated_at_begin_time=None,
+                             updated_at_end_time=None,
+                             sort_field=None,
                              sort_order=None,
                              cursor=None,
                              location_id=None,
@@ -42,6 +45,18 @@ def list_payment_refunds(self,
                 retrieve each `PaymentRefund` for, in RFC 3339  format.  The
                 range is determined using the `created_at` field for each
                 `PaymentRefund`.  Default: The current time.
+            updated_at_begin_time (str, optional): 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`.
+            updated_at_end_time (str, optional): 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.
+            sort_field (str, optional): The field used to sort results by. The default
+                is `CREATED_AT`. Current values include `CREATED_AT` and
+                `UPDATED_AT`.
             sort_order (str, optional): The order in which results are listed
                 by `PaymentRefund.created_at`: - `ASC` - Oldest to newest. -
                 `DESC` - Newest to oldest (default).
@@ -94,6 +109,15 @@ def list_payment_refunds(self,
             .query_param(Parameter()
                          .key('end_time')
                          .value(end_time))
+            .query_param(Parameter()
+                         .key('updated_at_begin_time')
+                         .value(updated_at_begin_time))
+            .query_param(Parameter()
+                         .key('updated_at_end_time')
+                         .value(updated_at_end_time))
+            .query_param(Parameter()
+                         .key('sort_field')
+                         .value(sort_field))
             .query_param(Parameter()
                          .key('sort_order')
                          .value(sort_order))

square/client.py

@@ -55,11 +55,11 @@
 class Client(object):
     @staticmethod
     def sdk_version():
-        return '40.0.0.220250123'
+        return '40.1.0.220250220'
 
     @staticmethod
     def square_version():
-        return '2025-01-23'
+        return '2025-02-20'
 
     def user_agent_detail(self):
         return self.config.user_agent_detail
@@ -238,7 +238,7 @@ def __init__(self, http_client_instance=None,
                  retry_statuses=None, retry_methods=None,
                  environment='production',
                  custom_url='https://connect.squareup.com', access_token=None,
-                 bearer_auth_credentials=None, square_version='2025-01-23',
+                 bearer_auth_credentials=None, square_version='2025-02-20',
                  additional_headers={}, user_agent_detail='', config=None):
         self.config = config or Configuration(
             http_client_instance=http_client_instance,

square/configuration.py

@@ -45,7 +45,7 @@ def __init__(self, http_client_instance=None,
                  retry_statuses=None, retry_methods=None,
                  environment='production',
                  custom_url='https://connect.squareup.com', access_token=None,
-                 bearer_auth_credentials=None, square_version='2025-01-23',
+                 bearer_auth_credentials=None, square_version='2025-02-20',
                  additional_headers={}, user_agent_detail=''):
         if retry_methods is None:
             retry_methods = ['GET', 'PUT']

tests/api/test_refunds_api.py

@@ -18,14 +18,17 @@ def test_test_list_payment_refunds(self):
         # Parameters for the API call
         begin_time = None
         end_time = None
+        updated_at_begin_time = None
+        updated_at_end_time = None
+        sort_field = None
         sort_order = None
         cursor = None
         location_id = None
         status = None
         source_type = None
 
         # Perform the API call through the SDK function
-        result = self.controller.list_payment_refunds(begin_time, end_time, sort_order, cursor, location_id, status, source_type)
+        result = self.controller.list_payment_refunds(begin_time, end_time, updated_at_begin_time, updated_at_end_time, sort_field, sort_order, cursor, location_id, status, source_type)
 
         # Test response code
         self.assertEquals(self.response_catcher.response.status_code, 200)