Merge pull request #11 from square/release/5.2.1.20200422

lindzeng · web-flow · commit 95416de9fac0 · 2020-04-22T15:26:36.000-07:00
5.2.1.20200422 release
diff --git a/doc/customer-groups.md b/doc/customer-groups.md
@@ -50,7 +50,7 @@ customerGroupsApi.listCustomerGroupsAsync(null).thenAccept(result -> {
 
 Creates a new customer group for a business. 
 
-The request must include at least the `name` value of the group.
+The request must include the `name` value of the group.
 
 ```java
 CompletableFuture<CreateCustomerGroupResponse> createCustomerGroupAsync(
diff --git a/doc/customer-segments.md b/doc/customer-segments.md
@@ -19,16 +19,14 @@ Retrieves the list of customer segments of a business.
 
 ```java
 CompletableFuture<ListCustomerSegmentsResponse> listCustomerSegmentsAsync(
-    final String cursor,
-    final Long limit)
+    final String cursor)
 ```
 
 ### Parameters
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `cursor` | `String` | Query, Optional | A pagination cursor returned by previous calls to __ListCustomerSegments__.<br>Used to retrieve the next set of query results.<br><br>See the [Pagination guide](https://developer.squareup.com/docs/docs/working-with-apis/pagination) for more information. |
-| `limit` | `Long` | Query, Optional | Sets the maximum number of results to be returned in a single page.<br>Limit values outside the supported range are ignored.<br><br>Minimum value: `1`<br>Maximum value: `1,000` |
 
 ### Response Type
 
@@ -37,7 +35,7 @@ CompletableFuture<ListCustomerSegmentsResponse> listCustomerSegmentsAsync(
 ### Example Usage
 
 ```java
-customerSegmentsApi.listCustomerSegmentsAsync(null, null).thenAccept(result -> {
+customerSegmentsApi.listCustomerSegmentsAsync(null).thenAccept(result -> {
     // TODO success callback handler
 }).exceptionally(exception -> {
     // TODO failure callback handler
diff --git a/doc/customers.md b/doc/customers.md
@@ -147,9 +147,15 @@ TimeRange bodyQueryFilterCreatedAt = new TimeRange.Builder()
     .startAt("2018-01-01T00:00:00-00:00")
     .endAt("2018-02-01T00:00:00-00:00")
     .build();
+List<String> bodyQueryFilterGroupIdsAll = new LinkedList<>();
+bodyQueryFilterGroupIdsAll.add("545AXB44B4XXWMVQ4W8SBT3HHF");
+FilterValue bodyQueryFilterGroupIds = new FilterValue.Builder()
+    .all(bodyQueryFilterGroupIdsAll)
+    .build();
 CustomerFilter bodyQueryFilter = new CustomerFilter.Builder()
     .creationSource(bodyQueryFilterCreationSource)
     .createdAt(bodyQueryFilterCreatedAt)
+    .groupIds(bodyQueryFilterGroupIds)
     .build();
 CustomerSort bodyQuerySort = new CustomerSort.Builder()
     .field("CREATED_AT")
@@ -372,7 +378,7 @@ customersApi.deleteCustomerCardAsync(customerId, cardId).thenAccept(result -> {
 
 ## Remove Group From Customer
 
-Removes a customer membership from a customer group. 
+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.
@@ -410,7 +416,7 @@ customersApi.removeGroupFromCustomerAsync(customerId, groupId).thenAccept(result
 
 ## Add Group to Customer
 
-Adds a customer membership to a customer group. 
+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.
diff --git a/doc/models/list-customer-segments-request.md b/doc/models/list-customer-segments-request.md
@@ -11,7 +11,6 @@ Defines the valid parameters for requests to __ListCustomerSegments__.
 | Name | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `Cursor` | `String` | Optional | A pagination cursor returned by previous calls to __ListCustomerSegments__.<br>Used to retrieve the next set of query results.<br><br>See the [Pagination guide](https://developer.squareup.com/docs/docs/working-with-apis/pagination) for more information. |
-| `Limit` | `Long` | Optional | Sets the maximum number of results to be returned in a single page.<br>Limit values outside the supported range are ignored.<br><br>Minimum value: `1`<br>Maximum value: `1,000` |
 
 ### Example (as JSON)
 
diff --git a/doc/models/list-customers-response.md b/doc/models/list-customers-response.md
@@ -42,9 +42,19 @@ One of `errors` or `customers` is present in a given response (never both).
       "note": "a customer",
       "groups": [
         {
-          "id": "16894e93-96eb-4ced-b24b-f71d42bf084c",
+          "id": "545AXB44B4XXWMVQ4W8SBT3HHF",
           "name": "Aviation Enthusiasts"
+        },
+        {
+          "id": "1KB9JE5EGJXCW.REACHABLE",
+          "name": "Reachable"
         }
+      ],
+      "group_ids": [
+        "545AXB44B4XXWMVQ4W8SBT3HHF"
+      ],
+      "segment_ids": [
+        "1KB9JE5EGJXCW.REACHABLE"
       ]
     }
   ]
diff --git a/doc/models/retrieve-customer-response.md b/doc/models/retrieve-customer-response.md
@@ -40,9 +40,19 @@ One of `errors` or `customer` is present in a given response (never both).
     "note": "a customer",
     "groups": [
       {
-        "id": "16894e93-96eb-4ced-b24b-f71d42bf084c",
+        "id": "545AXB44B4XXWMVQ4W8SBT3HHF",
         "name": "Aviation Enthusiasts"
+      },
+      {
+        "id": "1KB9JE5EGJXCW.REACHABLE",
+        "name": "Reachable"
       }
+    ],
+    "group_ids": [
+      "545AXB44B4XXWMVQ4W8SBT3HHF"
+    ],
+    "segment_ids": [
+      "1KB9JE5EGJXCW.REACHABLE"
     ]
   }
 }
diff --git a/doc/models/search-customers-request.md b/doc/models/search-customers-request.md
@@ -30,6 +30,11 @@ SearchCustomers endpoint.
       "created_at": {
         "start_at": "2018-01-01T00:00:00-00:00",
         "end_at": "2018-02-01T00:00:00-00:00"
+      },
+      "group_ids": {
+        "all": [
+          "545AXB44B4XXWMVQ4W8SBT3HHF"
+        ]
       }
     },
     "sort": {
diff --git a/doc/models/search-customers-response.md b/doc/models/search-customers-response.md
@@ -39,7 +39,23 @@ One of `errors` or `customers` is present in a given response (never both).
       },
       "phone_number": "1-212-555-4250",
       "reference_id": "YOUR_REFERENCE_ID_2",
-      "creation_source": "THIRD_PARTY"
+      "creation_source": "THIRD_PARTY",
+      "groups": [
+        {
+          "id": "545AXB44B4XXWMVQ4W8SBT3HHF",
+          "name": "Aviation Enthusiasts"
+        },
+        {
+          "id": "1KB9JE5EGJXCW.REACHABLE",
+          "name": "Reachable"
+        }
+      ],
+      "group_ids": [
+        "545AXB44B4XXWMVQ4W8SBT3HHF"
+      ],
+      "segment_ids": [
+        "1KB9JE5EGJXCW.REACHABLE"
+      ]
     },
     {
       "id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
@@ -59,7 +75,23 @@ One of `errors` or `customers` is present in a given response (never both).
       "phone_number": "1-212-555-4240",
       "reference_id": "YOUR_REFERENCE_ID_1",
       "note": "a customer",
-      "creation_source": "THIRD_PARTY"
+      "creation_source": "THIRD_PARTY",
+      "groups": [
+        {
+          "id": "545AXB44B4XXWMVQ4W8SBT3HHF",
+          "name": "Aviation Enthusiasts"
+        },
+        {
+          "id": "1KB9JE5EGJXCW.REACHABLE",
+          "name": "Reachable"
+        }
+      ],
+      "group_ids": [
+        "545AXB44B4XXWMVQ4W8SBT3HHF"
+      ],
+      "segment_ids": [
+        "1KB9JE5EGJXCW.REACHABLE"
+      ]
     }
   ],
   "cursor": "9dpS093Uy12AzeE"
diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
 
   <groupId>com.squareup</groupId>
   <artifactId>square</artifactId>
-  <version>5.2.0.20200422</version>
+  <version>5.2.1.20200422</version>
   <packaging>jar</packaging>
 
   <name>Square</name>
@@ -214,4 +214,4 @@
       <scope>test</scope>
     </dependency>
   </dependencies>
-</project>
+</project>
diff --git a/src/main/java/com/squareup/square/SquareClient.java b/src/main/java/com/squareup/square/SquareClient.java
@@ -435,7 +435,7 @@ public Headers getAdditionalHeaders() {
      * @return sdkVersion
      */
     public String getSdkVersion() {
-        return "5.2.0.20200422";
+        return "5.2.1.20200422";
     }
 
     /**
@@ -586,4 +586,4 @@ public SquareClient build() {
                     authManagers, httpCallback);
         }
     }
-}
+}
diff --git a/src/main/java/com/squareup/square/api/BaseApi.java b/src/main/java/com/squareup/square/api/BaseApi.java
@@ -23,7 +23,7 @@ public abstract class BaseApi {
      * Protected variables to hold an instance of Configuration
      */
     protected final Configuration config;
-    protected static final String userAgent = "Square-Java-SDK/5.2.0.20200422";
+    protected static final String userAgent = "Square-Java-SDK/5.2.1.20200422";
 
     /**
      * Protected variable to hold an instance of HttpCallback if the user provides it
diff --git a/src/main/java/com/squareup/square/api/CustomerGroupsApi.java b/src/main/java/com/squareup/square/api/CustomerGroupsApi.java
@@ -142,7 +142,7 @@ private ListCustomerGroupsResponse handleListCustomerGroupsResponse(HttpContext
 
     /**
      * Creates a new customer group for a business. 
-     * The request must include at least the `name` value of the group.
+     * The request must include the `name` value of the group.
      * @param    body    Required parameter: An object containing the fields to POST for the request.  See the corresponding object definition for field details.
      * @return    Returns the CreateCustomerGroupResponse response from the API call
      */
@@ -159,7 +159,7 @@ public CreateCustomerGroupResponse createCustomerGroup(
 
     /**
      * Creates a new customer group for a business. 
-     * The request must include at least the `name` value of the group.
+     * The request must include the `name` value of the group.
      * @param    body    Required parameter: An object containing the fields to POST for the request.  See the corresponding object definition for field details.
      * @return    Returns the CreateCustomerGroupResponse response from the API call 
      */
@@ -506,4 +506,4 @@ private UpdateCustomerGroupResponse handleUpdateCustomerGroupResponse(HttpContex
         return result;
     }
 
-}
+}
diff --git a/src/main/java/com/squareup/square/api/CustomerSegmentsApi.java b/src/main/java/com/squareup/square/api/CustomerSegmentsApi.java
@@ -48,13 +48,11 @@ public CustomerSegmentsApi(Configuration config, HttpClient httpClient, Map<Stri
     /**
      * Retrieves the list of customer segments of a business.
      * @param    cursor    Optional parameter: 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    limit    Optional parameter: 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    Returns the ListCustomerSegmentsResponse response from the API call
      */
     public ListCustomerSegmentsResponse listCustomerSegments(
-            final String cursor,
-            final Long limit) throws ApiException, IOException {
-        HttpRequest request = buildListCustomerSegmentsRequest(cursor, limit);
+            final String cursor) throws ApiException, IOException {
+        HttpRequest request = buildListCustomerSegmentsRequest(cursor);
         authManagers.get("default").apply(request);
 
         HttpResponse response = getClientInstance().executeAsString(request);
@@ -66,13 +64,11 @@ public ListCustomerSegmentsResponse listCustomerSegments(
     /**
      * Retrieves the list of customer segments of a business.
      * @param    cursor    Optional parameter: 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    limit    Optional parameter: 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    Returns the ListCustomerSegmentsResponse response from the API call 
      */
     public CompletableFuture<ListCustomerSegmentsResponse> listCustomerSegmentsAsync(
-            final String cursor,
-            final Long limit) {
-        return makeHttpCallAsync(() -> buildListCustomerSegmentsRequest(cursor, limit),
+            final String cursor) {
+        return makeHttpCallAsync(() -> buildListCustomerSegmentsRequest(cursor),
                 req -> authManagers.get("default").applyAsync(req)
                     .thenCompose(request -> getClientInstance().executeAsStringAsync(request)),
                 context -> handleListCustomerSegmentsResponse(context));
@@ -82,8 +78,7 @@ public CompletableFuture<ListCustomerSegmentsResponse> listCustomerSegmentsAsync
      * Builds the HttpRequest object for listCustomerSegments
      */
     private HttpRequest buildListCustomerSegmentsRequest(
-            final String cursor,
-            final Long limit) {
+            final String cursor) {
         //the base uri for api requests
         String baseUri = config.getBaseUri();
 
@@ -93,7 +88,6 @@ private HttpRequest buildListCustomerSegmentsRequest(
         //process query parameters
         Map<String, Object> queryParameters = new HashMap<>();
         queryParameters.put("cursor", cursor);
-        queryParameters.put("limit", limit);
         ApiHelper.appendUrlWithQueryParameters(queryBuilder, queryParameters);
         //validate and preprocess url
         String queryUrl = ApiHelper.cleanUrl(queryBuilder);
@@ -231,4 +225,4 @@ private RetrieveCustomerSegmentResponse handleRetrieveCustomerSegmentResponse(Ht
         return result;
     }
 
-}
+}
diff --git a/src/main/java/com/squareup/square/api/CustomersApi.java b/src/main/java/com/squareup/square/api/CustomersApi.java
@@ -846,7 +846,7 @@ private DeleteCustomerCardResponse handleDeleteCustomerCardResponse(HttpContext
     }
 
     /**
-     * Removes a customer membership from a customer group. 
+     * 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    customerId    Required parameter: The ID of the customer to remove from the group.
@@ -866,7 +866,7 @@ public RemoveGroupFromCustomerResponse removeGroupFromCustomer(
     }
 
     /**
-     * Removes a customer membership from a customer group. 
+     * 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    customerId    Required parameter: The ID of the customer to remove from the group.
@@ -946,7 +946,7 @@ private RemoveGroupFromCustomerResponse handleRemoveGroupFromCustomerResponse(Ht
     }
 
     /**
-     * Adds a customer membership to a customer group. 
+     * 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    customerId    Required parameter: The ID of the customer to add to a group.
@@ -966,7 +966,7 @@ public AddGroupToCustomerResponse addGroupToCustomer(
     }
 
     /**
-     * Adds a customer membership to a customer group. 
+     * 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    customerId    Required parameter: The ID of the customer to add to a group.
@@ -1045,4 +1045,4 @@ private AddGroupToCustomerResponse handleAddGroupToCustomerResponse(HttpContext
         return result;
     }
 
-}
+}
diff --git a/src/main/java/com/squareup/square/models/ListCustomerSegmentsRequest.java b/src/main/java/com/squareup/square/models/ListCustomerSegmentsRequest.java

Original file line number	Diff line number	Diff line change
@@ -42,9 +42,19 @@ One of `errors` or `customers` is present in a given response (never both).
`42`	`42`	`"note": "a customer",`
`43`	`43`	`"groups": [`
`44`	`44`	`{`
`45`		`- "id": "16894e93-96eb-4ced-b24b-f71d42bf084c",`
	`45`	`+ "id": "545AXB44B4XXWMVQ4W8SBT3HHF",`
`46`	`46`	`"name": "Aviation Enthusiasts"`
	`47`	`+ },`
	`48`	`+ {`
	`49`	`+ "id": "1KB9JE5EGJXCW.REACHABLE",`
	`50`	`+ "name": "Reachable"`
`47`	`51`	`}`
	`52`	`+ ],`
	`53`	`+ "group_ids": [`
	`54`	`+ "545AXB44B4XXWMVQ4W8SBT3HHF"`
	`55`	`+ ],`
	`56`	`+ "segment_ids": [`
	`57`	`+ "1KB9JE5EGJXCW.REACHABLE"`
`48`	`58`	`]`
`49`	`59`	`}`
`50`	`60`	`]`
Original file line number	Diff line number	Diff line change
@@ -40,9 +40,19 @@ One of `errors` or `customer` is present in a given response (never both).
`40`	`40`	`"note": "a customer",`
`41`	`41`	`"groups": [`
`42`	`42`	`{`
`43`		`- "id": "16894e93-96eb-4ced-b24b-f71d42bf084c",`
	`43`	`+ "id": "545AXB44B4XXWMVQ4W8SBT3HHF",`
`44`	`44`	`"name": "Aviation Enthusiasts"`
	`45`	`+ },`
	`46`	`+ {`
	`47`	`+ "id": "1KB9JE5EGJXCW.REACHABLE",`
	`48`	`+ "name": "Reachable"`
`45`	`49`	`}`
	`50`	`+ ],`
	`51`	`+ "group_ids": [`
	`52`	`+ "545AXB44B4XXWMVQ4W8SBT3HHF"`
	`53`	`+ ],`
	`54`	`+ "segment_ids": [`
	`55`	`+ "1KB9JE5EGJXCW.REACHABLE"`
`46`	`56`	`]`
`47`	`57`	`}`
`48`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -435,7 +435,7 @@ public Headers getAdditionalHeaders() {`
`435`	`435`	`* @return sdkVersion`
`436`	`436`	`*/`
`437`	`437`	`public String getSdkVersion() {`
`438`		`- return "5.2.0.20200422";`
	`438`	`+ return "5.2.1.20200422";`
`439`	`439`	`}`
`440`	`440`
`441`	`441`	`/**`
`@@ -586,4 +586,4 @@ public SquareClient build() {`
`586`	`586`	`authManagers, httpCallback);`
`587`	`587`	`}`
`588`	`588`	`}`
`589`		`-}`
	`589`	`+}`