Skip to content

Commit af214e2

Browse files
square-sdk-deployersquare-sdk-deployer
committed
release
1 parent 72218da commit af214e2

281 files changed

Lines changed: 1517 additions & 1481 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`]($m/RegisterDomainRequest) | 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`](/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. |
3333

3434
### Response Type
3535

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

3838
### Example Usage
3939

‎doc/cash-drawers.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@ def list_cash_drawer_shifts(self,
3434
| Parameter | Type | Tags | Description |
3535
| --- | --- | --- | --- |
3636
| `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 |
37+
| `sort_order` | [`str (Sort Order)`](/doc/models/sort-order.md) | Query, Optional | The order in which cash drawer shifts are listed in the response,<br>based on their opened_at field. Default value: ASC |
3838
| `begin_time` | `string` | Query, Optional | The inclusive start time of the query on opened_at, in ISO 8601 format. |
3939
| `end_time` | `string` | Query, Optional | The exclusive end date of the query on opened_at, in ISO 8601 format. |
4040
| `limit` | `int` | Query, Optional | Number of cash drawer shift events in a page of results (200 by<br>default, 1000 max). |
4141
| `cursor` | `string` | Query, Optional | Opaque cursor for fetching the next page of results. |
4242

4343
### Response Type
4444

45-
[`List Cash Drawer Shifts Response`]($m/ListCashDrawerShiftsResponse)
45+
[`List Cash Drawer Shifts Response`](/doc/models/list-cash-drawer-shifts-response.md)
4646

4747
### Example Usage
4848

@@ -77,7 +77,7 @@ def retrieve_cash_drawer_shift(self,
7777

7878
### Response Type
7979

80-
[`Retrieve Cash Drawer Shift Response`]($m/RetrieveCashDrawerShiftResponse)
80+
[`Retrieve Cash Drawer Shift Response`](/doc/models/retrieve-cash-drawer-shift-response.md)
8181

8282
### Example Usage
8383

@@ -116,7 +116,7 @@ def list_cash_drawer_shift_events(self,
116116

117117
### Response Type
118118

119-
[`List Cash Drawer Shift Events Response`]($m/ListCashDrawerShiftEventsResponse)
119+
[`List Cash Drawer Shift Events Response`](/doc/models/list-cash-drawer-shift-events-response.md)
120120

121121
### Example Usage
122122

‎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`]($m/BatchDeleteCatalogObjectsRequest) | 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`](/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. |
4949

5050
### Response Type
5151

52-
[`Batch Delete Catalog Objects Response`]($m/BatchDeleteCatalogObjectsResponse)
52+
[`Batch Delete Catalog Objects Response`](/doc/models/batch-delete-catalog-objects-response.md)
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`]($m/BatchRetrieveCatalogObjectsRequest) | 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`](/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. |
8787

8888
### Response Type
8989

90-
[`Batch Retrieve Catalog Objects Response`]($m/BatchRetrieveCatalogObjectsResponse)
90+
[`Batch Retrieve Catalog Objects Response`](/doc/models/batch-retrieve-catalog-objects-response.md)
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`]($m/BatchUpsertCatalogObjectsRequest) | 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`](/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. |
129129

130130
### Response Type
131131

132-
[`Batch Upsert Catalog Objects Response`]($m/BatchUpsertCatalogObjectsResponse)
132+
[`Batch Upsert Catalog Objects Response`](/doc/models/batch-upsert-catalog-objects-response.md)
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`]($m/CreateCatalogImageRequest) | Form, Optional | - |
254+
| `request` | [`Create Catalog Image Request`](/doc/models/create-catalog-image-request.md) | Form, Optional | - |
255255
| `image_file` | `string` | Form, Optional | - |
256256

257257
### Response Type
258258

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

261261
### Example Usage
262262

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

288288
### Response Type
289289

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

292292
### Example Usage
293293

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

328328
### Response Type
329329

330-
[`List Catalog Response`]($m/ListCatalogResponse)
330+
[`List Catalog Response`](/doc/models/list-catalog-response.md)
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`]($m/UpsertCatalogObjectRequest) | 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`](/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. |
357357

358358
### Response Type
359359

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

362362
### Example Usage
363363

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

403403
### Response Type
404404

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

407407
### Example Usage
408408

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

443443
### Response Type
444444

445-
[`Retrieve Catalog Object Response`]($m/RetrieveCatalogObjectResponse)
445+
[`Retrieve Catalog Object Response`](/doc/models/retrieve-catalog-object-response.md)
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`]($m/SearchCatalogObjectsRequest) | 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`](/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. |
487487

488488
### Response Type
489489

490-
[`Search Catalog Objects Response`]($m/SearchCatalogObjectsResponse)
490+
[`Search Catalog Objects Response`](/doc/models/search-catalog-objects-response.md)
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`]($m/UpdateItemModifierListsRequest) | 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`](/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. |
527527

528528
### Response Type
529529

530-
[`Update Item Modifier Lists Response`]($m/UpdateItemModifierListsResponse)
530+
[`Update Item Modifier Lists Response`](/doc/models/update-item-modifier-lists-response.md)
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`]($m/UpdateItemTaxesRequest) | 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`](/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. |
564564

565565
### Response Type
566566

567-
[`Update Item Taxes Response`]($m/UpdateItemTaxesResponse)
567+
[`Update Item Taxes Response`](/doc/models/update-item-taxes-response.md)
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`]($m/CreateCheckoutRequest) | 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`](/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. |
2929

3030
### Response Type
3131

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

3434
### Example Usage
3535

‎doc/customers.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@ def list_customers(self,
3535
| Parameter | Type | Tags | Description |
3636
| --- | --- | --- | --- |
3737
| `cursor` | `string` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this to retrieve the next set of results for your original query.<br><br>See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. |
38-
| `sort_field` | [`str (Customer Sort Field)`]($m/CustomerSortField) | Query, Optional | Indicates how Customers should be sorted.<br><br>Default: `DEFAULT`. |
39-
| `sort_order` | [`str (Sort Order)`]($m/SortOrder) | Query, Optional | Indicates whether Customers should be sorted in ascending (`ASC`) or<br>descending (`DESC`) order.<br><br>Default: `ASC`. |
38+
| `sort_field` | [`str (Customer Sort Field)`](/doc/models/customer-sort-field.md) | Query, Optional | Indicates how Customers should be sorted.<br><br>Default: `DEFAULT`. |
39+
| `sort_order` | [`str (Sort Order)`](/doc/models/sort-order.md) | Query, Optional | Indicates whether Customers should be sorted in ascending (`ASC`) or<br>descending (`DESC`) order.<br><br>Default: `ASC`. |
4040

4141
### Response Type
4242

43-
[`List Customers Response`]($m/ListCustomersResponse)
43+
[`List Customers Response`](/doc/models/list-customers-response.md)
4444

4545
### Example Usage
4646

@@ -75,11 +75,11 @@ def create_customer(self,
7575

7676
| Parameter | Type | Tags | Description |
7777
| --- | --- | --- | --- |
78-
| `body` | [`Create Customer Request`]($m/CreateCustomerRequest) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
78+
| `body` | [`Create Customer Request`](/doc/models/create-customer-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
7979

8080
### Response Type
8181

82-
[`Create Customer Response`]($m/CreateCustomerResponse)
82+
[`Create Customer Response`](/doc/models/create-customer-response.md)
8383

8484
### Example Usage
8585

@@ -123,11 +123,11 @@ def search_customers(self,
123123

124124
| Parameter | Type | Tags | Description |
125125
| --- | --- | --- | --- |
126-
| `body` | [`Search Customers Request`]($m/SearchCustomersRequest) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
126+
| `body` | [`Search Customers Request`](/doc/models/search-customers-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
127127

128128
### Response Type
129129

130-
[`Search Customers Response`]($m/SearchCustomersResponse)
130+
[`Search Customers Response`](/doc/models/search-customers-response.md)
131131

132132
### Example Usage
133133

@@ -173,7 +173,7 @@ def delete_customer(self,
173173

174174
### Response Type
175175

176-
[`Delete Customer Response`]($m/DeleteCustomerResponse)
176+
[`Delete Customer Response`](/doc/models/delete-customer-response.md)
177177

178178
### Example Usage
179179

@@ -205,7 +205,7 @@ def retrieve_customer(self,
205205

206206
### Response Type
207207

208-
[`Retrieve Customer Response`]($m/RetrieveCustomerResponse)
208+
[`Retrieve Customer Response`](/doc/models/retrieve-customer-response.md)
209209

210210
### Example Usage
211211

@@ -242,11 +242,11 @@ def update_customer(self,
242242
| Parameter | Type | Tags | Description |
243243
| --- | --- | --- | --- |
244244
| `customer_id` | `string` | Template, Required | The ID of the customer to update. |
245-
| `body` | [`Update Customer Request`]($m/UpdateCustomerRequest) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
245+
| `body` | [`Update Customer Request`](/doc/models/update-customer-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
246246

247247
### Response Type
248248

249-
[`Update Customer Response`]($m/UpdateCustomerResponse)
249+
[`Update Customer Response`](/doc/models/update-customer-response.md)
250250

251251
### Example Usage
252252

@@ -284,11 +284,11 @@ def create_customer_card(self,
284284
| Parameter | Type | Tags | Description |
285285
| --- | --- | --- | --- |
286286
| `customer_id` | `string` | Template, Required | The Square ID of the customer profile the card is linked to. |
287-
| `body` | [`Create Customer Card Request`]($m/CreateCustomerCardRequest) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
287+
| `body` | [`Create Customer Card Request`](/doc/models/create-customer-card-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
288288

289289
### Response Type
290290

291-
[`Create Customer Card Response`]($m/CreateCustomerCardResponse)
291+
[`Create Customer Card Response`](/doc/models/create-customer-card-response.md)
292292

293293
### Example Usage
294294

@@ -332,7 +332,7 @@ def delete_customer_card(self,
332332

333333
### Response Type
334334

335-
[`Delete Customer Card Response`]($m/DeleteCustomerCardResponse)
335+
[`Delete Customer Card Response`](/doc/models/delete-customer-card-response.md)
336336

337337
### Example Usage
338338

‎doc/employees.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ def list_employees(self,
3030
| Parameter | Type | Tags | Description |
3131
| --- | --- | --- | --- |
3232
| `location_id` | `string` | Query, Optional | Filter employees returned to only those that are associated with the specified location. |
33-
| `status` | [`str (Employee Status)`]($m/EmployeeStatus) | Query, Optional | Specifies the EmployeeStatus to filter the employee by. |
33+
| `status` | [`str (Employee Status)`](/doc/models/employee-status.md) | Query, Optional | Specifies the EmployeeStatus to filter the employee by. |
3434
| `limit` | `int` | Query, Optional | The number of employees to be returned on each page. |
3535
| `cursor` | `string` | Query, Optional | The token required to retrieve the specified page of results. |
3636

3737
### Response Type
3838

39-
[`List Employees Response`]($m/ListEmployeesResponse)
39+
[`List Employees Response`](/doc/models/list-employees-response.md)
4040

4141
### Example Usage
4242

@@ -66,7 +66,7 @@ def retrieve_employee(self,
6666

6767
### Response Type
6868

69-
[`Retrieve Employee Response`]($m/RetrieveEmployeeResponse)
69+
[`Retrieve Employee Response`](/doc/models/retrieve-employee-response.md)
7070

7171
### Example Usage
7272

0 commit comments

Comments
 (0)