square.rb 5.2.0.20200422 → 6.1.0.20200722
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/README.md +315 -285
- data/lib/square.rb +3 -0
- data/lib/square/api/base_api.rb +2 -2
- data/lib/square/api/catalog_api.rb +76 -57
- data/lib/square/api/customer_groups_api.rb +1 -1
- data/lib/square/api/customer_segments_api.rb +2 -7
- data/lib/square/api/customers_api.rb +18 -5
- data/lib/square/api/disputes_api.rb +1 -11
- data/lib/square/api/inventory_api.rb +2 -2
- data/lib/square/api/invoices_api.rb +358 -0
- data/lib/square/api/locations_api.rb +7 -2
- data/lib/square/api/loyalty_api.rb +543 -0
- data/lib/square/api/merchants_api.rb +2 -1
- data/lib/square/api/orders_api.rb +32 -0
- data/lib/square/api/payments_api.rb +3 -9
- data/lib/square/api/refunds_api.rb +3 -2
- data/lib/square/api/team_api.rb +326 -0
- data/lib/square/api/transactions_api.rb +0 -71
- data/lib/square/api/v1_employees_api.rb +3 -76
- data/lib/square/api/v1_items_api.rb +0 -360
- data/lib/square/api/v1_locations_api.rb +0 -18
- data/lib/square/api/v1_transactions_api.rb +1 -19
- data/lib/square/client.rb +23 -4
- data/lib/square/configuration.rb +12 -4
- metadata +6 -3
@@ -345,15 +345,6 @@ module Square
|
|
345
345
|
end
|
346
346
|
|
347
347
|
# Provides summary information for all of a business's employee timecards.
|
348
|
-
# ---
|
349
|
-
# - __Deprecation date__: 2020-02-26
|
350
|
-
# - [__Retirement
|
351
|
-
# date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
|
352
|
-
# e#deprecated): 2021-02-26
|
353
|
-
# - [Migration
|
354
|
-
# guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
|
355
|
-
# timecards)
|
356
|
-
# ---
|
357
348
|
# @param [SortOrder] order Optional parameter: The order in which timecards
|
358
349
|
# are listed in the response, based on their created_at field.
|
359
350
|
# @param [String] employee_id Optional parameter: If provided, the endpoint
|
@@ -395,7 +386,7 @@ module Square
|
|
395
386
|
end_clockout_time: nil,
|
396
387
|
begin_updated_at: nil,
|
397
388
|
end_updated_at: nil,
|
398
|
-
deleted:
|
389
|
+
deleted: false,
|
399
390
|
limit: nil,
|
400
391
|
batch_token: nil)
|
401
392
|
warn 'Endpoint list_timecards in V1EmployeesApi is deprecated'
|
@@ -440,15 +431,6 @@ module Square
|
|
440
431
|
# Creates a timecard for an employee and clocks them in with an
|
441
432
|
# `API_CREATE` event and a `clockin_time` set to the current time unless
|
442
433
|
# the request provides a different value.
|
443
|
-
# ---
|
444
|
-
# - __Deprecation date__: 2020-02-26
|
445
|
-
# - [__Retirement
|
446
|
-
# date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
|
447
|
-
# e#deprecated): 2021-02-26
|
448
|
-
# - [Migration
|
449
|
-
# guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
|
450
|
-
# timecards)
|
451
|
-
# ---
|
452
434
|
# To import timecards from another
|
453
435
|
# system (rather than clocking someone in). Specify the `clockin_time`
|
454
436
|
# and* `clockout_time` in the request.
|
@@ -493,25 +475,15 @@ module Square
|
|
493
475
|
# Square Dashboard. Deleted timecards are still accessible through
|
494
476
|
# Connect API endpoints, but cannot be modified. The `deleted` field of
|
495
477
|
# the `Timecard` object indicates whether the timecard has been deleted.
|
496
|
-
#
|
497
|
-
#
|
498
|
-
# - [__Retirement
|
499
|
-
# date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
|
500
|
-
# e#deprecated): 2021-02-26
|
501
|
-
# - [Migration
|
502
|
-
# guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
|
503
|
-
# timecards)
|
504
|
-
# ---
|
505
|
-
# *Note**: By default, deleted timecards appear alongside valid timecards in
|
478
|
+
# __Note__: By default, deleted timecards appear alongside valid timecards
|
479
|
+
# in
|
506
480
|
# results returned by the
|
507
481
|
# [ListTimecards](#endpoint-v1employees-listtimecards)
|
508
482
|
# endpoint. To filter deleted timecards, include the `deleted` query
|
509
483
|
# parameter in the list request.
|
510
|
-
# <aside>
|
511
484
|
# Only approved accounts can manage their employees with Square.
|
512
485
|
# Unapproved accounts cannot use employee management features with the
|
513
486
|
# API.
|
514
|
-
# </aside>
|
515
487
|
# @param [String] timecard_id Required parameter: The ID of the timecard to
|
516
488
|
# delete.
|
517
489
|
# @return [Object] response from the API call
|
@@ -538,15 +510,6 @@ module Square
|
|
538
510
|
end
|
539
511
|
|
540
512
|
# Provides the details for a single timecard.
|
541
|
-
# ---
|
542
|
-
# - __Deprecation date__: 2020-02-26
|
543
|
-
# - [__Retirement
|
544
|
-
# date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
|
545
|
-
# e#deprecated): 2021-02-26
|
546
|
-
# - [Migration
|
547
|
-
# guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
|
548
|
-
# timecards)
|
549
|
-
# ---
|
550
513
|
# <aside>
|
551
514
|
# Only approved accounts can manage their employees with Square.
|
552
515
|
# Unapproved accounts cannot use employee management features with the
|
@@ -587,15 +550,6 @@ module Square
|
|
587
550
|
# Modifies the details of a timecard with an `API_EDIT` event for
|
588
551
|
# the timecard. Updating an active timecard with a `clockout_time`
|
589
552
|
# clocks the employee out.
|
590
|
-
# ---
|
591
|
-
# - __Deprecation date__: 2020-02-26
|
592
|
-
# - [__Retirement
|
593
|
-
# date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
|
594
|
-
# e#deprecated): 2021-02-26
|
595
|
-
# - [Migration
|
596
|
-
# guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
|
597
|
-
# timecards)
|
598
|
-
# ---
|
599
553
|
# @param [String] timecard_id Required parameter: TThe ID of the timecard to
|
600
554
|
# modify.
|
601
555
|
# @param [V1Timecard] body Required parameter: An object containing the
|
@@ -637,15 +591,6 @@ module Square
|
|
637
591
|
|
638
592
|
# Provides summary information for all events associated with a
|
639
593
|
# particular timecard.
|
640
|
-
# ---
|
641
|
-
# - __Deprecation date__: 2020-02-26
|
642
|
-
# - [__Retirement
|
643
|
-
# date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
|
644
|
-
# e#deprecated): 2021-02-26
|
645
|
-
# - [Migration
|
646
|
-
# guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
|
647
|
-
# timecards)
|
648
|
-
# ---
|
649
594
|
# <aside>
|
650
595
|
# Only approved accounts can manage their employees with Square.
|
651
596
|
# Unapproved accounts cannot use employee management features with the
|
@@ -686,15 +631,6 @@ module Square
|
|
686
631
|
|
687
632
|
# Provides the details for all of a location's cash drawer shifts during a
|
688
633
|
# date range. The date range you specify cannot exceed 90 days.
|
689
|
-
# ---
|
690
|
-
# - __Deprecation date__: 2020-02-26
|
691
|
-
# - [__Retirement
|
692
|
-
# date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
|
693
|
-
# e#deprecated): 2021-02-26
|
694
|
-
# - [Migration
|
695
|
-
# guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
|
696
|
-
# cashdrawershifts)
|
697
|
-
# ---
|
698
634
|
# @param [String] location_id Required parameter: The ID of the location to
|
699
635
|
# list cash drawer shifts for.
|
700
636
|
# @param [SortOrder] order Optional parameter: The order in which cash
|
@@ -748,15 +684,6 @@ module Square
|
|
748
684
|
|
749
685
|
# Provides the details for a single cash drawer shift, including all events
|
750
686
|
# that occurred during the shift.
|
751
|
-
# ---
|
752
|
-
# - __Deprecation date__: 2020-02-26
|
753
|
-
# - [__Retirement
|
754
|
-
# date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
|
755
|
-
# e#deprecated): 2021-02-26
|
756
|
-
# - [Migration
|
757
|
-
# guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
|
758
|
-
# cashdrawershifts)
|
759
|
-
# ---
|
760
687
|
# @param [String] location_id Required parameter: The ID of the location to
|
761
688
|
# list cash drawer shifts for.
|
762
689
|
# @param [String] shift_id Required parameter: The shift's ID.
|
@@ -6,15 +6,6 @@ module Square
|
|
6
6
|
end
|
7
7
|
|
8
8
|
# Lists all the item categories for a given location.
|
9
|
-
# ---
|
10
|
-
# - __Deprecation date__: 2019-11-20
|
11
|
-
# - [__Retirement
|
12
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
13
|
-
# recated): 2020-11-18
|
14
|
-
# - [Migration
|
15
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
16
|
-
# )
|
17
|
-
# ---
|
18
9
|
# @param [String] location_id Required parameter: The ID of the location to
|
19
10
|
# list categories for.
|
20
11
|
# @return [List of V1Category Hash] response from the API call
|
@@ -49,15 +40,6 @@ module Square
|
|
49
40
|
end
|
50
41
|
|
51
42
|
# Creates an item category.
|
52
|
-
# ---
|
53
|
-
# - __Deprecation date__: 2019-11-20
|
54
|
-
# - [__Retirement
|
55
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
56
|
-
# recated): 2020-11-18
|
57
|
-
# - [Migration
|
58
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
59
|
-
# )
|
60
|
-
# ---
|
61
43
|
# @param [String] location_id Required parameter: The ID of the location to
|
62
44
|
# create an item for.
|
63
45
|
# @param [V1Category] body Required parameter: An object containing the
|
@@ -98,15 +80,6 @@ module Square
|
|
98
80
|
end
|
99
81
|
|
100
82
|
# Deletes an existing item category.
|
101
|
-
# ---
|
102
|
-
# - __Deprecation date__: 2019-11-20
|
103
|
-
# - [__Retirement
|
104
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
105
|
-
# recated): 2020-11-18
|
106
|
-
# - [Migration
|
107
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
108
|
-
# )
|
109
|
-
# ---
|
110
83
|
# __DeleteCategory__ returns nothing on success but Connect SDKs
|
111
84
|
# map the empty response to an empty `V1DeleteCategoryRequest` object
|
112
85
|
# as documented below.
|
@@ -148,15 +121,6 @@ module Square
|
|
148
121
|
end
|
149
122
|
|
150
123
|
# Modifies the details of an existing item category.
|
151
|
-
# ---
|
152
|
-
# - __Deprecation date__: 2019-11-20
|
153
|
-
# - [__Retirement
|
154
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
155
|
-
# recated): 2020-11-18
|
156
|
-
# - [Migration
|
157
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
158
|
-
# )
|
159
|
-
# ---
|
160
124
|
# @param [String] location_id Required parameter: The ID of the category's
|
161
125
|
# associated location.
|
162
126
|
# @param [String] category_id Required parameter: The ID of the category to
|
@@ -201,15 +165,6 @@ module Square
|
|
201
165
|
end
|
202
166
|
|
203
167
|
# Lists all the discounts for a given location.
|
204
|
-
# ---
|
205
|
-
# - __Deprecation date__: 2019-11-20
|
206
|
-
# - [__Retirement
|
207
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
208
|
-
# recated): 2020-11-18
|
209
|
-
# - [Migration
|
210
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
211
|
-
# )
|
212
|
-
# ---
|
213
168
|
# @param [String] location_id Required parameter: The ID of the location to
|
214
169
|
# list categories for.
|
215
170
|
# @return [List of V1Discount Hash] response from the API call
|
@@ -244,15 +199,6 @@ module Square
|
|
244
199
|
end
|
245
200
|
|
246
201
|
# Creates a discount.
|
247
|
-
# ---
|
248
|
-
# - __Deprecation date__: 2019-11-20
|
249
|
-
# - [__Retirement
|
250
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
251
|
-
# recated): 2020-11-18
|
252
|
-
# - [Migration
|
253
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
254
|
-
# )
|
255
|
-
# ---
|
256
202
|
# @param [String] location_id Required parameter: The ID of the location to
|
257
203
|
# create an item for.
|
258
204
|
# @param [V1Discount] body Required parameter: An object containing the
|
@@ -293,15 +239,6 @@ module Square
|
|
293
239
|
end
|
294
240
|
|
295
241
|
# Deletes an existing discount.
|
296
|
-
# ---
|
297
|
-
# - __Deprecation date__: 2019-11-20
|
298
|
-
# - [__Retirement
|
299
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
300
|
-
# recated): 2020-11-18
|
301
|
-
# - [Migration
|
302
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
303
|
-
# )
|
304
|
-
# ---
|
305
242
|
# __DeleteDiscount__ returns nothing on success but Connect SDKs
|
306
243
|
# map the empty response to an empty `V1DeleteDiscountRequest` object
|
307
244
|
# as documented below.
|
@@ -343,15 +280,6 @@ module Square
|
|
343
280
|
end
|
344
281
|
|
345
282
|
# Modifies the details of an existing discount.
|
346
|
-
# ---
|
347
|
-
# - __Deprecation date__: 2019-11-20
|
348
|
-
# - [__Retirement
|
349
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
350
|
-
# recated): 2020-11-18
|
351
|
-
# - [Migration
|
352
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
353
|
-
# )
|
354
|
-
# ---
|
355
283
|
# @param [String] location_id Required parameter: The ID of the category's
|
356
284
|
# associated location.
|
357
285
|
# @param [String] discount_id Required parameter: The ID of the discount to
|
@@ -396,15 +324,6 @@ module Square
|
|
396
324
|
end
|
397
325
|
|
398
326
|
# Lists all the fees (taxes) for a given location.
|
399
|
-
# ---
|
400
|
-
# - __Deprecation date__: 2019-11-20
|
401
|
-
# - [__Retirement
|
402
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
403
|
-
# recated): 2020-11-18
|
404
|
-
# - [Migration
|
405
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
406
|
-
# )
|
407
|
-
# ---
|
408
327
|
# @param [String] location_id Required parameter: The ID of the location to
|
409
328
|
# list fees for.
|
410
329
|
# @return [List of V1Fee Hash] response from the API call
|
@@ -439,15 +358,6 @@ module Square
|
|
439
358
|
end
|
440
359
|
|
441
360
|
# Creates a fee (tax).
|
442
|
-
# ---
|
443
|
-
# - __Deprecation date__: 2019-11-20
|
444
|
-
# - [__Retirement
|
445
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
446
|
-
# recated): 2020-11-18
|
447
|
-
# - [Migration
|
448
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
449
|
-
# )
|
450
|
-
# ---
|
451
361
|
# @param [String] location_id Required parameter: The ID of the location to
|
452
362
|
# create a fee for.
|
453
363
|
# @param [V1Fee] body Required parameter: An object containing the fields to
|
@@ -488,15 +398,6 @@ module Square
|
|
488
398
|
end
|
489
399
|
|
490
400
|
# Deletes an existing fee (tax).
|
491
|
-
# ---
|
492
|
-
# - __Deprecation date__: 2019-11-20
|
493
|
-
# - [__Retirement
|
494
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
495
|
-
# recated): 2020-11-18
|
496
|
-
# - [Migration
|
497
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
498
|
-
# )
|
499
|
-
# ---
|
500
401
|
# __DeleteFee__ returns nothing on success but Connect SDKs
|
501
402
|
# map the empty response to an empty `V1DeleteFeeRequest` object
|
502
403
|
# as documented below.
|
@@ -537,15 +438,6 @@ module Square
|
|
537
438
|
end
|
538
439
|
|
539
440
|
# Modifies the details of an existing fee (tax).
|
540
|
-
# ---
|
541
|
-
# - __Deprecation date__: 2019-11-20
|
542
|
-
# - [__Retirement
|
543
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
544
|
-
# recated): 2020-11-18
|
545
|
-
# - [Migration
|
546
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
547
|
-
# )
|
548
|
-
# ---
|
549
441
|
# @param [String] location_id Required parameter: The ID of the fee's
|
550
442
|
# associated location.
|
551
443
|
# @param [String] fee_id Required parameter: The ID of the fee to edit.
|
@@ -590,15 +482,6 @@ module Square
|
|
590
482
|
|
591
483
|
# Provides inventory information for all inventory-enabled item
|
592
484
|
# variations.
|
593
|
-
# ---
|
594
|
-
# - __Deprecation date__: 2019-11-20
|
595
|
-
# - [__Retirement
|
596
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
597
|
-
# recated): 2020-11-18
|
598
|
-
# - [Migration
|
599
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
600
|
-
# )
|
601
|
-
# ---
|
602
485
|
# @param [String] location_id Required parameter: The ID of the item's
|
603
486
|
# associated location.
|
604
487
|
# @param [Integer] limit Optional parameter: The maximum number of inventory
|
@@ -645,15 +528,6 @@ module Square
|
|
645
528
|
end
|
646
529
|
|
647
530
|
# Adjusts the current available inventory of an item variation.
|
648
|
-
# ---
|
649
|
-
# - __Deprecation date__: 2019-11-20
|
650
|
-
# - [__Retirement
|
651
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
652
|
-
# recated): 2020-11-18
|
653
|
-
# - [Migration
|
654
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
655
|
-
# )
|
656
|
-
# ---
|
657
531
|
# @param [String] location_id Required parameter: The ID of the item's
|
658
532
|
# associated location.
|
659
533
|
# @param [String] variation_id Required parameter: The ID of the variation
|
@@ -698,15 +572,6 @@ module Square
|
|
698
572
|
end
|
699
573
|
|
700
574
|
# Provides summary information of all items for a given location.
|
701
|
-
# ---
|
702
|
-
# - __Deprecation date__: 2019-11-20
|
703
|
-
# - [__Retirement
|
704
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
705
|
-
# recated): 2020-11-18
|
706
|
-
# - [Migration
|
707
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
708
|
-
# )
|
709
|
-
# ---
|
710
575
|
# @param [String] location_id Required parameter: The ID of the location to
|
711
576
|
# list items for.
|
712
577
|
# @param [String] batch_token Optional parameter: A pagination cursor to
|
@@ -749,15 +614,6 @@ module Square
|
|
749
614
|
end
|
750
615
|
|
751
616
|
# Creates an item and at least one variation for it.
|
752
|
-
# ---
|
753
|
-
# - __Deprecation date__: 2019-11-20
|
754
|
-
# - [__Retirement
|
755
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
756
|
-
# recated): 2020-11-18
|
757
|
-
# - [Migration
|
758
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
759
|
-
# )
|
760
|
-
# ---
|
761
617
|
# Item-related entities include fields you can use to associate them with
|
762
618
|
# entities in a non-Square system.
|
763
619
|
# When you create an item-related entity, you can optionally specify `id`.
|
@@ -808,15 +664,6 @@ module Square
|
|
808
664
|
end
|
809
665
|
|
810
666
|
# Deletes an existing item and all item variations associated with it.
|
811
|
-
# ---
|
812
|
-
# - __Deprecation date__: 2019-11-20
|
813
|
-
# - [__Retirement
|
814
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
815
|
-
# recated): 2020-11-18
|
816
|
-
# - [Migration
|
817
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
818
|
-
# )
|
819
|
-
# ---
|
820
667
|
# __DeleteItem__ returns nothing on success but Connect SDKs
|
821
668
|
# map the empty response to an empty `V1DeleteItemRequest` object
|
822
669
|
# as documented below.
|
@@ -859,15 +706,6 @@ module Square
|
|
859
706
|
|
860
707
|
# Provides the details for a single item, including associated modifier
|
861
708
|
# lists and fees.
|
862
|
-
# ---
|
863
|
-
# - __Deprecation date__: 2019-11-20
|
864
|
-
# - [__Retirement
|
865
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
866
|
-
# recated): 2020-11-18
|
867
|
-
# - [Migration
|
868
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
869
|
-
# )
|
870
|
-
# ---
|
871
709
|
# @param [String] location_id Required parameter: The ID of the item's
|
872
710
|
# associated location.
|
873
711
|
# @param [String] item_id Required parameter: The item's ID.
|
@@ -905,15 +743,6 @@ module Square
|
|
905
743
|
end
|
906
744
|
|
907
745
|
# Modifies the core details of an existing item.
|
908
|
-
# ---
|
909
|
-
# - __Deprecation date__: 2019-11-20
|
910
|
-
# - [__Retirement
|
911
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
912
|
-
# recated): 2020-11-18
|
913
|
-
# - [Migration
|
914
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
915
|
-
# )
|
916
|
-
# ---
|
917
746
|
# @param [String] location_id Required parameter: The ID of the item's
|
918
747
|
# associated location.
|
919
748
|
# @param [String] item_id Required parameter: The ID of the item to
|
@@ -959,15 +788,6 @@ module Square
|
|
959
788
|
|
960
789
|
# Removes a fee assocation from an item so the fee is no longer
|
961
790
|
# automatically applied to the item in Square Point of Sale.
|
962
|
-
# ---
|
963
|
-
# - __Deprecation date__: 2019-11-20
|
964
|
-
# - [__Retirement
|
965
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
966
|
-
# recated): 2020-11-18
|
967
|
-
# - [Migration
|
968
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
969
|
-
# )
|
970
|
-
# ---
|
971
791
|
# @param [String] location_id Required parameter: The ID of the fee's
|
972
792
|
# associated location.
|
973
793
|
# @param [String] item_id Required parameter: The ID of the item to add the
|
@@ -1010,15 +830,6 @@ module Square
|
|
1010
830
|
|
1011
831
|
# Associates a fee with an item so the fee is automatically applied to
|
1012
832
|
# the item in Square Point of Sale.
|
1013
|
-
# ---
|
1014
|
-
# - __Deprecation date__: 2019-11-20
|
1015
|
-
# - [__Retirement
|
1016
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1017
|
-
# recated): 2020-11-18
|
1018
|
-
# - [Migration
|
1019
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1020
|
-
# )
|
1021
|
-
# ---
|
1022
833
|
# @param [String] location_id Required parameter: The ID of the fee's
|
1023
834
|
# associated location.
|
1024
835
|
# @param [String] item_id Required parameter: The ID of the item to add the
|
@@ -1061,15 +872,6 @@ module Square
|
|
1061
872
|
|
1062
873
|
# Removes a modifier list association from an item so the modifier
|
1063
874
|
# options from the list can no longer be applied to the item.
|
1064
|
-
# ---
|
1065
|
-
# - __Deprecation date__: 2019-11-20
|
1066
|
-
# - [__Retirement
|
1067
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1068
|
-
# recated): 2020-11-18
|
1069
|
-
# - [Migration
|
1070
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1071
|
-
# )
|
1072
|
-
# ---
|
1073
875
|
# @param [String] location_id Required parameter: The ID of the item's
|
1074
876
|
# associated location.
|
1075
877
|
# @param [String] modifier_list_id Required parameter: The ID of the
|
@@ -1113,15 +915,6 @@ module Square
|
|
1113
915
|
|
1114
916
|
# Associates a modifier list with an item so the associated modifier
|
1115
917
|
# options can be applied to the item.
|
1116
|
-
# ---
|
1117
|
-
# - __Deprecation date__: 2019-11-20
|
1118
|
-
# - [__Retirement
|
1119
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1120
|
-
# recated): 2020-11-18
|
1121
|
-
# - [Migration
|
1122
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1123
|
-
# )
|
1124
|
-
# ---
|
1125
918
|
# @param [String] location_id Required parameter: The ID of the item's
|
1126
919
|
# associated location.
|
1127
920
|
# @param [String] modifier_list_id Required parameter: The ID of the
|
@@ -1164,15 +957,6 @@ module Square
|
|
1164
957
|
end
|
1165
958
|
|
1166
959
|
# Creates an item variation for an existing item.
|
1167
|
-
# ---
|
1168
|
-
# - __Deprecation date__: 2019-11-20
|
1169
|
-
# - [__Retirement
|
1170
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1171
|
-
# recated): 2020-11-18
|
1172
|
-
# - [Migration
|
1173
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1174
|
-
# )
|
1175
|
-
# ---
|
1176
960
|
# @param [String] location_id Required parameter: The ID of the item's
|
1177
961
|
# associated location.
|
1178
962
|
# @param [String] item_id Required parameter: The item's ID.
|
@@ -1216,15 +1000,6 @@ module Square
|
|
1216
1000
|
end
|
1217
1001
|
|
1218
1002
|
# Deletes an existing item variation from an item.
|
1219
|
-
# ---
|
1220
|
-
# - __Deprecation date__: 2019-11-20
|
1221
|
-
# - [__Retirement
|
1222
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1223
|
-
# recated): 2020-11-18
|
1224
|
-
# - [Migration
|
1225
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1226
|
-
# )
|
1227
|
-
# ---
|
1228
1003
|
# __DeleteVariation__ returns nothing on success but Connect SDKs
|
1229
1004
|
# map the empty response to an empty `V1DeleteVariationRequest` object
|
1230
1005
|
# as documented below.
|
@@ -1270,15 +1045,6 @@ module Square
|
|
1270
1045
|
end
|
1271
1046
|
|
1272
1047
|
# Modifies the details of an existing item variation.
|
1273
|
-
# ---
|
1274
|
-
# - __Deprecation date__: 2019-11-20
|
1275
|
-
# - [__Retirement
|
1276
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1277
|
-
# recated): 2020-11-18
|
1278
|
-
# - [Migration
|
1279
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1280
|
-
# )
|
1281
|
-
# ---
|
1282
1048
|
# @param [String] location_id Required parameter: The ID of the item's
|
1283
1049
|
# associated location.
|
1284
1050
|
# @param [String] item_id Required parameter: The ID of the item to
|
@@ -1327,15 +1093,6 @@ module Square
|
|
1327
1093
|
end
|
1328
1094
|
|
1329
1095
|
# Lists all the modifier lists for a given location.
|
1330
|
-
# ---
|
1331
|
-
# - __Deprecation date__: 2019-11-20
|
1332
|
-
# - [__Retirement
|
1333
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1334
|
-
# recated): 2020-11-18
|
1335
|
-
# - [Migration
|
1336
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1337
|
-
# )
|
1338
|
-
# ---
|
1339
1096
|
# @param [String] location_id Required parameter: The ID of the location to
|
1340
1097
|
# list modifier lists for.
|
1341
1098
|
# @return [List of V1ModifierList Hash] response from the API call
|
@@ -1370,15 +1127,6 @@ module Square
|
|
1370
1127
|
end
|
1371
1128
|
|
1372
1129
|
# Creates an item modifier list and at least 1 modifier option for it.
|
1373
|
-
# ---
|
1374
|
-
# - __Deprecation date__: 2019-11-20
|
1375
|
-
# - [__Retirement
|
1376
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1377
|
-
# recated): 2020-11-18
|
1378
|
-
# - [Migration
|
1379
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1380
|
-
# )
|
1381
|
-
# ---
|
1382
1130
|
# @param [String] location_id Required parameter: The ID of the location to
|
1383
1131
|
# create a modifier list for.
|
1384
1132
|
# @param [V1ModifierList] body Required parameter: An object containing the
|
@@ -1420,15 +1168,6 @@ module Square
|
|
1420
1168
|
|
1421
1169
|
# Deletes an existing item modifier list and all modifier options
|
1422
1170
|
# associated with it.
|
1423
|
-
# ---
|
1424
|
-
# - __Deprecation date__: 2019-11-20
|
1425
|
-
# - [__Retirement
|
1426
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1427
|
-
# recated): 2020-11-18
|
1428
|
-
# - [Migration
|
1429
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1430
|
-
# )
|
1431
|
-
# ---
|
1432
1171
|
# __DeleteModifierList__ returns nothing on success but Connect SDKs
|
1433
1172
|
# map the empty response to an empty `V1DeleteModifierListRequest` object
|
1434
1173
|
# as documented below.
|
@@ -1470,15 +1209,6 @@ module Square
|
|
1470
1209
|
end
|
1471
1210
|
|
1472
1211
|
# Provides the details for a single modifier list.
|
1473
|
-
# ---
|
1474
|
-
# - __Deprecation date__: 2019-11-20
|
1475
|
-
# - [__Retirement
|
1476
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1477
|
-
# recated): 2020-11-18
|
1478
|
-
# - [Migration
|
1479
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1480
|
-
# )
|
1481
|
-
# ---
|
1482
1212
|
# @param [String] location_id Required parameter: The ID of the item's
|
1483
1213
|
# associated location.
|
1484
1214
|
# @param [String] modifier_list_id Required parameter: The modifier list's
|
@@ -1517,15 +1247,6 @@ module Square
|
|
1517
1247
|
end
|
1518
1248
|
|
1519
1249
|
# Modifies the details of an existing item modifier list.
|
1520
|
-
# ---
|
1521
|
-
# - __Deprecation date__: 2019-11-20
|
1522
|
-
# - [__Retirement
|
1523
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1524
|
-
# recated): 2020-11-18
|
1525
|
-
# - [Migration
|
1526
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1527
|
-
# )
|
1528
|
-
# ---
|
1529
1250
|
# @param [String] location_id Required parameter: The ID of the item's
|
1530
1251
|
# associated location.
|
1531
1252
|
# @param [String] modifier_list_id Required parameter: The ID of the
|
@@ -1570,15 +1291,6 @@ module Square
|
|
1570
1291
|
end
|
1571
1292
|
|
1572
1293
|
# Creates an item modifier option and adds it to a modifier list.
|
1573
|
-
# ---
|
1574
|
-
# - __Deprecation date__: 2019-11-20
|
1575
|
-
# - [__Retirement
|
1576
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1577
|
-
# recated): 2020-11-18
|
1578
|
-
# - [Migration
|
1579
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1580
|
-
# )
|
1581
|
-
# ---
|
1582
1294
|
# @param [String] location_id Required parameter: The ID of the item's
|
1583
1295
|
# associated location.
|
1584
1296
|
# @param [String] modifier_list_id Required parameter: The ID of the
|
@@ -1623,15 +1335,6 @@ module Square
|
|
1623
1335
|
end
|
1624
1336
|
|
1625
1337
|
# Deletes an existing item modifier option from a modifier list.
|
1626
|
-
# ---
|
1627
|
-
# - __Deprecation date__: 2019-11-20
|
1628
|
-
# - [__Retirement
|
1629
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1630
|
-
# recated): 2020-11-18
|
1631
|
-
# - [Migration
|
1632
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1633
|
-
# )
|
1634
|
-
# ---
|
1635
1338
|
# __DeleteModifierOption__ returns nothing on success but Connect
|
1636
1339
|
# SDKs map the empty response to an empty `V1DeleteModifierOptionRequest`
|
1637
1340
|
# object.
|
@@ -1677,15 +1380,6 @@ module Square
|
|
1677
1380
|
end
|
1678
1381
|
|
1679
1382
|
# Modifies the details of an existing item modifier option.
|
1680
|
-
# ---
|
1681
|
-
# - __Deprecation date__: 2019-11-20
|
1682
|
-
# - [__Retirement
|
1683
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1684
|
-
# recated): 2020-11-18
|
1685
|
-
# - [Migration
|
1686
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1687
|
-
# )
|
1688
|
-
# ---
|
1689
1383
|
# @param [String] location_id Required parameter: The ID of the item's
|
1690
1384
|
# associated location.
|
1691
1385
|
# @param [String] modifier_list_id Required parameter: The ID of the
|
@@ -1735,15 +1429,6 @@ module Square
|
|
1735
1429
|
|
1736
1430
|
# Lists all Favorites pages (in Square Point of Sale) for a given
|
1737
1431
|
# location.
|
1738
|
-
# ---
|
1739
|
-
# - __Deprecation date__: 2019-11-20
|
1740
|
-
# - [__Retirement
|
1741
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1742
|
-
# recated): 2020-11-18
|
1743
|
-
# - [Migration
|
1744
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1745
|
-
# )
|
1746
|
-
# ---
|
1747
1432
|
# @param [String] location_id Required parameter: The ID of the location to
|
1748
1433
|
# list Favorites pages for.
|
1749
1434
|
# @return [List of V1Page Hash] response from the API call
|
@@ -1778,15 +1463,6 @@ module Square
|
|
1778
1463
|
end
|
1779
1464
|
|
1780
1465
|
# Creates a Favorites page in Square Point of Sale.
|
1781
|
-
# ---
|
1782
|
-
# - __Deprecation date__: 2019-11-20
|
1783
|
-
# - [__Retirement
|
1784
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1785
|
-
# recated): 2020-11-18
|
1786
|
-
# - [Migration
|
1787
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1788
|
-
# )
|
1789
|
-
# ---
|
1790
1466
|
# @param [String] location_id Required parameter: The ID of the location to
|
1791
1467
|
# create an item for.
|
1792
1468
|
# @param [V1Page] body Required parameter: An object containing the fields
|
@@ -1827,15 +1503,6 @@ module Square
|
|
1827
1503
|
end
|
1828
1504
|
|
1829
1505
|
# Deletes an existing Favorites page and all of its cells.
|
1830
|
-
# ---
|
1831
|
-
# - __Deprecation date__: 2019-11-20
|
1832
|
-
# - [__Retirement
|
1833
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1834
|
-
# recated): 2020-11-18
|
1835
|
-
# - [Migration
|
1836
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1837
|
-
# )
|
1838
|
-
# ---
|
1839
1506
|
# __DeletePage__ returns nothing on success but Connect SDKs
|
1840
1507
|
# map the empty response to an empty `V1DeletePageRequest` object.
|
1841
1508
|
# @param [String] location_id Required parameter: The ID of the Favorites
|
@@ -1876,15 +1543,6 @@ module Square
|
|
1876
1543
|
end
|
1877
1544
|
|
1878
1545
|
# Modifies the details of a Favorites page in Square Point of Sale.
|
1879
|
-
# ---
|
1880
|
-
# - __Deprecation date__: 2019-11-20
|
1881
|
-
# - [__Retirement
|
1882
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1883
|
-
# recated): 2020-11-18
|
1884
|
-
# - [Migration
|
1885
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1886
|
-
# )
|
1887
|
-
# ---
|
1888
1546
|
# @param [String] location_id Required parameter: The ID of the Favorites
|
1889
1547
|
# page's associated location
|
1890
1548
|
# @param [String] page_id Required parameter: The ID of the page to
|
@@ -1929,15 +1587,6 @@ module Square
|
|
1929
1587
|
end
|
1930
1588
|
|
1931
1589
|
# Deletes a cell from a Favorites page in Square Point of Sale.
|
1932
|
-
# ---
|
1933
|
-
# - __Deprecation date__: 2019-11-20
|
1934
|
-
# - [__Retirement
|
1935
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1936
|
-
# recated): 2020-11-18
|
1937
|
-
# - [Migration
|
1938
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
1939
|
-
# )
|
1940
|
-
# ---
|
1941
1590
|
# __DeletePageCell__ returns nothing on success but Connect SDKs
|
1942
1591
|
# map the empty response to an empty `V1DeletePageCellRequest` object
|
1943
1592
|
# as documented below.
|
@@ -1991,15 +1640,6 @@ module Square
|
|
1991
1640
|
end
|
1992
1641
|
|
1993
1642
|
# Modifies a cell of a Favorites page in Square Point of Sale.
|
1994
|
-
# ---
|
1995
|
-
# - __Deprecation date__: 2019-11-20
|
1996
|
-
# - [__Retirement
|
1997
|
-
# date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
|
1998
|
-
# recated): 2020-11-18
|
1999
|
-
# - [Migration
|
2000
|
-
# guide](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-items
|
2001
|
-
# )
|
2002
|
-
# ---
|
2003
1643
|
# @param [String] location_id Required parameter: The ID of the Favorites
|
2004
1644
|
# page's associated location.
|
2005
1645
|
# @param [String] page_id Required parameter: The ID of the page the cell
|