square.rb 15.0.0.20211020 → 17.1.0.20220120

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25322287d3387bc053e23f58c5a3b74476789df2145f9648f46b330517aa7574
-  data.tar.gz: a5476f517732ce5df169b402fded9909cefa155e02c90d9af5996e4dc087a887
+  metadata.gz: 407147246777f8a4eda2d4848cad5edb62be5801c25b6361f0dfb21d58663fd9
+  data.tar.gz: 735c7e92297b1d4a79ebd856dbe39cc304051536622f0277ddd9489811652cb6
 SHA512:
-  metadata.gz: 2d30c67ff2493a1dded81c4078d3549c0c195f092f9826735cd1f98bb6749153bd45d6614419f95f6d6fb32ed505459abc11ab0508b3fa51f0ad089f8a0cce51
-  data.tar.gz: 2b4a9e0bdb771a3658ec3a46b9838421c154ff1b280da9d27e589111dbb010c2d3c5672ae38d5b22e52ae26f864ae6d8cd76e53effc65e65fdefafcf0b949aa4
+  metadata.gz: 90ccb1516f8ff8998787d63a168c8c8688b9a12691d85cac3a2b6af35ce52af93bbc013e11336d5319cc252ec75ce7f790165ea5c38c69367f092e5ef62b365d
+  data.tar.gz: 05a3eb69caf678ad7f071b66a27c3ed4375ac96470ba09e51df9db6eba1401b80bd461c7fd6cb7bde91f30bb7ee5d11b9f7f293a59d40c70ab5ed52b25b9d180

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2021 Square, Inc.
+Copyright 2022 Square, Inc.
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

data/README.md

@@ -10,7 +10,7 @@ Use this gem to integrate Square payments into your app and grow your business w
 
 ## Requirements
 
-We support Ruby 2.5.x, 2.6.x, and 2.7.x.
+We support Ruby 2.5.x, 2.6.x, 2.7.x, and 3.0.x.
 
 ## Installation
 
@@ -349,4 +349,4 @@ You can also use the Square API to create applications or services that work wit
 [Snippets]: doc/api/snippets.md
 [Cards]: doc/api/cards.md
 [Gift Cards]: doc/api/gift-cards.md
-[Gift Card Activities]: doc/api/gift-card-activities.md
+[Gift Card Activities]: doc/api/gift-card-activities.md

data/lib/square/api/apple_pay_api.rb

@@ -30,7 +30,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/base_api.rb

@@ -1,3 +1,4 @@
+require 'erb'
 module Square
   # BaseApi.
   class BaseApi
@@ -8,7 +9,7 @@ module Square
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'Square-Ruby-SDK/15.0.0.20211020',
+        'user-agent' => get_user_agent,
         'Square-Version' => config.square_version
       }
     end
@@ -35,5 +36,19 @@ module Square
 
       response
     end
+
+    def get_user_agent
+      user_agent = 'Square-Ruby-SDK/17.1.0.20220120 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      user_agent['{engine}'] = RUBY_ENGINE
+      user_agent['{engine-version}'] = RUBY_ENGINE_VERSION
+      user_agent['{os-info}'] = RUBY_PLATFORM
+      user_agent['{api-version}'] = config.square_version
+      if config.user_agent_detail.nil? || config.user_agent_detail.empty?
+        user_agent = user_agent.gsub('{detail}', '')
+      else
+        user_agent['{detail}'] = ERB::Util.url_encode(config.user_agent_detail.to_s)
+      end
+      user_agent
+    end
   end
 end

data/lib/square/api/bookings_api.rb

@@ -5,7 +5,75 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
+    # Retrieve a collection of bookings.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_READ` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # per page to return in a paged response.
+    # @param [String] cursor Optional parameter: The pagination cursor from the
+    # preceding response to return the next page of the results. Do not set this
+    # when retrieving the first page of the results.
+    # @param [String] team_member_id Optional parameter: The team member for
+    # whom to retrieve bookings. If this is not set, bookings of all members are
+    # retrieved.
+    # @param [String] location_id Optional parameter: The location for which to
+    # retrieve bookings. If this is not set, all locations' bookings are
+    # retrieved.
+    # @param [String] start_at_min Optional parameter: The RFC 3339 timestamp
+    # specifying the earliest of the start time. If this is not set, the current
+    # time is used.
+    # @param [String] start_at_max Optional parameter: The RFC 3339 timestamp
+    # specifying the latest of the start time. If this is not set, the time of
+    # 31 days after `start_at_min` is used.
+    # @return [ListBookingsResponse Hash] response from the API call
+    def list_bookings(limit: nil,
+                      cursor: nil,
+                      team_member_id: nil,
+                      location_id: nil,
+                      start_at_min: nil,
+                      start_at_max: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'limit' => limit,
+        'cursor' => cursor,
+        'team_member_id' => team_member_id,
+        'location_id' => location_id,
+        'start_at_min' => start_at_min,
+        'start_at_max' => start_at_max
+      )
+      _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
+
     # Creates a booking.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_WRITE` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
     # @param [CreateBookingRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -19,7 +87,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -40,6 +108,10 @@ module Square
     end
 
     # Searches for availabilities for booking.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_READ` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
     # @param [SearchAvailabilityRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -53,7 +125,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -107,9 +179,10 @@ module Square
     # include only bookable team members in the returned result (`true`) or not
     # (`false`).
     # @param [Integer] limit Optional parameter: The maximum number of results
-    # to return.
-    # @param [String] cursor Optional parameter: The cursor for paginating
-    # through the results.
+    # to return in a paged response.
+    # @param [String] cursor Optional parameter: The pagination cursor from the
+    # preceding response to return the next page of the results. Do not set this
+    # when retrieving the first page of the results.
     # @param [String] location_id Optional parameter: Indicates whether to
     # include only team members enabled at the given location in the returned
     # result.
@@ -187,6 +260,10 @@ module Square
     end
 
     # Retrieves a booking.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_READ` for the OAuth scope.
+    # 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.
     # @return [RetrieveBookingResponse Hash] response from the API call
@@ -222,6 +299,10 @@ module Square
     end
 
     # Updates a booking.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_WRITE` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
     # @param [String] booking_id Required parameter: The ID of the
     # [Booking]($m/Booking) object representing the to-be-updated booking.
     # @param [UpdateBookingRequest] body Required parameter: An object
@@ -242,7 +323,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -263,6 +344,10 @@ module Square
     end
 
     # Cancels an existing booking.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_WRITE` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
     # @param [String] booking_id Required parameter: The ID of the
     # [Booking]($m/Booking) object representing the to-be-cancelled booking.
     # @param [CancelBookingRequest] body Required parameter: An object
@@ -283,7 +368,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/cards_api.rb

@@ -76,7 +76,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/catalog_api.rb

@@ -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.
@@ -68,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.
@@ -115,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.
@@ -136,10 +136,10 @@ module Square
     end
 
     # Uploads an image file to be represented by a
-    # [CatalogImage]($m/CatalogImage) object linked to an existing
-    # [CatalogObject]($m/CatalogObject) instance. A call to this endpoint can
-    # upload an image, link an image to
-    # a catalog object, or do both.
+    # [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.
@@ -196,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
@@ -226,15 +291,12 @@ module Square
       )
     end
 
-    # Returns a list of [CatalogObject]($m/CatalogObject)s that includes
-    # all objects of a set of desired types (for example, all
-    # [CatalogItem]($m/CatalogItem)
-    # and [CatalogTax]($m/CatalogTax) objects) in the catalog. The `types`
-    # parameter
-    # is specified as a comma-separated list of valid
-    # [CatalogObject]($m/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
@@ -247,16 +309,22 @@ module Square
     # 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, including
-    # `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`,
-    # `MODIFIER_LIST`, or `IMAGE`.  If this is unspecified, the operation
-    # returns objects of all the types at the version of the Square API used to
-    # make the request.
+    # 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]($m/CatalogObject)s' `version`
-    # attribute.
+    # 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,
@@ -307,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.
@@ -382,17 +450,24 @@ module Square
     # 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]($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,
@@ -462,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.
@@ -512,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.
@@ -548,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.
@@ -584,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

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

@@ -66,7 +66,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -177,7 +177,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/customers_api.rb

@@ -88,7 +88,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -132,7 +132,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -274,7 +274,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -320,7 +320,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/devices_api.rb

@@ -74,7 +74,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/disputes_api.rb

@@ -259,7 +259,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/gift_card_activities_api.rb

@@ -13,29 +13,35 @@ module Square
     # for a gift card,
     # for all gift cards in a specific region, or for activities within a time
     # window.
-    # @param [String] gift_card_id Optional parameter: If you provide a gift
-    # card ID, the endpoint returns activities that belong  to the specified
-    # gift card. Otherwise, the endpoint returns all gift card activities for 
-    # the seller.
-    # @param [String] type Optional parameter: If you provide a type, the
-    # endpoint returns gift card activities of this type.  Otherwise, the
-    # endpoint returns all types of gift card activities.
-    # @param [String] location_id Optional parameter: If you provide a location
-    # ID, the endpoint returns gift card activities for that location. 
-    # Otherwise, the endpoint returns gift card activities for all locations.
+    # @param [String] gift_card_id Optional parameter: If a gift card ID is
+    # provided, the endpoint returns activities related  to the specified gift
+    # 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
+    # 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
+    # provided, the endpoint returns gift card activities for the specified
+    # location.  Otherwise, the endpoint returns gift card activities for all
+    # locations.
     # @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.
+    # beginning of the reporting period, in RFC 3339 format. This start time is
+    # inclusive. The default value is 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. Inclusive. Default: The current
-    # time.
-    # @param [Integer] limit Optional parameter: If you provide a limit value,
-    # the endpoint returns the specified number  of results (or less) per page.
-    # A maximum value is 100. The default value is 50.
+    # the reporting period, in RFC 3339 format. This end time is inclusive. The
+    # default value is the current time.
+    # @param [Integer] limit Optional parameter: If a limit is provided, the
+    # endpoint returns the specified number  of results (or fewer) per page. The
+    # maximum value is 100. The default value is 50. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
     # @param [String] cursor Optional parameter: A pagination cursor returned by
     # a previous call to this endpoint. Provide this cursor to retrieve the next
-    # set of results for the original query. If you do not provide the cursor,
-    # the call returns the first page of the results.
+    # set of results for the original query. If a cursor is not provided, the
+    # endpoint returns the first page of the results. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
     # @param [String] sort_order Optional parameter: The order in which the
     # endpoint returns the activities, based on `created_at`. - `ASC` - Oldest
     # to newest. - `DESC` - Newest to oldest (default).
@@ -104,7 +110,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.