Skip to content

Commit 9162e46

Browse files
Barry-ZouBarry-Zou
authored
Merge pull request #151 from square/fern-bot/05-06-2025-0129PM
🌿 Fern Regeneration -- May 6, 2025
2 parents f4db5a8 + 3de0e08 commit 9162e46

File tree

74 files changed

+5899
-637
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+5899
-637
lines changed

‎.mock/definition/__package__.yml‎

Lines changed: 2470 additions & 233 deletions
Large diffs are not rendered by default.

‎.mock/definition/catalog.yml‎

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,15 @@ service:
215215
absent_at_location_ids:
216216
- absent_at_location_ids
217217
image_id: image_id
218+
item_data:
219+
name: Tea
220+
description: Hot Leaf Juice
221+
tax_ids:
222+
- HURXQOOAIC4IZSI2BEXQRYFY
223+
categories:
224+
- type: CATEGORY
225+
id: BJNQCF2FJ6S6UIDT65ABHLRX
226+
ordinal: 0
218227
- type: ITEM
219228
id: AA27W3M2GGTF3H6AVPNB77CK
220229
updated_at: '2016-11-16T22:25:24.878Z'
@@ -236,11 +245,11 @@ service:
236245
tax_ids:
237246
- HURXQOOAIC4IZSI2BEXQRYFY
238247
categories:
239-
- type: ITEM
248+
- type: CATEGORY
240249
id: BJNQCF2FJ6S6UIDT65ABHLRX
241250
ordinal: 0
242251
related_objects:
243-
- type: CATEGORY
252+
- type: ITEM
244253
id: BJNQCF2FJ6S6UIDT65ABHLRX
245254
updated_at: '2016-11-16T22:25:24.878Z'
246255
version: 1479335124878
@@ -408,13 +417,13 @@ service:
408417
idempotency_key: 789ff020-f723-43a9-b4b5-43b5dc1fa3dc
409418
batches:
410419
- objects:
411-
- type: ITEM
420+
- type: IMAGE
412421
id: '#Tea'
413422
present_at_all_locations: true
414-
- type: ITEM
423+
- type: IMAGE
415424
id: '#Coffee'
416425
present_at_all_locations: true
417-
- type: CATEGORY
426+
- type: ITEM
418427
id: '#Beverages'
419428
present_at_all_locations: true
420429
- type: TAX
@@ -458,7 +467,7 @@ service:
458467
- HP5VNYPKZKTNCKZ2Z5NPUH6A
459468
product_type: REGULAR
460469
categories:
461-
- type: ITEM
470+
- type: CATEGORY
462471
id: XCS4SCGN4WQYE2VU4U3TKXEH
463472
ordinal: -2251731094208512
464473
description_html: <p><strong>Hot</strong> Leaf Juice</p>
@@ -487,7 +496,7 @@ service:
487496
- HP5VNYPKZKTNCKZ2Z5NPUH6A
488497
product_type: REGULAR
489498
categories:
490-
- type: ITEM
499+
- type: CATEGORY
491500
id: XCS4SCGN4WQYE2VU4U3TKXEH
492501
ordinal: -2251662374731776
493502
description_html: <p>Hot <em>Bean Juice</em></p>
@@ -508,6 +517,12 @@ service:
508517
absent_at_location_ids:
509518
- absent_at_location_ids
510519
image_id: image_id
520+
ordinal: 1000000
521+
category_data:
522+
name: Beverages
523+
category_type: REGULAR_CATEGORY
524+
is_top_level: true
525+
online_visibility: true
511526
- type: TAX
512527
id: HP5VNYPKZKTNCKZ2Z5NPUH6A
513528
updated_at: '2023-11-30T19:24:35.4Z'
@@ -687,7 +702,7 @@ service:
687702
field: field
688703
cursor: cursor
689704
objects:
690-
- type: CATEGORY
705+
- type: ITEM
691706
id: 5ZYQZZ2IECPVJ2IJ5KQPRDC3
692707
updated_at: '2017-02-21T14:50:26.495Z'
693708
version: 1487688626495
@@ -934,7 +949,7 @@ service:
934949
- ZXITPM6RWHZ7GZ7EIP3YKECM
935950
product_type: REGULAR
936951
categories:
937-
- type: ITEM
952+
- type: CATEGORY
938953
id: E7CLE5RZZ744BHWVQQEAHI2C
939954
ordinal: 0
940955
- type: ITEM
@@ -959,7 +974,7 @@ service:
959974
- ZXITPM6RWHZ7GZ7EIP3YKECM
960975
product_type: REGULAR
961976
categories:
962-
- type: ITEM
977+
- type: CATEGORY
963978
id: E7CLE5RZZ744BHWVQQEAHI2C
964979
ordinal: 0
965980
related_objects:

‎.mock/definition/catalog/object.yml‎

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ service:
7272
- request:
7373
idempotency_key: af3d1afc-7212-4300-b463-0bfc5314a5ae
7474
object:
75-
type: ITEM
75+
type: IMAGE
7676
id: '#Cocoa'
7777
response:
7878
body:
@@ -259,8 +259,39 @@ service:
259259
absent_at_location_ids:
260260
- absent_at_location_ids
261261
image_id: image_id
262+
item_data:
263+
name: Tea
264+
description: Hot Leaf Juice
265+
abbreviation: abbreviation
266+
label_color: label_color
267+
is_taxable: true
268+
category_id: category_id
269+
tax_ids:
270+
- HURXQOOAIC4IZSI2BEXQRYFY
271+
modifier_list_info:
272+
- modifier_list_id: modifier_list_id
273+
product_type: REGULAR
274+
skip_modifier_screen: true
275+
item_options:
276+
- {}
277+
ecom_uri: ecom_uri
278+
ecom_image_uris:
279+
- ecom_image_uris
280+
image_ids:
281+
- image_ids
282+
sort_name: sort_name
283+
categories:
284+
- type: CATEGORY
285+
id: BJNQCF2FJ6S6UIDT65ABHLRX
286+
ordinal: 0
287+
description_html: description_html
288+
description_plaintext: description_plaintext
289+
channels:
290+
- channels
291+
is_archived: true
292+
is_alcoholic: true
262293
related_objects:
263-
- type: CATEGORY
294+
- type: ITEM
264295
id: BJNQCF2FJ6S6UIDT65ABHLRX
265296
updated_at: '2016-11-16T22:25:24.878Z'
266297
version: 1479335124878

‎.mock/definition/invoices.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -854,7 +854,7 @@ service:
854854
body:
855855
properties:
856856
request:
857-
type: optional<unknown>
857+
type: optional<root.CreateInvoiceAttachmentRequestData>
858858
content-type: application/json; charset=utf-8
859859
image_file:
860860
type: optional<file>

‎README.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,27 @@ for page in response.iter_pages():
140140
yield page
141141
```
142142

143+
## File Uploads
144+
145+
Files are uploaded with the [File](./src/square/core/file.py) type, which is constructed as a tuple in
146+
a variety of formats. You can customize the filename and `Content-Type` of the individual `multipart/form-data`
147+
part like so:
148+
149+
```python
150+
invoice_pdf = client.invoices.create_invoice_attachment(
151+
invoice_id="inv:0-ChA4-3sU9GPd-uOC3HgvFjMWEL4N",
152+
image_file=(
153+
os.path.basename(pdf_filepath), # The filename to include in the `multipart/form-data` part.
154+
open(pdf_filepath, "rb"), # The file stream, read as binary data.
155+
"application/pdf" # The Content-Type for this particular file.
156+
),
157+
request={
158+
"idempotency_key": str(uuid.uuid4()),
159+
"description": f"Invoice-{pdf_filepath}",
160+
}
161+
)
162+
```
163+
143164
## Exception Handling
144165

145166
When the API returns a non-success status code (4xx or 5xx response), a subclass of

‎poetry.lock‎

Lines changed: 18 additions & 18 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name = "squareup"
33

44
[tool.poetry]
55
name = "squareup"
6-
version = "42.0.0.20250416"
6+
version = "42.1.0.20250416"
77
description = ""
88
readme = "README.md"
99
authors = []

‎reference.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2653,17 +2653,17 @@ client.catalog.batch_upsert(
26532653
{
26542654
"objects": [
26552655
{
2656-
"type": "ITEM",
2656+
"type": "IMAGE",
26572657
"id": "#Tea",
26582658
"present_at_all_locations": True,
26592659
},
26602660
{
2661-
"type": "ITEM",
2661+
"type": "IMAGE",
26622662
"id": "#Coffee",
26632663
"present_at_all_locations": True,
26642664
},
26652665
{
2666-
"type": "CATEGORY",
2666+
"type": "ITEM",
26672667
"id": "#Beverages",
26682668
"present_at_all_locations": True,
26692669
},
@@ -8571,7 +8571,7 @@ client.invoices.create_invoice_attachment(
85718571
<dl>
85728572
<dd>
85738573

8574-
**request:** `typing.Optional[typing.Optional[typing.Any]]`
8574+
**request:** `typing.Optional[CreateInvoiceAttachmentRequestDataParams]`
85758575

85768576
</dd>
85778577
</dl>
@@ -17988,7 +17988,7 @@ client = Square(
1798817988
)
1798917989
client.catalog.object.upsert(
1799017990
idempotency_key="af3d1afc-7212-4300-b463-0bfc5314a5ae",
17991-
object={"type": "ITEM", "id": "#Cocoa"},
17991+
object={"type": "IMAGE", "id": "#Cocoa"},
1799217992
)
1799317993

1799417994
```

‎src/square/catalog/client.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -267,17 +267,17 @@ def batch_upsert(
267267
{
268268
"objects": [
269269
{
270-
"type": "ITEM",
270+
"type": "IMAGE",
271271
"id": "#Tea",
272272
"present_at_all_locations": True,
273273
},
274274
{
275-
"type": "ITEM",
275+
"type": "IMAGE",
276276
"id": "#Coffee",
277277
"present_at_all_locations": True,
278278
},
279279
{
280-
"type": "CATEGORY",
280+
"type": "ITEM",
281281
"id": "#Beverages",
282282
"present_at_all_locations": True,
283283
},
@@ -1034,17 +1034,17 @@ async def main() -> None:
10341034
{
10351035
"objects": [
10361036
{
1037-
"type": "ITEM",
1037+
"type": "IMAGE",
10381038
"id": "#Tea",
10391039
"present_at_all_locations": True,
10401040
},
10411041
{
1042-
"type": "ITEM",
1042+
"type": "IMAGE",
10431043
"id": "#Coffee",
10441044
"present_at_all_locations": True,
10451045
},
10461046
{
1047-
"type": "CATEGORY",
1047+
"type": "ITEM",
10481048
"id": "#Beverages",
10491049
"present_at_all_locations": True,
10501050
},

‎src/square/catalog/object/client.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ def upsert(
8181
)
8282
client.catalog.object.upsert(
8383
idempotency_key="af3d1afc-7212-4300-b463-0bfc5314a5ae",
84-
object={"type": "ITEM", "id": "#Cocoa"},
84+
object={"type": "IMAGE", "id": "#Cocoa"},
8585
)
8686
"""
8787
response = self._raw_client.upsert(
@@ -284,7 +284,7 @@ async def upsert(
284284
async def main() -> None:
285285
await client.catalog.object.upsert(
286286
idempotency_key="af3d1afc-7212-4300-b463-0bfc5314a5ae",
287-
object={"type": "ITEM", "id": "#Cocoa"},
287+
object={"type": "IMAGE", "id": "#Cocoa"},
288288
)
289289
290290

0 commit comments

Comments
 (0)