square.rb 8.1.0.20210121 → 18.1.0.20220316

data/lib/square/api/cards_api.rb

@@ -0,0 +1,170 @@
+module Square
+  # CardsApi
+  class CardsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Retrieves a list of cards owned by the account making the request.
+    # A max of 25 cards will be returned.
+    # @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.
+    # @param [String] customer_id Optional parameter: Limit results to cards
+    # associated with the customer supplied. By default, all cards owned by the
+    # merchant are returned.
+    # @param [Boolean] include_disabled Optional parameter: Includes disabled
+    # cards. By default, all enabled cards owned by the merchant are returned.
+    # @param [String] reference_id Optional parameter: Limit results to cards
+    # associated with the reference_id supplied.
+    # @param [SortOrder] sort_order Optional parameter: Sorts the returned list
+    # by when the card was created with the specified order. This field defaults
+    # to ASC.
+    # @return [ListCardsResponse Hash] response from the API call
+    def list_cards(cursor: nil,
+                   customer_id: nil,
+                   include_disabled: false,
+                   reference_id: nil,
+                   sort_order: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/cards'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'cursor' => cursor,
+        'customer_id' => customer_id,
+        'include_disabled' => include_disabled,
+        'reference_id' => reference_id,
+        'sort_order' => sort_order
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Adds a card on file to an existing merchant.
+    # @param [CreateCardRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [CreateCardResponse Hash] response from the API call
+    def create_card(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/cards'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Retrieves details for a specific Card.
+    # @param [String] card_id Required parameter: Unique ID for the desired
+    # Card.
+    # @return [RetrieveCardResponse Hash] response from the API call
+    def retrieve_card(card_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/cards/{card_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'card_id' => { 'value' => card_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Disables the card, preventing any further updates or charges.
+    # Disabling an already disabled card is allowed but has no effect.
+    # @param [String] card_id Required parameter: Unique ID for the desired
+    # Card.
+    # @return [DisableCardResponse Hash] response from the API call
+    def disable_card(card_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/cards/{card_id}/disable'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'card_id' => { 'value' => card_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+  end
+end

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
@@ -29,7 +29,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -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.
@@ -70,7 +68,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -117,7 +115,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -138,10 +136,10 @@ 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
-    # upload an image, link an image to
-    # a catalog object, or do both.
+    # [CatalogImage]($m/CatalogImage) object that can be linked to an existing
+    # [CatalogObject]($m/CatalogObject) instance. The resulting `CatalogImage`
+    # is unattached to any `CatalogObject` if the `object_id`
+    # is not specified.
     # This `CreateCatalogImage` endpoint accepts HTTP multipart/form-data
     # requests with a JSON part and an image file part in
     # JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB.
@@ -198,6 +196,71 @@ module Square
       )
     end
 
+    # Uploads a new image file to replace the existing one in the specified
+    # [CatalogImage]($m/CatalogImage) object.
+    # This `UpdateCatalogImage` endpoint accepts HTTP multipart/form-data
+    # requests with a JSON part and an image file part in
+    # JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB.
+    # @param [String] image_id Required parameter: The ID of the `CatalogImage`
+    # object to update the encapsulated image file.
+    # @param [UpdateCatalogImageRequest] request Optional parameter: Example:
+    # @param [File | UploadIO] image_file Optional parameter: Example:
+    # @return [UpdateCatalogImageResponse Hash] response from the API call
+    def update_catalog_image(image_id:,
+                             request: nil,
+                             image_file: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/catalog/images/{image_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'image_id' => { 'value' => image_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      if image_file.is_a? FileWrapper
+        image_file_wrapper = image_file.file
+        image_file_content_type = image_file.content_type
+      else
+        image_file_wrapper = image_file
+        image_file_content_type = 'image/jpeg'
+      end
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare form parameters.
+      _parameters = {
+        'request' => Faraday::UploadIO.new(
+          StringIO.new(request.to_json),
+          'application/json'
+        ),
+        'image_file' => Faraday::UploadIO.new(
+          image_file_wrapper,
+          image_file_content_type
+        )
+      }
+      _parameters = APIHelper.form_encode_parameters(_parameters)
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.put(
+        _query_url,
+        headers: _headers,
+        parameters: _parameters
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
     # Retrieves information about the Square Catalog API, such as batch size
     # limits that can be used by the `BatchUpsertCatalogObjects` endpoint.
     # @return [CatalogInfoResponse Hash] response from the API call
@@ -228,34 +291,40 @@ module Square
       )
     end
 
-    # Returns a list of [CatalogObject](#type-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`
-    # parameter
-    # is specified as a comma-separated list of valid
-    # [CatalogObject](#type-catalogobject) types:
-    # `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`,
-    # `DISCOUNT`, `TAX`, `IMAGE`.
+    # Returns a list of all [CatalogObject]($m/CatalogObject)s of the specified
+    # types in the catalog.
+    # The `types` parameter is specified as a comma-separated list of the
+    # [CatalogObjectType]($m/CatalogObjectType) values,
+    # for example, "`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
+    # 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.
     # @param [String] types Optional parameter: An optional case-insensitive,
-    # comma-separated list of object types to retrieve, for example
-    # `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`.  The legal values are taken from the
-    # CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`,
-    # `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`.
+    # comma-separated list of object types to retrieve.  The valid values are
+    # defined in the [CatalogObjectType]($m/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
+    # Square API used to make the request. Object types that are nested onto
+    # other object types are not included in the defaults.  At the current API
+    # version the default object types are: ITEM, CATEGORY, TAX, DISCOUNT,
+    # MODIFIER_LIST, DINING_OPTION, TAX_EXEMPTION, SERVICE_CHARGE, PRICING_RULE,
+    # PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN,
+    # ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.
     # @param [Long] catalog_version Optional parameter: The specific version of
     # the catalog objects to be included in the response.  This allows you to
     # retrieve historical versions of objects. The specified version value is
-    # matched against the [CatalogObject](#type-catalogobject)s' `version`
-    # attribute.
+    # matched against the [CatalogObject]($m/CatalogObject)s' `version`
+    # attribute.  If not included, results will be from the current version of
+    # the catalog.
     # @return [ListCatalogResponse Hash] response from the API call
     def list_catalog(cursor: nil,
                      types: nil,
@@ -292,7 +361,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.
@@ -306,7 +375,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -326,14 +395,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,30 +439,35 @@ 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`,
     # the response will include additional objects that are related to the
-    # requested object, as follows:  If the `object` field of the response
-    # contains a `CatalogItem`, its associated `CatalogCategory`, `CatalogTax`,
-    # `CatalogImage` and `CatalogModifierList` objects will be returned in the
-    # `related_objects` field of the response. If the `object` field of the
-    # response contains a `CatalogItemVariation`, its parent `CatalogItem` will
-    # be returned in the `related_objects` field of the response.  Default
-    # value: `false`
+    # requested objects. Related objects are defined as any objects referenced
+    # by ID by the results in the `objects` field of the response. These objects
+    # are put in the `related_objects` field. Setting this to `true` is helpful
+    # when the objects are needed for immediate display to a user. This process
+    # only goes one level deep. Objects referenced by the related objects will
+    # not be included. For example,  if the `objects` field of the response
+    # contains a CatalogItem, its associated CatalogCategory objects, CatalogTax
+    # objects, CatalogImage objects and CatalogModifierLists will be returned in
+    # the `related_objects` field of the response. If the `objects` field of the
+    # response contains a CatalogItemVariation, its parent CatalogItem will be
+    # returned in the `related_objects` field of the response.  Default value:
+    # `false`
     # @param [Long] catalog_version Optional parameter: Requests objects as of a
     # specific version of the catalog. This allows you to retrieve historical
     # versions of objects. The value to retrieve a specific version of an object
-    # can be found in the version field of
-    # [CatalogObject](#type-catalogobject)s.
+    # can be found in the version field of [CatalogObject]($m/CatalogObject)s.
+    # If not included, results will be from the current version of the
+    # catalog.
     # @return [RetrieveCatalogObjectResponse Hash] response from the API call
     def retrieve_catalog_object(object_id:,
                                 include_related_objects: false,
@@ -433,12 +507,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.
+    # or more of the specified query filters.
     # 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.
@@ -463,7 +537,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -486,9 +560,9 @@ module Square
     # Searches for catalog items or item variations by matching supported search
     # attribute values, including
     # custom attribute values, against one or more of the specified query
-    # expressions.
+    # filters.
     # 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.
@@ -513,7 +587,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -533,8 +607,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
@@ -549,7 +623,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -569,8 +643,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
@@ -585,7 +659,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.

data/lib/square/api/checkout_api.rb

@@ -5,8 +5,8 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Links a `checkoutId` to a `checkout_page_url` that customers will
-    # be directed to in order to provide their payment information using a
+    # Links a `checkoutId` to a `checkout_page_url` that customers are
+    # directed to in order to provide their payment information using a
     # payment processing workflow hosted on connect.squareup.com.
     # @param [String] location_id Required parameter: The ID of the business
     # location to associate the checkout with.
@@ -28,7 +28,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.

data/lib/square/api/customer_groups_api.rb

@@ -7,18 +7,27 @@ 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/build-basics/common-api-p
+    # atterns/pagination).
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return in a single page. This limit is advisory. The response might
+    # contain more or fewer results. If the limit is less than 1 or greater than
+    # 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error.
+    # The default value is 50.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @return [ListCustomerGroupsResponse Hash] response from the API call
-    def list_customer_groups(cursor: nil)
+    def list_customer_groups(cursor: nil,
+                             limit: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/customers/groups'
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
-        'cursor' => cursor
+        'cursor' => cursor,
+        'limit' => limit
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -58,7 +67,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -169,7 +178,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.

data/lib/square/api/customer_segments_api.rb

@@ -7,18 +7,27 @@ 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/build-basics/common-api-p
+    # atterns/pagination).
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return in a single page. This limit is advisory. The response might
+    # contain more or fewer results. If the specified limit is less than 1 or
+    # greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400
+    # VALUE_TOO_HIGH` error. The default value is 50.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @return [ListCustomerSegmentsResponse Hash] response from the API call
-    def list_customer_segments(cursor: nil)
+    def list_customer_segments(cursor: nil,
+                               limit: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/customers/segments'
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
-        'cursor' => cursor
+        'cursor' => cursor,
+        'limit' => limit
       )
       _query_url = APIHelper.clean_url _query_builder