Skip to content

Commit 9f60b10

Browse files
square-sdk-deployersquare-sdk-deployer
committed
release
1 parent 5e68efd commit 9f60b10

273 files changed

Lines changed: 1392 additions & 878 deletions

File tree

Some content is hidden

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

‎doc/apple-pay.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ def register_domain(self,
2929

3030
| Parameter | Type | Tags | Description |
3131
| --- | --- | --- | --- |
32-
| `body` | [`Register Domain Request`](/doc/models/register-domain-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
32+
| `body` | [`Register Domain Request`]($m/RegisterDomainRequest) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
3333

3434
### Response Type
3535

36-
[`Register Domain Response`](/doc/models/register-domain-response.md)
36+
[`Register Domain Response`]($m/RegisterDomainResponse)
3737

3838
### Example Usage
3939

‎doc/cash-drawers.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
# Cash Drawers
2+
3+
```python
4+
cash_drawers_api = client.cash_drawers
5+
```
6+
7+
## Class Name
8+
9+
`CashDrawersApi`
10+
11+
## Methods
12+
13+
* [List Cash Drawer Shifts](/doc/cash-drawers.md#list-cash-drawer-shifts)
14+
* [Retrieve Cash Drawer Shift](/doc/cash-drawers.md#retrieve-cash-drawer-shift)
15+
* [List Cash Drawer Shift Events](/doc/cash-drawers.md#list-cash-drawer-shift-events)
16+
17+
## List Cash Drawer Shifts
18+
19+
Provides the details for all of the cash drawer shifts for a location
20+
in a date range.
21+
22+
```python
23+
def list_cash_drawer_shifts(self,
24+
location_id,
25+
sort_order=None,
26+
begin_time=None,
27+
end_time=None,
28+
limit=None,
29+
cursor=None)
30+
```
31+
32+
### Parameters
33+
34+
| Parameter | Type | Tags | Description |
35+
| --- | --- | --- | --- |
36+
| `location_id` | `string` | Query, Required | The ID of the location to query for a list of cash drawer shifts. |
37+
| `sort_order` | [`str (Sort Order)`]($m/SortOrder) | Query, Optional | The order in which cash drawer shifts are listed in the response,<br>based on their opened_at field. Default value: ASC |
38+
| `begin_time` | `string` | Query, Optional | The inclusive start time of the query on opened_at, in ISO 8601 format. |
39+
| `end_time` | `string` | Query, Optional | The exclusive end date of the query on opened_at, in ISO 8601 format. |
40+
| `limit` | `int` | Query, Optional | Number of cash drawer shift events in a page of results (200 by<br>default, 1000 max). |
41+
| `cursor` | `string` | Query, Optional | Opaque cursor for fetching the next page of results. |
42+
43+
### Response Type
44+
45+
[`List Cash Drawer Shifts Response`]($m/ListCashDrawerShiftsResponse)
46+
47+
### Example Usage
48+
49+
```python
50+
location_id = 'location_id4'
51+
52+
result = cash_drawers_api.list_cash_drawer_shifts(location_id)
53+
54+
if result.is_success():
55+
print(result.body)
56+
elif result.is_error():
57+
print(result.errors)
58+
```
59+
60+
## Retrieve Cash Drawer Shift
61+
62+
Provides the summary details for a single cash drawer shift. See
63+
RetrieveCashDrawerShiftEvents for a list of cash drawer shift events.
64+
65+
```python
66+
def retrieve_cash_drawer_shift(self,
67+
location_id,
68+
shift_id)
69+
```
70+
71+
### Parameters
72+
73+
| Parameter | Type | Tags | Description |
74+
| --- | --- | --- | --- |
75+
| `location_id` | `string` | Query, Required | The ID of the location to retrieve cash drawer shifts from. |
76+
| `shift_id` | `string` | Template, Required | The shift ID. |
77+
78+
### Response Type
79+
80+
[`Retrieve Cash Drawer Shift Response`]($m/RetrieveCashDrawerShiftResponse)
81+
82+
### Example Usage
83+
84+
```python
85+
location_id = 'location_id4'
86+
shift_id = 'shift_id0'
87+
88+
result = cash_drawers_api.retrieve_cash_drawer_shift(location_id, shift_id)
89+
90+
if result.is_success():
91+
print(result.body)
92+
elif result.is_error():
93+
print(result.errors)
94+
```
95+
96+
## List Cash Drawer Shift Events
97+
98+
Provides a paginated list of events for a single cash drawer shift.
99+
100+
```python
101+
def list_cash_drawer_shift_events(self,
102+
location_id,
103+
shift_id,
104+
limit=None,
105+
cursor=None)
106+
```
107+
108+
### Parameters
109+
110+
| Parameter | Type | Tags | Description |
111+
| --- | --- | --- | --- |
112+
| `location_id` | `string` | Query, Required | The ID of the location to list cash drawer shifts for. |
113+
| `shift_id` | `string` | Template, Required | The shift ID. |
114+
| `limit` | `int` | Query, Optional | Number of resources to be returned in a page of results (200 by<br>default, 1000 max). |
115+
| `cursor` | `string` | Query, Optional | Opaque cursor for fetching the next page of results. |
116+
117+
### Response Type
118+
119+
[`List Cash Drawer Shift Events Response`]($m/ListCashDrawerShiftEventsResponse)
120+
121+
### Example Usage
122+
123+
```python
124+
location_id = 'location_id4'
125+
shift_id = 'shift_id0'
126+
127+
result = cash_drawers_api.list_cash_drawer_shift_events(location_id, shift_id)
128+
129+
if result.is_success():
130+
print(result.body)
131+
elif result.is_error():
132+
print(result.errors)
133+
```
134+

‎doc/catalog.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ def batch_delete_catalog_objects(self,
4545

4646
| Parameter | Type | Tags | Description |
4747
| --- | --- | --- | --- |
48-
| `body` | [`Batch Delete Catalog Objects Request`](/doc/models/batch-delete-catalog-objects-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
48+
| `body` | [`Batch Delete Catalog Objects Request`]($m/BatchDeleteCatalogObjectsRequest) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
4949

5050
### Response Type
5151

52-
[`Batch Delete Catalog Objects Response`](/doc/models/batch-delete-catalog-objects-response.md)
52+
[`Batch Delete Catalog Objects Response`]($m/BatchDeleteCatalogObjectsResponse)
5353

5454
### Example Usage
5555

@@ -83,11 +83,11 @@ def batch_retrieve_catalog_objects(self,
8383

8484
| Parameter | Type | Tags | Description |
8585
| --- | --- | --- | --- |
86-
| `body` | [`Batch Retrieve Catalog Objects Request`](/doc/models/batch-retrieve-catalog-objects-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
86+
| `body` | [`Batch Retrieve Catalog Objects Request`]($m/BatchRetrieveCatalogObjectsRequest) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
8787

8888
### Response Type
8989

90-
[`Batch Retrieve Catalog Objects Response`](/doc/models/batch-retrieve-catalog-objects-response.md)
90+
[`Batch Retrieve Catalog Objects Response`]($m/BatchRetrieveCatalogObjectsResponse)
9191

9292
### Example Usage
9393

@@ -125,11 +125,11 @@ def batch_upsert_catalog_objects(self,
125125

126126
| Parameter | Type | Tags | Description |
127127
| --- | --- | --- | --- |
128-
| `body` | [`Batch Upsert Catalog Objects Request`](/doc/models/batch-upsert-catalog-objects-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
128+
| `body` | [`Batch Upsert Catalog Objects Request`]($m/BatchUpsertCatalogObjectsRequest) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
129129

130130
### Response Type
131131

132-
[`Batch Upsert Catalog Objects Response`](/doc/models/batch-upsert-catalog-objects-response.md)
132+
[`Batch Upsert Catalog Objects Response`]($m/BatchUpsertCatalogObjectsResponse)
133133

134134
### Example Usage
135135

@@ -251,12 +251,12 @@ def create_catalog_image(self,
251251

252252
| Parameter | Type | Tags | Description |
253253
| --- | --- | --- | --- |
254-
| `request` | [`Create Catalog Image Request`](/doc/models/create-catalog-image-request.md) | Form, Optional | - |
254+
| `request` | [`Create Catalog Image Request`]($m/CreateCatalogImageRequest) | Form, Optional | - |
255255
| `image_file` | `string` | Form, Optional | - |
256256

257257
### Response Type
258258

259-
[`Create Catalog Image Response`](/doc/models/create-catalog-image-response.md)
259+
[`Create Catalog Image Response`]($m/CreateCatalogImageResponse)
260260

261261
### Example Usage
262262

@@ -287,7 +287,7 @@ def catalog_info(self)
287287

288288
### Response Type
289289

290-
[`Catalog Info Response`](/doc/models/catalog-info-response.md)
290+
[`Catalog Info Response`]($m/CatalogInfoResponse)
291291

292292
### Example Usage
293293

@@ -327,7 +327,7 @@ def list_catalog(self,
327327

328328
### Response Type
329329

330-
[`List Catalog Response`](/doc/models/list-catalog-response.md)
330+
[`List Catalog Response`]($m/ListCatalogResponse)
331331

332332
### Example Usage
333333

@@ -353,11 +353,11 @@ def upsert_catalog_object(self,
353353

354354
| Parameter | Type | Tags | Description |
355355
| --- | --- | --- | --- |
356-
| `body` | [`Upsert Catalog Object Request`](/doc/models/upsert-catalog-object-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
356+
| `body` | [`Upsert Catalog Object Request`]($m/UpsertCatalogObjectRequest) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
357357

358358
### Response Type
359359

360-
[`Upsert Catalog Object Response`](/doc/models/upsert-catalog-object-response.md)
360+
[`Upsert Catalog Object Response`]($m/UpsertCatalogObjectResponse)
361361

362362
### Example Usage
363363

@@ -402,7 +402,7 @@ def delete_catalog_object(self,
402402

403403
### Response Type
404404

405-
[`Delete Catalog Object Response`](/doc/models/delete-catalog-object-response.md)
405+
[`Delete Catalog Object Response`]($m/DeleteCatalogObjectResponse)
406406

407407
### Example Usage
408408

@@ -442,7 +442,7 @@ def retrieve_catalog_object(self,
442442

443443
### Response Type
444444

445-
[`Retrieve Catalog Object Response`](/doc/models/retrieve-catalog-object-response.md)
445+
[`Retrieve Catalog Object Response`]($m/RetrieveCatalogObjectResponse)
446446

447447
### Example Usage
448448

@@ -483,11 +483,11 @@ def search_catalog_objects(self,
483483

484484
| Parameter | Type | Tags | Description |
485485
| --- | --- | --- | --- |
486-
| `body` | [`Search Catalog Objects Request`](/doc/models/search-catalog-objects-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
486+
| `body` | [`Search Catalog Objects Request`]($m/SearchCatalogObjectsRequest) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
487487

488488
### Response Type
489489

490-
[`Search Catalog Objects Response`](/doc/models/search-catalog-objects-response.md)
490+
[`Search Catalog Objects Response`]($m/SearchCatalogObjectsResponse)
491491

492492
### Example Usage
493493

@@ -523,11 +523,11 @@ def update_item_modifier_lists(self,
523523

524524
| Parameter | Type | Tags | Description |
525525
| --- | --- | --- | --- |
526-
| `body` | [`Update Item Modifier Lists Request`](/doc/models/update-item-modifier-lists-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
526+
| `body` | [`Update Item Modifier Lists Request`]($m/UpdateItemModifierListsRequest) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
527527

528528
### Response Type
529529

530-
[`Update Item Modifier Lists Response`](/doc/models/update-item-modifier-lists-response.md)
530+
[`Update Item Modifier Lists Response`]($m/UpdateItemModifierListsResponse)
531531

532532
### Example Usage
533533

@@ -560,11 +560,11 @@ def update_item_taxes(self,
560560

561561
| Parameter | Type | Tags | Description |
562562
| --- | --- | --- | --- |
563-
| `body` | [`Update Item Taxes Request`](/doc/models/update-item-taxes-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
563+
| `body` | [`Update Item Taxes Request`]($m/UpdateItemTaxesRequest) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
564564

565565
### Response Type
566566

567-
[`Update Item Taxes Response`](/doc/models/update-item-taxes-response.md)
567+
[`Update Item Taxes Response`]($m/UpdateItemTaxesResponse)
568568

569569
### Example Usage
570570

‎doc/checkout.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ def create_checkout(self,
2525
| Parameter | Type | Tags | Description |
2626
| --- | --- | --- | --- |
2727
| `location_id` | `string` | Template, Required | The ID of the business location to associate the checkout with. |
28-
| `body` | [`Create Checkout Request`](/doc/models/create-checkout-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
28+
| `body` | [`Create Checkout Request`]($m/CreateCheckoutRequest) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
2929

3030
### Response Type
3131

32-
[`Create Checkout Response`](/doc/models/create-checkout-response.md)
32+
[`Create Checkout Response`]($m/CreateCheckoutResponse)
3333

3434
### Example Usage
3535

0 commit comments

Comments
 (0)