square.rb 39.0.0.20240821 → 39.1.0.20240919

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. checksums.yaml +4 -4
  2. data/lib/square/api/apple_pay_api.rb +1 -1
  3. data/lib/square/api/bank_accounts_api.rb +3 -3
  4. data/lib/square/api/base_api.rb +1 -1
  5. data/lib/square/api/booking_custom_attributes_api.rb +11 -11
  6. data/lib/square/api/bookings_api.rb +13 -13
  7. data/lib/square/api/cards_api.rb +4 -4
  8. data/lib/square/api/cash_drawers_api.rb +3 -3
  9. data/lib/square/api/catalog_api.rb +14 -14
  10. data/lib/square/api/checkout_api.rb +10 -10
  11. data/lib/square/api/customer_custom_attributes_api.rb +10 -10
  12. data/lib/square/api/customer_groups_api.rb +5 -5
  13. data/lib/square/api/customer_segments_api.rb +2 -2
  14. data/lib/square/api/customers_api.rb +14 -14
  15. data/lib/square/api/devices_api.rb +5 -5
  16. data/lib/square/api/disputes_api.rb +9 -9
  17. data/lib/square/api/employees_api.rb +2 -2
  18. data/lib/square/api/events_api.rb +4 -4
  19. data/lib/square/api/gift_card_activities_api.rb +2 -2
  20. data/lib/square/api/gift_cards_api.rb +7 -7
  21. data/lib/square/api/inventory_api.rb +13 -13
  22. data/lib/square/api/invoices_api.rb +10 -10
  23. data/lib/square/api/labor_api.rb +16 -16
  24. data/lib/square/api/location_custom_attributes_api.rb +11 -11
  25. data/lib/square/api/locations_api.rb +4 -4
  26. data/lib/square/api/loyalty_api.rb +18 -18
  27. data/lib/square/api/merchant_custom_attributes_api.rb +11 -11
  28. data/lib/square/api/merchants_api.rb +2 -2
  29. data/lib/square/api/mobile_authorization_api.rb +1 -1
  30. data/lib/square/api/o_auth_api.rb +3 -3
  31. data/lib/square/api/order_custom_attributes_api.rb +11 -11
  32. data/lib/square/api/orders_api.rb +8 -8
  33. data/lib/square/api/payments_api.rb +7 -7
  34. data/lib/square/api/payouts_api.rb +3 -3
  35. data/lib/square/api/refunds_api.rb +3 -3
  36. data/lib/square/api/sites_api.rb +1 -1
  37. data/lib/square/api/snippets_api.rb +3 -3
  38. data/lib/square/api/subscriptions_api.rb +12 -12
  39. data/lib/square/api/team_api.rb +8 -8
  40. data/lib/square/api/terminal_api.rb +15 -15
  41. data/lib/square/api/transactions_api.rb +4 -4
  42. data/lib/square/api/v1_transactions_api.rb +3 -3
  43. data/lib/square/api/vendors_api.rb +7 -7
  44. data/lib/square/api/webhook_subscriptions_api.rb +8 -8
  45. data/lib/square/client.rb +2 -2
  46. data/lib/square/configuration.rb +1 -1
  47. metadata +2 -2
data/lib/square/api/customer_groups_api.rb CHANGED
@@ -14,7 +14,7 @@ module Square
14
14
  # The default value is 50. For more information, see
15
15
  # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
16
16
  # atterns/pagination).
17
- # @return [ListCustomerGroupsResponse Hash] response from the API call
17
+ # @return [ApiResponse] the complete http response with raw body and status code.
18
18
  def list_customer_groups(cursor: nil,
19
19
  limit: nil)
20
20
  new_api_call_builder
@@ -37,7 +37,7 @@ module Square
37
37
  # @param [CreateCustomerGroupRequest] body Required parameter: An object
38
38
  # containing the fields to POST for the request. See the corresponding
39
39
  # object definition for field details.
40
- # @return [CreateCustomerGroupResponse Hash] response from the API call
40
+ # @return [ApiResponse] the complete http response with raw body and status code.
41
41
  def create_customer_group(body:)
42
42
  new_api_call_builder
43
43
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -58,7 +58,7 @@ module Square
58
58
  # Deletes a customer group as identified by the `group_id` value.
59
59
  # @param [String] group_id Required parameter: The ID of the customer group
60
60
  # to delete.
61
- # @return [DeleteCustomerGroupResponse Hash] response from the API call
61
+ # @return [ApiResponse] the complete http response with raw body and status code.
62
62
  def delete_customer_group(group_id:)
63
63
  new_api_call_builder
64
64
  .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -78,7 +78,7 @@ module Square
78
78
  # Retrieves a specific customer group as identified by the `group_id` value.
79
79
  # @param [String] group_id Required parameter: The ID of the customer group
80
80
  # to retrieve.
81
- # @return [RetrieveCustomerGroupResponse Hash] response from the API call
81
+ # @return [ApiResponse] the complete http response with raw body and status code.
82
82
  def retrieve_customer_group(group_id:)
83
83
  new_api_call_builder
84
84
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -101,7 +101,7 @@ module Square
101
101
  # @param [UpdateCustomerGroupRequest] body Required parameter: An object
102
102
  # containing the fields to POST for the request. See the corresponding
103
103
  # object definition for field details.
104
- # @return [UpdateCustomerGroupResponse Hash] response from the API call
104
+ # @return [ApiResponse] the complete http response with raw body and status code.
105
105
  def update_customer_group(group_id:,
106
106
  body:)
107
107
  new_api_call_builder
data/lib/square/api/customer_segments_api.rb CHANGED
@@ -14,7 +14,7 @@ module Square
14
14
  # VALUE_TOO_HIGH` error. The default value is 50. For more information, see
15
15
  # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
16
16
  # atterns/pagination).
17
- # @return [ListCustomerSegmentsResponse Hash] response from the API call
17
+ # @return [ApiResponse] the complete http response with raw body and status code.
18
18
  def list_customer_segments(cursor: nil,
19
19
  limit: nil)
20
20
  new_api_call_builder
@@ -36,7 +36,7 @@ module Square
36
36
  # value.
37
37
  # @param [String] segment_id Required parameter: The Square-issued ID of the
38
38
  # customer segment.
39
- # @return [RetrieveCustomerSegmentResponse Hash] response from the API call
39
+ # @return [ApiResponse] the complete http response with raw body and status code.
40
40
  def retrieve_customer_segment(segment_id:)
41
41
  new_api_call_builder
42
42
  .request(new_request_builder(HttpMethodEnum::GET,
data/lib/square/api/customers_api.rb CHANGED
@@ -29,7 +29,7 @@ module Square
29
29
  # @param [TrueClass | FalseClass] count Optional parameter: Indicates
30
30
  # whether to return the total count of customers in the `count` field of the
31
31
  # response. The default value is `false`.
32
- # @return [ListCustomersResponse Hash] response from the API call
32
+ # @return [ApiResponse] the complete http response with raw body and status code.
33
33
  def list_customers(cursor: nil,
34
34
  limit: nil,
35
35
  sort_field: nil,
@@ -65,7 +65,7 @@ module Square
65
65
  # @param [CreateCustomerRequest] body Required parameter: An object
66
66
  # containing the fields to POST for the request. See the corresponding
67
67
  # object definition for field details.
68
- # @return [CreateCustomerResponse Hash] response from the API call
68
+ # @return [ApiResponse] the complete http response with raw body and status code.
69
69
  def create_customer(body:)
70
70
  new_api_call_builder
71
71
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -96,7 +96,7 @@ module Square
96
96
  # @param [BulkCreateCustomersRequest] body Required parameter: An object
97
97
  # containing the fields to POST for the request. See the corresponding
98
98
  # object definition for field details.
99
- # @return [BulkCreateCustomersResponse Hash] response from the API call
99
+ # @return [ApiResponse] the complete http response with raw body and status code.
100
100
  def bulk_create_customers(body:)
101
101
  new_api_call_builder
102
102
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -119,7 +119,7 @@ module Square
119
119
  # @param [BulkDeleteCustomersRequest] body Required parameter: An object
120
120
  # containing the fields to POST for the request. See the corresponding
121
121
  # object definition for field details.
122
- # @return [BulkDeleteCustomersResponse Hash] response from the API call
122
+ # @return [ApiResponse] the complete http response with raw body and status code.
123
123
  def bulk_delete_customers(body:)
124
124
  new_api_call_builder
125
125
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -142,7 +142,7 @@ module Square
142
142
  # @param [BulkRetrieveCustomersRequest] body Required parameter: An object
143
143
  # containing the fields to POST for the request. See the corresponding
144
144
  # object definition for field details.
145
- # @return [BulkRetrieveCustomersResponse Hash] response from the API call
145
+ # @return [ApiResponse] the complete http response with raw body and status code.
146
146
  def bulk_retrieve_customers(body:)
147
147
  new_api_call_builder
148
148
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -168,7 +168,7 @@ module Square
168
168
  # @param [BulkUpdateCustomersRequest] body Required parameter: An object
169
169
  # containing the fields to POST for the request. See the corresponding
170
170
  # object definition for field details.
171
- # @return [BulkUpdateCustomersResponse Hash] response from the API call
171
+ # @return [ApiResponse] the complete http response with raw body and status code.
172
172
  def bulk_update_customers(body:)
173
173
  new_api_call_builder
174
174
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -200,7 +200,7 @@ module Square
200
200
  # @param [SearchCustomersRequest] body Required parameter: An object
201
201
  # containing the fields to POST for the request. See the corresponding
202
202
  # object definition for field details.
203
- # @return [SearchCustomersResponse Hash] response from the API call
203
+ # @return [ApiResponse] the complete http response with raw body and status code.
204
204
  def search_customers(body:)
205
205
  new_api_call_builder
206
206
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -232,7 +232,7 @@ module Square
232
232
  # [Delete a customer
233
233
  # profile](https://developer.squareup.com/docs/customers-api/use-the-api/kee
234
234
  # p-records#delete-customer-profile).
235
- # @return [DeleteCustomerResponse Hash] response from the API call
235
+ # @return [ApiResponse] the complete http response with raw body and status code.
236
236
  def delete_customer(customer_id:,
237
237
  version: nil)
238
238
  new_api_call_builder
@@ -254,7 +254,7 @@ module Square
254
254
  # Returns details for a single customer.
255
255
  # @param [String] customer_id Required parameter: The ID of the customer to
256
256
  # retrieve.
257
- # @return [RetrieveCustomerResponse Hash] response from the API call
257
+ # @return [ApiResponse] the complete http response with raw body and status code.
258
258
  def retrieve_customer(customer_id:)
259
259
  new_api_call_builder
260
260
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -284,7 +284,7 @@ module Square
284
284
  # @param [UpdateCustomerRequest] body Required parameter: An object
285
285
  # containing the fields to POST for the request. See the corresponding
286
286
  # object definition for field details.
287
- # @return [UpdateCustomerResponse Hash] response from the API call
287
+ # @return [ApiResponse] the complete http response with raw body and status code.
288
288
  def update_customer(customer_id:,
289
289
  body:)
290
290
  new_api_call_builder
@@ -315,7 +315,7 @@ module Square
315
315
  # @param [CreateCustomerCardRequest] body Required parameter: An object
316
316
  # containing the fields to POST for the request. See the corresponding
317
317
  # object definition for field details.
318
- # @return [CreateCustomerCardResponse Hash] response from the API call
318
+ # @return [ApiResponse] the complete http response with raw body and status code.
319
319
  def create_customer_card(customer_id:,
320
320
  body:)
321
321
  warn 'Endpoint create_customer_card in CustomersApi is deprecated'
@@ -342,7 +342,7 @@ module Square
342
342
  # that the card on file belongs to.
343
343
  # @param [String] card_id Required parameter: The ID of the card on file to
344
344
  # delete.
345
- # @return [DeleteCustomerCardResponse Hash] response from the API call
345
+ # @return [ApiResponse] the complete http response with raw body and status code.
346
346
  def delete_customer_card(customer_id:,
347
347
  card_id:)
348
348
  warn 'Endpoint delete_customer_card in CustomersApi is deprecated'
@@ -370,7 +370,7 @@ module Square
370
370
  # remove from the group.
371
371
  # @param [String] group_id Required parameter: The ID of the customer group
372
372
  # to remove the customer from.
373
- # @return [RemoveGroupFromCustomerResponse Hash] response from the API call
373
+ # @return [ApiResponse] the complete http response with raw body and status code.
374
374
  def remove_group_from_customer(customer_id:,
375
375
  group_id:)
376
376
  new_api_call_builder
@@ -397,7 +397,7 @@ module Square
397
397
  # add to a group.
398
398
  # @param [String] group_id Required parameter: The ID of the customer group
399
399
  # to add the customer to.
400
- # @return [AddGroupToCustomerResponse Hash] response from the API call
400
+ # @return [ApiResponse] the complete http response with raw body and status code.
401
401
  def add_group_to_customer(customer_id:,
402
402
  group_id:)
403
403
  new_api_call_builder
data/lib/square/api/devices_api.rb CHANGED
@@ -15,7 +15,7 @@ module Square
15
15
  # in a single page.
16
16
  # @param [String] location_id Optional parameter: If present, only returns
17
17
  # devices at the target location.
18
- # @return [ListDevicesResponse Hash] response from the API call
18
+ # @return [ApiResponse] the complete http response with raw body and status code.
19
19
  def list_devices(cursor: nil,
20
20
  sort_order: nil,
21
21
  limit: nil,
@@ -52,7 +52,7 @@ module Square
52
52
  # @param [DeviceCodeStatus] status Optional parameter: If specified, returns
53
53
  # DeviceCodes with the specified statuses. Returns DeviceCodes of status
54
54
  # `PAIRED` and `UNPAIRED` if empty.
55
- # @return [ListDeviceCodesResponse Hash] response from the API call
55
+ # @return [ApiResponse] the complete http response with raw body and status code.
56
56
  def list_device_codes(cursor: nil,
57
57
  location_id: nil,
58
58
  product_type: nil,
@@ -80,7 +80,7 @@ module Square
80
80
  # @param [CreateDeviceCodeRequest] body Required parameter: An object
81
81
  # containing the fields to POST for the request. See the corresponding
82
82
  # object definition for field details.
83
- # @return [CreateDeviceCodeResponse Hash] response from the API call
83
+ # @return [ApiResponse] the complete http response with raw body and status code.
84
84
  def create_device_code(body:)
85
85
  new_api_call_builder
86
86
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -101,7 +101,7 @@ module Square
101
101
  # Retrieves DeviceCode with the associated ID.
102
102
  # @param [String] id Required parameter: The unique identifier for the
103
103
  # device code.
104
- # @return [GetDeviceCodeResponse Hash] response from the API call
104
+ # @return [ApiResponse] the complete http response with raw body and status code.
105
105
  def get_device_code(id:)
106
106
  new_api_call_builder
107
107
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -121,7 +121,7 @@ module Square
121
121
  # Retrieves Device with the associated `device_id`.
122
122
  # @param [String] device_id Required parameter: The unique ID for the
123
123
  # desired `Device`.
124
- # @return [GetDeviceResponse Hash] response from the API call
124
+ # @return [ApiResponse] the complete http response with raw body and status code.
125
125
  def get_device(device_id:)
126
126
  new_api_call_builder
127
127
  .request(new_request_builder(HttpMethodEnum::GET,
data/lib/square/api/disputes_api.rb CHANGED
@@ -13,7 +13,7 @@ module Square
13
13
  # @param [String] location_id Optional parameter: The ID of the location for
14
14
  # which to return a list of disputes. If not specified, the endpoint returns
15
15
  # disputes associated with all locations.
16
- # @return [ListDisputesResponse Hash] response from the API call
16
+ # @return [ApiResponse] the complete http response with raw body and status code.
17
17
  def list_disputes(cursor: nil,
18
18
  states: nil,
19
19
  location_id: nil)
@@ -36,7 +36,7 @@ module Square
36
36
  # Returns details about a specific dispute.
37
37
  # @param [String] dispute_id Required parameter: The ID of the dispute you
38
38
  # want more details about.
39
- # @return [RetrieveDisputeResponse Hash] response from the API call
39
+ # @return [ApiResponse] the complete http response with raw body and status code.
40
40
  def retrieve_dispute(dispute_id:)
41
41
  new_api_call_builder
42
42
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -61,7 +61,7 @@ module Square
61
61
  # does not have sufficient funds, Square debits the associated bank account.
62
62
  # @param [String] dispute_id Required parameter: The ID of the dispute you
63
63
  # want to accept.
64
- # @return [AcceptDisputeResponse Hash] response from the API call
64
+ # @return [ApiResponse] the complete http response with raw body and status code.
65
65
  def accept_dispute(dispute_id:)
66
66
  new_api_call_builder
67
67
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -85,7 +85,7 @@ module Square
85
85
  # set of results for the original query. For more information, see
86
86
  # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
87
87
  # atterns/pagination).
88
- # @return [ListDisputeEvidenceResponse Hash] response from the API call
88
+ # @return [ApiResponse] the complete http response with raw body and status code.
89
89
  def list_dispute_evidence(dispute_id:,
90
90
  cursor: nil)
91
91
  new_api_call_builder
@@ -113,7 +113,7 @@ module Square
113
113
  # @param [CreateDisputeEvidenceFileRequest] request Optional parameter:
114
114
  # Defines the parameters for a `CreateDisputeEvidenceFile` request.
115
115
  # @param [File | UploadIO] image_file Optional parameter: Example:
116
- # @return [CreateDisputeEvidenceFileResponse Hash] response from the API call
116
+ # @return [ApiResponse] the complete http response with raw body and status code.
117
117
  def create_dispute_evidence_file(dispute_id:,
118
118
  request: nil,
119
119
  image_file: nil)
@@ -142,7 +142,7 @@ module Square
142
142
  # @param [CreateDisputeEvidenceTextRequest] body Required parameter: An
143
143
  # object containing the fields to POST for the request. See the
144
144
  # corresponding object definition for field details.
145
- # @return [CreateDisputeEvidenceTextResponse Hash] response from the API call
145
+ # @return [ApiResponse] the complete http response with raw body and status code.
146
146
  def create_dispute_evidence_text(dispute_id:,
147
147
  body:)
148
148
  new_api_call_builder
@@ -169,7 +169,7 @@ module Square
169
169
  # which you want to remove evidence.
170
170
  # @param [String] evidence_id Required parameter: The ID of the evidence you
171
171
  # want to remove.
172
- # @return [DeleteDisputeEvidenceResponse Hash] response from the API call
172
+ # @return [ApiResponse] the complete http response with raw body and status code.
173
173
  def delete_dispute_evidence(dispute_id:,
174
174
  evidence_id:)
175
175
  new_api_call_builder
@@ -196,7 +196,7 @@ module Square
196
196
  # which you want to retrieve evidence metadata.
197
197
  # @param [String] evidence_id Required parameter: The ID of the evidence to
198
198
  # retrieve.
199
- # @return [RetrieveDisputeEvidenceResponse Hash] response from the API call
199
+ # @return [ApiResponse] the complete http response with raw body and status code.
200
200
  def retrieve_dispute_evidence(dispute_id:,
201
201
  evidence_id:)
202
202
  new_api_call_builder
@@ -227,7 +227,7 @@ module Square
227
227
  # a dispute after submission.
228
228
  # @param [String] dispute_id Required parameter: The ID of the dispute for
229
229
  # which you want to submit evidence.
230
- # @return [SubmitEvidenceResponse Hash] response from the API call
230
+ # @return [ApiResponse] the complete http response with raw body and status code.
231
231
  def submit_evidence(dispute_id:)
232
232
  new_api_call_builder
233
233
  .request(new_request_builder(HttpMethodEnum::POST,
data/lib/square/api/employees_api.rb CHANGED
@@ -9,7 +9,7 @@ module Square
9
9
  # returned on each page.
10
10
  # @param [String] cursor Optional parameter: The token required to retrieve
11
11
  # the specified page of results.
12
- # @return [ListEmployeesResponse Hash] response from the API call
12
+ # @return [ApiResponse] the complete http response with raw body and status code.
13
13
  def list_employees(location_id: nil,
14
14
  status: nil,
15
15
  limit: nil,
@@ -35,7 +35,7 @@ module Square
35
35
  # TODO: type endpoint description here
36
36
  # @param [String] id Required parameter: UUID for the employee that was
37
37
  # requested.
38
- # @return [RetrieveEmployeeResponse Hash] response from the API call
38
+ # @return [ApiResponse] the complete http response with raw body and status code.
39
39
  def retrieve_employee(id:)
40
40
  warn 'Endpoint retrieve_employee in EmployeesApi is deprecated'
41
41
  new_api_call_builder
data/lib/square/api/events_api.rb CHANGED
@@ -5,7 +5,7 @@ module Square
5
5
  # @param [SearchEventsRequest] body Required parameter: An object containing
6
6
  # the fields to POST for the request. See the corresponding object
7
7
  # definition for field details.
8
- # @return [SearchEventsResponse Hash] response from the API call
8
+ # @return [ApiResponse] the complete http response with raw body and status code.
9
9
  def search_events(body:)
10
10
  new_api_call_builder
11
11
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -28,7 +28,7 @@ module Square
28
28
  # searchable.
29
29
  # Disabling events for a specific time period prevents them from being
30
30
  # searchable, even if you re-enable them later.
31
- # @return [DisableEventsResponse Hash] response from the API call
31
+ # @return [ApiResponse] the complete http response with raw body and status code.
32
32
  def disable_events
33
33
  new_api_call_builder
34
34
  .request(new_request_builder(HttpMethodEnum::PUT,
@@ -45,7 +45,7 @@ module Square
45
45
 
46
46
  # Enables events to make them searchable. Only events that occur while in
47
47
  # the enabled state are searchable.
48
- # @return [EnableEventsResponse Hash] response from the API call
48
+ # @return [ApiResponse] the complete http response with raw body and status code.
49
49
  def enable_events
50
50
  new_api_call_builder
51
51
  .request(new_request_builder(HttpMethodEnum::PUT,
@@ -65,7 +65,7 @@ module Square
65
65
  # @param [String] api_version Optional parameter: The API version for which
66
66
  # to list event types. Setting this field overrides the default version used
67
67
  # by the application.
68
- # @return [ListEventTypesResponse Hash] response from the API call
68
+ # @return [ApiResponse] the complete http response with raw body and status code.
69
69
  def list_event_types(api_version: nil)
70
70
  new_api_call_builder
71
71
  .request(new_request_builder(HttpMethodEnum::GET,
data/lib/square/api/gift_card_activities_api.rb CHANGED
@@ -41,7 +41,7 @@ module Square
41
41
  # @param [String] sort_order Optional parameter: The order in which the
42
42
  # endpoint returns the activities, based on `created_at`. - `ASC` - Oldest
43
43
  # to newest. - `DESC` - Newest to oldest (default).
44
- # @return [ListGiftCardActivitiesResponse Hash] response from the API call
44
+ # @return [ApiResponse] the complete http response with raw body and status code.
45
45
  def list_gift_card_activities(gift_card_id: nil,
46
46
  type: nil,
47
47
  location_id: nil,
@@ -78,7 +78,7 @@ module Square
78
78
  # @param [CreateGiftCardActivityRequest] body Required parameter: An object
79
79
  # containing the fields to POST for the request. See the corresponding
80
80
  # object definition for field details.
81
- # @return [CreateGiftCardActivityResponse Hash] response from the API call
81
+ # @return [ApiResponse] the complete http response with raw body and status code.
82
82
  def create_gift_card_activity(body:)
83
83
  new_api_call_builder
84
84
  .request(new_request_builder(HttpMethodEnum::POST,
data/lib/square/api/gift_cards_api.rb CHANGED
@@ -25,7 +25,7 @@ module Square
25
25
  # @param [String] customer_id Optional parameter: If a customer ID is
26
26
  # provided, the endpoint returns only the gift cards linked to the specified
27
27
  # customer.
28
- # @return [ListGiftCardsResponse Hash] response from the API call
28
+ # @return [ApiResponse] the complete http response with raw body and status code.
29
29
  def list_gift_cards(type: nil,
30
30
  state: nil,
31
31
  limit: nil,
@@ -61,7 +61,7 @@ module Square
61
61
  # @param [CreateGiftCardRequest] body Required parameter: An object
62
62
  # containing the fields to POST for the request. See the corresponding
63
63
  # object definition for field details.
64
- # @return [CreateGiftCardResponse Hash] response from the API call
64
+ # @return [ApiResponse] the complete http response with raw body and status code.
65
65
  def create_gift_card(body:)
66
66
  new_api_call_builder
67
67
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -83,7 +83,7 @@ module Square
83
83
  # @param [RetrieveGiftCardFromGANRequest] body Required parameter: An object
84
84
  # containing the fields to POST for the request. See the corresponding
85
85
  # object definition for field details.
86
- # @return [RetrieveGiftCardFromGANResponse Hash] response from the API call
86
+ # @return [ApiResponse] the complete http response with raw body and status code.
87
87
  def retrieve_gift_card_from_gan(body:)
88
88
  new_api_call_builder
89
89
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -106,7 +106,7 @@ module Square
106
106
  # @param [RetrieveGiftCardFromNonceRequest] body Required parameter: An
107
107
  # object containing the fields to POST for the request. See the
108
108
  # corresponding object definition for field details.
109
- # @return [RetrieveGiftCardFromNonceResponse Hash] response from the API call
109
+ # @return [ApiResponse] the complete http response with raw body and status code.
110
110
  def retrieve_gift_card_from_nonce(body:)
111
111
  new_api_call_builder
112
112
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -131,7 +131,7 @@ module Square
131
131
  # @param [LinkCustomerToGiftCardRequest] body Required parameter: An object
132
132
  # containing the fields to POST for the request. See the corresponding
133
133
  # object definition for field details.
134
- # @return [LinkCustomerToGiftCardResponse Hash] response from the API call
134
+ # @return [ApiResponse] the complete http response with raw body and status code.
135
135
  def link_customer_to_gift_card(gift_card_id:,
136
136
  body:)
137
137
  new_api_call_builder
@@ -159,7 +159,7 @@ module Square
159
159
  # @param [UnlinkCustomerFromGiftCardRequest] body Required parameter: An
160
160
  # object containing the fields to POST for the request. See the
161
161
  # corresponding object definition for field details.
162
- # @return [UnlinkCustomerFromGiftCardResponse Hash] response from the API call
162
+ # @return [ApiResponse] the complete http response with raw body and status code.
163
163
  def unlink_customer_from_gift_card(gift_card_id:,
164
164
  body:)
165
165
  new_api_call_builder
@@ -183,7 +183,7 @@ module Square
183
183
  # Retrieves a gift card using the gift card ID.
184
184
  # @param [String] id Required parameter: The ID of the gift card to
185
185
  # retrieve.
186
- # @return [RetrieveGiftCardResponse Hash] response from the API call
186
+ # @return [ApiResponse] the complete http response with raw body and status code.
187
187
  def retrieve_gift_card(id:)
188
188
  new_api_call_builder
189
189
  .request(new_request_builder(HttpMethodEnum::GET,
data/lib/square/api/inventory_api.rb CHANGED
@@ -7,7 +7,7 @@ module Square
7
7
  # is updated to conform to the standard convention.
8
8
  # @param [String] adjustment_id Required parameter: ID of the
9
9
  # [InventoryAdjustment](entity:InventoryAdjustment) to retrieve.
10
- # @return [RetrieveInventoryAdjustmentResponse Hash] response from the API call
10
+ # @return [ApiResponse] the complete http response with raw body and status code.
11
11
  def deprecated_retrieve_inventory_adjustment(adjustment_id:)
12
12
  warn 'Endpoint deprecated_retrieve_inventory_adjustment in InventoryApi '\
13
13
  'is deprecated'
@@ -30,7 +30,7 @@ module Square
30
30
  # with the provided `adjustment_id`.
31
31
  # @param [String] adjustment_id Required parameter: ID of the
32
32
  # [InventoryAdjustment](entity:InventoryAdjustment) to retrieve.
33
- # @return [RetrieveInventoryAdjustmentResponse Hash] response from the API call
33
+ # @return [ApiResponse] the complete http response with raw body and status code.
34
34
  def retrieve_inventory_adjustment(adjustment_id:)
35
35
  new_api_call_builder
36
36
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -54,7 +54,7 @@ module Square
54
54
  # @param [BatchChangeInventoryRequest] body Required parameter: An object
55
55
  # containing the fields to POST for the request. See the corresponding
56
56
  # object definition for field details.
57
- # @return [BatchChangeInventoryResponse Hash] response from the API call
57
+ # @return [ApiResponse] the complete http response with raw body and status code.
58
58
  def deprecated_batch_change_inventory(body:)
59
59
  warn 'Endpoint deprecated_batch_change_inventory in InventoryApi is depr'\
60
60
  'ecated'
@@ -81,7 +81,7 @@ module Square
81
81
  # @param [BatchRetrieveInventoryChangesRequest] body Required parameter: An
82
82
  # object containing the fields to POST for the request. See the
83
83
  # corresponding object definition for field details.
84
- # @return [BatchRetrieveInventoryChangesResponse Hash] response from the API call
84
+ # @return [ApiResponse] the complete http response with raw body and status code.
85
85
  def deprecated_batch_retrieve_inventory_changes(body:)
86
86
  warn 'Endpoint deprecated_batch_retrieve_inventory_changes in InventoryA'\
87
87
  'pi is deprecated'
@@ -108,7 +108,7 @@ module Square
108
108
  # @param [BatchRetrieveInventoryCountsRequest] body Required parameter: An
109
109
  # object containing the fields to POST for the request. See the
110
110
  # corresponding object definition for field details.
111
- # @return [BatchRetrieveInventoryCountsResponse Hash] response from the API call
111
+ # @return [ApiResponse] the complete http response with raw body and status code.
112
112
  def deprecated_batch_retrieve_inventory_counts(body:)
113
113
  warn 'Endpoint deprecated_batch_retrieve_inventory_counts in InventoryAp'\
114
114
  'i is deprecated'
@@ -135,7 +135,7 @@ module Square
135
135
  # @param [BatchChangeInventoryRequest] body Required parameter: An object
136
136
  # containing the fields to POST for the request. See the corresponding
137
137
  # object definition for field details.
138
- # @return [BatchChangeInventoryResponse Hash] response from the API call
138
+ # @return [ApiResponse] the complete http response with raw body and status code.
139
139
  def batch_change_inventory(body:)
140
140
  new_api_call_builder
141
141
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -162,7 +162,7 @@ module Square
162
162
  # @param [BatchRetrieveInventoryChangesRequest] body Required parameter: An
163
163
  # object containing the fields to POST for the request. See the
164
164
  # corresponding object definition for field details.
165
- # @return [BatchRetrieveInventoryChangesResponse Hash] response from the API call
165
+ # @return [ApiResponse] the complete http response with raw body and status code.
166
166
  def batch_retrieve_inventory_changes(body:)
167
167
  new_api_call_builder
168
168
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -193,7 +193,7 @@ module Square
193
193
  # @param [BatchRetrieveInventoryCountsRequest] body Required parameter: An
194
194
  # object containing the fields to POST for the request. See the
195
195
  # corresponding object definition for field details.
196
- # @return [BatchRetrieveInventoryCountsResponse Hash] response from the API call
196
+ # @return [ApiResponse] the complete http response with raw body and status code.
197
197
  def batch_retrieve_inventory_counts(body:)
198
198
  new_api_call_builder
199
199
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -217,7 +217,7 @@ module Square
217
217
  # is updated to conform to the standard convention.
218
218
  # @param [String] physical_count_id Required parameter: ID of the
219
219
  # [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve.
220
- # @return [RetrieveInventoryPhysicalCountResponse Hash] response from the API call
220
+ # @return [ApiResponse] the complete http response with raw body and status code.
221
221
  def deprecated_retrieve_inventory_physical_count(physical_count_id:)
222
222
  warn 'Endpoint deprecated_retrieve_inventory_physical_count in Inventory'\
223
223
  'Api is deprecated'
@@ -240,7 +240,7 @@ module Square
240
240
  # object with the provided `physical_count_id`.
241
241
  # @param [String] physical_count_id Required parameter: ID of the
242
242
  # [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve.
243
- # @return [RetrieveInventoryPhysicalCountResponse Hash] response from the API call
243
+ # @return [ApiResponse] the complete http response with raw body and status code.
244
244
  def retrieve_inventory_physical_count(physical_count_id:)
245
245
  new_api_call_builder
246
246
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -261,7 +261,7 @@ module Square
261
261
  # with the provided `transfer_id`.
262
262
  # @param [String] transfer_id Required parameter: ID of the
263
263
  # [InventoryTransfer](entity:InventoryTransfer) to retrieve.
264
- # @return [RetrieveInventoryTransferResponse Hash] response from the API call
264
+ # @return [ApiResponse] the complete http response with raw body and status code.
265
265
  def retrieve_inventory_transfer(transfer_id:)
266
266
  new_api_call_builder
267
267
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -292,7 +292,7 @@ module Square
292
292
  # results for the original query. See the
293
293
  # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
294
294
  # ion) guide for more information.
295
- # @return [RetrieveInventoryCountResponse Hash] response from the API call
295
+ # @return [ApiResponse] the complete http response with raw body and status code.
296
296
  def retrieve_inventory_count(catalog_object_id:,
297
297
  location_ids: nil,
298
298
  cursor: nil)
@@ -337,7 +337,7 @@ module Square
337
337
  # results for the original query. See the
338
338
  # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
339
339
  # ion) guide for more information.
340
- # @return [RetrieveInventoryChangesResponse Hash] response from the API call
340
+ # @return [ApiResponse] the complete http response with raw body and status code.
341
341
  def retrieve_inventory_changes(catalog_object_id:,
342
342
  location_ids: nil,
343
343
  cursor: nil)