This repository has been archived by the owner on Apr 23, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #120 from square/release/5.20201118.0
Release 5.20201118.0
- Loading branch information
Showing
224 changed files
with
7,883 additions
and
1,997 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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] | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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] | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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"`) | ||
|
||
|
Oops, something went wrong.