square.rb 20.1.0.20220616 → 22.0.0.20220817

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68c3c60d1b69c141d163be8e453c91bd76cca35f98228aeae4a41f7b61afe8a6
-  data.tar.gz: 3df6c78f8e6e493967624fca0cd804c1547aa6ccfb2b57daaac05695a33df12d
+  metadata.gz: 7406eafacea5f827425c9891d255ae7294e87d6129ca8fdbe9c6d3afe2ca8976
+  data.tar.gz: fbada6b040581a4189aae2d6aa6a55ba76be2551e08191d94f054b2aa4133c96
 SHA512:
-  metadata.gz: ab11afe945aa6630b158b07040290572d591b15e2d0829363dd334fc38f5197cc2d5eed47a36cf84e68061667d91b874486892da5acebb4f25420b8bec6e190b
-  data.tar.gz: 3427cb9920daac7363c982754ab7a5c8ef1abf609786e9c8b2bb4a6a4f82da77a2b05e9d7758d71c86613ef8dc54536ea44b9c9f9eed44576d90272121327b67
+  metadata.gz: a13e3097da587460e8d566a5f51c389707d0945840c569795473d3e27851706a96f3e944656cc9cd1d6fd2309f784d77cc91ff35323257a93594f58f6c310cba
+  data.tar.gz: 876ee033a900d638697c0e992a73d8406febe43b9a1cab66666cfc4f3f375c2feca3763cdc32d4161b5b7545cb5e91d3e24d61867d68959c3ad3611191e2e909

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

@@ -178,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

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

@@ -319,8 +319,8 @@ module Square
     # 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
+    # @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

@@ -23,6 +23,7 @@ module Square
     # @return [CreateCheckoutResponse Hash] response from the API call
     def create_checkout(location_id:,
                         body:)
+      warn 'Endpoint create_checkout in CheckoutApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/locations/{location_id}/checkouts'
@@ -57,14 +58,13 @@ module Square
 
     # 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
+    # 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
+    # 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`

data/lib/square/api/customer_custom_attributes_api.rb

@@ -5,14 +5,17 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Lists the customer-related custom attribute definitions that belong to a
-    # Square seller account.
+    # Lists the customer-related [custom attribute
+    # definitions]($m/CustomAttributeDefinition) 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`.
+    # `VISIBILITY_READ_WRITE_VALUES`. Note that
+    # seller-defined custom attributes (also known as custom fields) are always
+    # set to `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
@@ -59,10 +62,10 @@ module Square
       )
     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.
+    # Creates a customer-related [custom attribute
+    # definition]($m/CustomAttributeDefinition) 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
@@ -108,8 +111,8 @@ module Square
       )
     end
 
-    # Deletes a customer-related custom attribute definition from a Square
-    # seller account.
+    # Deletes a customer-related [custom attribute
+    # definition]($m/CustomAttributeDefinition) 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.
@@ -148,11 +151,14 @@ module Square
       )
     end
 
-    # Retrieves a customer-related custom attribute definition from a Square
-    # seller account.
+    # Retrieves a customer-related [custom attribute
+    # definition]($m/CustomAttributeDefinition) 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`.
+    # Note that seller-defined custom attributes
+    # (also known as custom fields) are always set to
+    # `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.
@@ -199,8 +205,8 @@ module Square
       )
     end
 
-    # Updates a customer-related custom attribute definition for a Square seller
-    # account.
+    # Updates a customer-related [custom attribute
+    # definition]($m/CustomAttributeDefinition) for a Square seller account.
     # Use this endpoint to update the following fields: `name`, `description`,
     # `visibility`, or the
     # `schema` for a `Selection` data type.
@@ -248,8 +254,8 @@ module Square
       )
     end
 
-    # Creates or updates custom attributes for customer profiles as a bulk
-    # operation.
+    # Creates or updates [custom attributes]($m/CustomAttribute) 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
@@ -266,7 +272,10 @@ module Square
     # of the corresponding request.
     # To create or update a custom attribute owned by another application, the
     # `visibility` setting
-    # must be `VISIBILITY_READ_WRITE_VALUES`.
+    # must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom
+    # attributes
+    # (also known as custom fields) are always set to
+    # `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.
@@ -300,7 +309,8 @@ module Square
       )
     end
 
-    # Lists the custom attributes associated with a customer profile.
+    # Lists the [custom attributes]($m/CustomAttribute) associated with a
+    # customer profile.
     # You can use the `with_definitions` query parameter to also retrieve custom
     # attribute definitions
     # in the same call.
@@ -323,12 +333,12 @@ module Square
     # 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`.
+    # @param [TrueClass|FalseClass] 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,
@@ -370,9 +380,12 @@ module Square
       )
     end
 
-    # Deletes a custom attribute associated with a customer profile.
+    # Deletes a [custom attribute]($m/CustomAttribute) associated with a
+    # customer profile.
     # To delete a custom attribute owned by another application, the
     # `visibility` setting must be
+    # `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes
+    # (also known as custom fields) are always set to
     # `VISIBILITY_READ_WRITE_VALUES`.
     # @param [String] customer_id Required parameter: The ID of the target
     # [customer profile]($m/Customer).
@@ -414,25 +427,29 @@ module Square
       )
     end
 
-    # Retrieves a custom attribute associated with a customer profile.
+    # Retrieves a [custom attribute]($m/CustomAttribute) 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`.
+    # `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that
+    # seller-defined custom attributes
+    # (also known as custom fields) are always set to
+    # `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 [TrueClass|FalseClass] 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,
@@ -480,7 +497,8 @@ module Square
       )
     end
 
-    # Creates or updates a custom attribute for a customer profile.
+    # Creates or updates a [custom attribute]($m/CustomAttribute) 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
@@ -490,7 +508,10 @@ module Square
     # teCustomerCustomAttributeDefinition) endpoint.
     # To create or update a custom attribute owned by another application, the
     # `visibility` setting
-    # must be `VISIBILITY_READ_WRITE_VALUES`.
+    # must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom
+    # attributes
+    # (also known as custom fields) are always set to
+    # `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

data/lib/square/api/customers_api.rb

@@ -110,8 +110,8 @@ module Square
       )
     end
 
-    # Searches the customer profiles associated with a Square account using a
-    # supported query filter.
+    # Searches the customer profiles associated with a Square account using one
+    # or more supported query filters.
     # Calling `SearchCustomers` without any explicit query filter returns all
     # customer profiles ordered alphabetically based on `given_name` and
     # `family_name`.
@@ -165,7 +165,7 @@ module Square
     # profiles, you must use the ID of the newly created profile.
     # @param [String] customer_id Required parameter: The ID of the customer to
     # delete.
-    # @param [Long] version Optional parameter: The current version of the
+    # @param [Integer] version Optional parameter: The current version of the
     # customer profile.  As a best practice, you should include this parameter
     # to enable [optimistic
     # concurrency](https://developer.squareup.com/docs/build-basics/common-api-p

data/lib/square/api/disputes_api.rb

@@ -11,13 +11,12 @@ module Square
     # set of results for the original query. For more information, see
     # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
     # .
-    # @param [DisputeState] states Optional parameter: The dispute states to
-    # filter the result. If not specified, the endpoint returns all open
-    # disputes (the dispute status is not `INQUIRY_CLOSED`, `WON`, or `LOST`).
+    # @param [DisputeState] states Optional parameter: The dispute states used
+    # to filter the result. If not specified, the endpoint returns all
+    # disputes.
     # @param [String] location_id Optional parameter: The ID of the location for
     # which to return a list of disputes. If not specified, the endpoint returns
-    # all open disputes (the dispute status is not `INQUIRY_CLOSED`, `WON`, or
-    # `LOST`) associated with all locations.
+    # disputes associated with all locations.
     # @return [ListDisputesResponse Hash] response from the API call
     def list_disputes(cursor: nil,
                       states: nil,
@@ -134,8 +133,8 @@ module Square
     # @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. For more information, see
-    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
-    # .
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @return [ListDisputeEvidenceResponse Hash] response from the API call
     def list_dispute_evidence(dispute_id:,
                               cursor: nil)
@@ -177,8 +176,8 @@ module Square
     # accepts HTTP
     # multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF
     # formats.
-    # @param [String] dispute_id Required parameter: The ID of the dispute you
-    # want to upload evidence for.
+    # @param [String] dispute_id Required parameter: The ID of the dispute for
+    # which you want to upload evidence.
     # @param [CreateDisputeEvidenceFileRequest] request Optional parameter:
     # Defines the parameters for a `CreateDisputeEvidenceFile` request.
     # @param [File | UploadIO] image_file Optional parameter: Example:
@@ -239,8 +238,8 @@ module Square
     end
 
     # Uploads text to use as evidence for a dispute challenge.
-    # @param [String] dispute_id Required parameter: The ID of the dispute you
-    # want to upload evidence for.
+    # @param [String] dispute_id Required parameter: The ID of the dispute for
+    # which you want to upload evidence.
     # @param [CreateDisputeEvidenceTextRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
@@ -280,12 +279,9 @@ module Square
     end
 
     # Removes specified evidence from a dispute.
-    # Square does not send the bank any evidence that is removed. Also, you
-    # cannot remove evidence after
-    # submitting it to the bank using
-    # [SubmitEvidence]($e/Disputes/SubmitEvidence).
-    # @param [String] dispute_id Required parameter: The ID of the dispute you
-    # want to remove evidence from.
+    # Square does not send the bank any evidence that is removed.
+    # @param [String] dispute_id Required parameter: The ID of the dispute from
+    # which you want to remove evidence.
     # @param [String] evidence_id Required parameter: The ID of the evidence you
     # want to remove.
     # @return [DeleteDisputeEvidenceResponse Hash] response from the API call
@@ -322,13 +318,11 @@ module Square
       )
     end
 
-    # Returns the evidence metadata specified by the evidence ID in the request
-    # URL path
-    # You must maintain a copy of the evidence you upload if you want to
-    # reference it later. You cannot
-    # download the evidence after you upload it.
-    # @param [String] dispute_id Required parameter: The ID of the dispute that
-    # you want to retrieve evidence from.
+    # Returns the metadata for the evidence specified in the request URL path.
+    # You must maintain a copy of any evidence uploaded if you want to reference
+    # it later. Evidence cannot be downloaded after you upload it.
+    # @param [String] dispute_id Required parameter: The ID of the dispute from
+    # which you want to retrieve evidence metadata.
     # @param [String] evidence_id Required parameter: The ID of the evidence to
     # retrieve.
     # @return [RetrieveDisputeEvidenceResponse Hash] response from the API call
@@ -366,15 +360,16 @@ module Square
     end
 
     # Submits evidence to the cardholder's bank.
-    # Before submitting evidence, Square compiles all available evidence. This
-    # includes evidence uploaded
+    # The evidence submitted by this endpoint includes evidence uploaded
     # using the
     # [CreateDisputeEvidenceFile]($e/Disputes/CreateDisputeEvidenceFile) and
     # [CreateDisputeEvidenceText]($e/Disputes/CreateDisputeEvidenceText)
     # endpoints and
-    # evidence automatically provided by Square, when available.
-    # @param [String] dispute_id Required parameter: The ID of the dispute that
-    # you want to submit evidence for.
+    # evidence automatically provided by Square, when available. Evidence cannot
+    # be removed from
+    # a dispute after submission.
+    # @param [String] dispute_id Required parameter: The ID of the dispute for
+    # which you want to submit evidence.
     # @return [SubmitEvidenceResponse Hash] response from the API call
     def submit_evidence(dispute_id:)
       # Prepare query url.