square.rb 26.2.0.20230315 → 28.0.0.20230517

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fe50fe3512834461866b9d1ebbd83bee0ca14f16313e4928f7ae114105ffc22
-  data.tar.gz: e168aac2b86e67820df82977d1cd628f83566abbc77e821f029f509fadb19b5d
+  metadata.gz: 7aad233be99bfca2993a00a7c626631d148ed55b31b1e066374f4140f24e39d8
+  data.tar.gz: 495f1f8e3090fdcff82d59bb5f3a107d6e3041054c84ab025a6f10349bfc0103
 SHA512:
-  metadata.gz: 1f4960b642816caa0d3aa71aceed7b834ca127c188b4e91098e56beacabb501531e67cf2747bdd3045e3dceedc565d9db9ec99f2fdfd369bdbec2c2bb110ca4d
-  data.tar.gz: 745fb7ff183d3445c7edcbe352dbb701597acf2a551971d9cfdd0cfa57e3002a085c3497404b52b49a39d89b7221991f092c14b7fec09352d6fe2b203def7940
+  metadata.gz: '08e41c2920e1801d7a40ec683df94518d41b00953c46079de8749dd8f1c6a207750f17ea001d4e293d8cd493dee568b7d23204e2e60c9a864bf25933841bd1a0'
+  data.tar.gz: e6f513724723fd25e7009dff20d565ce765b20312496409822bd492a96157c71e5c31eb207b2508faa75e9d5f8d424cc43bf670c19626fdfe6dae7bf9f78a3b2

data/README.md

@@ -126,6 +126,9 @@ rake
 * [Mobile Authorization]
 * [OAuth]
 
+### Webhook Subscriptions
+* [Webhook Subscriptions]
+
 ## Deprecated APIs
 
 The following Square APIs are [deprecated](https://developer.squareup.com/docs/build-basics/api-lifecycle):
@@ -176,3 +179,4 @@ The following Square APIs are [deprecated](https://developer.squareup.com/docs/b
 [Gift Card Activities]: doc/api/gift-card-activities.md
 [Employees]: doc/api/employees.md
 [Transactions]: doc/api/transactions.md
+[Webhook Subscriptions]: doc/api/webhook-subscriptions.md

data/lib/square/api/base_api.rb

@@ -4,7 +4,7 @@ module Square
     attr_accessor :config, :http_call_back
 
     def self.user_agent
-      'Square-Ruby-SDK/26.2.0.20230315 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      'Square-Ruby-SDK/28.0.0.20230517 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
     end
 
     def self.user_agent_parameters

data/lib/square/api/booking_custom_attributes_api.rb

@@ -223,7 +223,7 @@ module Square
     # To call this endpoint with seller-level permissions, set
     # `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
     # @param [String] booking_id Required parameter: The ID of the target
-    # [booking]($m/Booking).
+    # [booking](entity:Booking).
     # @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
@@ -238,7 +238,7 @@ module Square
     # atterns/pagination).
     # @param [TrueClass|FalseClass] with_definitions Optional parameter:
     # Indicates whether to return the [custom attribute
-    # definition]($m/CustomAttributeDefinition) in the `definition` field of
+    # definition](entity: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`.
@@ -274,7 +274,7 @@ module Square
     # seller must have subscribed to *Appointments Plus*
     # or *Appointments Premium*.
     # @param [String] booking_id Required parameter: The ID of the target
-    # [booking]($m/Booking).
+    # [booking](entity:Booking).
     # @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
@@ -305,15 +305,15 @@ module Square
     # To call this endpoint with seller-level permissions, set
     # `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
     # @param [String] booking_id Required parameter: The ID of the target
-    # [booking]($m/Booking).
+    # [booking](entity:Booking).
     # @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 [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
+    # definition](entity: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
@@ -355,7 +355,7 @@ module Square
     # seller must have subscribed to *Appointments Plus*
     # or *Appointments Premium*.
     # @param [String] booking_id Required parameter: The ID of the target
-    # [booking]($m/Booking).
+    # [booking](entity:Booking).
     # @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

data/lib/square/api/bookings_api.rb

@@ -51,8 +51,8 @@ module Square
 
     # Creates a booking.
     # The required input must include the following:
-    # - `Booking.location_id`,
-    # - `Booking.start_at`,
+    # - `Booking.location_id`
+    # - `Booking.start_at`
     # - `Booking.team_member_id`
     # - `Booking.AppointmentSegment.service_variation_id`
     # - `Booking.AppointmentSegment.service_variation_version`
@@ -186,7 +186,8 @@ module Square
     # To call this endpoint with seller-level permissions, set
     # `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
     # @param [String] booking_id Required parameter: The ID of the
-    # [Booking]($m/Booking) object representing the to-be-retrieved booking.
+    # [Booking](entity:Booking) object representing the to-be-retrieved
+    # booking.
     # @return [RetrieveBookingResponse Hash] response from the API call
     def retrieve_booking(booking_id:)
       new_api_call_builder
@@ -213,7 +214,7 @@ module Square
     # 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.
+    # [Booking](entity: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.
@@ -247,7 +248,8 @@ module Square
     # 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.
+    # [Booking](entity: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/cards_api.rb

@@ -6,8 +6,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
-    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
-    # for more information.
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination) for more information.
     # @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.

data/lib/square/api/catalog_api.rb

@@ -198,11 +198,11 @@ module Square
     # @param [String] cursor Optional parameter: The pagination cursor returned
     # in the previous response. Leave unset for an initial request. The page
     # size is currently set to be 100. See
-    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
-    # for more information.
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination) for more information.
     # @param [String] types Optional parameter: An optional case-insensitive,
     # comma-separated list of object types to retrieve.  The valid values are
-    # defined in the [CatalogObjectType]($m/CatalogObjectType) enum, for
+    # defined in the [CatalogObjectType](entity:CatalogObjectType) enum, for
     # example, `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,
     # `MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.  If this is unspecified, the
     # operation returns objects of all the top level types at the version of the

data/lib/square/api/checkout_api.rb

@@ -9,7 +9,7 @@ module Square
     # highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-
     # highlights).
     # We recommend that you use the
-    # new [CreatePaymentLink]($e/Checkout/CreatePaymentLink)
+    # new [CreatePaymentLink](api-endpoint: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.

data/lib/square/api/customer_custom_attributes_api.rb

@@ -229,7 +229,7 @@ module Square
     # 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).
+    # [customer profile](entity: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
@@ -244,7 +244,7 @@ module Square
     # atterns/pagination).
     # @param [TrueClass|FalseClass] with_definitions Optional parameter:
     # Indicates whether to return the [custom attribute
-    # definition]($m/CustomAttributeDefinition) in the `definition` field of
+    # definition](entity: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`.
@@ -279,7 +279,7 @@ module Square
     # (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).
+    # [customer profile](entity: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
@@ -316,15 +316,15 @@ module Square
     # (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).
+    # [customer profile](entity: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 [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
+    # definition](entity: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
@@ -373,7 +373,7 @@ module Square
     # (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).
+    # [customer profile](entity: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

data/lib/square/api/disputes_api.rb

@@ -5,8 +5,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).
     # @param [DisputeState] states Optional parameter: The dispute states used
     # to filter the result. If not specified, the endpoint returns all
     # disputes.

data/lib/square/api/gift_card_activities_api.rb

@@ -14,7 +14,7 @@ module Square
     # card. Otherwise, the endpoint returns all gift card activities for  the
     # seller.
     # @param [String] type Optional parameter: If a
-    # [type]($m/GiftCardActivityType) is provided, the endpoint returns gift
+    # [type](entity:GiftCardActivityType) is provided, the endpoint returns gift
     # card activities of the specified type.  Otherwise, the endpoint returns
     # all types of gift card activities.
     # @param [String] location_id Optional parameter: If a location ID is

data/lib/square/api/gift_cards_api.rb

@@ -4,12 +4,13 @@ module Square
     # Lists all gift cards. You can specify optional filters to retrieve
     # a subset of the gift cards. Results are sorted by `created_at` in
     # ascending order.
-    # @param [String] type Optional parameter: If a [type]($m/GiftCardType) is
-    # provided, the endpoint returns gift cards of the specified type.
+    # @param [String] type Optional parameter: If a [type](entity:GiftCardType)
+    # is provided, the endpoint returns gift cards of the specified type.
     # Otherwise, the endpoint returns gift cards of all types.
-    # @param [String] state Optional parameter: If a [state]($m/GiftCardStatus)
-    # is provided, the endpoint returns the gift cards in the specified state.
-    # Otherwise, the endpoint returns the gift cards of all states.
+    # @param [String] state Optional parameter: If a
+    # [state](entity:GiftCardStatus) is provided, the endpoint returns the gift
+    # cards in the specified state. Otherwise, the endpoint returns the gift
+    # cards of all states.
     # @param [Integer] limit Optional parameter: If a limit is provided, the
     # endpoint returns only the specified number of results per page. The
     # maximum value is 50. The default value is 30. For more information, see

data/lib/square/api/inventory_api.rb

@@ -2,11 +2,11 @@ module Square
   # InventoryApi
   class InventoryApi < BaseApi
     # Deprecated version of
-    # [RetrieveInventoryAdjustment]($e/Inventory/RetrieveInventoryAdjustment)
-    # after the endpoint URL
+    # [RetrieveInventoryAdjustment](api-endpoint:Inventory-RetrieveInventoryAdju
+    # stment) after the endpoint URL
     # is updated to conform to the standard convention.
     # @param [String] adjustment_id Required parameter: ID of the
-    # [InventoryAdjustment]($m/InventoryAdjustment) to retrieve.
+    # [InventoryAdjustment](entity:InventoryAdjustment) to retrieve.
     # @return [RetrieveInventoryAdjustmentResponse Hash] response from the API call
     def deprecated_retrieve_inventory_adjustment(adjustment_id:)
       warn 'Endpoint deprecated_retrieve_inventory_adjustment in InventoryApi '\
@@ -29,7 +29,7 @@ module Square
     # Returns the [InventoryAdjustment]($m/InventoryAdjustment) object
     # with the provided `adjustment_id`.
     # @param [String] adjustment_id Required parameter: ID of the
-    # [InventoryAdjustment]($m/InventoryAdjustment) to retrieve.
+    # [InventoryAdjustment](entity:InventoryAdjustment) to retrieve.
     # @return [RetrieveInventoryAdjustmentResponse Hash] response from the API call
     def retrieve_inventory_adjustment(adjustment_id:)
       new_api_call_builder
@@ -48,8 +48,8 @@ module Square
     end
 
     # Deprecated version of
-    # [BatchChangeInventory]($e/Inventory/BatchChangeInventory) after the
-    # endpoint URL
+    # [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) after
+    # the endpoint URL
     # is updated to conform to the standard convention.
     # @param [BatchChangeInventoryRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -75,8 +75,8 @@ module Square
     end
 
     # Deprecated version of
-    # [BatchRetrieveInventoryChanges]($e/Inventory/BatchRetrieveInventoryChanges
-    # ) after the endpoint URL
+    # [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInvent
+    # oryChanges) after the endpoint URL
     # is updated to conform to the standard convention.
     # @param [BatchRetrieveInventoryChangesRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
@@ -102,8 +102,8 @@ module Square
     end
 
     # Deprecated version of
-    # [BatchRetrieveInventoryCounts]($e/Inventory/BatchRetrieveInventoryCounts)
-    # after the endpoint URL
+    # [BatchRetrieveInventoryCounts](api-endpoint:Inventory-BatchRetrieveInvento
+    # ryCounts) after the endpoint URL
     # is updated to conform to the standard convention.
     # @param [BatchRetrieveInventoryCountsRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
@@ -212,11 +212,11 @@ module Square
     end
 
     # Deprecated version of
-    # [RetrieveInventoryPhysicalCount]($e/Inventory/RetrieveInventoryPhysicalCou
-    # nt) after the endpoint URL
+    # [RetrieveInventoryPhysicalCount](api-endpoint:Inventory-RetrieveInventoryP
+    # hysicalCount) after the endpoint URL
     # is updated to conform to the standard convention.
     # @param [String] physical_count_id Required parameter: ID of the
-    # [InventoryPhysicalCount]($m/InventoryPhysicalCount) to retrieve.
+    # [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve.
     # @return [RetrieveInventoryPhysicalCountResponse Hash] response from the API call
     def deprecated_retrieve_inventory_physical_count(physical_count_id:)
       warn 'Endpoint deprecated_retrieve_inventory_physical_count in Inventory'\
@@ -239,7 +239,7 @@ module Square
     # Returns the [InventoryPhysicalCount]($m/InventoryPhysicalCount)
     # object with the provided `physical_count_id`.
     # @param [String] physical_count_id Required parameter: ID of the
-    # [InventoryPhysicalCount]($m/InventoryPhysicalCount) to retrieve.
+    # [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve.
     # @return [RetrieveInventoryPhysicalCountResponse Hash] response from the API call
     def retrieve_inventory_physical_count(physical_count_id:)
       new_api_call_builder
@@ -260,7 +260,7 @@ module Square
     # Returns the [InventoryTransfer]($m/InventoryTransfer) object
     # with the provided `transfer_id`.
     # @param [String] transfer_id Required parameter: ID of the
-    # [InventoryTransfer]($m/InventoryTransfer) to retrieve.
+    # [InventoryTransfer](entity:InventoryTransfer) to retrieve.
     # @return [RetrieveInventoryTransferResponse Hash] response from the API call
     def retrieve_inventory_transfer(transfer_id:)
       new_api_call_builder
@@ -283,10 +283,10 @@ module Square
     # [Location]($m/Location)s. Responses are paginated and unsorted.
     # For more sophisticated queries, use a batch endpoint.
     # @param [String] catalog_object_id Required parameter: ID of the
-    # [CatalogObject]($m/CatalogObject) to retrieve.
+    # [CatalogObject](entity:CatalogObject) to retrieve.
     # @param [String] location_ids Optional parameter: The
-    # [Location]($m/Location) IDs to look up as a comma-separated list. An empty
-    # list queries all locations.
+    # [Location](entity:Location) IDs to look up as a comma-separated list. An
+    # empty list queries all locations.
     # @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 the original query.  See the
@@ -314,11 +314,11 @@ module Square
     end
 
     # Returns a set of physical counts and inventory adjustments for the
-    # provided [CatalogObject]($m/CatalogObject) at the requested
-    # [Location]($m/Location)s.
+    # provided [CatalogObject](entity:CatalogObject) at the requested
+    # [Location](entity:Location)s.
     # You can achieve the same result by calling
-    # [BatchRetrieveInventoryChanges]($e/Inventory/BatchRetrieveInventoryChanges
-    # )
+    # [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInvent
+    # oryChanges)
     # and having the `catalog_object_ids` list contain a single element of the
     # `CatalogObject` ID.
     # Results are paginated and sorted in descending order according to their
@@ -328,10 +328,10 @@ module Square
     # used to display recent changes for a specific item. For more
     # sophisticated queries, use a batch endpoint.
     # @param [String] catalog_object_id Required parameter: ID of the
-    # [CatalogObject]($m/CatalogObject) to retrieve.
+    # [CatalogObject](entity:CatalogObject) to retrieve.
     # @param [String] location_ids Optional parameter: The
-    # [Location]($m/Location) IDs to look up as a comma-separated list. An empty
-    # list queries all locations.
+    # [Location](entity:Location) IDs to look up as a comma-separated list. An
+    # empty list queries all locations.
     # @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 the original query.  See the

data/lib/square/api/invoices_api.rb

@@ -9,8 +9,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 your original query.  For more information, see
-    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
-    # ion).
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @param [Integer] limit Optional parameter: The maximum number of invoices
     # to return (200 is the maximum `limit`).  If not provided, the server uses
     # a default limit of 100 invoices.
@@ -95,9 +95,9 @@ module Square
     # @param [String] invoice_id Required parameter: The ID of the invoice to
     # delete.
     # @param [Integer] version Optional parameter: The version of the
-    # [invoice]($m/Invoice) to delete. If you do not know the version, you can
-    # call [GetInvoice]($e/Invoices/GetInvoice) or
-    # [ListInvoices]($e/Invoices/ListInvoices).
+    # [invoice](entity:Invoice) to delete. If you do not know the version, you
+    # can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or
+    # [ListInvoices](api-endpoint:Invoices-ListInvoices).
     # @return [DeleteInvoiceResponse Hash] response from the API call
     def delete_invoice(invoice_id:,
                        version: nil)
@@ -176,7 +176,7 @@ module Square
     # You cannot cancel an invoice in the `DRAFT` state or in a terminal state:
     # `PAID`, `REFUNDED`, `CANCELED`, or `FAILED`.
     # @param [String] invoice_id Required parameter: The ID of the
-    # [invoice]($m/Invoice) to cancel.
+    # [invoice](entity:Invoice) to cancel.
     # @param [CancelInvoiceRequest] 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/location_custom_attributes_api.rb

@@ -244,7 +244,7 @@ module Square
     # other applications
     # and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
     # @param [String] location_id Required parameter: The ID of the target
-    # [location]($m/Location).
+    # [location](entity:Location).
     # @param [VisibilityFilter] visibility_filter Optional parameter: Filters
     # the `CustomAttributeDefinition` results by their `visibility` values.
     # @param [Integer] limit Optional parameter: The maximum number of results
@@ -261,7 +261,7 @@ module Square
     # atterns/pagination).
     # @param [TrueClass|FalseClass] with_definitions Optional parameter:
     # Indicates whether to return the [custom attribute
-    # definition]($m/CustomAttributeDefinition) in the `definition` field of
+    # definition](entity: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`.
@@ -296,7 +296,7 @@ module Square
     # `visibility` setting must be
     # `VISIBILITY_READ_WRITE_VALUES`.
     # @param [String] location_id Required parameter: The ID of the target
-    # [location]($m/Location).
+    # [location](entity:Location).
     # @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
@@ -330,15 +330,15 @@ module Square
     # `visibility` setting must be
     # `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
     # @param [String] location_id Required parameter: The ID of the target
-    # [location]($m/Location).
+    # [location](entity:Location).
     # @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 [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
+    # definition](entity: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
@@ -384,7 +384,7 @@ module Square
     # `visibility` setting
     # must be `VISIBILITY_READ_WRITE_VALUES`.
     # @param [String] location_id Required parameter: The ID of the target
-    # [location]($m/Location).
+    # [location](entity:Location).
     # @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

data/lib/square/api/loyalty_api.rb

@@ -52,7 +52,7 @@ module Square
 
     # Retrieves a loyalty account.
     # @param [String] account_id Required parameter: The ID of the [loyalty
-    # account]($m/LoyaltyAccount) to retrieve.
+    # account](entity:LoyaltyAccount) to retrieve.
     # @return [RetrieveLoyaltyAccountResponse Hash] response from the API call
     def retrieve_loyalty_account(account_id:)
       new_api_call_builder
@@ -96,7 +96,7 @@ module Square
     # points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions
     # #calculate-promotion-points).
     # @param [String] account_id Required parameter: The ID of the target
-    # [loyalty account]($m/LoyaltyAccount).
+    # [loyalty account](entity:LoyaltyAccount).
     # @param [AccumulateLoyaltyPointsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -127,7 +127,7 @@ module Square
     # [AccumulateLoyaltyPoints]($e/Loyalty/AccumulateLoyaltyPoints)
     # to add points when a buyer pays for the purchase.
     # @param [String] account_id Required parameter: The ID of the target
-    # [loyalty account]($m/LoyaltyAccount).
+    # [loyalty account](entity:LoyaltyAccount).
     # @param [AdjustLoyaltyPointsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -187,8 +187,9 @@ module Square
     # created and managed from the Seller Dashboard. For more information, see
     # [Loyalty Program
     # Overview](https://developer.squareup.com/docs/loyalty/overview).
-    # Replaced with [RetrieveLoyaltyProgram]($e/Loyalty/RetrieveLoyaltyProgram)
-    # when used with the keyword `main`.
+    # Replaced with
+    # [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when
+    # used with the keyword `main`.
     # @return [ListLoyaltyProgramsResponse Hash] response from the API call
     def list_loyalty_programs
       warn 'Endpoint list_loyalty_programs in LoyaltyApi is deprecated'
@@ -257,7 +258,7 @@ module Square
     # points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions
     # #calculate-promotion-points).
     # @param [String] program_id Required parameter: The ID of the [loyalty
-    # program]($m/LoyaltyProgram), which defines the rules for accruing
+    # program](entity:LoyaltyProgram), which defines the rules for accruing
     # points.
     # @param [CalculateLoyaltyPointsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -288,9 +289,9 @@ module Square
     # Results are sorted by the `created_at` date in descending order (newest to
     # oldest).
     # @param [String] program_id Required parameter: The ID of the base [loyalty
-    # program]($m/LoyaltyProgram). To get the program ID, call
-    # [RetrieveLoyaltyProgram]($e/Loyalty/RetrieveLoyaltyProgram) using the
-    # `main` keyword.
+    # program](entity:LoyaltyProgram). To get the program ID, call
+    # [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram)
+    # using the `main` keyword.
     # @param [LoyaltyPromotionStatus] status Optional parameter: The status to
     # filter the results by. If a status is provided, only loyalty promotions
     # with the specified status are returned. Otherwise, all loyalty promotions
@@ -339,10 +340,10 @@ module Square
     # loyalty promotions with an
     # `ACTIVE` or `SCHEDULED` status.
     # @param [String] program_id Required parameter: The ID of the [loyalty
-    # program]($m/LoyaltyProgram) to associate with the promotion. To get the
-    # program ID, call
-    # [RetrieveLoyaltyProgram]($e/Loyalty/RetrieveLoyaltyProgram) using the
-    # `main` keyword.
+    # program](entity:LoyaltyProgram) to associate with the promotion. To get
+    # the program ID, call
+    # [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram)
+    # using the `main` keyword.
     # @param [CreateLoyaltyPromotionRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -369,11 +370,11 @@ module Square
 
     # Retrieves a loyalty promotion.
     # @param [String] promotion_id Required parameter: The ID of the [loyalty
-    # promotion]($m/LoyaltyPromotion) to retrieve.
+    # promotion](entity:LoyaltyPromotion) to retrieve.
     # @param [String] program_id Required parameter: The ID of the base [loyalty
-    # program]($m/LoyaltyProgram). To get the program ID, call
-    # [RetrieveLoyaltyProgram]($e/Loyalty/RetrieveLoyaltyProgram) using the
-    # `main` keyword.
+    # program](entity:LoyaltyProgram). To get the program ID, call
+    # [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram)
+    # using the `main` keyword.
     # @return [RetrieveLoyaltyPromotionResponse Hash] response from the API call
     def retrieve_loyalty_promotion(promotion_id:,
                                    program_id:)
@@ -403,10 +404,10 @@ module Square
     # you create a new one.
     # This endpoint sets the loyalty promotion to the `CANCELED` state
     # @param [String] promotion_id Required parameter: The ID of the [loyalty
-    # promotion]($m/LoyaltyPromotion) to cancel. You can cancel a promotion that
-    # has an `ACTIVE` or `SCHEDULED` status.
+    # promotion](entity:LoyaltyPromotion) to cancel. You can cancel a promotion
+    # that has an `ACTIVE` or `SCHEDULED` status.
     # @param [String] program_id Required parameter: The ID of the base [loyalty
-    # program]($m/LoyaltyProgram).
+    # program](entity:LoyaltyProgram).
     # @return [CancelLoyaltyPromotionResponse Hash] response from the API call
     def cancel_loyalty_promotion(promotion_id:,
                                  program_id:)
@@ -492,7 +493,7 @@ module Square
     # discounts.
     # You cannot delete a reward that has reached the terminal state (REDEEMED).
     # @param [String] reward_id Required parameter: The ID of the [loyalty
-    # reward]($m/LoyaltyReward) to delete.
+    # reward](entity:LoyaltyReward) to delete.
     # @return [DeleteLoyaltyRewardResponse Hash] response from the API call
     def delete_loyalty_reward(reward_id:)
       new_api_call_builder
@@ -512,7 +513,7 @@ module Square
 
     # Retrieves a loyalty reward.
     # @param [String] reward_id Required parameter: The ID of the [loyalty
-    # reward]($m/LoyaltyReward) to retrieve.
+    # reward](entity:LoyaltyReward) to retrieve.
     # @return [RetrieveLoyaltyRewardResponse Hash] response from the API call
     def retrieve_loyalty_reward(reward_id:)
       new_api_call_builder
@@ -539,7 +540,7 @@ module Square
     # In other words, points used for the reward cannot be returned
     # to the account.
     # @param [String] reward_id Required parameter: The ID of the [loyalty
-    # reward]($m/LoyaltyReward) to redeem.
+    # reward](entity:LoyaltyReward) to redeem.
     # @param [RedeemLoyaltyRewardRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.