square.rb 12.0.0.20210616 → 14.1.0.20210915

data/lib/square/api/labor_api.rb

@@ -6,13 +6,14 @@ module Square
     end
 
     # Returns a paginated list of `BreakType` instances for a business.
-    # @param [String] location_id Optional parameter: Filter Break Types
-    # returned to only those that are associated with the specified location.
-    # @param [Integer] limit Optional parameter: Maximum number of Break Types
-    # to return per page. Can range between 1 and 200. The default is the
-    # maximum at 200.
-    # @param [String] cursor Optional parameter: Pointer to the next page of
-    # Break Type results to fetch.
+    # @param [String] location_id Optional parameter: Filter the returned
+    # `BreakType` results to only those that are associated with the specified
+    # location.
+    # @param [Integer] limit Optional parameter: The maximum number of
+    # `BreakType` results to return per page. The number can range between 1 and
+    # 200. The default is 200.
+    # @param [String] cursor Optional parameter: A pointer to the next page of
+    # `BreakType` results to fetch.
     # @return [ListBreakTypesResponse Hash] response from the API call
     def list_break_types(location_id: nil,
                          limit: nil,
@@ -57,8 +58,8 @@ module Square
     # - `break_name`
     # - `expected_duration`
     # - `is_paid`
-    # You can only have 3 `BreakType` instances per location. If you attempt to
-    # add a 4th
+    # You can only have three `BreakType` instances per location. If you attempt
+    # to add a fourth
     # `BreakType` for a location, an `INVALID_REQUEST_ERROR` "Exceeded limit of
     # 3 breaks per location."
     # is returned.
@@ -97,7 +98,7 @@ module Square
 
     # Deletes an existing `BreakType`.
     # A `BreakType` can be deleted even if it is referenced from a `Shift`.
-    # @param [String] id Required parameter: UUID for the `BreakType` being
+    # @param [String] id Required parameter: The UUID for the `BreakType` being
     # deleted.
     # @return [DeleteBreakTypeResponse Hash] response from the API call
     def delete_break_type(id:)
@@ -131,8 +132,8 @@ module Square
       )
     end
 
-    # Returns a single `BreakType` specified by id.
-    # @param [String] id Required parameter: UUID for the `BreakType` being
+    # Returns a single `BreakType` specified by `id`.
+    # @param [String] id Required parameter: The UUID for the `BreakType` being
     # retrieved.
     # @return [GetBreakTypeResponse Hash] response from the API call
     def get_break_type(id:)
@@ -167,7 +168,7 @@ module Square
     end
 
     # Updates an existing `BreakType`.
-    # @param [String] id Required parameter: UUID for the `BreakType` being
+    # @param [String] id Required parameter: The UUID for the `BreakType` being
     # updated.
     # @param [UpdateBreakTypeRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -208,13 +209,13 @@ module Square
     end
 
     # Returns a paginated list of `EmployeeWage` instances for a business.
-    # @param [String] employee_id Optional parameter: Filter wages returned to
-    # only those that are associated with the specified employee.
-    # @param [Integer] limit Optional parameter: Maximum number of Employee
-    # Wages to return per page. Can range between 1 and 200. The default is the
-    # maximum at 200.
-    # @param [String] cursor Optional parameter: Pointer to the next page of
-    # Employee Wage results to fetch.
+    # @param [String] employee_id Optional parameter: Filter the returned wages
+    # to only those that are associated with the specified employee.
+    # @param [Integer] limit Optional parameter: The maximum number of
+    # `EmployeeWage` results to return per page. The number can range between 1
+    # and 200. The default is 200.
+    # @param [String] cursor Optional parameter: A pointer to the next page of
+    # `EmployeeWage` results to fetch.
     # @return [ListEmployeeWagesResponse Hash] response from the API call
     def list_employee_wages(employee_id: nil,
                             limit: nil,
@@ -252,9 +253,9 @@ module Square
       )
     end
 
-    # Returns a single `EmployeeWage` specified by id.
-    # @param [String] id Required parameter: UUID for the `EmployeeWage` being
-    # retrieved.
+    # Returns a single `EmployeeWage` specified by `id`.
+    # @param [String] id Required parameter: The UUID for the `EmployeeWage`
+    # being retrieved.
     # @return [GetEmployeeWageResponse Hash] response from the API call
     def get_employee_wage(id:)
       warn 'Endpoint get_employee_wage in LaborApi is deprecated'
@@ -289,7 +290,7 @@ module Square
     end
 
     # Creates a new `Shift`.
-    # A `Shift` represents a complete work day for a single employee.
+    # A `Shift` represents a complete workday for a single employee.
     # You must provide the following values in your request to this
     # endpoint:
     # - `location_id`
@@ -299,12 +300,12 @@ module Square
     # when:
     # - The `status` of the new `Shift` is `OPEN` and the employee has another
     # shift with an `OPEN` status.
-    # - The `start_at` date is in the future
-    # - the `start_at` or `end_at` overlaps another shift for the same employee
-    # - If `Break`s are set in the request, a break `start_at`
-    # must not be before the `Shift.start_at`. A break `end_at` must not be
-    # after
-    # the `Shift.end_at`
+    # - The `start_at` date is in the future.
+    # - The `start_at` or `end_at` date overlaps another shift for the same
+    # employee.
+    # - The `Break` instances are set in the request and a break `start_at`
+    # is before the `Shift.start_at`, a break `end_at` is after
+    # the `Shift.end_at`, or both.
     # @param [CreateShiftRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -340,17 +341,17 @@ module Square
 
     # Returns a paginated list of `Shift` records for a business.
     # The list to be returned can be filtered by:
-    # - Location IDs **and**
-    # - employee IDs **and**
-    # - shift status (`OPEN`, `CLOSED`) **and**
-    # - shift start **and**
-    # - shift end **and**
-    # - work day details
+    # - Location IDs.
+    # - Employee IDs.
+    # - Shift status (`OPEN` and `CLOSED`).
+    # - Shift start.
+    # - Shift end.
+    # - Workday details.
     # The list can be sorted by:
-    # - `start_at`
-    # - `end_at`
-    # - `created_at`
-    # - `updated_at`
+    # - `start_at`.
+    # - `end_at`.
+    # - `created_at`.
+    # - `updated_at`.
     # @param [SearchShiftsRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -385,7 +386,7 @@ module Square
     end
 
     # Deletes a `Shift`.
-    # @param [String] id Required parameter: UUID for the `Shift` being
+    # @param [String] id Required parameter: The UUID for the `Shift` being
     # deleted.
     # @return [DeleteShiftResponse Hash] response from the API call
     def delete_shift(id:)
@@ -419,8 +420,8 @@ module Square
       )
     end
 
-    # Returns a single `Shift` specified by id.
-    # @param [String] id Required parameter: UUID for the `Shift` being
+    # Returns a single `Shift` specified by `id`.
+    # @param [String] id Required parameter: The UUID for the `Shift` being
     # retrieved.
     # @return [GetShiftResponse Hash] response from the API call
     def get_shift(id:)
@@ -455,13 +456,14 @@ module Square
     end
 
     # Updates an existing `Shift`.
-    # When adding a `Break` to a `Shift`, any earlier `Breaks` in the `Shift`
-    # have
+    # When adding a `Break` to a `Shift`, any earlier `Break` instances in the
+    # `Shift` have
     # the `end_at` property set to a valid RFC-3339 datetime string.
-    # When closing a `Shift`, all `Break` instances in the shift must be
+    # When closing a `Shift`, all `Break` instances in the `Shift` must be
     # complete with `end_at`
     # set on each `Break`.
-    # @param [String] id Required parameter: ID of the object being updated.
+    # @param [String] id Required parameter: The ID of the object being
+    # updated.
     # @param [UpdateShiftRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -501,13 +503,13 @@ module Square
     end
 
     # Returns a paginated list of `TeamMemberWage` instances for a business.
-    # @param [String] team_member_id Optional parameter: Filter wages returned
-    # to only those that are associated with the specified team member.
-    # @param [Integer] limit Optional parameter: Maximum number of Team Member
-    # Wages to return per page. Can range between 1 and 200. The default is the
-    # maximum at 200.
-    # @param [String] cursor Optional parameter: Pointer to the next page of
-    # Employee Wage results to fetch.
+    # @param [String] team_member_id Optional parameter: Filter the returned
+    # wages to only those that are associated with the specified team member.
+    # @param [Integer] limit Optional parameter: The maximum number of
+    # `TeamMemberWage` results to return per page. The number can range between
+    # 1 and 200. The default is 200.
+    # @param [String] cursor Optional parameter: A pointer to the next page of
+    # `EmployeeWage` results to fetch.
     # @return [ListTeamMemberWagesResponse Hash] response from the API call
     def list_team_member_wages(team_member_id: nil,
                                limit: nil,
@@ -544,9 +546,9 @@ module Square
       )
     end
 
-    # Returns a single `TeamMemberWage` specified by id.
-    # @param [String] id Required parameter: UUID for the `TeamMemberWage` being
-    # retrieved.
+    # Returns a single `TeamMemberWage` specified by `id `.
+    # @param [String] id Required parameter: The UUID for the `TeamMemberWage`
+    # being retrieved.
     # @return [GetTeamMemberWageResponse Hash] response from the API call
     def get_team_member_wage(id:)
       # Prepare query url.
@@ -580,10 +582,10 @@ module Square
     end
 
     # Returns a list of `WorkweekConfig` instances for a business.
-    # @param [Integer] limit Optional parameter: Maximum number of Workweek
-    # Configs to return per page.
-    # @param [String] cursor Optional parameter: Pointer to the next page of
-    # Workweek Config results to fetch.
+    # @param [Integer] limit Optional parameter: The maximum number of
+    # `WorkweekConfigs` results to return per page.
+    # @param [String] cursor Optional parameter: A pointer to the next page of
+    # `WorkweekConfig` results to fetch.
     # @return [ListWorkweekConfigsResponse Hash] response from the API call
     def list_workweek_configs(limit: nil,
                               cursor: nil)
@@ -619,7 +621,7 @@ module Square
     end
 
     # Updates a `WorkweekConfig`.
-    # @param [String] id Required parameter: UUID for the `WorkweekConfig`
+    # @param [String] id Required parameter: The UUID for the `WorkweekConfig`
     # object being updated.
     # @param [UpdateWorkweekConfigRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding

data/lib/square/api/loyalty_api.rb

@@ -120,12 +120,16 @@ module Square
     # account.
     # - If you are not using the Orders API to manage orders,
     # you first perform a client-side computation to compute the points.
-    # For spend-based and visit-based programs, you can call
+    # For spend-based and visit-based programs, you can first call
     # [CalculateLoyaltyPoints]($e/Loyalty/CalculateLoyaltyPoints) to compute the
-    # points. For more information,
-    # see [Loyalty Program
-    # Overview](https://developer.squareup.com/docs/loyalty/overview).
-    # You then provide the points in a request to this endpoint.
+    # points
+    # that you provide to this endpoint.
+    # __Note:__ The country of the seller's Square account determines whether
+    # tax is included in the purchase amount when accruing points for
+    # spend-based and visit-based programs.
+    # For more information, see [Availability of Square
+    # Loyalty](https://developer.squareup.com/docs/loyalty-api/overview#loyalty-
+    # market-availability).
     # @param [String] account_id Required parameter: The [loyalty
     # account]($m/LoyaltyAccount) ID to which to add the points.
     # @param [AccumulateLoyaltyPointsRequest] body Required parameter: An object
@@ -341,6 +345,12 @@ module Square
     # An application might call this endpoint to show the points that a buyer
     # can earn with the
     # specific purchase.
+    # __Note:__ The country of the seller's Square account determines whether
+    # tax is included in the purchase amount when accruing points for
+    # spend-based and visit-based programs.
+    # For more information, see [Availability of Square
+    # Loyalty](https://developer.squareup.com/docs/loyalty-api/overview#loyalty-
+    # market-availability).
     # @param [String] program_id Required parameter: The [loyalty
     # program]($m/LoyaltyProgram) ID, which defines the rules for accruing
     # points.

data/lib/square/api/o_auth_api.rb

@@ -27,8 +27,8 @@ module Square
     # Credentials
     # page in the [developer dashboard](https://developer.squareup.com/apps).
     # @param [String] client_id Required parameter: Your application ID,
-    # available from the [developer
-    # dashboard](https://developer.squareup.com/apps).
+    # available from the OAuth page for your  application on the Developer
+    # Dashboard.
     # @param [RenewTokenRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -84,7 +84,7 @@ module Square
     # Authorization: Client APPLICATION_SECRET
     # ```
     # Replace `APPLICATION_SECRET` with the application secret on the OAuth
-    # page in the [developer dashboard](https://developer.squareup.com/apps).
+    # page for your application on the Developer Dashboard.
     # @param [RevokeTokenRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -121,15 +121,22 @@ module Square
       )
     end
 
-    # Returns an OAuth access token.
-    # The endpoint supports distinct methods of obtaining OAuth access tokens.
-    # Applications specify a method by adding the `grant_type` parameter
-    # in the request and also provide relevant information.
-    # __Note:__ Regardless of the method application specified,
-    # the endpoint always returns two items; an OAuth access token and
-    # a refresh token in the response.
-    # __OAuth tokens should only live on secure servers. Application clients
-    # should never interact directly with OAuth tokens__.
+    # Returns an OAuth access token and a refresh token unless the
+    # `short_lived` parameter is set to `true`, in which case the endpoint
+    # returns only an access token.
+    # The `grant_type` parameter specifies the type of OAuth request. If
+    # `grant_type` is `authorization_code`, you must include the authorization
+    # code you received when a seller granted you authorization. If `grant_type`
+    # is `refresh_token`, you must provide a valid refresh token. If you are
+    # using
+    # an old version of the Square APIs (prior to March 13, 2019), `grant_type`
+    # can be `migration_token` and you must provide a valid migration token.
+    # You can use the `scopes` parameter to limit the set of permissions granted
+    # to the access token and refresh token. You can use the `short_lived`
+    # parameter
+    # to create an access token that expires in 24 hours.
+    # __Note:__ OAuth tokens should be encrypted and stored on a secure server.
+    # Application clients should never interact directly with OAuth tokens.
     # @param [ObtainTokenRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.

data/lib/square/api/orders_api.rb

@@ -116,6 +116,43 @@ module Square
       )
     end
 
+    # Creates a new order, in the `DRAFT` state, by duplicating an existing
+    # order. The newly created order has
+    # only the core fields (such as line items, taxes, and discounts) copied
+    # from the original order.
+    # @param [CloneOrderRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [CloneOrderResponse Hash] response from the API call
+    def clone_order(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/orders/clone'
+      _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
+
     # Search all orders for one or more locations. Orders include all sales,
     # returns, and exchanges regardless of how or when they entered the Square
     # ecosystem (such as Point of Sale, Invoices, and Connect APIs).

data/lib/square/api_helper.rb

@@ -8,13 +8,14 @@ module Square
     def self.serialize_array(key, array, formatting: 'indexed')
       tuples = []
 
-      if formatting == 'unindexed'
+      case formatting
+      when 'unindexed'
         tuples += array.map { |element| ["#{key}[]", element] }
-      elsif formatting == 'indexed'
+      when 'indexed'
         tuples += array.map.with_index do |element, index|
           ["#{key}[#{index}]", element]
         end
-      elsif formatting == 'plain'
+      when 'plain'
         tuples += array.map { |element| [key, element] }
       else
         raise ArgumentError, 'Invalid format provided.'
@@ -55,7 +56,7 @@ module Square
         end
 
         # Find the template parameter and replace it with its value.
-        query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+        query_builder = query_builder.gsub("{#{key}}", replace_value)
       end
       query_builder
     end
@@ -80,15 +81,16 @@ module Square
         unless value.nil?
           if value.instance_of? Array
             value.compact!
-            query_builder += if array_serialization == 'csv'
+            query_builder += case array_serialization
+                             when 'csv'
                                "#{seperator}#{key}=#{value.map do |element|
                                  CGI.escape(element.to_s)
                                end.join(',')}"
-                             elsif array_serialization == 'psv'
+                             when 'psv'
                                "#{seperator}#{key}=#{value.map do |element|
                                  CGI.escape(element.to_s)
                                end.join('|')}"
-                             elsif array_serialization == 'tsv'
+                             when 'tsv'
                                "#{seperator}#{key}=#{value.map do |element|
                                  CGI.escape(element.to_s)
                                end.join("\t")}"
@@ -114,7 +116,7 @@ module Square
       raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
 
       # Ensure that the urls are absolute.
-      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      matches = url.match(%r{^(https?://[^/]+)})
       raise ArgumentError, 'Invalid Url format.' if matches.nil?
 
       # Get the http protocol match.
@@ -125,7 +127,7 @@ module Square
 
       # Remove redundant forward slashes.
       query = url[protocol.length...(!index.nil? ? index : url.length)]
-      query.gsub!(%r{\/\/+}, '/')
+      query.gsub!(%r{//+}, '/')
 
       # Get the parameters.
       parameters = !index.nil? ? url[url.index('?')...url.length] : ''
@@ -137,7 +139,7 @@ module Square
     # Parses JSON string.
     # @param [String] A JSON string.
     def self.json_deserialize(json)
-      return JSON.parse(json, symbolize_names: true)
+      JSON.parse(json, symbolize_names: true)
     rescue StandardError
       raise TypeError, 'Server responded with invalid JSON.'
     end
@@ -166,6 +168,7 @@ module Square
       a.each do |key, value_a|
         b.each do |k, value_b|
           next unless key == k
+
           x[k] = []
           if value_a.instance_of? Array
             value_a.each do |v|
@@ -207,13 +210,12 @@ module Square
       elsif obj.instance_of? Array
         if formatting == 'indexed'
           obj.each_with_index do |value, index|
-            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
-              index.to_s + ']'))
+            retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{index}]"))
           end
         elsif serializable_types.map { |x| obj[0].is_a? x }.any?
           obj.each do |value|
             abc = if formatting == 'unindexed'
-                    APIHelper.form_encode(value, instance_name + '[]',
+                    APIHelper.form_encode(value, "#{instance_name}[]",
                                           formatting: formatting)
                   else
                     APIHelper.form_encode(value, instance_name,
@@ -223,14 +225,14 @@ module Square
           end
         else
           obj.each_with_index do |value, index|
-            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
-              index.to_s + ']', formatting: formatting))
+            retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{index}]",
+                                                formatting: formatting))
           end
         end
       elsif obj.instance_of? Hash
         obj.each do |key, value|
-          retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
-            key.to_s + ']', formatting: formatting))
+          retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{key}]",
+                                              formatting: formatting))
         end
       elsif obj.instance_of? File
         retval[instance_name] = UploadIO.new(
@@ -265,17 +267,5 @@ module Square
       end
       val
     end
-
-    # Safely converts a string into an rfc3339 DateTime object
-    # @param [String] The datetime string
-    # @return [DateTime] A DateTime object of rfc3339 format
-    def self.rfc3339(date_time)
-      # missing timezone information
-      if date_time.end_with?('Z') || date_time.index('+')
-        DateTime.rfc3339(date_time)
-      else
-        DateTime.rfc3339(date_time + 'Z')
-      end
-    end
   end
 end