square.rb 19.0.0.20220420 → 21.0.0.20220720

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 431d8365d32b12be40203cfb143d88518f74cee228a0b36755cdc5fc8b782200
-  data.tar.gz: 5349f02eb93bf190d16d17ea0f13d3c434fdcb75a37825e1cdcb6406744c7385
+  metadata.gz: b8c49dc5dec3f51ebfdb70e1789d9ffd0c1826b9f953c7a1e0fa59b62dae9d4f
+  data.tar.gz: b49dd9dbf71cdb0c1371dc0f5fb9505a26aaffe5c1905a366a3e46ecae5ea7fe
 SHA512:
-  metadata.gz: 65afbe4492802c447ee9aa509cc282720a88e7e34f398609818e4cc60b2262d05584bdb736793d44f4a2d49299f350a4c8241666ebe452634e2ac73097424633
-  data.tar.gz: a0a524485adeb61c20502b6956df68fc908c0e9e52459421be2382ad962ccd17a0e4f128d1bf7ed341a2f9bed95c31da735512ddd73327d7ba739c52ae38d1f9
+  metadata.gz: bf2fcb52842fd5fc4f4b0cce1196a0276b882ec2d27d9a1d1eb6c717c0130eca6c52c0fda1d176bf4cc7f78f64b018162a58e484aa548534f58bf5738cee0e8d
+  data.tar.gz: d2efdfc7be2f8afde9906e01bc3b6dac865fd092f0394ea5ebe3e427101752251100ff409e8a9fff7b5c7d7af5d52278ec641289b90a52a8c6aa70715ce6c39c

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

@@ -20,6 +20,13 @@ module Square
       end
     end
 
+    def validate_parameters_types(args)
+      args.each do |_name, type|
+        key, val = type.first
+        APIHelper.validate_types(key, val) unless key.nil?
+      end
+    end
+
     def execute_request(request, binary: false)
       @http_call_back&.on_before_request(request)
 
@@ -38,7 +45,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/21.0.0.20220720 ({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.
@@ -175,9 +178,9 @@ module Square
     end
 
     # Lists booking profiles for team members.
-    # @param [Boolean] bookable_only Optional parameter: Indicates whether to
-    # include only bookable team members in the returned result (`true`) or not
-    # (`false`).
+    # @param [TrueClass|FalseClass] bookable_only Optional parameter: Indicates
+    # whether to include only bookable team members in the returned result
+    # (`true`) or not (`false`).
     # @param [Integer] limit Optional parameter: The maximum number of results
     # to return in a paged response.
     # @param [String] cursor Optional parameter: The pagination cursor from the
@@ -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/cards_api.rb

@@ -15,8 +15,9 @@ module Square
     # @param [String] customer_id Optional parameter: Limit results to cards
     # associated with the customer supplied. By default, all cards owned by the
     # merchant are returned.
-    # @param [Boolean] include_disabled Optional parameter: Includes disabled
-    # cards. By default, all enabled cards owned by the merchant are returned.
+    # @param [TrueClass|FalseClass] include_disabled Optional parameter:
+    # Includes disabled cards. By default, all enabled cards owned by the
+    # merchant are returned.
     # @param [String] reference_id Optional parameter: Limit results to cards
     # associated with the reference_id supplied.
     # @param [SortOrder] sort_order Optional parameter: Sorts the returned list

data/lib/square/api/catalog_api.rb

@@ -316,11 +316,11 @@ 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.
-    # @param [Long] catalog_version Optional parameter: The specific version of
-    # the catalog objects to be included in the response.  This allows you to
+    # MODIFIER_LIST,  PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,
+    # SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION,
+    # QUICK_AMOUNT_SETTINGS.
+    # @param [Integer] 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
     # matched against the [CatalogObject]($m/CatalogObject)s' `version`
     # attribute.  If not included, results will be from the current version of
@@ -448,26 +448,26 @@ module Square
     # any [CatalogTax]($m/CatalogTax) objects that apply to it.
     # @param [String] object_id Required parameter: The object ID of any type of
     # catalog objects to be retrieved.
-    # @param [Boolean] include_related_objects Optional parameter: If `true`,
-    # the response will include additional objects that are related to the
-    # requested objects. Related objects are defined as any objects referenced
-    # by ID by the results in the `objects` field of the response. These objects
-    # are put in the `related_objects` field. Setting this to `true` is helpful
-    # when the objects are needed for immediate display to a user. This process
-    # only goes one level deep. Objects referenced by the related objects will
-    # not be included. For example,  if the `objects` field of the response
-    # contains a CatalogItem, its associated CatalogCategory objects, CatalogTax
-    # objects, CatalogImage objects and CatalogModifierLists will be returned in
-    # the `related_objects` field of the response. If the `objects` field of the
-    # response contains a CatalogItemVariation, its parent CatalogItem will be
-    # returned in the `related_objects` field of the response.  Default value:
-    # `false`
-    # @param [Long] catalog_version Optional parameter: Requests objects as of a
-    # specific version of the catalog. This allows you to retrieve historical
-    # versions of objects. The value to retrieve a specific version of an object
-    # can be found in the version field of [CatalogObject]($m/CatalogObject)s.
-    # If not included, results will be from the current version of the
-    # catalog.
+    # @param [TrueClass|FalseClass] include_related_objects Optional parameter:
+    # If `true`, the response will include additional objects that are related
+    # to the requested objects. Related objects are defined as any objects
+    # referenced by ID by the results in the `objects` field of the response.
+    # These objects are put in the `related_objects` field. Setting this to
+    # `true` is helpful when the objects are needed for immediate display to a
+    # user. This process only goes one level deep. Objects referenced by the
+    # related objects will not be included. For example,  if the `objects` field
+    # of the response contains a CatalogItem, its associated CatalogCategory
+    # objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists
+    # will be returned in the `related_objects` field of the response. If the
+    # `objects` field of the response contains a CatalogItemVariation, its
+    # parent CatalogItem will be returned in the `related_objects` field of the
+    # response.  Default value: `false`
+    # @param [Integer] catalog_version Optional parameter: Requests objects as
+    # of a specific version of the catalog. This allows you to retrieve
+    # historical versions of objects. The value to retrieve a specific version
+    # of an object can be found in the version field of
+    # [CatalogObject]($m/CatalogObject)s. If not included, results will be from
+    # the current version of the catalog.
     # @return [RetrieveCatalogObjectResponse Hash] response from the API call
     def retrieve_catalog_object(object_id:,
                                 include_related_objects: false,

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