Skip to content
This repository has been archived by the owner on Apr 23, 2021. It is now read-only.

Commit

Permalink
Merge pull request #120 from square/release/5.20201118.0
Browse files Browse the repository at this point in the history
Release 5.20201118.0
  • Loading branch information
jessdelacruzsantos authored Nov 18, 2020
2 parents 0b91ba4 + eb84804 commit c676e07
Show file tree
Hide file tree
Showing 224 changed files with 7,883 additions and 1,997 deletions.
30 changes: 28 additions & 2 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
# Change Log

## Version 5.20201118.0 (2020-11-18T00:00)
## New API releases

* **Bookings API** (beta). The Bookings API lets you create applications to set up and manage bookings for appointments of fixed duration in which selected staff members of a Square seller provide specified services in supported locations for particular customers.
* For an overview, see [Manage Bookings for Square Sellers.](https://developer.squareup.com/docs/bookings-api/what-it-is)
* For technical reference, see [Bookings API](https://developer.squareup.com/reference/square_2020-11-18/bookings-api).

## Existing API updates

* **Payments API:**
* [Payment.](https://developer.squareup.com/reference/square_2020-11-18/objects/Payment) The object now includes the `risk_evaluation` field to identify the Square-assigned risk level associated with the payment. Sellers can use this information to provide the goods and services or refund the payment.

## New SDK release
* **New Square Node.js SDK (beta)**

The new [Square Node.js SDK](https://github.com/square/square-nodejs-sdk) is available in beta and will eventually replace the deprecated Connect Node.js SDK. For migration information, see the [Connect SDK README.](https://github.com/square/connect-nodejs-sdk/blob/master/README.md) The following topics are updated to use the new SDK:
* [Walkthrough: Integrate Square Payments in a Website](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough)
* [Verify the Buyer When Using a Nonce for an Online Payment](https://developer.squareup.com/docs/payment-form/cookbook/verify-buyer-on-card-charge)
* [Create a Gift Card Payment Endpoint](https://developer.squareup.com/docs/payment-form/gift-cards/part-2)

## Documentation updates

* The Testing topics are moved from the end of the table of contents to the top, in the Home section under [Testing your Application.](https://developer.squareup.com/docs/testing-your-app)
* [Pay for Orders.](https://developer.squareup.com/docs/orders-api/pay-for-orders) The topic is revised to add clarity for when to use the Payments API and Orders API to pay for an order. The [Orders integration](https://developer.squareup.com/docs/payments-api/take-payments?preview=true#orders-integration) section for the Payments API is simplified accordingly.


## Version 4.20201028.5 (2020-10-28T00:00)

## Existing API updates
Expand Down Expand Up @@ -247,8 +273,8 @@

## Version 3.20200325.0 (2020-03-25)
## Existing API updates
* **[Payments API](https://developer.squareup.com/reference/square/payments-api).** In support of the existing [Delayed capture](payments-api/take-payments) for payments, the following fields are added to the [Payment](https://developer.squareup.com/reference/square/objects/Payment) type:
* `delay_duration`. In a [CreatePayment](https://developer.squareup.com/reference/square/payments-api/create-payment) request, you can set `autocomplete` to false to get payment approval but not charge the payment source. You can now add this field to specify a time period to complete (or cancel) the payment. For more information, see [Delay capture](payments-api/take-payments).
* **[Payments API](https://developer.squareup.com/reference/square/payments-api).** In support of the existing [Delayed capturehttps://developer.squareup.com/docs/payments-api/take-payments) for payments, the following fields are added to the [Payment](https://developer.squareup.com/reference/square/objects/Payment) type:
* `delay_duration`. In a [CreatePayment](https://developer.squareup.com/reference/square/payments-api/create-payment) request, you can set `autocomplete` to false to get payment approval but not charge the payment source. You can now add this field to specify a time period to complete (or cancel) the payment. For more information, see [Delay capturehttps://developer.squareup.com/docs/payments-api/take-payments).
* `delay_action`. Defines the action that Square takes on the payment when the `delay_duration` elapses. In this release, the API supports only the cancel payment action.
* `delayed_until`. Provides the date and time on Square servers when Square applies `delay_action` on the payment.

Expand Down
1,291 changes: 157 additions & 1,134 deletions README.md

Large diffs are not rendered by default.

16 changes: 16 additions & 0 deletions docs/AppointmentSegment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# SquareConnect.AppointmentSegment

### Description
**Note: This model is in beta.**

Defines an appointment segment of a booking.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**duration_minutes** | **Number** | The time span in minutes of an appointment segment. |
**service_variation_id** | **String** | The ID of the `CatalogItemVariation` object representing the service booked in this segment. |
**team_member_id** | **String** | The ID of the `TeamMember` object representing the team member booked in this segment. |
**service_variation_version** | **Number** | The current version of the item variation representing the service booked in this segment. |


15 changes: 15 additions & 0 deletions docs/Availability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# SquareConnect.Availability

### Description
**Note: This model is in beta.**

Describes a slot available for booking, encapsulating appointment segments, the location and starting time.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**start_at** | **String** | The RFC-3339 timestamp specifying the beginning time of the slot available for booking. | [optional]
**location_id** | **String** | The ID of the location available for booking. | [optional]
**appointment_segments** | [**[AppointmentSegment]**](AppointmentSegment.md) | The list of appointment segments available for booking | [optional]


4 changes: 2 additions & 2 deletions docs/BalancePaymentDetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Reflects the current status of a balance payment.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account_id** | **String** | ID for the account used to fund the payment. | [optional]
**status** | **String** | The balance payment’s current state. Can be `COMPLETED` or `FAILED`. | [optional]
**account_id** | **String** | The ID of the account used to fund the payment. | [optional]
**status** | **String** | The balance payment’s current state. The state can be COMPLETED or FAILED. | [optional]


23 changes: 23 additions & 0 deletions docs/Booking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# SquareConnect.Booking

### Description
**Note: This model is in beta.**

Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service at a given location to a requesting customer in one or more appointment segments.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | A unique ID of this object representing a booking. | [optional]
**version** | **Number** | The revision number for the booking used for optimistic concurrency. | [optional]
**status** | **String** | The status of the booking, describing where the booking stands with respect to the booking state machine. See [BookingStatus](#type-bookingstatus) for possible values | [optional]
**created_at** | **String** | The timestamp specifying the creation time of this booking. | [optional]
**updated_at** | **String** | The timestamp specifying the most recent update time of this booking. | [optional]
**start_at** | **String** | The timestamp specifying the starting time of this booking. | [optional]
**location_id** | **String** | The ID of the `Location` object representing the location where the booked service is provided. | [optional]
**customer_id** | **String** | The ID of the `Customer` object representing the customer attending this booking | [optional]
**customer_note** | **String** | The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant `CatalogObject` instance. | [optional]
**seller_note** | **String** | The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific `CatalogObject` instance. This field should not be visible to customers. | [optional]
**appointment_segments** | [**[AppointmentSegment]**](AppointmentSegment.md) | A list of appointment segments for this booking. | [optional]


18 changes: 18 additions & 0 deletions docs/BookingStatus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# SquareConnect.BookingStatus

## Enum


* `PENDING` (value: `"PENDING"`)

* `CANCELLED_BY_CUSTOMER` (value: `"CANCELLED_BY_CUSTOMER"`)

* `CANCELLED_BY_SELLER` (value: `"CANCELLED_BY_SELLER"`)

* `DECLINED` (value: `"DECLINED"`)

* `ACCEPTED` (value: `"ACCEPTED"`)

* `NO_SHOW` (value: `"NO_SHOW"`)


Loading

0 comments on commit c676e07

Please sign in to comment.