square.rb 8.0.0.20201216 → 26.1.0.20230119

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 (59) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +79 -221
  4. data/lib/square/api/apple_pay_api.rb +15 -8
  5. data/lib/square/api/bank_accounts_api.rb +5 -5
  6. data/lib/square/api/base_api.rb +27 -9
  7. data/lib/square/api/booking_custom_attributes_api.rb +555 -0
  8. data/lib/square/api/bookings_api.rb +107 -15
  9. data/lib/square/api/cards_api.rb +171 -0
  10. data/lib/square/api/cash_drawers_api.rb +2 -2
  11. data/lib/square/api/catalog_api.rb +167 -73
  12. data/lib/square/api/checkout_api.rb +205 -3
  13. data/lib/square/api/customer_custom_attributes_api.rb +561 -0
  14. data/lib/square/api/customer_groups_api.rb +17 -8
  15. data/lib/square/api/customer_segments_api.rb +15 -6
  16. data/lib/square/api/customers_api.rb +67 -33
  17. data/lib/square/api/devices_api.rb +3 -2
  18. data/lib/square/api/disputes_api.rb +109 -105
  19. data/lib/square/api/gift_card_activities_api.rb +132 -0
  20. data/lib/square/api/gift_cards_api.rb +298 -0
  21. data/lib/square/api/inventory_api.rb +263 -24
  22. data/lib/square/api/invoices_api.rb +21 -21
  23. data/lib/square/api/labor_api.rb +70 -68
  24. data/lib/square/api/location_custom_attributes_api.rb +584 -0
  25. data/lib/square/api/locations_api.rb +21 -14
  26. data/lib/square/api/loyalty_api.rb +333 -50
  27. data/lib/square/api/merchants_api.rb +11 -9
  28. data/lib/square/api/mobile_authorization_api.rb +4 -4
  29. data/lib/square/api/o_auth_api.rb +78 -25
  30. data/lib/square/api/order_custom_attributes_api.rb +601 -0
  31. data/lib/square/api/orders_api.rb +84 -45
  32. data/lib/square/api/payments_api.rb +72 -24
  33. data/lib/square/api/payouts_api.rb +173 -0
  34. data/lib/square/api/refunds_api.rb +18 -7
  35. data/lib/square/api/sites_api.rb +43 -0
  36. data/lib/square/api/snippets_api.rb +146 -0
  37. data/lib/square/api/subscriptions_api.rb +190 -15
  38. data/lib/square/api/team_api.rb +46 -46
  39. data/lib/square/api/terminal_api.rb +172 -22
  40. data/lib/square/api/transactions_api.rb +15 -191
  41. data/lib/square/api/v1_transactions_api.rb +52 -124
  42. data/lib/square/api/vendors_api.rb +257 -0
  43. data/lib/square/api/webhook_subscriptions_api.rb +327 -0
  44. data/lib/square/api_helper.rb +217 -57
  45. data/lib/square/client.rb +90 -18
  46. data/lib/square/configuration.rb +64 -20
  47. data/lib/square/exceptions/validation_exception.rb +13 -0
  48. data/lib/square/http/api_response.rb +7 -9
  49. data/lib/square/http/faraday_client.rb +40 -9
  50. data/lib/square/http/http_client.rb +31 -12
  51. data/lib/square/http/http_request.rb +6 -2
  52. data/lib/square/utilities/date_time_helper.rb +151 -0
  53. data/lib/square/utilities/file_wrapper.rb +1 -2
  54. data/lib/square.rb +56 -44
  55. data/test/api/test_locations_api.rb +2 -5
  56. data/test/test_helper.rb +2 -2
  57. metadata +83 -15
  58. data/lib/square/api/v1_employees_api.rb +0 -751
  59. data/lib/square/api/v1_items_api.rb +0 -1766
data/lib/square.rb CHANGED
@@ -4,58 +4,70 @@ require 'faraday'
4
4
  require 'certifi'
5
5
  require 'logging'
6
6
 
7
- require_relative 'square/api_helper.rb'
8
- require_relative 'square/client.rb'
7
+ require_relative 'square/api_helper'
8
+ require_relative 'square/client'
9
9
 
10
10
  # Utilities
11
- require_relative 'square/utilities/file_wrapper.rb'
11
+ require_relative 'square/utilities/file_wrapper'
12
+ require_relative 'square/utilities/date_time_helper'
12
13
 
13
14
  # Http
14
- require_relative 'square/http/api_response.rb'
15
- require_relative 'square/http/http_call_back.rb'
16
- require_relative 'square/http/http_client.rb'
17
- require_relative 'square/http/faraday_client.rb'
18
- require_relative 'square/http/http_method_enum.rb'
19
- require_relative 'square/http/http_request.rb'
20
- require_relative 'square/http/http_response.rb'
21
- require_relative 'square/http/auth/o_auth2.rb'
15
+ require_relative 'square/http/api_response'
16
+ require_relative 'square/http/http_call_back'
17
+ require_relative 'square/http/http_client'
18
+ require_relative 'square/http/faraday_client'
19
+ require_relative 'square/http/http_method_enum'
20
+ require_relative 'square/http/http_request'
21
+ require_relative 'square/http/http_response'
22
+ require_relative 'square/http/auth/o_auth2'
22
23
 
23
24
  # Models
24
25
 
25
26
  # Exceptions
26
- require_relative 'square/exceptions/api_exception.rb'
27
+ require_relative 'square/exceptions/api_exception'
28
+ require_relative 'square/exceptions/validation_exception'
27
29
 
28
- require_relative 'square/configuration.rb'
30
+ require_relative 'square/configuration'
29
31
 
30
32
  # Controllers
31
- require_relative 'square/api/base_api.rb'
32
- require_relative 'square/api/mobile_authorization_api.rb'
33
- require_relative 'square/api/o_auth_api.rb'
34
- require_relative 'square/api/v1_employees_api.rb'
35
- require_relative 'square/api/v1_transactions_api.rb'
36
- require_relative 'square/api/v1_items_api.rb'
37
- require_relative 'square/api/apple_pay_api.rb'
38
- require_relative 'square/api/bank_accounts_api.rb'
39
- require_relative 'square/api/bookings_api.rb'
40
- require_relative 'square/api/cash_drawers_api.rb'
41
- require_relative 'square/api/catalog_api.rb'
42
- require_relative 'square/api/customers_api.rb'
43
- require_relative 'square/api/customer_groups_api.rb'
44
- require_relative 'square/api/customer_segments_api.rb'
45
- require_relative 'square/api/devices_api.rb'
46
- require_relative 'square/api/disputes_api.rb'
47
- require_relative 'square/api/employees_api.rb'
48
- require_relative 'square/api/inventory_api.rb'
49
- require_relative 'square/api/invoices_api.rb'
50
- require_relative 'square/api/labor_api.rb'
51
- require_relative 'square/api/locations_api.rb'
52
- require_relative 'square/api/checkout_api.rb'
53
- require_relative 'square/api/transactions_api.rb'
54
- require_relative 'square/api/loyalty_api.rb'
55
- require_relative 'square/api/merchants_api.rb'
56
- require_relative 'square/api/orders_api.rb'
57
- require_relative 'square/api/payments_api.rb'
58
- require_relative 'square/api/refunds_api.rb'
59
- require_relative 'square/api/subscriptions_api.rb'
60
- require_relative 'square/api/team_api.rb'
61
- require_relative 'square/api/terminal_api.rb'
33
+ require_relative 'square/api/base_api'
34
+ require_relative 'square/api/mobile_authorization_api'
35
+ require_relative 'square/api/o_auth_api'
36
+ require_relative 'square/api/v1_transactions_api'
37
+ require_relative 'square/api/apple_pay_api'
38
+ require_relative 'square/api/bank_accounts_api'
39
+ require_relative 'square/api/bookings_api'
40
+ require_relative 'square/api/booking_custom_attributes_api'
41
+ require_relative 'square/api/cards_api'
42
+ require_relative 'square/api/cash_drawers_api'
43
+ require_relative 'square/api/catalog_api'
44
+ require_relative 'square/api/customers_api'
45
+ require_relative 'square/api/customer_custom_attributes_api'
46
+ require_relative 'square/api/customer_groups_api'
47
+ require_relative 'square/api/customer_segments_api'
48
+ require_relative 'square/api/devices_api'
49
+ require_relative 'square/api/disputes_api'
50
+ require_relative 'square/api/employees_api'
51
+ require_relative 'square/api/gift_cards_api'
52
+ require_relative 'square/api/gift_card_activities_api'
53
+ require_relative 'square/api/inventory_api'
54
+ require_relative 'square/api/invoices_api'
55
+ require_relative 'square/api/labor_api'
56
+ require_relative 'square/api/locations_api'
57
+ require_relative 'square/api/location_custom_attributes_api'
58
+ require_relative 'square/api/checkout_api'
59
+ require_relative 'square/api/transactions_api'
60
+ require_relative 'square/api/loyalty_api'
61
+ require_relative 'square/api/merchants_api'
62
+ require_relative 'square/api/orders_api'
63
+ require_relative 'square/api/order_custom_attributes_api'
64
+ require_relative 'square/api/payments_api'
65
+ require_relative 'square/api/payouts_api'
66
+ require_relative 'square/api/refunds_api'
67
+ require_relative 'square/api/sites_api'
68
+ require_relative 'square/api/snippets_api'
69
+ require_relative 'square/api/subscriptions_api'
70
+ require_relative 'square/api/team_api'
71
+ require_relative 'square/api/terminal_api'
72
+ require_relative 'square/api/vendors_api'
73
+ require_relative 'square/api/webhook_subscriptions_api'
@@ -7,11 +7,8 @@ class LocationsApiTests < ApiTestBase
7
7
  @controller = LocationsApi.new CONFIG, http_call_back: @response_catcher
8
8
  end
9
9
 
10
- # Provides information of all locations of a business.
11
- #
12
- #Many Square API endpoints require a `location_id` parameter.
13
- #The `id` field of the [`Location`](#type-location) objects returned by this
14
- #endpoint correspond to that `location_id` parameter.
10
+ # Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api),
11
+ #including those with an inactive status.
15
12
  def test_list_locations()
16
13
 
17
14
  # Perform the API call through the SDK function
data/test/test_helper.rb CHANGED
@@ -49,7 +49,7 @@ class TestHelper
49
49
  end
50
50
  end
51
51
  elsif expected_body.instance_of? Array
52
- return False unless received_body.instance_of? Array
52
+ return false unless received_body.instance_of? Array
53
53
  if check_count == true && (expected_body.length != received_body.length)
54
54
  return false
55
55
  else
@@ -82,7 +82,7 @@ class TestHelper
82
82
  unless @cache.keys.include? url
83
83
  @cache[url] = Tempfile.new('APIMatic')
84
84
  @cache[url].binmode
85
- @cache[url].write(open(url, {ssl_ca_cert: Certifi.where}).read)
85
+ @cache[url].write(URI.open(url, {ssl_ca_cert: Certifi.where}).read)
86
86
  end
87
87
  return @cache[url].path
88
88
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: square.rb
3
3
  version: !ruby/object:Gem::Version
4
- version: 8.0.0.20201216
4
+ version: 26.1.0.20230119
5
5
  platform: ruby
6
6
  authors:
7
7
  - Square Developer Platform
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-12-16 00:00:00.000000000 Z
11
+ date: 2023-01-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: logging
@@ -30,22 +30,64 @@ dependencies:
30
30
  requirements:
31
31
  - - "~>"
32
32
  - !ruby/object:Gem::Version
33
- version: '1.0'
33
+ version: '2.0'
34
34
  - - ">="
35
35
  - !ruby/object:Gem::Version
36
- version: 1.0.1
36
+ version: 2.0.1
37
37
  type: :runtime
38
38
  prerelease: false
39
39
  version_requirements: !ruby/object:Gem::Requirement
40
40
  requirements:
41
41
  - - "~>"
42
42
  - !ruby/object:Gem::Version
43
- version: '1.0'
43
+ version: '2.0'
44
44
  - - ">="
45
45
  - !ruby/object:Gem::Version
46
- version: 1.0.1
46
+ version: 2.0.1
47
+ - !ruby/object:Gem::Dependency
48
+ name: faraday-follow_redirects
49
+ requirement: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - "~>"
52
+ - !ruby/object:Gem::Version
53
+ version: '0.2'
54
+ type: :runtime
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ requirements:
58
+ - - "~>"
59
+ - !ruby/object:Gem::Version
60
+ version: '0.2'
61
+ - !ruby/object:Gem::Dependency
62
+ name: faraday-multipart
63
+ requirement: !ruby/object:Gem::Requirement
64
+ requirements:
65
+ - - "~>"
66
+ - !ruby/object:Gem::Version
67
+ version: '1.0'
68
+ type: :runtime
69
+ prerelease: false
70
+ version_requirements: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - "~>"
73
+ - !ruby/object:Gem::Version
74
+ version: '1.0'
75
+ - !ruby/object:Gem::Dependency
76
+ name: faraday-gzip
77
+ requirement: !ruby/object:Gem::Requirement
78
+ requirements:
79
+ - - "~>"
80
+ - !ruby/object:Gem::Version
81
+ version: '0.1'
82
+ type: :runtime
83
+ prerelease: false
84
+ version_requirements: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - "~>"
87
+ - !ruby/object:Gem::Version
88
+ version: '0.1'
47
89
  - !ruby/object:Gem::Dependency
48
- name: faraday_middleware
90
+ name: faraday-retry
49
91
  requirement: !ruby/object:Gem::Requirement
50
92
  requirements:
51
93
  - - "~>"
@@ -58,6 +100,20 @@ dependencies:
58
100
  - - "~>"
59
101
  - !ruby/object:Gem::Version
60
102
  version: '1.0'
103
+ - !ruby/object:Gem::Dependency
104
+ name: faraday-net_http_persistent
105
+ requirement: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - "~>"
108
+ - !ruby/object:Gem::Version
109
+ version: '2.0'
110
+ type: :runtime
111
+ prerelease: false
112
+ version_requirements: !ruby/object:Gem::Requirement
113
+ requirements:
114
+ - - "~>"
115
+ - !ruby/object:Gem::Version
116
+ version: '2.0'
61
117
  - !ruby/object:Gem::Dependency
62
118
  name: certifi
63
119
  requirement: !ruby/object:Gem::Requirement
@@ -126,9 +182,9 @@ dependencies:
126
182
  - - "~>"
127
183
  - !ruby/object:Gem::Version
128
184
  version: '1.0'
129
- description: Use Square APIs to manage and run business including payment, customer,
130
- product, inventory, and employee management.
131
- email: developers@squareup.com
185
+ description: ''
186
+ email:
187
+ - developers@squareup.com
132
188
  executables: []
133
189
  extensions: []
134
190
  extra_rdoc_files: []
@@ -139,38 +195,49 @@ files:
139
195
  - lib/square/api/apple_pay_api.rb
140
196
  - lib/square/api/bank_accounts_api.rb
141
197
  - lib/square/api/base_api.rb
198
+ - lib/square/api/booking_custom_attributes_api.rb
142
199
  - lib/square/api/bookings_api.rb
200
+ - lib/square/api/cards_api.rb
143
201
  - lib/square/api/cash_drawers_api.rb
144
202
  - lib/square/api/catalog_api.rb
145
203
  - lib/square/api/checkout_api.rb
204
+ - lib/square/api/customer_custom_attributes_api.rb
146
205
  - lib/square/api/customer_groups_api.rb
147
206
  - lib/square/api/customer_segments_api.rb
148
207
  - lib/square/api/customers_api.rb
149
208
  - lib/square/api/devices_api.rb
150
209
  - lib/square/api/disputes_api.rb
151
210
  - lib/square/api/employees_api.rb
211
+ - lib/square/api/gift_card_activities_api.rb
212
+ - lib/square/api/gift_cards_api.rb
152
213
  - lib/square/api/inventory_api.rb
153
214
  - lib/square/api/invoices_api.rb
154
215
  - lib/square/api/labor_api.rb
216
+ - lib/square/api/location_custom_attributes_api.rb
155
217
  - lib/square/api/locations_api.rb
156
218
  - lib/square/api/loyalty_api.rb
157
219
  - lib/square/api/merchants_api.rb
158
220
  - lib/square/api/mobile_authorization_api.rb
159
221
  - lib/square/api/o_auth_api.rb
222
+ - lib/square/api/order_custom_attributes_api.rb
160
223
  - lib/square/api/orders_api.rb
161
224
  - lib/square/api/payments_api.rb
225
+ - lib/square/api/payouts_api.rb
162
226
  - lib/square/api/refunds_api.rb
227
+ - lib/square/api/sites_api.rb
228
+ - lib/square/api/snippets_api.rb
163
229
  - lib/square/api/subscriptions_api.rb
164
230
  - lib/square/api/team_api.rb
165
231
  - lib/square/api/terminal_api.rb
166
232
  - lib/square/api/transactions_api.rb
167
- - lib/square/api/v1_employees_api.rb
168
- - lib/square/api/v1_items_api.rb
169
233
  - lib/square/api/v1_transactions_api.rb
234
+ - lib/square/api/vendors_api.rb
235
+ - lib/square/api/webhook_subscriptions_api.rb
170
236
  - lib/square/api_helper.rb
171
237
  - lib/square/client.rb
172
238
  - lib/square/configuration.rb
173
239
  - lib/square/exceptions/api_exception.rb
240
+ - lib/square/exceptions/validation_exception.rb
174
241
  - lib/square/http/api_response.rb
175
242
  - lib/square/http/auth/o_auth2.rb
176
243
  - lib/square/http/faraday_client.rb
@@ -179,6 +246,7 @@ files:
179
246
  - lib/square/http/http_method_enum.rb
180
247
  - lib/square/http/http_request.rb
181
248
  - lib/square/http/http_response.rb
249
+ - lib/square/utilities/date_time_helper.rb
182
250
  - lib/square/utilities/file_wrapper.rb
183
251
  - spec/user_journey_spec.rb
184
252
  - test/api/api_test_base.rb
@@ -192,7 +260,7 @@ files:
192
260
  - test/api/test_refunds_api.rb
193
261
  - test/http_response_catcher.rb
194
262
  - test/test_helper.rb
195
- homepage: https://squareup.com/developers
263
+ homepage: ''
196
264
  licenses:
197
265
  - Apache-2.0
198
266
  metadata: {}
@@ -204,14 +272,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
204
272
  requirements:
205
273
  - - ">="
206
274
  - !ruby/object:Gem::Version
207
- version: '2.0'
275
+ version: '2.6'
208
276
  required_rubygems_version: !ruby/object:Gem::Requirement
209
277
  requirements:
210
278
  - - ">="
211
279
  - !ruby/object:Gem::Version
212
280
  version: '0'
213
281
  requirements: []
214
- rubygems_version: 3.1.4
282
+ rubygems_version: 3.1.6
215
283
  signing_key:
216
284
  specification_version: 4
217
285
  summary: square