diff --git a/.fern/metadata.json b/.fern/metadata.json
index ac4c8814..7203ea45 100644
--- a/.fern/metadata.json
+++ b/.fern/metadata.json
@@ -1,5 +1,5 @@
{
- "cliVersion": "3.98.5",
+ "cliVersion": "5.56.0",
"generatorName": "fernapi/fern-python-sdk",
"generatorVersion": "4.55.4",
"generatorConfig": {
@@ -14,5 +14,6 @@
"use_typeddict_requests_for_file_upload": true,
"exclude_types_from_init_exports": true
},
- "sdkVersion": "44.2.0-rc.0"
+ "originGitCommit": "b2dac8b2c1b9fe87c0e1fe3eb6257b259caa0715",
+ "sdkVersion": "45.0.1.20260715"
}
\ No newline at end of file
diff --git a/.fern/replay.lock b/.fern/replay.lock
index 276d1b4d..5edd26f5 100644
--- a/.fern/replay.lock
+++ b/.fern/replay.lock
@@ -6,5 +6,11 @@ generations:
timestamp: 2026-05-19T21:17:07.449Z
cli_version: unknown
generator_versions: {}
-current_generation: 813313da9098aacfa234225449b0c67cf4a6284c
+ - commit_sha: 20fdc7bbb8d546dddddc81eb6d529308bd168d08
+ tree_hash: a122988cb5ca436b953d395eef18e3b7b51224cb
+ timestamp: 2026-07-14T16:59:18.638Z
+ cli_version: unknown
+ generator_versions:
+ fernapi/fern-python-sdk: 4.55.4
+current_generation: 20fdc7bbb8d546dddddc81eb6d529308bd168d08
patches: []
diff --git a/pyproject.toml b/pyproject.toml
index 2dba3aba..bb56312e 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,7 +4,7 @@ dynamic = ["version"]
[tool.poetry]
name = "squareup"
-version = "44.2.0-rc.0"
+version = "45.0.1.20260715"
description = ""
readme = "README.md"
authors = []
diff --git a/reference.md b/reference.md
index 4857a1df..c056b1f3 100644
--- a/reference.md
+++ b/reference.md
@@ -2748,9 +2748,15 @@ batches will be processed in order as long as the total object count for the
request (items, variations, modifier lists, discounts, and taxes) is no more
than 10,000.
+This endpoint uses full-replacement semantics. The client must send the complete object, and any
+field absent from the request is interpreted as an intentional clear. This logic applies to
+nested objects as well. For example, omitting inlined children like variations will delete them.
+
To ensure consistency, only one update request is processed at a time per seller account.
While one (batch or non-batch) update request is being processed, other (batched and non-batched)
-update requests are rejected with the `429` error code.
+update requests are rejected with the `429` error code. Prefer batching related changes into a
+single call rather than issuing many small writes, since each write acquires the lock separately
+and parallel writes to the same seller will contend with each other, producing `429` errors.
@@ -2935,6 +2941,8 @@ Returns a list of all [CatalogObject](entity:CatalogObject)s of the specified ty
The `types` parameter is specified as a comma-separated list of the [CatalogObjectType](entity:CatalogObjectType) values,
for example, "`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`".
+Always specify `types` explicitly. When upgrading to a newer API version, omitting `types` may
+cause new object types to appear in results that were not returned under the previous version.
__Important:__ ListCatalog does not return deleted catalog items. To retrieve
deleted catalog items, use [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects)
@@ -3065,6 +3073,11 @@ endpoint in the following aspects:
- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not.
- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does.
- The both endpoints have different call conventions, including the query filter formats.
+
+The `object_types` parameter is specified as a list of [CatalogObjectType](entity:CatalogObjectType) values.
+Always specify `object_types` explicitly. When upgrading to a newer API version, omitting
+`object_types` may cause new object types to appear in results that were not returned under
+the previous version.
@@ -6437,10 +6450,578 @@ see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-pa
-
-**location_id:** `str`
+**location_id:** `str`
+
+The ID of the [location](entity:Location) where the gift card should be registered for
+reporting purposes. Gift cards can be redeemed at any of the seller's locations.
+
+
+
+
+
+-
+
+**gift_card:** `GiftCardParams`
+
+The gift card to create. The `type` field is required for this request. The `gan_source`
+and `gan` fields are included as follows:
+
+To direct Square to generate a 16-digit GAN, omit `gan_source` and `gan`.
+
+To provide a custom GAN, include `gan_source` and `gan`.
+- For `gan_source`, specify `OTHER`.
+- For `gan`, provide a custom GAN containing 8 to 20 alphanumeric characters. The GAN must be
+unique for the seller and cannot start with the same bank identification number (BIN) as major
+credit cards. Do not use GANs that are easy to guess (such as 12345678) because they greatly
+increase the risk of fraud. It is the responsibility of the developer to ensure the security
+of their custom GANs. For more information, see
+[Custom GANs](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#custom-gans).
+
+To register an unused, physical gift card that the seller previously ordered from Square,
+include `gan` and provide the GAN that is printed on the gift card.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+
+
+client.gift_cards.get_from_gan(...) -> AsyncHttpResponse[GetGiftCardFromGanResponse]
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves a gift card using the gift card account number (GAN).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from square import Square
+
+client = Square(
+ token="YOUR_TOKEN",
+)
+client.gift_cards.get_from_gan(
+ gan="7783320001001635",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**gan:** `str`
+
+The gift card account number (GAN) of the gift card to retrieve.
+The maximum length of a GAN is 255 digits to account for third-party GANs that have been imported.
+Square-issued gift cards have 16-digit GANs.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.gift_cards.get_from_nonce(...) -> AsyncHttpResponse[GetGiftCardFromNonceResponse]
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves a gift card using a secure payment token that represents the gift card.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from square import Square
+
+client = Square(
+ token="YOUR_TOKEN",
+)
+client.gift_cards.get_from_nonce(
+ nonce="cnon:7783322135245171",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**nonce:** `str`
+
+The payment token of the gift card to retrieve. Payment tokens are generated by the
+Web Payments SDK or In-App Payments SDK.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.gift_cards.link_customer(...) -> AsyncHttpResponse[LinkCustomerToGiftCardResponse]
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Links a customer to a gift card, which is also referred to as adding a card on file.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from square import Square
+
+client = Square(
+ token="YOUR_TOKEN",
+)
+client.gift_cards.link_customer(
+ gift_card_id="gift_card_id",
+ customer_id="GKY0FZ3V717AH8Q2D821PNT2ZW",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**gift_card_id:** `str` — The ID of the gift card to be linked.
+
+
+
+
+
+-
+
+**customer_id:** `str` — The ID of the customer to link to the gift card.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.gift_cards.unlink_customer(...) -> AsyncHttpResponse[UnlinkCustomerFromGiftCardResponse]
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Unlinks a customer from a gift card, which is also referred to as removing a card on file.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from square import Square
+
+client = Square(
+ token="YOUR_TOKEN",
+)
+client.gift_cards.unlink_customer(
+ gift_card_id="gift_card_id",
+ customer_id="GKY0FZ3V717AH8Q2D821PNT2ZW",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**gift_card_id:** `str` — The ID of the gift card to be unlinked.
+
+
+
+
+
+-
+
+**customer_id:** `str` — The ID of the customer to unlink from the gift card.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.gift_cards.get(...) -> AsyncHttpResponse[GetGiftCardResponse]
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves a gift card using the gift card ID.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from square import Square
+
+client = Square(
+ token="YOUR_TOKEN",
+)
+client.gift_cards.get(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str` — The ID of the gift card to retrieve.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.inventory.list_inventory_adjustment_reasons(...) -> AsyncHttpResponse[ListInventoryAdjustmentReasonsResponse]
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the standard and custom inventory adjustment reasons available
+to the seller.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from square import Square
+
+client = Square(
+ token="YOUR_TOKEN",
+)
+client.inventory.list_inventory_adjustment_reasons(
+ include_deleted=True,
+ include_system_codes=True,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**include_deleted:** `typing.Optional[bool]`
+
+Indicates whether the response should include deleted custom inventory
+adjustment reasons. The default value is `false`.
+
+
+
+
+
+-
+
+**include_system_codes:** `typing.Optional[bool]`
+
+Indicates whether the response should include Square-generated system
+inventory adjustment reason codes that cannot be used to write adjustments
+from the Connect API, such as `SALE`, `RECOUNT`, `TRANSFER`, `IN_TRANSIT`,
+and `CANCELED_SALE`. The default value is `false`.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.inventory.create_inventory_adjustment_reason(...) -> AsyncHttpResponse[CreateInventoryAdjustmentReasonResponse]
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a custom inventory adjustment reason.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from square import Square
+
+client = Square(
+ token="YOUR_TOKEN",
+)
+client.inventory.create_inventory_adjustment_reason(
+ idempotency_key="27b2f2b1-1c2a-4b9e-8f3a-0d9c3a1e5b47",
+ adjustment_reason={
+ "id": {"type": "CUSTOM"},
+ "name": "Donated to charity",
+ "direction": "DECREASE",
+ },
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
-The ID of the [location](entity:Location) where the gift card should be registered for
-reporting purposes. Gift cards can be redeemed at any of the seller's locations.
+**idempotency_key:** `str`
+
+A client-supplied, universally unique identifier to make this
+[CreateInventoryAdjustmentReason](api-endpoint:Inventory-CreateInventoryAdjustmentReason)
+request idempotent.
@@ -6448,24 +7029,10 @@ reporting purposes. Gift cards can be redeemed at any of the seller's locations.
-
-**gift_card:** `GiftCardParams`
-
-The gift card to create. The `type` field is required for this request. The `gan_source`
-and `gan` fields are included as follows:
-
-To direct Square to generate a 16-digit GAN, omit `gan_source` and `gan`.
-
-To provide a custom GAN, include `gan_source` and `gan`.
-- For `gan_source`, specify `OTHER`.
-- For `gan`, provide a custom GAN containing 8 to 20 alphanumeric characters. The GAN must be
-unique for the seller and cannot start with the same bank identification number (BIN) as major
-credit cards. Do not use GANs that are easy to guess (such as 12345678) because they greatly
-increase the risk of fraud. It is the responsibility of the developer to ensure the security
-of their custom GANs. For more information, see
-[Custom GANs](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#custom-gans).
+**adjustment_reason:** `InventoryAdjustmentReasonParams`
-To register an unused, physical gift card that the seller previously ordered from Square,
-include `gan` and provide the GAN that is printed on the gift card.
+The custom inventory adjustment reason to create. Only custom
+adjustment reasons can be created.
@@ -6485,7 +7052,7 @@ include `gan` and provide the GAN that is printed on the gift card.
client.gift_cards.get_from_gan(...) -> AsyncHttpResponse[GetGiftCardFromGanResponse]
+client.inventory.delete_inventory_adjustment_reason(...) -> AsyncHttpResponse[DeleteInventoryAdjustmentReasonResponse]
-
@@ -6497,7 +7064,7 @@ include `gan` and provide the GAN that is printed on the gift card.
-
-Retrieves a gift card using the gift card account number (GAN).
+Soft deletes a custom inventory adjustment reason.
@@ -6517,8 +7084,8 @@ from square import Square
client = Square(
token="YOUR_TOKEN",
)
-client.gift_cards.get_from_gan(
- gan="7783320001001635",
+client.inventory.delete_inventory_adjustment_reason(
+ reason_id={"type": "CUSTOM", "custom_reason_id": "R5BX3PDCZ6EXAMPLE"},
)
```
@@ -6535,11 +7102,7 @@ client.gift_cards.get_from_gan(
-
-**gan:** `str`
-
-The gift card account number (GAN) of the gift card to retrieve.
-The maximum length of a GAN is 255 digits to account for third-party GANs that have been imported.
-Square-issued gift cards have 16-digit GANs.
+**reason_id:** `InventoryAdjustmentReasonIdParams` — The identifier of the custom inventory adjustment reason to soft delete.
@@ -6559,7 +7122,7 @@ Square-issued gift cards have 16-digit GANs.
client.gift_cards.get_from_nonce(...) -> AsyncHttpResponse[GetGiftCardFromNonceResponse]
+client.inventory.restore_inventory_adjustment_reason(...) -> AsyncHttpResponse[RestoreInventoryAdjustmentReasonResponse]
-
@@ -6571,7 +7134,7 @@ Square-issued gift cards have 16-digit GANs.
-
-Retrieves a gift card using a secure payment token that represents the gift card.
+Restores a soft-deleted custom inventory adjustment reason.
@@ -6591,8 +7154,8 @@ from square import Square
client = Square(
token="YOUR_TOKEN",
)
-client.gift_cards.get_from_nonce(
- nonce="cnon:7783322135245171",
+client.inventory.restore_inventory_adjustment_reason(
+ reason_id={"type": "CUSTOM", "custom_reason_id": "R5BX3PDCZ6EXAMPLE"},
)
```
@@ -6609,10 +7172,10 @@ client.gift_cards.get_from_nonce(
-
-**nonce:** `str`
+**reason_id:** `InventoryAdjustmentReasonIdParams`
-The payment token of the gift card to retrieve. Payment tokens are generated by the
-Web Payments SDK or In-App Payments SDK.
+The identifier of the soft-deleted custom inventory adjustment reason
+to restore.
@@ -6632,7 +7195,7 @@ Web Payments SDK or In-App Payments SDK.
client.gift_cards.link_customer(...) -> AsyncHttpResponse[LinkCustomerToGiftCardResponse]
+client.inventory.retrieve_inventory_adjustment_reason(...) -> AsyncHttpResponse[RetrieveInventoryAdjustmentReasonResponse]
-
@@ -6644,7 +7207,8 @@ Web Payments SDK or In-App Payments SDK.
-
-Links a customer to a gift card, which is also referred to as adding a card on file.
+Returns the inventory adjustment reason identified by the provided
+`reason_id`. Deleted custom reasons can be retrieved by ID.
@@ -6664,9 +7228,8 @@ from square import Square
client = Square(
token="YOUR_TOKEN",
)
-client.gift_cards.link_customer(
- gift_card_id="gift_card_id",
- customer_id="GKY0FZ3V717AH8Q2D821PNT2ZW",
+client.inventory.retrieve_inventory_adjustment_reason(
+ reason_id={"type": "CUSTOM", "custom_reason_id": "R5BX3PDCZ6EXAMPLE"},
)
```
@@ -6683,15 +7246,7 @@ client.gift_cards.link_customer(
-
-**gift_card_id:** `str` — The ID of the gift card to be linked.
-
-
-
-
-
--
-
-**customer_id:** `str` — The ID of the customer to link to the gift card.
+**reason_id:** `InventoryAdjustmentReasonIdParams` — The identifier of the inventory adjustment reason to retrieve.
@@ -6711,7 +7266,7 @@ client.gift_cards.link_customer(
client.gift_cards.unlink_customer(...) -> AsyncHttpResponse[UnlinkCustomerFromGiftCardResponse]
+client.inventory.update_inventory_adjustment_reason(...) -> AsyncHttpResponse[UpdateInventoryAdjustmentReasonResponse]
-
@@ -6723,7 +7278,7 @@ client.gift_cards.link_customer(
-
-Unlinks a customer from a gift card, which is also referred to as removing a card on file.
+Updates a custom inventory adjustment reason.
@@ -6743,9 +7298,12 @@ from square import Square
client = Square(
token="YOUR_TOKEN",
)
-client.gift_cards.unlink_customer(
- gift_card_id="gift_card_id",
- customer_id="GKY0FZ3V717AH8Q2D821PNT2ZW",
+client.inventory.update_inventory_adjustment_reason(
+ reason_id={"type": "CUSTOM", "custom_reason_id": "R5BX3PDCZ6EXAMPLE"},
+ adjustment_reason={
+ "id": {"type": "CUSTOM", "custom_reason_id": "R5BX3PDCZ6EXAMPLE"},
+ "name": "Charitable donation",
+ },
)
```
@@ -6762,7 +7320,7 @@ client.gift_cards.unlink_customer(
-
-**gift_card_id:** `str` — The ID of the gift card to be unlinked.
+**reason_id:** `InventoryAdjustmentReasonIdParams` — The identifier of the custom inventory adjustment reason to update.
@@ -6770,7 +7328,12 @@ client.gift_cards.unlink_customer(
-
-**customer_id:** `str` — The ID of the customer to unlink from the gift card.
+**adjustment_reason:** `InventoryAdjustmentReasonParams`
+
+The requested custom inventory adjustment reason update. Only the
+`name` field can be updated. Deleted custom reasons cannot be updated. To
+restore a deleted custom reason, call
+[RestoreInventoryAdjustmentReason](api-endpoint:Inventory-RestoreInventoryAdjustmentReason).
@@ -6790,7 +7353,7 @@ client.gift_cards.unlink_customer(
client.gift_cards.get(...) -> AsyncHttpResponse[GetGiftCardResponse]
+client.inventory.deprecated_get_adjustment(...) -> AsyncHttpResponse[GetInventoryAdjustmentResponse]
-
@@ -6802,7 +7365,8 @@ client.gift_cards.unlink_customer(
-
-Retrieves a gift card using the gift card ID.
+Deprecated version of [RetrieveInventoryAdjustment](api-endpoint:Inventory-RetrieveInventoryAdjustment) after the endpoint URL
+is updated to conform to the standard convention.
@@ -6822,8 +7386,8 @@ from square import Square
client = Square(
token="YOUR_TOKEN",
)
-client.gift_cards.get(
- id="id",
+client.inventory.deprecated_get_adjustment(
+ adjustment_id="adjustment_id",
)
```
@@ -6840,7 +7404,7 @@ client.gift_cards.get(
-
-**id:** `str` — The ID of the gift card to retrieve.
+**adjustment_id:** `str` — ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve.
@@ -6860,8 +7424,7 @@ client.gift_cards.get(
client.inventory.deprecated_get_adjustment(...) -> AsyncHttpResponse[GetInventoryAdjustmentResponse]
+client.inventory.update_inventory_adjustment(...) -> AsyncHttpResponse[UpdateInventoryAdjustmentResponse]
-
@@ -6873,8 +7436,10 @@ client.gift_cards.get(
-
-Deprecated version of [RetrieveInventoryAdjustment](api-endpoint:Inventory-RetrieveInventoryAdjustment) after the endpoint URL
-is updated to conform to the standard convention.
+Applies an update to the provided adjustment.
+
+On success: returns the newly updated adjustment.
+On failure: returns a list of related errors.
@@ -6894,8 +7459,9 @@ from square import Square
client = Square(
token="YOUR_TOKEN",
)
-client.inventory.deprecated_get_adjustment(
- adjustment_id="adjustment_id",
+client.inventory.update_inventory_adjustment(
+ idempotency_key="8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe",
+ adjustment={},
)
```
@@ -6912,7 +7478,35 @@ client.inventory.deprecated_get_adjustment(
-
-**adjustment_id:** `str` — ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve.
+**idempotency_key:** `str`
+
+A client-supplied, universally unique identifier (UUID) for the
+request.
+
+See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the
+[Build Basics](https://developer.squareup.com/docs/buildbasics) section for more
+information.
+
+
+
+
+
+-
+
+**adjustment:** `InventoryAdjustmentParams`
+
+Represents the updates being written to a past/existing inventory adjustment.
+This works using sparse updates, meaning that any fields omitted from the inputted InventoryAdjustment
+will retain their values.
+
+Only updates to the quantity, cost_money, vendor_id, and reason_id fields of an InventoryAdjustment can be made here.
+Note that the quantity field must be provided, but it can be identical to the current quantity if there are no desired quantity changes.
+cost_money and vendor_id can only be written to adjustments that add stock to the system (from_state of NONE or UNLINKED_RETURN) and to untracked sale adjustments.
+reason_id can be changed to any reason that is valid for the adjustment's state transition. The reason of a system-generated adjustment (for example, SALE or RECOUNT) cannot be changed.
+Adjustments generated by Square from other records cannot be updated. This includes inferred adjustments created by physical counts, transfer-like cross-location adjustments, and component adjustments.
+Adjustments linked to purchase orders cannot be updated. Adjustments linked to sales can only have cost_money and vendor_id updated, and only for untracked sales.
+Restock adjustments linked to an itemized return can have their quantity updated, up to the quantity remaining on the return.
+Adjustments older than one year cannot be updated.
@@ -7265,6 +7859,31 @@ See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagin
-
+**sort:** `typing.Optional[BatchRetrieveInventoryChangesSortParams]`
+
+Specification of how returned inventory changes should be ordered.
+
+Currently, inventory changes can only be ordered by the occurred_at field.
+The default sort order for occurred_at is ASC (changes are returned oldest-first by default).
+
+
+
+
+
+-
+
+**reason_ids:** `typing.Optional[typing.Sequence[InventoryAdjustmentReasonIdParams]]`
+
+The filter to return `ADJUSTMENT` query results by inventory
+adjustment reason. This filter is only applied when set. The request cannot
+include both `reason_ids` and `states`.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -7685,6 +8304,31 @@ See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagin
-
+**sort:** `typing.Optional[BatchRetrieveInventoryChangesSortParams]`
+
+Specification of how returned inventory changes should be ordered.
+
+Currently, inventory changes can only be ordered by the occurred_at field.
+The default sort order for occurred_at is ASC (changes are returned oldest-first by default).
+
+
+
+
+
+-
+
+**reason_ids:** `typing.Optional[typing.Sequence[InventoryAdjustmentReasonIdParams]]`
+
+The filter to return `ADJUSTMENT` query results by inventory
+adjustment reason. This filter is only applied when set. The request cannot
+include both `reason_ids` and `states`.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -7987,77 +8631,6 @@ ID of the
-
-
-
client.inventory.get_transfer(...) -> AsyncHttpResponse[GetInventoryTransferResponse]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns the [InventoryTransfer](entity:InventoryTransfer) object
-with the provided `transfer_id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from square import Square
-
-client = Square(
- token="YOUR_TOKEN",
-)
-client.inventory.get_transfer(
- transfer_id="transfer_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**transfer_id:** `str` — ID of the [InventoryTransfer](entity:InventoryTransfer) to retrieve.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
client.inventory.get_transfer(...) -> AsyncHttpResponse[None]
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from square import Square
+
+client = Square(
+ token="YOUR_TOKEN",
+)
+client.inventory.get_transfer(
+ transfer_id="transfer_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**transfer_id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+