square.rb 3.20190624.0 → 3.20190814.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (45) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +10 -28
  3. data/README.md +281 -17235
  4. data/lib/square/api/apple_pay_api.rb +55 -54
  5. data/lib/square/api/base_api.rb +45 -45
  6. data/lib/square/api/catalog_api.rb +461 -460
  7. data/lib/square/api/checkout_api.rb +54 -54
  8. data/lib/square/api/customers_api.rb +335 -334
  9. data/lib/square/api/employees_api.rb +91 -91
  10. data/lib/square/api/inventory_api.rb +300 -298
  11. data/lib/square/api/labor_api.rb +558 -558
  12. data/lib/square/api/locations_api.rb +45 -45
  13. data/lib/square/api/mobile_authorization_api.rb +56 -56
  14. data/lib/square/api/o_auth_api.rb +168 -164
  15. data/lib/square/api/orders_api.rb +269 -151
  16. data/lib/square/api/payments_api.rb +282 -0
  17. data/lib/square/api/refunds_api.rb +149 -0
  18. data/lib/square/api/reporting_api.rb +143 -139
  19. data/lib/square/api/transactions_api.rb +379 -360
  20. data/lib/square/api/v1_employees_api.rb +720 -720
  21. data/lib/square/api/v1_items_api.rb +1651 -1651
  22. data/lib/square/api/v1_locations_api.rb +67 -67
  23. data/lib/square/api/v1_locations_api.rbe +67 -0
  24. data/lib/square/api/v1_transactions_api.rb +574 -574
  25. data/lib/square/api_helper.rb +281 -277
  26. data/lib/square/client.rb +139 -127
  27. data/lib/square/configuration.rb +88 -85
  28. data/lib/square/exceptions/api_exception.rb +20 -20
  29. data/lib/square/http/api_response.rb +50 -50
  30. data/lib/square/http/auth/o_auth2.rb +17 -17
  31. data/lib/square/http/faraday_client.rb +64 -64
  32. data/lib/square/http/http_call_back.rb +24 -24
  33. data/lib/square/http/http_client.rb +104 -104
  34. data/lib/square/http/http_method_enum.rb +13 -13
  35. data/lib/square/http/http_request.rb +50 -50
  36. data/lib/square/http/http_response.rb +29 -29
  37. data/lib/square.rb +52 -50
  38. data/spec/user_journey_spec.rb +4 -1
  39. data/test/api/api_test_base.rb +2 -1
  40. data/test/api/test_catalog_api.rb +59 -0
  41. data/test/api/test_employees_api.rb +36 -0
  42. data/test/api/test_locations_api.rb +35 -0
  43. data/test/api/test_payments_api.rb +42 -0
  44. data/test/api/test_refunds_api.rb +41 -0
  45. metadata +19 -11
data/lib/square.rb CHANGED
@@ -1,50 +1,52 @@
1
- # square
2
- #
3
- # This file was automatically generated by APIMATIC v2.0
4
- # ( https://apimatic.io ).
5
-
6
- require 'date'
7
- require 'json'
8
- require 'faraday'
9
- require 'certifi'
10
- require 'logging'
11
-
12
- require_relative 'square/api_helper.rb'
13
- require_relative 'square/client.rb'
14
-
15
- # Http
16
- require_relative 'square/http/api_response.rb'
17
- require_relative 'square/http/http_call_back.rb'
18
- require_relative 'square/http/http_client.rb'
19
- require_relative 'square/http/faraday_client.rb'
20
- require_relative 'square/http/http_method_enum.rb'
21
- require_relative 'square/http/http_request.rb'
22
- require_relative 'square/http/http_response.rb'
23
- require_relative 'square/http/auth/o_auth2.rb'
24
-
25
- # Models
26
-
27
- # Exceptions
28
- require_relative 'square/exceptions/api_exception.rb'
29
-
30
- require_relative 'square/configuration.rb'
31
-
32
- # Controllers
33
- require_relative 'square/api/base_api.rb'
34
- require_relative 'square/api/mobile_authorization_api.rb'
35
- require_relative 'square/api/o_auth_api.rb'
36
- require_relative 'square/api/v1_locations_api.rb'
37
- require_relative 'square/api/v1_employees_api.rb'
38
- require_relative 'square/api/v1_transactions_api.rb'
39
- require_relative 'square/api/v1_items_api.rb'
40
- require_relative 'square/api/apple_pay_api.rb'
41
- require_relative 'square/api/catalog_api.rb'
42
- require_relative 'square/api/customers_api.rb'
43
- require_relative 'square/api/employees_api.rb'
44
- require_relative 'square/api/inventory_api.rb'
45
- require_relative 'square/api/labor_api.rb'
46
- require_relative 'square/api/locations_api.rb'
47
- require_relative 'square/api/reporting_api.rb'
48
- require_relative 'square/api/checkout_api.rb'
49
- require_relative 'square/api/orders_api.rb'
50
- require_relative 'square/api/transactions_api.rb'
1
+ # square
2
+ #
3
+ # This file was automatically generated by APIMATIC v2.0
4
+ # ( https://apimatic.io ).
5
+
6
+ require 'date'
7
+ require 'json'
8
+ require 'faraday'
9
+ require 'certifi'
10
+ require 'logging'
11
+
12
+ require_relative 'square/api_helper.rb'
13
+ require_relative 'square/client.rb'
14
+
15
+ # Http
16
+ require_relative 'square/http/api_response.rb'
17
+ require_relative 'square/http/http_call_back.rb'
18
+ require_relative 'square/http/http_client.rb'
19
+ require_relative 'square/http/faraday_client.rb'
20
+ require_relative 'square/http/http_method_enum.rb'
21
+ require_relative 'square/http/http_request.rb'
22
+ require_relative 'square/http/http_response.rb'
23
+ require_relative 'square/http/auth/o_auth2.rb'
24
+
25
+ # Models
26
+
27
+ # Exceptions
28
+ require_relative 'square/exceptions/api_exception.rb'
29
+
30
+ require_relative 'square/configuration.rb'
31
+
32
+ # Controllers
33
+ require_relative 'square/api/base_api.rb'
34
+ require_relative 'square/api/mobile_authorization_api.rb'
35
+ require_relative 'square/api/o_auth_api.rb'
36
+ require_relative 'square/api/v1_locations_api.rb'
37
+ require_relative 'square/api/v1_employees_api.rb'
38
+ require_relative 'square/api/v1_transactions_api.rb'
39
+ require_relative 'square/api/v1_items_api.rb'
40
+ require_relative 'square/api/apple_pay_api.rb'
41
+ require_relative 'square/api/catalog_api.rb'
42
+ require_relative 'square/api/customers_api.rb'
43
+ require_relative 'square/api/employees_api.rb'
44
+ require_relative 'square/api/inventory_api.rb'
45
+ require_relative 'square/api/labor_api.rb'
46
+ require_relative 'square/api/locations_api.rb'
47
+ require_relative 'square/api/reporting_api.rb'
48
+ require_relative 'square/api/checkout_api.rb'
49
+ require_relative 'square/api/orders_api.rb'
50
+ require_relative 'square/api/transactions_api.rb'
51
+ require_relative 'square/api/payments_api.rb'
52
+ require_relative 'square/api/refunds_api.rb'
@@ -5,6 +5,7 @@ require 'json'
5
5
 
6
6
  describe "UserJourney" do
7
7
  let(:access_token) { ApiTestBase::CONFIG.access_token }
8
+ let(:environment) { ApiTestBase::CONFIG.environment }
8
9
 
9
10
  let(:phone_number) { "1-212-555-4240" }
10
11
  let(:phone_number2) { "1-917-500-1000" }
@@ -29,7 +30,7 @@ describe "UserJourney" do
29
30
  end
30
31
 
31
32
  let :sq do
32
- Square::Client.new(access_token: access_token)
33
+ Square::Client.new(access_token: access_token, environment: environment)
33
34
  end
34
35
 
35
36
  let :unauthoerized_sq do
@@ -109,6 +110,8 @@ describe "UserJourney" do
109
110
  # create
110
111
  response = sq.customers.create_customer(body: customer)
111
112
  assert_equal response.data.customer[:phone_number], phone_number
113
+
114
+
112
115
  assert_equal response.status_code, 200
113
116
  created_customer = response.data.customer
114
117
 
@@ -18,6 +18,7 @@ class ApiTestBase < Minitest::Test
18
18
 
19
19
  # Create configuration and set any test parameters
20
20
  CONFIG = Configuration.new(
21
- access_token: ENV.fetch('SQUARE_SANDBOX_TOKEN', 'AccessToken')
21
+ access_token: ENV.fetch('SQUARE_SANDBOX_TOKEN', 'AccessToken'),
22
+ environment: "sandbox"
22
23
  )
23
24
  end
@@ -0,0 +1,59 @@
1
+ # square
2
+ #
3
+ # This file was automatically generated by APIMATIC v2.0
4
+ # ( https://apimatic.io ).
5
+
6
+ require_relative 'api_test_base'
7
+
8
+ class CatalogApiTests < ApiTestBase
9
+ # Called only once for the class before any test has executed
10
+ def setup
11
+ @response_catcher = HttpResponseCatcher.new
12
+ @controller = CatalogApi.new CONFIG, http_call_back: @response_catcher
13
+ end
14
+
15
+ # Returns information about the Square Catalog API, such as batch size
16
+ #limits for `BatchUpsertCatalogObjects`.
17
+ def test_test_catalog_info()
18
+
19
+ # Perform the API call through the SDK function
20
+ result = @controller.catalog_info()
21
+
22
+ # Test response code
23
+ assert_equal(200, @response_catcher.response.status_code)
24
+
25
+ # Test headers
26
+ expected_headers = {}
27
+ expected_headers['content-type'] = 'application/json'
28
+
29
+ assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
30
+ end
31
+
32
+ # Returns a list of [CatalogObject](#type-catalogobject)s that includes
33
+ #all objects of a set of desired types (for example, all [CatalogItem](#type-catalogitem)
34
+ #and [CatalogTax](#type-catalogtax) objects) in the catalog. The `types` parameter
35
+ #is specified as a comma-separated list of valid [CatalogObject](#type-catalogobject) types:
36
+ #`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`.
37
+ #
38
+ #__Important:__ ListCatalog does not return deleted catalog items. To retrieve
39
+ #deleted catalog items, use SearchCatalogObjects and set `include_deleted_objects`
40
+ #to `true`.
41
+ def test_test_list_catalog()
42
+ # Parameters for the API call
43
+ cursor = nil
44
+ types = nil
45
+
46
+ # Perform the API call through the SDK function
47
+ result = @controller.list_catalog(cursor: cursor, types: types)
48
+
49
+ # Test response code
50
+ assert_equal(200, @response_catcher.response.status_code)
51
+
52
+ # Test headers
53
+ expected_headers = {}
54
+ expected_headers['content-type'] = 'application/json'
55
+
56
+ assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
57
+ end
58
+
59
+ end
@@ -0,0 +1,36 @@
1
+ # square
2
+ #
3
+ # This file was automatically generated by APIMATIC v2.0
4
+ # ( https://apimatic.io ).
5
+
6
+ require_relative 'api_test_base'
7
+
8
+ class EmployeesApiTests < ApiTestBase
9
+ # Called only once for the class before any test has executed
10
+ def setup
11
+ @response_catcher = HttpResponseCatcher.new
12
+ @controller = EmployeesApi.new CONFIG, http_call_back: @response_catcher
13
+ end
14
+
15
+ # Gets a list of `Employee` objects for a business.
16
+ def test_test_list_employees()
17
+ # Parameters for the API call
18
+ location_id = nil
19
+ status = nil
20
+ limit = nil
21
+ cursor = nil
22
+
23
+ # Perform the API call through the SDK function
24
+ result = @controller.list_employees(location_id: location_id, status: status, limit: limit, cursor: cursor)
25
+
26
+ # Test response code
27
+ assert_equal(200, @response_catcher.response.status_code)
28
+
29
+ # Test headers
30
+ expected_headers = {}
31
+ expected_headers['content-type'] = 'application/json'
32
+
33
+ assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
34
+ end
35
+
36
+ end
@@ -0,0 +1,35 @@
1
+ # square
2
+ #
3
+ # This file was automatically generated by APIMATIC v2.0
4
+ # ( https://apimatic.io ).
5
+
6
+ require_relative 'api_test_base'
7
+
8
+ class LocationsApiTests < ApiTestBase
9
+ # Called only once for the class before any test has executed
10
+ def setup
11
+ @response_catcher = HttpResponseCatcher.new
12
+ @controller = LocationsApi.new CONFIG, http_call_back: @response_catcher
13
+ end
14
+
15
+ # Provides the details for all of a business's locations.
16
+ #
17
+ #Most other Connect API endpoints have a required `location_id` path parameter.
18
+ #The `id` field of the [`Location`](#type-location) objects returned by this
19
+ #endpoint correspond to that `location_id` parameter.
20
+ def test_test_list_locations()
21
+
22
+ # Perform the API call through the SDK function
23
+ result = @controller.list_locations()
24
+
25
+ # Test response code
26
+ assert_equal(200, @response_catcher.response.status_code)
27
+
28
+ # Test headers
29
+ expected_headers = {}
30
+ expected_headers['content-type'] = 'application/json'
31
+
32
+ assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
33
+ end
34
+
35
+ end
@@ -0,0 +1,42 @@
1
+ # square
2
+ #
3
+ # This file was automatically generated by APIMATIC v2.0
4
+ # ( https://apimatic.io ).
5
+
6
+ require_relative 'api_test_base'
7
+
8
+ class PaymentsApiTests < ApiTestBase
9
+ # Called only once for the class before any test has executed
10
+ def setup
11
+ @response_catcher = HttpResponseCatcher.new
12
+ @controller = PaymentsApi.new CONFIG, http_call_back: @response_catcher
13
+ end
14
+
15
+ # Retrieves a list of payments taken by the account making the request.
16
+ #
17
+ #Max results per page: 100
18
+ def test_test_list_payments()
19
+ # Parameters for the API call
20
+ begin_time = nil
21
+ end_time = nil
22
+ sort_order = nil
23
+ cursor = nil
24
+ location_id = nil
25
+ total = nil
26
+ last_4 = nil
27
+ card_brand = nil
28
+
29
+ # Perform the API call through the SDK function
30
+ result = @controller.list_payments(begin_time: begin_time, end_time: end_time, sort_order: sort_order, cursor: cursor, location_id: location_id, total: total, last_4: last_4, card_brand: card_brand)
31
+
32
+ # Test response code
33
+ assert_equal(200, @response_catcher.response.status_code)
34
+
35
+ # Test headers
36
+ expected_headers = {}
37
+ expected_headers['content-type'] = 'application/json'
38
+
39
+ assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
40
+ end
41
+
42
+ end
@@ -0,0 +1,41 @@
1
+ # square
2
+ #
3
+ # This file was automatically generated by APIMATIC v2.0
4
+ # ( https://apimatic.io ).
5
+
6
+ require_relative 'api_test_base'
7
+
8
+ class RefundsApiTests < ApiTestBase
9
+ # Called only once for the class before any test has executed
10
+ def setup
11
+ @response_catcher = HttpResponseCatcher.new
12
+ @controller = RefundsApi.new CONFIG, http_call_back: @response_catcher
13
+ end
14
+
15
+ # Retrieves a list of refunds for the account making the request.
16
+ #
17
+ #Max results per page: 100
18
+ def test_test_list_payment_refunds()
19
+ # Parameters for the API call
20
+ begin_time = nil
21
+ end_time = nil
22
+ sort_order = nil
23
+ cursor = nil
24
+ location_id = nil
25
+ status = nil
26
+ source_type = nil
27
+
28
+ # Perform the API call through the SDK function
29
+ result = @controller.list_payment_refunds(begin_time: begin_time, end_time: end_time, sort_order: sort_order, cursor: cursor, location_id: location_id, status: status, source_type: source_type)
30
+
31
+ # Test response code
32
+ assert_equal(200, @response_catcher.response.status_code)
33
+
34
+ # Test headers
35
+ expected_headers = {}
36
+ expected_headers['content-type'] = 'application/json'
37
+
38
+ assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
39
+ end
40
+
41
+ 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: 3.20190624.0
4
+ version: 3.20190814.0
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: 2019-06-24 00:00:00.000000000 Z
11
+ date: 2019-08-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: logging
@@ -16,42 +16,42 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: 2.2.2
19
+ version: '2.2'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: 2.2.2
26
+ version: '2.2'
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: faraday
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
31
  - - "~>"
32
32
  - !ruby/object:Gem::Version
33
- version: 0.15.4
33
+ version: '0.15'
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - "~>"
39
39
  - !ruby/object:Gem::Version
40
- version: 0.15.4
40
+ version: '0.15'
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: faraday_middleware
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
45
  - - "~>"
46
46
  - !ruby/object:Gem::Version
47
- version: 0.13.1
47
+ version: '0.13'
48
48
  type: :runtime
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - "~>"
53
53
  - !ruby/object:Gem::Version
54
- version: 0.13.1
54
+ version: '0.13'
55
55
  - !ruby/object:Gem::Dependency
56
56
  name: certifi
57
57
  requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
72
72
  requirements:
73
73
  - - "~>"
74
74
  - !ruby/object:Gem::Version
75
- version: 2.0.0
75
+ version: '2.0'
76
76
  type: :runtime
77
77
  prerelease: false
78
78
  version_requirements: !ruby/object:Gem::Requirement
79
79
  requirements:
80
80
  - - "~>"
81
81
  - !ruby/object:Gem::Version
82
- version: 2.0.0
82
+ version: '2.0'
83
83
  - !ruby/object:Gem::Dependency
84
84
  name: minitest
85
85
  requirement: !ruby/object:Gem::Requirement
@@ -130,11 +130,14 @@ files:
130
130
  - lib/square/api/mobile_authorization_api.rb
131
131
  - lib/square/api/o_auth_api.rb
132
132
  - lib/square/api/orders_api.rb
133
+ - lib/square/api/payments_api.rb
134
+ - lib/square/api/refunds_api.rb
133
135
  - lib/square/api/reporting_api.rb
134
136
  - lib/square/api/transactions_api.rb
135
137
  - lib/square/api/v1_employees_api.rb
136
138
  - lib/square/api/v1_items_api.rb
137
139
  - lib/square/api/v1_locations_api.rb
140
+ - lib/square/api/v1_locations_api.rbe
138
141
  - lib/square/api/v1_transactions_api.rb
139
142
  - lib/square/api_helper.rb
140
143
  - lib/square/client.rb
@@ -150,12 +153,17 @@ files:
150
153
  - lib/square/http/http_response.rb
151
154
  - spec/user_journey_spec.rb
152
155
  - test/api/api_test_base.rb
156
+ - test/api/test_catalog_api.rb
153
157
  - test/api/test_customers_api.rb
158
+ - test/api/test_employees_api.rb
159
+ - test/api/test_locations_api.rb
160
+ - test/api/test_payments_api.rb
161
+ - test/api/test_refunds_api.rb
154
162
  - test/http_response_catcher.rb
155
163
  - test/test_helper.rb
156
164
  homepage: https://squareup.com/developers
157
165
  licenses:
158
- - MIT
166
+ - Apache-2.0
159
167
  metadata: {}
160
168
  post_install_message:
161
169
  rdoc_options: []