diff --git a/.fern/metadata.json b/.fern/metadata.json
index d4b24802..844b1e55 100644
--- a/.fern/metadata.json
+++ b/.fern/metadata.json
@@ -1,7 +1,7 @@
{
- "cliVersion": "2.2.5",
+ "cliVersion": "3.38.0",
"generatorName": "fernapi/fern-python-sdk",
- "generatorVersion": "4.38.4",
+ "generatorVersion": "4.46.14",
"generatorConfig": {
"client": {
"class_name": "Square",
@@ -13,5 +13,6 @@
"use_typeddict_requests": true,
"use_typeddict_requests_for_file_upload": true,
"exclude_types_from_init_exports": true
- }
+ },
+ "sdkVersion": "44.0.0.20260122"
}
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
index f5669d1d..878ffc14 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
MIT License
-Copyright (c) 2025 Square.
+Copyright (c) 2026 Square.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/poetry.lock b/poetry.lock
index 9decbf87..2f8666b3 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -38,13 +38,13 @@ trio = ["trio (>=0.26.1)"]
[[package]]
name = "certifi"
-version = "2025.11.12"
+version = "2026.1.4"
description = "Python package for providing Mozilla's CA Bundle."
optional = false
python-versions = ">=3.7"
files = [
- {file = "certifi-2025.11.12-py3-none-any.whl", hash = "sha256:97de8790030bbd5c2d96b7ec782fc2f7820ef8dba6db909ccf95449f2d062d4b"},
- {file = "certifi-2025.11.12.tar.gz", hash = "sha256:d8ab5478f2ecd78af242878415affce761ca6bc54a22a27e026d7c25357c3316"},
+ {file = "certifi-2026.1.4-py3-none-any.whl", hash = "sha256:9943707519e4add1115f44c2bc244f782c0249876bf51b6599fee1ffbedd685c"},
+ {file = "certifi-2026.1.4.tar.gz", hash = "sha256:ac726dd470482006e014ad384921ed6438c457018f4b3d204aea4281258b2120"},
]
[[package]]
@@ -236,13 +236,13 @@ files = [
[[package]]
name = "packaging"
-version = "25.0"
+version = "26.0"
description = "Core utilities for Python packages"
optional = false
python-versions = ">=3.8"
files = [
- {file = "packaging-25.0-py3-none-any.whl", hash = "sha256:29572ef2b1f17581046b3a2227d5c611fb25ec70ca1ba8554b24b0e69331a484"},
- {file = "packaging-25.0.tar.gz", hash = "sha256:d443872c98d677bf60f6a1f2f8c1cb748e8fe762d2bf9d3148b5599295b0fc4f"},
+ {file = "packaging-26.0-py3-none-any.whl", hash = "sha256:b36f1fef9334a5588b4166f8bcd26a14e521f2b55e6b9de3aaa80d3ff7a37529"},
+ {file = "packaging-26.0.tar.gz", hash = "sha256:00243ae351a257117b6a241061796684b084ed1c516a08c48a3f7e147a9d80b4"},
]
[[package]]
@@ -517,53 +517,58 @@ files = [
[[package]]
name = "tomli"
-version = "2.3.0"
+version = "2.4.0"
description = "A lil' TOML parser"
optional = false
python-versions = ">=3.8"
files = [
- {file = "tomli-2.3.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:88bd15eb972f3664f5ed4b57c1634a97153b4bac4479dcb6a495f41921eb7f45"},
- {file = "tomli-2.3.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:883b1c0d6398a6a9d29b508c331fa56adbcdff647f6ace4dfca0f50e90dfd0ba"},
- {file = "tomli-2.3.0-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:d1381caf13ab9f300e30dd8feadb3de072aeb86f1d34a8569453ff32a7dea4bf"},
- {file = "tomli-2.3.0-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:a0e285d2649b78c0d9027570d4da3425bdb49830a6156121360b3f8511ea3441"},
- {file = "tomli-2.3.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:0a154a9ae14bfcf5d8917a59b51ffd5a3ac1fd149b71b47a3a104ca4edcfa845"},
- {file = "tomli-2.3.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:74bf8464ff93e413514fefd2be591c3b0b23231a77f901db1eb30d6f712fc42c"},
- {file = "tomli-2.3.0-cp311-cp311-win32.whl", hash = "sha256:00b5f5d95bbfc7d12f91ad8c593a1659b6387b43f054104cda404be6bda62456"},
- {file = "tomli-2.3.0-cp311-cp311-win_amd64.whl", hash = "sha256:4dc4ce8483a5d429ab602f111a93a6ab1ed425eae3122032db7e9acf449451be"},
- {file = "tomli-2.3.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:d7d86942e56ded512a594786a5ba0a5e521d02529b3826e7761a05138341a2ac"},
- {file = "tomli-2.3.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:73ee0b47d4dad1c5e996e3cd33b8a76a50167ae5f96a2607cbe8cc773506ab22"},
- {file = "tomli-2.3.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:792262b94d5d0a466afb5bc63c7daa9d75520110971ee269152083270998316f"},
- {file = "tomli-2.3.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:4f195fe57ecceac95a66a75ac24d9d5fbc98ef0962e09b2eddec5d39375aae52"},
- {file = "tomli-2.3.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:e31d432427dcbf4d86958c184b9bfd1e96b5b71f8eb17e6d02531f434fd335b8"},
- {file = "tomli-2.3.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:7b0882799624980785240ab732537fcfc372601015c00f7fc367c55308c186f6"},
- {file = "tomli-2.3.0-cp312-cp312-win32.whl", hash = "sha256:ff72b71b5d10d22ecb084d345fc26f42b5143c5533db5e2eaba7d2d335358876"},
- {file = "tomli-2.3.0-cp312-cp312-win_amd64.whl", hash = "sha256:1cb4ed918939151a03f33d4242ccd0aa5f11b3547d0cf30f7c74a408a5b99878"},
- {file = "tomli-2.3.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:5192f562738228945d7b13d4930baffda67b69425a7f0da96d360b0a3888136b"},
- {file = "tomli-2.3.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:be71c93a63d738597996be9528f4abe628d1adf5e6eb11607bc8fe1a510b5dae"},
- {file = "tomli-2.3.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c4665508bcbac83a31ff8ab08f424b665200c0e1e645d2bd9ab3d3e557b6185b"},
- {file = "tomli-2.3.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:4021923f97266babc6ccab9f5068642a0095faa0a51a246a6a02fccbb3514eaf"},
- {file = "tomli-2.3.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:a4ea38c40145a357d513bffad0ed869f13c1773716cf71ccaa83b0fa0cc4e42f"},
- {file = "tomli-2.3.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:ad805ea85eda330dbad64c7ea7a4556259665bdf9d2672f5dccc740eb9d3ca05"},
- {file = "tomli-2.3.0-cp313-cp313-win32.whl", hash = "sha256:97d5eec30149fd3294270e889b4234023f2c69747e555a27bd708828353ab606"},
- {file = "tomli-2.3.0-cp313-cp313-win_amd64.whl", hash = "sha256:0c95ca56fbe89e065c6ead5b593ee64b84a26fca063b5d71a1122bf26e533999"},
- {file = "tomli-2.3.0-cp314-cp314-macosx_10_13_x86_64.whl", hash = "sha256:cebc6fe843e0733ee827a282aca4999b596241195f43b4cc371d64fc6639da9e"},
- {file = "tomli-2.3.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:4c2ef0244c75aba9355561272009d934953817c49f47d768070c3c94355c2aa3"},
- {file = "tomli-2.3.0-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c22a8bf253bacc0cf11f35ad9808b6cb75ada2631c2d97c971122583b129afbc"},
- {file = "tomli-2.3.0-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0eea8cc5c5e9f89c9b90c4896a8deefc74f518db5927d0e0e8d4a80953d774d0"},
- {file = "tomli-2.3.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:b74a0e59ec5d15127acdabd75ea17726ac4c5178ae51b85bfe39c4f8a278e879"},
- {file = "tomli-2.3.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:b5870b50c9db823c595983571d1296a6ff3e1b88f734a4c8f6fc6188397de005"},
- {file = "tomli-2.3.0-cp314-cp314-win32.whl", hash = "sha256:feb0dacc61170ed7ab602d3d972a58f14ee3ee60494292d384649a3dc38ef463"},
- {file = "tomli-2.3.0-cp314-cp314-win_amd64.whl", hash = "sha256:b273fcbd7fc64dc3600c098e39136522650c49bca95df2d11cf3b626422392c8"},
- {file = "tomli-2.3.0-cp314-cp314t-macosx_10_13_x86_64.whl", hash = "sha256:940d56ee0410fa17ee1f12b817b37a4d4e4dc4d27340863cc67236c74f582e77"},
- {file = "tomli-2.3.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:f85209946d1fe94416debbb88d00eb92ce9cd5266775424ff81bc959e001acaf"},
- {file = "tomli-2.3.0-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:a56212bdcce682e56b0aaf79e869ba5d15a6163f88d5451cbde388d48b13f530"},
- {file = "tomli-2.3.0-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:c5f3ffd1e098dfc032d4d3af5c0ac64f6d286d98bc148698356847b80fa4de1b"},
- {file = "tomli-2.3.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:5e01decd096b1530d97d5d85cb4dff4af2d8347bd35686654a004f8dea20fc67"},
- {file = "tomli-2.3.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:8a35dd0e643bb2610f156cca8db95d213a90015c11fee76c946aa62b7ae7e02f"},
- {file = "tomli-2.3.0-cp314-cp314t-win32.whl", hash = "sha256:a1f7f282fe248311650081faafa5f4732bdbfef5d45fe3f2e702fbc6f2d496e0"},
- {file = "tomli-2.3.0-cp314-cp314t-win_amd64.whl", hash = "sha256:70a251f8d4ba2d9ac2542eecf008b3c8a9fc5c3f9f02c56a9d7952612be2fdba"},
- {file = "tomli-2.3.0-py3-none-any.whl", hash = "sha256:e95b1af3c5b07d9e643909b5abbec77cd9f1217e6d0bca72b0234736b9fb1f1b"},
- {file = "tomli-2.3.0.tar.gz", hash = "sha256:64be704a875d2a59753d80ee8a533c3fe183e3f06807ff7dc2232938ccb01549"},
+ {file = "tomli-2.4.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:b5ef256a3fd497d4973c11bf142e9ed78b150d36f5773f1ca6088c230ffc5867"},
+ {file = "tomli-2.4.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:5572e41282d5268eb09a697c89a7bee84fae66511f87533a6f88bd2f7b652da9"},
+ {file = "tomli-2.4.0-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:551e321c6ba03b55676970b47cb1b73f14a0a4dce6a3e1a9458fd6d921d72e95"},
+ {file = "tomli-2.4.0-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:5e3f639a7a8f10069d0e15408c0b96a2a828cfdec6fca05296ebcdcc28ca7c76"},
+ {file = "tomli-2.4.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:1b168f2731796b045128c45982d3a4874057626da0e2ef1fdd722848b741361d"},
+ {file = "tomli-2.4.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:133e93646ec4300d651839d382d63edff11d8978be23da4cc106f5a18b7d0576"},
+ {file = "tomli-2.4.0-cp311-cp311-win32.whl", hash = "sha256:b6c78bdf37764092d369722d9946cb65b8767bfa4110f902a1b2542d8d173c8a"},
+ {file = "tomli-2.4.0-cp311-cp311-win_amd64.whl", hash = "sha256:d3d1654e11d724760cdb37a3d7691f0be9db5fbdaef59c9f532aabf87006dbaa"},
+ {file = "tomli-2.4.0-cp311-cp311-win_arm64.whl", hash = "sha256:cae9c19ed12d4e8f3ebf46d1a75090e4c0dc16271c5bce1c833ac168f08fb614"},
+ {file = "tomli-2.4.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:920b1de295e72887bafa3ad9f7a792f811847d57ea6b1215154030cf131f16b1"},
+ {file = "tomli-2.4.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:7d6d9a4aee98fac3eab4952ad1d73aee87359452d1c086b5ceb43ed02ddb16b8"},
+ {file = "tomli-2.4.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:36b9d05b51e65b254ea6c2585b59d2c4cb91c8a3d91d0ed0f17591a29aaea54a"},
+ {file = "tomli-2.4.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1c8a885b370751837c029ef9bc014f27d80840e48bac415f3412e6593bbc18c1"},
+ {file = "tomli-2.4.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:8768715ffc41f0008abe25d808c20c3d990f42b6e2e58305d5da280ae7d1fa3b"},
+ {file = "tomli-2.4.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:7b438885858efd5be02a9a133caf5812b8776ee0c969fea02c45e8e3f296ba51"},
+ {file = "tomli-2.4.0-cp312-cp312-win32.whl", hash = "sha256:0408e3de5ec77cc7f81960c362543cbbd91ef883e3138e81b729fc3eea5b9729"},
+ {file = "tomli-2.4.0-cp312-cp312-win_amd64.whl", hash = "sha256:685306e2cc7da35be4ee914fd34ab801a6acacb061b6a7abca922aaf9ad368da"},
+ {file = "tomli-2.4.0-cp312-cp312-win_arm64.whl", hash = "sha256:5aa48d7c2356055feef06a43611fc401a07337d5b006be13a30f6c58f869e3c3"},
+ {file = "tomli-2.4.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:84d081fbc252d1b6a982e1870660e7330fb8f90f676f6e78b052ad4e64714bf0"},
+ {file = "tomli-2.4.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:9a08144fa4cba33db5255f9b74f0b89888622109bd2776148f2597447f92a94e"},
+ {file = "tomli-2.4.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c73add4bb52a206fd0c0723432db123c0c75c280cbd67174dd9d2db228ebb1b4"},
+ {file = "tomli-2.4.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1fb2945cbe303b1419e2706e711b7113da57b7db31ee378d08712d678a34e51e"},
+ {file = "tomli-2.4.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:bbb1b10aa643d973366dc2cb1ad94f99c1726a02343d43cbc011edbfac579e7c"},
+ {file = "tomli-2.4.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:4cbcb367d44a1f0c2be408758b43e1ffb5308abe0ea222897d6bfc8e8281ef2f"},
+ {file = "tomli-2.4.0-cp313-cp313-win32.whl", hash = "sha256:7d49c66a7d5e56ac959cb6fc583aff0651094ec071ba9ad43df785abc2320d86"},
+ {file = "tomli-2.4.0-cp313-cp313-win_amd64.whl", hash = "sha256:3cf226acb51d8f1c394c1b310e0e0e61fecdd7adcb78d01e294ac297dd2e7f87"},
+ {file = "tomli-2.4.0-cp313-cp313-win_arm64.whl", hash = "sha256:d20b797a5c1ad80c516e41bc1fb0443ddb5006e9aaa7bda2d71978346aeb9132"},
+ {file = "tomli-2.4.0-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:26ab906a1eb794cd4e103691daa23d95c6919cc2fa9160000ac02370cc9dd3f6"},
+ {file = "tomli-2.4.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:20cedb4ee43278bc4f2fee6cb50daec836959aadaf948db5172e776dd3d993fc"},
+ {file = "tomli-2.4.0-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:39b0b5d1b6dd03684b3fb276407ebed7090bbec989fa55838c98560c01113b66"},
+ {file = "tomli-2.4.0-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:a26d7ff68dfdb9f87a016ecfd1e1c2bacbe3108f4e0f8bcd2228ef9a766c787d"},
+ {file = "tomli-2.4.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:20ffd184fb1df76a66e34bd1b36b4a4641bd2b82954befa32fe8163e79f1a702"},
+ {file = "tomli-2.4.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:75c2f8bbddf170e8effc98f5e9084a8751f8174ea6ccf4fca5398436e0320bc8"},
+ {file = "tomli-2.4.0-cp314-cp314-win32.whl", hash = "sha256:31d556d079d72db7c584c0627ff3a24c5d3fb4f730221d3444f3efb1b2514776"},
+ {file = "tomli-2.4.0-cp314-cp314-win_amd64.whl", hash = "sha256:43e685b9b2341681907759cf3a04e14d7104b3580f808cfde1dfdb60ada85475"},
+ {file = "tomli-2.4.0-cp314-cp314-win_arm64.whl", hash = "sha256:3d895d56bd3f82ddd6faaff993c275efc2ff38e52322ea264122d72729dca2b2"},
+ {file = "tomli-2.4.0-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:5b5807f3999fb66776dbce568cc9a828544244a8eb84b84b9bafc080c99597b9"},
+ {file = "tomli-2.4.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:c084ad935abe686bd9c898e62a02a19abfc9760b5a79bc29644463eaf2840cb0"},
+ {file = "tomli-2.4.0-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:0f2e3955efea4d1cfbcb87bc321e00dc08d2bcb737fd1d5e398af111d86db5df"},
+ {file = "tomli-2.4.0-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0e0fe8a0b8312acf3a88077a0802565cb09ee34107813bba1c7cd591fa6cfc8d"},
+ {file = "tomli-2.4.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:413540dce94673591859c4c6f794dfeaa845e98bf35d72ed59636f869ef9f86f"},
+ {file = "tomli-2.4.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:0dc56fef0e2c1c470aeac5b6ca8cc7b640bb93e92d9803ddaf9ea03e198f5b0b"},
+ {file = "tomli-2.4.0-cp314-cp314t-win32.whl", hash = "sha256:d878f2a6707cc9d53a1be1414bbb419e629c3d6e67f69230217bb663e76b5087"},
+ {file = "tomli-2.4.0-cp314-cp314t-win_amd64.whl", hash = "sha256:2add28aacc7425117ff6364fe9e06a183bb0251b03f986df0e78e974047571fd"},
+ {file = "tomli-2.4.0-cp314-cp314t-win_arm64.whl", hash = "sha256:2b1e3b80e1d5e52e40e9b924ec43d81570f0e7d09d11081b797bc4692765a3d4"},
+ {file = "tomli-2.4.0-py3-none-any.whl", hash = "sha256:1f776e7d669ebceb01dee46484485f43a4048746235e683bcdffacdf1fb4785a"},
+ {file = "tomli-2.4.0.tar.gz", hash = "sha256:aa89c3f6c277dd275d8e243ad24f3b5e701491a860d5121f2cdd399fbb31fc9c"},
]
[[package]]
diff --git a/pyproject.toml b/pyproject.toml
index 64fe2625..89b1f7b7 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,9 +1,10 @@
[project]
name = "squareup"
+dynamic = ["version"]
[tool.poetry]
name = "squareup"
-version = "43.2.1.20251016"
+version = "44.0.0.20260122"
description = ""
readme = "README.md"
authors = []
diff --git a/reference.md b/reference.md
index d42bf0f8..12a1b0c9 100644
--- a/reference.md
+++ b/reference.md
@@ -1,91 +1,6 @@
# Reference
-## Mobile
-client.mobile.authorization_code(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-__Note:__ This endpoint is used by the deprecated Reader SDK.
-Developers should update their integration to use the [Mobile Payments SDK](https://developer.squareup.com/docs/mobile-payments-sdk), which includes its own authorization methods.
-
-Generates code to authorize a mobile application to connect to a Square card reader.
-
-Authorization codes are one-time-use codes and expire 60 minutes after being issued.
-
-The `Authorization` header you provide to this endpoint must have the following format:
-
-```
-Authorization: Bearer ACCESS_TOKEN
-```
-
-Replace `ACCESS_TOKEN` with a
-[valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from square import Square
-
-client = Square(
- token="YOUR_TOKEN",
-)
-client.mobile.authorization_code(
- location_id="YOUR_LOCATION_ID",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**location_id:** `typing.Optional[str]` — The Square location ID that the authorization code should be tied to.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.o_auth.revoke_token(...)
+client.o_auth.revoke_token(...) -> AsyncHttpResponse[RevokeTokenResponse]
-
@@ -206,7 +121,7 @@ Default: `false`
client.o_auth.obtain_token(...)
+client.o_auth.obtain_token(...) -> AsyncHttpResponse[ObtainTokenResponse]
-
@@ -417,6 +332,18 @@ Required for the PKCE flow if `grant_type` is `authorization_code`.
-
+**use_jwt:** `typing.Optional[bool]`
+
+Indicates whether to use a JWT (JSON Web Token) as the OAuth access token.
+When set to `true`, the OAuth flow returns a JWT to your application, used in the
+same way as a regular token. The default value is `false`.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -429,7 +356,7 @@ Required for the PKCE flow if `grant_type` is `authorization_code`.
client.o_auth.retrieve_token_status()
+client.o_auth.retrieve_token_status() -> AsyncHttpResponse[RetrieveTokenStatusResponse]
-
@@ -502,7 +429,7 @@ client.o_auth.retrieve_token_status()
client.o_auth.authorize()
+client.o_auth.authorize() -> AsyncHttpResponse[None]
-
@@ -549,7 +476,7 @@ client.o_auth.authorize()
client.v1transactions.v1list_orders(...)
+client.v1transactions.v1list_orders(...) -> AsyncHttpResponse[typing.List[V1Order]]
-
@@ -649,7 +576,7 @@ original query to the endpoint.
client.v1transactions.v1retrieve_order(...)
+client.v1transactions.v1retrieve_order(...) -> AsyncHttpResponse[V1Order]
-
@@ -728,7 +655,7 @@ client.v1transactions.v1retrieve_order(
client.v1transactions.v1update_order(...)
+client.v1transactions.v1update_order(...) -> AsyncHttpResponse[V1Order]
-
@@ -852,7 +779,7 @@ See [V1UpdateOrderRequestAction](#type-v1updateorderrequestaction) for possible
client.apple_pay.register_domain(...)
+client.apple_pay.register_domain(...) -> AsyncHttpResponse[RegisterDomainResponse]
-
@@ -936,7 +863,7 @@ client.apple_pay.register_domain(
client.bank_accounts.list(...)
+client.bank_accounts.list(...) -> AsyncPager[BankAccount, ListBankAccountsResponse]
-
@@ -972,6 +899,7 @@ response = client.bank_accounts.list(
cursor="cursor",
limit=1,
location_id="location_id",
+ customer_id="customer_id",
)
for item in response:
yield item
@@ -996,7 +924,7 @@ for page in response.iter_pages():
**cursor:** `typing.Optional[str]`
The pagination cursor returned by a previous call to this endpoint.
-Use it in the next `ListBankAccounts` request to retrieve the next set
+Use it in the next `ListBankAccounts` request to retrieve the next set
of results.
See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.
@@ -1009,8 +937,8 @@ See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagin
**limit:** `typing.Optional[int]`
-Upper limit on the number of bank accounts to return in the response.
-Currently, 1000 is the largest supported limit. You can specify a limit
+Upper limit on the number of bank accounts to return in the response.
+Currently, 1000 is the largest supported limit. You can specify a limit
of up to 1000 bank accounts. This is also the default limit.
@@ -1021,7 +949,7 @@ of up to 1000 bank accounts. This is also the default limit.
**location_id:** `typing.Optional[str]`
-Location ID. You can specify this optional filter
+Location ID. You can specify this optional filter
to retrieve only the linked bank accounts belonging to a specific location.
@@ -1030,6 +958,111 @@ to retrieve only the linked bank accounts belonging to a specific location.
-
+**customer_id:** `typing.Optional[str]`
+
+Customer ID. You can specify this optional filter
+to retrieve only the linked bank accounts belonging to a specific customer.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.bank_accounts.create_bank_account(...) -> AsyncHttpResponse[CreateBankAccountResponse]
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Store a bank account on file for a square account
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from square import Square
+
+client = Square(
+ token="YOUR_TOKEN",
+)
+client.bank_accounts.create_bank_account(
+ idempotency_key="4e43559a-f0fd-47d3-9da2-7ea1f97d94be",
+ source_id="bnon:CA4SEHsQwr0rx6DbWLD5BQaqMnoYAQ",
+ customer_id="HM3B2D5JKGZ69359BTEHXM2V8M",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**idempotency_key:** `str`
+
+Unique ID. For more information, see the
+[Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
+
+
+
+
+
+-
+
+**source_id:** `str`
+
+The ID of the source that represents the bank account information to be stored. This field
+accepts the payment token created by WebSDK
+
+
+
+
+
+-
+
+**customer_id:** `typing.Optional[str]` — The ID of the customer associated with the bank account to be stored.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -1042,7 +1075,7 @@ to retrieve only the linked bank accounts belonging to a specific location.
client.bank_accounts.get_by_v1id(...)
+client.bank_accounts.get_by_v1id(...) -> AsyncHttpResponse[GetBankAccountByV1IdResponse]
-
@@ -1115,7 +1148,7 @@ Connect V1 ID of the desired `BankAccount`. For more information, see
client.bank_accounts.get(...)
+client.bank_accounts.get(...) -> AsyncHttpResponse[GetBankAccountResponse]
-
@@ -1127,8 +1160,7 @@ Connect V1 ID of the desired `BankAccount`. For more information, see
-
-Returns details of a [BankAccount](entity:BankAccount)
-linked to a Square account.
+Retrieve details of a [BankAccount](entity:BankAccount) bank account linked to a Square account.
@@ -1182,12 +1214,82 @@ client.bank_accounts.get(
+
+
+client.bank_accounts.disable_bank_account(...) -> AsyncHttpResponse[DisableBankAccountResponse]
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Disable a bank account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from square import Square
+
+client = Square(
+ token="YOUR_TOKEN",
+)
+client.bank_accounts.disable_bank_account(
+ bank_account_id="bank_account_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**bank_account_id:** `str` — The ID of the bank account to disable.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
client.bookings.list(...)
+client.bookings.list(...) -> AsyncPager[Booking, ListBookingsResponse]
-
@@ -1319,7 +1421,7 @@ for page in response.iter_pages():
client.bookings.create(...)
+client.bookings.create(...) -> AsyncHttpResponse[CreateBookingResponse]
-
@@ -1410,7 +1512,7 @@ client.bookings.create(
client.bookings.search_availability(...)
+client.bookings.search_availability(...) -> AsyncHttpResponse[SearchAvailabilityResponse]
-
@@ -1483,7 +1585,7 @@ client.bookings.search_availability(
client.bookings.bulk_retrieve_bookings(...)
+client.bookings.bulk_retrieve_bookings(...) -> AsyncHttpResponse[BulkRetrieveBookingsResponse]
-
@@ -1556,7 +1658,7 @@ client.bookings.bulk_retrieve_bookings(
client.bookings.get_business_profile()
+client.bookings.get_business_profile() -> AsyncHttpResponse[GetBusinessBookingProfileResponse]
-
@@ -1616,7 +1718,7 @@ client.bookings.get_business_profile()
client.bookings.retrieve_location_booking_profile(...)
+client.bookings.retrieve_location_booking_profile(...) -> AsyncHttpResponse[RetrieveLocationBookingProfileResponse]
-
@@ -1686,7 +1788,7 @@ client.bookings.retrieve_location_booking_profile(
client.bookings.bulk_retrieve_team_member_booking_profiles(...)
+client.bookings.bulk_retrieve_team_member_booking_profiles(...) -> AsyncHttpResponse[BulkRetrieveTeamMemberBookingProfilesResponse]
-
@@ -1756,7 +1858,7 @@ client.bookings.bulk_retrieve_team_member_booking_profiles(
client.bookings.get(...)
+client.bookings.get(...) -> AsyncHttpResponse[GetBookingResponse]
-
@@ -1829,7 +1931,7 @@ client.bookings.get(
client.bookings.update(...)
+client.bookings.update(...) -> AsyncHttpResponse[UpdateBookingResponse]
-
@@ -1922,7 +2024,7 @@ client.bookings.update(
client.bookings.cancel(...)
+client.bookings.cancel(...) -> AsyncHttpResponse[CancelBookingResponse]
-
@@ -2015,7 +2117,7 @@ client.bookings.cancel(
client.cards.list(...)
+client.cards.list(...) -> AsyncPager[Card, ListCardsResponse]
-
@@ -2141,7 +2243,7 @@ This field defaults to ASC.
client.cards.create(...)
+client.cards.create(...) -> AsyncHttpResponse[CreateCardResponse]
-
@@ -2262,7 +2364,7 @@ See the [SCA Overview](https://developer.squareup.com/docs/sca-overview).
client.cards.get(...)
+client.cards.get(...) -> AsyncHttpResponse[GetCardResponse]
-
@@ -2332,7 +2434,7 @@ client.cards.get(
client.cards.disable(...)
+client.cards.disable(...) -> AsyncHttpResponse[DisableCardResponse]
-
@@ -2404,7 +2506,7 @@ client.cards.disable(
client.catalog.batch_delete(...)
+client.catalog.batch_delete(...) -> AsyncHttpResponse[BatchDeleteCatalogObjectsResponse]
-
@@ -2491,7 +2593,7 @@ CatalogItem will delete its CatalogItemVariation.
client.catalog.batch_get(...)
+client.catalog.batch_get(...) -> AsyncHttpResponse[BatchGetCatalogObjectsResponse]
-
@@ -2624,7 +2726,7 @@ in the response payload.
client.catalog.batch_upsert(...)
+client.catalog.batch_upsert(...) -> AsyncHttpResponse[BatchUpsertCatalogObjectsResponse]
-
@@ -2673,34 +2775,10 @@ client.catalog.batch_upsert(
batches=[
{
"objects": [
- {
- "type": "IMAGE",
- "id": "#Tea",
- "present_at_all_locations": True,
- },
- {
- "type": "IMAGE",
- "id": "#Coffee",
- "present_at_all_locations": True,
- },
- {
- "type": "ITEM",
- "id": "#Beverages",
- "present_at_all_locations": True,
- },
- {
- "type": "TAX",
- "id": "#SalesTax",
- "present_at_all_locations": True,
- "tax_data": {
- "name": "Sales Tax",
- "calculation_phase": "TAX_SUBTOTAL_PHASE",
- "inclusion_type": "ADDITIVE",
- "percentage": "5.0",
- "applies_to_custom_amounts": True,
- "enabled": True,
- },
- },
+ {"id": "id", "type": "ITEM"},
+ {"id": "id", "type": "ITEM"},
+ {"id": "id", "type": "ITEM"},
+ {"id": "id", "type": "TAX"},
]
}
],
@@ -2780,7 +2858,7 @@ be inserted or updated.
client.catalog.info()
+client.catalog.info() -> AsyncHttpResponse[CatalogInfoResponse]
-
@@ -2841,7 +2919,7 @@ client.catalog.info()
client.catalog.list(...)
+client.catalog.list(...) -> AsyncPager[CatalogObject, ListCatalogResponse]
-
@@ -2965,7 +3043,7 @@ current version of the catalog.
client.catalog.search(...)
+client.catalog.search(...) -> AsyncHttpResponse[SearchCatalogObjectsResponse]
-
@@ -3145,7 +3223,7 @@ is higher than the maximum limit of 1,000, it will be ignored.
client.catalog.search_items(...)
+client.catalog.search_items(...) -> AsyncHttpResponse[SearchCatalogItemsResponse]
-
@@ -3328,7 +3406,7 @@ a single call to the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItem
client.catalog.update_item_modifier_lists(...)
+client.catalog.update_item_modifier_lists(...) -> AsyncHttpResponse[UpdateItemModifierListsResponse]
-
@@ -3427,7 +3505,7 @@ At least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must b
client.catalog.update_item_taxes(...)
+client.catalog.update_item_taxes(...) -> AsyncHttpResponse[UpdateItemTaxesResponse]
-
@@ -3527,7 +3605,7 @@ At least one of `taxes_to_enable` or `taxes_to_disable` must be specified.
client.channels.list(...)
+client.channels.list(...) -> AsyncPager[Channel, ListChannelsResponse]
-
@@ -3641,7 +3719,7 @@ When not provided the returned results will be cap at 100 channels.
client.channels.bulk_retrieve(...)
+client.channels.bulk_retrieve(...) -> AsyncHttpResponse[BulkRetrieveChannelsResponse]
-
@@ -3711,7 +3789,7 @@ client.channels.bulk_retrieve(
client.channels.get(...)
+client.channels.get(...) -> AsyncHttpResponse[RetrieveChannelResponse]
-
@@ -3782,7 +3860,7 @@ client.channels.get(
client.customers.list(...)
+client.customers.list(...) -> AsyncPager[Customer, ListCustomersResponse]
-
@@ -3920,7 +3998,7 @@ The default value is `false`.
client.customers.create(...)
+client.customers.create(...) -> AsyncHttpResponse[CreateCustomerResponse]
-
@@ -4144,7 +4222,7 @@ see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it
client.customers.batch_create(...)
+client.customers.batch_create(...) -> AsyncHttpResponse[BulkCreateCustomersResponse]
-
@@ -4264,7 +4342,7 @@ customer profile.
client.customers.bulk_delete_customers(...)
+client.customers.bulk_delete_customers(...) -> AsyncHttpResponse[BulkDeleteCustomersResponse]
-
@@ -4340,7 +4418,7 @@ client.customers.bulk_delete_customers(
client.customers.bulk_retrieve_customers(...)
+client.customers.bulk_retrieve_customers(...) -> AsyncHttpResponse[BulkRetrieveCustomersResponse]
-
@@ -4416,7 +4494,7 @@ client.customers.bulk_retrieve_customers(
client.customers.bulk_update_customers(...)
+client.customers.bulk_update_customers(...) -> AsyncHttpResponse[BulkUpdateCustomersResponse]
-
@@ -4508,7 +4586,7 @@ update a field, specify the new value. To remove a field, specify `null`.
client.customers.search(...)
+client.customers.search(...) -> AsyncHttpResponse[SearchCustomersResponse]
-
@@ -4639,7 +4717,7 @@ The default value is `false`.
client.customers.get(...)
+client.customers.get(...) -> AsyncHttpResponse[GetCustomerResponse]
-
@@ -4709,7 +4787,7 @@ client.customers.get(
client.customers.update(...)
+client.customers.update(...) -> AsyncHttpResponse[UpdateCustomerResponse]
-
@@ -4927,7 +5005,7 @@ see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it
client.customers.delete(...)
+client.customers.delete(...) -> AsyncHttpResponse[DeleteCustomerResponse]
-
@@ -5013,7 +5091,7 @@ As a best practice, you should include this parameter to enable [optimistic conc
client.devices.list(...)
+client.devices.list(...) -> AsyncPager[Device, ListDevicesResponse]
-
@@ -5124,7 +5202,7 @@ The order in which results are listed.
client.devices.get(...)
+client.devices.get(...) -> AsyncHttpResponse[GetDeviceResponse]
-
@@ -5195,7 +5273,7 @@ client.devices.get(
client.disputes.list(...)
+client.disputes.list(...) -> AsyncPager[Dispute, ListDisputesResponse]
-
@@ -5295,7 +5373,7 @@ If not specified, the endpoint returns disputes associated with all locations.
client.disputes.get(...)
+client.disputes.get(...) -> AsyncHttpResponse[GetDisputeResponse]
-
@@ -5365,7 +5443,7 @@ client.disputes.get(
client.disputes.accept(...)
+client.disputes.accept(...) -> AsyncHttpResponse[AcceptDisputeResponse]
-
@@ -5439,7 +5517,7 @@ client.disputes.accept(
client.disputes.create_evidence_file(...)
+client.disputes.create_evidence_file(...) -> AsyncHttpResponse[CreateDisputeEvidenceFileResponse]
-
@@ -5528,7 +5606,7 @@ typing.Optional[core.File]` — See core.File for more documentation
client.disputes.create_evidence_text(...)
+client.disputes.create_evidence_text(...) -> AsyncHttpResponse[CreateDisputeEvidenceTextResponse]
-
@@ -5628,7 +5706,7 @@ See [DisputeEvidenceType](#type-disputeevidencetype) for possible values
client.disputes.submit_evidence(...)
+client.disputes.submit_evidence(...) -> AsyncHttpResponse[SubmitEvidenceResponse]
-
@@ -5705,7 +5783,7 @@ client.disputes.submit_evidence(
client.employees.list(...)
+client.employees.list(...) -> AsyncPager[Employee, ListEmployeesResponse]
-
@@ -5807,7 +5885,7 @@ for page in response.iter_pages():
client.employees.get(...)
+client.employees.get(...) -> AsyncHttpResponse[GetEmployeeResponse]
-
@@ -5878,7 +5956,7 @@ client.employees.get(
client.events.search_events(...)
+client.events.search_events(...) -> AsyncHttpResponse[SearchEventsResponse]
-
@@ -5972,7 +6050,7 @@ Default: 100
client.events.disable_events()
+client.events.disable_events() -> AsyncHttpResponse[DisableEventsResponse]
-
@@ -6034,7 +6112,7 @@ client.events.disable_events()
client.events.enable_events()
+client.events.enable_events() -> AsyncHttpResponse[EnableEventsResponse]
-
@@ -6094,7 +6172,7 @@ client.events.enable_events()
client.events.list_event_types(...)
+client.events.list_event_types(...) -> AsyncHttpResponse[ListEventTypesResponse]
-
@@ -6165,7 +6243,7 @@ client.events.list_event_types(
client.gift_cards.list(...)
+client.gift_cards.list(...) -> AsyncPager[GiftCard, ListGiftCardsResponse]
-
@@ -6292,7 +6370,7 @@ For more information, see [Pagination](https://developer.squareup.com/docs/worki
client.gift_cards.create(...)
+client.gift_cards.create(...) -> AsyncHttpResponse[CreateGiftCardResponse]
-
@@ -6407,7 +6485,7 @@ include `gan` and provide the GAN that is printed on the gift card.
client.gift_cards.get_from_gan(...)
+client.gift_cards.get_from_gan(...) -> AsyncHttpResponse[GetGiftCardFromGanResponse]
-
@@ -6481,7 +6559,7 @@ Square-issued gift cards have 16-digit GANs.
client.gift_cards.get_from_nonce(...)
+client.gift_cards.get_from_nonce(...) -> AsyncHttpResponse[GetGiftCardFromNonceResponse]
-
@@ -6554,7 +6632,7 @@ Web Payments SDK or In-App Payments SDK.
client.gift_cards.link_customer(...)
+client.gift_cards.link_customer(...) -> AsyncHttpResponse[LinkCustomerToGiftCardResponse]
-
@@ -6633,7 +6711,7 @@ client.gift_cards.link_customer(
client.gift_cards.unlink_customer(...)
+client.gift_cards.unlink_customer(...) -> AsyncHttpResponse[UnlinkCustomerFromGiftCardResponse]
-
@@ -6712,7 +6790,7 @@ client.gift_cards.unlink_customer(
client.gift_cards.get(...)
+client.gift_cards.get(...) -> AsyncHttpResponse[GetGiftCardResponse]
-
@@ -6783,7 +6861,7 @@ client.gift_cards.get(
client.inventory.deprecated_get_adjustment(...)
+client.inventory.deprecated_get_adjustment(...) -> AsyncHttpResponse[GetInventoryAdjustmentResponse]
-
@@ -6854,7 +6932,7 @@ client.inventory.deprecated_get_adjustment(
client.inventory.get_adjustment(...)
+client.inventory.get_adjustment(...) -> AsyncHttpResponse[GetInventoryAdjustmentResponse]
-
@@ -6925,7 +7003,7 @@ client.inventory.get_adjustment(
client.inventory.deprecated_batch_change(...)
+client.inventory.deprecated_batch_change(...) -> AsyncHttpResponse[BatchChangeInventoryResponse]
-
@@ -7041,7 +7119,7 @@ the quantity is unchanged since the last physical count. Default: `true`.
client.inventory.deprecated_batch_get_changes(...)
+client.inventory.deprecated_batch_get_changes(...) -> AsyncHttpResponse[BatchGetInventoryChangesResponse]
-
@@ -7199,7 +7277,7 @@ See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagin
client.inventory.deprecated_batch_get_counts(...)
+client.inventory.deprecated_batch_get_counts(...) -> AsyncHttpResponse[BatchGetInventoryCountsResponse]
-
@@ -7331,7 +7409,7 @@ The default is null.
client.inventory.batch_create_changes(...)
+client.inventory.batch_create_changes(...) -> AsyncHttpResponse[BatchChangeInventoryResponse]
-
@@ -7450,7 +7528,7 @@ the quantity is unchanged since the last physical count. Default: `true`.
client.inventory.batch_get_changes(...)
+client.inventory.batch_get_changes(...) -> AsyncPager[InventoryChange, BatchGetInventoryChangesResponse]
-
@@ -7619,7 +7697,7 @@ See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagin
client.inventory.batch_get_counts(...)
+client.inventory.batch_get_counts(...) -> AsyncPager[InventoryCount, BatchGetInventoryCountsResponse]
-
@@ -7765,7 +7843,7 @@ The default is null.
client.inventory.deprecated_get_physical_count(...)
+client.inventory.deprecated_get_physical_count(...) -> AsyncHttpResponse[GetInventoryPhysicalCountResponse]
-
@@ -7839,7 +7917,7 @@ ID of the
client.inventory.get_physical_count(...)
+client.inventory.get_physical_count(...) -> AsyncHttpResponse[GetInventoryPhysicalCountResponse]
-
@@ -7913,7 +7991,7 @@ ID of the
client.inventory.get_transfer(...)
+client.inventory.get_transfer(...) -> AsyncHttpResponse[GetInventoryTransferResponse]
-
@@ -7984,7 +8062,7 @@ client.inventory.get_transfer(
client.inventory.get(...)
+client.inventory.get(...) -> AsyncPager[InventoryCount, GetInventoryCountResponse]
-
@@ -8088,7 +8166,7 @@ See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagin
client.inventory.changes(...)
+client.inventory.changes(...) -> AsyncPager[InventoryChange, GetInventoryChangesResponse]
-
@@ -8202,7 +8280,7 @@ See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagin
client.invoices.list(...)
+client.invoices.list(...) -> AsyncPager[Invoice, ListInvoicesResponse]
-
@@ -8305,7 +8383,7 @@ If not provided, the server uses a default limit of 100 invoices.
client.invoices.create(...)
+client.invoices.create(...) -> AsyncHttpResponse[CreateInvoiceResponse]
-
@@ -8438,7 +8516,7 @@ For more information, see [Idempotency](https://developer.squareup.com/docs/buil
client.invoices.search(...)
+client.invoices.search(...) -> AsyncHttpResponse[SearchInvoicesResponse]
-
@@ -8545,7 +8623,7 @@ For more information, see [Pagination](https://developer.squareup.com/docs/build
client.invoices.get(...)
+client.invoices.get(...) -> AsyncHttpResponse[GetInvoiceResponse]
-
@@ -8615,7 +8693,7 @@ client.invoices.get(
client.invoices.update(...)
+client.invoices.update(...) -> AsyncHttpResponse[UpdateInvoiceResponse]
-
@@ -8737,7 +8815,7 @@ recommend using null values or the `remove` field when possible. For examples, s
client.invoices.delete(...)
+client.invoices.delete(...) -> AsyncHttpResponse[DeleteInvoiceResponse]
-
@@ -8822,7 +8900,7 @@ If you do not know the version, you can call [GetInvoice](api-endpoint:Invoices-
client.invoices.create_invoice_attachment(...)
+client.invoices.create_invoice_attachment(...) -> AsyncHttpResponse[CreateInvoiceAttachmentResponse]
-
@@ -8917,7 +8995,7 @@ typing.Optional[core.File]` — See core.File for more documentation
client.invoices.delete_invoice_attachment(...)
+client.invoices.delete_invoice_attachment(...) -> AsyncHttpResponse[DeleteInvoiceAttachmentResponse]
-
@@ -8997,7 +9075,7 @@ client.invoices.delete_invoice_attachment(
client.invoices.cancel(...)
+client.invoices.cancel(...) -> AsyncHttpResponse[CancelInvoiceResponse]
-
@@ -9083,7 +9161,7 @@ If you do not know the version, you can call
client.invoices.publish(...)
+client.invoices.publish(...) -> AsyncHttpResponse[PublishInvoiceResponse]
-
@@ -9194,7 +9272,7 @@ For more information, see [Idempotency](https://developer.squareup.com/docs/buil
client.labor.create_scheduled_shift(...)
+client.labor.create_scheduled_shift(...) -> AsyncHttpResponse[CreateScheduledShiftResponse]
-
@@ -9302,7 +9380,7 @@ of the operation.
client.labor.bulk_publish_scheduled_shifts(...)
+client.labor.bulk_publish_scheduled_shifts(...) -> AsyncHttpResponse[BulkPublishScheduledShiftsResponse]
-
@@ -9397,7 +9475,7 @@ See [ScheduledShiftNotificationAudience](#type-scheduledshiftnotificationaudienc
client.labor.search_scheduled_shifts(...)
+client.labor.search_scheduled_shifts(...) -> AsyncHttpResponse[SearchScheduledShiftsResponse]
-
@@ -9493,7 +9571,7 @@ information, see [Pagination](https://developer.squareup.com/docs/build-basics/c
client.labor.retrieve_scheduled_shift(...)
+client.labor.retrieve_scheduled_shift(...) -> AsyncHttpResponse[RetrieveScheduledShiftResponse]
-
@@ -9563,7 +9641,7 @@ client.labor.retrieve_scheduled_shift(
client.labor.update_scheduled_shift(...)
+client.labor.update_scheduled_shift(...) -> AsyncHttpResponse[UpdateScheduledShiftResponse]
-
@@ -9676,7 +9754,7 @@ omitted, Square executes a blind write, potentially overwriting data from anothe
client.labor.publish_scheduled_shift(...)
+client.labor.publish_scheduled_shift(...) -> AsyncHttpResponse[PublishScheduledShiftResponse]
-
@@ -9786,7 +9864,7 @@ See [ScheduledShiftNotificationAudience](#type-scheduledshiftnotificationaudienc
client.labor.create_timecard(...)
+client.labor.create_timecard(...) -> AsyncHttpResponse[CreateTimecardResponse]
-
@@ -9903,7 +9981,7 @@ client.labor.create_timecard(
client.labor.search_timecards(...)
+client.labor.search_timecards(...) -> AsyncHttpResponse[SearchTimecardsResponse]
-
@@ -10014,7 +10092,7 @@ client.labor.search_timecards(
client.labor.retrieve_timecard(...)
+client.labor.retrieve_timecard(...) -> AsyncHttpResponse[RetrieveTimecardResponse]
-
@@ -10084,7 +10162,7 @@ client.labor.retrieve_timecard(
client.labor.update_timecard(...)
+client.labor.update_timecard(...) -> AsyncHttpResponse[UpdateTimecardResponse]
-
@@ -10193,7 +10271,7 @@ client.labor.update_timecard(
client.labor.delete_timecard(...)
+client.labor.delete_timecard(...) -> AsyncHttpResponse[DeleteTimecardResponse]
-
@@ -10264,7 +10342,7 @@ client.labor.delete_timecard(
client.locations.list()
+client.locations.list() -> AsyncHttpResponse[ListLocationsResponse]
-
@@ -10325,7 +10403,7 @@ client.locations.list()
client.locations.create(...)
+client.locations.create(...) -> AsyncHttpResponse[CreateLocationResponse]
-
@@ -10414,7 +10492,7 @@ The remaining fields are automatically added based on the data from the [main lo
client.locations.get(...)
+client.locations.get(...) -> AsyncHttpResponse[GetLocationResponse]
-
@@ -10488,7 +10566,7 @@ The ID of the location to retrieve. Specify the string
client.locations.update(...)
+client.locations.update(...) -> AsyncHttpResponse[UpdateLocationResponse]
-
@@ -10588,7 +10666,7 @@ client.locations.update(
client.locations.checkouts(...)
+client.locations.checkouts(...) -> AsyncHttpResponse[CreateCheckoutResponse]
-
@@ -10870,7 +10948,7 @@ This value cannot exceed 60 characters.
client.loyalty.search_events(...)
+client.loyalty.search_events(...) -> AsyncHttpResponse[SearchLoyaltyEventsResponse]
-
@@ -10982,7 +11060,7 @@ For more information, see [Pagination](https://developer.squareup.com/docs/build
client.merchants.list(...)
+client.merchants.list(...) -> AsyncPager[Merchant, ListMerchantsResponse]
-
@@ -11066,7 +11144,7 @@ for page in response.iter_pages():
client.merchants.get(...)
+client.merchants.get(...) -> AsyncHttpResponse[GetMerchantResponse]
-
@@ -11140,7 +11218,7 @@ then retrieve the merchant that is currently accessible to this call.
client.checkout.retrieve_location_settings(...)
+client.checkout.retrieve_location_settings(...) -> AsyncHttpResponse[RetrieveLocationSettingsResponse]
-
@@ -11210,7 +11288,7 @@ client.checkout.retrieve_location_settings(
client.checkout.update_location_settings(...)
+client.checkout.update_location_settings(...) -> AsyncHttpResponse[UpdateLocationSettingsResponse]
-
@@ -11289,7 +11367,7 @@ client.checkout.update_location_settings(
client.checkout.retrieve_merchant_settings()
+client.checkout.retrieve_merchant_settings() -> AsyncHttpResponse[RetrieveMerchantSettingsResponse]
-
@@ -11349,7 +11427,7 @@ client.checkout.retrieve_merchant_settings()
client.checkout.update_merchant_settings(...)
+client.checkout.update_merchant_settings(...) -> AsyncHttpResponse[UpdateMerchantSettingsResponse]
-
@@ -11420,7 +11498,7 @@ client.checkout.update_merchant_settings(
client.orders.create(...)
+client.orders.create(...) -> AsyncHttpResponse[CreateOrderResponse]
-
@@ -11562,7 +11640,7 @@ For more information, see [Idempotency](https://developer.squareup.com/docs/buil
client.orders.batch_get(...)
+client.orders.batch_get(...) -> AsyncHttpResponse[BatchGetOrdersResponse]
-
@@ -11646,7 +11724,7 @@ orders within the scope of the current authorization's merchant ID.
client.orders.calculate(...)
+client.orders.calculate(...) -> AsyncHttpResponse[CalculateOrderResponse]
-
@@ -11747,7 +11825,7 @@ random strings used only to reference the reward tier.
client.orders.clone(...)
+client.orders.clone(...) -> AsyncHttpResponse[CloneOrderResponse]
-
@@ -11850,7 +11928,7 @@ For more information, see [Idempotency](https://developer.squareup.com/docs/buil
client.orders.search(...)
+client.orders.search(...) -> AsyncHttpResponse[SearchOrdersResponse]
-
@@ -12005,7 +12083,7 @@ Default: `false`.
client.orders.get(...)
+client.orders.get(...) -> AsyncHttpResponse[GetOrderResponse]
-
@@ -12075,7 +12153,7 @@ client.orders.get(
client.orders.update(...)
+client.orders.update(...) -> AsyncHttpResponse[UpdateOrderResponse]
-
@@ -12214,7 +12292,7 @@ For more information, see [Idempotency](https://developer.squareup.com/docs/buil
client.orders.pay(...)
+client.orders.pay(...) -> AsyncHttpResponse[PayOrderResponse]
-
@@ -12333,7 +12411,7 @@ The payment total must match the order total.
client.payments.list(...)
+client.payments.list(...) -> AsyncPager[Payment, ListPaymentsResponse]
-
@@ -12588,7 +12666,7 @@ range is determined using the `updated_at` field for each Payment.
client.payments.create(...)
+client.payments.create(...) -> AsyncHttpResponse[CreatePaymentResponse]
-
@@ -12710,6 +12788,8 @@ The amount must be specified in the smallest denomination of the applicable curr
(for example, US dollar amounts are specified in cents). For more information, see
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts).
+Tips for external vendors such as a 3rd party delivery courier must be recorded using Order.service_charges.
+
The currency code must match the currency associated with the business
that is accepting the payment.
@@ -12996,7 +13076,7 @@ internal 1st-party callers only.
client.payments.cancel_by_idempotency_key(...)
+client.payments.cancel_by_idempotency_key(...) -> AsyncHttpResponse[CancelPaymentByIdempotencyKeyResponse]
-
@@ -13076,7 +13156,7 @@ client.payments.cancel_by_idempotency_key(
client.payments.get(...)
+client.payments.get(...) -> AsyncHttpResponse[GetPaymentResponse]
-
@@ -13146,7 +13226,7 @@ client.payments.get(
client.payments.update(...)
+client.payments.update(...) -> AsyncHttpResponse[UpdatePaymentResponse]
-
@@ -13244,7 +13324,7 @@ For more information, see [Idempotency](https://developer.squareup.com/docs/buil
client.payments.cancel(...)
+client.payments.cancel(...) -> AsyncHttpResponse[CancelPaymentResponse]
-
@@ -13315,7 +13395,7 @@ client.payments.cancel(
client.payments.complete(...)
+client.payments.complete(...) -> AsyncHttpResponse[CompletePaymentResponse]
-
@@ -13401,7 +13481,7 @@ the update fails and a response with a VERSION_MISMATCH error is returned.
client.payouts.list(...)
+client.payouts.list(...) -> AsyncPager[Payout, ListPayoutsResponse]
-
@@ -13552,7 +13632,7 @@ Default: `100`
client.payouts.get(...)
+client.payouts.get(...) -> AsyncHttpResponse[GetPayoutResponse]
-
@@ -13623,7 +13703,7 @@ client.payouts.get(
client.payouts.list_entries(...)
+client.payouts.list_entries(...) -> AsyncPager[PayoutEntry, ListPayoutEntriesResponse]
-
@@ -13738,7 +13818,7 @@ Default: `100`
client.refunds.list(...)
+client.refunds.list(...) -> AsyncPager[PaymentRefund, ListPaymentRefundsResponse]
-
@@ -13960,7 +14040,7 @@ Default: The current time.
client.refunds.refund_payment(...)
+client.refunds.refund_payment(...) -> AsyncHttpResponse[RefundPaymentResponse]
-
@@ -14197,7 +14277,7 @@ Additional details required when recording an unlinked external refund
client.refunds.get(...)
+client.refunds.get(...) -> AsyncHttpResponse[GetPaymentRefundResponse]
-
@@ -14268,7 +14348,7 @@ client.refunds.get(
client.sites.list()
+client.sites.list() -> AsyncHttpResponse[ListSitesResponse]
-
@@ -14332,7 +14412,7 @@ client.sites.list()
client.snippets.get(...)
+client.snippets.get(...) -> AsyncHttpResponse[GetSnippetResponse]
-
@@ -14407,7 +14487,7 @@ client.snippets.get(
client.snippets.upsert(...)
+client.snippets.upsert(...) -> AsyncHttpResponse[UpsertSnippetResponse]
-
@@ -14492,7 +14572,7 @@ client.snippets.upsert(
client.snippets.delete(...)
+client.snippets.delete(...) -> AsyncHttpResponse[DeleteSnippetResponse]
-
@@ -14568,7 +14648,7 @@ client.snippets.delete(
client.subscriptions.create(...)
+client.subscriptions.create(...) -> AsyncHttpResponse[CreateSubscriptionResponse]
-
@@ -14787,7 +14867,7 @@ a list of time zones, see [List of tz database time zones](https://en.wikipedia.
client.subscriptions.bulk_swap_plan(...)
+client.subscriptions.bulk_swap_plan(...) -> AsyncHttpResponse[BulkSwapPlanResponse]
-
@@ -14884,7 +14964,7 @@ day.
client.subscriptions.search(...)
+client.subscriptions.search(...) -> AsyncHttpResponse[SearchSubscriptionsResponse]
-
@@ -15016,7 +15096,7 @@ The supported values are:
client.subscriptions.get(...)
+client.subscriptions.get(...) -> AsyncHttpResponse[GetSubscriptionResponse]
-
@@ -15101,7 +15181,7 @@ The supported query parameter values are:
client.subscriptions.update(...)
+client.subscriptions.update(...) -> AsyncHttpResponse[UpdateSubscriptionResponse]
-
@@ -15185,7 +15265,7 @@ be treated as a request to clear the relevant data.
client.subscriptions.delete_action(...)
+client.subscriptions.delete_action(...) -> AsyncHttpResponse[DeleteSubscriptionActionResponse]
-
@@ -15264,7 +15344,7 @@ client.subscriptions.delete_action(
client.subscriptions.change_billing_anchor_date(...)
+client.subscriptions.change_billing_anchor_date(...) -> AsyncHttpResponse[ChangeBillingAnchorDateResponse]
-
@@ -15358,7 +15438,7 @@ is changed immediately.
client.subscriptions.cancel(...)
+client.subscriptions.cancel(...) -> AsyncHttpResponse[CancelSubscriptionResponse]
-
@@ -15430,7 +15510,7 @@ client.subscriptions.cancel(
client.subscriptions.list_events(...)
+client.subscriptions.list_events(...) -> AsyncPager[SubscriptionEvent, ListSubscriptionEventsResponse]
-
@@ -15532,7 +15612,7 @@ in a paged response.
client.subscriptions.pause(...)
+client.subscriptions.pause(...) -> AsyncHttpResponse[PauseSubscriptionResponse]
-
@@ -15660,7 +15740,7 @@ See [ChangeTiming](#type-changetiming) for possible values
client.subscriptions.resume(...)
+client.subscriptions.resume(...) -> AsyncHttpResponse[ResumeSubscriptionResponse]
-
@@ -15750,7 +15830,7 @@ See [ChangeTiming](#type-changetiming) for possible values
client.subscriptions.swap_plan(...)
+client.subscriptions.swap_plan(...) -> AsyncHttpResponse[SwapPlanResponse]
-
@@ -15846,7 +15926,7 @@ This field is required.
client.team_members.create(...)
+client.team_members.create(...) -> AsyncHttpResponse[CreateTeamMemberResponse]
-
@@ -15966,7 +16046,7 @@ The minimum length is 1 and the maximum length is 45.
client.team_members.batch_create(...)
+client.team_members.batch_create(...) -> AsyncHttpResponse[BatchCreateTeamMembersResponse]
-
@@ -16073,7 +16153,7 @@ call [ListJobs](api-endpoint:Team-ListJobs).
client.team_members.batch_update(...)
+client.team_members.batch_update(...) -> AsyncHttpResponse[BatchUpdateTeamMembersResponse]
-
@@ -16184,7 +16264,7 @@ call [ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values.
client.team_members.search(...)
+client.team_members.search(...) -> AsyncHttpResponse[SearchTeamMembersResponse]
-
@@ -16276,7 +16356,7 @@ The opaque cursor for fetching the next page. For more information, see
client.team_members.get(...)
+client.team_members.get(...) -> AsyncHttpResponse[GetTeamMemberResponse]
-
@@ -16347,7 +16427,7 @@ client.team_members.get(
client.team_members.update(...)
+client.team_members.update(...) -> AsyncHttpResponse[UpdateTeamMemberResponse]
-
@@ -16459,7 +16539,7 @@ The team member fields to add, change, or clear. Fields can be cleared using a n
client.team.list_jobs(...)
+client.team.list_jobs(...) -> AsyncHttpResponse[ListJobsResponse]
-
@@ -16533,7 +16613,7 @@ see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-pat
client.team.create_job(...)
+client.team.create_job(...) -> AsyncHttpResponse[CreateJobResponse]
-
@@ -16617,7 +16697,7 @@ but must be unique for each request. For more information, see
client.team.retrieve_job(...)
+client.team.retrieve_job(...) -> AsyncHttpResponse[RetrieveJobResponse]
-
@@ -16687,7 +16767,7 @@ client.team.retrieve_job(
client.team.update_job(...)
+client.team.update_job(...) -> AsyncHttpResponse[UpdateJobResponse]
-
@@ -16772,7 +16852,7 @@ to be included in the request. Optionally include `version` to enable optimistic
client.terminal.dismiss_terminal_action(...)
+client.terminal.dismiss_terminal_action(...) -> AsyncHttpResponse[DismissTerminalActionResponse]
-
@@ -16844,7 +16924,7 @@ client.terminal.dismiss_terminal_action(
client.terminal.dismiss_terminal_checkout(...)
+client.terminal.dismiss_terminal_checkout(...) -> AsyncHttpResponse[DismissTerminalCheckoutResponse]
-
@@ -16914,7 +16994,7 @@ client.terminal.dismiss_terminal_checkout(
client.terminal.dismiss_terminal_refund(...)
+client.terminal.dismiss_terminal_refund(...) -> AsyncHttpResponse[DismissTerminalRefundResponse]
-
@@ -16985,7 +17065,7 @@ client.terminal.dismiss_terminal_refund(
client.transfer_orders.create(...)
+client.transfer_orders.create(...) -> AsyncHttpResponse[CreateTransferOrderResponse]
-
@@ -17103,7 +17183,7 @@ any valid string but must be unique for every CreateTransferOrder request.
client.transfer_orders.search(...)
+client.transfer_orders.search(...) -> AsyncPager[TransferOrder, SearchTransferOrdersResponse]
-
@@ -17209,7 +17289,7 @@ for page in response.iter_pages():
client.transfer_orders.get(...)
+client.transfer_orders.get(...) -> AsyncHttpResponse[RetrieveTransferOrderResponse]
-
@@ -17285,7 +17365,7 @@ client.transfer_orders.get(
client.transfer_orders.update(...)
+client.transfer_orders.update(...) -> AsyncHttpResponse[UpdateTransferOrderResponse]
-
@@ -17399,7 +17479,7 @@ client.transfer_orders.update(
client.transfer_orders.delete(...)
+client.transfer_orders.delete(...) -> AsyncHttpResponse[DeleteTransferOrderResponse]
-
@@ -17482,7 +17562,7 @@ client.transfer_orders.delete(
client.transfer_orders.cancel(...)
+client.transfer_orders.cancel(...) -> AsyncHttpResponse[CancelTransferOrderResponse]
-
@@ -17582,7 +17662,7 @@ any valid string but must be unique for every UpdateTransferOrder request.
client.transfer_orders.receive(...)
+client.transfer_orders.receive(...) -> AsyncHttpResponse[ReceiveTransferOrderResponse]
-
@@ -17635,13 +17715,13 @@ client.transfer_orders.receive(
receipt={
"line_items": [
{
- "transfer_order_line_uid": "transfer_order_line_uid",
+ "transfer_order_line_uid": "1",
"quantity_received": "3",
"quantity_damaged": "1",
"quantity_canceled": "1",
},
{
- "transfer_order_line_uid": "transfer_order_line_uid",
+ "transfer_order_line_uid": "2",
"quantity_received": "2",
"quantity_canceled": "1",
},
@@ -17708,7 +17788,7 @@ client.transfer_orders.receive(
client.transfer_orders.start(...)
+client.transfer_orders.start(...) -> AsyncHttpResponse[StartTransferOrderResponse]
-
@@ -17807,7 +17887,7 @@ any valid string but must be unique for every UpdateTransferOrder request.
client.vendors.batch_create(...)
+client.vendors.batch_create(...) -> AsyncHttpResponse[BatchCreateVendorsResponse]
-
@@ -17899,7 +17979,7 @@ client.vendors.batch_create(
client.vendors.batch_get(...)
+client.vendors.batch_get(...) -> AsyncHttpResponse[BatchGetVendorsResponse]
-
@@ -17969,7 +18049,7 @@ client.vendors.batch_get(
client.vendors.batch_update(...)
+client.vendors.batch_update(...) -> AsyncHttpResponse[BatchUpdateVendorsResponse]
-
@@ -18045,7 +18125,7 @@ objects. The set is represented by a collection of `Vendor`-ID/`UpdateVendorReq
client.vendors.create(...)
+client.vendors.create(...) -> AsyncHttpResponse[CreateVendorResponse]
-
@@ -18150,7 +18230,7 @@ information.
client.vendors.search(...)
+client.vendors.search(...) -> AsyncHttpResponse[SearchVendorsResponse]
-
@@ -18239,7 +18319,7 @@ See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagin
client.vendors.get(...)
+client.vendors.get(...) -> AsyncHttpResponse[GetVendorResponse]
-
@@ -18309,7 +18389,7 @@ client.vendors.get(
client.vendors.update(...)
+client.vendors.update(...) -> AsyncHttpResponse[UpdateVendorResponse]
-
@@ -18405,12 +18485,61 @@ information.
+
+
+client.mobile.authorization_code() -> AsyncHttpResponse[None]
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from square import Square
+
+client = Square(
+ token="YOUR_TOKEN",
+)
+client.mobile.authorization_code()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
client.bookings.custom_attribute_definitions.list(...)
+client.bookings.custom_attribute_definitions.list(...) -> AsyncPager[
+ CustomAttributeDefinition, ListBookingCustomAttributeDefinitionsResponse
+]
-
@@ -18505,7 +18634,7 @@ For more information, see [Pagination](https://developer.squareup.com/docs/build
client.bookings.custom_attribute_definitions.create(...)
+client.bookings.custom_attribute_definitions.create(...) -> AsyncHttpResponse[CreateBookingCustomAttributeDefinitionResponse]
-
@@ -18608,7 +18737,7 @@ see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-pa
client.bookings.custom_attribute_definitions.get(...)
+client.bookings.custom_attribute_definitions.get(...) -> AsyncHttpResponse[RetrieveBookingCustomAttributeDefinitionResponse]
-
@@ -18698,7 +18827,7 @@ is higher than the current version, Square returns a `BAD_REQUEST` error.
client.bookings.custom_attribute_definitions.update(...)
+client.bookings.custom_attribute_definitions.update(...) -> AsyncHttpResponse[UpdateBookingCustomAttributeDefinitionResponse]
-
@@ -18807,7 +18936,7 @@ see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-pa
client.bookings.custom_attribute_definitions.delete(...)
+client.bookings.custom_attribute_definitions.delete(...) -> AsyncHttpResponse[DeleteBookingCustomAttributeDefinitionResponse]
-
@@ -18884,7 +19013,7 @@ client.bookings.custom_attribute_definitions.delete(
client.bookings.custom_attributes.batch_delete(...)
+client.bookings.custom_attributes.batch_delete(...) -> AsyncHttpResponse[BulkDeleteBookingCustomAttributesResponse]
-
@@ -18964,7 +19093,7 @@ information needed to delete a custom attribute.
client.bookings.custom_attributes.batch_upsert(...)
+client.bookings.custom_attributes.batch_upsert(...) -> AsyncHttpResponse[BulkUpsertBookingCustomAttributesResponse]
-
@@ -19044,7 +19173,7 @@ information needed to create or update a custom attribute.
client.bookings.custom_attributes.list(...)
+client.bookings.custom_attributes.list(...) -> AsyncPager[CustomAttribute, ListBookingCustomAttributesResponse]
-
@@ -19161,7 +19290,7 @@ attribute, information about the data type, or other definition details. The def
client.bookings.custom_attributes.get(...)
+client.bookings.custom_attributes.get(...) -> AsyncHttpResponse[RetrieveBookingCustomAttributeResponse]
-
@@ -19274,7 +19403,7 @@ higher than the current version, Square returns a `BAD_REQUEST` error.
client.bookings.custom_attributes.upsert(...)
+client.bookings.custom_attributes.upsert(...) -> AsyncHttpResponse[UpsertBookingCustomAttributeResponse]
-
@@ -19392,7 +19521,7 @@ see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-pa
client.bookings.custom_attributes.delete(...)
+client.bookings.custom_attributes.delete(...) -> AsyncHttpResponse[DeleteBookingCustomAttributeResponse]
-
@@ -19482,7 +19611,7 @@ definition owner, you must use the qualified key.
client.bookings.location_profiles.list(...)
+client.bookings.location_profiles.list(...) -> AsyncPager[LocationBookingProfile, ListLocationBookingProfilesResponse]
-
@@ -19567,7 +19696,7 @@ for page in response.iter_pages():
client.bookings.team_member_profiles.list(...)
+client.bookings.team_member_profiles.list(...) -> AsyncPager[TeamMemberBookingProfile, ListTeamMemberBookingProfilesResponse]
-
@@ -19669,7 +19798,7 @@ for page in response.iter_pages():
client.bookings.team_member_profiles.get(...)
+client.bookings.team_member_profiles.get(...) -> AsyncHttpResponse[GetTeamMemberBookingProfileResponse]
-
@@ -19740,7 +19869,7 @@ client.bookings.team_member_profiles.get(
client.cash_drawers.shifts.list(...)
+client.cash_drawers.shifts.list(...) -> AsyncPager[CashDrawerShiftSummary, ListCashDrawerShiftsResponse]
-
@@ -19867,7 +19996,7 @@ default, 1000 max).
client.cash_drawers.shifts.get(...)
+client.cash_drawers.shifts.get(...) -> AsyncHttpResponse[GetCashDrawerShiftResponse]
-
@@ -19947,7 +20076,7 @@ client.cash_drawers.shifts.get(
client.cash_drawers.shifts.list_events(...)
+client.cash_drawers.shifts.list_events(...) -> AsyncPager[CashDrawerShiftEvent, ListCashDrawerShiftEventsResponse]
-
@@ -20053,7 +20182,7 @@ default, 1000 max).
client.catalog.images.create(...)
+client.catalog.images.create(...) -> AsyncHttpResponse[CreateCatalogImageResponse]
-
@@ -20136,7 +20265,7 @@ typing.Optional[core.File]` — See core.File for more documentation
client.catalog.images.update(...)
+client.catalog.images.update(...) -> AsyncHttpResponse[UpdateCatalogImageResponse]
-
@@ -20228,7 +20357,7 @@ typing.Optional[core.File]` — See core.File for more documentation
client.catalog.object.upsert(...)
+client.catalog.object.upsert(...) -> AsyncHttpResponse[UpsertCatalogObjectResponse]
-
@@ -20266,7 +20395,7 @@ client = Square(
)
client.catalog.object.upsert(
idempotency_key="af3d1afc-7212-4300-b463-0bfc5314a5ae",
- object={"type": "IMAGE", "id": "#Cocoa"},
+ object={"id": "id", "type": "ITEM"},
)
```
@@ -20327,7 +20456,7 @@ A CatalogObject to be created or updated.
client.catalog.object.get(...)
+client.catalog.object.get(...) -> AsyncHttpResponse[GetCatalogObjectResponse]
-
@@ -20455,7 +20584,7 @@ in the response payload.
client.catalog.object.delete(...)
+client.catalog.object.delete(...) -> AsyncHttpResponse[DeleteCatalogObjectResponse]
-
@@ -20539,7 +20668,7 @@ catalog item will delete its catalog item variations).
client.checkout.payment_links.list(...)
+client.checkout.payment_links.list(...) -> AsyncPager[PaymentLink, ListPaymentLinksResponse]
-
@@ -20634,7 +20763,7 @@ Default value: `100`
client.checkout.payment_links.create(...)
+client.checkout.payment_links.create(...) -> AsyncHttpResponse[CreatePaymentLinkResponse]
-
@@ -20781,7 +20910,7 @@ For more information, see [Prepopulate the shipping address](https://developer.s
client.checkout.payment_links.get(...)
+client.checkout.payment_links.get(...) -> AsyncHttpResponse[GetPaymentLinkResponse]
-
@@ -20851,7 +20980,7 @@ client.checkout.payment_links.get(
client.checkout.payment_links.update(...)
+client.checkout.payment_links.update(...) -> AsyncHttpResponse[UpdatePaymentLinkResponse]
-
@@ -20938,7 +21067,7 @@ For more information, see [Update a payment link](https://developer.squareup.com
client.checkout.payment_links.delete(...)
+client.checkout.payment_links.delete(...) -> AsyncHttpResponse[DeletePaymentLinkResponse]
-
@@ -21009,7 +21138,9 @@ client.checkout.payment_links.delete(
client.customers.custom_attribute_definitions.list(...)
+client.customers.custom_attribute_definitions.list(...) -> AsyncPager[
+ CustomAttributeDefinition, ListCustomerCustomAttributeDefinitionsResponse
+]
-
@@ -21106,7 +21237,7 @@ For more information, see [Pagination](https://developer.squareup.com/docs/build
client.customers.custom_attribute_definitions.create(...)
+client.customers.custom_attribute_definitions.create(...) -> AsyncHttpResponse[CreateCustomerCustomAttributeDefinitionResponse]
-
@@ -21212,7 +21343,7 @@ see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-pa
client.customers.custom_attribute_definitions.get(...)
+client.customers.custom_attribute_definitions.get(...) -> AsyncHttpResponse[GetCustomerCustomAttributeDefinitionResponse]
-
@@ -21303,7 +21434,7 @@ is higher than the current version, Square returns a `BAD_REQUEST` error.
client.customers.custom_attribute_definitions.update(...)
+client.customers.custom_attribute_definitions.update(...) -> AsyncHttpResponse[UpdateCustomerCustomAttributeDefinitionResponse]
-
@@ -21418,7 +21549,7 @@ see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-pa
client.customers.custom_attribute_definitions.delete(...)
+client.customers.custom_attribute_definitions.delete(...) -> AsyncHttpResponse[DeleteCustomerCustomAttributeDefinitionResponse]
-
@@ -21493,7 +21624,7 @@ client.customers.custom_attribute_definitions.delete(
client.customers.custom_attribute_definitions.batch_upsert(...)
+client.customers.custom_attribute_definitions.batch_upsert(...) -> AsyncHttpResponse[BatchUpsertCustomerCustomAttributesResponse]
-
@@ -21611,7 +21742,7 @@ information needed to create or update a custom attribute.
client.customers.groups.list(...)
+client.customers.groups.list(...) -> AsyncPager[CustomerGroup, ListCustomerGroupsResponse]
-
@@ -21705,7 +21836,7 @@ For more information, see [Pagination](https://developer.squareup.com/docs/build
client.customers.groups.create(...)
+client.customers.groups.create(...) -> AsyncHttpResponse[CreateCustomerGroupResponse]
-
@@ -21785,7 +21916,7 @@ client.customers.groups.create(
client.customers.groups.get(...)
+client.customers.groups.get(...) -> AsyncHttpResponse[GetCustomerGroupResponse]
-
@@ -21855,7 +21986,7 @@ client.customers.groups.get(
client.customers.groups.update(...)
+client.customers.groups.update(...) -> AsyncHttpResponse[UpdateCustomerGroupResponse]
-
@@ -21934,7 +22065,7 @@ client.customers.groups.update(
client.customers.groups.delete(...)
+client.customers.groups.delete(...) -> AsyncHttpResponse[DeleteCustomerGroupResponse]
-
@@ -22004,7 +22135,7 @@ client.customers.groups.delete(
client.customers.groups.add(...)
+client.customers.groups.add(...) -> AsyncHttpResponse[AddGroupToCustomerResponse]
-
@@ -22086,7 +22217,7 @@ client.customers.groups.add(
client.customers.groups.remove(...)
+client.customers.groups.remove(...) -> AsyncHttpResponse[RemoveGroupFromCustomerResponse]
-
@@ -22169,7 +22300,7 @@ client.customers.groups.remove(
client.customers.segments.list(...)
+client.customers.segments.list(...) -> AsyncPager[CustomerSegment, ListCustomerSegmentsResponse]
-
@@ -22263,7 +22394,7 @@ For more information, see [Pagination](https://developer.squareup.com/docs/build
client.customers.segments.get(...)
+client.customers.segments.get(...) -> AsyncHttpResponse[GetCustomerSegmentResponse]
-
@@ -22334,7 +22465,7 @@ client.customers.segments.get(
client.customers.cards.create(...)
+client.customers.cards.create(...) -> AsyncHttpResponse[CreateCustomerCardResponse]
-
@@ -22469,7 +22600,7 @@ challenge results to indicate that Square has verified the buyer identity.
client.customers.cards.delete(...)
+client.customers.cards.delete(...) -> AsyncHttpResponse[DeleteCustomerCardResponse]
-
@@ -22549,7 +22680,7 @@ client.customers.cards.delete(
client.customers.custom_attributes.list(...)
+client.customers.custom_attributes.list(...) -> AsyncPager[CustomAttribute, ListCustomerCustomAttributesResponse]
-
@@ -22670,7 +22801,7 @@ attribute, information about the data type, or other definition details. The def
client.customers.custom_attributes.get(...)
+client.customers.custom_attributes.get(...) -> AsyncHttpResponse[GetCustomerCustomAttributeResponse]
-
@@ -22787,7 +22918,7 @@ higher than the current version, Square returns a `BAD_REQUEST` error.
client.customers.custom_attributes.upsert(...)
+client.customers.custom_attributes.upsert(...) -> AsyncHttpResponse[UpsertCustomerCustomAttributeResponse]
-
@@ -22907,7 +23038,7 @@ see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-pa
client.customers.custom_attributes.delete(...)
+client.customers.custom_attributes.delete(...) -> AsyncHttpResponse[DeleteCustomerCustomAttributeResponse]
-
@@ -22995,7 +23126,7 @@ definition owner, you must use the qualified key.
client.devices.codes.list(...)
+client.devices.codes.list(...) -> AsyncPager[DeviceCode, ListDeviceCodesResponse]
-
@@ -23110,7 +23241,7 @@ Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty.
client.devices.codes.create(...)
+client.devices.codes.create(...) -> AsyncHttpResponse[CreateDeviceCodeResponse]
-
@@ -23199,7 +23330,7 @@ See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-a
client.devices.codes.get(...)
+client.devices.codes.get(...) -> AsyncHttpResponse[GetDeviceCodeResponse]
-
@@ -23270,7 +23401,7 @@ client.devices.codes.get(
client.disputes.evidence.list(...)
+client.disputes.evidence.list(...) -> AsyncPager[DisputeEvidence, ListDisputeEvidenceResponse]
-
@@ -23358,7 +23489,7 @@ For more information, see [Pagination](https://developer.squareup.com/docs/build
client.disputes.evidence.get(...)
+client.disputes.evidence.get(...) -> AsyncHttpResponse[GetDisputeEvidenceResponse]
-
@@ -23439,7 +23570,7 @@ client.disputes.evidence.get(
client.disputes.evidence.delete(...)
+client.disputes.evidence.delete(...) -> AsyncHttpResponse[DeleteDisputeEvidenceResponse]
-
@@ -23520,7 +23651,7 @@ client.disputes.evidence.delete(
client.gift_cards.activities.list(...)
+client.gift_cards.activities.list(...) -> AsyncPager[GiftCardActivity, ListGiftCardActivitiesResponse]
-
@@ -23690,7 +23821,7 @@ The order in which the endpoint returns the activities, based on `created_at`.
client.gift_cards.activities.create(...)
+client.gift_cards.activities.create(...) -> AsyncHttpResponse[CreateGiftCardActivityResponse]
-
@@ -23782,7 +23913,7 @@ gift card, the `location_id` where the activity occurred, and the activity `type
client.labor.break_types.list(...)
+client.labor.break_types.list(...) -> AsyncPager[BreakType, ListBreakTypesResponse]
-
@@ -23881,7 +24012,7 @@ and 200. The default is 200.
client.labor.break_types.create(...)
+client.labor.break_types.create(...) -> AsyncHttpResponse[CreateBreakTypeResponse]
-
@@ -23978,7 +24109,7 @@ client.labor.break_types.create(
client.labor.break_types.get(...)
+client.labor.break_types.get(...) -> AsyncHttpResponse[GetBreakTypeResponse]
-
@@ -24048,7 +24179,7 @@ client.labor.break_types.get(
client.labor.break_types.update(...)
+client.labor.break_types.update(...) -> AsyncHttpResponse[UpdateBreakTypeResponse]
-
@@ -24133,7 +24264,7 @@ client.labor.break_types.update(
client.labor.break_types.delete(...)
+client.labor.break_types.delete(...) -> AsyncHttpResponse[DeleteBreakTypeResponse]
-
@@ -24206,7 +24337,7 @@ client.labor.break_types.delete(
client.labor.employee_wages.list(...)
+client.labor.employee_wages.list(...) -> AsyncPager[EmployeeWage, ListEmployeeWagesResponse]
-
@@ -24302,7 +24433,7 @@ The maximum number of `EmployeeWage` results to return per page. The number can
client.labor.employee_wages.get(...)
+client.labor.employee_wages.get(...) -> AsyncHttpResponse[GetEmployeeWageResponse]
-
@@ -24373,7 +24504,7 @@ client.labor.employee_wages.get(
client.labor.shifts.create(...)
+client.labor.shifts.create(...) -> AsyncHttpResponse[CreateShiftResponse]
-
@@ -24490,7 +24621,7 @@ client.labor.shifts.create(
client.labor.shifts.search(...)
+client.labor.shifts.search(...) -> AsyncHttpResponse[SearchShiftsResponse]
-
@@ -24601,7 +24732,7 @@ client.labor.shifts.search(
client.labor.shifts.get(...)
+client.labor.shifts.get(...) -> AsyncHttpResponse[GetShiftResponse]
-
@@ -24671,7 +24802,7 @@ client.labor.shifts.get(
client.labor.shifts.update(...)
+client.labor.shifts.update(...) -> AsyncHttpResponse[UpdateShiftResponse]
-
@@ -24779,7 +24910,7 @@ client.labor.shifts.update(
client.labor.shifts.delete(...)
+client.labor.shifts.delete(...) -> AsyncHttpResponse[DeleteShiftResponse]
-
@@ -24850,7 +24981,7 @@ client.labor.shifts.delete(
client.labor.team_member_wages.list(...)
+client.labor.team_member_wages.list(...) -> AsyncPager[TeamMemberWage, ListTeamMemberWagesResponse]
-
@@ -24949,7 +25080,7 @@ The maximum number of `TeamMemberWage` results to return per page. The number ca
client.labor.team_member_wages.get(...)
+client.labor.team_member_wages.get(...) -> AsyncHttpResponse[GetTeamMemberWageResponse]
-
@@ -25020,7 +25151,7 @@ client.labor.team_member_wages.get(
client.labor.workweek_configs.list(...)
+client.labor.workweek_configs.