square.rb 5.2.1.20200422 → 6.2.0.20200812

data/lib/square.rb

@@ -46,13 +46,17 @@ 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'
 require_relative 'square/api/checkout_api.rb'
 require_relative 'square/api/orders_api.rb'
 require_relative 'square/api/transactions_api.rb'
+require_relative 'square/api/loyalty_api.rb'
 require_relative 'square/api/merchants_api.rb'
 require_relative 'square/api/payments_api.rb'
 require_relative 'square/api/refunds_api.rb'
+require_relative 'square/api/subscriptions_api.rb'
+require_relative 'square/api/team_api.rb'
 require_relative 'square/api/terminal_api.rb'

data/lib/square/api/base_api.rb

@@ -8,8 +8,8 @@ module Square
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'Square-Ruby-SDK/5.2.1.20200422',
-        'Square-Version' => '2020-04-22'
+        'user-agent' => 'Square-Ruby-SDK/6.2.0.20200812',
+        'Square-Version' => config.square_version
       }
     end
 

data/lib/square/api/catalog_api.rb

@@ -131,42 +131,14 @@ 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
-    # JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB. The
-    # following is an example of such an HTTP request:
-    # ```
-    # POST /v2/catalog/images
-    # Accept: application/json
-    # Content-Type: multipart/form-data;boundary="boundary"
-    # Square-Version: XXXX-XX-XX
-    # Authorization: Bearer {ACCESS_TOKEN}
-    # --boundary
-    # Content-Disposition: form-data; name="request"
-    # Content-Type: application/json
-    # {
-    # "idempotency_key":"528dea59-7bfb-43c1-bd48-4a6bba7dd61f86",
-    # "object_id": "ND6EA5AAJEO5WL3JNNIAQA32",
-    # "image":{
-    # "id":"#TEMP_ID",
-    # "type":"IMAGE",
-    # "image_data":{
-    # "caption":"A picture of a cup of coffee"
-    # }
-    # }
-    # }
-    # --boundary
-    # Content-Disposition: form-data; name="image"; filename="Coffee.jpg"
-    # Content-Type: image/jpeg
-    # {ACTUAL_IMAGE_BYTES}
-    # --boundary
-    # ```
+    # 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
     # recipe](https://developer.squareup.com/docs/more-apis/catalog/cookbook/cre
@@ -222,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.
@@ -400,7 +372,7 @@ module Square
     # `false`
     # @return [RetrieveCatalogObjectResponse Hash] response from the API call
     def retrieve_catalog_object(object_id:,
-                                include_related_objects: nil)
+                                include_related_objects: false)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/catalog/object/{object_id}'
@@ -433,24 +405,23 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
-    # Queries the targeted catalog using a variety of query types:
-    # [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute),
-    # [CatalogQueryExact](#type-catalogqueryexact),
-    # [CatalogQueryRange](#type-catalogqueryrange),
-    # [CatalogQueryText](#type-catalogquerytext),
-    # [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and
-    # [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist)
-    # .
-    # --
-    # --
-    # Future end of the above comment:
-    # [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.
@@ -482,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/customers_api.rb

@@ -5,7 +5,13 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Lists a business's customers.
+    # Lists customer profiles associated with a Square account.
+    # Under normal operating conditions, newly created or updated customer
+    # profiles become available
+    # for the listing operation in well under 30 seconds. Occasionally,
+    # propagation of the new or updated
+    # profiles can take closer to one minute or longer, espeically during
+    # network incidents and outages.
     # @param [String] cursor Optional parameter: A pagination cursor returned by
     # a previous call to this endpoint. Provide this to retrieve the next set of
     # results for your original query.  See the [Pagination
@@ -91,10 +97,17 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
-    # Searches the customer profiles associated with a Square account.
-    # Calling SearchCustomers without an explicit query parameter returns all
+    # Searches the customer profiles associated with a Square account using
+    # one or more supported query filters.
+    # Calling `SearchCustomers` without any explicit query filter returns all
     # customer profiles ordered alphabetically based on `given_name` and
     # `family_name`.
+    # Under normal operating conditions, newly created or updated customer
+    # profiles become available
+    # for the search operation in well under 30 seconds. Occasionally,
+    # propagation of the new or updated
+    # profiles can take closer to one minute or longer, espeically during
+    # network incidents and outages.
     # @param [SearchCustomersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.

data/lib/square/api/disputes_api.rb

@@ -244,17 +244,7 @@ module Square
     # Uploads a file to use as evidence in a dispute challenge. The endpoint
     # accepts
     # HTTP multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG,
-    # and TIFF formats. The following is an example of such an HTTP request:
-    # ```
-    # curl -X POST \
-    # -H 'Accept: application/json' \
-    # -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
-    # -H 'Content-Type: multipart/form-data' \
-    # -F 'evidence=@/path/to/file/filename.tiff' \
-    # -F 'request={ "idempotency_key":"{{UNIQUE_KEY}}",
-    # "evidence_type":"{{EVIDENCE_TYPE}}", "content_type":"image/tiff" }' \
-    # 'https://connect.squareup.com/v2/disputes/{{DISPUTE_ID}}/evidence_file'
-    # ```
+    # and TIFF formats.
     # For more information, see [Challenge a
     # Dispute](https://developer.squareup.com/docs/docs/disputes-api/process-dis
     # putes#challenge-a-dispute).

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