square.rb 8.1.0.20210121 → 18.1.0.20220316

data/lib/square/api/orders_api.rb

@@ -5,14 +5,14 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Creates a new [Order](#type-order) which can include information on
+    # Creates a new [order]($m/Order) that can include information about
     # products for
     # purchase and settings to apply to the purchase.
-    # To pay for a created order, please refer to the [Pay for
-    # Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders)
-    # guide.
-    # You can modify open orders using the
-    # [UpdateOrder](#endpoint-orders-updateorder) endpoint.
+    # To pay for a created order, see
+    # [Pay for
+    # Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).
+    # You can modify open orders using the [UpdateOrder]($e/Orders/UpdateOrder)
+    # endpoint.
     # @param [CreateOrderRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -26,7 +26,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -46,8 +46,8 @@ module Square
       )
     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
+    # Retrieves a set of [orders]($m/Order) by their IDs.
+    # If a given order ID does not exist, the ID is ignored instead of
     # generating an error.
     # @param [BatchRetrieveOrdersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -62,7 +62,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -82,7 +82,7 @@ module Square
       )
     end
 
-    # Calculates an [Order](#type-order).
+    # Enables applications to preview order pricing without creating an order.
     # @param [CalculateOrderRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -96,7 +96,44 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _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
+
+    # Creates a new order, in the `DRAFT` state, by duplicating an existing
+    # order. The newly created order has
+    # only the core fields (such as line items, taxes, and discounts) copied
+    # from the original order.
+    # @param [CloneOrderRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [CloneOrderResponse Hash] response from the API call
+    def clone_order(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/orders/clone'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -118,17 +155,18 @@ module Square
 
     # Search all orders for one or more locations. Orders include all sales,
     # returns, and exchanges regardless of how or when they entered the Square
-    # Ecosystem (e.g. Point of Sale, Invoices, Connect APIs, etc).
-    # SearchOrders requests need to specify which locations to search and define
-    # a
-    # [`SearchOrdersQuery`](#type-searchordersquery) object which controls
-    # how to sort or filter the results. Your SearchOrdersQuery can:
+    # ecosystem (such as Point of Sale, Invoices, and Connect APIs).
+    # `SearchOrders` requests need to specify which locations to search and
+    # define a
+    # [SearchOrdersQuery]($m/SearchOrdersQuery) object that controls
+    # how to sort or filter the results. Your `SearchOrdersQuery` can:
     #   Set filter criteria.
-    #   Set sort order.
-    #   Determine whether to return results as complete Order objects, or as
-    # [OrderEntry](#type-orderentry) objects.
+    #   Set the sort order.
+    #   Determine whether to return results as complete `Order` objects or as
+    # [OrderEntry]($m/OrderEntry) objects.
     # Note that details for orders processed with Square Point of Sale while in
-    # offline mode may not be transmitted to Square for up to 72 hours. Offline
+    # offline mode might not be transmitted to Square for up to 72 hours.
+    # Offline
     # orders have a `created_at` value that reflects the time the order was
     # created,
     # not the time it was subsequently transmitted to Square.
@@ -145,7 +183,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -165,7 +203,7 @@ module Square
       )
     end
 
-    # Retrieves an [Order](#type-order) by ID.
+    # Retrieves an [Order]($m/Order) by ID.
     # @param [String] order_id Required parameter: The ID of the order to
     # retrieve.
     # @return [RetrieveOrderResponse Hash] response from the API call
@@ -200,23 +238,24 @@ module Square
       )
     end
 
-    # Updates an open [Order](#type-order) by adding, replacing, or deleting
+    # Updates an open [order]($m/Order) by adding, replacing, or deleting
     # fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.
-    # An UpdateOrder request requires the following:
+    # 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.
+    # containing only the fields to update and the version to which the update
+    # is
+    # being applied.
     # - 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.
+    # identifying the fields to clear.
+    # To pay for an order, see
+    # [Pay for
+    # Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).
     # @param [String] order_id Required parameter: The ID of the order to
     # update.
     # @param [UpdateOrderRequest] body Required parameter: An object containing
@@ -237,7 +276,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -257,24 +296,24 @@ module Square
       )
     end
 
-    # Pay for an [order](#type-order) using one or more approved
-    # [payments](#type-payment),
+    # Pay for an [order]($m/Order) using one or more approved
+    # [payments]($m/Payment)
     # or settle an order with a total of `0`.
     # The total of the `payment_ids` listed in the request must be equal to the
     # order
     # total. Orders with a total amount of `0` can be marked as paid by
     # specifying an empty
     # array of `payment_ids` in the request.
-    # To be used with PayOrder, a payment must:
+    # To be used with `PayOrder`, a payment must:
     # - Reference the order by specifying the `order_id` when [creating the
-    # payment](#endpoint-payments-createpayment).
+    # payment]($e/Payments/CreatePayment).
     # Any approved payments that reference the same `order_id` not specified in
     # the
-    # `payment_ids` will be canceled.
+    # `payment_ids` is canceled.
     # - Be approved with [delayed
     # capture](https://developer.squareup.com/docs/payments-api/take-payments#de
     # layed-capture).
-    # Using a delayed capture payment with PayOrder will complete the approved
+    # Using a delayed capture payment with `PayOrder` completes the approved
     # payment.
     # @param [String] order_id Required parameter: The ID of the order being
     # paid.
@@ -296,7 +335,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.

data/lib/square/api/payments_api.rb

@@ -6,6 +6,9 @@ module Square
     end
 
     # Retrieves a list of payments taken by the account making the request.
+    # Results are eventually consistent, and new payments or changes to payments
+    # might take several
+    # seconds to appear.
     # 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:
@@ -83,16 +86,14 @@ module Square
       )
     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 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
-    # reference ID
-    # to correlate this payment with another system).
-    # The `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required
-    # to enable application fees.
+    # Creates a payment using the provided source. You can use this endpoint
+    # to charge a card (credit/debit card or
+    # Square gift card) or record a payment that the seller received outside of
+    # Square
+    # (cash payment from a buyer or a payment that an external entity
+    # processed on behalf of the seller).
+    # The endpoint creates a
+    # `Payment` object and returns it in the response.
     # @param [CreatePaymentRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -106,7 +107,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -154,7 +155,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -209,11 +210,53 @@ module Square
       )
     end
 
-    # Cancels (voids) a payment. If you set `autocomplete` to `false` when
-    # creating a payment,
-    # you can cancel the payment using this endpoint.
-    # @param [String] payment_id Required parameter: The `payment_id`
-    # identifying the payment to be canceled.
+    # Updates a payment with the APPROVED status.
+    # You can update the `amount_money` and `tip_money` using this endpoint.
+    # @param [String] payment_id Required parameter: The ID of the payment to
+    # update.
+    # @param [UpdatePaymentRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [UpdatePaymentResponse Hash] response from the API call
+    def update_payment(payment_id:,
+                       body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/payments/{payment_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'payment_id' => { 'value' => payment_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # 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
+
+    # Cancels (voids) a payment. You can use this endpoint to cancel a payment
+    # with
+    # the APPROVED `status`.
+    # @param [String] payment_id Required parameter: The ID of the payment to
+    # cancel.
     # @return [CancelPaymentResponse Hash] response from the API call
     def cancel_payment(payment_id:)
       # Prepare query url.
@@ -249,13 +292,16 @@ module Square
     # 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.
+    # You can use this endpoint to complete a payment with the APPROVED
+    # `status`.
     # @param [String] payment_id Required parameter: The unique ID identifying
     # the payment to be completed.
+    # @param [CompletePaymentRequest] 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:)
+    def complete_payment(payment_id:,
+                         body:)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/payments/{payment_id}/complete'
@@ -267,13 +313,15 @@ module Square
 
       # Prepare headers.
       _headers = {
-        'accept' => 'application/json'
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
       _request = config.http_client.post(
         _query_url,
-        headers: _headers
+        headers: _headers,
+        parameters: body.to_json
       )
       OAuth2.apply(config, _request)
       _response = execute_request(_request)

data/lib/square/api/refunds_api.rb

@@ -6,6 +6,9 @@ module Square
     end
 
     # Retrieves a list of refunds for the account making the request.
+    # Results are eventually consistent, and new refunds or changes to refunds
+    # might take several
+    # seconds to appear.
     # The maximum results per page is 100.
     # @param [String] begin_time Optional parameter: The timestamp for the
     # beginning of the requested reporting period, in RFC 3339 format.  Default:
@@ -26,12 +29,15 @@ module Square
     # associated with the seller.
     # @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
+    # [PaymentRefund]($m/PaymentRefund).  Default: If omitted, refunds are
     # returned regardless of their status.
-    # @param [String] source_type Optional parameter: If provided, only refunds
-    # with the given source type are returned. - `CARD` - List refunds only for
-    # payments where `CARD` was specified as the payment source.  Default: If
-    # omitted, refunds are returned regardless of the source type.
+    # @param [String] source_type Optional parameter: If provided, only returns
+    # refunds whose payments have the indicated source type. Current values
+    # include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, and `EXTERNAL`. For
+    # information about these payment source types, see [Take
+    # Payments](https://developer.squareup.com/docs/payments-api/take-payments).
+    #  Default: If omitted, refunds are returned regardless of the source
+    # type.
     # @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.  If the supplied value is
@@ -83,7 +89,12 @@ module Square
     end
 
     # Refunds a payment. You can refund the entire payment amount or a
-    # portion of it.
+    # portion of it. You can use this endpoint to refund a card payment or
+    # record a
+    # refund of a cash or external payment. For more information, see
+    # [Refund
+    # Payment](https://developer.squareup.com/docs/payments-api/refund-payments)
+    # .
     # @param [RefundPaymentRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -97,7 +108,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.

data/lib/square/api/sites_api.rb

@@ -0,0 +1,43 @@
+module Square
+  # SitesApi
+  class SitesApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Lists the Square Online sites that belong to a seller. Sites are listed in
+    # descending order by the `created_at` date.
+    # __Note:__ Square Online APIs are publicly available as part of an early
+    # access program. For more information, see [Early access program for Square
+    # Online
+    # APIs](https://developer.squareup.com/docs/online-api#early-access-program-
+    # for-square-online-apis).
+    # @return [ListSitesResponse Hash] response from the API call
+    def list_sites
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/sites'
+      _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
+  end
+end

data/lib/square/api/snippets_api.rb

@@ -0,0 +1,146 @@
+module Square
+  # SnippetsApi
+  class SnippetsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Removes your snippet from a Square Online site.
+    # You can call [ListSites]($e/Sites/ListSites) to get the IDs of the sites
+    # that belong to a seller.
+    # __Note:__ Square Online APIs are publicly available as part of an early
+    # access program. For more information, see [Early access program for Square
+    # Online
+    # APIs](https://developer.squareup.com/docs/online-api#early-access-program-
+    # for-square-online-apis).
+    # @param [String] site_id Required parameter: The ID of the site that
+    # contains the snippet.
+    # @return [DeleteSnippetResponse Hash] response from the API call
+    def delete_snippet(site_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/sites/{site_id}/snippet'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'site_id' => { 'value' => site_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _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
+
+    # Retrieves your snippet from a Square Online site. A site can contain
+    # snippets from multiple snippet applications, but you can retrieve only the
+    # snippet that was added by your application.
+    # You can call [ListSites]($e/Sites/ListSites) to get the IDs of the sites
+    # that belong to a seller.
+    # __Note:__ Square Online APIs are publicly available as part of an early
+    # access program. For more information, see [Early access program for Square
+    # Online
+    # APIs](https://developer.squareup.com/docs/online-api#early-access-program-
+    # for-square-online-apis).
+    # @param [String] site_id Required parameter: The ID of the site that
+    # contains the snippet.
+    # @return [RetrieveSnippetResponse Hash] response from the API call
+    def retrieve_snippet(site_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/sites/{site_id}/snippet'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'site_id' => { 'value' => site_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
+
+    # Adds a snippet to a Square Online site or updates the existing snippet on
+    # the site.
+    # The snippet code is appended to the end of the `head` element on every
+    # page of the site, except checkout pages. A snippet application can add one
+    # snippet to a given site.
+    # You can call [ListSites]($e/Sites/ListSites) to get the IDs of the sites
+    # that belong to a seller.
+    # __Note:__ Square Online APIs are publicly available as part of an early
+    # access program. For more information, see [Early access program for Square
+    # Online
+    # APIs](https://developer.squareup.com/docs/online-api#early-access-program-
+    # for-square-online-apis).
+    # @param [String] site_id Required parameter: The ID of the site where you
+    # want to add or update the snippet.
+    # @param [UpsertSnippetRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [UpsertSnippetResponse Hash] response from the API call
+    def upsert_snippet(site_id:,
+                       body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/sites/{site_id}/snippet'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'site_id' => { 'value' => site_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _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
+  end
+end