Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .fern/metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@
"use_typeddict_requests_for_file_upload": true,
"exclude_types_from_init_exports": true
},
"originGitCommit": "074e2540401528521d322c512800c4ebd67cd153",
"originGitCommit": "b05364cda2b85e35d8daa9ff2c24bbabbbd9652a",
"sdkVersion": "45.1.0.20260819"
}
8 changes: 7 additions & 1 deletion .fern/replay.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 27 additions & 2 deletions reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -2714,6 +2714,14 @@ in the response payload.
<dl>
<dd>

**include_options:** `typing.Optional[IncludeOptionsParams]` — Options to include related resources in the response.

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
Expand Down Expand Up @@ -3224,6 +3232,14 @@ is higher than the maximum limit of 1,000, it will be ignored.
<dl>
<dd>

**include_options:** `typing.Optional[IncludeOptionsParams]` — Options to include related resources in the response.

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
Expand Down Expand Up @@ -3407,6 +3423,14 @@ a single call to the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItem
<dl>
<dd>

**include_options:** `typing.Optional[IncludeOptionsParams]` — Options to include related resources in the response.

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
Expand Down Expand Up @@ -12584,8 +12608,9 @@ how to sort or filter the results. Your `SearchOrdersQuery` can:

Note that details for orders processed with Square Point of Sale while in
offline mode might not be transmitted to Square for up to 72 hours. Offline
orders have a `created_at` value that reflects the time the order was created,
not the time it was subsequently transmitted to Square.
orders have a `created_at` value that reflects the time the order was
transmitted to Square and created server-side, not the time the order was
created on the Point of Sale device.
</dd>
</dl>
</dd>
Expand Down
31 changes: 31 additions & 0 deletions src/square/catalog/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
from ..requests.catalog_object_batch import CatalogObjectBatchParams
from ..requests.catalog_query import CatalogQueryParams
from ..requests.custom_attribute_filter import CustomAttributeFilterParams
from ..requests.include_options import IncludeOptionsParams
from ..types.archived_state import ArchivedState
from ..types.batch_delete_catalog_objects_response import BatchDeleteCatalogObjectsResponse
from ..types.batch_get_catalog_objects_response import BatchGetCatalogObjectsResponse
Expand Down Expand Up @@ -108,6 +109,7 @@ def batch_get(
catalog_version: typing.Optional[int] = OMIT,
include_deleted_objects: typing.Optional[bool] = OMIT,
include_category_path_to_root: typing.Optional[bool] = OMIT,
include_options: typing.Optional[IncludeOptionsParams] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> BatchGetCatalogObjectsResponse:
"""
Expand Down Expand Up @@ -154,6 +156,9 @@ def batch_get(
and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned
in the response payload.

include_options : typing.Optional[IncludeOptionsParams]
Options to include related resources in the response.

request_options : typing.Optional[RequestOptions]
Request-specific configuration.

Expand All @@ -180,6 +185,7 @@ def batch_get(
catalog_version=catalog_version,
include_deleted_objects=include_deleted_objects,
include_category_path_to_root=include_category_path_to_root,
include_options=include_options,
request_options=request_options,
)
return _response.data
Expand Down Expand Up @@ -399,6 +405,7 @@ def search(
query: typing.Optional[CatalogQueryParams] = OMIT,
limit: typing.Optional[int] = OMIT,
include_category_path_to_root: typing.Optional[bool] = OMIT,
include_options: typing.Optional[IncludeOptionsParams] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> SearchCatalogObjectsResponse:
"""
Expand Down Expand Up @@ -475,6 +482,9 @@ def search(
include_category_path_to_root : typing.Optional[bool]
Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned in the response payload. If `include_category_path_to_root` is `true`, then the `include_deleted_objects` request parameter must be `false`. Both properties cannot be `true` at the same time.

include_options : typing.Optional[IncludeOptionsParams]
Options to include related resources in the response.

request_options : typing.Optional[RequestOptions]
Request-specific configuration.

Expand Down Expand Up @@ -507,6 +517,7 @@ def search(
query=query,
limit=limit,
include_category_path_to_root=include_category_path_to_root,
include_options=include_options,
request_options=request_options,
)
return _response.data
Expand All @@ -524,6 +535,7 @@ def search_items(
product_types: typing.Optional[typing.Sequence[CatalogItemProductType]] = OMIT,
custom_attribute_filters: typing.Optional[typing.Sequence[CustomAttributeFilterParams]] = OMIT,
archived_state: typing.Optional[ArchivedState] = OMIT,
include_options: typing.Optional[IncludeOptionsParams] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> SearchCatalogItemsResponse:
"""
Expand Down Expand Up @@ -576,6 +588,9 @@ def search_items(
archived_state : typing.Optional[ArchivedState]
The query filter to return not archived (`ARCHIVED_STATE_NOT_ARCHIVED`), archived (`ARCHIVED_STATE_ARCHIVED`), or either type (`ARCHIVED_STATE_ALL`) of items.

include_options : typing.Optional[IncludeOptionsParams]
Options to include related resources in the response.

request_options : typing.Optional[RequestOptions]
Request-specific configuration.

Expand Down Expand Up @@ -624,6 +639,7 @@ def search_items(
product_types=product_types,
custom_attribute_filters=custom_attribute_filters,
archived_state=archived_state,
include_options=include_options,
request_options=request_options,
)
return _response.data
Expand Down Expand Up @@ -841,6 +857,7 @@ async def batch_get(
catalog_version: typing.Optional[int] = OMIT,
include_deleted_objects: typing.Optional[bool] = OMIT,
include_category_path_to_root: typing.Optional[bool] = OMIT,
include_options: typing.Optional[IncludeOptionsParams] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> BatchGetCatalogObjectsResponse:
"""
Expand Down Expand Up @@ -887,6 +904,9 @@ async def batch_get(
and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned
in the response payload.

include_options : typing.Optional[IncludeOptionsParams]
Options to include related resources in the response.

request_options : typing.Optional[RequestOptions]
Request-specific configuration.

Expand Down Expand Up @@ -921,6 +941,7 @@ async def main() -> None:
catalog_version=catalog_version,
include_deleted_objects=include_deleted_objects,
include_category_path_to_root=include_category_path_to_root,
include_options=include_options,
request_options=request_options,
)
return _response.data
Expand Down Expand Up @@ -1165,6 +1186,7 @@ async def search(
query: typing.Optional[CatalogQueryParams] = OMIT,
limit: typing.Optional[int] = OMIT,
include_category_path_to_root: typing.Optional[bool] = OMIT,
include_options: typing.Optional[IncludeOptionsParams] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> SearchCatalogObjectsResponse:
"""
Expand Down Expand Up @@ -1241,6 +1263,9 @@ async def search(
include_category_path_to_root : typing.Optional[bool]
Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned in the response payload. If `include_category_path_to_root` is `true`, then the `include_deleted_objects` request parameter must be `false`. Both properties cannot be `true` at the same time.

include_options : typing.Optional[IncludeOptionsParams]
Options to include related resources in the response.

request_options : typing.Optional[RequestOptions]
Request-specific configuration.

Expand Down Expand Up @@ -1284,6 +1309,7 @@ async def main() -> None:
query=query,
limit=limit,
include_category_path_to_root=include_category_path_to_root,
include_options=include_options,
request_options=request_options,
)
return _response.data
Expand All @@ -1301,6 +1327,7 @@ async def search_items(
product_types: typing.Optional[typing.Sequence[CatalogItemProductType]] = OMIT,
custom_attribute_filters: typing.Optional[typing.Sequence[CustomAttributeFilterParams]] = OMIT,
archived_state: typing.Optional[ArchivedState] = OMIT,
include_options: typing.Optional[IncludeOptionsParams] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> SearchCatalogItemsResponse:
"""
Expand Down Expand Up @@ -1353,6 +1380,9 @@ async def search_items(
archived_state : typing.Optional[ArchivedState]
The query filter to return not archived (`ARCHIVED_STATE_NOT_ARCHIVED`), archived (`ARCHIVED_STATE_ARCHIVED`), or either type (`ARCHIVED_STATE_ALL`) of items.

include_options : typing.Optional[IncludeOptionsParams]
Options to include related resources in the response.

request_options : typing.Optional[RequestOptions]
Request-specific configuration.

Expand Down Expand Up @@ -1409,6 +1439,7 @@ async def main() -> None:
product_types=product_types,
custom_attribute_filters=custom_attribute_filters,
archived_state=archived_state,
include_options=include_options,
request_options=request_options,
)
return _response.data
Expand Down
Loading
Loading