Merge pull request #118 from square/release/29.0.0.20230720

Generated PR for Release: 29.0.0.20230720

Author: jguze

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": "28.0.1.20230608",
+    "version": "29.0.0.20230720",
     "type": "library",
     "keywords": [
         "Square",

doc/apis/customers.md

@@ -35,7 +35,8 @@ function listCustomers(
     ?string $cursor = null,
     ?int $limit = null,
     ?string $sortField = null,
-    ?string $sortOrder = null
+    ?string $sortOrder = null,
+    ?bool $count = false
 ): ApiResponse
 ```
 
@@ -47,6 +48,7 @@ function listCustomers(
 | `limit` | `?int` | Query, Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.<br>If the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |
 | `sortField` | [`?string(CustomerSortField)`](../../doc/models/customer-sort-field.md) | Query, Optional | Indicates how customers should be sorted.<br><br>The default value is `DEFAULT`. |
 | `sortOrder` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Query, Optional | Indicates whether customers should be sorted in ascending (`ASC`) or<br>descending (`DESC`) order.<br><br>The default value is `ASC`. |
+| `count` | `?bool` | Query, Optional | Indicates whether to return the total count of customers in the `count` field of the response.<br><br>The default value is `false`.<br>**Default**: `false` |
 
 ## Response Type
 
@@ -55,7 +57,9 @@ This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` met
 ## Example Usage
 
 ```php
-$apiResponse = $customersApi->listCustomers();
+$count = false;
+
+$apiResponse = $customersApi->listCustomers($count);
 
 if ($apiResponse->isSuccess()) {
     $listCustomersResponse = $apiResponse->getResult();

doc/apis/invoices.md

@@ -124,6 +124,7 @@ $body = CreateInvoiceRequestBuilder::init(
                 ->squareGiftCard(false)
                 ->bankAccount(false)
                 ->buyNowPayLater(false)
+                ->cashAppPay(false)
                 ->build()
         )
         ->customFields(

doc/apis/refunds.md

@@ -41,7 +41,7 @@ function listPaymentRefunds(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `beginTime` | `?string` | Query, Optional | Indicates the start of the time range to retrieve each PaymentRefund`for, in RFC 3339 format. The range is determined using the`created_at`field for each`PaymentRefund`.<br><br>Default: The current time minus one year. |
+| `beginTime` | `?string` | Query, Optional | Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339<br>format.  The range is determined using the `created_at` field for each `PaymentRefund`.<br><br>Default: The current time minus one year. |
 | `endTime` | `?string` | Query, Optional | Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339<br>format.  The range is determined using the `created_at` field for each `PaymentRefund`.<br><br>Default: The current time. |
 | `sortOrder` | `?string` | Query, Optional | The order in which results are listed by `PaymentRefund.created_at`:<br><br>- `ASC` - Oldest to newest.<br>- `DESC` - Newest to oldest (default). |
 | `cursor` | `?string` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this cursor to retrieve the next set of results for the original query.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |

doc/apis/subscriptions.md

@@ -55,22 +55,23 @@ $body = CreateSubscriptionRequestBuilder::init(
     'CHFGVKYY8RSV93M5KCYTG4PN0G'
 )
     ->idempotencyKey('8193148c-9586-11e6-99f9-28cfe92138cf')
-    ->planId('6JHXF3B2CW3YKHDV4XEM674H')
-    ->startDate('2021-10-20')
-    ->taxPercentage('5')
-    ->priceOverrideMoney(
-        MoneyBuilder::init()
-            ->amount(100)
-            ->currency(Currency::USD)
-            ->build()
-    )
+    ->planVariationId('6JHXF3B2CW3YKHDV4XEM674H')
+    ->startDate('2023-06-20')
     ->cardId('ccof:qy5x8hHGYsgLrp4Q4GB')
     ->timezone('America/Los_Angeles')
     ->source(
         SubscriptionSourceBuilder::init()
-            ->name('My App')
+            ->name('My Application')
             ->build()
     )
+    ->phases(
+        [
+            PhaseBuilder::init()
+                ->ordinal(0)
+                ->orderTemplateId('U2NaowWxzXwpsZU697x7ZHOAnCNZY')
+                ->build()
+        ]
+    )
     ->build();
 
 $apiResponse = $subscriptionsApi->createSubscription($body);
@@ -478,7 +479,18 @@ This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` met
 ```php
 $subscriptionId = 'subscription_id0';
 
-$body = SwapPlanRequestBuilder::init()->build();
+$body = SwapPlanRequestBuilder::init()
+    ->newPlanVariationId('FQ7CDXXWSLUJRPM3GFJSJGZ7')
+    ->phases(
+        [
+            PhaseInputBuilder::init(
+                0
+            )
+                ->orderTemplateId('uhhnjH9osVv3shUADwaC0b3hNxQZY')
+                ->build()
+        ]
+    )
+    ->build();
 
 $apiResponse = $subscriptionsApi->swapPlan(
     $subscriptionId,

doc/client.md

@@ -5,7 +5,7 @@ The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `squareVersion` | `string` | Square Connect API versions<br>*Default*: `'2023-06-08'` |
+| `squareVersion` | `string` | Square Connect API versions<br>*Default*: `'2023-07-20'` |
 | `customUrl` | `string` | Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`<br>*Default*: `'https://connect.squareup.com'` |
 | `environment` | `string` | The API environment. <br> **Default: `production`** |
 | `timeout` | `int` | Timeout for API calls in seconds.<br>*Default*: `60` |
@@ -26,7 +26,7 @@ The API client can be initialized as follows:
 ```php
 $client = SquareClientBuilder::init()
     ->accessToken('AccessToken')
-    ->squareVersion('2023-06-08')
+    ->squareVersion('2023-07-20')
     ->environment('production')
     ->customUrl('https://connect.squareup.com')
     ->build();
@@ -51,7 +51,7 @@ use Square\SquareClientBuilder;
 
 $client = SquareClientBuilder::init()
     ->accessToken('AccessToken')
-    ->squareVersion('2023-06-08')
+    ->squareVersion('2023-07-20')
     ->build();
 
 $apiResponse = $client->getLocationsApi()->listLocations();

doc/models/accept-dispute-response.md

@@ -41,20 +41,20 @@ Defines the fields in an `AcceptDispute` response.
   },
   "errors": [
     {
-      "category": "AUTHENTICATION_ERROR",
-      "code": "REFUND_ALREADY_PENDING",
+      "category": "REFUND_ERROR",
+      "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND",
       "detail": "detail1",
       "field": "field9"
     },
     {
-      "category": "INVALID_REQUEST_ERROR",
-      "code": "PAYMENT_NOT_REFUNDABLE",
+      "category": "MERCHANT_SUBSCRIPTION_ERROR",
+      "code": "BAD_REQUEST",
       "detail": "detail2",
       "field": "field0"
     },
     {
-      "category": "RATE_LIMIT_ERROR",
-      "code": "REFUND_DECLINED",
+      "category": "EXTERNAL_VENDOR_ERROR",
+      "code": "MISSING_REQUIRED_PARAMETER",
       "detail": "detail3",
       "field": "field1"
     }

doc/models/accumulate-loyalty-points-response.md

@@ -56,20 +56,20 @@ Represents an [AccumulateLoyaltyPoints](../../doc/apis/loyalty.md#accumulate-loy
   ],
   "errors": [
     {
-      "category": "AUTHENTICATION_ERROR",
-      "code": "REFUND_ALREADY_PENDING",
+      "category": "REFUND_ERROR",
+      "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND",
       "detail": "detail1",
       "field": "field9"
     },
     {
-      "category": "INVALID_REQUEST_ERROR",
-      "code": "PAYMENT_NOT_REFUNDABLE",
+      "category": "MERCHANT_SUBSCRIPTION_ERROR",
+      "code": "BAD_REQUEST",
       "detail": "detail2",
       "field": "field0"
     },
     {
-      "category": "RATE_LIMIT_ERROR",
-      "code": "REFUND_DECLINED",
+      "category": "EXTERNAL_VENDOR_ERROR",
+      "code": "MISSING_REQUIRED_PARAMETER",
       "detail": "detail3",
       "field": "field1"
     }

doc/models/add-group-to-customer-response.md

@@ -20,20 +20,20 @@ a request to the [AddGroupToCustomer](../../doc/apis/customers.md#add-group-to-c
 {
   "errors": [
     {
-      "category": "AUTHENTICATION_ERROR",
-      "code": "REFUND_ALREADY_PENDING",
+      "category": "REFUND_ERROR",
+      "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND",
       "detail": "detail1",
       "field": "field9"
     },
     {
-      "category": "INVALID_REQUEST_ERROR",
-      "code": "PAYMENT_NOT_REFUNDABLE",
+      "category": "MERCHANT_SUBSCRIPTION_ERROR",
+      "code": "BAD_REQUEST",
       "detail": "detail2",
       "field": "field0"
     },
     {
-      "category": "RATE_LIMIT_ERROR",
-      "code": "REFUND_DECLINED",
+      "category": "EXTERNAL_VENDOR_ERROR",
+      "code": "MISSING_REQUIRED_PARAMETER",
       "detail": "detail3",
       "field": "field1"
     }

doc/models/additional-recipient.md

@@ -24,7 +24,7 @@ Represents an additional recipient (other than the merchant) receiving a portion
   "description": "description0",
   "amount_money": {
     "amount": 186,
-    "currency": "NGN"
+    "currency": "TZS"
   },
   "receivable_id": "receivable_id0"
 }