square.rb 6.3.0.20200826 → 17.1.0.20220120

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.
@@ -44,17 +44,17 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     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.
@@ -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.
@@ -83,7 +83,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Creates or updates up to 10,000 target objects based on the provided
@@ -113,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.
@@ -128,21 +130,19 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
-    # Uploads an image file to be represented by an
-    # [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.
+    # Uploads an image file to be represented by a
+    # [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.
-    # Additional information and an example cURL request can be found in the
-    # [Create a Catalog Image
-    # recipe](https://developer.squareup.com/docs/more-apis/catalog/cookbook/cre
-    # ate-catalog-images).
     # @param [CreateCatalogImageRequest] request Optional parameter: Example:
     # @param [File | UploadIO] image_file Optional parameter: Example:
     # @return [CreateCatalogImageResponse Hash] response from the API call
@@ -191,7 +191,74 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    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
@@ -219,42 +286,57 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     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 and set
-    # `include_deleted_objects`
-    # to `true`.
+    # deleted catalog items, use
+    # [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]($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)
+                     types: nil,
+                     catalog_version: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/catalog/list'
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
         'cursor' => cursor,
-        'types' => types
+        'types' => types,
+        'catalog_version' => catalog_version
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -274,10 +356,12 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     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.
@@ -291,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.
@@ -306,17 +390,19 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     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
@@ -328,7 +414,7 @@ module Square
       _query_builder << '/v2/catalog/object/{object_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'object_id' => object_id
+        'object_id' => { 'value' => object_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -348,41 +434,55 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     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
-    # objects, CatalogImages and CatalogModifierLists will be returned in the
-    # `related_objects` field of the response. If the `object` field of the
+    # 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)
+                                include_related_objects: false,
+                                catalog_version: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/catalog/object/{object_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'object_id' => object_id
+        'object_id' => { 'value' => object_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
-        'include_related_objects' => include_related_objects
+        'include_related_objects' => include_related_objects,
+        'catalog_version' => catalog_version
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -402,15 +502,17 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
-    # Searches for [CatalogObject](#type-CatalogObject) of any types against
+    # 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.
@@ -435,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.
@@ -450,15 +552,17 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # 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.
@@ -483,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.
@@ -498,11 +602,13 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     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
@@ -517,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.
@@ -532,11 +638,13 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     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
@@ -551,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.
@@ -566,7 +674,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end

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.
@@ -21,14 +21,14 @@ module Square
       _query_builder << '/v2/locations/{location_id}/checkouts'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -43,7 +43,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end