square.rb 6.0.0.20200625 → 6.5.0.20201028

data/lib/square/api/employees_api.rb

@@ -6,8 +6,7 @@ module Square
     end
 
     # ListEmployees
-    # @param [String] location_id Optional parameter: Filter employees returned
-    # to only those that are associated with the specified location.
+    # @param [String] location_id Optional parameter: Example:
     # @param [EmployeeStatus] status Optional parameter: Specifies the
     # EmployeeStatus to filter the employee by.
     # @param [Integer] limit Optional parameter: The number of employees to be
@@ -19,6 +18,7 @@ module Square
                        status: nil,
                        limit: nil,
                        cursor: nil)
+      warn 'Endpoint list_employees in EmployeesApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/employees'
@@ -47,7 +47,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
 
     # RetrieveEmployee
@@ -55,12 +57,13 @@ module Square
     # requested.
     # @return [RetrieveEmployeeResponse Hash] response from the API call
     def retrieve_employee(id:)
+      warn 'Endpoint retrieve_employee in EmployeesApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/employees/{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
 
@@ -80,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
   end
 end

data/lib/square/api/inventory_api.rb

@@ -16,7 +16,7 @@ module Square
       _query_builder << '/v2/inventory/adjustment/{adjustment_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'adjustment_id' => adjustment_id
+        'adjustment_id' => { 'value' => adjustment_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -36,7 +36,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
 
     # Applies adjustments and counts to the provided item quantities.
@@ -71,7 +73,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 historical physical counts and adjustments based on the
@@ -108,7 +112,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 current counts for the provided
@@ -149,7 +155,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 the [InventoryPhysicalCount](#type-inventoryphysicalcount)
@@ -163,7 +171,7 @@ module Square
       _query_builder << '/v2/inventory/physical-count/{physical_count_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'physical_count_id' => physical_count_id
+        'physical_count_id' => { 'value' => physical_count_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -183,7 +191,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 the current calculated stock count for a given
@@ -209,7 +219,7 @@ module Square
       _query_builder << '/v2/inventory/{catalog_object_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'catalog_object_id' => catalog_object_id
+        'catalog_object_id' => { 'value' => catalog_object_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -234,7 +244,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 set of physical counts and inventory adjustments for the
@@ -242,8 +254,9 @@ module Square
     # [Location](#type-location)s.
     # Results are paginated and sorted in descending order according to their
     # `occurred_at` timestamp (newest first).
-    # There are no limits on how far back the caller can page. This endpoint is
-    # useful when displaying recent changes for a specific item. For more
+    # There are no limits on how far back the caller can page. This endpoint can
+    # be
+    # used to display recent changes for a specific item. For more
     # sophisticated queries, use a batch endpoint.
     # @param [String] catalog_object_id Required parameter: ID of the
     # [CatalogObject](#type-catalogobject) to retrieve.
@@ -253,8 +266,8 @@ module Square
     # @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 the original query.  See the
-    # [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pa
-    # gination) guide for more information.
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion) guide for more information.
     # @return [RetrieveInventoryChangesResponse Hash] response from the API call
     def retrieve_inventory_changes(catalog_object_id:,
                                    location_ids: nil,
@@ -264,7 +277,7 @@ module Square
       _query_builder << '/v2/inventory/{catalog_object_id}/changes'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'catalog_object_id' => catalog_object_id
+        'catalog_object_id' => { 'value' => catalog_object_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -289,7 +302,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/invoices_api.rb

@@ -0,0 +1,359 @@
+module Square
+  # InvoicesApi
+  class InvoicesApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # 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.
+    # @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).
+    # @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.
+    # @return [ListInvoicesResponse Hash] response from the API call
+    def list_invoices(location_id:,
+                      cursor: nil,
+                      limit: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/invoices'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'location_id' => location_id,
+        'cursor' => cursor,
+        'limit' => limit
+      )
+      _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 draft [invoice](#type-invoice)
+    # for an order created using the Orders API.
+    # 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).
+    # @param [CreateInvoiceRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CreateInvoiceResponse Hash] response from the API call
+    def create_invoice(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/invoices'
+      _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
+
+    # Searches for invoices from a location specified in
+    # the filter. You can optionally specify customers in the filter for whom to
+    # retrieve invoices. In the current implementation, you can only specify one
+    # location and
+    # 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.
+    # @param [SearchInvoicesRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [SearchInvoicesResponse Hash] response from the API call
+    def search_invoices(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/invoices/search'
+      _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 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).
+    # @param [String] invoice_id Required parameter: The ID of the invoice to
+    # delete.
+    # @param [Integer] version Optional parameter: The version of the
+    # [invoice](#type-invoice) to delete. If you do not know the version, you
+    # can call [GetInvoice](#endpoint-Invoices-GetInvoice) or 
+    # [ListInvoices](#endpoint-Invoices-ListInvoices).
+    # @return [DeleteInvoiceResponse Hash] response from the API call
+    def delete_invoice(invoice_id:,
+                       version: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/invoices/{invoice_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'invoice_id' => { 'value' => invoice_id, 'encode' => true }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'version' => version
+      )
+      _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 an invoice by invoice ID.
+    # @param [String] invoice_id Required parameter: The id of the invoice to
+    # retrieve.
+    # @return [GetInvoiceResponse Hash] response from the API call
+    def get_invoice(invoice_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/invoices/{invoice_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'invoice_id' => { 'value' => invoice_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
+
+    # 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.
+    # @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
+    # object definition for field details.
+    # @return [UpdateInvoiceResponse Hash] response from the API call
+    def update_invoice(invoice_id:,
+                       body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/invoices/{invoice_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'invoice_id' => { 'value' => invoice_id, 'encode' => true }
+      )
+      _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
+
+    # Cancels an invoice. The seller cannot collect payments for
+    # the canceled invoice.
+    # You cannot cancel an invoice in a terminal state: `PAID`, `REFUNDED`,
+    # `CANCELED`, or `FAILED`.
+    # @param [String] invoice_id Required parameter: The ID of the
+    # [invoice](#type-invoice) to cancel.
+    # @param [CancelInvoiceRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CancelInvoiceResponse Hash] response from the API call
+    def cancel_invoice(invoice_id:,
+                       body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/invoices/{invoice_id}/cancel'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'invoice_id' => { 'value' => invoice_id, 'encode' => true }
+      )
+      _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
+
+    # Publishes the specified draft invoice.
+    # After an invoice is published, Square
+    # follows up based on the invoice configuration. For example, Square
+    # sends the invoice to the customer's email address, charges the customer's
+    # card on file, or does
+    # nothing. Square also makes the invoice available on a Square-hosted
+    # invoice page.
+    # The invoice `status` also changes from `DRAFT` to a status
+    # based on the invoice configuration. For example, the status changes to
+    # `UNPAID` if
+    # Square emails the invoice or `PARTIALLY_PAID` if Square charge a card on
+    # file for a portion of the
+    # invoice amount).
+    # @param [String] invoice_id Required parameter: The id of the invoice to
+    # publish.
+    # @param [PublishInvoiceRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [PublishInvoiceResponse Hash] response from the API call
+    def publish_invoice(invoice_id:,
+                        body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/invoices/{invoice_id}/publish'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'invoice_id' => { 'value' => invoice_id, 'encode' => true }
+      )
+      _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
+  end
+end