square.rb 9.1.1.20210317 → 10.0.0.20210421

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5daa9230376e0d7e260342e846b5118b92e12aa89fe226ad0df404c5aed13dfa
-  data.tar.gz: c0ba7b58ac6d2ae2d511344c66bdc4b670aef159e4a20045bfd8d8b160e00649
+  metadata.gz: 87a7fd1bf8e3ac239bdcbf9ca199c6df913a50c7b31d2b0daa46dc2b7b8556f8
+  data.tar.gz: d38853a5ff3857cdba57f8318082205a75d685147beba0fd0d655e8e058e78cb
 SHA512:
-  metadata.gz: f78aa71da656d92d0aee4afa1af82d7c783bdf37bead5ec7a8f007ea84131e6457c3d413d4cec15cee4b2f15de7a7afd399c32d8c8a331b82ec5902a610c823d
-  data.tar.gz: e9d14b674b48660e2b499e07e730fe818447aedad773fe063d2a40b28286a7f4296d93efd0a9e310dae4c56032c7f377809555c993979207e28e544466fd5503
+  metadata.gz: ced95e4b69aa0d95e8ee5f1aa53485da51f9b39745058b72cbb974261a2d09eef992ef182fd90c854df8edc8399c258a4f1ed62dd63968817f4b4aba5c6b0989
+  data.tar.gz: 6fd69a6ba99ec2dee2b5ba51456c4c99d91f7b299729cecd1ed278ce4770aae328234147ce8b4de6c9fc954b454be5442c1dc0d66e4d2e84c167ce28b47bcef0

data/README.md

@@ -2,7 +2,7 @@
 
 # Square Ruby SDK
 
-[![Travis status](https://travis-ci.org/square/square-ruby-sdk.svg?branch=master)](https://travis-ci.org/square/square-ruby-sdk)
+[![Build](https://github.com/square/square-ruby-sdk/actions/workflows/ruby.yml/badge.svg)](https://github.com/square/square-ruby-sdk/actions/workflows/ruby.yml)
 [![Gem version](https://badge.fury.io/rb/square.rb.svg?new)](https://badge.fury.io/rb/square.rb)
 [![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 

data/lib/square/api/bank_accounts_api.rb

@@ -5,8 +5,8 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Returns a list of [BankAccount](#type-bankaccount) objects linked to a
-    # Square account.
+    # Returns a list of [BankAccount]($m/BankAccount) objects linked to a Square
+    # account.
     # @param [String] cursor Optional parameter: The pagination cursor returned
     # by a previous call to this endpoint. Use it in the next `ListBankAccounts`
     # request to retrieve the next set  of results.  See the
@@ -55,8 +55,8 @@ module Square
       )
     end
 
-    # Returns details of a [BankAccount](#type-bankaccount) identified by V1
-    # bank account ID.
+    # Returns details of a [BankAccount]($m/BankAccount) identified by V1 bank
+    # account ID.
     # @param [String] v1_bank_account_id Required parameter: Connect V1 ID of
     # the desired `BankAccount`. For more information, see  [Retrieve a bank
     # account by using an ID issued by V1 Bank Accounts
@@ -94,7 +94,7 @@ module Square
       )
     end
 
-    # Returns details of a [BankAccount](#type-bankaccount)
+    # Returns details of a [BankAccount]($m/BankAccount)
     # linked to a Square account.
     # @param [String] bank_account_id Required parameter: Square-issued ID of
     # the desired `BankAccount`.

data/lib/square/api/base_api.rb

@@ -8,7 +8,7 @@ module Square
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'Square-Ruby-SDK/9.1.1.20210317',
+        'user-agent' => 'Square-Ruby-SDK/10.0.0.20210421',
         'Square-Version' => config.square_version
       }
     end

data/lib/square/api/bookings_api.rb

@@ -188,8 +188,7 @@ module Square
 
     # Retrieves a booking.
     # @param [String] booking_id Required parameter: The ID of the
-    # [Booking](#type-booking) object representing the to-be-retrieved
-    # booking.
+    # [Booking]($m/Booking) object representing the to-be-retrieved booking.
     # @return [RetrieveBookingResponse Hash] response from the API call
     def retrieve_booking(booking_id:)
       # Prepare query url.
@@ -224,7 +223,7 @@ module Square
 
     # Updates a booking.
     # @param [String] booking_id Required parameter: The ID of the
-    # [Booking](#type-booking) object representing the to-be-updated booking.
+    # [Booking]($m/Booking) object representing the to-be-updated booking.
     # @param [UpdateBookingRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -265,8 +264,7 @@ module Square
 
     # Cancels an existing booking.
     # @param [String] booking_id Required parameter: The ID of the
-    # [Booking](#type-booking) object representing the to-be-cancelled
-    # booking.
+    # [Booking]($m/Booking) object representing the to-be-cancelled booking.
     # @param [CancelBookingRequest] 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/cash_drawers_api.rb

@@ -63,8 +63,8 @@ module Square
     end
 
     # Provides the summary details for a single cash drawer shift. See
-    # [ListCashDrawerShiftEvents](#endpoint-CashDrawers-ListCashDrawerShiftEvent
-    # s) for a list of cash drawer shift events.
+    # [ListCashDrawerShiftEvents]($e/CashDrawers/ListCashDrawerShiftEvents) for
+    # a list of cash drawer shift events.
     # @param [String] location_id Required parameter: The ID of the location to
     # retrieve cash drawer shifts from.
     # @param [String] shift_id Required parameter: The shift ID.

data/lib/square/api/catalog_api.rb

@@ -5,12 +5,12 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Deletes a set of [CatalogItem](#type-catalogitem)s based on the
+    # Deletes a set of [CatalogItem]($m/CatalogItem)s based on the
     # provided list of target IDs and returns a set of successfully deleted IDs
     # in
     # the response. Deletion is a cascading event such that all children of the
     # targeted object are also deleted. For example, deleting a CatalogItem will
-    # also delete all of its [CatalogItemVariation](#type-catalogitemvariation)
+    # also delete all of its [CatalogItemVariation]($m/CatalogItemVariation)
     # children.
     # `BatchDeleteCatalogObjects` succeeds even if only a portion of the
     # targeted
@@ -50,13 +50,11 @@ module Square
     end
 
     # Returns a set of objects based on the provided ID.
-    # Each [CatalogItem](#type-catalogitem) returned in the set includes all of
-    # its
+    # Each [CatalogItem]($m/CatalogItem) returned in the set includes all of its
     # child information including: all of its
-    # [CatalogItemVariation](#type-catalogitemvariation) objects, references to
-    # its [CatalogModifierList](#type-catalogmodifierlist) objects, and the ids
-    # of
-    # any [CatalogTax](#type-catalogtax) objects that apply to it.
+    # [CatalogItemVariation]($m/CatalogItemVariation) objects, references to
+    # its [CatalogModifierList]($m/CatalogModifierList) objects, and the ids of
+    # any [CatalogTax]($m/CatalogTax) objects that apply to it.
     # @param [BatchRetrieveCatalogObjectsRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
@@ -138,8 +136,8 @@ module Square
     end
 
     # Uploads an image file to be represented by a
-    # [CatalogImage](#type-catalogimage) object linked to an existing
-    # [CatalogObject](#type-catalogobject) instance. A call to this endpoint can
+    # [CatalogImage]($m/CatalogImage) object linked to an existing
+    # [CatalogObject]($m/CatalogObject) instance. A call to this endpoint can
     # upload an image, link an image to
     # a catalog object, or do both.
     # This `CreateCatalogImage` endpoint accepts HTTP multipart/form-data
@@ -228,19 +226,19 @@ module Square
       )
     end
 
-    # Returns a list of [CatalogObject](#type-catalogobject)s that includes
+    # Returns a list of [CatalogObject]($m/CatalogObject)s that includes
     # all objects of a set of desired types (for example, all
-    # [CatalogItem](#type-catalogitem)
-    # and [CatalogTax](#type-catalogtax) objects) in the catalog. The `types`
+    # [CatalogItem]($m/CatalogItem)
+    # and [CatalogTax]($m/CatalogTax) objects) in the catalog. The `types`
     # parameter
     # is specified as a comma-separated list of valid
-    # [CatalogObject](#type-catalogobject) types:
+    # [CatalogObject]($m/CatalogObject) types:
     # `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`,
     # `DISCOUNT`, `TAX`, `IMAGE`.
     # __Important:__ ListCatalog does not return deleted catalog items. To
     # retrieve
     # deleted catalog items, use
-    # [SearchCatalogObjects](#endpoint-Catalog-SearchCatalogObjects)
+    # [SearchCatalogObjects]($e/Catalog/SearchCatalogObjects)
     # and set the `include_deleted_objects` attribute value to `true`.
     # @param [String] cursor Optional parameter: The pagination cursor returned
     # in the previous response. Leave unset for an initial request. See
@@ -254,7 +252,7 @@ module Square
     # @param [Long] catalog_version Optional parameter: The specific version of
     # the catalog objects to be included in the response.  This allows you to
     # retrieve historical versions of objects. The specified version value is
-    # matched against the [CatalogObject](#type-catalogobject)s' `version`
+    # matched against the [CatalogObject]($m/CatalogObject)s' `version`
     # attribute.
     # @return [ListCatalogResponse Hash] response from the API call
     def list_catalog(cursor: nil,
@@ -292,7 +290,7 @@ module Square
       )
     end
 
-    # Creates or updates the target [CatalogObject](#type-catalogobject).
+    # Creates or updates the target [CatalogObject]($m/CatalogObject).
     # @param [UpsertCatalogObjectRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -326,14 +324,14 @@ module Square
       )
     end
 
-    # Deletes a single [CatalogObject](#type-catalogobject) based on the
+    # Deletes a single [CatalogObject]($m/CatalogObject) based on the
     # provided ID and returns the set of successfully deleted IDs in the
     # response.
     # Deletion is a cascading event such that all children of the targeted
     # object
-    # are also deleted. For example, deleting a [CatalogItem](#type-catalogitem)
+    # are also deleted. For example, deleting a [CatalogItem]($m/CatalogItem)
     # will also delete all of its
-    # [CatalogItemVariation](#type-catalogitemvariation) children.
+    # [CatalogItemVariation]($m/CatalogItemVariation) children.
     # @param [String] object_id Required parameter: The ID of the catalog object
     # to be deleted. When an object is deleted, other objects in the graph that
     # depend on that object will be deleted as well (for example, deleting a
@@ -370,14 +368,13 @@ module Square
       )
     end
 
-    # Returns a single [CatalogItem](#type-catalogitem) as a
-    # [CatalogObject](#type-catalogobject) based on the provided ID. The
-    # returned
-    # object includes all of the relevant [CatalogItem](#type-catalogitem)
-    # information including: [CatalogItemVariation](#type-catalogitemvariation)
+    # Returns a single [CatalogItem]($m/CatalogItem) as a
+    # [CatalogObject]($m/CatalogObject) based on the provided ID. The returned
+    # object includes all of the relevant [CatalogItem]($m/CatalogItem)
+    # information including: [CatalogItemVariation]($m/CatalogItemVariation)
     # children, references to its
-    # [CatalogModifierList](#type-catalogmodifierlist) objects, and the ids of
-    # any [CatalogTax](#type-catalogtax) objects that apply to it.
+    # [CatalogModifierList]($m/CatalogModifierList) objects, and the ids of
+    # 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`,
@@ -392,8 +389,7 @@ module Square
     # @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](#type-catalogobject)s.
+    # can be found in the version field of [CatalogObject]($m/CatalogObject)s.
     # @return [RetrieveCatalogObjectResponse Hash] response from the API call
     def retrieve_catalog_object(object_id:,
                                 include_related_objects: false,
@@ -433,12 +429,12 @@ module Square
       )
     end
 
-    # Searches for [CatalogObject](#type-CatalogObject) of any type by matching
+    # Searches for [CatalogObject]($m/CatalogObject) of any type by matching
     # supported search attribute values,
     # excluding custom attribute values on items or item variations, against one
     # or more of the specified query expressions.
     # This (`SearchCatalogObjects`) endpoint differs from the
-    # [SearchCatalogItems](#endpoint-Catalog-SearchCatalogItems)
+    # [SearchCatalogItems]($e/Catalog/SearchCatalogItems)
     # endpoint in the following aspects:
     # - `SearchCatalogItems` can only search for items or item variations,
     # whereas `SearchCatalogObjects` can search for any type of catalog objects.
@@ -488,7 +484,7 @@ module Square
     # custom attribute values, against one or more of the specified query
     # expressions.
     # This (`SearchCatalogItems`) endpoint differs from the
-    # [SearchCatalogObjects](#endpoint-Catalog-SearchCatalogObjects)
+    # [SearchCatalogObjects]($e/Catalog/SearchCatalogObjects)
     # endpoint in the following aspects:
     # - `SearchCatalogItems` can only search for items or item variations,
     # whereas `SearchCatalogObjects` can search for any type of catalog objects.
@@ -533,8 +529,8 @@ module Square
       )
     end
 
-    # Updates the [CatalogModifierList](#type-catalogmodifierlist) objects
-    # that apply to the targeted [CatalogItem](#type-catalogitem) without having
+    # Updates the [CatalogModifierList]($m/CatalogModifierList) objects
+    # that apply to the targeted [CatalogItem]($m/CatalogItem) without having
     # to perform an upsert on the entire item.
     # @param [UpdateItemModifierListsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -569,8 +565,8 @@ module Square
       )
     end
 
-    # Updates the [CatalogTax](#type-catalogtax) objects that apply to the
-    # targeted [CatalogItem](#type-catalogitem) without having to perform an
+    # Updates the [CatalogTax]($m/CatalogTax) objects that apply to the
+    # targeted [CatalogItem]($m/CatalogItem) without having to perform an
     # upsert on the entire item.
     # @param [UpdateItemTaxesRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding

data/lib/square/api/customer_groups_api.rb

@@ -7,10 +7,10 @@ module Square
 
     # Retrieves the list of customer groups of a business.
     # @param [String] cursor Optional parameter: A pagination cursor returned by
-    # a previous call to this endpoint. Provide this to retrieve the next set of
-    # results for your original query.  See the [Pagination
-    # guide](https://developer.squareup.com/docs/working-with-apis/pagination)
-    # for more information.
+    # a previous call to this endpoint. Provide this cursor to retrieve the next
+    # set of results for your original query.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
     # @return [ListCustomerGroupsResponse Hash] response from the API call
     def list_customer_groups(cursor: nil)
       # Prepare query url.

data/lib/square/api/customer_segments_api.rb

@@ -7,10 +7,10 @@ module Square
 
     # Retrieves the list of customer segments of a business.
     # @param [String] cursor Optional parameter: A pagination cursor returned by
-    # previous calls to __ListCustomerSegments__. Used to retrieve the next set
-    # of query results.  See the [Pagination
-    # guide](https://developer.squareup.com/docs/working-with-apis/pagination)
-    # for more information.
+    # previous calls to `ListCustomerSegments`. This cursor is used to retrieve
+    # the next set of query results.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
     # @return [ListCustomerSegmentsResponse Hash] response from the API call
     def list_customer_segments(cursor: nil)
       # Prepare query url.

data/lib/square/api/customers_api.rb

@@ -13,14 +13,14 @@ module Square
     # profiles can take closer to one minute or longer, especially during
     # network incidents and outages.
     # @param [String] cursor Optional parameter: A pagination cursor returned by
-    # a previous call to this endpoint. Provide this to retrieve the next set of
-    # results for your original query.  See the [Pagination
-    # guide](https://developer.squareup.com/docs/working-with-apis/pagination)
-    # for more information.
+    # a previous call to this endpoint. Provide this cursor to retrieve the next
+    # set of results for your original query.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
     # @param [CustomerSortField] sort_field Optional parameter: Indicates how
-    # Customers should be sorted.  Default: `DEFAULT`.
+    # customers should be sorted.  Default: `DEFAULT`.
     # @param [SortOrder] sort_order Optional parameter: Indicates whether
-    # Customers should be sorted in ascending (`ASC`) or descending (`DESC`)
+    # customers should be sorted in ascending (`ASC`) or descending (`DESC`)
     # order.  Default: `ASC`.
     # @return [ListCustomersResponse Hash] response from the API call
     def list_customers(cursor: nil,
@@ -60,8 +60,8 @@ module Square
 
     # Creates a new customer for a business, which can have associated cards on
     # file.
-    # You must provide __at least one__ of the following values in your request
-    # to this
+    # You must provide at least one of the following values in your request to
+    # this
     # endpoint:
     # - `given_name`
     # - `family_name`
@@ -145,15 +145,27 @@ module Square
       )
     end
 
-    # Deletes a customer from a business, along with any linked cards on file.
-    # When two profiles
-    # are merged into a single profile, that profile is assigned a new
-    # `customer_id`. You must use the
-    # new `customer_id` to delete merged profiles.
+    # Deletes a customer profile from a business, including any linked cards on
+    # file.
+    # As a best practice, you should include the `version` field in the request
+    # to enable [optimistic
+    # concurrency](https://developer.squareup.com/docs/working-with-apis/optimis
+    # tic-concurrency) control. The value must be set to the current version of
+    # the customer profile.
+    # To delete a customer profile that was created by merging existing
+    # 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
+    # customer profile.   As a best practice, you should include this parameter
+    # to enable [optimistic
+    # concurrency](https://developer.squareup.com/docs/working-with-apis/optimis
+    # tic-concurrency) control.  For more information, see [Delete a customer
+    # profile](https://developer.squareup.com/docs/customers-api/use-the-api/kee
+    # p-records#delete-customer-profile).
     # @return [DeleteCustomerResponse Hash] response from the API call
-    def delete_customer(customer_id:)
+    def delete_customer(customer_id:,
+                        version: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/customers/{customer_id}'
@@ -161,6 +173,10 @@ module Square
         _query_builder,
         'customer_id' => { 'value' => customer_id, 'encode' => true }
       )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'version' => version
+      )
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
@@ -219,16 +235,21 @@ module Square
       )
     end
 
-    # Updates the details of an existing customer. When two profiles are merged
-    # into a single profile, that profile is assigned a new `customer_id`. You
-    # must use
-    # the new `customer_id` to update merged profiles.
-    # You cannot edit a customer's cards on file with this endpoint. To make
-    # changes
-    # to a card on file, you must delete the existing card on file with the
-    # [DeleteCustomerCard](#endpoint-Customers-deletecustomercard) endpoint,
-    # then create a new one with the
-    # [CreateCustomerCard](#endpoint-Customers-createcustomercard) endpoint.
+    # Updates a customer profile. To change an attribute, specify the new value.
+    # To remove an attribute, specify the value as an empty string or empty
+    # object.
+    # As a best practice, you should include the `version` field in the request
+    # to enable [optimistic
+    # concurrency](https://developer.squareup.com/docs/working-with-apis/optimis
+    # tic-concurrency) control. The value must be set to the current version of
+    # the customer profile.
+    # To update a customer profile that was created by merging existing
+    # profiles, you must use the ID of the newly created profile.
+    # You cannot use this endpoint to change cards on file. To change a card on
+    # file, call [DeleteCustomerCard]($e/Customers/DeleteCustomerCard) to delete
+    # the existing card and then call
+    # [CreateCustomerCard]($e/Customers/CreateCustomerCard) to create a new
+    # card.
     # @param [String] customer_id Required parameter: The ID of the customer to
     # update.
     # @param [UpdateCustomerRequest] body Required parameter: An object

data/lib/square/api/devices_api.rb

@@ -9,7 +9,8 @@ module Square
     # @param [String] cursor Optional parameter: A pagination cursor returned by
     # a previous call to this endpoint. Provide this to retrieve the next set of
     # results for your original query.  See [Paginating
-    # results](#paginatingresults) for more information.
+    # results](https://developer.squareup.com/docs/working-with-apis/pagination)
+    # for more information.
     # @param [String] location_id Optional parameter: If specified, only returns
     # DeviceCodes of the specified location. Returns DeviceCodes of all
     # locations if empty.

data/lib/square/api/disputes_api.rb

@@ -167,8 +167,7 @@ module Square
     # Square does not send the bank any evidence that is removed. Also, you
     # cannot remove evidence after
     # submitting it to the bank using
-    # [SubmitEvidence](https://developer.squareup.com/docs/reference/square/disp
-    # utes-api/submit-evidence).
+    # [SubmitEvidence]($e/Disputes/SubmitEvidence).
     # @param [String] dispute_id Required parameter: The ID of the dispute you
     # want to remove evidence from.
     # @param [String] evidence_id Required parameter: The ID of the evidence you
@@ -359,10 +358,9 @@ module Square
     # Before submitting evidence, Square compiles all available evidence. This
     # includes evidence uploaded
     # using the
-    # [CreateDisputeEvidenceFile](https://developer.squareup.com/docs/reference/
-    # square/disputes-api/create-dispute-evidence-file) and
-    # [CreateDisputeEvidenceText](https://developer.squareup.com/docs/reference/
-    # square/disputes-api/create-dispute-evidence-text) endpoints and
+    # [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.