square.rb 6.2.0.20200812 → 8.0.0.20201216

data/lib/square/api/o_auth_api.rb

@@ -44,7 +44,7 @@ module Square
       _query_builder << '/oauth2/clients/{client_id}/access-token/renew'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'client_id' => client_id
+        'client_id' => { 'value' => client_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -66,7 +66,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Revokes an access token generated with the OAuth flow.
@@ -83,7 +85,7 @@ module Square
     # ```
     # Replace `APPLICATION_SECRET` with the application secret on the
     # Credentials
-    # page in the [application dashboard](https://connect.squareup.com/apps).
+    # page in the [Developer Dashboard](https://developer.squareup.com/apps).
     # @param [RevokeTokenRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -115,16 +117,15 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Returns an OAuth access token.
     # The endpoint supports distinct methods of obtaining OAuth access tokens.
     # Applications specify a method by adding the `grant_type` parameter
     # in the request and also provide relevant information.
-    # For more information, see [OAuth access token
-    # management](https://developer.squareup.com/docs/authz/oauth/how-it-works#o
-    # auth-access-token-management).
     # __Note:__ Regardless of the method application specified,
     # the endpoint always returns two items; an OAuth access token and
     # a refresh token in the response.
@@ -157,7 +158,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end

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.
@@ -51,27 +41,22 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # 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.
@@ -92,69 +77,9 @@ module Square
       # 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
-
-    # 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
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
       )
-      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).
@@ -186,7 +111,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Search all orders for one or more locations. Orders include all sales,
@@ -233,7 +160,101 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Retrieves an [Order](#type-order) by ID.
+    # @param [String] order_id Required parameter: The ID of the order to
+    # retrieve.
+    # @return [RetrieveOrderResponse Hash] response from the API call
+    def retrieve_order(order_id:)
+      # 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' => { 'value' => order_id, 'encode' => true }
+      )
+      _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
+
+    # 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' => { 'value' => order_id, 'encode' => true }
+      )
+      _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
@@ -255,8 +276,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
@@ -270,7 +289,7 @@ module Square
       _query_builder << '/v2/orders/{order_id}/pay'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'order_id' => order_id
+        'order_id' => { 'value' => order_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -292,7 +311,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end

data/lib/square/api/payments_api.rb

@@ -6,30 +6,35 @@ module Square
     end
 
     # Retrieves a list of payments taken by the account making the request.
-    # Max results per page: 100
-    # @param [String] begin_time Optional parameter: Timestamp for the beginning
-    # of the reporting period, in RFC 3339 format. Inclusive. Default: The
-    # current time minus one year.
-    # @param [String] end_time Optional parameter: Timestamp for the end of the
-    # requested reporting period, in RFC 3339 format.  Default: The current
-    # time.
+    # The maximum results per page is 100.
+    # @param [String] begin_time Optional parameter: The timestamp for the
+    # beginning of the reporting period, in RFC 3339 format. Inclusive. Default:
+    # The current time minus one year.
+    # @param [String] end_time Optional parameter: The timestamp for the end of
+    # the reporting period, in RFC 3339 format.  Default: The current time.
     # @param [String] sort_order Optional parameter: The order in which results
-    # are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest
+    # are listed: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest
     # (default).
     # @param [String] cursor Optional parameter: A pagination cursor returned by
-    # a previous call to this endpoint. Provide this to retrieve the next set of
-    # results for the original query.  See
+    # a previous call to this endpoint. Provide this cursor to retrieve the next
+    # set of results for the original query.  For more information, see
     # [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 seller.
     # @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`
+    # `total_money` for a payment.
+    # @param [String] last_4 Optional parameter: The last four digits of a
+    # payment card.
+    # @param [String] card_brand Optional parameter: The brand of the payment
+    # card (for example, VISA).
+    # @param [Integer] limit Optional parameter: The 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.  The default value of 100 is
+    # also the maximum allowed value. If the provided value is  greater than
+    # 100, it is ignored and the default value is used instead.  Default:
+    # `100`
     # @return [ListPaymentsResponse Hash] response from the API call
     def list_payments(begin_time: nil,
                       end_time: nil,
@@ -38,7 +43,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 +57,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
 
@@ -71,20 +78,19 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
-    # Charges a payment source, for example, a card
-    # represented by customer's card on file or a card nonce. In addition
-    # to the payment source, the request must also include the
+    # Charges a payment source (for example, a card
+    # represented by customer's card on file or a card nonce). In addition
+    # to the payment source, the request must include the
     # amount to accept for the payment.
-    # There are several optional parameters that you can include in the request.
-    # For example, tip money, whether to autocomplete the payment, or a
+    # There are several optional parameters that you can include in the request
+    # (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).
+    # to correlate this payment with another system).
     # The `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required
     # to enable application fees.
     # @param [CreatePaymentRequest] body Required parameter: An object
@@ -115,24 +121,26 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Cancels (voids) a payment identified by the idempotency key that is
     # specified in the
     # request.
-    # Use this method when status of a CreatePayment request is unknown. For
-    # example, after you send a
-    # CreatePayment request a network error occurs and you don't get a response.
-    # In this case, you can
+    # Use this method when the status of a `CreatePayment` request is unknown
+    # (for example, after you send a
+    # `CreatePayment` request, a network error occurs and you do not get a
+    # response). In this case, you can
     # direct Square to cancel the payment using this endpoint. In the request,
     # you provide the same
-    # idempotency key that you provided in your CreatePayment request you want 
-    # to cancel. After
-    # cancelling the payment, you can submit your CreatePayment request again.
+    # idempotency key that you provided in your `CreatePayment` request that you
+    # want to cancel. After
+    # canceling the payment, you can submit your `CreatePayment` request again.
     # Note that if no payment with the specified idempotency key is found, no
-    # action is taken, the end
-    # point returns successfully.
+    # action is taken and the endpoint
+    # returns successfully.
     # @param [CancelPaymentByIdempotencyKeyRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
@@ -161,12 +169,14 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
-    # Retrieves details for a specific Payment.
-    # @param [String] payment_id Required parameter: Unique ID for the desired
-    # `Payment`.
+    # Retrieves details for a specific payment.
+    # @param [String] payment_id Required parameter: A unique ID for the desired
+    # payment.
     # @return [GetPaymentResponse Hash] response from the API call
     def get_payment(payment_id:)
       # Prepare query url.
@@ -174,7 +184,7 @@ module Square
       _query_builder << '/v2/payments/{payment_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'payment_id' => payment_id
+        'payment_id' => { 'value' => payment_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -194,17 +204,16 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
-    # Cancels (voids) a payment. If you set `autocomplete` to false when
+    # 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).
-    # @param [String] payment_id Required parameter: `payment_id` identifying
-    # the payment to be canceled.
+    # you can cancel the payment using this endpoint.
+    # @param [String] payment_id Required parameter: The `payment_id`
+    # identifying the payment to be canceled.
     # @return [CancelPaymentResponse Hash] response from the API call
     def cancel_payment(payment_id:)
       # Prepare query url.
@@ -212,7 +221,7 @@ module Square
       _query_builder << '/v2/payments/{payment_id}/cancel'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'payment_id' => payment_id
+        'payment_id' => { 'value' => payment_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -232,20 +241,19 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Completes (captures) a payment.
     # By default, payments are set to complete immediately after they are
     # 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).
-    # @param [String] payment_id Required parameter: Unique ID identifying the
-    # payment to be completed.
+    # If you set `autocomplete` to `false` when creating a payment, you can
+    # complete (capture)
+    # the payment using this endpoint.
+    # @param [String] payment_id Required parameter: The unique ID identifying
+    # the payment to be completed.
     # @return [CompletePaymentResponse Hash] response from the API call
     def complete_payment(payment_id:)
       # Prepare query url.
@@ -253,7 +261,7 @@ module Square
       _query_builder << '/v2/payments/{payment_id}/complete'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'payment_id' => payment_id
+        'payment_id' => { 'value' => payment_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -273,7 +281,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end