square.rb 6.4.0.20200923 → 9.0.0.20210226

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff331317ad3b1bea0c21cf6a6cc9bfd0b46296890792bf0f5d19d21be6ea8ddb
-  data.tar.gz: dbf543ea3a0ebd7a70cd04e754ffc843d13575899c7e0fe1697c0a538d68fa0c
+  metadata.gz: d590e351e349cad97ee0e30e6f0c281f699e9357b68007ce847cdf3d69b86451
+  data.tar.gz: 5f89a1777603830bb3b6878f3e45041522c862a2b625e8bdda39c2893678e93d
 SHA512:
-  metadata.gz: 15818b53efa7435cc292b14f3d504feef1ab423e3edafdba332694ad229910d8400eb08e6ba67906c19629ac2ecdc9a76251d29f85790fb3046a115aca3a566c
-  data.tar.gz: 749326579ee962e569e387f932af7176f0137e6f6b175e7392bfa9b8e19e872092f34b7f2097fa9ce9d21cd744c2837cd23015e5c826b50510664887bd9ee546
+  metadata.gz: d460315ea4f40be58b73ae56ce056ae5a7e0d09f8ca3b8604e8e347987743054228243318d4e23cbb2cf876272c88e7c5ace6cd50ddf9ad2a116f84c20a378f0
+  data.tar.gz: 48da57deda485630006753f057fc6962caea914f058fca58d20884696e101b3e859b8cd5bf68a6d69817ed62b66fb743bddde49b5c15d9837ccca91fe40dc806

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2020 Square, Inc.
+Copyright 2121 Square, Inc.
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

data/README.md

@@ -56,6 +56,9 @@ gem 'square.rb'
 ### Loyalty
 * [Loyalty]
 
+### Bookings
+* [Bookings]
+
 ### Business
 * [Merchants]
 * [Locations]
@@ -75,7 +78,6 @@ gem 'square.rb'
 * [O Auth]
 
 ### Deprecated APIs
-* [V1 Locations]
 * [V1 Employees]
 * [V1 Transactions]
 * [V1 Items]
@@ -194,6 +196,15 @@ client = Square::Client.new(
     environment: 'production'
 )
 ```
+
+- To set a custom environment provide a `custom_url`, and set environment to `custom`:
+
+```ruby
+client = Square::Client.new(
+    access_token:'ACCESS TOKEN HERE',
+    environment: 'custom',
+    custom_url: 'https://your.customdomain.com'
+)
  
 ### Get an Instance of an API object and call its methods
 
@@ -280,38 +291,39 @@ The Square Platform is built on the [Square API]. Square has a number of other S
 
 You can also use the Square API to create applications or services that work with payments, orders, inventory, etc. that have been created and managed in Square’s in-person hardware products (Square Point of Sale and Square Register).
 
+[//]: # "Link anchor definitions"
 [Square Logo]: https://docs.connect.squareup.com/images/github/github-square-logo.svg
 [Developer Dashboard]: https://developer.squareup.com/apps
 [Square API]: https://squareup.com/developers
 [sign up for a developer account]: https://squareup.com/signup?v=developers
 [Client]: doc/client.md
-[Devices]: doc/devices.md
-[Disputes]: doc/disputes.md
-[Terminal]: doc/terminal.md
-[Team]: doc/team.md
-[Cash Drawers]: doc/cash-drawers.md
-[Customer Groups]: doc/customer-groups.md
-[Customer Segments]: doc/customer-segments.md
-[Bank Accounts]: doc/bank-accounts
-[Payments]: doc/payments.md
-[Checkout]: doc/checkout.md
-[Catalog]: doc/catalog.md
-[Customers]: doc/customers.md
-[Employees]: doc/employees.md
-[Inventory]: doc/inventory.md
-[Labor]: doc/labor.md
-[Loyalty]: doc/loyalty.md
-[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
-[Mobile Authorization]: doc/mobile-authorization.md
-[O Auth]: doc/o-auth.md
-[V1 Locations]: doc/v1-locations.md
-[V1 Employees]: doc/v1-employees.md
-[V1 Transactions]: doc/v1-transactions.md
-[V1 Items]: doc/v1-items.md
-[Transactions]: doc/transactions.md
-[Subscriptions]: doc/subscriptions.md
+[Devices]: doc/api/devices.md
+[Disputes]: doc/api/disputes.md
+[Terminal]: doc/api/terminal.md
+[Team]: doc/api/team.md
+[Cash Drawers]: doc/api/cash-drawers.md
+[Customer Groups]: doc/api/customer-groups.md
+[Customer Segments]: doc/api/customer-segments.md
+[Bank Accounts]: doc/api/bank-accounts.md
+[Payments]: doc/api/payments.md
+[Checkout]: doc/api/checkout.md
+[Catalog]: doc/api/catalog.md
+[Customers]: doc/api/customers.md
+[Employees]: doc/api/employees.md
+[Inventory]: doc/api/inventory.md
+[Labor]: doc/api/labor.md
+[Loyalty]: doc/api/loyalty.md
+[Bookings]: doc/api/bookings.md
+[Locations]: doc/api/locations.md
+[Merchants]: doc/api/merchants.md
+[Orders]: doc/api/orders.md
+[Invoices]: doc/api/invoices.md
+[Apple Pay]: doc/api/apple-pay.md
+[Refunds]: doc/api/refunds.md
+[Subscriptions]: doc/api/subscriptions.md
+[Mobile Authorization]: doc/api/mobile-authorization.md
+[O Auth]: doc/api/o-auth.md
+[V1 Employees]: doc/api/v1-employees.md
+[V1 Transactions]: doc/api/v1-transactions.md
+[V1 Items]: doc/api/v1-items.md
+[Transactions]: doc/api/transactions.md

data/lib/square.rb

@@ -1,61 +1,60 @@
-require 'date'
-require 'json'
-require 'faraday'
-require 'certifi'
-require 'logging'
-
-require_relative 'square/api_helper.rb'
-require_relative 'square/client.rb'
-
-# Utilities
-require_relative 'square/utilities/file_wrapper.rb'
-
-# Http
-require_relative 'square/http/api_response.rb'
-require_relative 'square/http/http_call_back.rb'
-require_relative 'square/http/http_client.rb'
-require_relative 'square/http/faraday_client.rb'
-require_relative 'square/http/http_method_enum.rb'
-require_relative 'square/http/http_request.rb'
-require_relative 'square/http/http_response.rb'
-require_relative 'square/http/auth/o_auth2.rb'
-
-# Models
-
-# Exceptions
-require_relative 'square/exceptions/api_exception.rb'
-
-require_relative 'square/configuration.rb'
-
-# Controllers
-require_relative 'square/api/base_api.rb'
-require_relative 'square/api/mobile_authorization_api.rb'
-require_relative 'square/api/o_auth_api.rb'
-require_relative 'square/api/v1_locations_api.rb'
-require_relative 'square/api/v1_employees_api.rb'
-require_relative 'square/api/v1_transactions_api.rb'
-require_relative 'square/api/v1_items_api.rb'
-require_relative 'square/api/apple_pay_api.rb'
-require_relative 'square/api/bank_accounts_api.rb'
-require_relative 'square/api/cash_drawers_api.rb'
-require_relative 'square/api/catalog_api.rb'
-require_relative 'square/api/customers_api.rb'
-require_relative 'square/api/customer_groups_api.rb'
-require_relative 'square/api/customer_segments_api.rb'
-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/checkout_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/orders_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'
+require 'date'
+require 'json'
+require 'faraday'
+require 'certifi'
+require 'logging'
+
+require_relative 'square/api_helper.rb'
+require_relative 'square/client.rb'
+
+# Utilities
+require_relative 'square/utilities/file_wrapper.rb'
+
+# Http
+require_relative 'square/http/api_response.rb'
+require_relative 'square/http/http_call_back.rb'
+require_relative 'square/http/http_client.rb'
+require_relative 'square/http/faraday_client.rb'
+require_relative 'square/http/http_method_enum.rb'
+require_relative 'square/http/http_request.rb'
+require_relative 'square/http/http_response.rb'
+require_relative 'square/http/auth/o_auth2.rb'
+
+# Models
+
+# Exceptions
+require_relative 'square/exceptions/api_exception.rb'
+
+require_relative 'square/configuration.rb'
+
+# Controllers
+require_relative 'square/api/base_api.rb'
+require_relative 'square/api/mobile_authorization_api.rb'
+require_relative 'square/api/o_auth_api.rb'
+require_relative 'square/api/v1_employees_api.rb'
+require_relative 'square/api/v1_transactions_api.rb'
+require_relative 'square/api/apple_pay_api.rb'
+require_relative 'square/api/bank_accounts_api.rb'
+require_relative 'square/api/bookings_api.rb'
+require_relative 'square/api/cash_drawers_api.rb'
+require_relative 'square/api/catalog_api.rb'
+require_relative 'square/api/customers_api.rb'
+require_relative 'square/api/customer_groups_api.rb'
+require_relative 'square/api/customer_segments_api.rb'
+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/checkout_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/orders_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/apple_pay_api.rb

@@ -14,8 +14,8 @@ module Square
     # Web Apple Pay with Square for merchants using their platform.
     # To learn more about Apple Pay on Web see the Apple Pay section in the
     # [Square Payment Form
-    # Walkthrough](https://developer.squareup.com/docs/docs/payment-form/payment
-    # -form-walkthrough).
+    # Walkthrough](https://developer.squareup.com/docs/payment-form/payment-form
+    # -walkthrough).
     # @param [RegisterDomainRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -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
   end
 end

data/lib/square/api/bank_accounts_api.rb

@@ -7,14 +7,11 @@ module Square
 
     # Returns a list of [BankAccount](#type-bankaccount) objects linked to a
     # Square account.
-    # For more information, see
-    # [Bank Accounts
-    # API](https://developer.squareup.com/docs/docs/bank-accounts-api).
     # @param [String] cursor Optional parameter: The pagination cursor returned
     # by a previous call to this endpoint. Use it in the next `ListBankAccounts`
     # request to retrieve the next set  of results.  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.
     # @param [Integer] limit Optional parameter: Upper limit on the number of
     # bank accounts to return in the response.  Currently, 1000 is the largest
     # supported limit. You can specify a limit  of up to 1000 bank accounts.
@@ -53,20 +50,18 @@ 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 details of a [BankAccount](#type-bankaccount) identified by V1
     # bank account ID.
-    # For more information, see
-    # [Retrieve a bank account by using an ID issued by V1 Bank Accounts
-    # API](https://developer.squareup.com/docs/docs/bank-accounts-api#retrieve-a
-    # -bank-account-by-using-an-id-issued-by-the-v1-bank-accounts-api).
     # @param [String] v1_bank_account_id Required parameter: Connect V1 ID of
     # the desired `BankAccount`. For more information, see  [Retrieve a bank
     # account by using an ID issued by V1 Bank Accounts
-    # API](https://developer.squareup.com/docs/docs/bank-accounts-api#retrieve-a
-    # -bank-account-by-using-an-id-issued-by-v1-bank-accounts-api).
+    # API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank
+    # -account-by-using-an-id-issued-by-v1-bank-accounts-api).
     # @return [GetBankAccountByV1IdResponse Hash] response from the API call
     def get_bank_account_by_v1_id(v1_bank_account_id:)
       # Prepare query url.
@@ -74,7 +69,7 @@ module Square
       _query_builder << '/v2/bank-accounts/by-v1-id/{v1_bank_account_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'v1_bank_account_id' => v1_bank_account_id
+        'v1_bank_account_id' => { 'value' => v1_bank_account_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -94,13 +89,13 @@ 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 details of a [BankAccount](#type-bankaccount)
-    # linked to a Square account. For more information, see
-    # [Bank Accounts
-    # API](https://developer.squareup.com/docs/docs/bank-accounts-api).
+    # linked to a Square account.
     # @param [String] bank_account_id Required parameter: Square-issued ID of
     # the desired `BankAccount`.
     # @return [GetBankAccountResponse Hash] response from the API call
@@ -110,7 +105,7 @@ module Square
       _query_builder << '/v2/bank-accounts/{bank_account_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'bank_account_id' => bank_account_id
+        'bank_account_id' => { 'value' => bank_account_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -130,7 +125,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/base_api.rb

@@ -8,7 +8,7 @@ module Square
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'Square-Ruby-SDK/6.4.0.20200923',
+        'user-agent' => 'Square-Ruby-SDK/9.0.0.20210226',
         'Square-Version' => config.square_version
       }
     end

data/lib/square/api/bookings_api.rb

@@ -0,0 +1,308 @@
+module Square
+  # BookingsApi
+  class BookingsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Creates a booking.
+    # @param [CreateBookingRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CreateBookingResponse Hash] response from the API call
+    def create_booking(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings'
+      _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 availabilities for booking.
+    # @param [SearchAvailabilityRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [SearchAvailabilityResponse Hash] response from the API call
+    def search_availability(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/availability/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
+
+    # Retrieves a seller's booking profile.
+    # @return [RetrieveBusinessBookingProfileResponse Hash] response from the API call
+    def retrieve_business_booking_profile
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/business-booking-profile'
+      _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
+
+    # Lists booking profiles for team members.
+    # @param [Boolean] bookable_only Optional parameter: Indicates whether to
+    # include only bookable team members in the returned result (`true`) or not
+    # (`false`).
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return.
+    # @param [String] cursor Optional parameter: The cursor for paginating
+    # through the results.
+    # @param [String] location_id Optional parameter: Indicates whether to
+    # include only team members enabled at the given location in the returned
+    # result.
+    # @return [ListTeamMemberBookingProfilesResponse Hash] response from the API call
+    def list_team_member_booking_profiles(bookable_only: false,
+                                          limit: nil,
+                                          cursor: nil,
+                                          location_id: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/team-member-booking-profiles'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'bookable_only' => bookable_only,
+        'limit' => limit,
+        'cursor' => cursor,
+        'location_id' => location_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
+
+    # Retrieves a team member's booking profile.
+    # @param [String] team_member_id Required parameter: The ID of the team
+    # member to retrieve.
+    # @return [RetrieveTeamMemberBookingProfileResponse Hash] response from the API call
+    def retrieve_team_member_booking_profile(team_member_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/team-member-booking-profiles/{team_member_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'team_member_id' => { 'value' => team_member_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
+
+    # Retrieves a booking.
+    # @param [String] booking_id Required parameter: The ID of the
+    # [Booking](#type-booking) object representing the to-be-retrieved
+    # booking.
+    # @return [RetrieveBookingResponse Hash] response from the API call
+    def retrieve_booking(booking_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/{booking_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'booking_id' => { 'value' => booking_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 a booking.
+    # @param [String] booking_id Required parameter: The ID of the
+    # [Booking](#type-booking) object representing the to-be-updated booking.
+    # @param [UpdateBookingRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [UpdateBookingResponse Hash] response from the API call
+    def update_booking(booking_id:,
+                       body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/{booking_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'booking_id' => { 'value' => booking_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 existing booking.
+    # @param [String] booking_id Required parameter: The ID of the
+    # [Booking](#type-booking) object representing the to-be-cancelled
+    # booking.
+    # @param [CancelBookingRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CancelBookingResponse Hash] response from the API call
+    def cancel_booking(booking_id:,
+                       body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/{booking_id}/cancel'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'booking_id' => { 'value' => booking_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