square.rb 5.3.0.20200528 → 6.4.0.20200923

data/lib/square/api/labor_api.rb

@@ -209,6 +209,7 @@ module Square
     def list_employee_wages(employee_id: nil,
                             limit: nil,
                             cursor: nil)
+      warn 'Endpoint list_employee_wages in LaborApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/labor/employee-wages'
@@ -244,6 +245,7 @@ module Square
     # retrieved.
     # @return [GetEmployeeWageResponse Hash] response from the API call
     def get_employee_wage(id:)
+      warn 'Endpoint get_employee_wage in LaborApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/labor/employee-wages/{id}'
@@ -474,6 +476,81 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
+    # Returns a paginated list of `TeamMemberWage` instances for a business.
+    # @param [String] team_member_id Optional parameter: Filter wages returned
+    # to only those that are associated with the specified team member.
+    # @param [Integer] limit Optional parameter: Maximum number of Team Member
+    # Wages to return per page. Can range between 1 and 200. The default is the
+    # maximum at 200.
+    # @param [String] cursor Optional parameter: Pointer to the next page of
+    # Employee Wage results to fetch.
+    # @return [ListTeamMemberWagesResponse Hash] response from the API call
+    def list_team_member_wages(team_member_id: nil,
+                               limit: nil,
+                               cursor: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/labor/team-member-wages'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'team_member_id' => team_member_id,
+        'limit' => limit,
+        'cursor' => cursor
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(_response, data: decoded, errors: _errors)
+    end
+
+    # Returns a single `TeamMemberWage` specified by id.
+    # @param [String] id Required parameter: UUID for the `TeamMemberWage` being
+    # retrieved.
+    # @return [GetTeamMemberWageResponse Hash] response from the API call
+    def get_team_member_wage(id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/labor/team-member-wages/{id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'id' => id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(_response, data: decoded, errors: _errors)
+    end
+
     # Returns a list of `WorkweekConfig` instances for a business.
     # @param [Integer] limit Optional parameter: Maximum number of Workweek
     # Configs to return per page.

data/lib/square/api/locations_api.rb

@@ -71,9 +71,14 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
-    # Retrieves details of a location.
+    # Retrieves details of a location. You can specify "main"
+    # as the location ID to retrieve details of the
+    # main location. For more information,
+    # see [Locations API
+    # Overview](https://developer.squareup.com/docs/docs/locations-api).
     # @param [String] location_id Required parameter: The ID of the location to
-    # retrieve.
+    # retrieve. If you specify the string "main", then the endpoint returns the
+    # main location.
     # @return [RetrieveLocationResponse Hash] response from the API call
     def retrieve_location(location_id:)
       # Prepare query url.

data/lib/square/api/merchants_api.rb

@@ -48,7 +48,8 @@ module Square
 
     # Retrieve a `Merchant` object for the given `merchant_id`.
     # @param [String] merchant_id Required parameter: The ID of the merchant to
-    # retrieve.
+    # retrieve. If the string "me" is supplied as the ID, then retrieve the
+    # merchant that is currently accessible to this call.
     # @return [RetrieveMerchantResponse Hash] response from the API call
     def retrieve_merchant(merchant_id:)
       # Prepare query url.

data/lib/square/api/orders_api.rb

@@ -13,24 +13,14 @@ module Square
     # guide.
     # You can modify open orders using the
     # [UpdateOrder](#endpoint-orders-updateorder) endpoint.
-    # To learn more about the Orders API, see the
-    # [Orders API
-    # Overview](https://developer.squareup.com/docs/orders-api/what-it-does).
-    # @param [String] location_id Required parameter: The ID of the business
-    # location to associate the order with.
     # @param [CreateOrderRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
     # @return [CreateOrderResponse Hash] response from the API call
-    def create_order(location_id:,
-                     body:)
+    def create_order(body:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/orders'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id
-      )
+      _query_builder << '/v2/orders'
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
@@ -57,21 +47,14 @@ module Square
     # Retrieves a set of [Order](#type-order)s by their IDs.
     # If a given Order ID does not exist, the ID is ignored instead of
     # generating an error.
-    # @param [String] location_id Required parameter: The ID of the orders'
-    # associated location.
     # @param [BatchRetrieveOrdersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
     # @return [BatchRetrieveOrdersResponse Hash] response from the API call
-    def batch_retrieve_orders(location_id:,
-                              body:)
+    def batch_retrieve_orders(body:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/orders/batch-retrieve'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id
-      )
+      _query_builder << '/v2/orders/batch-retrieve'
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
@@ -95,68 +78,6 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
-    # Updates an open [Order](#type-order) by adding, replacing, or deleting
-    # fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.
-    # An UpdateOrder request requires the following:
-    # - The `order_id` in the endpoint path, identifying the order to update.
-    # - The latest `version` of the order to update.
-    # - The [sparse
-    # order](https://developer.squareup.com/docs/orders-api/manage-orders#sparse
-    # -order-objects)
-    # containing only the fields to update and the version the update is
-    # being applied to.
-    # - If deleting fields, the [dot notation
-    # paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot
-    # -notation)
-    # identifying fields to clear.
-    # To pay for an order, please refer to the [Pay for
-    # Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders)
-    # guide.
-    # To learn more about the Orders API, see the
-    # [Orders API
-    # Overview](https://developer.squareup.com/docs/orders-api/what-it-does).
-    # @param [String] location_id Required parameter: The ID of the order's
-    # associated location.
-    # @param [String] order_id Required parameter: The ID of the order to
-    # update.
-    # @param [UpdateOrderRequest] body Required parameter: An object containing
-    # the fields to POST for the request.  See the corresponding object
-    # definition for field details.
-    # @return [UpdateOrderResponse Hash] response from the API call
-    def update_order(location_id:,
-                     order_id:,
-                     body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/orders/{order_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id,
-        'order_id' => order_id
-      )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.put(
-        _query_url,
-        headers: _headers,
-        parameters: body.to_json
-      )
-      OAuth2.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Return appropriate response type.
-      decoded = APIHelper.json_deserialize(_response.raw_body)
-      _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
-    end
-
     # Calculates an [Order](#type-order).
     # @param [CalculateOrderRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -236,6 +157,61 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
+    # Updates an open [Order](#type-order) by adding, replacing, or deleting
+    # fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.
+    # An UpdateOrder request requires the following:
+    # - The `order_id` in the endpoint path, identifying the order to update.
+    # - The latest `version` of the order to update.
+    # - The [sparse
+    # order](https://developer.squareup.com/docs/orders-api/manage-orders#sparse
+    # -order-objects)
+    # containing only the fields to update and the version the update is
+    # being applied to.
+    # - If deleting fields, the [dot notation
+    # paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot
+    # -notation)
+    # identifying fields to clear.
+    # To pay for an order, please refer to the [Pay for
+    # Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders)
+    # guide.
+    # @param [String] order_id Required parameter: The ID of the order to
+    # update.
+    # @param [UpdateOrderRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [UpdateOrderResponse Hash] response from the API call
+    def update_order(order_id:,
+                     body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/orders/{order_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'order_id' => order_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.put(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(_response, data: decoded, errors: _errors)
+    end
+
     # Pay for an [order](#type-order) using one or more approved
     # [payments](#type-payment),
     # or settle an order with a total of `0`.
@@ -255,8 +231,6 @@ module Square
     # layed-capture).
     # Using a delayed capture payment with PayOrder will complete the approved
     # payment.
-    # Learn how to [pay for orders with a single payment using the Payments
-    # API](https://developer.squareup.com/docs/orders-api/pay-for-orders).
     # @param [String] order_id Required parameter: The ID of the order being
     # paid.
     # @param [PayOrderRequest] body Required parameter: An object containing the

data/lib/square/api/payments_api.rb

@@ -22,14 +22,18 @@ module Square
     # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
     # for more information.
     # @param [String] location_id Optional parameter: Limit results to the
-    # location supplied. By default, results are returned for all locations
-    # associated with the merchant.
+    # location supplied. By default, results are returned for the default (main)
+    # location associated with the merchant.
     # @param [Long] total Optional parameter: The exact amount in the
     # total_money for a `Payment`.
     # @param [String] last_4 Optional parameter: The last 4 digits of `Payment`
     # card.
     # @param [String] card_brand Optional parameter: The brand of `Payment`
     # card. For example, `VISA`
+    # @param [Integer] limit Optional parameter: Maximum number of results to be
+    # returned in a single page. It is possible to receive fewer results than
+    # the specified limit on a given page.  If the supplied value is greater
+    # than 100, at most 100 results will be returned.  Default: `100`
     # @return [ListPaymentsResponse Hash] response from the API call
     def list_payments(begin_time: nil,
                       end_time: nil,
@@ -38,7 +42,8 @@ module Square
                       location_id: nil,
                       total: nil,
                       last_4: nil,
-                      card_brand: nil)
+                      card_brand: nil,
+                      limit: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/payments'
@@ -51,7 +56,8 @@ module Square
         'location_id' => location_id,
         'total' => total,
         'last_4' => last_4,
-        'card_brand' => card_brand
+        'card_brand' => card_brand,
+        'limit' => limit
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -82,9 +88,6 @@ module Square
     # For example, tip money, whether to autocomplete the payment, or a
     # reference ID
     # to correlate this payment with another system.
-    # For more information about these
-    # payment options, see [Take
-    # Payments](https://developer.squareup.com/docs/payments-api/take-payments).
     # The `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required
     # to enable application fees.
     # @param [CreatePaymentRequest] body Required parameter: An object
@@ -199,10 +202,7 @@ module Square
 
     # Cancels (voids) a payment. If you set `autocomplete` to false when
     # creating a payment,
-    # you can cancel the payment using this endpoint. For more information, see
-    # [Delayed
-    # Payments](https://developer.squareup.com/docs/payments-api/take-payments#d
-    # elayed-payments).
+    # you can cancel the payment using this endpoint.
     # @param [String] payment_id Required parameter: `payment_id` identifying
     # the payment to be canceled.
     # @return [CancelPaymentResponse Hash] response from the API call
@@ -240,18 +240,11 @@ module Square
     # created.
     # If you set autocomplete to false when creating a payment, you can complete
     # (capture)
-    # the payment using this endpoint. For more information, see
-    # [Delayed
-    # Payments](https://developer.squareup.com/docs/payments-api/take-payments#d
-    # elayed-payments).
+    # the payment using this endpoint.
     # @param [String] payment_id Required parameter: Unique ID identifying the
     # payment to be completed.
-    # @param [Object] body Required parameter: An object containing the fields
-    # to POST for the request.  See the corresponding object definition for
-    # field details.
     # @return [CompletePaymentResponse Hash] response from the API call
-    def complete_payment(payment_id:,
-                         body:)
+    def complete_payment(payment_id:)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/payments/{payment_id}/complete'
@@ -263,15 +256,13 @@ module Square
 
       # Prepare headers.
       _headers = {
-        'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'accept' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
       _request = config.http_client.post(
         _query_url,
-        headers: _headers,
-        parameters: body.to_json
+        headers: _headers
       )
       OAuth2.apply(config, _request)
       _response = execute_request(_request)

data/lib/square/api/refunds_api.rb

@@ -21,8 +21,9 @@ module Square
     # results for the original query.  See
     # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
     # for more information.
-    # @param [String] location_id Optional parameter: ID of location associated
-    # with payment.
+    # @param [String] location_id Optional parameter: Limit results to the
+    # location supplied. By default, results are returned for all locations
+    # associated with the merchant.
     # @param [String] status Optional parameter: If provided, only refunds with
     # the given status are returned. For a list of refund status values, see
     # [PaymentRefund](#type-paymentrefund).  Default: If omitted refunds are
@@ -31,6 +32,10 @@ module Square
     # with the given source type are returned. - `CARD` - List refunds only for
     # payments where card was specified as payment source.  Default: If omitted
     # refunds are returned regardless of source type.
+    # @param [Integer] limit Optional parameter: Maximum number of results to be
+    # returned in a single page. It is possible to receive fewer results than
+    # the specified limit on a given page.  If the supplied value is greater
+    # than 100, at most 100 results will be returned.  Default: `100`
     # @return [ListPaymentRefundsResponse Hash] response from the API call
     def list_payment_refunds(begin_time: nil,
                              end_time: nil,
@@ -38,7 +43,8 @@ module Square
                              cursor: nil,
                              location_id: nil,
                              status: nil,
-                             source_type: nil)
+                             source_type: nil,
+                             limit: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/refunds'
@@ -50,7 +56,8 @@ module Square
         'cursor' => cursor,
         'location_id' => location_id,
         'status' => status,
-        'source_type' => source_type
+        'source_type' => source_type,
+        'limit' => limit
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -74,9 +81,7 @@ module Square
     end
 
     # Refunds a payment. You can refund the entire payment amount or a
-    # portion of it. For more information, see
-    # [Payments and Refunds
-    # Overview](https://developer.squareup.com/docs/payments-api/overview).
+    # portion of it.
     # @param [RefundPaymentRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.