Merge pull request #118 from square/release/2.18.0

Release 2.18.0
square · May 8, 2019 · 4ecadd1 · 4ecadd1
2 parents 3f41174 + 2f9a4af
commit 4ecadd1
Show file tree

Hide file tree

Showing 148 changed files with 9,792 additions and 228 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -12,7 +12,7 @@ install:
 
 script:
   - export frameworkVersion=netstandard2.0
-  - export releaseVersion="2.17.1"
+  - export releaseVersion="2.18.0"
   - /bin/sh ./mono_nunit_test.sh
 
 after_success:

diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,15 @@
 # Change Log
 
+## Version 2.18.0 (2019-05-08)
+
+## Details
+
+* **Beta functionality**: Orders API &mdash; support for fractional quantities,
+  expanded metadata, and embedded information on payments, refunds, and returns.
+* **Beta functionality**: Inventory API &mdash; support for fractional quantities.
+* **New functionality**: `Locations.business_hours` &mdash; read-only field with
+  information about the business hours at a particular location.
+
 ## Version 2.17.1 (2019-04-24)
 
 ## Details

diff --git a/README.md b/README.md
@@ -150,6 +150,7 @@ Class | Method | HTTP request
 *OAuthApi* | [**RevokeToken**](docs/OAuthApi.md#revoketoken) | **POST** /oauth2/revoke
 *OrdersApi* | [**BatchRetrieveOrders**](docs/OrdersApi.md#batchretrieveorders) | **POST** /v2/locations/{location_id}/orders/batch-retrieve
 *OrdersApi* | [**CreateOrder**](docs/OrdersApi.md#createorder) | **POST** /v2/locations/{location_id}/orders
+*OrdersApi* | [**SearchOrders**](docs/OrdersApi.md#searchorders) | **POST** /v2/orders/search
 *ReportingApi* | [**ListAdditionalRecipientReceivableRefunds**](docs/ReportingApi.md#listadditionalrecipientreceivablerefunds) | **GET** /v2/locations/{location_id}/additional-recipient-receivable-refunds
 *ReportingApi* | [**ListAdditionalRecipientReceivables**](docs/ReportingApi.md#listadditionalrecipientreceivables) | **GET** /v2/locations/{location_id}/additional-recipient-receivables
 *TransactionsApi* | [**CaptureTransaction**](docs/TransactionsApi.md#capturetransaction) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/capture
@@ -251,6 +252,8 @@ Class | Method | HTTP request
  - [Model.BatchUpsertCatalogObjectsRequest](docs/BatchUpsertCatalogObjectsRequest.md)
  - [Model.BatchUpsertCatalogObjectsResponse](docs/BatchUpsertCatalogObjectsResponse.md)
  - [Model.BreakType](docs/BreakType.md)
+ - [Model.BusinessHours](docs/BusinessHours.md)
+ - [Model.BusinessHoursPeriod](docs/BusinessHoursPeriod.md)
  - [Model.CaptureTransactionRequest](docs/CaptureTransactionRequest.md)
  - [Model.CaptureTransactionResponse](docs/CaptureTransactionResponse.md)
  - [Model.Card](docs/Card.md)
@@ -360,18 +363,29 @@ Class | Method | HTTP request
  - [Model.ListWorkweekConfigsRequest](docs/ListWorkweekConfigsRequest.md)
  - [Model.ListWorkweekConfigsResponse](docs/ListWorkweekConfigsResponse.md)
  - [Model.Location](docs/Location.md)
+ - [Model.MeasurementUnit](docs/MeasurementUnit.md)
+ - [Model.MeasurementUnitCustom](docs/MeasurementUnitCustom.md)
  - [Model.ModelBreak](docs/ModelBreak.md)
  - [Model.Money](docs/Money.md)
  - [Model.ObtainTokenRequest](docs/ObtainTokenRequest.md)
  - [Model.ObtainTokenResponse](docs/ObtainTokenResponse.md)
  - [Model.Order](docs/Order.md)
+ - [Model.OrderEntry](docs/OrderEntry.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)
  - [Model.OrderLineItemTax](docs/OrderLineItemTax.md)
+ - [Model.OrderMoneyAmounts](docs/OrderMoneyAmounts.md)
+ - [Model.OrderQuantityUnit](docs/OrderQuantityUnit.md)
+ - [Model.OrderReturn](docs/OrderReturn.md)
+ - [Model.OrderReturnDiscount](docs/OrderReturnDiscount.md)
+ - [Model.OrderReturnLineItem](docs/OrderReturnLineItem.md)
+ - [Model.OrderReturnLineItemModifier](docs/OrderReturnLineItemModifier.md)
+ - [Model.OrderReturnTax](docs/OrderReturnTax.md)
+ - [Model.OrderRoundingAdjustment](docs/OrderRoundingAdjustment.md)
  - [Model.OrderSource](docs/OrderSource.md)
  - [Model.Refund](docs/Refund.md)
  - [Model.RegisterDomainRequest](docs/RegisterDomainRequest.md)
@@ -400,6 +414,16 @@ Class | Method | HTTP request
  - [Model.SearchCatalogObjectsResponse](docs/SearchCatalogObjectsResponse.md)
  - [Model.SearchCustomersRequest](docs/SearchCustomersRequest.md)
  - [Model.SearchCustomersResponse](docs/SearchCustomersResponse.md)
+ - [Model.SearchOrdersCustomerFilter](docs/SearchOrdersCustomerFilter.md)
+ - [Model.SearchOrdersDateTimeFilter](docs/SearchOrdersDateTimeFilter.md)
+ - [Model.SearchOrdersFilter](docs/SearchOrdersFilter.md)
+ - [Model.SearchOrdersFulfillmentFilter](docs/SearchOrdersFulfillmentFilter.md)
+ - [Model.SearchOrdersQuery](docs/SearchOrdersQuery.md)
+ - [Model.SearchOrdersRequest](docs/SearchOrdersRequest.md)
+ - [Model.SearchOrdersResponse](docs/SearchOrdersResponse.md)
+ - [Model.SearchOrdersSort](docs/SearchOrdersSort.md)
+ - [Model.SearchOrdersSourceFilter](docs/SearchOrdersSourceFilter.md)
+ - [Model.SearchOrdersStateFilter](docs/SearchOrdersStateFilter.md)
  - [Model.SearchShiftsRequest](docs/SearchShiftsRequest.md)
  - [Model.SearchShiftsResponse](docs/SearchShiftsResponse.md)
  - [Model.Shift](docs/Shift.md)

diff --git a/docs/BatchRetrieveOrdersResponse.md b/docs/BatchRetrieveOrdersResponse.md
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Orders** | [**List&lt;Order&gt;**](Order.md) | The requested orders. This will omit any requested orders that do not exist or are not charged. | [optional] 
 **Errors** | [**List&lt;Error&gt;**](Error.md) | Any errors that occurred during the request. | [optional] 
+**UnconvertibleTransactionIds** | **List<string>** | List of transaction ids within the requested set of ids that encountered transformation issues when being converted to an Order. | [optional] 
 
 
 

diff --git a/docs/BusinessHours.md b/docs/BusinessHours.md
@@ -0,0 +1,16 @@
+# Square.Connect.Model.BusinessHours
+
+### Description
+
+ Represents the hours of operation for a business location.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Periods** | [**List&lt;BusinessHoursPeriod&gt;**](BusinessHoursPeriod.md) | The list of time periods during which the business is open. There may be at most 10 periods per day. | [optional] 
+
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/BusinessHoursPeriod.md b/docs/BusinessHoursPeriod.md
@@ -0,0 +1,31 @@
+# Square.Connect.Model.BusinessHoursPeriod
+
+### Description
+
+ Represents a period of time during which a business location is open.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**DayOfWeek** | **DayOfWeekEnum** | The day of week for this time period. See [DayOfWeek](#type-dayofweek) for possible values | [optional] 
+**StartLocalTime** | **string** | The start time of a business hours period, specified in local time using partial-time RFC3339 format. | [optional] 
+**EndLocalTime** | **string** | The end time of a business hours period, specified in local time using partial-time RFC3339 format. | [optional] 
+
+
+## DayOfWeekEnum
+
+Name | Value
+------------ | -------------
+**SUN** | "SUN"
+**MON** | "MON"
+**TUE** | "TUE"
+**WED** | "WED"
+**THU** | "THU"
+**FRI** | "FRI"
+**SAT** | "SAT"
+
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/ChargeRequest.md b/docs/ChargeRequest.md
@@ -16,9 +16,9 @@ Name | Type | Description | Notes
 **ReferenceId** | **string** | An optional ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database).  This value cannot exceed 40 characters. | [optional] 
 **Note** | **string** | An optional note to associate with the transaction.  This value cannot exceed 60 characters. | [optional] 
 **CustomerId** | **string** | The ID of the customer to associate this transaction with. This field is required if you provide a value for &#x60;customer_card_id&#x60;, and optional otherwise. | [optional] 
-**BillingAddress** | [**Address**](Address.md) | The buyer&#39;s billing address. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor &#x60;shipping_address&#x60; is provided. | [optional] 
-**ShippingAddress** | [**Address**](Address.md) | The buyer&#39;s shipping address, if available. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor &#x60;billing_address&#x60; is provided. | [optional] 
-**BuyerEmailAddress** | **string** | The buyer&#39;s email address, if available. This value is optional, but this transaction is ineligible for chargeback protection if it is not provided. | [optional] 
+**BillingAddress** | [**Address**](Address.md) | The buyer&#39;s billing address. | [optional] 
+**ShippingAddress** | [**Address**](Address.md) | The buyer&#39;s shipping address, if available. | [optional] 
+**BuyerEmailAddress** | **string** | The buyer&#39;s email address, if available. | [optional] 
 **OrderId** | **string** | The ID of the order to associate with this transaction.  If you provide this value, the &#x60;amount_money&#x60; value of your request must __exactly match__ the value of the order&#39;s &#x60;total_money&#x60; field. | [optional] 
 **AdditionalRecipients** | [**List&lt;AdditionalRecipient&gt;**](AdditionalRecipient.md) | The basic primitive of multi-party transaction. The value is optional. The transaction facilitated by you can be split from here.  If you provide this value, the &#x60;amount_money&#x60; value in your additional_recipients must not be more than 90% of the &#x60;amount_money&#x60; value in the charge request. The &#x60;location_id&#x60; must be the valid location of the app owner merchant.  This field requires the &#x60;PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS&#x60; OAuth permission.  This field is currently not supported in sandbox. | [optional] 
 

diff --git a/docs/CreateOrderRequest.md b/docs/CreateOrderRequest.md
@@ -10,7 +10,7 @@ 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&#39;ve created.  If you&#39;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](/basics/api101/idempotency) for more information. | [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] 
+**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. - - Top-level fields necessary to support the connect v2 CreateOrderRequest shape. | [optional] 
 **LineItems** | [**List&lt;CreateOrderRequestLineItem&gt;**](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&lt;CreateOrderRequestTax&gt;**](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&lt;CreateOrderRequestDiscount&gt;**](CreateOrderRequestDiscount.md) | __Deprecated__: Please set the discounts on the nested [order](#type-order) field instead.  The discounts to include on the order. | [optional] 

diff --git a/docs/CreateOrderRequestTax.md b/docs/CreateOrderRequestTax.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **CatalogObjectId** | **string** | Only used for catalog taxes. The catalog object ID of an existing [CatalogTax](#type-catalogtax).  Do not provide a value for this field if you provide values in other fields for an ad hoc tax. | [optional] 
 **Name** | **string** | Only used for ad hoc taxes. The tax&#39;s name.  Do not provide a value for this field if you set &#x60;catalog_object_id&#x60;. | [optional] 
-**Type** | **TypeEnum** | Only used for ad hoc taxes. Indicates the calculation method used to apply the line item tax.  Default: &#x60;ADDITIVE&#x60;; See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values | [optional] 
+**Type** | **TypeEnum** | Only used for ad hoc taxes. Indicates the calculation method used to apply the line item tax.  Default: &#x60;ADDITIVE&#x60;; See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values. See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values | [optional] 
 **Percentage** | **string** | Only used for ad hoc taxes. The percentage of the tax, as a string representation of a decimal number.  A value of &#x60;7.25&#x60; corresponds to a percentage of 7.25%. This value range between 0.0 up to 100.0 | [optional] 
 
 

diff --git a/docs/DayOfWeek.md b/docs/DayOfWeek.md
@@ -0,0 +1,15 @@
+# Square.Connect.Model.DayOfWeek
+
+### Description
+
+ Indicates the specific day  of the week.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/Error.md b/docs/Error.md
@@ -103,6 +103,8 @@ Name | Value
 **INVALIDPHONENUMBER** | "INVALID_PHONE_NUMBER"
 **CHECKOUTEXPIRED** | "CHECKOUT_EXPIRED"
 **BADCERTIFICATE** | "BAD_CERTIFICATE"
+**INVALIDSQUAREVERSIONFORMAT** | "INVALID_SQUARE_VERSION_FORMAT"
+**APIVERSIONINCOMPATIBLE** | "API_VERSION_INCOMPATIBLE"
 **CARDDECLINED** | "CARD_DECLINED"
 **VERIFYCVVFAILURE** | "VERIFY_CVV_FAILURE"
 **VERIFYAVSFAILURE** | "VERIFY_AVS_FAILURE"

diff --git a/docs/InventoryAdjustment.md b/docs/InventoryAdjustment.md
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 **LocationId** | **string** | The Square ID of the [Location](#type-location) where the related quantity of items are being tracked. | [optional] 
 **CatalogObjectId** | **string** | The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked. | [optional] 
 **CatalogObjectType** | **string** | The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the &#x60;ITEM_VARIATION&#x60; type. | [optional] 
-**Quantity** | **string** | The number of items affected by the adjustment as a decimal string. Fractional quantities are not supported. | [optional] 
+**Quantity** | **string** | The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point.  _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, &#x60;2.5&#x60; will become &#x60;2&#x60;, and &#x60;-2.5&#x60; will become &#x60;-3&#x60;. Read [Decimal Quantities (BETA)](/more-apis/inventory/overview#decimal-quantities-beta) for more information. | [optional] 
 **TotalPriceMoney** | [**Money**](Money.md) | The read-only total price paid for goods associated with the adjustment. Present if and only if &#x60;to_state&#x60; is &#x60;SOLD&#x60;. Always non-negative. | [optional] 
 **OccurredAt** | **string** | A client-generated timestamp in RFC 3339 format that indicates when the adjustment took place. For write actions, the &#x60;occurred_at&#x60; timestamp cannot be older than 24 hours or in the future relative to the time of the request. | [optional] 
 **CreatedAt** | **string** | A read-only timestamp in RFC 3339 format that indicates when Square received the adjustment. | [optional] 

diff --git a/docs/InventoryCount.md b/docs/InventoryCount.md
@@ -2,7 +2,7 @@
 
 ### Description
 
-Represents the estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments.
+Represents Square's estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments
 
 ## Properties
 
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **CatalogObjectType** | **string** | The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the &#x60;ITEM_VARIATION&#x60; type. | [optional] 
 **State** | **StateEnum** | The current [InventoryState](#type-inventorystate) for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values | [optional] 
 **LocationId** | **string** | The Square ID of the [Location](#type-location) where the related quantity of items are being tracked. | [optional] 
-**Quantity** | **string** | The number of items in the count as a decimal string. Fractional quantities are not supported. | [optional] 
+**Quantity** | **string** | The number of items in the count as a decimal string. Can support up to 5 digits after the decimal point.  _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, &#x60;2.5&#x60; will become &#x60;2&#x60;, and &#x60;-2.5&#x60; will become &#x60;-3&#x60;. Read [Decimal Quantities (BETA)](/more-apis/inventory/overview#decimal-quantities-beta) for more information. | [optional] 
 **CalculatedAt** | **string** | A read-only timestamp in RFC 3339 format that indicates when Square received the most recent physical count or adjustment that had an affect on the estimated count. | [optional]