square.rb 6.2.0.20200812 → 8.0.0.20201216

data/lib/square/api/invoices_api.rb

@@ -8,16 +8,13 @@ module Square
     # Returns a list of invoices for a given location. The response
     # is paginated. If truncated, the response includes a `cursor` that you
     # use in a subsequent request to fetch the next set of invoices.
-    # For more information about retrieving invoices, see [Retrieve
-    # invoices](https://developer.squareup.com/docs/docs/invoices-api/overview#r
-    # etrieve-invoices).
     # @param [String] location_id Required parameter: The ID of the location for
     # which to list invoices.
     # @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 your original query.  For more information, see
-    # [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pa
-    # gination).
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
     # @param [Integer] limit Optional parameter: The maximum number of invoices
     # to return (200 is the maximum `limit`).  If not provided, the server  uses
     # a default limit of 100 invoices.
@@ -52,7 +49,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 a draft [invoice](#type-invoice)
@@ -60,8 +59,6 @@ module Square
     # A draft invoice remains in your account and no action is taken.
     # You must publish the invoice before Square can process it (send it to the
     # customer's email address or charge the customer’s card on file).
-    # For more information, see [Manage Invoices Using the Invoices
-    # API](https://developer.squareup.com/docs/docs/invoices-api/overview).
     # @param [CreateInvoiceRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -90,7 +87,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
 
     # Searches for invoices from a location specified in
@@ -100,9 +99,6 @@ module Square
     # optionally one customer.
     # The response is paginated. If truncated, the response includes a `cursor`
     # that you use in a subsequent request to fetch the next set of invoices.
-    # For more information about retrieving invoices, see [Retrieve
-    # invoices](https://developer.squareup.com/docs/docs/invoices-api/overview#r
-    # etrieve-invoices).
     # @param [SearchInvoicesRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -131,13 +127,15 @@ 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 the specified invoice. When an invoice is deleted, the
     # associated Order status changes to CANCELED. You can only delete a draft
-    # invoice (you cannot delete an invoice scheduled for publication, or a
-    # published invoice).
+    # invoice (you cannot delete a published invoice, including one that is
+    # scheduled for processing).
     # @param [String] invoice_id Required parameter: The ID of the invoice to
     # delete.
     # @param [Integer] version Optional parameter: The version of the
@@ -152,7 +150,7 @@ module Square
       _query_builder << '/v2/invoices/{invoice_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'invoice_id' => invoice_id
+        'invoice_id' => { 'value' => invoice_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -176,7 +174,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
 
     # Retrieves an invoice by invoice ID.
@@ -189,7 +189,7 @@ module Square
       _query_builder << '/v2/invoices/{invoice_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'invoice_id' => invoice_id
+        'invoice_id' => { 'value' => invoice_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -209,18 +209,20 @@ 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 an invoice by modifying field values, clearing field values, or
-    # both
-    # as specified in the request.
-    # There are no restrictions to updating an invoice in a draft state.
-    # However, there are guidelines for updating a published invoice.
-    # For more information, see [Update an
-    # invoice](https://developer.squareup.com/docs/docs/invoices-api/overview#up
-    # date-an-invoice).
-    # @param [String] invoice_id Required parameter: The id of the invoice to
+    # Updates an invoice by modifying fields, clearing fields, or both. For most
+    # updates, you can use a sparse
+    # `Invoice` object to add fields or change values, and use the
+    # `fields_to_clear` field to specify fields to clear.
+    # However, some restrictions apply. For example, you cannot change the
+    # `order_id` or `location_id` field, and you
+    # must provide the complete `custom_fields` list to update a custom field.
+    # Published invoices have additional restrictions.
+    # @param [String] invoice_id Required parameter: The ID of the invoice to
     # update.
     # @param [UpdateInvoiceRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -233,7 +235,7 @@ module Square
       _query_builder << '/v2/invoices/{invoice_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'invoice_id' => invoice_id
+        'invoice_id' => { 'value' => invoice_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -255,7 +257,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
 
     # Cancels an invoice. The seller cannot collect payments for
@@ -275,7 +279,7 @@ module Square
       _query_builder << '/v2/invoices/{invoice_id}/cancel'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'invoice_id' => invoice_id
+        'invoice_id' => { 'value' => invoice_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -297,7 +301,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
 
     # Publishes the specified draft invoice.
@@ -313,10 +319,6 @@ module Square
     # Square emails the invoice or `PARTIALLY_PAID` if Square charge a card on
     # file for a portion of the
     # invoice amount).
-    # For more information, see
-    # [Create and publish an
-    # invoice](https://developer.squareup.com/docs/docs/invoices-api/overview#cr
-    # eate-and-publish-an-invoice).
     # @param [String] invoice_id Required parameter: The id of the invoice to
     # publish.
     # @param [PublishInvoiceRequest] body Required parameter: An object
@@ -330,7 +332,7 @@ module Square
       _query_builder << '/v2/invoices/{invoice_id}/publish'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'invoice_id' => invoice_id
+        'invoice_id' => { 'value' => invoice_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -352,7 +354,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/labor_api.rb

@@ -44,7 +44,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 a new `BreakType`.
@@ -88,7 +90,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
 
     # Deletes an existing `BreakType`.
@@ -102,7 +106,7 @@ module Square
       _query_builder << '/v2/labor/break-types/{id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'id' => id
+        'id' => { 'value' => id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -122,7 +126,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
 
     # Returns a single `BreakType` specified by id.
@@ -135,7 +141,7 @@ module Square
       _query_builder << '/v2/labor/break-types/{id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'id' => id
+        'id' => { 'value' => id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -155,7 +161,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
 
     # Updates an existing `BreakType`.
@@ -172,7 +180,7 @@ module Square
       _query_builder << '/v2/labor/break-types/{id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'id' => id
+        'id' => { 'value' => id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -194,7 +202,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
 
     # Returns a paginated list of `EmployeeWage` instances for a business.
@@ -209,6 +219,7 @@ module Square
     def list_employee_wages(employee_id: nil,
                             limit: nil,
                             cursor: nil)
+      warn 'Endpoint list_employee_wages in LaborApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/labor/employee-wages'
@@ -236,7 +247,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
 
     # Returns a single `EmployeeWage` specified by id.
@@ -244,12 +257,13 @@ module Square
     # retrieved.
     # @return [GetEmployeeWageResponse Hash] response from the API call
     def get_employee_wage(id:)
+      warn 'Endpoint get_employee_wage in LaborApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/labor/employee-wages/{id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'id' => id
+        'id' => { 'value' => id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -269,7 +283,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 a new `Shift`.
@@ -317,7 +333,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
 
     # Returns a paginated list of `Shift` records for a business.
@@ -361,7 +379,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
 
     # Deletes a `Shift`.
@@ -374,7 +394,7 @@ module Square
       _query_builder << '/v2/labor/shifts/{id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'id' => id
+        'id' => { 'value' => id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -394,7 +414,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
 
     # Returns a single `Shift` specified by id.
@@ -407,7 +429,7 @@ module Square
       _query_builder << '/v2/labor/shifts/{id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'id' => id
+        'id' => { 'value' => id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -427,7 +449,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
 
     # Updates an existing `Shift`.
@@ -449,7 +473,7 @@ module Square
       _query_builder << '/v2/labor/shifts/{id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'id' => id
+        'id' => { 'value' => id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -471,7 +495,88 @@ 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 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.
+    # @return [ListTeamMemberWagesResponse Hash] response from the API call
+    def list_team_member_wages(team_member_id: nil,
+                               limit: nil,
+                               cursor: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/labor/team-member-wages'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'team_member_id' => team_member_id,
+        'limit' => limit,
+        '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
+
+    # Returns a single `TeamMemberWage` specified by id.
+    # @param [String] id Required parameter: UUID for the `TeamMemberWage` being
+    # retrieved.
+    # @return [GetTeamMemberWageResponse Hash] response from the API call
+    def get_team_member_wage(id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/labor/team-member-wages/{id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'id' => { 'value' => id, 'encode' => true }
+      )
+      _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
 
     # Returns a list of `WorkweekConfig` instances for a business.
@@ -508,7 +613,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
 
     # Updates a `WorkweekConfig`.
@@ -525,7 +632,7 @@ module Square
       _query_builder << '/v2/labor/workweek-configs/{id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'id' => id
+        'id' => { 'value' => id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -547,7 +654,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