Merge pull request #79 from square/release/20.0.0.20220512

Generated PR for Release: 20.0.0.20220512

Author: jguze

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve Square SDKs
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**To Reproduce**
+Steps to reproduce the bug:
+1. (step 1)
+2. (step 2)
+3. (step 3)
+4. ...
+
+**Screenshots**
+If applicable, add screenshots to help explain the bug.
+
+**Square SDK version**
+For example:  17.2.x
+
+**Additional context**
+Add any other context about the problem here.

CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Contributing to Square SDKs
+
+Thank you for your willingness to help improve the Square SDKs. Your feedback and expertise ultimately benefits everyone who builds with Square.
+
+If you encounter a bug while using Square SDKs, please [let us know](#bug-reporting).  We'll investigate the issue and fix it as soon as possible.
+
+We also accept feedback in the form of a pull request (PR), and will follow up with you if we need more information.  However, any code changes required will be perfomed by Square engineering, and we'll close the PR.
+
+## Bug report
+
+To report a bug: 
+* Go to the **[Issues](../../issues)** page.
+* Click **New issue**.
+* Click **Get started**.
+
+## Other support
+
+For all other support, including new feature requests, see:
+
+* Square developer forums:  [https://developer.squareup.com/forums](https://developer.squareup.com/forums)
+* Square support center:  [https://squareup.com/help/us/en](https://squareup.com/help/us/en)

README.md

@@ -77,6 +77,7 @@ mvn test
 
 ### Customers
 * [Customers]
+* [Customer Custom Attributes]
 * [Customer Groups]
 * [Customer Segments]
 
@@ -95,6 +96,7 @@ mvn test
 * [Locations]
 * [Devices]
 * [Cash Drawers]
+* [Vendors]
 
 ### Team
 * [Team]
@@ -139,13 +141,15 @@ You'll also need to provide logic to handle paginated results.  For more informa
 [Disputes]: doc/api/disputes.md
 [Terminal]: doc/api/terminal.md
 [Cash Drawers]: doc/api/cash-drawers.md
+[Vendors]: doc/api/vendors.md
 [Customer Groups]: doc/api/customer-groups.md
 [Customer Segments]: doc/api/customer-segments.md
 [Bank Accounts]: doc/api/bank-accounts.md
 [Payments]: doc/api/payments.md
 [Checkout]: doc/api/checkout.md
 [Catalog]: doc/api/catalog.md
 [Customers]: doc/api/customers.md
+[Customer Custom Attributes]: doc/api/customer-custom-attributes.md
 [Employees]: doc/api/employees.md
 [Inventory]: doc/api/inventory.md
 [Labor]: doc/api/labor.md

doc/api/bank-accounts.md

@@ -41,11 +41,7 @@ CompletableFuture<ListBankAccountsResponse> listBankAccountsAsync(
 ## Example Usage
 
 ```java
-String cursor = "cursor6";
-Integer limit = 172;
-String locationId = "location_id4";
-
-bankAccountsApi.listBankAccountsAsync(cursor, limit, locationId).thenAccept(result -> {
+bankAccountsApi.listBankAccountsAsync(null, null, null).thenAccept(result -> {
     // TODO success callback handler
 }).exceptionally(exception -> {
     // TODO failure callback handler

doc/api/bookings.md

@@ -56,14 +56,7 @@ CompletableFuture<ListBookingsResponse> listBookingsAsync(
 ## Example Usage
 
 ```java
-Integer limit = 172;
-String cursor = "cursor6";
-String teamMemberId = "team_member_id0";
-String locationId = "location_id4";
-String startAtMin = "start_at_min8";
-String startAtMax = "start_at_max8";
-
-bookingsApi.listBookingsAsync(limit, cursor, teamMemberId, locationId, startAtMin, startAtMax).thenAccept(result -> {
+bookingsApi.listBookingsAsync(null, null, null, null, null, null).thenAccept(result -> {
     // TODO success callback handler
 }).exceptionally(exception -> {
     // TODO failure callback handler
@@ -77,7 +70,10 @@ bookingsApi.listBookingsAsync(limit, cursor, teamMemberId, locationId, startAtMi
 Creates a booking.
 
 To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
-To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+
+For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*
+or *Appointments Premium*.
 
 ```java
 CompletableFuture<CreateBookingResponse> createBookingAsync(
@@ -98,15 +94,9 @@ CompletableFuture<CreateBookingResponse> createBookingAsync(
 
 ```java
 Booking booking = new Booking.Builder()
-    .id("id8")
-    .version(148)
-    .status("ACCEPTED")
-    .createdAt("created_at6")
-    .updatedAt("updated_at4")
     .build();
 CreateBookingRequest body = new CreateBookingRequest.Builder(
         booking)
-    .idempotencyKey("idempotency_key2")
     .build();
 
 bookingsApi.createBookingAsync(body).thenAccept(result -> {
@@ -144,56 +134,9 @@ CompletableFuture<SearchAvailabilityResponse> searchAvailabilityAsync(
 
 ```java
 TimeRange timeRange = new TimeRange.Builder()
-    .startAt("start_at8")
-    .endAt("end_at4")
-    .build();
-List<SegmentFilter> bodyQueryFilterSegmentFilters = new LinkedList<>();
-
-List<String> bodyQueryFilterSegmentFilters0TeamMemberIdFilterAll = new LinkedList<>();
-bodyQueryFilterSegmentFilters0TeamMemberIdFilterAll.add("all7");
-List<String> bodyQueryFilterSegmentFilters0TeamMemberIdFilterAny = new LinkedList<>();
-bodyQueryFilterSegmentFilters0TeamMemberIdFilterAny.add("any0");
-bodyQueryFilterSegmentFilters0TeamMemberIdFilterAny.add("any1");
-List<String> bodyQueryFilterSegmentFilters0TeamMemberIdFilterNone = new LinkedList<>();
-bodyQueryFilterSegmentFilters0TeamMemberIdFilterNone.add("none5");
-FilterValue filterValue = new FilterValue.Builder()
-    .all(filterValueAll)
-    .any(filterValueAny)
-    .none(filterValueNone)
-    .build();
-SegmentFilter bodyQueryFilterSegmentFilters0 = new SegmentFilter.Builder(
-        "service_variation_id8")
-    .teamMemberIdFilter(bodyQueryFilterSegmentFilters0TeamMemberIdFilter)
     .build();
-bodyQueryFilterSegmentFilters.add(bodyQueryFilterSegmentFilters0);
-
-List<String> bodyQueryFilterSegmentFilters1TeamMemberIdFilterAll = new LinkedList<>();
-bodyQueryFilterSegmentFilters1TeamMemberIdFilterAll.add("all6");
-bodyQueryFilterSegmentFilters1TeamMemberIdFilterAll.add("all7");
-bodyQueryFilterSegmentFilters1TeamMemberIdFilterAll.add("all8");
-List<String> bodyQueryFilterSegmentFilters1TeamMemberIdFilterAny = new LinkedList<>();
-bodyQueryFilterSegmentFilters1TeamMemberIdFilterAny.add("any1");
-bodyQueryFilterSegmentFilters1TeamMemberIdFilterAny.add("any2");
-bodyQueryFilterSegmentFilters1TeamMemberIdFilterAny.add("any3");
-List<String> bodyQueryFilterSegmentFilters1TeamMemberIdFilterNone = new LinkedList<>();
-bodyQueryFilterSegmentFilters1TeamMemberIdFilterNone.add("none6");
-bodyQueryFilterSegmentFilters1TeamMemberIdFilterNone.add("none7");
-FilterValue filterValue = new FilterValue.Builder()
-    .all(filterValueAll)
-    .any(filterValueAny)
-    .none(filterValueNone)
-    .build();
-SegmentFilter bodyQueryFilterSegmentFilters1 = new SegmentFilter.Builder(
-        "service_variation_id7")
-    .teamMemberIdFilter(bodyQueryFilterSegmentFilters1TeamMemberIdFilter)
-    .build();
-bodyQueryFilterSegmentFilters.add(bodyQueryFilterSegmentFilters1);
-
 SearchAvailabilityFilter searchAvailabilityFilter = new SearchAvailabilityFilter.Builder(
         startAtRange)
-    .locationId("location_id6")
-    .segmentFilters(searchAvailabilityFilterSegmentFilters)
-    .bookingId("booking_id6")
     .build();
 SearchAvailabilityQuery searchAvailabilityQuery = new SearchAvailabilityQuery.Builder(
         filter)
@@ -264,11 +207,8 @@ CompletableFuture<ListTeamMemberBookingProfilesResponse> listTeamMemberBookingPr
 
 ```java
 Boolean bookableOnly = false;
-Integer limit = 172;
-String cursor = "cursor6";
-String locationId = "location_id4";
 
-bookingsApi.listTeamMemberBookingProfilesAsync(bookableOnly, limit, cursor, locationId).thenAccept(result -> {
+bookingsApi.listTeamMemberBookingProfilesAsync(bookableOnly, null, null, null).thenAccept(result -> {
     // TODO success callback handler
 }).exceptionally(exception -> {
     // TODO failure callback handler
@@ -351,7 +291,10 @@ bookingsApi.retrieveBookingAsync(bookingId).thenAccept(result -> {
 Updates a booking.
 
 To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
-To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+
+For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*
+or *Appointments Premium*.
 
 ```java
 CompletableFuture<UpdateBookingResponse> updateBookingAsync(
@@ -375,15 +318,9 @@ CompletableFuture<UpdateBookingResponse> updateBookingAsync(
 ```java
 String bookingId = "booking_id4";
 Booking booking = new Booking.Builder()
-    .id("id8")
-    .version(148)
-    .status("ACCEPTED")
-    .createdAt("created_at6")
-    .updatedAt("updated_at4")
     .build();
 UpdateBookingRequest body = new UpdateBookingRequest.Builder(
         booking)
-    .idempotencyKey("idempotency_key2")
     .build();
 
 bookingsApi.updateBookingAsync(bookingId, body).thenAccept(result -> {
@@ -400,7 +337,10 @@ bookingsApi.updateBookingAsync(bookingId, body).thenAccept(result -> {
 Cancels an existing booking.
 
 To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
-To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+
+For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*
+or *Appointments Premium*.
 
 ```java
 CompletableFuture<CancelBookingResponse> cancelBookingAsync(
@@ -424,8 +364,6 @@ CompletableFuture<CancelBookingResponse> cancelBookingAsync(
 ```java
 String bookingId = "booking_id4";
 CancelBookingRequest body = new CancelBookingRequest.Builder()
-    .idempotencyKey("idempotency_key2")
-    .bookingVersion(8)
     .build();
 
 bookingsApi.cancelBookingAsync(bookingId, body).thenAccept(result -> {

doc/api/cards.md

@@ -47,13 +47,9 @@ CompletableFuture<ListCardsResponse> listCardsAsync(
 ## Example Usage
 
 ```java
-String cursor = "cursor6";
-String customerId = "customer_id8";
 Boolean includeDisabled = false;
-String referenceId = "reference_id2";
-String sortOrder = "DESC";
 
-cardsApi.listCardsAsync(cursor, customerId, includeDisabled, referenceId, sortOrder).thenAccept(result -> {
+cardsApi.listCardsAsync(null, null, includeDisabled, null, null).thenAccept(result -> {
     // TODO success callback handler
 }).exceptionally(exception -> {
     // TODO failure callback handler
@@ -87,19 +83,12 @@ CompletableFuture<CreateCardResponse> createCardAsync(
 Address address = new Address.Builder()
     .addressLine1("500 Electric Ave")
     .addressLine2("Suite 600")
-    .addressLine3("address_line_34")
     .locality("New York")
-    .sublocality("sublocality8")
     .administrativeDistrictLevel1("NY")
     .postalCode("10003")
     .country("US")
     .build();
 Card card = new Card.Builder()
-    .id("id0")
-    .cardBrand("INTERAC")
-    .last4("last_42")
-    .expMonth(236L)
-    .expYear(60L)
     .cardholderName("Amelia Earhart")
     .billingAddress(cardBillingAddress)
     .customerId("VDKXEEKPJN48QDG3BGGFAK05P8")
@@ -109,7 +98,6 @@ CreateCardRequest body = new CreateCardRequest.Builder(
         "4935a656-a929-4792-b97c-8848be85c27c",
         "cnon:uIbfJXhXETSP197M3GB",
         card)
-    .verificationToken("verification_token0")
     .build();
 
 cardsApi.createCardAsync(body).thenAccept(result -> {

doc/api/cash-drawers.md

@@ -49,13 +49,8 @@ CompletableFuture<ListCashDrawerShiftsResponse> listCashDrawerShiftsAsync(
 
 ```java
 String locationId = "location_id4";
-String sortOrder = "DESC";
-String beginTime = "begin_time2";
-String endTime = "end_time2";
-Integer limit = 172;
-String cursor = "cursor6";
 
-cashDrawersApi.listCashDrawerShiftsAsync(locationId, sortOrder, beginTime, endTime, limit, cursor).thenAccept(result -> {
+cashDrawersApi.listCashDrawerShiftsAsync(locationId, null, null, null, null, null).thenAccept(result -> {
     // TODO success callback handler
 }).exceptionally(exception -> {
     // TODO failure callback handler
@@ -131,10 +126,8 @@ CompletableFuture<ListCashDrawerShiftEventsResponse> listCashDrawerShiftEventsAs
 ```java
 String locationId = "location_id4";
 String shiftId = "shift_id0";
-Integer limit = 172;
-String cursor = "cursor6";
 
-cashDrawersApi.listCashDrawerShiftEventsAsync(locationId, shiftId, limit, cursor).thenAccept(result -> {
+cashDrawersApi.listCashDrawerShiftEventsAsync(locationId, shiftId, null, null).thenAccept(result -> {
     // TODO success callback handler
 }).exceptionally(exception -> {
     // TODO failure callback handler