square.rb 26.2.0.20230315 → 28.0.0.20230517

data/lib/square/api/merchant_custom_attributes_api.rb

@@ -0,0 +1,419 @@
+module Square
+  # MerchantCustomAttributesApi
+  class MerchantCustomAttributesApi < BaseApi
+    # Lists the merchant-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`.
+    # @param [VisibilityFilter] visibility_filter Optional parameter: Filters
+    # the `CustomAttributeDefinition` results by their `visibility` values.
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return in a single paged response. This limit is advisory. The response
+    # might contain more or fewer results. The minimum value is 1 and the
+    # maximum value is 100. The default value is 20. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @param [String] cursor Optional parameter: The cursor returned in the
+    # paged response from the previous call to this endpoint. Provide this
+    # cursor to retrieve the next page of results for your original request. For
+    # more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @return [ListMerchantCustomAttributeDefinitionsResponse Hash] response from the API call
+    def list_merchant_custom_attribute_definitions(visibility_filter: nil,
+                                                   limit: nil,
+                                                   cursor: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/merchants/custom-attribute-definitions',
+                                     'default')
+                   .query_param(new_parameter(visibility_filter, key: 'visibility_filter'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Creates a merchant-related [custom attribute
+    # definition]($m/CustomAttributeDefinition) for a Square seller account.
+    # Use this endpoint to define a custom attribute that can be associated with
+    # a merchant connecting to your application.
+    # A custom attribute definition specifies the `key`, `visibility`, `schema`,
+    # and other properties
+    # for a custom attribute. After the definition is created, you can call
+    # [UpsertMerchantCustomAttribute]($e/MerchantCustomAttributes/UpsertMerchant
+    # CustomAttribute) or
+    # [BulkUpsertMerchantCustomAttributes]($e/MerchantCustomAttributes/BulkUpser
+    # tMerchantCustomAttributes)
+    # to set the custom attribute for a merchant.
+    # @param [CreateMerchantCustomAttributeDefinitionRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [CreateMerchantCustomAttributeDefinitionResponse Hash] response from the API call
+    def create_merchant_custom_attribute_definition(body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/merchants/custom-attribute-definitions',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Deletes a merchant-related [custom attribute
+    # definition]($m/CustomAttributeDefinition) from a Square seller account.
+    # Deleting a custom attribute definition also deletes the corresponding
+    # custom attribute from
+    # the merchant.
+    # Only the definition owner can delete a custom attribute definition.
+    # @param [String] key Required parameter: The key of the custom attribute
+    # definition to delete.
+    # @return [DeleteMerchantCustomAttributeDefinitionResponse Hash] response from the API call
+    def delete_merchant_custom_attribute_definition(key:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/v2/merchants/custom-attribute-definitions/{key}',
+                                     'default')
+                   .template_param(new_parameter(key, key: 'key')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Retrieves a merchant-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`.
+    # @param [String] key Required parameter: The key of the custom attribute
+    # definition to retrieve. If the requesting application is not the
+    # definition owner, you must use the qualified key.
+    # @param [Integer] version Optional parameter: The current version of the
+    # custom attribute definition, which is used for strongly consistent reads
+    # to guarantee that you receive the most up-to-date data. When included in
+    # the request, Square returns the specified version or a higher version if
+    # one exists. If the specified version is higher than the current version,
+    # Square returns a `BAD_REQUEST` error.
+    # @return [RetrieveMerchantCustomAttributeDefinitionResponse Hash] response from the API call
+    def retrieve_merchant_custom_attribute_definition(key:,
+                                                      version: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/merchants/custom-attribute-definitions/{key}',
+                                     'default')
+                   .template_param(new_parameter(key, key: 'key')
+                                    .should_encode(true))
+                   .query_param(new_parameter(version, key: 'version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Updates a merchant-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.
+    # Only the definition owner can update a custom attribute definition.
+    # @param [String] key Required parameter: The key of the custom attribute
+    # definition to update.
+    # @param [UpdateMerchantCustomAttributeDefinitionRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [UpdateMerchantCustomAttributeDefinitionResponse Hash] response from the API call
+    def update_merchant_custom_attribute_definition(key:,
+                                                    body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/v2/merchants/custom-attribute-definitions/{key}',
+                                     'default')
+                   .template_param(new_parameter(key, key: 'key')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Deletes [custom attributes]($m/CustomAttribute) for a merchant as a bulk
+    # operation.
+    # To delete a custom attribute owned by another application, the
+    # `visibility` setting must be
+    # `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [BulkDeleteMerchantCustomAttributesRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [BulkDeleteMerchantCustomAttributesResponse Hash] response from the API call
+    def bulk_delete_merchant_custom_attributes(body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/merchants/custom-attributes/bulk-delete',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Creates or updates [custom attributes]($m/CustomAttribute) for a merchant
+    # as a bulk operation.
+    # Use this endpoint to set the value of one or more custom attributes for a
+    # merchant.
+    # A custom attribute is based on a custom attribute definition in a Square
+    # seller account, which is
+    # created using the
+    # [CreateMerchantCustomAttributeDefinition]($e/MerchantCustomAttributes/Crea
+    # teMerchantCustomAttributeDefinition) endpoint.
+    # This `BulkUpsertMerchantCustomAttributes` endpoint accepts a map of 1 to
+    # 25 individual upsert
+    # requests and returns a map of individual upsert responses. Each upsert
+    # request has a unique ID
+    # and provides a merchant ID and custom attribute. Each upsert response is
+    # returned with the ID
+    # of the corresponding request.
+    # To create or update a custom attribute owned by another application, the
+    # `visibility` setting
+    # must be `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [BulkUpsertMerchantCustomAttributesRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [BulkUpsertMerchantCustomAttributesResponse Hash] response from the API call
+    def bulk_upsert_merchant_custom_attributes(body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/merchants/custom-attributes/bulk-upsert',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Lists the [custom attributes]($m/CustomAttribute) associated with a
+    # merchant.
+    # You can use the `with_definitions` query parameter to also retrieve custom
+    # attribute definitions
+    # in the same call.
+    # When all response pages are retrieved, the results include all custom
+    # attributes that are
+    # visible to the requesting application, including those that are owned by
+    # other applications
+    # and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [String] merchant_id Required parameter: The ID of the target
+    # [merchant](entity:Merchant).
+    # @param [VisibilityFilter] visibility_filter Optional parameter: Filters
+    # the `CustomAttributeDefinition` results by their `visibility` values.
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return in a single paged response. This limit is advisory. The response
+    # might contain more or fewer results. The minimum value is 1 and the
+    # maximum value is 100. The default value is 20. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @param [String] cursor Optional parameter: The cursor returned in the
+    # paged response from the previous call to this endpoint. Provide this
+    # cursor to retrieve the next page of results for your original request. For
+    # more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @param [TrueClass|FalseClass] with_definitions Optional parameter:
+    # Indicates whether to return the [custom attribute
+    # 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`.
+    # @return [ListMerchantCustomAttributesResponse Hash] response from the API call
+    def list_merchant_custom_attributes(merchant_id:,
+                                        visibility_filter: nil,
+                                        limit: nil,
+                                        cursor: nil,
+                                        with_definitions: false)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/merchants/{merchant_id}/custom-attributes',
+                                     'default')
+                   .template_param(new_parameter(merchant_id, key: 'merchant_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(visibility_filter, key: 'visibility_filter'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(with_definitions, key: 'with_definitions'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Deletes a [custom attribute]($m/CustomAttribute) associated with a
+    # merchant.
+    # To delete a custom attribute owned by another application, the
+    # `visibility` setting must be
+    # `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [String] merchant_id Required parameter: The ID of the target
+    # [merchant](entity:Merchant).
+    # @param [String] key Required parameter: The key of the custom attribute to
+    # delete. This key must match the `key` of a custom attribute definition in
+    # the Square seller account. If the requesting application is not the
+    # definition owner, you must use the qualified key.
+    # @return [DeleteMerchantCustomAttributeResponse Hash] response from the API call
+    def delete_merchant_custom_attribute(merchant_id:,
+                                         key:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/v2/merchants/{merchant_id}/custom-attributes/{key}',
+                                     'default')
+                   .template_param(new_parameter(merchant_id, key: 'merchant_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(key, key: 'key')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Retrieves a [custom attribute]($m/CustomAttribute) associated with a
+    # merchant.
+    # You can use the `with_definition` query parameter to also retrieve the
+    # custom attribute definition
+    # in the same call.
+    # To retrieve a custom attribute owned by another application, the
+    # `visibility` setting must be
+    # `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [String] merchant_id Required parameter: The ID of the target
+    # [merchant](entity:Merchant).
+    # @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](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
+    # custom attribute, which is used for strongly consistent reads to guarantee
+    # that you receive the most up-to-date data. When included in the request,
+    # Square returns the specified version or a higher version if one exists. If
+    # the specified version is higher than the current version, Square returns a
+    # `BAD_REQUEST` error.
+    # @return [RetrieveMerchantCustomAttributeResponse Hash] response from the API call
+    def retrieve_merchant_custom_attribute(merchant_id:,
+                                           key:,
+                                           with_definition: false,
+                                           version: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/merchants/{merchant_id}/custom-attributes/{key}',
+                                     'default')
+                   .template_param(new_parameter(merchant_id, key: 'merchant_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(key, key: 'key')
+                                    .should_encode(true))
+                   .query_param(new_parameter(with_definition, key: 'with_definition'))
+                   .query_param(new_parameter(version, key: 'version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Creates or updates a [custom attribute]($m/CustomAttribute) for a
+    # merchant.
+    # Use this endpoint to set the value of a custom attribute for a specified
+    # merchant.
+    # A custom attribute is based on a custom attribute definition in a Square
+    # seller account, which
+    # is created using the
+    # [CreateMerchantCustomAttributeDefinition]($e/MerchantCustomAttributes/Crea
+    # teMerchantCustomAttributeDefinition) endpoint.
+    # To create or update a custom attribute owned by another application, the
+    # `visibility` setting
+    # must be `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [String] merchant_id Required parameter: The ID of the target
+    # [merchant](entity:Merchant).
+    # @param [String] key Required parameter: The key of the custom attribute to
+    # create or update. This key must match the `key` of a custom attribute
+    # definition in the Square seller account. If the requesting application is
+    # not the definition owner, you must use the qualified key.
+    # @param [UpsertMerchantCustomAttributeRequest] body Required parameter: An
+    # object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [UpsertMerchantCustomAttributeResponse Hash] response from the API call
+    def upsert_merchant_custom_attribute(merchant_id:,
+                                         key:,
+                                         body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/merchants/{merchant_id}/custom-attributes/{key}',
+                                     'default')
+                   .template_param(new_parameter(merchant_id, key: 'merchant_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(key, key: 'key')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+  end
+end

data/lib/square/api/order_custom_attributes_api.rb

@@ -257,7 +257,7 @@ module Square
     # other applications
     # and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
     # @param [String] order_id Required parameter: The ID of the target
-    # [order]($m/Order).
+    # [order](entity:Order).
     # @param [VisibilityFilter] visibility_filter Optional parameter: Requests
     # that all of the custom attributes be returned, or only those that are
     # read-only or read-write.
@@ -276,7 +276,7 @@ module Square
     # ion).
     # @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`.
@@ -313,7 +313,7 @@ module Square
     # (also known as custom fields) are always set to
     # `VISIBILITY_READ_WRITE_VALUES`.
     # @param [String] order_id Required parameter: The ID of the target
-    # [order]($m/Order).
+    # [order](entity:Order).
     # @param [String] custom_attribute_key Required parameter: The key of the
     # custom attribute to delete.  This key must match the key of an existing
     # custom attribute definition.
@@ -349,7 +349,7 @@ module Square
     # also known as custom fields) are always set to
     # `VISIBILITY_READ_WRITE_VALUES`.
     # @param [String] order_id Required parameter: The ID of the target
-    # [order]($m/Order).
+    # [order](entity:Order).
     # @param [String] custom_attribute_key Required parameter: The key of the
     # custom attribute to retrieve.  This key must match the key of an existing
     # custom attribute definition.
@@ -359,7 +359,7 @@ module Square
     # specify the current version of the custom attribute.
     # @param [TrueClass|FalseClass] with_definition 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`.
@@ -402,7 +402,7 @@ module Square
     # (also known as custom fields) are always set to
     # `VISIBILITY_READ_WRITE_VALUES`.
     # @param [String] order_id Required parameter: The ID of the target
-    # [order]($m/Order).
+    # [order](entity:Order).
     # @param [String] custom_attribute_key Required parameter: The key of the
     # custom attribute to create or update.  This key must match the key  of an
     # existing custom attribute definition.

data/lib/square/api/payments_api.rb

@@ -6,19 +6,22 @@ module Square
     # might take several
     # seconds to appear.
     # The maximum results per page is 100.
-    # @param [String] begin_time Optional parameter: The timestamp for the
-    # beginning of the reporting period, in RFC 3339 format. Inclusive. Default:
-    # The current time minus one year.
-    # @param [String] end_time Optional parameter: The timestamp for the end of
-    # the reporting period, in RFC 3339 format.  Default: The current time.
+    # @param [String] begin_time Optional parameter: Indicates the start of the
+    # time range to retrieve payments for, in RFC 3339 format.   The range is
+    # determined using the `created_at` field for each Payment. Inclusive.
+    # Default: The current time minus one year.
+    # @param [String] end_time Optional parameter: Indicates the end of the time
+    # range to retrieve payments for, in RFC 3339 format.  The  range is
+    # determined using the `created_at` field for each Payment.  Default: The
+    # current time.
     # @param [String] sort_order Optional parameter: The order in which results
-    # are listed: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest
-    # (default).
+    # are listed by `Payment.created_at`: - `ASC` - Oldest to newest. - `DESC` -
+    # Newest to oldest (default).
     # @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 [String] location_id Optional parameter: Limit results to the
     # location supplied. By default, results are returned for the default (main)
     # location associated with the seller.

data/lib/square/api/payouts_api.rb

@@ -6,7 +6,7 @@ module Square
     # in ascending or descending order.
     # To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.
     # @param [String] location_id Optional parameter: The ID of the location for
-    # which to list the payouts.  By default, payouts are returned for the
+    # which to list the payouts. By default, payouts are returned for the
     # default (main) location associated with the seller.
     # @param [PayoutStatus] status Optional parameter: If provided, only payouts
     # with the given status are returned.
@@ -20,9 +20,9 @@ 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)
-    # . If request parameters change between requests, subsequent results may
-    # contain duplicates or missing records.
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination). If request parameters change between requests,
+    # subsequent results may contain duplicates or missing records.
     # @param [Integer] limit Optional parameter: The maximum number of results
     # to be returned in a single page. It is possible to receive fewer results
     # than the specified limit on a given page. The default value of 100 is also
@@ -86,9 +86,9 @@ 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)
-    # . If request parameters change between requests, subsequent results may
-    # contain duplicates or missing records.
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination). If request parameters change between requests,
+    # subsequent results may contain duplicates or missing records.
     # @param [Integer] limit Optional parameter: The maximum number of results
     # to be returned in a single page. It is possible to receive fewer results
     # than the specified limit on a given page. The default value of 100 is also

data/lib/square/api/refunds_api.rb

@@ -6,26 +6,28 @@ module Square
     # might take several
     # seconds to appear.
     # The maximum results per page is 100.
-    # @param [String] begin_time Optional parameter: The timestamp for the
-    # beginning of the requested reporting period, in RFC 3339 format.  Default:
-    # The current time minus one year.
-    # @param [String] end_time Optional parameter: The timestamp for the end of
-    # the requested reporting period, in RFC 3339 format.  Default: The current
-    # time.
+    # @param [String] begin_time Optional parameter: Indicates the start of the
+    # time range to retrieve each PaymentRefund` for, in RFC 3339  format.  The
+    # range is determined using the `created_at` field for each `PaymentRefund`.
+    #   Default: The current time minus one year.
+    # @param [String] end_time Optional parameter: Indicates the end of the time
+    # range to retrieve each `PaymentRefund` for, in RFC 3339  format.  The
+    # range is determined using the `created_at` field for each `PaymentRefund`.
+    #  Default: The current time.
     # @param [String] sort_order Optional parameter: The order in which results
-    # are listed: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest
-    # (default).
+    # are listed by `PaymentRefund.created_at`: - `ASC` - Oldest to newest. -
+    # `DESC` - Newest to oldest (default).
     # @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 [String] location_id Optional parameter: Limit results to the
     # location supplied. By default, results are returned for all locations
     # associated with the seller.
     # @param [String] status Optional parameter: If provided, only refunds with
     # the given status are returned. For a list of refund status values, see
-    # [PaymentRefund]($m/PaymentRefund).  Default: If omitted, refunds are
+    # [PaymentRefund](entity:PaymentRefund).  Default: If omitted, refunds are
     # returned regardless of their status.
     # @param [String] source_type Optional parameter: If provided, only returns
     # refunds whose payments have the indicated source type. Current values

data/lib/square/api/transactions_api.rb

@@ -81,7 +81,7 @@ module Square
     end
 
     # Captures a transaction that was created with the
-    # [Charge]($e/Transactions/Charge)
+    # [Charge](api-endpoint:Transactions-Charge)
     # endpoint with a `delay_capture` value of `true`.
     # See [Delayed capture
     # transactions](https://developer.squareup.com/docs/payments/transactions/ov
@@ -111,7 +111,7 @@ module Square
     end
 
     # Cancels a transaction that was created with the
-    # [Charge]($e/Transactions/Charge)
+    # [Charge](api-endpoint:Transactions-Charge)
     # endpoint with a `delay_capture` value of `true`.
     # See [Delayed capture
     # transactions](https://developer.squareup.com/docs/payments/transactions/ov

data/lib/square/api/vendors_api.rb

@@ -117,7 +117,7 @@ module Square
 
     # Retrieves the vendor of a specified [Vendor]($m/Vendor) ID.
     # @param [String] vendor_id Required parameter: ID of the
-    # [Vendor]($m/Vendor) to retrieve.
+    # [Vendor](entity:Vendor) to retrieve.
     # @return [RetrieveVendorResponse Hash] response from the API call
     def retrieve_vendor(vendor_id:)
       new_api_call_builder