Merge pull request #113 from square/release/27.0.0.20230517

Author: joanc-sq

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,6 +7,9 @@ assignees: ''
 
 ---
 
+## **ATTENTION**
+This issue template is for **bugs** or **documentation** errors in this SDK Repo. Please direct all technical support questions, feature requests, API-related issues, and general discussions to our Square-supported developer channels. For public support, [join us in our BuildWithSquare Slack](https://squ.re/slack) or [post in our Developer Forums](https://developer.squareup.com/forums). For private support, [contact our Developer Success Engineers](https://squareup.com/help/us/en/contact?panel=BF53A9C8EF68) directly.
+
 **Describe the bug**
 A clear and concise description of what the bug is.
 
@@ -27,4 +30,4 @@ If applicable, add screenshots to help explain the bug.
 For example:  17.2.x
 
 **Additional context**
-Add any other context about the problem here.
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Square Developer Forums
+    url: https://developer.squareup.com/forums
+    about: Public discussion threads for technical support, feature requests, api discussion, and all things related to square development.
+  - name: BuildWithSquare Slack Channel
+    url: https://squ.re/slack
+    about: Community slack channel for real time support and conversations about building with square.
+  - name: Developer Support
+    url: https://squareup.com/help/us/en/contact?panel=BF53A9C8EF68
+    about: Private support directly with Square Developer Success Engineers.

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "square/square",
     "description": "Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.",
-    "version": "26.0.0.20230419",
+    "version": "27.0.0.20230517",
     "type": "library",
     "keywords": [
         "Square",
@@ -24,7 +24,7 @@
         "ext-json": "*",
         "apimatic/unirest-php": "^4.0.0",
         "apimatic/core-interfaces": "~0.1.0",
-        "apimatic/core": "~0.2.0"
+        "apimatic/core": "~0.3.0"
     },
     "require-dev": {
         "squizlabs/php_codesniffer": "^3.5",

doc/apis/apple-pay.md

@@ -35,7 +35,7 @@ function registerDomain(RegisterDomainRequest $body): ApiResponse
 
 ## Response Type
 
-[`RegisterDomainResponse`](../../doc/models/register-domain-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`RegisterDomainResponse`](../../doc/models/register-domain-response.md).
 
 ## Example Usage
 

doc/apis/bank-accounts.md

@@ -33,7 +33,7 @@ function listBankAccounts(?string $cursor = null, ?int $limit = null, ?string $l
 
 ## Response Type
 
-[`ListBankAccountsResponse`](../../doc/models/list-bank-accounts-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`ListBankAccountsResponse`](../../doc/models/list-bank-accounts-response.md).
 
 ## Example Usage
 
@@ -68,7 +68,7 @@ function getBankAccountByV1Id(string $v1BankAccountId): ApiResponse
 
 ## Response Type
 
-[`GetBankAccountByV1IdResponse`](../../doc/models/get-bank-account-by-v1-id-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`GetBankAccountByV1IdResponse`](../../doc/models/get-bank-account-by-v1-id-response.md).
 
 ## Example Usage
 
@@ -106,7 +106,7 @@ function getBankAccount(string $bankAccountId): ApiResponse
 
 ## Response Type
 
-[`GetBankAccountResponse`](../../doc/models/get-bank-account-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`GetBankAccountResponse`](../../doc/models/get-bank-account-response.md).
 
 ## Example Usage
 

doc/apis/booking-custom-attributes.md

@@ -43,7 +43,7 @@ function listBookingCustomAttributeDefinitions(?int $limit = null, ?string $curs
 
 ## Response Type
 
-[`ListBookingCustomAttributeDefinitionsResponse`](../../doc/models/list-booking-custom-attribute-definitions-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`ListBookingCustomAttributeDefinitionsResponse`](../../doc/models/list-booking-custom-attribute-definitions-response.md).
 
 ## Example Usage
 
@@ -86,7 +86,7 @@ function createBookingCustomAttributeDefinition(
 
 ## Response Type
 
-[`CreateBookingCustomAttributeDefinitionResponse`](../../doc/models/create-booking-custom-attribute-definition-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`CreateBookingCustomAttributeDefinitionResponse`](../../doc/models/create-booking-custom-attribute-definition-response.md).
 
 ## Example Usage
 
@@ -131,7 +131,7 @@ function deleteBookingCustomAttributeDefinition(string $key): ApiResponse
 
 ## Response Type
 
-[`DeleteBookingCustomAttributeDefinitionResponse`](../../doc/models/delete-booking-custom-attribute-definition-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`DeleteBookingCustomAttributeDefinitionResponse`](../../doc/models/delete-booking-custom-attribute-definition-response.md).
 
 ## Example Usage
 
@@ -172,7 +172,7 @@ function retrieveBookingCustomAttributeDefinition(string $key, ?int $version = n
 
 ## Response Type
 
-[`RetrieveBookingCustomAttributeDefinitionResponse`](../../doc/models/retrieve-booking-custom-attribute-definition-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`RetrieveBookingCustomAttributeDefinitionResponse`](../../doc/models/retrieve-booking-custom-attribute-definition-response.md).
 
 ## Example Usage
 
@@ -219,7 +219,7 @@ function updateBookingCustomAttributeDefinition(
 
 ## Response Type
 
-[`UpdateBookingCustomAttributeDefinitionResponse`](../../doc/models/update-booking-custom-attribute-definition-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`UpdateBookingCustomAttributeDefinitionResponse`](../../doc/models/update-booking-custom-attribute-definition-response.md).
 
 ## Example Usage
 
@@ -269,7 +269,7 @@ function bulkDeleteBookingCustomAttributes(BulkDeleteBookingCustomAttributesRequ
 
 ## Response Type
 
-[`BulkDeleteBookingCustomAttributesResponse`](../../doc/models/bulk-delete-booking-custom-attributes-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`BulkDeleteBookingCustomAttributesResponse`](../../doc/models/bulk-delete-booking-custom-attributes-response.md).
 
 ## Example Usage
 
@@ -323,7 +323,7 @@ function bulkUpsertBookingCustomAttributes(BulkUpsertBookingCustomAttributesRequ
 
 ## Response Type
 
-[`BulkUpsertBookingCustomAttributesResponse`](../../doc/models/bulk-upsert-booking-custom-attributes-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`BulkUpsertBookingCustomAttributesResponse`](../../doc/models/bulk-upsert-booking-custom-attributes-response.md).
 
 ## Example Usage
 
@@ -382,7 +382,7 @@ function listBookingCustomAttributes(
 
 ## Response Type
 
-[`ListBookingCustomAttributesResponse`](../../doc/models/list-booking-custom-attributes-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`ListBookingCustomAttributesResponse`](../../doc/models/list-booking-custom-attributes-response.md).
 
 ## Example Usage
 
@@ -431,7 +431,7 @@ function deleteBookingCustomAttribute(string $bookingId, string $key): ApiRespon
 
 ## Response Type
 
-[`DeleteBookingCustomAttributeResponse`](../../doc/models/delete-booking-custom-attribute-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`DeleteBookingCustomAttributeResponse`](../../doc/models/delete-booking-custom-attribute-response.md).
 
 ## Example Usage
 
@@ -484,7 +484,7 @@ function retrieveBookingCustomAttribute(
 
 ## Response Type
 
-[`RetrieveBookingCustomAttributeResponse`](../../doc/models/retrieve-booking-custom-attribute-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`RetrieveBookingCustomAttributeResponse`](../../doc/models/retrieve-booking-custom-attribute-response.md).
 
 ## Example Usage
 
@@ -541,7 +541,7 @@ function upsertBookingCustomAttribute(
 
 ## Response Type
 
-[`UpsertBookingCustomAttributeResponse`](../../doc/models/upsert-booking-custom-attribute-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`UpsertBookingCustomAttributeResponse`](../../doc/models/upsert-booking-custom-attribute-response.md).
 
 ## Example Usage
 

doc/apis/bookings.md

@@ -52,7 +52,7 @@ function listBookings(
 
 ## Response Type
 
-[`ListBookingsResponse`](../../doc/models/list-bookings-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`ListBookingsResponse`](../../doc/models/list-bookings-response.md).
 
 ## Example Usage
 
@@ -101,7 +101,7 @@ function createBooking(CreateBookingRequest $body): ApiResponse
 
 ## Response Type
 
-[`CreateBookingResponse`](../../doc/models/create-booking-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`CreateBookingResponse`](../../doc/models/create-booking-response.md).
 
 ## Example Usage
 
@@ -143,7 +143,7 @@ function searchAvailability(SearchAvailabilityRequest $body): ApiResponse
 
 ## Response Type
 
-[`SearchAvailabilityResponse`](../../doc/models/search-availability-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`SearchAvailabilityResponse`](../../doc/models/search-availability-response.md).
 
 ## Example Usage
 
@@ -180,7 +180,7 @@ function retrieveBusinessBookingProfile(): ApiResponse
 
 ## Response Type
 
-[`RetrieveBusinessBookingProfileResponse`](../../doc/models/retrieve-business-booking-profile-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`RetrieveBusinessBookingProfileResponse`](../../doc/models/retrieve-business-booking-profile-response.md).
 
 ## Example Usage
 
@@ -223,7 +223,7 @@ function listTeamMemberBookingProfiles(
 
 ## Response Type
 
-[`ListTeamMemberBookingProfilesResponse`](../../doc/models/list-team-member-booking-profiles-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`ListTeamMemberBookingProfilesResponse`](../../doc/models/list-team-member-booking-profiles-response.md).
 
 ## Example Usage
 
@@ -260,7 +260,7 @@ function retrieveTeamMemberBookingProfile(string $teamMemberId): ApiResponse
 
 ## Response Type
 
-[`RetrieveTeamMemberBookingProfileResponse`](../../doc/models/retrieve-team-member-booking-profile-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`RetrieveTeamMemberBookingProfileResponse`](../../doc/models/retrieve-team-member-booking-profile-response.md).
 
 ## Example Usage
 
@@ -300,7 +300,7 @@ function retrieveBooking(string $bookingId): ApiResponse
 
 ## Response Type
 
-[`RetrieveBookingResponse`](../../doc/models/retrieve-booking-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`RetrieveBookingResponse`](../../doc/models/retrieve-booking-response.md).
 
 ## Example Usage
 
@@ -344,7 +344,7 @@ function updateBooking(string $bookingId, UpdateBookingRequest $body): ApiRespon
 
 ## Response Type
 
-[`UpdateBookingResponse`](../../doc/models/update-booking-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`UpdateBookingResponse`](../../doc/models/update-booking-response.md).
 
 ## Example Usage
 
@@ -395,7 +395,7 @@ function cancelBooking(string $bookingId, CancelBookingRequest $body): ApiRespon
 
 ## Response Type
 
-[`CancelBookingResponse`](../../doc/models/cancel-booking-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`CancelBookingResponse`](../../doc/models/cancel-booking-response.md).
 
 ## Example Usage
 

doc/apis/cards.md

@@ -43,7 +43,7 @@ function listCards(
 
 ## Response Type
 
-[`ListCardsResponse`](../../doc/models/list-cards-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`ListCardsResponse`](../../doc/models/list-cards-response.md).
 
 ## Example Usage
 
@@ -80,7 +80,7 @@ function createCard(CreateCardRequest $body): ApiResponse
 
 ## Response Type
 
-[`CreateCardResponse`](../../doc/models/create-card-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`CreateCardResponse`](../../doc/models/create-card-response.md).
 
 ## Example Usage
 
@@ -135,7 +135,7 @@ function retrieveCard(string $cardId): ApiResponse
 
 ## Response Type
 
-[`RetrieveCardResponse`](../../doc/models/retrieve-card-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`RetrieveCardResponse`](../../doc/models/retrieve-card-response.md).
 
 ## Example Usage
 
@@ -173,7 +173,7 @@ function disableCard(string $cardId): ApiResponse
 
 ## Response Type
 
-[`DisableCardResponse`](../../doc/models/disable-card-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`DisableCardResponse`](../../doc/models/disable-card-response.md).
 
 ## Example Usage
 

doc/apis/cash-drawers.md

@@ -44,7 +44,7 @@ function listCashDrawerShifts(
 
 ## Response Type
 
-[`ListCashDrawerShiftsResponse`](../../doc/models/list-cash-drawer-shifts-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`ListCashDrawerShiftsResponse`](../../doc/models/list-cash-drawer-shifts-response.md).
 
 ## Example Usage
 
@@ -83,7 +83,7 @@ function retrieveCashDrawerShift(string $locationId, string $shiftId): ApiRespon
 
 ## Response Type
 
-[`RetrieveCashDrawerShiftResponse`](../../doc/models/retrieve-cash-drawer-shift-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`RetrieveCashDrawerShiftResponse`](../../doc/models/retrieve-cash-drawer-shift-response.md).
 
 ## Example Usage
 
@@ -133,7 +133,7 @@ function listCashDrawerShiftEvents(
 
 ## Response Type
 
-[`ListCashDrawerShiftEventsResponse`](../../doc/models/list-cash-drawer-shift-events-response.md)
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`ListCashDrawerShiftEventsResponse`](../../doc/models/list-cash-drawer-shift-events-response.md).
 
 ## Example Usage