Merge pull request #90 from square/release/3.20200325.0

Release 3.20200325.0

CHANGES.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## Version 3.20200325.0 (2020-03-25)
+## Existing API updates
+* **[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:
+   * `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).
+   * `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.
+   * `delayed_until`. Provides the date and time on Square servers when Square applies `delay_action` on the payment.
+
+
 ## Version 3.20200226.0 (2020-02-26)
 ## API releases
 * **GA release**: All SDKs have been updated to support the new Bank Accounts and CashDrawerShifts APIs.

README.md

@@ -282,8 +282,15 @@ Class | Method | HTTP request | Description
  - [SquareConnect.CashDrawerShiftEvent](docs/CashDrawerShiftEvent.md)
  - [SquareConnect.CashDrawerShiftState](docs/CashDrawerShiftState.md)
  - [SquareConnect.CashDrawerShiftSummary](docs/CashDrawerShiftSummary.md)
- - [SquareConnect.CashPaymentDetails](docs/CashPaymentDetails.md)
  - [SquareConnect.CatalogCategory](docs/CatalogCategory.md)
+ - [SquareConnect.CatalogCustomAttributeDefinition](docs/CatalogCustomAttributeDefinition.md)
+ - [SquareConnect.CatalogCustomAttributeDefinitionAppVisibility](docs/CatalogCustomAttributeDefinitionAppVisibility.md)
+ - [SquareConnect.CatalogCustomAttributeDefinitionSelectionConfig](docs/CatalogCustomAttributeDefinitionSelectionConfig.md)
+ - [SquareConnect.CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection](docs/CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection.md)
+ - [SquareConnect.CatalogCustomAttributeDefinitionSellerVisibility](docs/CatalogCustomAttributeDefinitionSellerVisibility.md)
+ - [SquareConnect.CatalogCustomAttributeDefinitionStringConfig](docs/CatalogCustomAttributeDefinitionStringConfig.md)
+ - [SquareConnect.CatalogCustomAttributeDefinitionType](docs/CatalogCustomAttributeDefinitionType.md)
+ - [SquareConnect.CatalogCustomAttributeValue](docs/CatalogCustomAttributeValue.md)
  - [SquareConnect.CatalogDiscount](docs/CatalogDiscount.md)
  - [SquareConnect.CatalogDiscountModifyTaxBasis](docs/CatalogDiscountModifyTaxBasis.md)
  - [SquareConnect.CatalogDiscountType](docs/CatalogDiscountType.md)
@@ -404,7 +411,6 @@ Class | Method | HTTP request | Description
  - [SquareConnect.ErrorCategory](docs/ErrorCategory.md)
  - [SquareConnect.ErrorCode](docs/ErrorCode.md)
  - [SquareConnect.ExcludeStrategy](docs/ExcludeStrategy.md)
- - [SquareConnect.ExternalPaymentDetails](docs/ExternalPaymentDetails.md)
  - [SquareConnect.GetBankAccountByV1IdRequest](docs/GetBankAccountByV1IdRequest.md)
  - [SquareConnect.GetBankAccountByV1IdResponse](docs/GetBankAccountByV1IdResponse.md)
  - [SquareConnect.GetBankAccountRequest](docs/GetBankAccountRequest.md)

docs/CashDrawerDevice.md

@@ -1,7 +1,6 @@
 # SquareConnect.CashDrawerDevice
 
 ### Description
-**Note: This model is in beta.**
 
 
 

docs/CashDrawerShift.md

@@ -1,7 +1,6 @@
 # SquareConnect.CashDrawerShift
 
 ### Description
-**Note: This model is in beta.**
 
 This model gives the details of a cash drawer shift. The cash_payment_money, cash_refund_money, cash_paid_in_money, and cash_paid_out_money fields are all computed by summing their respective event types.
 

docs/CashDrawerShiftEvent.md

@@ -1,7 +1,6 @@
 # SquareConnect.CashDrawerShiftEvent
 
 ### Description
-**Note: This model is in beta.**
 
 
 

docs/CashDrawerShiftSummary.md

@@ -1,7 +1,6 @@
 # SquareConnect.CashDrawerShiftSummary
 
 ### Description
-**Note: This model is in beta.**
 
 The summary of a closed cash drawer shift. This model contains only the money counted to start a cash drawer shift, counted at the end of the shift, and the amount that should be in the drawer at shift end based on summing all cash drawer shift events.
 

docs/CashDrawersApi.md

@@ -11,7 +11,6 @@ Method | HTTP request | Description
 
 <a name="listCashDrawerShiftEvents"></a>
 # **listCashDrawerShiftEvents**
-**Note: This endpoint is in beta.**
 > ListCashDrawerShiftEventsResponse listCashDrawerShiftEvents(locationId, shiftId, opts)
 
 ListCashDrawerShiftEvents
@@ -69,7 +68,6 @@ Name | Type | Description  | Notes
 
 <a name="listCashDrawerShifts"></a>
 # **listCashDrawerShifts**
-**Note: This endpoint is in beta.**
 > ListCashDrawerShiftsResponse listCashDrawerShifts(locationId, opts)
 
 ListCashDrawerShifts
@@ -130,7 +128,6 @@ Name | Type | Description  | Notes
 
 <a name="retrieveCashDrawerShift"></a>
 # **retrieveCashDrawerShift**
-**Note: This endpoint is in beta.**
 > RetrieveCashDrawerShiftResponse retrieveCashDrawerShift(locationId, shiftId)
 
 RetrieveCashDrawerShift

docs/CatalogCustomAttributeDefinition.md

@@ -0,0 +1,23 @@
+# SquareConnect.CatalogCustomAttributeDefinition
+
+### Description
+**Note: This model is in beta.**
+
+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)
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of this custom attribute. Cannot be modified after creation. Required. See [CatalogCustomAttributeDefinitionType](#type-catalogcustomattributedefinitiontype) for possible values | 
+**name** | **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. | 
+**description** | **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] 
+**source_application** | [**SourceApplication**](SourceApplication.md) | __Read only.__ Contains information about the application that created this custom attribute definition. | [optional] 
+**allowed_object_types** | **[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] 
+**seller_visibility** | **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] 
+**app_visibility** | **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] 
+**string_config** | [**CatalogCustomAttributeDefinitionStringConfig**](CatalogCustomAttributeDefinitionStringConfig.md) | Optionally, populated when `type` = `STRING`, unset otherwise. | [optional] 
+**selection_config** | [**CatalogCustomAttributeDefinitionSelectionConfig**](CatalogCustomAttributeDefinitionSelectionConfig.md) | Populated when `type` is set to `SELECTION`, unset otherwise. | [optional] 
+**custom_attribute_usage_count** | **Number** | __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] 
+**key** | **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] 
+
+

docs/CatalogCustomAttributeDefinitionAppVisibility.md

@@ -0,0 +1,12 @@
+# SquareConnect.CatalogCustomAttributeDefinitionAppVisibility
+
+## Enum
+
+
+* `HIDDEN` (value: `"APP_VISIBILITY_HIDDEN"`)
+
+* `READ_ONLY` (value: `"APP_VISIBILITY_READ_ONLY"`)
+
+* `READ_WRITE_VALUES` (value: `"APP_VISIBILITY_READ_WRITE_VALUES"`)
+
+

docs/CatalogCustomAttributeDefinitionSelectionConfig.md

@@ -0,0 +1,14 @@
+# SquareConnect.CatalogCustomAttributeDefinitionSelectionConfig
+
+### Description
+**Note: This model is in beta.**
+
+Configuration associated with `SELECTION`-type custom attribute definitions.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**max_allowed_selections** | **Number** | 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] 
+**allowed_selections** | [**[CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection]**](CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection.md) | The set of valid `CatalogCustomAttributeSelections`. Up to a maximum of 100 selections can be defined. Can be modified. | [optional] 
+
+

docs/CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection.md

@@ -0,0 +1,14 @@
+# SquareConnect.CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection
+
+### Description
+**Note: This model is in beta.**
+
+A named selection for this `SELECTION`-type custom attribute definition.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **String** | Unique ID set by Square. | [optional] 
+**name** | **String** | Selection name, unique within `allowed_selections`. Required. Min length of 1, max length of 255. | 
+
+

docs/CatalogCustomAttributeDefinitionSellerVisibility.md

@@ -0,0 +1,10 @@
+# SquareConnect.CatalogCustomAttributeDefinitionSellerVisibility
+
+## Enum
+
+
+* `HIDDEN` (value: `"SELLER_VISIBILITY_HIDDEN"`)
+
+* `READ_WRITE_VALUES` (value: `"SELLER_VISIBILITY_READ_WRITE_VALUES"`)
+
+

docs/CatalogCustomAttributeDefinitionStringConfig.md

@@ -0,0 +1,13 @@
+# SquareConnect.CatalogCustomAttributeDefinitionStringConfig
+
+### Description
+**Note: This model is in beta.**
+
+Configuration associated with Custom Attribute Definitions of type `STRING`.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enforce_uniqueness** | **Boolean** | 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] 
+
+

docs/CatalogCustomAttributeDefinitionType.md

@@ -0,0 +1,14 @@
+# SquareConnect.CatalogCustomAttributeDefinitionType
+
+## Enum
+
+
+* `STRING` (value: `"STRING"`)
+
+* `BOOLEAN` (value: `"BOOLEAN"`)
+
+* `NUMBER` (value: `"NUMBER"`)
+
+* `SELECTION` (value: `"SELECTION"`)
+
+

docs/CatalogCustomAttributeValue.md

@@ -0,0 +1,20 @@
+# SquareConnect.CatalogCustomAttributeValue
+
+### Description
+**Note: This model is in beta.**
+
+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).
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the custom attribute. | [optional] 
+**string_value** | **String** | The string value of the custom attribute.  Populated if `type` = `STRING`. | [optional] 
+**custom_attribute_definition_id** | **String** | __Read-only.__ The custom attribute definition this value belongs to. | [optional] 
+**type** | **String** | __Read-only.__ A copy of type from the associated custom attribute definition. See [CatalogCustomAttributeDefinitionType](#type-catalogcustomattributedefinitiontype) for possible values | [optional] 
+**number_value** | **String** | Populated if `type` = `NUMBER`. Contains a string representation of a decimal number, using a `.` as the decimal separator. | [optional] 
+**boolean_value** | **Boolean** | A `true` or `false` value. Populated if `type` = `BOOLEAN`. | [optional] 
+**selection_uid_values** | **[String]** | One or more choices from `allowed_selections`. Populated if `type` = `SELECTION`. | [optional] 
+**key** | **String** | __Read-only.__ A copy of key from the associated custom attribute definition. | [optional] 
+
+

docs/CatalogObject.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **updated_at** | **String** | Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. | [optional] 
 **version** | **Number** | The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting. | [optional] 
 **is_deleted** | **Boolean** | If `true`, the object has been deleted from the database. Must be `false` for new objects being inserted. When deleted, the `updated_at` field will equal the deletion time. | [optional] 
+**custom_attribute_values** | [**{String: CatalogCustomAttributeValue}**](CatalogCustomAttributeValue.md) | Application-defined key/value attributes that are set at a global (location-independent) level. Values from the `*_data` fields may not be duplicated. Custom Attribute fields are intended to store additional information about a Catalog Object or associations with an entity in another system. Do not use custom attributes to store any sensitive information (personally identifiable information, card details, etc.).  For CustomAttributesDefinitions defined by the app making the request, the map key is the key defined in CustomAttributeDefinition (eg. “reference_id”). For CustomAttributesDefinitions by other apps, the map key is the key defined in CustomAttributeDefinition prefixed with the application ID and a colon (eg. “abcd1234:reference_id”). | [optional] [beta]
 **catalog_v1_ids** | [**[CatalogV1Id]**](CatalogV1Id.md) | The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. | [optional] 
 **present_at_all_locations** | **Boolean** | If `true`, this object is present at all locations (including future locations), except where specified in the `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations), except where specified in the `present_at_location_ids` field. If not specified, defaults to `true`. | [optional] 
 **present_at_location_ids** | **[String]** | A list of locations where the object is present, even if `present_at_all_locations` is `false`. | [optional] 
@@ -31,5 +32,6 @@ Name | Type | Description | Notes
 **measurement_unit_data** | [**CatalogMeasurementUnit**](CatalogMeasurementUnit.md) | Structured data for a `CatalogMeasurementUnit`, set for CatalogObjects of type `MEASUREMENT_UNIT`. | [optional] 
 **item_option_data** | [**CatalogItemOption**](CatalogItemOption.md) | Structured data for a `CatalogItemOption`, set for CatalogObjects of type `ITEM_OPTION`. | [optional] 
 **item_option_value_data** | [**CatalogItemOptionValue**](CatalogItemOptionValue.md) | Structured data for a `CatalogItemOptionValue`, set for CatalogObjects of type `ITEM_OPTION_VAL`. | [optional] 
+**custom_attribute_definition_data** | [**CatalogCustomAttributeDefinition**](CatalogCustomAttributeDefinition.md) | Structured data for a `CatalogCustomAttributeDefinition`, set for CatalogObjects of type `CUSTOM_ATTRIBUTE_DEFINITION`. | [optional]