Merge pull request #13 from square/release/2.6.1

Release 2.6.1
square · Mar 28, 2018 · 655f39c · 655f39c
2 parents d4ccc1c + c3f6118
commit 655f39c
Show file tree

Hide file tree

Showing 172 changed files with 188 additions and 184 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,9 @@
 # Change Log
 
+## Version 2.6.1 (2018-03-28)
+
+* Updates user-agent header
+
 ## Version 2.6.0 (2018-03-27)
 
 ### Improvements: Orders API

diff --git a/README.md b/README.md
@@ -31,7 +31,7 @@ oauth2.accessToken = "YOUR ACCESS TOKEN";
 
 var api = new SquareConnect.LocationsApi();
 
-api.listLocations.then(function(data) {
+api.listLocations().then(function(data) {
   console.log('API called successfully. Returned data: ' + data);
 }, function(error) {
   console.error(error);

diff --git a/docs/OrdersApi.md b/docs/OrdersApi.md
@@ -14,7 +14,7 @@ Method | HTTP request | Description
 
 BatchRetrieveOrders
 
-Retrieves a set of [Order](#type-order)s by their IDs.  If a provided Order ID does not exist, it is ignored instead of resulting in an error.
+Retrieves a set of [Order](#type-order)s by their IDs.  If a given Order ID does not exist, the ID is ignored instead of generating an error.
 
 ### Example
 ```javascript

diff --git a/docs/V1SettlementEntry.md b/docs/V1SettlementEntry.md
@@ -43,10 +43,10 @@ Name | Type | Description | Notes
 
 * `SUBSCRIPTION_FEE_REFUND` (value: `"SUBSCRIPTION_FEE_REFUND"`)
 
-* `INCENTED_PAYMENT` (value: `"INCENTED_PAYMENT"`)
-
 * `OTHER` (value: `"OTHER"`)
 
+* `INCENTED_PAYMENT` (value: `"INCENTED_PAYMENT"`)
+
 * `RETURNED_ACH_ENTRY` (value: `"RETURNED_ACH_ENTRY"`)
 
 * `RETURNED_SQUARE_275` (value: `"RETURNED_SQUARE_275"`)

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "square-connect",
-  "version": "2.6.0",
+  "version": "2.6.1",
   "description": "JavaScript client library for the Square Connect v2 API",
   "keywords": [
     "square",

diff --git a/src/ApiClient.js b/src/ApiClient.js
@@ -16,7 +16,7 @@ var querystring = require('querystring');
 
   /**
  * @module ApiClient
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**
@@ -48,7 +48,7 @@ var exports = function() {
    * @default {}
    */
   this.defaultHeaders = {
-    'User-Agent': 'Square-Connect-Javascript/2.6.0'
+    'User-Agent': 'Square-Connect-Javascript/2.6.1'
   };
   /**
    * The default HTTP timeout for all API calls.

diff --git a/src/api/ApplePayApi.js b/src/api/ApplePayApi.js
@@ -18,7 +18,7 @@ var RegisterDomainResponse = require('../model/RegisterDomainResponse');
 /**
  * ApplePay service.
  * @module api/ApplePayApi
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/api/CatalogApi.js b/src/api/CatalogApi.js
@@ -34,7 +34,7 @@ var UpsertCatalogObjectResponse = require('../model/UpsertCatalogObjectResponse'
 /**
  * Catalog service.
  * @module api/CatalogApi
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/api/CheckoutApi.js b/src/api/CheckoutApi.js
@@ -18,7 +18,7 @@ var CreateCheckoutResponse = require('../model/CreateCheckoutResponse');
 /**
  * Checkout service.
  * @module api/CheckoutApi
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/api/CustomersApi.js b/src/api/CustomersApi.js
@@ -26,7 +26,7 @@ var UpdateCustomerResponse = require('../model/UpdateCustomerResponse');
 /**
  * Customers service.
  * @module api/CustomersApi
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/api/LocationsApi.js b/src/api/LocationsApi.js
@@ -17,7 +17,7 @@ var ListLocationsResponse = require('../model/ListLocationsResponse');
 /**
  * Locations service.
  * @module api/LocationsApi
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/api/OrdersApi.js b/src/api/OrdersApi.js
@@ -20,7 +20,7 @@ var CreateOrderResponse = require('../model/CreateOrderResponse');
 /**
  * Orders service.
  * @module api/OrdersApi
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**
@@ -37,7 +37,7 @@ module.exports = function(apiClient) {
 
   /**
    * BatchRetrieveOrders
-   * Retrieves a set of [Order](#type-order)s by their IDs.  If a provided Order ID does not exist, it is ignored instead of resulting in an error.
+   * Retrieves a set of [Order](#type-order)s by their IDs.  If a given Order ID does not exist, the ID is ignored instead of generating an error.
    * @param {String} locationId The ID of the orders&#39; associated location.
    * @param {module:model/BatchRetrieveOrdersRequest} body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BatchRetrieveOrdersResponse} and HTTP response
@@ -80,7 +80,7 @@ module.exports = function(apiClient) {
 
   /**
    * BatchRetrieveOrders
-   * Retrieves a set of [Order](#type-order)s by their IDs.  If a provided Order ID does not exist, it is ignored instead of resulting in an error.
+   * Retrieves a set of [Order](#type-order)s by their IDs.  If a given Order ID does not exist, the ID is ignored instead of generating an error.
    * @param {String} locationId The ID of the orders&#39; associated location.
    * @param {module:model/BatchRetrieveOrdersRequest} body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BatchRetrieveOrdersResponse}

diff --git a/src/api/ReportingApi.js b/src/api/ReportingApi.js
@@ -18,7 +18,7 @@ var ListAdditionalRecipientReceivablesResponse = require('../model/ListAdditiona
 /**
  * Reporting service.
  * @module api/ReportingApi
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/api/TransactionsApi.js b/src/api/TransactionsApi.js
@@ -25,7 +25,7 @@ var VoidTransactionResponse = require('../model/VoidTransactionResponse');
 /**
  * Transactions service.
  * @module api/TransactionsApi
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/api/V1EmployeesApi.js b/src/api/V1EmployeesApi.js
@@ -21,7 +21,7 @@ var V1TimecardEvent = require('../model/V1TimecardEvent');
 /**
  * V1Employees service.
  * @module api/V1EmployeesApi
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/api/V1ItemsApi.js b/src/api/V1ItemsApi.js
@@ -28,7 +28,7 @@ var V1Variation = require('../model/V1Variation');
 /**
  * V1Items service.
  * @module api/V1ItemsApi
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/api/V1LocationsApi.js b/src/api/V1LocationsApi.js
@@ -17,7 +17,7 @@ var V1Merchant = require('../model/V1Merchant');
 /**
  * V1Locations service.
  * @module api/V1LocationsApi
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/api/V1TransactionsApi.js b/src/api/V1TransactionsApi.js
@@ -23,11 +23,11 @@ var V1UpdateOrderRequest = require('../model/V1UpdateOrderRequest');
 /**
  * V1Transactions service.
  * @module api/V1TransactionsApi
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**
- * Constructs a new V1TransactionsApi.
+ * Constructs a new V1TransactionsApi. 
  * @alias module:api/V1TransactionsApi
  * @class
  * @param {module:ApiClient} apiClient Optional API client implementation to use,
@@ -350,7 +350,7 @@ module.exports = function(apiClient) {
 
   /**
    * Provides summary information for all deposits and withdrawals initiated by Square to a merchant&#39;s bank account during a date range. Date ranges cannot exceed one year in length.
-   * Provides summary information for all deposits and withdrawals initiated by Square to a merchant&#39;s bank account during a date range. Date ranges cannot exceed one year in length.
+   * Provides summary information for all deposits and withdrawals initiated by Square to a merchant&#39;s bank account during a date range. Date ranges cannot exceed one year in length. 
    * @param {String} locationId The ID of the location to list settlements for. If you specify me, this endpoint returns payments aggregated from all of the business&#39;s locations.
    * @param {Object} opts Optional parameters
    * @param {module:model/String} opts.order TThe order in which payments are listed in the response.
@@ -401,7 +401,7 @@ module.exports = function(apiClient) {
 
   /**
    * Provides summary information for all deposits and withdrawals initiated by Square to a merchant&#39;s bank account during a date range. Date ranges cannot exceed one year in length.
-   * Provides summary information for all deposits and withdrawals initiated by Square to a merchant&#39;s bank account during a date range. Date ranges cannot exceed one year in length.
+   * Provides summary information for all deposits and withdrawals initiated by Square to a merchant&#39;s bank account during a date range. Date ranges cannot exceed one year in length. 
    * @param {String} locationId The ID of the location to list settlements for. If you specify me, this endpoint returns payments aggregated from all of the business&#39;s locations.
    * @param {Object} opts Optional parameters
    * @param {module:model/String} opts.order TThe order in which payments are listed in the response.

diff --git a/src/index.js b/src/index.js
@@ -236,7 +236,7 @@ var V1TransactionsApi = require('./api/V1TransactionsApi');
  * </pre>
  * </p>
  * @module index
- * @version 2.6.0
+ * @version 2.6.1
  */
   module.exports = {
   /**

diff --git a/src/model/AdditionalRecipient.js b/src/model/AdditionalRecipient.js
@@ -20,7 +20,7 @@ var Money = require('./Money');
 /**
  * The AdditionalRecipient model module.
  * @module model/AdditionalRecipient
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/AdditionalRecipientReceivable.js b/src/model/AdditionalRecipientReceivable.js
@@ -21,7 +21,7 @@ var Money = require('./Money');
 /**
  * The AdditionalRecipientReceivable model module.
  * @module model/AdditionalRecipientReceivable
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/AdditionalRecipientReceivableRefund.js b/src/model/AdditionalRecipientReceivableRefund.js
@@ -20,7 +20,7 @@ var Money = require('./Money');
 /**
  * The AdditionalRecipientReceivableRefund model module.
  * @module model/AdditionalRecipientReceivableRefund
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/Address.js b/src/model/Address.js
@@ -19,7 +19,7 @@ var ApiClient = require('../ApiClient');
 /**
  * The Address model module.
  * @module model/Address
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/BatchDeleteCatalogObjectsRequest.js b/src/model/BatchDeleteCatalogObjectsRequest.js
@@ -19,7 +19,7 @@ var ApiClient = require('../ApiClient');
 /**
  * The BatchDeleteCatalogObjectsRequest model module.
  * @module model/BatchDeleteCatalogObjectsRequest
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/BatchDeleteCatalogObjectsResponse.js b/src/model/BatchDeleteCatalogObjectsResponse.js
@@ -20,7 +20,7 @@ var Error = require('./Error');
 /**
  * The BatchDeleteCatalogObjectsResponse model module.
  * @module model/BatchDeleteCatalogObjectsResponse
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/BatchRetrieveCatalogObjectsRequest.js b/src/model/BatchRetrieveCatalogObjectsRequest.js
@@ -19,7 +19,7 @@ var ApiClient = require('../ApiClient');
 /**
  * The BatchRetrieveCatalogObjectsRequest model module.
  * @module model/BatchRetrieveCatalogObjectsRequest
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/BatchRetrieveCatalogObjectsResponse.js b/src/model/BatchRetrieveCatalogObjectsResponse.js
@@ -21,7 +21,7 @@ var Error = require('./Error');
 /**
  * The BatchRetrieveCatalogObjectsResponse model module.
  * @module model/BatchRetrieveCatalogObjectsResponse
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/BatchRetrieveOrdersRequest.js b/src/model/BatchRetrieveOrdersRequest.js
@@ -19,7 +19,7 @@ var ApiClient = require('../ApiClient');
 /**
  * The BatchRetrieveOrdersRequest model module.
  * @module model/BatchRetrieveOrdersRequest
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/BatchRetrieveOrdersResponse.js b/src/model/BatchRetrieveOrdersResponse.js
@@ -21,7 +21,7 @@ var Order = require('./Order');
 /**
  * The BatchRetrieveOrdersResponse model module.
  * @module model/BatchRetrieveOrdersResponse
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/BatchUpsertCatalogObjectsRequest.js b/src/model/BatchUpsertCatalogObjectsRequest.js
@@ -20,7 +20,7 @@ var CatalogObjectBatch = require('./CatalogObjectBatch');
 /**
  * The BatchUpsertCatalogObjectsRequest model module.
  * @module model/BatchUpsertCatalogObjectsRequest
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/BatchUpsertCatalogObjectsResponse.js b/src/model/BatchUpsertCatalogObjectsResponse.js
@@ -22,7 +22,7 @@ var Error = require('./Error');
 /**
  * The BatchUpsertCatalogObjectsResponse model module.
  * @module model/BatchUpsertCatalogObjectsResponse
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/CaptureTransactionRequest.js b/src/model/CaptureTransactionRequest.js
@@ -19,7 +19,7 @@ var ApiClient = require('../ApiClient');
 /**
  * The CaptureTransactionRequest model module.
  * @module model/CaptureTransactionRequest
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/CaptureTransactionResponse.js b/src/model/CaptureTransactionResponse.js
@@ -20,7 +20,7 @@ var Error = require('./Error');
 /**
  * The CaptureTransactionResponse model module.
  * @module model/CaptureTransactionResponse
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/Card.js b/src/model/Card.js
@@ -20,7 +20,7 @@ var Address = require('./Address');
 /**
  * The Card model module.
  * @module model/Card
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/CatalogCategory.js b/src/model/CatalogCategory.js
@@ -19,7 +19,7 @@ var ApiClient = require('../ApiClient');
 /**
  * The CatalogCategory model module.
  * @module model/CatalogCategory
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/CatalogDiscount.js b/src/model/CatalogDiscount.js
@@ -20,7 +20,7 @@ var Money = require('./Money');
 /**
  * The CatalogDiscount model module.
  * @module model/CatalogDiscount
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/CatalogIdMapping.js b/src/model/CatalogIdMapping.js
@@ -19,7 +19,7 @@ var ApiClient = require('../ApiClient');
 /**
  * The CatalogIdMapping model module.
  * @module model/CatalogIdMapping
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**

diff --git a/src/model/CatalogInfoRequest.js b/src/model/CatalogInfoRequest.js
@@ -19,7 +19,7 @@ var ApiClient = require('../ApiClient');
 /**
  * The CatalogInfoRequest model module.
  * @module model/CatalogInfoRequest
- * @version 2.6.0
+ * @version 2.6.1
  */
 
 /**