square.rb 19.0.0.20220420 → 20.0.0.20220512

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 431d8365d32b12be40203cfb143d88518f74cee228a0b36755cdc5fc8b782200
-  data.tar.gz: 5349f02eb93bf190d16d17ea0f13d3c434fdcb75a37825e1cdcb6406744c7385
+  metadata.gz: 1907488e99eddc840ad5c67c38ac3feaacf9b6440359b6085add2d248388ab7a
+  data.tar.gz: e6647691aec85fd628b47ac329248f9171a33570bf0eb37871391f7e246a8014
 SHA512:
-  metadata.gz: 65afbe4492802c447ee9aa509cc282720a88e7e34f398609818e4cc60b2262d05584bdb736793d44f4a2d49299f350a4c8241666ebe452634e2ac73097424633
-  data.tar.gz: a0a524485adeb61c20502b6956df68fc908c0e9e52459421be2382ad962ccd17a0e4f128d1bf7ed341a2f9bed95c31da735512ddd73327d7ba739c52ae38d1f9
+  metadata.gz: 1b0d5825af20339f09f49466d34a46825bc25c995eba52108174d1e78ed58083cc1c5b280fecefe4f1edbf94a8ca45aba427c0c01feafac02b6e0b076224f749
+  data.tar.gz: 572efdbd9f3ebb6915ab82e2c2b554e5b2e53d764f6a64f05c4cfd5373118e73f97b9076ad0ce8d0dc70c3c5a540d29db5fb101ceb4bde7da8638e0edc4eb448

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/19.0.0.20220420 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      user_agent = 'Square-Ruby-SDK/20.0.0.20220512 ({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/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

data/lib/square/api/customer_custom_attributes_api.rb

@@ -0,0 +1,540 @@
+module Square
+  # CustomerCustomAttributesApi
+  class CustomerCustomAttributesApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Lists the customer-related custom attribute definitions that belong to a
+    # Square seller account.
+    # When all response pages are retrieved, the results include all custom
+    # attribute definitions
+    # that are visible to the requesting application, including those that are
+    # created by other
+    # applications and set to `VISIBILITY_READ_ONLY` or
+    # `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return in a single paged response. This limit is advisory. The response
+    # might contain more or fewer results. The minimum value is 1 and the
+    # maximum value is 100. The default value is 20. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @param [String] cursor Optional parameter: The cursor returned in the
+    # paged response from the previous call to this endpoint. Provide this
+    # cursor to retrieve the next page of results for your original request. For
+    # more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @return [ListCustomerCustomAttributeDefinitionsResponse Hash] response from the API call
+    def list_customer_custom_attribute_definitions(limit: nil,
+                                                   cursor: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/custom-attribute-definitions'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        '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
+
+    # Creates a customer-related custom attribute definition for a Square seller
+    # account. Use this
+    # endpoint to define a custom attribute that can be associated with customer
+    # profiles.
+    # A custom attribute definition specifies the `key`, `visibility`, `schema`,
+    # and other properties
+    # for a custom attribute. After the definition is created, you can call
+    # [UpsertCustomerCustomAttribute]($e/CustomerCustomAttributes/UpsertCustomer
+    # CustomAttribute) or
+    # [BulkUpsertCustomerCustomAttributes]($e/CustomerCustomAttributes/BulkUpser
+    # tCustomerCustomAttributes)
+    # to set the custom attribute for customer profiles in the seller's Customer
+    # Directory.
+    # Sellers can view all custom attributes in exported customer data,
+    # including those set to
+    # `VISIBILITY_HIDDEN`.
+    # @param [CreateCustomerCustomAttributeDefinitionRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [CreateCustomerCustomAttributeDefinitionResponse Hash] response from the API call
+    def create_customer_custom_attribute_definition(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/custom-attribute-definitions'
+      _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 customer-related custom attribute definition from a Square
+    # seller account.
+    # Deleting a custom attribute definition also deletes the corresponding
+    # custom attribute from
+    # all customer profiles in the seller's Customer Directory.
+    # Only the definition owner can delete a custom attribute definition.
+    # @param [String] key Required parameter: The key of the custom attribute
+    # definition to delete.
+    # @return [DeleteCustomerCustomAttributeDefinitionResponse Hash] response from the API call
+    def delete_customer_custom_attribute_definition(key:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/custom-attribute-definitions/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'key' => { 'value' => key, '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 customer-related custom attribute definition from a Square
+    # seller account.
+    # To retrieve a custom attribute definition created by another application,
+    # the `visibility`
+    # setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [String] key Required parameter: The key of the custom attribute
+    # definition to retrieve. If the requesting application is not the
+    # definition owner, you must use the qualified key.
+    # @param [Integer] version Optional parameter: The current version of the
+    # custom attribute definition, which is used for strongly consistent reads
+    # to guarantee that you receive the most up-to-date data. When included in
+    # the request, Square returns the specified version or a higher version if
+    # one exists. If the specified version is higher than the current version,
+    # Square returns a `BAD_REQUEST` error.
+    # @return [RetrieveCustomerCustomAttributeDefinitionResponse Hash] response from the API call
+    def retrieve_customer_custom_attribute_definition(key:,
+                                                      version: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/custom-attribute-definitions/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'key' => { 'value' => key, 'encode' => true }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'version' => version
+      )
+      _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 customer-related custom attribute definition for a Square seller
+    # account.
+    # Use this endpoint to update the following fields: `name`, `description`,
+    # `visibility`, or the
+    # `schema` for a `Selection` data type.
+    # Only the definition owner can update a custom attribute definition. Note
+    # that sellers can view
+    # all custom attributes in exported customer data, including those set to
+    # `VISIBILITY_HIDDEN`.
+    # @param [String] key Required parameter: The key of the custom attribute
+    # definition to update.
+    # @param [UpdateCustomerCustomAttributeDefinitionRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [UpdateCustomerCustomAttributeDefinitionResponse Hash] response from the API call
+    def update_customer_custom_attribute_definition(key:,
+                                                    body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/custom-attribute-definitions/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'key' => { 'value' => key, '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
+
+    # Creates or updates custom attributes for customer profiles as a bulk
+    # operation.
+    # Use this endpoint to set the value of one or more custom attributes for
+    # one or more customer profiles.
+    # A custom attribute is based on a custom attribute definition in a Square
+    # seller account, which is
+    # created using the
+    # [CreateCustomerCustomAttributeDefinition]($e/CustomerCustomAttributes/Crea
+    # teCustomerCustomAttributeDefinition) endpoint.
+    # This `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to
+    # 25 individual upsert
+    # requests and returns a map of individual upsert responses. Each upsert
+    # request has a unique ID
+    # and provides a customer ID and custom attribute. Each upsert response is
+    # returned with the ID
+    # of the corresponding request.
+    # To create or update a custom attribute owned by another application, the
+    # `visibility` setting
+    # must be `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [BulkUpsertCustomerCustomAttributesRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [BulkUpsertCustomerCustomAttributesResponse Hash] response from the API call
+    def bulk_upsert_customer_custom_attributes(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/custom-attributes/bulk-upsert'
+      _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
+
+    # Lists the custom attributes associated with a customer profile.
+    # You can use the `with_definitions` query parameter to also retrieve custom
+    # attribute definitions
+    # in the same call.
+    # When all response pages are retrieved, the results include all custom
+    # attributes that are
+    # visible to the requesting application, including those that are owned by
+    # other applications
+    # and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [String] customer_id Required parameter: The ID of the target
+    # [customer profile]($m/Customer).
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return in a single paged response. This limit is advisory. The response
+    # might contain more or fewer results. The minimum value is 1 and the
+    # maximum value is 100. The default value is 20. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @param [String] cursor Optional parameter: The cursor returned in the
+    # paged response from the previous call to this endpoint. Provide this
+    # cursor to retrieve the next page of results for your original request. For
+    # more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @param [Boolean] with_definitions Optional parameter: Indicates whether to
+    # return the [custom attribute definition]($m/CustomAttributeDefinition) in
+    # the `definition` field of each custom attribute. Set this parameter to
+    # `true` to get the name and description of each custom attribute,
+    # information about the data type, or other definition details. The default
+    # value is `false`.
+    # @return [ListCustomerCustomAttributesResponse Hash] response from the API call
+    def list_customer_custom_attributes(customer_id:,
+                                        limit: nil,
+                                        cursor: nil,
+                                        with_definitions: false)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/{customer_id}/custom-attributes'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'customer_id' => { 'value' => customer_id, 'encode' => true }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'limit' => limit,
+        'cursor' => cursor,
+        'with_definitions' => with_definitions
+      )
+      _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
+
+    # Deletes a custom attribute associated with a customer profile.
+    # To delete a custom attribute owned by another application, the
+    # `visibility` setting must be
+    # `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [String] customer_id Required parameter: The ID of the target
+    # [customer profile]($m/Customer).
+    # @param [String] key Required parameter: The key of the custom attribute to
+    # delete. This key must match the `key` of a custom attribute definition in
+    # the Square seller account. If the requesting application is not the
+    # definition owner, you must use the qualified key.
+    # @return [DeleteCustomerCustomAttributeResponse Hash] response from the API call
+    def delete_customer_custom_attribute(customer_id:,
+                                         key:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/{customer_id}/custom-attributes/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'customer_id' => { 'value' => customer_id, 'encode' => true },
+        'key' => { 'value' => key, '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 custom attribute associated with a customer profile.
+    # You can use the `with_definition` query parameter to also retrieve the
+    # custom attribute definition
+    # in the same call.
+    # To retrieve a custom attribute owned by another application, the
+    # `visibility` setting must be
+    # `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [String] customer_id Required parameter: The ID of the target
+    # [customer profile]($m/Customer).
+    # @param [String] key Required parameter: The key of the custom attribute to
+    # retrieve. This key must match the `key` of a custom attribute definition
+    # in the Square seller account. If the requesting application is not the
+    # definition owner, you must use the qualified key.
+    # @param [Boolean] with_definition Optional parameter: Indicates whether to
+    # return the [custom attribute definition]($m/CustomAttributeDefinition) in
+    # the `definition` field of the custom attribute. Set this parameter to
+    # `true` to get the name and description of the custom attribute,
+    # information about the data type, or other definition details. The default
+    # value is `false`.
+    # @param [Integer] version Optional parameter: The current version of the
+    # custom attribute, which is used for strongly consistent reads to guarantee
+    # that you receive the most up-to-date data. When included in the request,
+    # Square returns the specified version or a higher version if one exists. If
+    # the specified version is higher than the current version, Square returns a
+    # `BAD_REQUEST` error.
+    # @return [RetrieveCustomerCustomAttributeResponse Hash] response from the API call
+    def retrieve_customer_custom_attribute(customer_id:,
+                                           key:,
+                                           with_definition: false,
+                                           version: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/{customer_id}/custom-attributes/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'customer_id' => { 'value' => customer_id, 'encode' => true },
+        'key' => { 'value' => key, 'encode' => true }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'with_definition' => with_definition,
+        'version' => version
+      )
+      _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 or updates a custom attribute for a customer profile.
+    # Use this endpoint to set the value of a custom attribute for a specified
+    # customer profile.
+    # A custom attribute is based on a custom attribute definition in a Square
+    # seller account, which
+    # is created using the
+    # [CreateCustomerCustomAttributeDefinition]($e/CustomerCustomAttributes/Crea
+    # teCustomerCustomAttributeDefinition) endpoint.
+    # To create or update a custom attribute owned by another application, the
+    # `visibility` setting
+    # must be `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [String] customer_id Required parameter: The ID of the target
+    # [customer profile]($m/Customer).
+    # @param [String] key Required parameter: The key of the custom attribute to
+    # create or update. This key must match the `key` of a custom attribute
+    # definition in the Square seller account. If the requesting application is
+    # not the definition owner, you must use the qualified key.
+    # @param [UpsertCustomerCustomAttributeRequest] body Required parameter: An
+    # object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [UpsertCustomerCustomAttributeResponse Hash] response from the API call
+    def upsert_customer_custom_attribute(customer_id:,
+                                         key:,
+                                         body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/{customer_id}/custom-attributes/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'customer_id' => { 'value' => customer_id, 'encode' => true },
+        'key' => { 'value' => key, '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

data/lib/square/api/gift_card_activities_api.rb

@@ -91,12 +91,11 @@ module Square
       )
     end
 
-    # Creates a gift card activity. For more information, see
-    # [GiftCardActivity](https://developer.squareup.com/docs/gift-cards/using-gi
-    # ft-cards-api#giftcardactivity) and
-    # [Using activated gift
-    # cards](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api
-    # #using-activated-gift-cards).
+    # Creates a gift card activity to manage the balance or state of a [gift
+    # card]($m/GiftCard).
+    # For example, you create an `ACTIVATE` activity to activate a gift card
+    # with an initial balance
+    # before the gift card can be used.
     # @param [CreateGiftCardActivityRequest] 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/gift_cards_api.rb

@@ -68,11 +68,11 @@ module Square
     end
 
     # Creates a digital gift card or registers a physical (plastic) gift card.
-    # You must activate the gift card before
-    # it can be used for payment. For more information, see
-    # [Selling gift
-    # cards](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api
-    # #selling-square-gift-cards).
+    # After the gift card
+    # is created, you must call
+    # [CreateGiftCardActivity]($e/GiftCardActivities/CreateGiftCardActivity)
+    # to activate the card with an initial balance before it can be used for
+    # payment.
     # @param [CreateGiftCardRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -259,7 +259,7 @@ module Square
       )
     end
 
-    # Retrieves a gift card using its ID.
+    # Retrieves a gift card using the gift card ID.
     # @param [String] id Required parameter: The ID of the gift card to
     # retrieve.
     # @return [RetrieveGiftCardResponse Hash] response from the API call

data/lib/square/api/terminal_api.rb

@@ -5,6 +5,149 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
+    # Creates a Terminal action request and sends it to the specified device to
+    # take a payment
+    # for the requested amount.
+    # @param [CreateTerminalActionRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CreateTerminalActionResponse Hash] response from the API call
+    def create_terminal_action(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/terminals/actions'
+      _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
+
+    # Retrieves a filtered list of Terminal action requests created by the
+    # account making the request. Terminal action requests are available for 30
+    # days.
+    # @param [SearchTerminalActionsRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [SearchTerminalActionsResponse Hash] response from the API call
+    def search_terminal_actions(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/terminals/actions/search'
+      _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
+
+    # Retrieves a Terminal action request by `action_id`. Terminal action
+    # requests are available for 30 days.
+    # @param [String] action_id Required parameter: Unique ID for the desired
+    # `TerminalAction`
+    # @return [GetTerminalActionResponse Hash] response from the API call
+    def get_terminal_action(action_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/terminals/actions/{action_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'action_id' => { 'value' => action_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
+
+    # Cancels a Terminal action request if the status of the request permits it.
+    # @param [String] action_id Required parameter: Unique ID for the desired
+    # `TerminalAction`
+    # @return [CancelTerminalActionResponse Hash] response from the API call
+    def cancel_terminal_action(action_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/terminals/actions/{action_id}/cancel'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'action_id' => { 'value' => action_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
+
     # Creates a Terminal checkout request and sends it to the specified device
     # to take a payment
     # for the requested amount.

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '19.0.0.20220420'
+      '20.0.0.20220512'
     end
 
     def square_version
@@ -75,6 +75,12 @@ module Square
       @customers ||= CustomersApi.new config
     end
 
+    # Access to customer_custom_attributes controller.
+    # @return [CustomerCustomAttributesApi] Returns the controller instance.
+    def customer_custom_attributes
+      @customer_custom_attributes ||= CustomerCustomAttributesApi.new config
+    end
+
     # Access to customer_groups controller.
     # @return [CustomerGroupsApi] Returns the controller instance.
     def customer_groups
@@ -230,7 +236,7 @@ module Square
                    retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
                    retry_methods: %i[get put], environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2022-04-20', access_token: '',
+                   square_version: '2022-05-12', access_token: '',
                    user_agent_detail: '', additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(connection: connection, timeout: timeout,

data/lib/square/configuration.rb

@@ -20,7 +20,7 @@ module Square
                    retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
                    retry_methods: %i[get put], environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2022-04-20', access_token: '',
+                   square_version: '2022-05-12', access_token: '',
                    user_agent_detail: '', additional_headers: {})
       # The Faraday connection object passed by the SDK user for making requests
       @connection = connection

data/lib/square.rb

@@ -40,6 +40,7 @@ require_relative 'square/api/cards_api'
 require_relative 'square/api/cash_drawers_api'
 require_relative 'square/api/catalog_api'
 require_relative 'square/api/customers_api'
+require_relative 'square/api/customer_custom_attributes_api'
 require_relative 'square/api/customer_groups_api'
 require_relative 'square/api/customer_segments_api'
 require_relative 'square/api/devices_api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 19.0.0.20220420
+  version: 20.0.0.20220512
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-19 00:00:00.000000000 Z
+date: 2022-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -31,6 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
@@ -180,6 +186,7 @@ files:
 - lib/square/api/cash_drawers_api.rb
 - lib/square/api/catalog_api.rb
 - lib/square/api/checkout_api.rb
+- lib/square/api/customer_custom_attributes_api.rb
 - lib/square/api/customer_groups_api.rb
 - lib/square/api/customer_segments_api.rb
 - lib/square/api/customers_api.rb