square.rb 5.0.0.20200226 → 5.3.0.20200528

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4db64adc1deef73ef00086f17ac38e54e342472456ebc04cee8b64e691c5ea3a
-  data.tar.gz: bd4ee35fcc7bc37b6a37d7f071b6e9bce6091088879bbf1c9a4b3b6d67de3553
+  metadata.gz: 4df584cf8656280c84a929e33d017ae45261bb30afdfed941a8e7c775995ea45
+  data.tar.gz: c87a6cbd1d57921bc3b3251135ebdc40d02dd007d16a59bab366e6f10123b8eb
 SHA512:
-  metadata.gz: 9bc48e30881676a19e52933b16fd57d02bb990fcafd282969f010412d31b8296c2511288cb478cb545f418959e8206847d31d53127fc6311f14ebc731ad0a3a9
-  data.tar.gz: 2f6af98a925f9304a1e7c833c3a637bea22329099cba3cf09656cd92bada279c7f8cf3f0d14c08faba2026f6ef777a5dbb1a119477107f6d7b7f403b795f2635
+  metadata.gz: c5acce30bed99da12a50425ee308932eeab669e3791a5f849224f49a2ffa3dc91bcdbff296a011f21d2c03d31104a6bfbf5d5f11da93658c44d270db9e21b85a
+  data.tar.gz: 063afe2bce7b09d25bfe6941c63de99d03ededbea209f67cba6e89096f573650c099e76486d69a39466c639a58b20afccbc330a3ef5231eeeeafa9892bcdcb03

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2019 Square, Inc.
+Copyright 2020 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/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,8 @@ 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/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.0.0.20200226',
-        'Square-Version' => '2020-02-26'
+        'user-agent' => 'Square-Ruby-SDK/5.3.0.20200528',
+        'Square-Version' => '2020-05-28'
       }
     end
 

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

data/lib/square/api/devices_api.rb

@@ -0,0 +1,120 @@
+module Square
+  # DevicesApi
+  class DevicesApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Lists all DeviceCodes associated with the merchant.
+    # @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 [Paginating
+    # results](#paginatingresults) for more information.
+    # @param [String] location_id Optional parameter: If specified, only returns
+    # DeviceCodes of the specified location. Returns DeviceCodes of all
+    # locations if empty.
+    # @param [ProductType] product_type Optional parameter: If specified, only
+    # returns DeviceCodes targeting the specified product type. Returns
+    # DeviceCodes of all product types if empty.
+    # @return [ListDeviceCodesResponse Hash] response from the API call
+    def list_device_codes(cursor: nil,
+                          location_id: nil,
+                          product_type: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/devices/codes'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'cursor' => cursor,
+        'location_id' => location_id,
+        'product_type' => product_type
+      )
+      _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 DeviceCode that can be used to login to a Square Terminal device
+    # to enter the connected
+    # terminal mode.
+    # @param [CreateDeviceCodeRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CreateDeviceCodeResponse Hash] response from the API call
+    def create_device_code(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/devices/codes'
+      _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
+
+    # Retrieves DeviceCode with the associated ID.
+    # @param [String] id Required parameter: The unique identifier for the
+    # device code.
+    # @return [GetDeviceCodeResponse Hash] response from the API call
+    def get_device_code(id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/devices/codes/{id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'id' => 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