square.rb 5.1.0.20200325 → 6.0.0.20200625

data/lib/square.rb

@@ -40,6 +40,9 @@ require_relative 'square/api/bank_accounts_api.rb'
 require_relative 'square/api/cash_drawers_api.rb'
 require_relative 'square/api/catalog_api.rb'
 require_relative 'square/api/customers_api.rb'
+require_relative 'square/api/customer_groups_api.rb'
+require_relative 'square/api/customer_segments_api.rb'
+require_relative 'square/api/devices_api.rb'
 require_relative 'square/api/disputes_api.rb'
 require_relative 'square/api/employees_api.rb'
 require_relative 'square/api/inventory_api.rb'
@@ -49,6 +52,9 @@ require_relative 'square/api/reporting_api.rb'
 require_relative 'square/api/checkout_api.rb'
 require_relative 'square/api/orders_api.rb'
 require_relative 'square/api/transactions_api.rb'
+require_relative 'square/api/loyalty_api.rb'
 require_relative 'square/api/merchants_api.rb'
 require_relative 'square/api/payments_api.rb'
 require_relative 'square/api/refunds_api.rb'
+require_relative 'square/api/team_api.rb'
+require_relative 'square/api/terminal_api.rb'

data/lib/square/api/base_api.rb

@@ -8,8 +8,8 @@ module Square
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'Square-Ruby-SDK/5.1.0.20200325',
-        'Square-Version' => '2020-03-25'
+        'user-agent' => 'Square-Ruby-SDK/6.0.0.20200625',
+        'Square-Version' => '2020-06-25'
       }
     end
 

data/lib/square/api/catalog_api.rb

@@ -139,34 +139,7 @@ module Square
     # [CatalogObject](#type-catalogobject) at a later time.
     # CreateCatalogImage 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. The
-    # following is an example of such an HTTP request:
-    # ```
-    # POST /v2/catalog/images
-    # Accept: application/json
-    # Content-Type: multipart/form-data;boundary="boundary"
-    # Square-Version: XXXX-XX-XX
-    # Authorization: Bearer {ACCESS_TOKEN}
-    # --boundary
-    # Content-Disposition: form-data; name="request"
-    # Content-Type: application/json
-    # {
-    # "idempotency_key":"528dea59-7bfb-43c1-bd48-4a6bba7dd61f86",
-    # "object_id": "ND6EA5AAJEO5WL3JNNIAQA32",
-    # "image":{
-    # "id":"#TEMP_ID",
-    # "type":"IMAGE",
-    # "image_data":{
-    # "caption":"A picture of a cup of coffee"
-    # }
-    # }
-    # }
-    # --boundary
-    # Content-Disposition: form-data; name="image"; filename="Coffee.jpg"
-    # Content-Type: image/jpeg
-    # {ACTUAL_IMAGE_BYTES}
-    # --boundary
-    # ```
+    # 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
@@ -400,7 +373,7 @@ module Square
     # `false`
     # @return [RetrieveCatalogObjectResponse Hash] response from the API call
     def retrieve_catalog_object(object_id:,
-                                include_related_objects: nil)
+                                include_related_objects: false)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/catalog/object/{object_id}'
@@ -433,22 +406,20 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
-    # Queries the targeted catalog using a variety of query types:
-    # [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute),
-    # [CatalogQueryExact](#type-catalogqueryexact),
-    # [CatalogQueryRange](#type-catalogqueryrange),
-    # [CatalogQueryText](#type-catalogquerytext),
-    # [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and
-    # [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist)
-    # .
-    # --
-    # --
-    # Future end of the above comment:
-    # [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax),
+    # Queries the targeted catalog using a variety of query expressions.
+    # Supported query expressions are of the following types:
+    # - [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute),
+    # - [CatalogQueryExact](#type-catalogqueryexact),
+    # - [CatalogQueryRange](#type-catalogqueryrange),
+    # - [CatalogQueryText](#type-catalogquerytext),
+    # - [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax),
+    # -
     # [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist)
     # ,
+    # -
     # [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions),
     # and
+    # -
     # [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvari
     # ationsforitemoptionvalues).
     # @param [SearchCatalogObjectsRequest] body Required parameter: An object

data/lib/square/api/customer_groups_api.rb

@@ -0,0 +1,182 @@
+module Square
+  # CustomerGroupsApi
+  class CustomerGroupsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # 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.
+    # @return [ListCustomerGroupsResponse Hash] response from the API call
+    def list_customer_groups(cursor: 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
+      )
+      _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 new customer group for a business.
+    # The request must include the `name` value of the group.
+    # @param [CreateCustomerGroupRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CreateCustomerGroupResponse Hash] response from the API call
+    def create_customer_group(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/groups'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # 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
+
+    # Deletes a customer group as identified by the `group_id` value.
+    # @param [String] group_id Required parameter: The ID of the customer group
+    # to delete.
+    # @return [DeleteCustomerGroupResponse Hash] response from the API call
+    def delete_customer_group(group_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/groups/{group_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'group_id' => group_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _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
+
+    # Retrieves a specific customer group as identified by the `group_id` value.
+    # @param [String] group_id Required parameter: The ID of the customer group
+    # to retrieve.
+    # @return [RetrieveCustomerGroupResponse Hash] response from the API call
+    def retrieve_customer_group(group_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/groups/{group_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'group_id' => group_id
+      )
+      _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
+
+    # Updates a customer group as identified by the `group_id` value.
+    # @param [String] group_id Required parameter: The ID of the customer group
+    # to update.
+    # @param [UpdateCustomerGroupRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [UpdateCustomerGroupResponse Hash] response from the API call
+    def update_customer_group(group_id:,
+                              body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/groups/{group_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'group_id' => group_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.put(
+        _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
+  end
+end

data/lib/square/api/customer_segments_api.rb

@@ -0,0 +1,78 @@
+module Square
+  # CustomerSegmentsApi
+  class CustomerSegmentsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # 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/docs/working-with-apis/paginati
+    # on) for more information.
+    # @return [ListCustomerSegmentsResponse Hash] response from the API call
+    def list_customer_segments(cursor: 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
+      )
+      _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
+
+    # Retrieves a specific customer segment as identified by the `segment_id`
+    # value.
+    # @param [String] segment_id Required parameter: The Square-issued ID of the
+    # customer segment.
+    # @return [RetrieveCustomerSegmentResponse Hash] response from the API call
+    def retrieve_customer_segment(segment_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/segments/{segment_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'segment_id' => segment_id
+      )
+      _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
+  end
+end

data/lib/square/api/customers_api.rb

@@ -5,7 +5,13 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Lists a business's customers.
+    # Lists customer profiles associated with a Square account.
+    # Under normal operating conditions, newly created or updated customer
+    # profiles become available
+    # for the listing operation in well under 30 seconds. Occasionally,
+    # propagation of the new or updated
+    # profiles can take closer to one minute or longer, espeically during
+    # network incidents and outages.
     # @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
@@ -91,10 +97,17 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
-    # Searches the customer profiles associated with a Square account.
-    # Calling SearchCustomers without an explicit query parameter returns all
+    # Searches the customer profiles associated with a Square account using
+    # one or more supported query filters.
+    # Calling `SearchCustomers` without any explicit query filter returns all
     # customer profiles ordered alphabetically based on `given_name` and
     # `family_name`.
+    # Under normal operating conditions, newly created or updated customer
+    # profiles become available
+    # for the search operation in well under 30 seconds. Occasionally,
+    # propagation of the new or updated
+    # profiles can take closer to one minute or longer, espeically during
+    # network incidents and outages.
     # @param [SearchCustomersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -323,5 +336,83 @@ module Square
       _errors = APIHelper.map_response(decoded, ['errors'])
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
+
+    # Removes a group membership from a customer.
+    # The customer is identified by the `customer_id` value
+    # and the customer group is identified by the `group_id` value.
+    # @param [String] customer_id Required parameter: The ID of the customer to
+    # remove from the group.
+    # @param [String] group_id Required parameter: The ID of the customer group
+    # to remove the customer from.
+    # @return [RemoveGroupFromCustomerResponse Hash] response from the API call
+    def remove_group_from_customer(customer_id:,
+                                   group_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/{customer_id}/groups/{group_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'customer_id' => customer_id,
+        'group_id' => group_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _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 group membership to a customer.
+    # The customer is identified by the `customer_id` value
+    # and the customer group is identified by the `group_id` value.
+    # @param [String] customer_id Required parameter: The ID of the customer to
+    # add to a group.
+    # @param [String] group_id Required parameter: The ID of the customer group
+    # to add the customer to.
+    # @return [AddGroupToCustomerResponse Hash] response from the API call
+    def add_group_to_customer(customer_id:,
+                              group_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/{customer_id}/groups/{group_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'customer_id' => customer_id,
+        'group_id' => group_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.put(
+        _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