Release 2.14.0 (#103)

.travis.yml

@@ -12,7 +12,7 @@ install:
 
 script:
   - export frameworkVersion=netstandard2.0
-  - export releaseVersion="2.13.0"
+  - export releaseVersion="2.14.0"
   - /bin/sh ./mono_nunit_test.sh
 
 after_success:

CHANGES.md

@@ -1,5 +1,26 @@
 # Change Log
 
+## Version 2.14.0 (2019-02-13)
+
+## New feature: Order fulfillment BETA
+
+The Orders API now includes beta
+functionality that supports in-person fulfillment through Square Point of Sale
+for orders placed online.
+
+## Improvement: New CreateOrder request structure
+
+The `CreateOrderRequest` datatype now groups order details under a single
+object.
+
+
+## Improvement: CreateOrder requests preserve order-level price adjustment objects
+
+The `CreateOrderResponse` datatype now retains structure of order-level
+price adjustments in addition to converting them to scoped, line-item price
+adjustments. Previously, `CreateOrderResponse` did not preserve the original
+order-level price-adjustment objects.
+
 ## Version 2.13.0 (2018-12-12)
 
 ## Improvement: ListCustomers return set expanded

README.md

@@ -321,6 +321,9 @@ Class | Method | HTTP request
  - [Model.ObtainTokenRequest](docs/ObtainTokenRequest.md)
  - [Model.ObtainTokenResponse](docs/ObtainTokenResponse.md)
  - [Model.Order](docs/Order.md)
+ - [Model.OrderFulfillment](docs/OrderFulfillment.md)
+ - [Model.OrderFulfillmentPickupDetails](docs/OrderFulfillmentPickupDetails.md)
+ - [Model.OrderFulfillmentRecipient](docs/OrderFulfillmentRecipient.md)
  - [Model.OrderLineItem](docs/OrderLineItem.md)
  - [Model.OrderLineItemDiscount](docs/OrderLineItemDiscount.md)
  - [Model.OrderLineItemModifier](docs/OrderLineItemModifier.md)

docs/CatalogCategory.md

@@ -3,7 +3,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Name** | **string** | The category's name. Searchable. | [optional] 
+**Name** | **string** | The category's name. Searchable. This field has max length of 255 Unicode code points. | [optional] 
 
 
 

docs/CatalogDiscount.md

@@ -3,12 +3,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Name** | **string** | The discount's name. Searchable. | [optional] 
+**Name** | **string** | The discount's name. Searchable. This field has max length of 255 Unicode code points. | [optional] 
 **DiscountType** | **DiscountTypeEnum** | Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale. See [CatalogDiscountType](#type-catalogdiscounttype) for all possible values. | [optional] 
 **Percentage** | **string** | The percentage of the discount as a string representation of a decimal number, using a `.` as the decimal separator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type` is `VARIABLE_PERCENTAGE`.  Do not include this field for amount-based or variable discounts. | [optional] 
 **AmountMoney** | [**Money**](Money.md) | The amount of the discount. Specify an amount of `0` if `discount_type` is `VARIABLE_AMOUNT`.  Do not include this field for percentage-based or variable discounts. | [optional] 
 **PinRequired** | **bool?** | Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment in the Square Point of Sale app. | [optional] 
-**LabelColor** | **string** | The color of the discount's display label in the Square Point of Sale app. | [optional] 
+**LabelColor** | **string** | The color of the discount's display label in the Square Point of Sale app. This must be a valid hex color code. | [optional] 
 
 
 ## DiscountTypeEnum

docs/CatalogItem.md

@@ -3,10 +3,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Name** | **string** | The item's name. Searchable. | [optional] 
-**Description** | **string** | The item's description. Searchable. | [optional] 
-**Abbreviation** | **string** | The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used.  Searchable. | [optional] 
-**LabelColor** | **string** | The color of the item's display label in the Square Point of Sale app. | [optional] 
+**Name** | **string** | The item's name. Searchable. This field must not be empty. This field has max length of 512 Unicode code points. | [optional] 
+**Description** | **string** | The item's description. Searchable. This field has max length of 4096 Unicode code points. | [optional] 
+**Abbreviation** | **string** | The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used. Searchable. This field has max length of 24 Unicode code points. | [optional] 
+**LabelColor** | **string** | The color of the item's display label in the Square Point of Sale app. This must be a valid hex color code. | [optional] 
 **AvailableOnline** | **bool?** | If `true`, the item can be added to shipping orders from the merchant's online store. | [optional] 
 **AvailableForPickup** | **bool?** | If `true`, the item can be added to pickup orders from the merchant's online store. | [optional] 
 **AvailableElectronically** | **bool?** | If `true`, the item can be added to electronically fulfilled orders from the merchant's online store. | [optional] 

docs/CatalogItemVariation.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **ItemId** | **string** | The ID of the [CatalogItem](#type-catalogitem) associated with this item variation. Searchable. | [optional] 
-**Name** | **string** | The item variation's name. Searchable. | [optional] 
+**Name** | **string** | The item variation's name. Searchable. This field has max length of 255 Unicode code points. | [optional] 
 **Sku** | **string** | The item variation's SKU, if any. Searchable. | [optional] 
 **Upc** | **string** | The item variation's UPC, if any. Searchable in the Connect API. This field is only exposed in the Connect API. It is not exposed in Square's Dashboard, Square Point of Sale app or Retail Point of Sale app. | [optional] 
 **Ordinal** | **int?** | The order in which this item variation should be displayed. This value is read-only. On writes, the ordinal for each item variation within a parent [CatalogItem](#type-catalogitem) is set according to the item variations's position. On reads, the value is not guaranteed to be sequential or unique. | [optional] 
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **TrackInventory** | **bool?** | If `true`, inventory tracking is active for the variation. | [optional] 
 **InventoryAlertType** | **InventoryAlertTypeEnum** | Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for all possible values. | [optional] 
 **InventoryAlertThreshold** | **long?** | If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard.  This value is always an integer. | [optional] 
-**UserData** | **string** | Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable. | [optional] 
+**UserData** | **string** | Arbitrary user metadata to associate with the item variation. Searchable. This field has max length of 255 Unicode code points. | [optional] 
 **ServiceDuration** | **long?** | If the [CatalogItem](#type-catalogitem) that owns this item variation is of type `APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For example, a 30 minute appointment would have the value `1800000`, which is equal to 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second). | [optional] 
 
 

docs/CatalogModifier.md

@@ -3,7 +3,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Name** | **string** | The modifier's name. Searchable. | [optional] 
+**Name** | **string** | The modifier's name. Searchable. This field has max length of 255 Unicode code points. | [optional] 
 **PriceMoney** | [**Money**](Money.md) | The modifier's price. | [optional] 
 
 

docs/CatalogModifierList.md

@@ -3,7 +3,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Name** | **string** | The [CatalogModifierList](#type-catalogmodifierlist)'s name. Searchable. | [optional] 
+**Name** | **string** | The [CatalogModifierList](#type-catalogmodifierlist)'s name. Searchable. This field has max length of 255 Unicode code points. | [optional] 
 **SelectionType** | **SelectionTypeEnum** | Indicates whether multiple options from the [CatalogModifierList](#type-catalogmodifierlist) can be applied to a single [CatalogItem](#type-catalogitem). See [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for all possible values. | [optional] 
 **Modifiers** | [**List<CatalogObject>**](CatalogObject.md) | The options included in the [CatalogModifierList](#type-catalogmodifierlist). You must include at least one [CatalogModifier](#type-catalogmodifier). Each [CatalogObject](#type-catalogobject) must have type `MODIFIER` and contain [CatalogModifier](#type-catalogmodifier) data. | [optional] 
 

docs/CatalogObject.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 **Type** | **TypeEnum** | The type of this object. Each object type has expected properties expressed in a structured format within its corresponding `*_data` field below.  See [CatalogObjectType](#type-catalogobjecttype) for all possible values. | 
 **Id** | **string** | An identifier to reference this object in the catalog. When a new CatalogObject is inserted, the client should set the id to a temporary identifier starting with a `'#'` character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object.  When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. | 
 **UpdatedAt** | **string** | Last modification [timestamp](#workingwithdates) 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** | **long?** | The version of the object. When updating an object, the version supplied by the must match the version in the database, otherwise the write will be rejected as conflicting. | [optional] 
+**Version** | **long?** | 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] 
 **IsDeleted** | **bool?** | 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] 
 **CatalogV1Ids** | [**List<CatalogV1Id>**](CatalogV1Id.md) | The Connect V1 IDs for this object at each [location](#type-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] 
 **PresentAtAllLocations** | **bool?** | 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] 

docs/CatalogTax.md

@@ -3,7 +3,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Name** | **string** | The tax's name. Searchable. | [optional] 
+**Name** | **string** | The tax's name. Searchable. This field has max length of 255 Unicode code points. | [optional] 
 **CalculationPhase** | **CalculationPhaseEnum** | Whether the tax is calculated based on a payment's subtotal or total. See [TaxCalculationPhase](#type-taxcalculationphase) for all possible values. | [optional] 
 **InclusionType** | **InclusionTypeEnum** | Whether the tax is `ADDITIVE` or `INCLUSIVE`. See [TaxInclusionType](#type-taxinclusiontype) for all possible values. | [optional] 
 **Percentage** | **string** | The percentage of the tax in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. A value of `7.5` corresponds to 7.5%. | [optional] 

docs/CheckoutApi.md

@@ -13,7 +13,7 @@ Method | HTTP request | Description
 
 CreateCheckout
 
-Creates a [Checkout](#type-checkout) response that links a `checkoutId` and `checkout_page_url` that customers can be directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.
+Links a `checkoutId` to a `checkout_page_url` that customers will be directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.
 
 ### Example
 ```csharp

docs/CreateOrderRequest.md

@@ -3,11 +3,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**Order** | [**Order**](Order.md) | The order to create. If this field is set, then the only other top-level field that can be set is the idempotency_key. | [optional] 
 **IdempotencyKey** | **string** | A value you specify that uniquely identifies this order among orders you've created.  If you're unsure whether a particular order was created successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate orders.  See [Idempotency keys](#idempotencykeys) for more information. | [optional] 
-**ReferenceId** | **string** | An optional ID you can associate with the order for your own purposes (such as to associate the order with an entity ID in your own database).  This value cannot exceed 40 characters. | [optional] 
-**LineItems** | [**List<CreateOrderRequestLineItem>**](CreateOrderRequestLineItem.md) | The line items to associate with this order.  Each line item represents a different product to include in a purchase. | 
-**Taxes** | [**List<CreateOrderRequestTax>**](CreateOrderRequestTax.md) | The taxes to include on the order. | [optional] 
-**Discounts** | [**List<CreateOrderRequestDiscount>**](CreateOrderRequestDiscount.md) | The discounts to include on the order. | [optional] 
+**ReferenceId** | **string** | __Deprecated__: Please set the reference_id on the nested [order](#type-order) field instead.  An optional ID you can associate with the order for your own purposes (such as to associate the order with an entity ID in your own database).  This value cannot exceed 40 characters. | [optional] 
+**LineItems** | [**List<CreateOrderRequestLineItem>**](CreateOrderRequestLineItem.md) | __Deprecated__: Please set the line_items on the nested [order](#type-order) field instead.  The line items to associate with this order.  Each line item represents a different product to include in a purchase. | [optional] 
+**Taxes** | [**List<CreateOrderRequestTax>**](CreateOrderRequestTax.md) | __Deprecated__: Please set the taxes on the nested [order](#type-order) field instead.  The taxes to include on the order. | [optional] 
+**Discounts** | [**List<CreateOrderRequestDiscount>**](CreateOrderRequestDiscount.md) | __Deprecated__: Please set the discounts on the nested [order](#type-order) field instead.  The discounts to include on the order. | [optional] 
 
 
 

docs/Error.md

@@ -105,6 +105,7 @@ Name | Value
 **NOTFOUND** | "NOT_FOUND"
 **APPLEPAYMENTPROCESSINGCERTIFICATEHASHNOTFOUND** | "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND"
 **METHODNOTALLOWED** | "METHOD_NOT_ALLOWED"
+**NOTACCEPTABLE** | "NOT_ACCEPTABLE"
 **REQUESTTIMEOUT** | "REQUEST_TIMEOUT"
 **CONFLICT** | "CONFLICT"
 **REQUESTENTITYTOOLARGE** | "REQUEST_ENTITY_TOO_LARGE"

docs/Order.md

@@ -6,7 +6,10 @@ Name | Type | Description | Notes
 **Id** | **string** | The order's unique ID.  This value is only present for Order objects created by the Orders API through the [CreateOrder](#endpoint-createorder) endpoint. | [optional] 
 **LocationId** | **string** | The ID of the merchant location this order is associated with. | 
 **ReferenceId** | **string** | A client specified identifier to associate an entity in another system with this order. | [optional] 
-**LineItems** | [**List<OrderLineItem>**](OrderLineItem.md) | The line items included in the order. Every order has at least one line item. | 
+**LineItems** | [**List<OrderLineItem>**](OrderLineItem.md) | The line items included in the order. | [optional] 
+**Taxes** | [**List<OrderLineItemTax>**](OrderLineItemTax.md) | A list of taxes applied to this order. On read or retrieve, this list includes both order-level and item-level taxes. When creating an Order, set your order-level taxes in this list. | [optional] 
+**Discounts** | [**List<OrderLineItemDiscount>**](OrderLineItemDiscount.md) | A list of discounts applied to this order. On read or retrieve, this list includes both order-level and item-level discounts. When creating an Order, set your order-level discounts in this list. | [optional] 
+**Fulfillments** | [**List<OrderFulfillment>**](OrderFulfillment.md) | Details on order fulfillment.  Orders can only be created with at most one fulfillment. However, orders returned by the API may contain multiple fulfillments. | [optional] 
 **TotalMoney** | [**Money**](Money.md) | The total amount of money to collect for the order. | [optional] 
 **TotalTaxMoney** | [**Money**](Money.md) | The total tax amount of money to collect for the order. | [optional] 
 **TotalDiscountMoney** | [**Money**](Money.md) | The total discount amount of money to collect for the order. | [optional] 

docs/OrderFulfillment.md

@@ -0,0 +1,32 @@
+# Square.Connect.Model.OrderFulfillment
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Type** | **TypeEnum** | The type of the fulfillment. | [optional] 
+**State** | **StateEnum** | The state of the fulfillment. | [optional] 
+**PickupDetails** | [**OrderFulfillmentPickupDetails**](OrderFulfillmentPickupDetails.md) | Contains pickup-specific details. Required when fulfillment type is `PICKUP`. | [optional] 
+
+
+## TypeEnum
+
+Name | Value
+------------ | -------------
+**PICKUP** | "PICKUP"
+
+
+## StateEnum
+
+Name | Value
+------------ | -------------
+**PROPOSED** | "PROPOSED"
+**RESERVED** | "RESERVED"
+**PREPARED** | "PREPARED"
+**COMPLETED** | "COMPLETED"
+**CANCELED** | "CANCELED"
+**FAILED** | "FAILED"
+
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+