square.rb 9.1.1.20210317 → 10.0.0.202104217

Sign up to get free protection for your applications and to get access to all the features.
@@ -54,8 +54,8 @@ module Square
54
54
  # marked as failed, but the body of the response
55
55
  # will contain explicit error information for this particular create.
56
56
  # Learn about [Troubleshooting the Teams
57
- # API](https://developer.squareup.com/docs/team/troubleshooting#bulkcreatete
58
- # ammembers).
57
+ # API](https://developer.squareup.com/docs/team/troubleshooting#bulk-create-
58
+ # team-members).
59
59
  # @param [BulkCreateTeamMembersRequest] body Required parameter: An object
60
60
  # containing the fields to POST for the request. See the corresponding
61
61
  # object definition for field details.
@@ -97,8 +97,8 @@ module Square
97
97
  # marked as failed, but the body of the response
98
98
  # will contain explicit error information for this particular update.
99
99
  # Learn about [Troubleshooting the Teams
100
- # API](https://developer.squareup.com/docs/team/troubleshooting#bulkupdatete
101
- # ammembers).
100
+ # API](https://developer.squareup.com/docs/team/troubleshooting#bulk-update-
101
+ # team-members).
102
102
  # @param [BulkUpdateTeamMembersRequest] 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.
@@ -171,8 +171,8 @@ module Square
171
171
 
172
172
  # Retrieve a `TeamMember` object for the given `TeamMember.id`.
173
173
  # Learn about [Troubleshooting the Teams
174
- # API](https://developer.squareup.com/docs/team/troubleshooting#retrieveteam
175
- # member).
174
+ # API](https://developer.squareup.com/docs/team/troubleshooting#retrieve-a-t
175
+ # eam-member).
176
176
  # @param [String] team_member_id Required parameter: The ID of the team
177
177
  # member to retrieve.
178
178
  # @return [RetrieveTeamMemberResponse Hash] response from the API call
@@ -210,8 +210,8 @@ module Square
210
210
  # Updates a single `TeamMember` object. The `TeamMember` will be returned on
211
211
  # successful updates.
212
212
  # Learn about [Troubleshooting the Teams
213
- # API](https://developer.squareup.com/docs/team/troubleshooting#updateteamme
214
- # mber).
213
+ # API](https://developer.squareup.com/docs/team/troubleshooting#update-a-tea
214
+ # m-member).
215
215
  # @param [String] team_member_id Required parameter: The ID of the team
216
216
  # member to update.
217
217
  # @param [UpdateTeamMemberRequest] body Required parameter: An object
@@ -297,8 +297,8 @@ module Square
297
297
  # it fully replaces the `WageSetting` object for the team member.
298
298
  # The `WageSetting` will be returned upon successful update.
299
299
  # Learn about [Troubleshooting the Teams
300
- # API](https://developer.squareup.com/docs/team/troubleshooting#updatewagese
301
- # tting).
300
+ # API](https://developer.squareup.com/docs/team/troubleshooting#create-or-up
301
+ # date-a-wage-setting).
302
302
  # @param [String] team_member_id Required parameter: The ID of the team
303
303
  # member to update the `WageSetting` object for.
304
304
  # @param [UpdateWageSettingRequest] body Required parameter: An object
@@ -12,24 +12,29 @@ module Square
12
12
  # Point of Sale applications.
13
13
  # Refunds with a `status` of `PENDING` are not currently included in this
14
14
  # endpoint's response.
15
- # Max results per [page](#paginatingresults): 50
15
+ # Max results per
16
+ # [page](https://developer.squareup.com/docs/working-with-apis/pagination):
17
+ # 50
16
18
  # @param [String] location_id Required parameter: The ID of the location to
17
19
  # list refunds for.
18
20
  # @param [String] begin_time Optional parameter: The beginning of the
19
21
  # requested reporting period, in RFC 3339 format. See [Date
20
- # ranges](#dateranges) for details on date inclusivity/exclusivity. Default
21
- # value: The current time minus one year.
22
+ # ranges](https://developer.squareup.com/docs/build-basics/working-with-date
23
+ # s) for details on date inclusivity/exclusivity. Default value: The
24
+ # current time minus one year.
22
25
  # @param [String] end_time Optional parameter: The end of the requested
23
- # reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for
24
- # details on date inclusivity/exclusivity. Default value: The current
25
- # time.
26
+ # reporting period, in RFC 3339 format. See [Date
27
+ # ranges](https://developer.squareup.com/docs/build-basics/working-with-date
28
+ # s) for details on date inclusivity/exclusivity. Default value: The
29
+ # current time.
26
30
  # @param [SortOrder] sort_order Optional parameter: The order in which
27
31
  # results are listed in the response (`ASC` for oldest first, `DESC` for
28
32
  # newest first). Default value: `DESC`
29
33
  # @param [String] cursor Optional parameter: A pagination cursor returned by
30
34
  # a previous call to this endpoint. Provide this to retrieve the next set of
31
35
  # results for your original query. See [Paginating
32
- # results](#paginatingresults) for more information.
36
+ # results](https://developer.squareup.com/docs/working-with-apis/pagination)
37
+ # for more information.
33
38
  # @return [ListRefundsResponse Hash] response from the API call
34
39
  def list_refunds(location_id:,
35
40
  begin_time: nil,
@@ -78,24 +83,29 @@ module Square
78
83
  # Transactions include payment information from sales and exchanges and
79
84
  # refund
80
85
  # information from returns and exchanges.
81
- # Max results per [page](#paginatingresults): 50
86
+ # Max results per
87
+ # [page](https://developer.squareup.com/docs/working-with-apis/pagination):
88
+ # 50
82
89
  # @param [String] location_id Required parameter: The ID of the location to
83
90
  # list transactions for.
84
91
  # @param [String] begin_time Optional parameter: The beginning of the
85
92
  # requested reporting period, in RFC 3339 format. See [Date
86
- # ranges](#dateranges) for details on date inclusivity/exclusivity. Default
87
- # value: The current time minus one year.
93
+ # ranges](https://developer.squareup.com/docs/build-basics/working-with-date
94
+ # s) for details on date inclusivity/exclusivity. Default value: The
95
+ # current time minus one year.
88
96
  # @param [String] end_time Optional parameter: The end of the requested
89
- # reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for
90
- # details on date inclusivity/exclusivity. Default value: The current
91
- # time.
97
+ # reporting period, in RFC 3339 format. See [Date
98
+ # ranges](https://developer.squareup.com/docs/build-basics/working-with-date
99
+ # s) for details on date inclusivity/exclusivity. Default value: The
100
+ # current time.
92
101
  # @param [SortOrder] sort_order Optional parameter: The order in which
93
102
  # results are listed in the response (`ASC` for oldest first, `DESC` for
94
103
  # newest first). Default value: `DESC`
95
104
  # @param [String] cursor Optional parameter: A pagination cursor returned by
96
105
  # a previous call to this endpoint. Provide this to retrieve the next set of
97
106
  # results for your original query. See [Paginating
98
- # results](#paginatingresults) for more information.
107
+ # results](https://developer.squareup.com/docs/working-with-apis/pagination)
108
+ # for more information.
99
109
  # @return [ListTransactionsResponse Hash] response from the API call
100
110
  def list_transactions(location_id:,
101
111
  begin_time: nil,
@@ -156,9 +166,9 @@ module Square
156
166
  # When this response is returned, the amount of Square's processing fee
157
167
  # might not yet be
158
168
  # calculated. To obtain the processing fee, wait about ten seconds and call
159
- # [RetrieveTransaction](#endpoint-retrievetransaction). See the
169
+ # [RetrieveTransaction]($e/Transactions/RetrieveTransaction). See the
160
170
  # `processing_fee_money`
161
- # field of each [Tender included](#type-tender) in the transaction.
171
+ # field of each [Tender included]($m/Tender) in the transaction.
162
172
  # @param [String] location_id Required parameter: The ID of the location to
163
173
  # associate the created transaction with.
164
174
  # @param [ChargeRequest] body Required parameter: An object containing the
@@ -241,7 +251,7 @@ module Square
241
251
  end
242
252
 
243
253
  # Captures a transaction that was created with the
244
- # [Charge](#endpoint-charge)
254
+ # [Charge]($e/Transactions/Charge)
245
255
  # endpoint with a `delay_capture` value of `true`.
246
256
  # See [Delayed capture
247
257
  # transactions](https://developer.squareup.com/docs/payments/transactions/ov
@@ -337,7 +347,8 @@ module Square
337
347
  )
338
348
  end
339
349
 
340
- # Cancels a transaction that was created with the [Charge](#endpoint-charge)
350
+ # Cancels a transaction that was created with the
351
+ # [Charge]($e/Transactions/Charge)
341
352
  # endpoint with a `delay_capture` value of `true`.
342
353
  # See [Delayed capture
343
354
  # transactions](https://developer.squareup.com/docs/payments/transactions/ov
@@ -247,7 +247,8 @@ module Square
247
247
  # employee with that role. For example, an employee with a "Shift Manager"
248
248
  # role might be able to issue refunds in Square Point of Sale, whereas an
249
249
  # employee with a "Clerk" role might not.
250
- # Roles are assigned with the [V1UpdateEmployee](#endpoint-v1updateemployee)
250
+ # Roles are assigned with the
251
+ # [V1UpdateEmployee]($e/V1Employees/UpdateEmployeeRole)
251
252
  # endpoint. An employee can have only one role at a time.
252
253
  # If an employee has no role, they have none of the permissions associated
253
254
  # with roles. All employees can accept payments with Square Point of Sale.
data/lib/square/client.rb CHANGED
@@ -4,7 +4,7 @@ module Square
4
4
  attr_reader :config
5
5
 
6
6
  def sdk_version
7
- '9.1.1.20210317'
7
+ '10.0.0.202104217'
8
8
  end
9
9
 
10
10
  def square_version
@@ -188,7 +188,7 @@ module Square
188
188
  def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
189
189
  backoff_factor: 1, environment: 'production',
190
190
  custom_url: 'https://connect.squareup.com',
191
- square_version: '2021-03-17', access_token: 'TODO: Replace',
191
+ square_version: '2021-04-21', access_token: 'TODO: Replace',
192
192
  additional_headers: {}, config: nil)
193
193
  @config = if config.nil?
194
194
  Configuration.new(timeout: timeout, max_retries: max_retries,
@@ -24,7 +24,7 @@ module Square
24
24
  def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
25
25
  backoff_factor: 1, environment: 'production',
26
26
  custom_url: 'https://connect.squareup.com',
27
- square_version: '2021-03-17', access_token: 'TODO: Replace',
27
+ square_version: '2021-04-21', access_token: 'TODO: Replace',
28
28
  additional_headers: {})
29
29
  # The value to use for connection timeout
30
30
  @timeout = timeout
@@ -10,7 +10,7 @@ class LocationsApiTests < ApiTestBase
10
10
  # Provides information of all locations of a business.
11
11
  #
12
12
  #Many Square API endpoints require a `location_id` parameter.
13
- #The `id` field of the [`Location`](#type-location) objects returned by this
13
+ #The `id` field of the [`Location`]($m/Location) objects returned by this
14
14
  #endpoint correspond to that `location_id` parameter.
15
15
  def test_list_locations()
16
16
 
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: 9.1.1.20210317
4
+ version: 10.0.0.202104217
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: 2021-04-02 00:00:00.000000000 Z
11
+ date: 2021-04-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: logging