Skip to content

Commit d263a35

Browse files
guyofeckguyofeck
authored
Publishing Bookings Services
Publishing Bookings Services
2 parents 88079d7 + ac5f0a8 commit d263a35

19 files changed

+38461
-155
lines changed

‎wix-bookings-v2/wix-bookings-v2.service.json

+75
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,81 @@
6767
"extra": {}
6868
},
6969
"hidden": true
70+
},
71+
{
72+
"name": "externalCalendars",
73+
"type": [
74+
{
75+
"referenceType": "wix-bookings-v2.ExternalCalendars"
76+
}
77+
],
78+
"docs": {
79+
"summary": "",
80+
"links": [],
81+
"examples": [],
82+
"extra": {}
83+
},
84+
"hidden": true
85+
},
86+
{
87+
"name": "serviceOptionsAndVariants",
88+
"type": [
89+
{
90+
"referenceType": "wix-bookings-v2.ServiceOptionsAndVariants"
91+
}
92+
],
93+
"docs": {
94+
"summary": "",
95+
"links": [],
96+
"examples": [],
97+
"extra": {}
98+
},
99+
"hidden": true
100+
},
101+
{
102+
"name": "services",
103+
"type": [
104+
{
105+
"referenceType": "wix-bookings-v2.Services"
106+
}
107+
],
108+
"docs": {
109+
"summary": "",
110+
"links": [],
111+
"examples": [],
112+
"extra": {}
113+
},
114+
"hidden": true
115+
},
116+
{
117+
"name": "sessions",
118+
"type": [
119+
{
120+
"referenceType": "wix-bookings-v2.Sessions"
121+
}
122+
],
123+
"docs": {
124+
"summary": "",
125+
"links": [],
126+
"examples": [],
127+
"extra": {}
128+
},
129+
"hidden": true
130+
},
131+
{
132+
"name": "sessionsView",
133+
"type": [
134+
{
135+
"referenceType": "wix-bookings-v2.SessionsView"
136+
}
137+
],
138+
"docs": {
139+
"summary": "",
140+
"links": [],
141+
"examples": [],
142+
"extra": {}
143+
},
144+
"hidden": true
70145
}
71146
],
72147
"operations": [],

‎wix-bookings-v2/wix-bookings-v2/AvailabilityCalendar.service.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
" } catch (error) {",
7272
" console.error(error);",
7373
" // Handle the error",
74-
" }",
74+
" }",
7575
" }",
7676
" "
7777
]

‎wix-bookings-v2/wix-bookings-v2/Bookings.service.json

+230-125
Large diffs are not rendered by default.

‎wix-bookings-v2/wix-bookings-v2/BookingsPricing.service.json

+14-14
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
" } catch (error) {",
6161
" console.error(error);",
6262
" // Handle the error",
63-
" }",
63+
" }",
6464
" }",
6565
" "
6666
]
@@ -123,7 +123,7 @@
123123
" } catch (error) {",
124124
" console.error(error);",
125125
" // Handle the error",
126-
" }",
126+
" }",
127127
" }",
128128
" "
129129
]
@@ -368,7 +368,7 @@
368368
"referenceType": "wix-bookings-v2.BookingsPricing.BookedSlot"
369369
}
370370
],
371-
"doc": "The booked slot, which once booked becomes a session. The booking is automatically assigned to the session if given, or a session is be created if one doesn't already exist."
371+
"doc": "The booked slot, once booked becomes a session, The booking is automatically assigned to the session if it already exists, or creates a session if one doesn't already exist."
372372
},
373373
{
374374
"name": "tags",
@@ -436,7 +436,7 @@
436436
"referenceType": "wix-bookings-v2.BookingsPricing.BookedSlot"
437437
}
438438
],
439-
"doc": "The booked slot, which once booked becomes a session. The booking is automatically assigned to the session if given, or a session is be created if one doesn't already exist."
439+
"doc": "The booked slot, once booked becomes a session, The booking is automatically assigned to the session if it already exists, or creates a session if one doesn't already exist."
440440
}
441441
],
442442
"docs": {
@@ -486,7 +486,7 @@
486486
"nativeType": "string"
487487
}
488488
],
489-
"doc": "Resources schedule ID."
489+
"doc": "Resource's schedule ID."
490490
}
491491
],
492492
"docs": {
@@ -549,7 +549,7 @@
549549
"nativeType": "string"
550550
}
551551
],
552-
"doc": "ID of the booked service."
552+
"doc": "Booked service ID."
553553
},
554554
{
555555
"name": "timezone",
@@ -599,7 +599,7 @@
599599
"referenceType": "wix-bookings-v2.BookingsPricing.BookedResource"
600600
}
601601
],
602-
"doc": "The resource used on the slot."
602+
"doc": "The resource assigned to the slot."
603603
},
604604
{
605605
"name": "scheduleId",
@@ -629,7 +629,7 @@
629629
"nativeType": "string"
630630
}
631631
],
632-
"doc": "ID of the underlying session when session is a single session or generated from a recurring session.\nIf `sessionId` is defined in the Create Booking request, the `startDate`, `endDate`, timezone, resource, and location fields from the request are ignored and populated from the session's information."
632+
"doc": "ID of the underlying session when session is a single session or generated from a recurring session.\nIf `sessionId` is defined in the `Create Booking` request, the `startDate`, `endDate`, `timezone`, `resource`, and `location` fields are ignored and populated from the existing session's information."
633633
},
634634
{
635635
"name": "startDate",
@@ -740,7 +740,7 @@
740740
"referenceType": "wix-bookings-v2.BookingsPricing.IdentificationData"
741741
}
742742
],
743-
"doc": "ID of the creator of the Booking\nIf `appId` and another ID are present, the other ID takes precedence."
743+
"doc": "ID of the creator of the Booking.\nIf `appId` and another ID are present, the other ID takes precedence."
744744
},
745745
{
746746
"name": "doubleBooked",
@@ -751,7 +751,7 @@
751751
"nativeType": "boolean"
752752
}
753753
],
754-
"doc": "Indicating if this booking overlaps another existing confirmed booking"
754+
"doc": "Whether this booking overlaps another existing confirmed booking. Returned when: `true`"
755755
},
756756
{
757757
"name": "endDate",
@@ -762,7 +762,7 @@
762762
"nativeType": "Date"
763763
}
764764
],
765-
"doc": "The end date of this booking. For a slot, this is the end date of the slot. For a schedule, the end date of the last session."
765+
"doc": "The end date of this booking. For a slot, this is the end date of the slot. For a schedule, this is the end date of the last session."
766766
},
767767
{
768768
"name": "extendedFields",
@@ -813,7 +813,7 @@
813813
"nativeType": "string"
814814
}
815815
],
816-
"doc": "Revision number to be used when updating, rescheduling, or cancelling the booking. The revision number is automatically incremented when the booing is updated."
816+
"doc": "Revision number to be used when updating, rescheduling, or cancelling the booking. Revision number, which increments by 1 each time the booking is updated, rescheduled, or canceled. To prevent conflicting changes,the current revision must be passed when updating the booking."
817817
},
818818
{
819819
"name": "selectedPaymentOption",
@@ -834,7 +834,7 @@
834834
"nativeType": "Date"
835835
}
836836
],
837-
"doc": "The start date of this booking. For a slot, this is the start date of the slot. For a schedule, the start date of the first session."
837+
"doc": "The start date of this booking. For a slot, this is the start date of the slot. For a schedule, this is the start date of the first session."
838838
},
839839
{
840840
"name": "status",
@@ -844,7 +844,7 @@
844844
"nativeType": "string"
845845
}
846846
],
847-
"doc": "Booking status.\nOne of:\n- `\"CREATED\"` - The booking was created.\n- `\"UPDATED\"` - The booking was updated.\n- `\"CONFIRMED\"` - The booking has been confirmed and appears on the bookings calendar.\nBooking can be manually confirmed using the Set As Confirmed endpoint.\nBooking can be automatically confirmed when the following requirements are met:\n+ The service is configured as automatically confirmed.\n+ Invoking eCommerce checkout API and an order has been created.\n- `\"CANCELED\"` - The booking has been canceled and synced to bookings calendar.\nThe booking can be canceled using cancel API.\n- `\"PENDING\"` - The booking waiting to be confirmed or declined buy the owner and is synced to bookings calendar.\nBookings can be manually set as pending using setAsPending API, requires manage booking status permissions.\nBooking can be automatically set as pending when the following requirements are met:\n+ The Service is configured as manually confirmed.\n+ Invoking the eCommerce checkout API and an order has been created.\n- `\"WAITING_LIST\"` - The booking is pending on a waiting list.\nBooking can be created with this status when invoking waiting list join API.\n- `\"DECLINED\"` - The booking was declined by the owner and synced to bookings calendar.\nBooking can be manually declined using decline API and requires manage booking permissions.\nBooking can be automatically declined when the following requirements are met:\n+ Invoking eCommerce checkout API and the order declined event has been sent.\n+ Invoking eCommerce checkout API and order approved event has been sent, but the booking is offline and the booking causes a double booking."
847+
"doc": "Booking status.\nOne of:\n- `\"CREATED\"` - The booking was created.\n- `\"UPDATED\"` - The booking was updated.\n- `\"CONFIRMED\"` - The booking was confirmed and appears on the bookings calendar.\nA booking can be manually confirmed using the [`Confirm Or Decline API`](www.example.com).\nA booking can be automatically confirmed when the following requirements are met:\n+ The service is configured as automatically confirmed.\n+ The system invoked the eCommerce checkout API and created an order.\n- `\"CANCELED\"` - The booking has been canceled and synced to the bookings calendar.\nThe booking can be canceled using [`Cancel Booking API`](www.example.com).\n- `\"PENDING\"` - The booking is waiting to be confirmed or declined by the owner and the booking is synced to the bookings calendar.\nBookings can be manually set as `PENDING` using the [`setAsPending` API](www.example.com), by those with Manage Booking Status permissions scopes.\nBookings can be automatically set as `PENDING` when the following requirements are met:\n+ The service is configured as manually confirmed.\n+ Invoking the eCommerce checkout API and an order has been created.\n- `\"WAITING_LIST\"` - The booking is on a waiting list.\n- `\"DECLINED\"` - The booking was declined by the owner and synced to the Bookings calendar.\nBookings can be manually declined using the [`Decline Booking` API](www.example.com) by those with Manage Booking Status permissions scopes.\nBooking can be automatically declined when one of the following requirements are met:\n+ Invoking the `eCommerce checkout` API and the order declined event has been sent.\n+ Invoking the `eCommerce checkout` API and order approved event has been sent, but the booking is offline and the booking causes a double booking."
848848
},
849849
{
850850
"name": "totalParticipants",

0 commit comments

Comments
 (0)