Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.

Commit 0da61b1

Browse files
square-sdk-deployersquare-sdk-deployer
committed
Release 3.20200325.0
1 parent ac7b863 commit 0da61b1

File tree

74 files changed

+2469
-510
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+2469
-510
lines changed

‎CHANGES.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Change Log
22

3+
## Version 3.20200325.0 (2020-03-25)
4+
## Existing API updates
5+
* **[Payments API](${SQUARE_TECH_REF}/payments-api).** In support of the existing [Delayed capture](payments-api/take-payments) for payments, the following fields are added to the [Payment](${SQUARE_TECH_REF}/objects/Payment) type:
6+
* `delay_duration`. In a [CreatePayment](${SQUARE_TECH_REF}/payments-api/create-payment) request, you can set `autocomplete` to false to get payment approval but not charge the payment source. You can now add this field to specify a time period to complete (or cancel) the payment. For more information, see [Delay capture](payments-api/take-payments).
7+
* `delay_action`. Defines the action that Square takes on the payment when the `delay_duration` elapses. In this release, the API supports only the cancel payment action.
8+
* `delayed_until`. Provides the date and time on Square servers when Square applies `delay_action` on the payment.
9+
10+
311
## Version 3.20200226.0 (2020-02-26)
412
## API releases
513
* **GA release**: All SDKs have been updated to support the new Bank Accounts and CashDrawerShifts APIs.

‎README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -372,8 +372,15 @@ Class | Method | HTTP request | Description
372372
- [CashDrawerShiftEvent](docs/Model/CashDrawerShiftEvent.md)
373373
- [CashDrawerShiftState](docs/Model/CashDrawerShiftState.md)
374374
- [CashDrawerShiftSummary](docs/Model/CashDrawerShiftSummary.md)
375-
- [CashPaymentDetails](docs/Model/CashPaymentDetails.md)
376375
- [CatalogCategory](docs/Model/CatalogCategory.md)
376+
- [CatalogCustomAttributeDefinition](docs/Model/CatalogCustomAttributeDefinition.md)
377+
- [CatalogCustomAttributeDefinitionAppVisibility](docs/Model/CatalogCustomAttributeDefinitionAppVisibility.md)
378+
- [CatalogCustomAttributeDefinitionSelectionConfig](docs/Model/CatalogCustomAttributeDefinitionSelectionConfig.md)
379+
- [CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection](docs/Model/CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection.md)
380+
- [CatalogCustomAttributeDefinitionSellerVisibility](docs/Model/CatalogCustomAttributeDefinitionSellerVisibility.md)
381+
- [CatalogCustomAttributeDefinitionStringConfig](docs/Model/CatalogCustomAttributeDefinitionStringConfig.md)
382+
- [CatalogCustomAttributeDefinitionType](docs/Model/CatalogCustomAttributeDefinitionType.md)
383+
- [CatalogCustomAttributeValue](docs/Model/CatalogCustomAttributeValue.md)
377384
- [CatalogDiscount](docs/Model/CatalogDiscount.md)
378385
- [CatalogDiscountModifyTaxBasis](docs/Model/CatalogDiscountModifyTaxBasis.md)
379386
- [CatalogDiscountType](docs/Model/CatalogDiscountType.md)
@@ -494,7 +501,6 @@ Class | Method | HTTP request | Description
494501
- [ErrorCategory](docs/Model/ErrorCategory.md)
495502
- [ErrorCode](docs/Model/ErrorCode.md)
496503
- [ExcludeStrategy](docs/Model/ExcludeStrategy.md)
497-
- [ExternalPaymentDetails](docs/Model/ExternalPaymentDetails.md)
498504
- [GetBankAccountByV1IdRequest](docs/Model/GetBankAccountByV1IdRequest.md)
499505
- [GetBankAccountByV1IdResponse](docs/Model/GetBankAccountByV1IdResponse.md)
500506
- [GetBankAccountRequest](docs/Model/GetBankAccountRequest.md)

‎composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "square/connect",
3-
"version": "3.20200226.0",
3+
"version": "3.20200325.0",
44
"description": "PHP client library for the Square Connect v2 API",
55
"keywords": [
66
"swagger",

‎docs/Api/CashDrawersApi.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ Method | HTTP request | Description
1010

1111

1212
# **listCashDrawerShiftEvents**
13-
**Note: This endpoint is in beta.**
1413
> \SquareConnect\Model\ListCashDrawerShiftEventsResponse listCashDrawerShiftEvents($location_id, $shift_id, $limit, $cursor)
1514
1615
ListCashDrawerShiftEvents
@@ -65,7 +64,6 @@ Name | Type | Description | Notes
6564
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
6665

6766
# **listCashDrawerShifts**
68-
**Note: This endpoint is in beta.**
6967
> \SquareConnect\Model\ListCashDrawerShiftsResponse listCashDrawerShifts($location_id, $sort_order, $begin_time, $end_time, $limit, $cursor)
7068
7169
ListCashDrawerShifts
@@ -124,7 +122,6 @@ Name | Type | Description | Notes
124122
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
125123

126124
# **retrieveCashDrawerShift**
127-
**Note: This endpoint is in beta.**
128125
> \SquareConnect\Model\RetrieveCashDrawerShiftResponse retrieveCashDrawerShift($location_id, $shift_id)
129126
130127
RetrieveCashDrawerShift

‎docs/Api/PaymentsApi.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Name | Type | Description | Notes
109109
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
110110

111111
# **completePayment**
112-
> \SquareConnect\Model\CompletePaymentResponse completePayment($payment_id)
112+
> \SquareConnect\Model\CompletePaymentResponse completePayment($payment_id, $body)
113113
114114
CompletePayment
115115

@@ -125,9 +125,10 @@ SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACC
125125

126126
$apiInstance = new SquareConnect\Api\PaymentsApi();
127127
$payment_id = "payment_id_example"; // string | Unique ID identifying the payment to be completed.
128+
$body = new \SquareConnect\Model\CompletePaymentRequest(); // \SquareConnect\Model\CompletePaymentRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details.
128129

129130
try {
130-
$result = $apiInstance->completePayment($payment_id);
131+
$result = $apiInstance->completePayment($payment_id, $body);
131132
print_r($result);
132133
} catch (Exception $e) {
133134
echo 'Exception when calling PaymentsApi->completePayment: ', $e->getMessage(), PHP_EOL;
@@ -140,6 +141,7 @@ try {
140141
Name | Type | Description | Notes
141142
------------- | ------------- | ------------- | -------------
142143
**payment_id** | **string**| Unique ID identifying the payment to be completed. |
144+
**body** | [**\SquareConnect\Model\CompletePaymentRequest**](../Model/CompletePaymentRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. |
143145

144146
### Return type
145147

‎docs/Model/CashPaymentDetails.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎docs/Model/CatalogCustomAttributeDefinition.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# CatalogCustomAttributeDefinition
2+
3+
### Description
4+
5+
Contains information defining a custom attribute. Custom attributes are intended to store additional information about a catalog object or to associate a catalog object with an entity in another system. Do not use custom attributes to store any sensitive information (personally identifiable information, card details, etc.). [Read more about custom attributes](/catalog-api/add-custom-attributes)
6+
7+
## Properties
8+
Name | Getter | Setter | Type | Description | Notes
9+
------------ | ------------- | ------------- | ------------- | ------------- | -------------
10+
**type** | getType() | setType($value) | **string** | The type of this custom attribute. Cannot be modified after creation. Required. See [CatalogCustomAttributeDefinitionType](#type-catalogcustomattributedefinitiontype) for possible values |
11+
**name** | getName() | setName($value) | **string** | The name of this definition for API and seller-facing UI purposes. The name must be unique within the (merchant, application_id) pair. Required. May not be empty and may not exceed 255 characters. Can be modified after creation. |
12+
**description** | getDescription() | setDescription($value) | **string** | Seller-oriented description of the meaning of this Custom Attribute, any constraints that the seller should observe, etc. May be displayed as a tooltip in Square UIs. | [optional]
13+
**source_application** | getSourceApplication() | setSourceApplication($value) | [**\SquareConnect\Model\SourceApplication**](SourceApplication.md) | __Read only.__ Contains information about the application that created this custom attribute definition. | [optional]
14+
**allowed_object_types** | getAllowedObjectTypes() | setAllowedObjectTypes($value) | **string[]** | The set of Catalog Object Types that this Custom Attribute may be applied to. Currently, only `ITEM` and `ITEM_VARIATION` are allowed. See [CatalogObjectType](#type-catalogobjecttype) for possible values | [optional]
15+
**seller_visibility** | getSellerVisibility() | setSellerVisibility($value) | **string** | The visibility of a custom attribute in seller-facing UIs (including Square Point of Sale applications and Square Dashboard). May be modified. See [CatalogCustomAttributeDefinitionSellerVisibility](#type-catalogcustomattributedefinitionsellervisibility) for possible values | [optional]
16+
**app_visibility** | getAppVisibility() | setAppVisibility($value) | **string** | The visibility of a custom attribute to applications other than the application that created the attribute. See [CatalogCustomAttributeDefinitionAppVisibility](#type-catalogcustomattributedefinitionappvisibility) for possible values | [optional]
17+
**string_config** | getStringConfig() | setStringConfig($value) | [**\SquareConnect\Model\CatalogCustomAttributeDefinitionStringConfig**](CatalogCustomAttributeDefinitionStringConfig.md) | Optionally, populated when `type` = `STRING`, unset otherwise. | [optional]
18+
**selection_config** | getSelectionConfig() | setSelectionConfig($value) | [**\SquareConnect\Model\CatalogCustomAttributeDefinitionSelectionConfig**](CatalogCustomAttributeDefinitionSelectionConfig.md) | Populated when `type` is set to `SELECTION`, unset otherwise. | [optional]
19+
**custom_attribute_usage_count** | getCustomAttributeUsageCount() | setCustomAttributeUsageCount($value) | **int** | __Read-only.__ The number of custom attributes that reference this custom attribute definition. Set by the server in response to a ListCatalog request with `include_counts` set to `true`. If the actual count is greater than 100, `custom_attribute_usage_count` will be set to `100`. | [optional]
20+
**key** | getKey() | setKey($value) | **string** | The name of the desired custom attribute key that can be used to access the custom attribute value on catalog objects. Cannot be modified after the custom attribute definition has been created. | [optional]
21+
22+
Note: All properties are protected and only accessed via getters and setters.
23+
24+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
25+

‎docs/Model/CatalogCustomAttributeDefinitionAppVisibility.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# CatalogCustomAttributeDefinitionAppVisibility
2+
3+
### Description
4+
5+
Defines the visibility of a custom attribute to applications other than their creating application.
6+
7+
## Properties
8+
Name | Type
9+
------------ | -------------
10+
**APP_VISIBILITY_HIDDEN** | string
11+
**APP_VISIBILITY_READ_ONLY** | string
12+
**APP_VISIBILITY_READ_WRITE_VALUES** | string
13+
14+
Note: All properties are protected and only accessed via getters and setters.
15+
16+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
17+

‎docs/Model/CatalogCustomAttributeDefinitionSelectionConfig.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# CatalogCustomAttributeDefinitionSelectionConfig
2+
3+
### Description
4+
5+
Configuration associated with `SELECTION`-type custom attribute definitions.
6+
7+
## Properties
8+
Name | Getter | Setter | Type | Description | Notes
9+
------------ | ------------- | ------------- | ------------- | ------------- | -------------
10+
**max_allowed_selections** | getMaxAllowedSelections() | setMaxAllowedSelections($value) | **int** | The maximum number of selections that can be set. The maximum value for this attribute is 100. May be modified, but changing the value will not affect existing custom attribute values on objects. Clients need to handle Custom Attributes with more selected values than allowed by this limit. | [optional]
11+
**allowed_selections** | getAllowedSelections() | setAllowedSelections($value) | [**\SquareConnect\Model\CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection[]**](CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection.md) | The set of valid `CatalogCustomAttributeSelections`. Up to a maximum of 100 selections can be defined. Can be modified. | [optional]
12+
13+
Note: All properties are protected and only accessed via getters and setters.
14+
15+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
16+

‎docs/Model/CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection
2+
3+
### Description
4+
5+
A named selection for this `SELECTION`-type custom attribute definition.
6+
7+
## Properties
8+
Name | Getter | Setter | Type | Description | Notes
9+
------------ | ------------- | ------------- | ------------- | ------------- | -------------
10+
**uid** | getUid() | setUid($value) | **string** | Unique ID set by Square. | [optional]
11+
**name** | getName() | setName($value) | **string** | Selection name, unique within `allowed_selections`. Required. Min length of 1, max length of 255. |
12+
13+
Note: All properties are protected and only accessed via getters and setters.
14+
15+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
16+

‎docs/Model/CatalogCustomAttributeDefinitionSellerVisibility.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# CatalogCustomAttributeDefinitionSellerVisibility
2+
3+
### Description
4+
5+
Defines the visibility of a custom attribute to sellers in Square client applications, Square APIs or in Square UIs (including Square Point of Sale applications and Square Dashboard).
6+
7+
## Properties
8+
Name | Type
9+
------------ | -------------
10+
**SELLER_VISIBILITY_HIDDEN** | string
11+
**SELLER_VISIBILITY_READ_WRITE_VALUES** | string
12+
13+
Note: All properties are protected and only accessed via getters and setters.
14+
15+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
16+

‎docs/Model/CatalogCustomAttributeDefinitionStringConfig.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# CatalogCustomAttributeDefinitionStringConfig
2+
3+
### Description
4+
5+
Configuration associated with Custom Attribute Definitions of type `STRING`.
6+
7+
## Properties
8+
Name | Getter | Setter | Type | Description | Notes
9+
------------ | ------------- | ------------- | ------------- | ------------- | -------------
10+
**enforce_uniqueness** | getEnforceUniqueness() | setEnforceUniqueness($value) | **bool** | If true, each Custom Attribute instance associated with this Custom Attribute Definition must have a unique value within the seller's catalog. For example, this may be used for a value like a SKU that should not be duplicated within a seller's catalog. May not be modified after the definition has been created. | [optional]
11+
12+
Note: All properties are protected and only accessed via getters and setters.
13+
14+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
15+

‎docs/Model/CatalogCustomAttributeDefinitionType.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# CatalogCustomAttributeDefinitionType
2+
3+
### Description
4+
5+
Defines the possible types for a custom attribute.
6+
7+
## Properties
8+
Name | Type
9+
------------ | -------------
10+
**STRING** | string
11+
**BOOLEAN** | string
12+
**NUMBER** | string
13+
**SELECTION** | string
14+
15+
Note: All properties are protected and only accessed via getters and setters.
16+
17+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
18+

‎docs/Model/CatalogCustomAttributeValue.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# CatalogCustomAttributeValue
2+
3+
### Description
4+
5+
An instance of a custom attribute. Custom attributes can be defined and added to `ITEM` and `ITEM_VARIATION` type catalog objects. [Read more about custom attributes](/catalog-api/add-custom-attributes).
6+
7+
## Properties
8+
Name | Getter | Setter | Type | Description | Notes
9+
------------ | ------------- | ------------- | ------------- | ------------- | -------------
10+
**name** | getName() | setName($value) | **string** | The name of the custom attribute. | [optional]
11+
**string_value** | getStringValue() | setStringValue($value) | **string** | The string value of the custom attribute. Populated if `type` = `STRING`. | [optional]
12+
**custom_attribute_definition_id** | getCustomAttributeDefinitionId() | setCustomAttributeDefinitionId($value) | **string** | __Read-only.__ The custom attribute definition this value belongs to. | [optional]
13+
**type** | getType() | setType($value) | **string** | __Read-only.__ A copy of type from the associated custom attribute definition. See [CatalogCustomAttributeDefinitionType](#type-catalogcustomattributedefinitiontype) for possible values | [optional]
14+
**number_value** | getNumberValue() | setNumberValue($value) | **string** | Populated if `type` = `NUMBER`. Contains a string representation of a decimal number, using a `.` as the decimal separator. | [optional]
15+
**boolean_value** | getBooleanValue() | setBooleanValue($value) | **bool** | A `true` or `false` value. Populated if `type` = `BOOLEAN`. | [optional]
16+
**selection_uid_values** | getSelectionUidValues() | setSelectionUidValues($value) | **string[]** | One or more choices from `allowed_selections`. Populated if `type` = `SELECTION`. | [optional]
17+
**key** | getKey() | setKey($value) | **string** | __Read-only.__ A copy of key from the associated custom attribute definition. | [optional]
18+
19+
Note: All properties are protected and only accessed via getters and setters.
20+
21+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
22+

0 commit comments

Comments
 (0)