square.rb 6.0.0.20200625 → 6.1.0.20200722

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9b142bc997b6065afc532abf126925305076501dd2f92e27fa12a1e09b1dbcd
-  data.tar.gz: 426acce9ecbcf54368c66d511b3a6b9eb0995ea0a2505fa811bcbcf2cf32683a
+  metadata.gz: 274c6809492acf86fd49adee12a1ccc2045d394dfff9612914de1bc010eeb1cb
+  data.tar.gz: 99e6be9ca77af585b64213a3e607ac36f935182bbf9dc8529546548f37d2023c
 SHA512:
-  metadata.gz: bd46549961c8a0c9d469854e05cf5dbda210cb65c0d64d1997f3e894f10d043092dce537dc1cbd3610a43ff4249b10218ee06c85e4e9cf183452f990f67c9522
-  data.tar.gz: 3f1df3f844188ea7dc76279dc20435729b6a05e676f71fe2ecfd59cc63e31c71e0ac0812cf63107d4d2bf54f2b7b1113d50998705a716decef46e5d0fdcc6b7a
+  metadata.gz: c13b32a0109ebd31d40394547775814ddb2aed9f50141b1cd36e3339d2c5e9b43d6f9cce2e0c3cc7775ad69034d3f0908c78c873d930f7d6cd7bfe4a20888e6c
+  data.tar.gz: eb897df878e5f4d861405c2580fb581ad28ce11e3d6ae467b193bc68822d88161238a111022c94d93d67c052c9321e90874550838723840de664313f02121003

data/README.md

@@ -38,6 +38,9 @@ gem 'square.rb'
 ### Orders
 * [Orders]
 
+### Invoices
+* [Invoices]
+
 ### Items
 * [Catalog]
 * [Inventory]
@@ -299,6 +302,7 @@ You can also use the Square API to create applications or services that work wit
 [Locations]: doc/locations.md
 [Merchants]: doc/merchants.md
 [Orders]: doc/orders.md
+[Invoices]: doc/invoices.md
 [Apple Pay]: doc/apple-pay.md
 [Refunds]: doc/refunds.md
 [Reporting]: doc/reporting.md

data/lib/square.rb

@@ -46,6 +46,7 @@ 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'
+require_relative 'square/api/invoices_api.rb'
 require_relative 'square/api/labor_api.rb'
 require_relative 'square/api/locations_api.rb'
 require_relative 'square/api/reporting_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/6.0.0.20200625',
-        'Square-Version' => '2020-06-25'
+        'user-agent' => 'Square-Ruby-SDK/6.1.0.20200722',
+        'Square-Version' => config.square_version
       }
     end
 

data/lib/square/api/catalog_api.rb

@@ -131,14 +131,13 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
-    # Upload an image file to create a new [CatalogImage](#type-catalogimage)
-    # for an existing
-    # [CatalogObject](#type-catalogobject). Images can be uploaded and linked in
-    # this request or created independently
-    # (without an object assignment) and linked to a
-    # [CatalogObject](#type-catalogobject) at a later time.
-    # CreateCatalogImage accepts HTTP multipart/form-data requests with a JSON
-    # part and an image file part in
+    # Uploads an image file to be represented by an
+    # [CatalogImage](#type-catalogimage) object linked to an existing
+    # [CatalogObject](#type-catalogobject) instance. A call to this endpoint can
+    # upload an image, link an image to
+    # a catalog object, or do both.
+    # This `CreateCatalogImage` endpoint 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.
     # Additional information and an example cURL request can be found in the
     # [Create a Catalog Image
@@ -195,8 +194,8 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
-    # Returns information about the Square Catalog API, such as batch size
-    # limits for `BatchUpsertCatalogObjects`.
+    # Retrieves information about the Square Catalog API, such as batch size
+    # limits that can be used by the `BatchUpsertCatalogObjects` endpoint.
     # @return [CatalogInfoResponse Hash] response from the API call
     def catalog_info
       # Prepare query url.
@@ -406,22 +405,23 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
-    # 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).
+    # Searches for [CatalogObject](#type-CatalogObject) of any types against
+    # supported search attribute values,
+    # excluding custom attribute values on items or item variations, against one
+    # or more of the specified query expressions,
+    # This (`SearchCatalogObjects`) endpoint differs from the
+    # [SearchCatalogItems](#endpoint-Catalog-SearchCatalogItems)
+    # endpoint in the following aspects:
+    # - `SearchCatalogItems` can only search for items or item variations,
+    # whereas `SearchCatalogObjects` can search for any type of catalog objects.
+    # - `SearchCatalogItems` supports the custom attribute query filters to
+    # return items or item variations that contain custom attribute values,
+    # where `SearchCatalogObjects` does not.
+    # - `SearchCatalogItems` does not support the `include_deleted_objects`
+    # filter to search for deleted items or item variations, whereas
+    # `SearchCatalogObjects` does.
+    # - The both endpoints have different call conventions, including the query
+    # filter formats.
     # @param [SearchCatalogObjectsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -453,6 +453,54 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
+    # Searches for catalog items or item variations by matching supported search
+    # attribute values, including
+    # custom attribute values, against one or more of the specified query
+    # expressions,
+    # This (`SearchCatalogItems`) endpoint differs from the
+    # [SearchCatalogObjects](#endpoint-Catalog-SearchCatalogObjects)
+    # endpoint in the following aspects:
+    # - `SearchCatalogItems` can only search for items or item variations,
+    # whereas `SearchCatalogObjects` can search for any type of catalog objects.
+    # - `SearchCatalogItems` supports the custom attribute query filters to
+    # return items or item variations that contain custom attribute values,
+    # where `SearchCatalogObjects` does not.
+    # - `SearchCatalogItems` does not support the `include_deleted_objects`
+    # filter to search for deleted items or item variations, whereas
+    # `SearchCatalogObjects` does.
+    # - The both endpoints use different call conventions, including the query
+    # filter formats.
+    # @param [SearchCatalogItemsRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [SearchCatalogItemsResponse Hash] response from the API call
+    def search_catalog_items(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/catalog/search-catalog-items'
+      _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
+
     # Updates the [CatalogModifierList](#type-catalogmodifierlist) objects
     # that apply to the targeted [CatalogItem](#type-catalogitem) without having
     # to perform an upsert on the entire item.

data/lib/square/api/inventory_api.rb

@@ -253,8 +253,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,

data/lib/square/api/invoices_api.rb

@@ -0,0 +1,358 @@
+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.
+    # 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).
+    # @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).
+    # 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.
+    # @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.
+    # 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.
+    # @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' => invoice_id
+      )
+      _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' => invoice_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 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
+    # 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' => invoice_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
+
+    # 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' => invoice_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.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).
+    # 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
+    # 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' => invoice_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.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

data/lib/square/api/locations_api.rb

@@ -71,9 +71,14 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
-    # Retrieves details of a location.
+    # Retrieves details of a location. You can specify "main"
+    # as the location ID to retrieve details of the
+    # main location. For more information,
+    # see [Locations API
+    # Overview](https://developer.squareup.com/docs/docs/locations-api).
     # @param [String] location_id Required parameter: The ID of the location to
-    # retrieve.
+    # retrieve. If you specify the string "main", then the endpoint returns the
+    # main location.
     # @return [RetrieveLocationResponse Hash] response from the API call
     def retrieve_location(location_id:)
       # Prepare query url.

data/lib/square/api/merchants_api.rb

@@ -48,7 +48,8 @@ module Square
 
     # Retrieve a `Merchant` object for the given `merchant_id`.
     # @param [String] merchant_id Required parameter: The ID of the merchant to
-    # retrieve.
+    # retrieve. If the string "me" is supplied as the ID, then retrieve the
+    # merchant that is currently accessible to this call.
     # @return [RetrieveMerchantResponse Hash] response from the API call
     def retrieve_merchant(merchant_id:)
       # Prepare query url.

data/lib/square/client.rb

@@ -4,11 +4,11 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '6.0.0.20200625'
+      '6.1.0.20200722'
     end
 
     def square_version
-      '2020-06-25'
+      config.square_version
     end
 
     # Access to mobile_authorization controller.
@@ -113,6 +113,12 @@ module Square
       @inventory ||= InventoryApi.new config
     end
 
+    # Access to invoices controller.
+    # @return [InvoicesApi] Returns the controller instance.
+    def invoices
+      @invoices ||= InvoicesApi.new config
+    end
+
     # Access to labor controller.
     # @return [LaborApi] Returns the controller instance.
     def labor
@@ -187,13 +193,14 @@ module Square
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
-                   access_token: 'TODO: Replace', additional_headers: {},
-                   config: nil)
+                   square_version: '2020-07-22', access_token: 'TODO: Replace',
+                   additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(timeout: timeout, max_retries: max_retries,
                                     retry_interval: retry_interval,
                                     backoff_factor: backoff_factor,
                                     environment: environment,
+                                    square_version: square_version,
                                     access_token: access_token,
                                     additional_headers: additional_headers)
                 else

data/lib/square/configuration.rb

@@ -9,6 +9,7 @@ module Square
     attr_reader :retry_interval
     attr_reader :backoff_factor
     attr_reader :environment
+    attr_reader :square_version
     attr_reader :access_token
 
     def additional_headers
@@ -21,7 +22,8 @@ module Square
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
-                   access_token: 'TODO: Replace', additional_headers: {})
+                   square_version: '2020-07-22', access_token: 'TODO: Replace',
+                   additional_headers: {})
       # The value to use for connection timeout
       @timeout = timeout
 
@@ -38,6 +40,9 @@ module Square
       # Current API environment
       @environment = String(environment)
 
+      # Square Connect API versions
+      @square_version = square_version
+
       # OAuth 2.0 Access Token
       @access_token = access_token
 
@@ -49,20 +54,23 @@ module Square
     end
 
     def clone_with(timeout: nil, max_retries: nil, retry_interval: nil,
-                   backoff_factor: nil, environment: nil, access_token: nil,
-                   additional_headers: nil)
+                   backoff_factor: nil, environment: nil, square_version: nil,
+                   access_token: nil, additional_headers: nil)
       timeout ||= self.timeout
       max_retries ||= self.max_retries
       retry_interval ||= self.retry_interval
       backoff_factor ||= self.backoff_factor
       environment ||= self.environment
+      square_version ||= self.square_version
       access_token ||= self.access_token
       additional_headers ||= self.additional_headers
 
       Configuration.new(timeout: timeout, max_retries: max_retries,
                         retry_interval: retry_interval,
                         backoff_factor: backoff_factor,
-                        environment: environment, access_token: access_token,
+                        environment: environment,
+                        square_version: square_version,
+                        access_token: access_token,
                         additional_headers: additional_headers)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 6.0.0.20200625
+  version: 6.1.0.20200722
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -131,6 +131,7 @@ files:
 - lib/square/api/disputes_api.rb
 - lib/square/api/employees_api.rb
 - lib/square/api/inventory_api.rb
+- lib/square/api/invoices_api.rb
 - lib/square/api/labor_api.rb
 - lib/square/api/locations_api.rb
 - lib/square/api/loyalty_api.rb