square.rb 18.1.0.20220316 → 20.1.0.20220616

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbb5aeea53c32ac7828ffb52501c522f8e4811bb81aa4f0deb453802dcc9147e
-  data.tar.gz: 2526651aefdbeb8e605d35ef011de1c21f241e860c9d3fde2853b3c9e8912932
+  metadata.gz: 68c3c60d1b69c141d163be8e453c91bd76cca35f98228aeae4a41f7b61afe8a6
+  data.tar.gz: 3df6c78f8e6e493967624fca0cd804c1547aa6ccfb2b57daaac05695a33df12d
 SHA512:
-  metadata.gz: 500aa37342e9b95690d2541bc0f55d4b2ba2797290439a9da44bb1056b3aaf20d741a30b853afdaf9a81be4720b1b2284062974ac5c31908b17e0bc858725fa8
-  data.tar.gz: 83e45f18a23572b205a30ac3aad83529a6f94e0ae2a340ce28d3a06b243ace51e315114ca5e24cfa8676420d705dd7d80aec69053306eb63f799578c9a499f97
+  metadata.gz: ab11afe945aa6630b158b07040290572d591b15e2d0829363dd334fc38f5197cc2d5eed47a36cf84e68061667d91b874486892da5acebb4f25420b8bec6e190b
+  data.tar.gz: 3427cb9920daac7363c982754ab7a5c8ef1abf609786e9c8b2bb4a6a4f82da77a2b05e9d7758d71c86613ef8dc54536ea44b9c9f9eed44576d90272121327b67

data/README.md

@@ -62,6 +62,7 @@ rake
 * [Checkout]
 * [Apple Pay]
 * [Cards]
+* [Payouts]
 
 ### Terminal
 * [Terminal]
@@ -81,6 +82,7 @@ rake
 
 ### Customers
 * [Customers]
+* [Customer Custom Attributes]
 * [Customer Groups]
 * [Customer Segments]
 
@@ -99,6 +101,7 @@ rake
 * [Locations]
 * [Devices]
 * [Cash Drawers]
+* [Vendors]
 
 ### Team
 * [Team]
@@ -134,6 +137,7 @@ rake
 [Terminal]: doc/api/terminal.md
 [Team]: doc/api/team.md
 [Cash Drawers]: doc/api/cash-drawers.md
+[Vendors]: doc/api/vendors.md
 [Customer Groups]: doc/api/customer-groups.md
 [Customer Segments]: doc/api/customer-segments.md
 [Bank Accounts]: doc/api/bank-accounts.md
@@ -141,6 +145,7 @@ rake
 [Checkout]: doc/api/checkout.md
 [Catalog]: doc/api/catalog.md
 [Customers]: doc/api/customers.md
+[Customer Custom Attributes]: doc/api/customer-custom-attributes.md
 [Employees]: doc/api/employees.md
 [Inventory]: doc/api/inventory.md
 [Labor]: doc/api/labor.md
@@ -162,5 +167,6 @@ rake
 [Sites]: doc/api/sites.md
 [Snippets]: doc/api/snippets.md
 [Cards]: doc/api/cards.md
+[Payouts]: doc/api/payouts.md
 [Gift Cards]: doc/api/gift-cards.md
 [Gift Card Activities]: doc/api/gift-card-activities.md

data/lib/square/api/base_api.rb

@@ -38,7 +38,7 @@ module Square
     end
 
     def get_user_agent
-      user_agent = 'Square-Ruby-SDK/18.1.0.20220316 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      user_agent = 'Square-Ruby-SDK/20.1.0.20220616 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
       user_agent['{engine}'] = RUBY_ENGINE
       user_agent['{engine-version}'] = RUBY_ENGINE_VERSION
       user_agent['{os-info}'] = RUBY_PLATFORM

data/lib/square/api/bookings_api.rb

@@ -74,6 +74,9 @@ module Square
     # `APPOINTMENTS_WRITE` for the OAuth scope.
     # To call this endpoint with seller-level permissions, set
     # `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+    # For calls to this endpoint with seller-level permissions to succeed, the
+    # seller must have subscribed to *Appointments Plus*
+    # or *Appointments Premium*.
     # @param [CreateBookingRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -303,6 +306,9 @@ module Square
     # `APPOINTMENTS_WRITE` for the OAuth scope.
     # To call this endpoint with seller-level permissions, set
     # `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+    # For calls to this endpoint with seller-level permissions to succeed, the
+    # seller must have subscribed to *Appointments Plus*
+    # or *Appointments Premium*.
     # @param [String] booking_id Required parameter: The ID of the
     # [Booking]($m/Booking) object representing the to-be-updated booking.
     # @param [UpdateBookingRequest] body Required parameter: An object
@@ -348,6 +354,9 @@ module Square
     # `APPOINTMENTS_WRITE` for the OAuth scope.
     # To call this endpoint with seller-level permissions, set
     # `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+    # For calls to this endpoint with seller-level permissions to succeed, the
+    # seller must have subscribed to *Appointments Plus*
+    # or *Appointments Premium*.
     # @param [String] booking_id Required parameter: The ID of the
     # [Booking]($m/Booking) object representing the to-be-cancelled booking.
     # @param [CancelBookingRequest] body Required parameter: An object

data/lib/square/api/catalog_api.rb

@@ -316,9 +316,9 @@ module Square
     # Square API used to make the request. Object types that are nested onto
     # other object types are not included in the defaults.  At the current API
     # version the default object types are: ITEM, CATEGORY, TAX, DISCOUNT,
-    # MODIFIER_LIST, DINING_OPTION, TAX_EXEMPTION, SERVICE_CHARGE, PRICING_RULE,
-    # PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN,
-    # ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.
+    # MODIFIER_LIST,  PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,
+    # SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION,
+    # QUICK_AMOUNT_SETTINGS.
     # @param [Long] catalog_version Optional parameter: The specific version of
     # the catalog objects to be included in the response.  This allows you to
     # retrieve historical versions of objects. The specified version value is

data/lib/square/api/checkout_api.rb

@@ -8,6 +8,13 @@ module Square
     # Links a `checkoutId` to a `checkout_page_url` that customers are
     # directed to in order to provide their payment information using a
     # payment processing workflow hosted on connect.squareup.com.
+    # NOTE: The Checkout API has been updated with new features.
+    # For more information, see [Checkout API
+    # highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-
+    # highlights).
+    # We recommend that you use the
+    # new [CreatePaymentLink]($e/Checkout/CreatePaymentLink)
+    # endpoint in place of this previously released endpoint.
     # @param [String] location_id Required parameter: The ID of the business
     # location to associate the checkout with.
     # @param [CreateCheckoutRequest] body Required parameter: An object
@@ -47,5 +54,200 @@ module Square
         _response, data: decoded, errors: _errors
       )
     end
+
+    # Lists all payment links.
+    # @param [String] cursor Optional parameter: A pagination cursor returned by
+    # a previous call to this endpoint.  Provide this cursor to retrieve the
+    # next set of results for the original query.  If a cursor is not provided,
+    # the endpoint returns the first page of the results.  For more 
+    # information, see
+    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
+    # .
+    # @param [Integer] limit Optional parameter: A limit on the number of
+    # results to return per page. The limit is advisory and  the implementation
+    # might return more or less results. If the supplied limit is negative,
+    # zero, or greater than the maximum limit of 1000, it is ignored.  Default
+    # value: `100`
+    # @return [ListPaymentLinksResponse Hash] response from the API call
+    def list_payment_links(cursor: nil,
+                           limit: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/online-checkout/payment-links'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'cursor' => cursor,
+        'limit' => limit
+      )
+      _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
+
+    # Creates a Square-hosted checkout page. Applications can share the
+    # resulting payment link with their buyer to pay for goods and services.
+    # @param [CreatePaymentLinkRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CreatePaymentLinkResponse Hash] response from the API call
+    def create_payment_link(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/online-checkout/payment-links'
+      _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
+
+    # Deletes a payment link.
+    # @param [String] id Required parameter: The ID of the payment link to
+    # delete.
+    # @return [DeletePaymentLinkResponse Hash] response from the API call
+    def delete_payment_link(id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/online-checkout/payment-links/{id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'id' => { 'value' => 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 a payment link.
+    # @param [String] id Required parameter: The ID of link to retrieve.
+    # @return [RetrievePaymentLinkResponse Hash] response from the API call
+    def retrieve_payment_link(id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/online-checkout/payment-links/{id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'id' => { 'value' => 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 a payment link. You can update the `payment_link` fields such as
+    # `description`, `checkout_options`, and  `pre_populated_data`.
+    # You cannot update other fields such as the `order_id`, `version`, `URL`,
+    # or `timestamp` field.
+    # @param [String] id Required parameter: The ID of the payment link to
+    # update.
+    # @param [UpdatePaymentLinkRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [UpdatePaymentLinkResponse Hash] response from the API call
+    def update_payment_link(id:,
+                            body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/online-checkout/payment-links/{id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'id' => { 'value' => 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
   end
 end