square.rb 39.0.0.20240821 → 39.1.0.20240919

Sign up to get free protection for your applications and to get access to all the features.
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/mobile_authorization_api.rb CHANGED
@@ -17,7 +17,7 @@ module Square
17
17
  # @param [CreateMobileAuthorizationCodeRequest] body Required parameter: An
18
18
  # object containing the fields to POST for the request. See the
19
19
  # corresponding object definition for field details.
20
- # @return [CreateMobileAuthorizationCodeResponse Hash] response from the API call
20
+ # @return [ApiResponse] the complete http response with raw body and status code.
21
21
  def create_mobile_authorization_code(body:)
22
22
  new_api_call_builder
23
23
  .request(new_request_builder(HttpMethodEnum::POST,
data/lib/square/api/o_auth_api.rb CHANGED
@@ -17,7 +17,7 @@ module Square
17
17
  # definition for field details.
18
18
  # @param [String] authorization Required parameter: Client
19
19
  # APPLICATION_SECRET
20
- # @return [RevokeTokenResponse Hash] response from the API call
20
+ # @return [ApiResponse] the complete http response with raw body and status code.
21
21
  def revoke_token(body:,
22
22
  authorization:)
23
23
  new_api_call_builder
@@ -55,7 +55,7 @@ module Square
55
55
  # @param [ObtainTokenRequest] body Required parameter: An object containing
56
56
  # the fields to POST for the request. See the corresponding object
57
57
  # definition for field details.
58
- # @return [ObtainTokenResponse Hash] response from the API call
58
+ # @return [ApiResponse] the complete http response with raw body and status code.
59
59
  def obtain_token(body:)
60
60
  new_api_call_builder
61
61
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -89,7 +89,7 @@ module Square
89
89
  # ).
90
90
  # If the access token is expired or not a valid access token, the endpoint
91
91
  # returns an `UNAUTHORIZED` error.
92
- # @return [RetrieveTokenStatusResponse Hash] response from the API call
92
+ # @return [ApiResponse] the complete http response with raw body and status code.
93
93
  def retrieve_token_status
94
94
  new_api_call_builder
95
95
  .request(new_request_builder(HttpMethodEnum::POST,
data/lib/square/api/order_custom_attributes_api.rb CHANGED
@@ -28,7 +28,7 @@ module Square
28
28
  # see
29
29
  # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
30
30
  # ion).
31
- # @return [ListOrderCustomAttributeDefinitionsResponse Hash] response from the API call
31
+ # @return [ApiResponse] the complete http response with raw body and status code.
32
32
  def list_order_custom_attribute_definitions(visibility_filter: nil,
33
33
  cursor: nil,
34
34
  limit: nil)
@@ -57,7 +57,7 @@ module Square
57
57
  # @param [CreateOrderCustomAttributeDefinitionRequest] body Required
58
58
  # parameter: An object containing the fields to POST for the request. See
59
59
  # the corresponding object definition for field details.
60
- # @return [CreateOrderCustomAttributeDefinitionResponse Hash] response from the API call
60
+ # @return [ApiResponse] the complete http response with raw body and status code.
61
61
  def create_order_custom_attribute_definition(body:)
62
62
  new_api_call_builder
63
63
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -80,7 +80,7 @@ module Square
80
80
  # Only the definition owner can delete a custom attribute definition.
81
81
  # @param [String] key Required parameter: The key of the custom attribute
82
82
  # definition to delete.
83
- # @return [DeleteOrderCustomAttributeDefinitionResponse Hash] response from the API call
83
+ # @return [ApiResponse] the complete http response with raw body and status code.
84
84
  def delete_order_custom_attribute_definition(key:)
85
85
  new_api_call_builder
86
86
  .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -111,7 +111,7 @@ module Square
111
111
  # concurrency](https://developer.squareup.com/docs/build-basics/common-api-p
112
112
  # atterns/optimistic-concurrency) control, include this optional field and
113
113
  # specify the current version of the custom attribute.
114
- # @return [RetrieveOrderCustomAttributeDefinitionResponse Hash] response from the API call
114
+ # @return [ApiResponse] the complete http response with raw body and status code.
115
115
  def retrieve_order_custom_attribute_definition(key:,
116
116
  version: nil)
117
117
  new_api_call_builder
@@ -140,7 +140,7 @@ module Square
140
140
  # @param [UpdateOrderCustomAttributeDefinitionRequest] body Required
141
141
  # parameter: An object containing the fields to POST for the request. See
142
142
  # the corresponding object definition for field details.
143
- # @return [UpdateOrderCustomAttributeDefinitionResponse Hash] response from the API call
143
+ # @return [ApiResponse] the complete http response with raw body and status code.
144
144
  def update_order_custom_attribute_definition(key:,
145
145
  body:)
146
146
  new_api_call_builder
@@ -185,7 +185,7 @@ module Square
185
185
  # @param [BulkDeleteOrderCustomAttributesRequest] body Required parameter:
186
186
  # An object containing the fields to POST for the request. See the
187
187
  # corresponding object definition for field details.
188
- # @return [BulkDeleteOrderCustomAttributesResponse Hash] response from the API call
188
+ # @return [ApiResponse] the complete http response with raw body and status code.
189
189
  def bulk_delete_order_custom_attributes(body:)
190
190
  new_api_call_builder
191
191
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -228,7 +228,7 @@ module Square
228
228
  # @param [BulkUpsertOrderCustomAttributesRequest] body Required parameter:
229
229
  # An object containing the fields to POST for the request. See the
230
230
  # corresponding object definition for field details.
231
- # @return [BulkUpsertOrderCustomAttributesResponse Hash] response from the API call
231
+ # @return [ApiResponse] the complete http response with raw body and status code.
232
232
  def bulk_upsert_order_custom_attributes(body:)
233
233
  new_api_call_builder
234
234
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -280,7 +280,7 @@ module Square
280
280
  # each custom attribute. Set this parameter to `true` to get the name and
281
281
  # description of each custom attribute, information about the data type, or
282
282
  # other definition details. The default value is `false`.
283
- # @return [ListOrderCustomAttributesResponse Hash] response from the API call
283
+ # @return [ApiResponse] the complete http response with raw body and status code.
284
284
  def list_order_custom_attributes(order_id:,
285
285
  visibility_filter: nil,
286
286
  cursor: nil,
@@ -317,7 +317,7 @@ module Square
317
317
  # @param [String] custom_attribute_key Required parameter: The key of the
318
318
  # custom attribute to delete. This key must match the key of an existing
319
319
  # custom attribute definition.
320
- # @return [DeleteOrderCustomAttributeResponse Hash] response from the API call
320
+ # @return [ApiResponse] the complete http response with raw body and status code.
321
321
  def delete_order_custom_attribute(order_id:,
322
322
  custom_attribute_key:)
323
323
  new_api_call_builder
@@ -363,7 +363,7 @@ module Square
363
363
  # each custom attribute. Set this parameter to `true` to get the name and
364
364
  # description of each custom attribute, information about the data type, or
365
365
  # other definition details. The default value is `false`.
366
- # @return [RetrieveOrderCustomAttributeResponse Hash] response from the API call
366
+ # @return [ApiResponse] the complete http response with raw body and status code.
367
367
  def retrieve_order_custom_attribute(order_id:,
368
368
  custom_attribute_key:,
369
369
  version: nil,
@@ -409,7 +409,7 @@ module Square
409
409
  # @param [UpsertOrderCustomAttributeRequest] body Required parameter: An
410
410
  # object containing the fields to POST for the request. See the
411
411
  # corresponding object definition for field details.
412
- # @return [UpsertOrderCustomAttributeResponse Hash] response from the API call
412
+ # @return [ApiResponse] the complete http response with raw body and status code.
413
413
  def upsert_order_custom_attribute(order_id:,
414
414
  custom_attribute_key:,
415
415
  body:)
data/lib/square/api/orders_api.rb CHANGED
@@ -12,7 +12,7 @@ module Square
12
12
  # @param [CreateOrderRequest] body Required parameter: An object containing
13
13
  # the fields to POST for the request. See the corresponding object
14
14
  # definition for field details.
15
- # @return [CreateOrderResponse Hash] response from the API call
15
+ # @return [ApiResponse] the complete http response with raw body and status code.
16
16
  def create_order(body:)
17
17
  new_api_call_builder
18
18
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -36,7 +36,7 @@ module Square
36
36
  # @param [BatchRetrieveOrdersRequest] body Required parameter: An object
37
37
  # containing the fields to POST for the request. See the corresponding
38
38
  # object definition for field details.
39
- # @return [BatchRetrieveOrdersResponse Hash] response from the API call
39
+ # @return [ApiResponse] the complete http response with raw body and status code.
40
40
  def batch_retrieve_orders(body:)
41
41
  new_api_call_builder
42
42
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -58,7 +58,7 @@ module Square
58
58
  # @param [CalculateOrderRequest] body Required parameter: An object
59
59
  # containing the fields to POST for the request. See the corresponding
60
60
  # object definition for field details.
61
- # @return [CalculateOrderResponse Hash] response from the API call
61
+ # @return [ApiResponse] the complete http response with raw body and status code.
62
62
  def calculate_order(body:)
63
63
  new_api_call_builder
64
64
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -83,7 +83,7 @@ module Square
83
83
  # @param [CloneOrderRequest] body Required parameter: An object containing
84
84
  # the fields to POST for the request. See the corresponding object
85
85
  # definition for field details.
86
- # @return [CloneOrderResponse Hash] response from the API call
86
+ # @return [ApiResponse] the complete http response with raw body and status code.
87
87
  def clone_order(body:)
88
88
  new_api_call_builder
89
89
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -121,7 +121,7 @@ module Square
121
121
  # @param [SearchOrdersRequest] body Required parameter: An object containing
122
122
  # the fields to POST for the request. See the corresponding object
123
123
  # definition for field details.
124
- # @return [SearchOrdersResponse Hash] response from the API call
124
+ # @return [ApiResponse] the complete http response with raw body and status code.
125
125
  def search_orders(body:)
126
126
  new_api_call_builder
127
127
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -142,7 +142,7 @@ module Square
142
142
  # Retrieves an [Order]($m/Order) by ID.
143
143
  # @param [String] order_id Required parameter: The ID of the order to
144
144
  # retrieve.
145
- # @return [RetrieveOrderResponse Hash] response from the API call
145
+ # @return [ApiResponse] the complete http response with raw body and status code.
146
146
  def retrieve_order(order_id:)
147
147
  new_api_call_builder
148
148
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -182,7 +182,7 @@ module Square
182
182
  # @param [UpdateOrderRequest] body Required parameter: An object containing
183
183
  # the fields to POST for the request. See the corresponding object
184
184
  # definition for field details.
185
- # @return [UpdateOrderResponse Hash] response from the API call
185
+ # @return [ApiResponse] the complete http response with raw body and status code.
186
186
  def update_order(order_id:,
187
187
  body:)
188
188
  new_api_call_builder
@@ -227,7 +227,7 @@ module Square
227
227
  # @param [PayOrderRequest] body Required parameter: An object containing the
228
228
  # fields to POST for the request. See the corresponding object definition
229
229
  # for field details.
230
- # @return [PayOrderResponse Hash] response from the API call
230
+ # @return [ApiResponse] the complete http response with raw body and status code.
231
231
  def pay_order(order_id:,
232
232
  body:)
233
233
  new_api_call_builder
data/lib/square/api/payments_api.rb CHANGED
@@ -53,7 +53,7 @@ module Square
53
53
  # set, payments without a value set in
54
54
  # `offline_payment_details.client_created_at` will not be returned.
55
55
  # Default: The current time.
56
- # @return [ListPaymentsResponse Hash] response from the API call
56
+ # @return [ApiResponse] the complete http response with raw body and status code.
57
57
  def list_payments(begin_time: nil,
58
58
  end_time: nil,
59
59
  sort_order: nil,
@@ -102,7 +102,7 @@ module Square
102
102
  # @param [CreatePaymentRequest] body Required parameter: An object
103
103
  # containing the fields to POST for the request. See the corresponding
104
104
  # object definition for field details.
105
- # @return [CreatePaymentResponse Hash] response from the API call
105
+ # @return [ApiResponse] the complete http response with raw body and status code.
106
106
  def create_payment(body:)
107
107
  new_api_call_builder
108
108
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -138,7 +138,7 @@ module Square
138
138
  # @param [CancelPaymentByIdempotencyKeyRequest] body Required parameter: An
139
139
  # object containing the fields to POST for the request. See the
140
140
  # corresponding object definition for field details.
141
- # @return [CancelPaymentByIdempotencyKeyResponse Hash] response from the API call
141
+ # @return [ApiResponse] the complete http response with raw body and status code.
142
142
  def cancel_payment_by_idempotency_key(body:)
143
143
  new_api_call_builder
144
144
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -159,7 +159,7 @@ module Square
159
159
  # Retrieves details for a specific payment.
160
160
  # @param [String] payment_id Required parameter: A unique ID for the desired
161
161
  # payment.
162
- # @return [GetPaymentResponse Hash] response from the API call
162
+ # @return [ApiResponse] the complete http response with raw body and status code.
163
163
  def get_payment(payment_id:)
164
164
  new_api_call_builder
165
165
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -183,7 +183,7 @@ module Square
183
183
  # @param [UpdatePaymentRequest] body Required parameter: An object
184
184
  # containing the fields to POST for the request. See the corresponding
185
185
  # object definition for field details.
186
- # @return [UpdatePaymentResponse Hash] response from the API call
186
+ # @return [ApiResponse] the complete http response with raw body and status code.
187
187
  def update_payment(payment_id:,
188
188
  body:)
189
189
  new_api_call_builder
@@ -209,7 +209,7 @@ module Square
209
209
  # the APPROVED `status`.
210
210
  # @param [String] payment_id Required parameter: The ID of the payment to
211
211
  # cancel.
212
- # @return [CancelPaymentResponse Hash] response from the API call
212
+ # @return [ApiResponse] the complete http response with raw body and status code.
213
213
  def cancel_payment(payment_id:)
214
214
  new_api_call_builder
215
215
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -236,7 +236,7 @@ module Square
236
236
  # @param [CompletePaymentRequest] body Required parameter: An object
237
237
  # containing the fields to POST for the request. See the corresponding
238
238
  # object definition for field details.
239
- # @return [CompletePaymentResponse Hash] response from the API call
239
+ # @return [ApiResponse] the complete http response with raw body and status code.
240
240
  def complete_payment(payment_id:,
241
241
  body:)
242
242
  new_api_call_builder
data/lib/square/api/payouts_api.rb CHANGED
@@ -28,7 +28,7 @@ module Square
28
28
  # than the specified limit on a given page. The default value of 100 is also
29
29
  # the maximum allowed value. If the provided value is greater than 100, it
30
30
  # is ignored and the default value is used instead. Default: `100`
31
- # @return [ListPayoutsResponse Hash] response from the API call
31
+ # @return [ApiResponse] the complete http response with raw body and status code.
32
32
  def list_payouts(location_id: nil,
33
33
  status: nil,
34
34
  begin_time: nil,
@@ -60,7 +60,7 @@ module Square
60
60
  # To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.
61
61
  # @param [String] payout_id Required parameter: The ID of the payout to
62
62
  # retrieve the information for.
63
- # @return [GetPayoutResponse Hash] response from the API call
63
+ # @return [ApiResponse] the complete http response with raw body and status code.
64
64
  def get_payout(payout_id:)
65
65
  new_api_call_builder
66
66
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -94,7 +94,7 @@ module Square
94
94
  # than the specified limit on a given page. The default value of 100 is also
95
95
  # the maximum allowed value. If the provided value is greater than 100, it
96
96
  # is ignored and the default value is used instead. Default: `100`
97
- # @return [ListPayoutEntriesResponse Hash] response from the API call
97
+ # @return [ApiResponse] the complete http response with raw body and status code.
98
98
  def list_payout_entries(payout_id:,
99
99
  sort_order: nil,
100
100
  cursor: nil,
data/lib/square/api/refunds_api.rb CHANGED
@@ -40,7 +40,7 @@ module Square
40
40
  # to be returned in a single page. It is possible to receive fewer results
41
41
  # than the specified limit on a given page. If the supplied value is
42
42
  # greater than 100, no more than 100 results are returned. Default: 100
43
- # @return [ListPaymentRefundsResponse Hash] response from the API call
43
+ # @return [ApiResponse] the complete http response with raw body and status code.
44
44
  def list_payment_refunds(begin_time: nil,
45
45
  end_time: nil,
46
46
  sort_order: nil,
@@ -80,7 +80,7 @@ module Square
80
80
  # @param [RefundPaymentRequest] 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 [RefundPaymentResponse Hash] response from the API call
83
+ # @return [ApiResponse] the complete http response with raw body and status code.
84
84
  def refund_payment(body:)
85
85
  new_api_call_builder
86
86
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -101,7 +101,7 @@ module Square
101
101
  # Retrieves a specific refund using the `refund_id`.
102
102
  # @param [String] refund_id Required parameter: The unique ID for the
103
103
  # desired `PaymentRefund`.
104
- # @return [GetPaymentRefundResponse Hash] response from the API call
104
+ # @return [ApiResponse] the complete http response with raw body and status code.
105
105
  def get_payment_refund(refund_id:)
106
106
  new_api_call_builder
107
107
  .request(new_request_builder(HttpMethodEnum::GET,
data/lib/square/api/sites_api.rb CHANGED
@@ -8,7 +8,7 @@ module Square
8
8
  # Online
9
9
  # APIs](https://developer.squareup.com/docs/online-api#early-access-program-
10
10
  # for-square-online-apis).
11
- # @return [ListSitesResponse Hash] response from the API call
11
+ # @return [ApiResponse] the complete http response with raw body and status code.
12
12
  def list_sites
13
13
  new_api_call_builder
14
14
  .request(new_request_builder(HttpMethodEnum::GET,
data/lib/square/api/snippets_api.rb CHANGED
@@ -11,7 +11,7 @@ module Square
11
11
  # for-square-online-apis).
12
12
  # @param [String] site_id Required parameter: The ID of the site that
13
13
  # contains the snippet.
14
- # @return [DeleteSnippetResponse Hash] response from the API call
14
+ # @return [ApiResponse] the complete http response with raw body and status code.
15
15
  def delete_snippet(site_id:)
16
16
  new_api_call_builder
17
17
  .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -40,7 +40,7 @@ module Square
40
40
  # for-square-online-apis).
41
41
  # @param [String] site_id Required parameter: The ID of the site that
42
42
  # contains the snippet.
43
- # @return [RetrieveSnippetResponse Hash] response from the API call
43
+ # @return [ApiResponse] the complete http response with raw body and status code.
44
44
  def retrieve_snippet(site_id:)
45
45
  new_api_call_builder
46
46
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -74,7 +74,7 @@ module Square
74
74
  # @param [UpsertSnippetRequest] body Required parameter: An object
75
75
  # containing the fields to POST for the request. See the corresponding
76
76
  # object definition for field details.
77
- # @return [UpsertSnippetResponse Hash] response from the API call
77
+ # @return [ApiResponse] the complete http response with raw body and status code.
78
78
  def upsert_snippet(site_id:,
79
79
  body:)
80
80
  new_api_call_builder
data/lib/square/api/subscriptions_api.rb CHANGED
@@ -14,7 +14,7 @@ module Square
14
14
  # @param [CreateSubscriptionRequest] body Required parameter: An object
15
15
  # containing the fields to POST for the request. See the corresponding
16
16
  # object definition for field details.
17
- # @return [CreateSubscriptionResponse Hash] response from the API call
17
+ # @return [ApiResponse] the complete http response with raw body and status code.
18
18
  def create_subscription(body:)
19
19
  new_api_call_builder
20
20
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -40,7 +40,7 @@ module Square
40
40
  # @param [BulkSwapPlanRequest] body Required parameter: An object containing
41
41
  # the fields to POST for the request. See the corresponding object
42
42
  # definition for field details.
43
- # @return [BulkSwapPlanResponse Hash] response from the API call
43
+ # @return [ApiResponse] the complete http response with raw body and status code.
44
44
  def bulk_swap_plan(body:)
45
45
  new_api_call_builder
46
46
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -74,7 +74,7 @@ module Square
74
74
  # @param [SearchSubscriptionsRequest] body Required parameter: An object
75
75
  # containing the fields to POST for the request. See the corresponding
76
76
  # object definition for field details.
77
- # @return [SearchSubscriptionsResponse Hash] response from the API call
77
+ # @return [ApiResponse] the complete http response with raw body and status code.
78
78
  def search_subscriptions(body:)
79
79
  new_api_call_builder
80
80
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -99,7 +99,7 @@ module Square
99
99
  # related information to be included in the response. The supported query
100
100
  # parameter values are: - `actions`: to include scheduled actions on the
101
101
  # targeted subscription.
102
- # @return [RetrieveSubscriptionResponse Hash] response from the API call
102
+ # @return [ApiResponse] the complete http response with raw body and status code.
103
103
  def retrieve_subscription(subscription_id:,
104
104
  include: nil)
105
105
  new_api_call_builder
@@ -126,7 +126,7 @@ module Square
126
126
  # @param [UpdateSubscriptionRequest] body Required parameter: An object
127
127
  # containing the fields to POST for the request. See the corresponding
128
128
  # object definition for field details.
129
- # @return [UpdateSubscriptionResponse Hash] response from the API call
129
+ # @return [ApiResponse] the complete http response with raw body and status code.
130
130
  def update_subscription(subscription_id:,
131
131
  body:)
132
132
  new_api_call_builder
@@ -152,7 +152,7 @@ module Square
152
152
  # subscription the targeted action is to act upon.
153
153
  # @param [String] action_id Required parameter: The ID of the targeted
154
154
  # action to be deleted.
155
- # @return [DeleteSubscriptionActionResponse Hash] response from the API call
155
+ # @return [ApiResponse] the complete http response with raw body and status code.
156
156
  def delete_subscription_action(subscription_id:,
157
157
  action_id:)
158
158
  new_api_call_builder
@@ -181,7 +181,7 @@ module Square
181
181
  # @param [ChangeBillingAnchorDateRequest] body Required parameter: An object
182
182
  # containing the fields to POST for the request. See the corresponding
183
183
  # object definition for field details.
184
- # @return [ChangeBillingAnchorDateResponse Hash] response from the API call
184
+ # @return [ApiResponse] the complete http response with raw body and status code.
185
185
  def change_billing_anchor_date(subscription_id:,
186
186
  body:)
187
187
  new_api_call_builder
@@ -208,7 +208,7 @@ module Square
208
208
  # the subscription status changes from ACTIVE to CANCELED.
209
209
  # @param [String] subscription_id Required parameter: The ID of the
210
210
  # subscription to cancel.
211
- # @return [CancelSubscriptionResponse Hash] response from the API call
211
+ # @return [ApiResponse] the complete http response with raw body and status code.
212
212
  def cancel_subscription(subscription_id:)
213
213
  new_api_call_builder
214
214
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -239,7 +239,7 @@ module Square
239
239
  # atterns/pagination).
240
240
  # @param [Integer] limit Optional parameter: The upper limit on the number
241
241
  # of subscription events to return in a paged response.
242
- # @return [ListSubscriptionEventsResponse Hash] response from the API call
242
+ # @return [ApiResponse] the complete http response with raw body and status code.
243
243
  def list_subscription_events(subscription_id:,
244
244
  cursor: nil,
245
245
  limit: nil)
@@ -266,7 +266,7 @@ module Square
266
266
  # @param [PauseSubscriptionRequest] body Required parameter: An object
267
267
  # containing the fields to POST for the request. See the corresponding
268
268
  # object definition for field details.
269
- # @return [PauseSubscriptionResponse Hash] response from the API call
269
+ # @return [ApiResponse] the complete http response with raw body and status code.
270
270
  def pause_subscription(subscription_id:,
271
271
  body:)
272
272
  new_api_call_builder
@@ -294,7 +294,7 @@ module Square
294
294
  # @param [ResumeSubscriptionRequest] body Required parameter: An object
295
295
  # containing the fields to POST for the request. See the corresponding
296
296
  # object definition for field details.
297
- # @return [ResumeSubscriptionResponse Hash] response from the API call
297
+ # @return [ApiResponse] the complete http response with raw body and status code.
298
298
  def resume_subscription(subscription_id:,
299
299
  body:)
300
300
  new_api_call_builder
@@ -325,7 +325,7 @@ module Square
325
325
  # @param [SwapPlanRequest] body Required parameter: An object containing the
326
326
  # fields to POST for the request. See the corresponding object definition
327
327
  # for field details.
328
- # @return [SwapPlanResponse Hash] response from the API call
328
+ # @return [ApiResponse] the complete http response with raw body and status code.
329
329
  def swap_plan(subscription_id:,
330
330
  body:)
331
331
  new_api_call_builder
data/lib/square/api/team_api.rb CHANGED
@@ -12,7 +12,7 @@ module Square
12
12
  # @param [CreateTeamMemberRequest] body Required parameter: An object
13
13
  # containing the fields to POST for the request. See the corresponding
14
14
  # object definition for field details.
15
- # @return [CreateTeamMemberResponse Hash] response from the API call
15
+ # @return [ApiResponse] the complete http response with raw body and status code.
16
16
  def create_team_member(body:)
17
17
  new_api_call_builder
18
18
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -43,7 +43,7 @@ module Square
43
43
  # @param [BulkCreateTeamMembersRequest] body Required parameter: An object
44
44
  # containing the fields to POST for the request. See the corresponding
45
45
  # object definition for field details.
46
- # @return [BulkCreateTeamMembersResponse Hash] response from the API call
46
+ # @return [ApiResponse] the complete http response with raw body and status code.
47
47
  def bulk_create_team_members(body:)
48
48
  new_api_call_builder
49
49
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -74,7 +74,7 @@ module Square
74
74
  # @param [BulkUpdateTeamMembersRequest] body Required parameter: An object
75
75
  # containing the fields to POST for the request. See the corresponding
76
76
  # object definition for field details.
77
- # @return [BulkUpdateTeamMembersResponse Hash] response from the API call
77
+ # @return [ApiResponse] the complete http response with raw body and status code.
78
78
  def bulk_update_team_members(body:)
79
79
  new_api_call_builder
80
80
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -99,7 +99,7 @@ module Square
99
99
  # @param [SearchTeamMembersRequest] body Required parameter: An object
100
100
  # containing the fields to POST for the request. See the corresponding
101
101
  # object definition for field details.
102
- # @return [SearchTeamMembersResponse Hash] response from the API call
102
+ # @return [ApiResponse] the complete http response with raw body and status code.
103
103
  def search_team_members(body:)
104
104
  new_api_call_builder
105
105
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -123,7 +123,7 @@ module Square
123
123
  # eam-member).
124
124
  # @param [String] team_member_id Required parameter: The ID of the team
125
125
  # member to retrieve.
126
- # @return [RetrieveTeamMemberResponse Hash] response from the API call
126
+ # @return [ApiResponse] the complete http response with raw body and status code.
127
127
  def retrieve_team_member(team_member_id:)
128
128
  new_api_call_builder
129
129
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -150,7 +150,7 @@ module Square
150
150
  # @param [UpdateTeamMemberRequest] body Required parameter: An object
151
151
  # containing the fields to POST for the request. See the corresponding
152
152
  # object definition for field details.
153
- # @return [UpdateTeamMemberResponse Hash] response from the API call
153
+ # @return [ApiResponse] the complete http response with raw body and status code.
154
154
  def update_team_member(team_member_id:,
155
155
  body:)
156
156
  new_api_call_builder
@@ -178,7 +178,7 @@ module Square
178
178
  # setting).
179
179
  # @param [String] team_member_id Required parameter: The ID of the team
180
180
  # member for which to retrieve the wage setting.
181
- # @return [RetrieveWageSettingResponse Hash] response from the API call
181
+ # @return [ApiResponse] the complete http response with raw body and status code.
182
182
  def retrieve_wage_setting(team_member_id:)
183
183
  new_api_call_builder
184
184
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -208,7 +208,7 @@ module Square
208
208
  # @param [UpdateWageSettingRequest] body Required parameter: An object
209
209
  # containing the fields to POST for the request. See the corresponding
210
210
  # object definition for field details.
211
- # @return [UpdateWageSettingResponse Hash] response from the API call
211
+ # @return [ApiResponse] the complete http response with raw body and status code.
212
212
  def update_wage_setting(team_member_id:,
213
213
  body:)
214
214
  new_api_call_builder