Merge pull request #117 from square/release/2.20200122.0

Release 2.20200122.0

CHANGES.md

@@ -1,6 +1,13 @@
 # Change Log
 
-## Version 2.20191217.0 (2019-12-17)
+## Version 2.20200122.0 (2020-01-22)
+* New field:  The **Employee** object now has an `is_owner` field.
+* New field:  The **Card** enumeration has a new `SQUARE_CAPITAL_CARD` enum value to support a Square one-time Installments payment.
+
+* New request body field constraint: The **Refund Payment** request now required a non-empty string when the `payment_id` is supplied. 
+
+
+## Version 2.3.0.20191217 (2019-12-17)
 !!!important
 Square is excited to announce the public release of customized SDKs for [Java](https://github.com/square/square-java-sdk) and [.NET](https://github.com/square/square-dotnet-sdk). For more information, see [Square SDKs](/sdks).
 !!!

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "square/connect",
-    "version": "2.20191217.1",
+    "version": "2.20200122.0",
     "description": "PHP client library for the Square Connect v2 API",
     "keywords": [
         "swagger",

docs/Api/V1TransactionsApi.md

@@ -303,11 +303,11 @@ require_once(__DIR__ . '/vendor/autoload.php');
 SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
 
 $apiInstance = new SquareConnect\Api\V1TransactionsApi();
-$location_id = "location_id_example"; // string | The ID of the location to list settlements for.
-$order = "order_example"; // string | TThe order in which payments are listed in the response.
+$location_id = "location_id_example"; // string | The ID of the location to list settlements for. If you specify me, this endpoint returns settlements aggregated from all of the business's locations.
+$order = "order_example"; // string | The order in which settlements are listed in the response.
 $begin_time = "begin_time_example"; // string | The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.
 $end_time = "end_time_example"; // string | The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.
-$limit = 56; // int | The maximum number of payments to return in a single response. This value cannot exceed 200.
+$limit = 56; // int | The maximum number of settlements to return in a single response. This value cannot exceed 200.
 $status = "status_example"; // string | Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED).
 $batch_token = "batch_token_example"; // string | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
 
@@ -324,11 +324,11 @@ try {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **location_id** | **string**| The ID of the location to list settlements for. |
- **order** | **string**| TThe order in which payments are listed in the response. | [optional]
+ **location_id** | **string**| The ID of the location to list settlements for. If you specify me, this endpoint returns settlements aggregated from all of the business's locations. |
+ **order** | **string**| The order in which settlements are listed in the response. | [optional]
  **begin_time** | **string**| The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year. | [optional]
  **end_time** | **string**| The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. | [optional]
- **limit** | **int**| The maximum number of payments to return in a single response. This value cannot exceed 200. | [optional]
+ **limit** | **int**| The maximum number of settlements to return in a single response. This value cannot exceed 200. | [optional]
  **status** | **string**| Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED). | [optional]
  **batch_token** | **string**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional]
 

docs/Model/CardBrand.md

@@ -16,6 +16,7 @@ Name | Type
 **JCB** | string
 **CHINA_UNIONPAY** | string
 **SQUARE_GIFT_CARD** | string
+**SQUARE_CAPITAL_CARD** | string
 
 Note: All properties are protected and only accessed via getters and setters.
 

docs/Model/Employee.md

@@ -14,6 +14,7 @@ Name | Getter | Setter | Type | Description | Notes
 **phone_number** | getPhoneNumber() | setPhoneNumber($value) | **string** | The employee's phone number in E.164 format, i.e. \"+12125554250\" | [optional] 
 **location_ids** | getLocationIds() | setLocationIds($value) | **string[]** | A list of location IDs where this employee has access to. | [optional] 
 **status** | getStatus() | setStatus($value) | **string** | Specifies the status of the employees being fetched. See [EmployeeStatus](#type-employeestatus) for possible values | [optional] 
+**is_owner** | getIsOwner() | setIsOwner($value) | **bool** | Whether this employee is the owner of the merchant. Each merchant has one owner employee, and that employee has full authority over the account. | [optional] 
 **created_at** | getCreatedAt() | setCreatedAt($value) | **string** | A read-only timestamp in RFC 3339 format. | [optional] 
 **updated_at** | getUpdatedAt() | setUpdatedAt($value) | **string** | A read-only timestamp in RFC 3339 format. | [optional] 
 

docs/Model/ErrorCode.md

@@ -101,9 +101,6 @@ Name | Type
 **BAD_CERTIFICATE** | string
 **INVALID_SQUARE_VERSION_FORMAT** | string
 **API_VERSION_INCOMPATIBLE** | string
-**INVALID_URL** | string
-**HTTPS_ONLY** | string
-**UNREACHABLE_URL** | string
 **CARD_DECLINED** | string
 **VERIFY_CVV_FAILURE** | string
 **VERIFY_AVS_FAILURE** | string

docs/Model/RefundPaymentRequest.md

@@ -10,7 +10,7 @@ Name | Getter | Setter | Type | Description | Notes
 **idempotency_key** | getIdempotencyKey() | setIdempotencyKey($value) | **string** | A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency). | 
 **amount_money** | getAmountMoney() | setAmountMoney($value) | [**\SquareConnect\Model\Money**](Money.md) | The amount of money to refund.  Cannot be more than the `total_money` value of the payment minus the total amount of all previously completed refunds for this payment.  Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details.  The currency code must match the currency associated with the business that is charging the card. | 
 **app_fee_money** | getAppFeeMoney() | setAppFeeMoney($value) | [**\SquareConnect\Model\Money**](Money.md) | Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents.  Value cannot be more than the `amount_money`.  You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee  scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees) | [optional] 
-**payment_id** | getPaymentId() | setPaymentId($value) | **string** | Unique ID of the payment being refunded. | [optional] 
+**payment_id** | getPaymentId() | setPaymentId($value) | **string** | Unique ID of the payment being refunded. | 
 **reason** | getReason() | setReason($value) | **string** | A description of the reason for the refund. | [optional] 
 
 Note: All properties are protected and only accessed via getters and setters.

docs/Model/V1ListSettlementsRequest.md

@@ -7,10 +7,10 @@
 ## Properties
 Name | Getter | Setter | Type | Description | Notes
 ------------ | ------------- | ------------- | ------------- | ------------- | -------------
-**order** | getOrder() | setOrder($value) | **string** | TThe order in which payments are listed in the response. See [SortOrder](#type-sortorder) for possible values | [optional] 
+**order** | getOrder() | setOrder($value) | **string** | The order in which settlements are listed in the response. See [SortOrder](#type-sortorder) for possible values | [optional] 
 **begin_time** | getBeginTime() | setBeginTime($value) | **string** | The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year. | [optional] 
 **end_time** | getEndTime() | setEndTime($value) | **string** | The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. | [optional] 
-**limit** | getLimit() | setLimit($value) | **int** | The maximum number of payments to return in a single response. This value cannot exceed 200. | [optional] 
+**limit** | getLimit() | setLimit($value) | **int** | The maximum number of settlements to return in a single response. This value cannot exceed 200. | [optional] 
 **status** | getStatus() | setStatus($value) | **string** | Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED). See [V1ListSettlementsRequestStatus](#type-v1listsettlementsrequeststatus) for possible values | [optional] 
 **batch_token** | getBatchToken() | setBatchToken($value) | **string** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
 

lib/Api/ApplePayApi.php

@@ -108,7 +108,7 @@ public function registerDomainWithHttpInfo($body)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 

lib/Api/CashDrawersApi.php

@@ -119,7 +119,7 @@ public function listCashDrawerShiftEventsWithHttpInfo($location_id, $shift_id, $
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
         // query params
         if ($location_id !== null) {
@@ -235,7 +235,7 @@ public function listCashDrawerShiftsWithHttpInfo($location_id, $sort_order = nul
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
         // query params
         if ($location_id !== null) {
@@ -349,7 +349,7 @@ public function retrieveCashDrawerShiftWithHttpInfo($location_id, $shift_id)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
         // query params
         if ($location_id !== null) {

lib/Api/CatalogApi.php

@@ -108,7 +108,7 @@ public function batchDeleteCatalogObjectsWithHttpInfo($body)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 
@@ -201,7 +201,7 @@ public function batchRetrieveCatalogObjectsWithHttpInfo($body)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 
@@ -294,7 +294,7 @@ public function batchUpsertCatalogObjectsWithHttpInfo($body)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 
@@ -381,7 +381,7 @@ public function catalogInfoWithHttpInfo()
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 
@@ -470,7 +470,7 @@ public function deleteCatalogObjectWithHttpInfo($object_id)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 
@@ -564,7 +564,7 @@ public function listCatalogWithHttpInfo($cursor = null, $types = null)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
         // query params
         if ($cursor !== null) {
@@ -661,7 +661,7 @@ public function retrieveCatalogObjectWithHttpInfo($object_id, $include_related_o
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
         // query params
         if ($include_related_objects !== null) {
@@ -760,7 +760,7 @@ public function searchCatalogObjectsWithHttpInfo($body)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 
@@ -853,7 +853,7 @@ public function updateItemModifierListsWithHttpInfo($body)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 
@@ -946,7 +946,7 @@ public function updateItemTaxesWithHttpInfo($body)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 
@@ -1039,7 +1039,7 @@ public function upsertCatalogObjectWithHttpInfo($body)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 

lib/Api/CheckoutApi.php

@@ -114,7 +114,7 @@ public function createCheckoutWithHttpInfo($location_id, $body)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 

lib/Api/CustomersApi.php

@@ -108,7 +108,7 @@ public function createCustomerWithHttpInfo($body)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 
@@ -207,7 +207,7 @@ public function createCustomerCardWithHttpInfo($customer_id, $body)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 
@@ -307,7 +307,7 @@ public function deleteCustomerWithHttpInfo($customer_id)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 
@@ -409,7 +409,7 @@ public function deleteCustomerCardWithHttpInfo($customer_id, $card_id)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 
@@ -512,7 +512,7 @@ public function listCustomersWithHttpInfo($cursor = null, $sort_field = null, $s
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
         // query params
         if ($cursor !== null) {
@@ -610,7 +610,7 @@ public function retrieveCustomerWithHttpInfo($customer_id)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 
@@ -706,7 +706,7 @@ public function searchCustomersWithHttpInfo($body)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 
@@ -805,7 +805,7 @@ public function updateCustomerWithHttpInfo($customer_id, $body)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
 
 

lib/Api/EmployeesApi.php

@@ -110,7 +110,7 @@ public function listEmployeesWithHttpInfo($location_id = null, $status = null, $
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";
 
         // query params
         if ($location_id !== null) {
@@ -211,7 +211,7 @@ public function retrieveEmployeeWithHttpInfo($id)
             $headerParams['Accept'] = $_header_accept;
         }
         $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array('application/json'));
-        $headerParams['Square-Version'] = "2019-12-17";
+        $headerParams['Square-Version'] = "2020-01-22";