Merge pull request #93 from square/release/3.20200422.1

Release 3.20200422.1

CHANGES.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## Version 3.20200422.1 (2020-04-22)
+## API releases
+* **Customer Segments API (beta).** `limit` field removed from **ListCustomerSegments** endpoint.
+
+
+**Note:** This release fixes a bug introduced on the [April 22, 2020](changelog/connect-logs/2020-04-22) release of the Square API.
+
+
 ## Version 3.20200422.0 (2020-04-22)
 ## API releases
 * **Terminal API.** The new Terminal API lets a custom third-party POS app integrate with the Square Terminal to send terminal checkout requests to collect payments.

docs/CustomerGroupsApi.md

@@ -18,7 +18,7 @@ Method | HTTP request | Description
 
 CreateCustomerGroup
 
-Creates a new customer group for a business.   The request must include at least the `name` value of the group.
+Creates a new customer group for a business.   The request must include the `name` value of the group.
 
 ### Example
 ```javascript

docs/CustomerSegmentsApi.md

@@ -29,8 +29,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN';
 var apiInstance = new SquareConnect.CustomerSegmentsApi();
 
 var opts = { 
-  'cursor': "cursor_example", // String | A pagination cursor returned by previous calls to __ListCustomerSegments__. Used to retrieve the next set of query results.  See the [Pagination guide](https://developer.squareup.com/docs/docs/working-with-apis/pagination) for more information.
-  'limit': 789 // Number | Sets the maximum number of results to be returned in a single page. Limit values outside the supported range are ignored.  Minimum value: `1` Maximum value: `1,000`
+  'cursor': "cursor_example" // String | A pagination cursor returned by previous calls to __ListCustomerSegments__. Used to retrieve the next set of query results.  See the [Pagination guide](https://developer.squareup.com/docs/docs/working-with-apis/pagination) for more information.
 };
 apiInstance.listCustomerSegments(opts).then(function(data) {
   console.log('API called successfully. Returned data: ' + data);
@@ -45,7 +44,6 @@ apiInstance.listCustomerSegments(opts).then(function(data) {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **cursor** | **String**| A pagination cursor returned by previous calls to __ListCustomerSegments__. Used to retrieve the next set of query results.  See the [Pagination guide](https://developer.squareup.com/docs/docs/working-with-apis/pagination) for more information. | [optional] 
- **limit** | **Number**| Sets the maximum number of results to be returned in a single page. Limit values outside the supported range are ignored.  Minimum value: `1` Maximum value: `1,000` | [optional] 
 
 ### Return type
 

docs/CustomersApi.md

@@ -23,7 +23,7 @@ Method | HTTP request | Description
 
 AddGroupToCustomer
 
-Adds a customer membership to a customer group.   The customer is identified by the `customer_id` value  and the customer group is identified by the `group_id` value.
+Adds a group membership to a customer.   The customer is identified by the `customer_id` value  and the customer group is identified by the `group_id` value.
 
 ### Example
 ```javascript
@@ -326,7 +326,7 @@ Name | Type | Description  | Notes
 
 RemoveGroupFromCustomer
 
-Removes a customer membership from a customer group.   The customer is identified by the `customer_id` value  and the customer group is identified by the `group_id` value.
+Removes a group membership from a customer.   The customer is identified by the `customer_id` value  and the customer group is identified by the `group_id` value.
 
 ### Example
 ```javascript

docs/ListCustomerSegmentsRequest.md

@@ -9,6 +9,5 @@ Defines the valid parameters for requests to __ListCustomerSegments__.
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **cursor** | **String** | A pagination cursor returned by previous calls to __ListCustomerSegments__. Used to retrieve the next set of query results.  See the [Pagination guide](https://developer.squareup.com/docs/docs/working-with-apis/pagination) for more information. | [optional] 
-**limit** | **Number** | Sets the maximum number of results to be returned in a single page. Limit values outside the supported range are ignored.  Minimum value: `1` Maximum value: `1,000` | [optional] 
 
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "square-connect",
-  "version": "3.20200422.0",
+  "version": "3.20200422.1",
   "description": "JavaScript client library for the Square Connect v2 API",
   "keywords": [
     "square",

src/ApiClient.js

@@ -17,7 +17,7 @@ var HeaderUtils = require('./lib/HeaderUtils');
 
   /**
  * @module ApiClient
- * @version 3.20200422.0
+ * @version 3.20200422.1
  */
 
 /**
@@ -49,7 +49,7 @@ var exports = function() {
    * @default {}
    */
   this.defaultHeaders = {
-    'User-Agent': 'Square-Connect-Javascript/3.20200422.0'
+    'User-Agent': 'Square-Connect-Javascript/3.20200422.1'
   };
   /**
    * The default HTTP timeout for all API calls.

src/api/CustomerGroupsApi.js

@@ -40,7 +40,7 @@ module.exports = function(apiClient) {
   /**
    * CreateCustomerGroup
    * Note: This endpoint is in beta.
-   * Creates a new customer group for a business.   The request must include at least the `name` value of the group.
+   * Creates a new customer group for a business.   The request must include the `name` value of the group.
    * @param {module:model/CreateCustomerGroupRequest} 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/CreateCustomerGroupResponse} and HTTP response
    */
@@ -78,7 +78,7 @@ module.exports = function(apiClient) {
 
   /**
    * CreateCustomerGroup
-   * Creates a new customer group for a business.   The request must include at least the `name` value of the group.
+   * Creates a new customer group for a business.   The request must include the `name` value of the group.
    * @param {module:model/CreateCustomerGroupRequest} 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/CreateCustomerGroupResponse}
    */

src/api/CustomerSegmentsApi.js

@@ -38,7 +38,6 @@ module.exports = function(apiClient) {
    * Retrieves the list of customer segments of a business.
    * @param {Object} opts Optional parameters
    * @param {String} opts.cursor A pagination cursor returned by previous calls to __ListCustomerSegments__. Used to retrieve the next set of query results.  See the [Pagination guide](https://developer.squareup.com/docs/docs/working-with-apis/pagination) for more information.
-   * @param {Number} opts.limit Sets the maximum number of results to be returned in a single page. Limit values outside the supported range are ignored.  Minimum value: `1` Maximum value: `1,000`
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListCustomerSegmentsResponse} and HTTP response
    */
   this.listCustomerSegmentsWithHttpInfo = function(opts) {
@@ -49,8 +48,7 @@ module.exports = function(apiClient) {
     var pathParams = {
     };
     var queryParams = {
-      'cursor': opts['cursor'],
-      'limit': opts['limit']
+      'cursor': opts['cursor']
     };
     var headerParams = {
     };
@@ -76,7 +74,6 @@ module.exports = function(apiClient) {
    * Retrieves the list of customer segments of a business.
    * @param {Object} opts Optional parameters
    * @param {String} opts.cursor A pagination cursor returned by previous calls to __ListCustomerSegments__. Used to retrieve the next set of query results.  See the [Pagination guide](https://developer.squareup.com/docs/docs/working-with-apis/pagination) for more information.
-   * @param {Number} opts.limit Sets the maximum number of results to be returned in a single page. Limit values outside the supported range are ignored.  Minimum value: `1` Maximum value: `1,000`
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListCustomerSegmentsResponse}
    */
   this.listCustomerSegments = function(opts) {

src/api/CustomersApi.js

@@ -47,7 +47,7 @@ module.exports = function(apiClient) {
   /**
    * AddGroupToCustomer
    * Note: This endpoint is in beta.
-   * Adds a customer membership to a customer group.   The customer is identified by the `customer_id` value  and the customer group is identified by the `group_id` value.
+   * Adds a group membership to a customer.   The customer is identified by the `customer_id` value  and the customer group is identified by the `group_id` value.
    * @param {String} customerId The ID of the customer to add to a group.
    * @param {String} groupId The ID of the customer group to add the customer to.
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddGroupToCustomerResponse} and HTTP response
@@ -93,7 +93,7 @@ module.exports = function(apiClient) {
 
   /**
    * AddGroupToCustomer
-   * Adds a customer membership to a customer group.   The customer is identified by the `customer_id` value  and the customer group is identified by the `group_id` value.
+   * Adds a group membership to a customer.   The customer is identified by the `customer_id` value  and the customer group is identified by the `group_id` value.
    * @param {String} customerId The ID of the customer to add to a group.
    * @param {String} groupId The ID of the customer group to add the customer to.
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddGroupToCustomerResponse}
@@ -392,7 +392,7 @@ module.exports = function(apiClient) {
   /**
    * RemoveGroupFromCustomer
    * Note: This endpoint is in beta.
-   * Removes a customer membership from a customer group.   The customer is identified by the `customer_id` value  and the customer group is identified by the `group_id` value.
+   * Removes a group membership from a customer.   The customer is identified by the `customer_id` value  and the customer group is identified by the `group_id` value.
    * @param {String} customerId The ID of the customer to remove from the group.
    * @param {String} groupId The ID of the customer group to remove the customer from.
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RemoveGroupFromCustomerResponse} and HTTP response
@@ -438,7 +438,7 @@ module.exports = function(apiClient) {
 
   /**
    * RemoveGroupFromCustomer
-   * Removes a customer membership from a customer group.   The customer is identified by the `customer_id` value  and the customer group is identified by the `group_id` value.
+   * Removes a group membership from a customer.   The customer is identified by the `customer_id` value  and the customer group is identified by the `group_id` value.
    * @param {String} customerId The ID of the customer to remove from the group.
    * @param {String} groupId The ID of the customer group to remove the customer from.
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RemoveGroupFromCustomerResponse}

src/index.js

@@ -688,7 +688,7 @@ var V1TransactionsApi = require('./api/V1TransactionsApi');
  * </pre>
  * </p>
  * @module index
- * @version 3.20200422.0
+ * @version 3.20200422.1
  */
   module.exports = {
   /**

src/model/ListCustomerSegmentsRequest.js

@@ -32,7 +32,6 @@ var exports = function() {
   var _this = this;
 
 
-
 };
 
 /**
@@ -48,9 +47,6 @@ exports.constructFromObject = function(data, obj) {
 
       if (data.hasOwnProperty('cursor')) {
       obj['cursor'] = ApiClient.convertToType(data['cursor'], 'String');
-    }
-      if (data.hasOwnProperty('limit')) {
-      obj['limit'] = ApiClient.convertToType(data['limit'], 'Number');
     }
     }
   return obj;
@@ -61,11 +57,6 @@ exports.constructFromObject = function(data, obj) {
  * @member {String} cursor
  */
 exports.prototype['cursor'] = undefined;
-/**
- * Sets the maximum number of results to be returned in a single page. Limit values outside the supported range are ignored.  Minimum value: `1` Maximum value: `1,000`
- * @member {Number} limit
- */
-exports.prototype['limit'] = undefined;