diff --git a/all/all-apis/bookings---bookings-service.service.json b/all/all-apis/bookings---bookings-service.service.json index 417cb01268..f28836aa42 100644 --- a/all/all-apis/bookings---bookings-service.service.json +++ b/all/all-apis/bookings---bookings-service.service.json @@ -16,7 +16,7 @@ "entity": null }, { - "name": "Bookings", + "name": "Bookings V1", "entity": "_com_wix_bookings_api_v1_Booking", "src": "https://github.com/wix-private/scheduler/tree/master/bookings-backend/bookings/bookings-api/com/wix/bookings/api/v1/entities/booking.proto" }, @@ -44,7 +44,7 @@ "name": "Book", "methodName": "Book", "serviceName": "Bookings", - "tag": "Bookings", + "tag": "Bookings V1", "permissions": [], "events": [], "labels": [], @@ -122,7 +122,7 @@ }, "locations": [], "docs": { - "summary": " Book a service. \n Booking a service can be done by either of two methods:\n 1. The booking is made by a customer. \n 2. The booking is made by the business on behalf of a customer. \n \n\n\n\n When the booking is done by the customer, the following takes place: \n - Validation of the booking details according to the bookings policy and the service form mandatory fields.\n - Payment rules are applied.\n - When booking an approval required service, The booking is not charged until it is confirmed by the business. \n - BySessionId: The participant added to session is marked as `\"PENDING\"` until the booking is confirmed by the business. \n - Slot: A new session is created with affected availability based on the configuration defined in the service policy.\n - When booking a service with Business Locations, if a business location is provided its Id will be validated to exist in the schedule's business locations.\n\n > **Note:** \n > The `businessLocation.businessSchedule` object in the `bookedEntity.location` object is not supported.\n \n > **Permissions** \n > This endpoint requires the Read Bookings - Public data or the Manage Bookings permission scope. \n > With the Read Bookings - Public data permission scope, a customer booking flow is applied. \n > With the Manage Bookings permission scope, a business 'book on behalf' flow is applied. \n\n \n", + "summary": " Book a service. \n Booking a service can be done by either of two methods:\n 1. The booking is made by a customer. \n 2. The booking is made by the business on behalf of a customer. \n \n\n\n\n When the booking is done by the customer, the following takes place: \n - Validation of the booking details according to the bookings policy and the service form mandatory fields.\n - Payment rules are applied.\n - When booking an approval required service, The booking is not charged until it is confirmed by the business. \n - BySessionId: The participant added to session is marked as `\"PENDING\"` until the booking is confirmed by the business. \n - Slot: A new session is created with affected availability based on the configuration defined in the service policy.\n - When booking a service with Business Locations, if a business location is provided its Id will be validated to exist in the schedule's business locations.\n - When booking a service with location set to client's place, the default location is the contacts address as supplied on the form, unless the owner supplied custom address on the session location.\n\n > **Note:** \n > The `businessLocation.businessSchedule` object in the `bookedEntity.location` object is not supported.\n \n > **Permissions** \n > This endpoint requires the Read Bookings - Public data or the Manage Bookings permission scope. \n > With the Read Bookings - Public data permission scope, a customer booking flow is applied. \n > With the Manage Bookings permission scope, a business 'book on behalf' flow is applied. \n\n \n", "description": [], "request": "POST", "url": "https://www.wixapis.com/bookings/v1/bookings/book", @@ -163,7 +163,7 @@ "name": "Cancel Booking", "methodName": "Cancel", "serviceName": "Bookings", - "tag": "Bookings", + "tag": "Bookings V1", "permissions": [], "events": [], "labels": [], @@ -220,7 +220,7 @@ "name": "Checkout Booking", "methodName": "Checkout", "serviceName": "Bookings", - "tag": "Bookings", + "tag": "Bookings V1", "permissions": [], "events": [], "labels": [], @@ -298,7 +298,7 @@ "name": "Confirm Booking", "methodName": "Confirm", "serviceName": "Bookings", - "tag": "Bookings", + "tag": "Bookings V1", "permissions": [], "events": [], "labels": [], @@ -355,7 +355,7 @@ "name": "Confirm Booking (Additional Binding 1)", "methodName": "Confirm", "serviceName": "Bookings", - "tag": "Bookings", + "tag": "Bookings V1", "permissions": [], "events": [], "labels": [], @@ -412,7 +412,7 @@ "name": "Decline Booking", "methodName": "Decline", "serviceName": "Bookings", - "tag": "Bookings", + "tag": "Bookings V1", "permissions": [], "events": [], "labels": [], @@ -469,7 +469,7 @@ "name": "Decline Booking (Additional Binding 1)", "methodName": "Decline", "serviceName": "Bookings", - "tag": "Bookings", + "tag": "Bookings V1", "permissions": [], "events": [], "labels": [], @@ -751,7 +751,7 @@ "name": "Mark Booking As Paid", "methodName": "MarkAsPaid", "serviceName": "Bookings", - "tag": "Bookings", + "tag": "Bookings V1", "permissions": [], "events": [], "labels": [], @@ -878,7 +878,7 @@ "name": "Reschedule Booking", "methodName": "Reschedule", "serviceName": "Bookings", - "tag": "Bookings", + "tag": "Bookings V1", "permissions": [], "events": [], "labels": [], @@ -945,7 +945,7 @@ "name": "Set Attendance", "methodName": "SetAttendance", "serviceName": "Bookings", - "tag": "Bookings", + "tag": "Bookings V1", "permissions": [], "events": [], "labels": [], @@ -1065,7 +1065,7 @@ "name": "Update Customer Info", "methodName": "UpdateCustomerInfo", "serviceName": "Bookings", - "tag": "Bookings", + "tag": "Bookings V1", "permissions": [ { "name": "Manage Bookings - all permissions", @@ -1136,7 +1136,7 @@ "src": "https://github.com/wix-private/scheduler/tree/master/bookings-backend/bookings/bookings-api/src/main/proto/com/wix/bookings/api/v1/services/bookings.proto" }, "topic": "bookings.bookings.notifications", - "tag": "Bookings", + "tag": "Bookings V1", "permissions": [ { "name": "Manage Bookings - all permissions", @@ -1484,7 +1484,7 @@ { "name": "email", "type": "string", - "doc": " Contact's email, used to create a new contact or get existing one from the [Contacts API](https://dev.wix.com/api/rest/contacts/contacts). Used to validate coupon usage limitations per contact. If not passed, the coupon usage limitation will not be enforced. (Coupon usage limitation validation is not supported yet).\n" + "doc": " Contact's email, used to create a new contact or get an existing contact from the [Contacts API](https://dev.wix.com/api/rest/contacts/contacts). Calling Book and CreateBooking validates email address, and fails if the email is invalid. Email addresses are used to validate coupon usage limitations per contact. If not passed, the coupon usage limitation will not be enforced. (Coupon usage limitation validation is not supported yet).\n" }, { "name": "phone", @@ -2166,7 +2166,7 @@ { "name": "customAddress", "type": "All APIs.Bookings - Bookings Service._com_wix_bookings_upstream_wix_common_Address", - "doc": "Custom address, used when locationType is `\"OWNER_CUSTOM\"`.\n" + "doc": "Custom address, used when locationType is `\"OWNER_CUSTOM\"`. Might be used when locationType is `\"CUSTOM\"` in case the owner sets a custom address for the session which is different from the default.\n" }, { "name": "businessLocation", @@ -3563,7 +3563,7 @@ { "name": "id", "type": "string", - "doc": "Participant ID.\n" + "doc": "Participant ID. Currently represents the booking.id.\n" }, { "name": "contactId", @@ -3636,6 +3636,24 @@ "enum": null, "extra": {}, "labels": [] + }, + { + "name": "_com_wix_bookings_schedules_api_v1_ExternalCalendarInfo", + "displayName": "External Calendar Info Object", + "locations": [], + "docs": { + "summary": "", + "links": [], + "examples": [] + }, + "members": [ { + "name": "calendarType", + "type": "All APIs.Bookings - Bookings Service._com_wix_bookings_externalcalendar_spi_v1_CalendarTypeEnum_CalendarType", + "doc": " The external calendar type (e.g. Google Calendar, iCal, etc).\n" + }], + "enum": null, + "extra": {}, + "labels": [] }, { "name": "_com_wix_bookings_schedules_api_v1_ExternalCalendarOverrides", @@ -5430,6 +5448,25 @@ ], "extra": {}, "labels": [] + }, + { + "name": "_com_wix_bookings_externalcalendar_spi_v1_CalendarTypeEnum_CalendarType", + "displayName": "Calendar Type Object", + "locations": [], + "docs": { + "summary": " \n Possible values are:
  • UNDEFINED <\/code><\/li>
  • GOOGLE <\/code><\/li>
  • I_CAL <\/code><\/li>
  • OUTLOOK <\/code><\/li>", + "links": [], + "examples": [] + }, + "members": [], + "enum": [ + "UNDEFINED", + "GOOGLE", + "I_CAL", + "OUTLOOK" + ], + "extra": {}, + "labels": [] }, { "name": "_com_wix_bookings_schedules_api_v1_SessionType",