square.rb 9.0.0.20210226 → 11.0.0.20210513

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.
@@ -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; 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
+
+    # 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,9 +292,8 @@ 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.
     # @return [CompletePaymentResponse Hash] response from the API call

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,7 +29,7 @@ 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
@@ -83,7 +86,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.

data/lib/square/api/sites_api.rb

@@ -0,0 +1,42 @@
+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.
+    # __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; charset=utf-8'
+      }
+
+      # 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

data/lib/square/api/subscriptions_api.rb

@@ -220,7 +220,7 @@ module Square
     # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
     # ion).
     # @param [Integer] limit Optional parameter: The upper limit on the number
-    # of subscription events to return  in the response.   Default: `200`
+    # of subscription events to return in the response.  Default: `200`
     # @return [ListSubscriptionEventsResponse Hash] response from the API call
     def list_subscription_events(subscription_id:,
                                  cursor: nil,
@@ -259,5 +259,40 @@ module Square
         _response, data: decoded, errors: _errors
       )
     end
+
+    # Resumes a deactivated subscription.
+    # @param [String] subscription_id Required parameter: The ID of the
+    # subscription to resume.
+    # @return [ResumeSubscriptionResponse Hash] response from the API call
+    def resume_subscription(subscription_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/subscriptions/{subscription_id}/resume'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'subscription_id' => { 'value' => subscription_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _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/team_api.rb

@@ -54,8 +54,8 @@ module Square
     # marked as failed, but the body of the response
     # will contain explicit error information for this particular create.
     # Learn about [Troubleshooting the Teams
-    # API](https://developer.squareup.com/docs/team/troubleshooting#bulkcreatete
-    # ammembers).
+    # API](https://developer.squareup.com/docs/team/troubleshooting#bulk-create-
+    # team-members).
     # @param [BulkCreateTeamMembersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -97,8 +97,8 @@ module Square
     # marked as failed, but the body of the response
     # will contain explicit error information for this particular update.
     # Learn about [Troubleshooting the Teams
-    # API](https://developer.squareup.com/docs/team/troubleshooting#bulkupdatete
-    # ammembers).
+    # API](https://developer.squareup.com/docs/team/troubleshooting#bulk-update-
+    # team-members).
     # @param [BulkUpdateTeamMembersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -171,8 +171,8 @@ module Square
 
     # Retrieve a `TeamMember` object for the given `TeamMember.id`.
     # Learn about [Troubleshooting the Teams
-    # API](https://developer.squareup.com/docs/team/troubleshooting#retrieveteam
-    # member).
+    # API](https://developer.squareup.com/docs/team/troubleshooting#retrieve-a-t
+    # eam-member).
     # @param [String] team_member_id Required parameter: The ID of the team
     # member to retrieve.
     # @return [RetrieveTeamMemberResponse Hash] response from the API call
@@ -210,8 +210,8 @@ module Square
     # Updates a single `TeamMember` object. The `TeamMember` will be returned on
     # successful updates.
     # Learn about [Troubleshooting the Teams
-    # API](https://developer.squareup.com/docs/team/troubleshooting#updateteamme
-    # mber).
+    # API](https://developer.squareup.com/docs/team/troubleshooting#update-a-tea
+    # m-member).
     # @param [String] team_member_id Required parameter: The ID of the team
     # member to update.
     # @param [UpdateTeamMemberRequest] body Required parameter: An object
@@ -297,8 +297,8 @@ module Square
     # it fully replaces the `WageSetting` object for the team member.
     # The `WageSetting` will be returned upon successful update.
     # Learn about [Troubleshooting the Teams
-    # API](https://developer.squareup.com/docs/team/troubleshooting#updatewagese
-    # tting).
+    # API](https://developer.squareup.com/docs/team/troubleshooting#create-or-up
+    # date-a-wage-setting).
     # @param [String] team_member_id Required parameter: The ID of the team
     # member to update the `WageSetting` object for.
     # @param [UpdateWageSettingRequest] body Required parameter: An object

data/lib/square/api/terminal_api.rb

@@ -5,8 +5,9 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Creates a new Terminal checkout request and sends it to the specified
-    # device to take a payment for the requested amount.
+    # Creates a Terminal checkout request and sends it to the specified device
+    # to take a payment
+    # for the requested amount.
     # @param [CreateTerminalCheckoutRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -75,9 +76,9 @@ module Square
       )
     end
 
-    # Retrieves a Terminal checkout request by checkout_id.
-    # @param [String] checkout_id Required parameter: Unique ID for the desired
-    # `TerminalCheckout`
+    # Retrieves a Terminal checkout request by `checkout_id`.
+    # @param [String] checkout_id Required parameter: The unique ID for the
+    # desired `TerminalCheckout`.
     # @return [GetTerminalCheckoutResponse Hash] response from the API call
     def get_terminal_checkout(checkout_id:)
       # Prepare query url.
@@ -112,8 +113,8 @@ module Square
 
     # Cancels a Terminal checkout request if the status of the request permits
     # it.
-    # @param [String] checkout_id Required parameter: Unique ID for the desired
-    # `TerminalCheckout`
+    # @param [String] checkout_id Required parameter: The unique ID for the
+    # desired `TerminalCheckout`.
     # @return [CancelTerminalCheckoutResponse Hash] response from the API call
     def cancel_terminal_checkout(checkout_id:)
       # Prepare query url.
@@ -181,7 +182,7 @@ module Square
       )
     end
 
-    # Retrieves a filtered list of Terminal Interac refund requests created by
+    # Retrieves a filtered list of Interac Terminal refund requests created by
     # the seller making the request.
     # @param [SearchTerminalRefundsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -216,9 +217,9 @@ module Square
       )
     end
 
-    # Retrieves an Interac terminal refund object by ID.
-    # @param [String] terminal_refund_id Required parameter: Unique ID for the
-    # desired `TerminalRefund`
+    # Retrieves an Interac Terminal refund object by ID.
+    # @param [String] terminal_refund_id Required parameter: The unique ID for
+    # the desired `TerminalRefund`.
     # @return [GetTerminalRefundResponse Hash] response from the API call
     def get_terminal_refund(terminal_refund_id:)
       # Prepare query url.
@@ -251,10 +252,10 @@ module Square
       )
     end
 
-    # Cancels an Interac terminal refund request by refund request ID if the
+    # Cancels an Interac Terminal refund request by refund request ID if the
     # status of the request permits it.
-    # @param [String] terminal_refund_id Required parameter: Unique ID for the
-    # desired `TerminalRefund`
+    # @param [String] terminal_refund_id Required parameter: The unique ID for
+    # the desired `TerminalRefund`.
     # @return [CancelTerminalRefundResponse Hash] response from the API call
     def cancel_terminal_refund(terminal_refund_id:)
       # Prepare query url.