Release 2.10.0 (#71)

.travis.yml

@@ -12,7 +12,7 @@ install:
 
 script:
   - export frameworkVersion=net45
-  - export releaseVersion="2.9.1"
+  - export releaseVersion="2.10.0"
   - /bin/sh ./mono_nunit_test.sh
 
 after_success:

CHANGES.md

@@ -1,5 +1,48 @@
 # Change Log
 
+## Version 2.10.0 (2018-07-12)
+
+We introduce Square API versions. `Square-Version` is 2018-07-12 for this SDK.
+
+### How versioning works
+
+Square API versions (`Square-Version`) track changes in the evolution of Connect
+v2 APIs. The `Square-Version` naming scheme is `YYYY-MM-DD`, which indicates
+the date the version was released. Connect v1 APIs are not versioned. Square
+continues to support Connect v1, but future releases will focus on improving
+Connect v2 functionality.
+
+By default, new Square applications are pinned to the version current at the
+time the application was created in the Square Application Dashboard. Pinning an
+application sets the default `Square-Version` for the application. The default
+`Square-Version` of an application can be reviewed and updated at any time on
+the settings pages for the application.
+
+
+### Versioning and SDKs
+
+When a new `Square-Version` is released, new Connect SDKs are publish on GitHub
+and various package management systems.
+
+While SDK versions can be mapped to a related Square-version, SDK versions
+follow an independent, incremental versioning scheme to allow updates and
+improvements to the SDKs outside of `Square-Version` updates.
+
+
+### Migrating to new versions
+
+In most cases, Square-version migration should be straightforward, with known
+differences listed in the related Change Log.
+
+To test migrations, developers can override the default `Square-Version` of an
+application by explicitly setting the preferred `Square-Version` in the HTTP
+header of the Connect v2 API request for REST calls. Requesting an API version
+that does not exist returns an error. Successful API responses include the
+`Square-Version` header to indicate the API version used to process request.
+
+Connect SDK versions are locked to specific API versions and cannot be
+overwritten. Instead, the SDK must be upgraded to work with new API versions.
+
 ## Version 2.9.1 (2018-07-09)
 
 Dependencies updated for compatibility with .NET Core 2.0

docs/CustomerCreationSourceFilter.md

@@ -3,7 +3,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Values** | **List<ValuesEnum>** | The list of creation sources used as filtering criteria. | [optional] 
+**Values** | **List<ValuesEnum>** | The list of creation sources used as filtering criteria. See [CustomerCreationSource](#type-customercreationsource) for possible values. | [optional] 
 **Rule** | **RuleEnum** | Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: &#x60;INCLUDE&#x60;. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values. | [optional] 
 
 

docs/CustomerSort.md

@@ -3,8 +3,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Field** | **FieldEnum** | The field to sort the results on. It could be the total money spent at the merchant, the date of the first visit (etc).  Default value: `DEFAULT`. | [optional] 
-**Order** | **OrderEnum** | Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default value: `ASC`. | [optional] 
+**Field** | **FieldEnum** | The field to sort the results on. It could be the total money spent at the merchant, the date of the first visit (etc). See [CustomerSortField](#type-customersortfield) for possible values. Default value: `DEFAULT`. | [optional] 
+**Order** | **OrderEnum** | Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. See [SortOrder](#type-sortorder) for possible values. Default value: `ASC`. | [optional] 
 
 
 ## FieldEnum

docs/CustomersApi.md

@@ -418,7 +418,7 @@ Name | Type | Description  | Notes
 
 SearchCustomers
 
-Searches a business's customers.
+Searches the customer profiles associated with a Square account. Calling SearchCustomers without an explicit query parameter returns all customer profiles ordered alphabetically based on `given_name` and `family_name`.
 
 ### Example
 ```csharp

src/Square.Connect/Api/ApplePayApi.cs

@@ -225,7 +225,7 @@ public ApiResponse< RegisterDomainResponse > RegisterDomainWithHttpInfo (Registe
             String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts);
             if (localVarHttpHeaderAccept != null)
                 localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept);
-
+            localVarHeaderParams.Add("Square-Version", "2018-07-12");
             if (body != null && body.GetType() != typeof(byte[]))
             {
                 localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter

src/Square.Connect/Api/CatalogApi.cs

@@ -649,7 +649,7 @@ public ApiResponse< BatchDeleteCatalogObjectsResponse > BatchDeleteCatalogObject
             String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts);
             if (localVarHttpHeaderAccept != null)
                 localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept);
-
+            localVarHeaderParams.Add("Square-Version", "2018-07-12");
             if (body != null && body.GetType() != typeof(byte[]))
             {
                 localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter
@@ -812,7 +812,7 @@ public ApiResponse< BatchRetrieveCatalogObjectsResponse > BatchRetrieveCatalogOb
             String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts);
             if (localVarHttpHeaderAccept != null)
                 localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept);
-
+            localVarHeaderParams.Add("Square-Version", "2018-07-12");
             if (body != null && body.GetType() != typeof(byte[]))
             {
                 localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter
@@ -975,7 +975,7 @@ public ApiResponse< BatchUpsertCatalogObjectsResponse > BatchUpsertCatalogObject
             String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts);
             if (localVarHttpHeaderAccept != null)
                 localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept);
-
+            localVarHeaderParams.Add("Square-Version", "2018-07-12");
             if (body != null && body.GetType() != typeof(byte[]))
             {
                 localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter
@@ -1133,7 +1133,7 @@ public ApiResponse< CatalogInfoResponse > CatalogInfoWithHttpInfo ()
             String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts);
             if (localVarHttpHeaderAccept != null)
                 localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept);
-
+            localVarHeaderParams.Add("Square-Version", "2018-07-12");
 
             // authentication (oauth2) required
             // oauth required
@@ -1275,7 +1275,7 @@ public ApiResponse< DeleteCatalogObjectResponse > DeleteCatalogObjectWithHttpInf
             String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts);
             if (localVarHttpHeaderAccept != null)
                 localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept);
-
+            localVarHeaderParams.Add("Square-Version", "2018-07-12");
             if (objectId != null) localVarPathParams.Add("object_id", Configuration.ApiClient.ParameterToString(objectId)); // path parameter
 
             // authentication (oauth2) required
@@ -1423,7 +1423,7 @@ public ApiResponse< ListCatalogResponse > ListCatalogWithHttpInfo (string cursor
             String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts);
             if (localVarHttpHeaderAccept != null)
                 localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept);
-
+            localVarHeaderParams.Add("Square-Version", "2018-07-12");
             if (cursor != null) localVarQueryParams.Add("cursor", Configuration.ApiClient.ParameterToString(cursor)); // query parameter
             if (types != null) localVarQueryParams.Add("types", Configuration.ApiClient.ParameterToString(types)); // query parameter
 
@@ -1575,7 +1575,7 @@ public ApiResponse< RetrieveCatalogObjectResponse > RetrieveCatalogObjectWithHtt
             String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts);
             if (localVarHttpHeaderAccept != null)
                 localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept);
-
+            localVarHeaderParams.Add("Square-Version", "2018-07-12");
             if (objectId != null) localVarPathParams.Add("object_id", Configuration.ApiClient.ParameterToString(objectId)); // path parameter
             if (includeRelatedObjects != null) localVarQueryParams.Add("include_related_objects", Configuration.ApiClient.ParameterToString(includeRelatedObjects)); // query parameter
 
@@ -1728,7 +1728,7 @@ public ApiResponse< SearchCatalogObjectsResponse > SearchCatalogObjectsWithHttpI
             String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts);
             if (localVarHttpHeaderAccept != null)
                 localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept);
-
+            localVarHeaderParams.Add("Square-Version", "2018-07-12");
             if (body != null && body.GetType() != typeof(byte[]))
             {
                 localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter
@@ -1891,7 +1891,7 @@ public ApiResponse< UpdateItemModifierListsResponse > UpdateItemModifierListsWit
             String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts);
             if (localVarHttpHeaderAccept != null)
                 localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept);
-
+            localVarHeaderParams.Add("Square-Version", "2018-07-12");
             if (body != null && body.GetType() != typeof(byte[]))
             {
                 localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter
@@ -2054,7 +2054,7 @@ public ApiResponse< UpdateItemTaxesResponse > UpdateItemTaxesWithHttpInfo (Updat
             String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts);
             if (localVarHttpHeaderAccept != null)
                 localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept);
-
+            localVarHeaderParams.Add("Square-Version", "2018-07-12");
             if (body != null && body.GetType() != typeof(byte[]))
             {
                 localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter
@@ -2217,7 +2217,7 @@ public ApiResponse< UpsertCatalogObjectResponse > UpsertCatalogObjectWithHttpInf
             String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts);
             if (localVarHttpHeaderAccept != null)
                 localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept);
-
+            localVarHeaderParams.Add("Square-Version", "2018-07-12");
             if (body != null && body.GetType() != typeof(byte[]))
             {
                 localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter

src/Square.Connect/Api/CheckoutApi.cs

@@ -234,7 +234,7 @@ public ApiResponse< CreateCheckoutResponse > CreateCheckoutWithHttpInfo (string
             String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts);
             if (localVarHttpHeaderAccept != null)
                 localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept);
-
+            localVarHeaderParams.Add("Square-Version", "2018-07-12");
             if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter
             if (body != null && body.GetType() != typeof(byte[]))
             {