@wix/auto_sdk_bookings_booking-policies 1.0.31 → 1.0.33
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{internal/cjs/src/bookings-v1-booking-policy-booking-policies.universal.d.ts → bookings-v1-booking-policy-booking-policies.universal-Dn-27NDP.d.mts} +129 -435
- package/build/{cjs/src/bookings-v1-booking-policy-booking-policies.universal.d.ts → bookings-v1-booking-policy-booking-policies.universal-Dn-27NDP.d.ts} +129 -435
- package/build/index.d.mts +146 -0
- package/build/index.d.ts +146 -0
- package/build/index.js +794 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +750 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/bookings-v1-booking-policy-booking-policies.universal.d.ts → bookings-v1-booking-policy-booking-policies.universal-Dn-27NDP.d.mts} +129 -435
- package/build/{es/src/bookings-v1-booking-policy-booking-policies.universal.d.ts → internal/bookings-v1-booking-policy-booking-policies.universal-Dn-27NDP.d.ts} +129 -435
- package/build/internal/index.d.mts +146 -0
- package/build/internal/index.d.ts +146 -0
- package/build/internal/index.js +794 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +750 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +545 -0
- package/build/internal/meta.d.ts +545 -0
- package/build/internal/meta.js +448 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +414 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +545 -0
- package/build/meta.d.ts +545 -0
- package/build/meta.js +448 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +414 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.context.d.ts +0 -37
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.context.js +0 -49
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.context.js.map +0 -1
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.http.d.ts +0 -71
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.http.js +0 -330
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.http.js.map +0 -1
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.meta.d.ts +0 -28
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.meta.js +0 -180
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.meta.js.map +0 -1
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.public.d.ts +0 -117
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.public.js +0 -110
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.public.js.map +0 -1
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.types.d.ts +0 -1438
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.types.js +0 -155
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.types.js.map +0 -1
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.universal.js +0 -594
- package/build/cjs/src/bookings-v1-booking-policy-booking-policies.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/bookings-v1-booking-policy-booking-policies.context.d.ts +0 -37
- package/build/es/src/bookings-v1-booking-policy-booking-policies.context.js +0 -37
- package/build/es/src/bookings-v1-booking-policy-booking-policies.context.js.map +0 -1
- package/build/es/src/bookings-v1-booking-policy-booking-policies.http.d.ts +0 -71
- package/build/es/src/bookings-v1-booking-policy-booking-policies.http.js +0 -319
- package/build/es/src/bookings-v1-booking-policy-booking-policies.http.js.map +0 -1
- package/build/es/src/bookings-v1-booking-policy-booking-policies.meta.d.ts +0 -28
- package/build/es/src/bookings-v1-booking-policy-booking-policies.meta.js +0 -146
- package/build/es/src/bookings-v1-booking-policy-booking-policies.meta.js.map +0 -1
- package/build/es/src/bookings-v1-booking-policy-booking-policies.public.d.ts +0 -117
- package/build/es/src/bookings-v1-booking-policy-booking-policies.public.js +0 -90
- package/build/es/src/bookings-v1-booking-policy-booking-policies.public.js.map +0 -1
- package/build/es/src/bookings-v1-booking-policy-booking-policies.types.d.ts +0 -1438
- package/build/es/src/bookings-v1-booking-policy-booking-policies.types.js +0 -152
- package/build/es/src/bookings-v1-booking-policy-booking-policies.types.js.map +0 -1
- package/build/es/src/bookings-v1-booking-policy-booking-policies.universal.js +0 -560
- package/build/es/src/bookings-v1-booking-policy-booking-policies.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.context.d.ts +0 -37
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.context.js +0 -49
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.context.js.map +0 -1
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.http.d.ts +0 -71
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.http.js +0 -330
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.http.js.map +0 -1
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.meta.d.ts +0 -28
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.meta.js +0 -180
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.meta.js.map +0 -1
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.public.d.ts +0 -117
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.public.js +0 -110
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.public.js.map +0 -1
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.types.d.ts +0 -1438
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.types.js +0 -155
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.types.js.map +0 -1
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.universal.js +0 -594
- package/build/internal/cjs/src/bookings-v1-booking-policy-booking-policies.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.context.d.ts +0 -37
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.context.js +0 -37
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.context.js.map +0 -1
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.http.d.ts +0 -71
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.http.js +0 -319
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.http.js.map +0 -1
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.meta.d.ts +0 -28
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.meta.js +0 -146
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.meta.js.map +0 -1
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.public.d.ts +0 -117
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.public.js +0 -90
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.public.js.map +0 -1
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.types.d.ts +0 -1438
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.types.js +0 -152
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.types.js.map +0 -1
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.universal.js +0 -560
- package/build/internal/es/src/bookings-v1-booking-policy-booking-policies.universal.js.map +0 -1
|
@@ -1,1438 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* A booking policy is a set of rules that determine how customers can book a
|
|
3
|
-
* service, including timeframes for booking, canceling, or rescheduling.
|
|
4
|
-
*/
|
|
5
|
-
export interface BookingPolicy {
|
|
6
|
-
/**
|
|
7
|
-
* ID of the booking policy.
|
|
8
|
-
* @format GUID
|
|
9
|
-
* @readonly
|
|
10
|
-
*/
|
|
11
|
-
id?: string | null;
|
|
12
|
-
/**
|
|
13
|
-
* Revision number, which increments by 1 each time the booking policy is updated.
|
|
14
|
-
* To prevent conflicting changes, the current `revision` must be passed when
|
|
15
|
-
* updating the booking policy.
|
|
16
|
-
* @readonly
|
|
17
|
-
*/
|
|
18
|
-
revision?: string | null;
|
|
19
|
-
/**
|
|
20
|
-
* Date and time the booking policy was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
21
|
-
* @readonly
|
|
22
|
-
*/
|
|
23
|
-
createdDate?: Date | null;
|
|
24
|
-
/**
|
|
25
|
-
* Date and time the booking policy was updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
26
|
-
* @readonly
|
|
27
|
-
*/
|
|
28
|
-
updatedDate?: Date | null;
|
|
29
|
-
/**
|
|
30
|
-
* Name of the booking policy.
|
|
31
|
-
* @maxLength 400
|
|
32
|
-
*/
|
|
33
|
-
name?: string | null;
|
|
34
|
-
/**
|
|
35
|
-
* Custom description for the booking policy and whether it's displayed to the
|
|
36
|
-
* participant.
|
|
37
|
-
*/
|
|
38
|
-
customPolicyDescription?: PolicyDescription;
|
|
39
|
-
/**
|
|
40
|
-
* Whether the booking policy is the default.
|
|
41
|
-
* @readonly
|
|
42
|
-
*/
|
|
43
|
-
default?: boolean | null;
|
|
44
|
-
/** Rule for limiting early bookings. */
|
|
45
|
-
limitEarlyBookingPolicy?: LimitEarlyBookingPolicy;
|
|
46
|
-
/**
|
|
47
|
-
* Rule for limiting late bookings. This rule and `bookAfterStartPolicy` can't
|
|
48
|
-
* be both enabled at the same time.
|
|
49
|
-
*/
|
|
50
|
-
limitLateBookingPolicy?: LimitLateBookingPolicy;
|
|
51
|
-
/**
|
|
52
|
-
* Rule for booking after the start of a session or course. This rule and
|
|
53
|
-
* `limitLateBookingPolicy` can't be both enabled at the same time.
|
|
54
|
-
*/
|
|
55
|
-
bookAfterStartPolicy?: BookAfterStartPolicy;
|
|
56
|
-
/** Rule for canceling a booking. */
|
|
57
|
-
cancellationPolicy?: CancellationPolicy;
|
|
58
|
-
/** Rule for rescheduling a booking. */
|
|
59
|
-
reschedulePolicy?: ReschedulePolicy;
|
|
60
|
-
/** Waitlist rule for the service. */
|
|
61
|
-
waitlistPolicy?: WaitlistPolicy;
|
|
62
|
-
/** Rule for participants per booking. */
|
|
63
|
-
participantsPolicy?: ParticipantsPolicy;
|
|
64
|
-
/** Rules for cancellation fees. */
|
|
65
|
-
cancellationFeePolicy?: CancellationFeePolicy;
|
|
66
|
-
/** Rule for saving credit card details. */
|
|
67
|
-
saveCreditCardPolicy?: SaveCreditCardPolicy;
|
|
68
|
-
/** Extensions enabling users to save custom data related to the booking policies. */
|
|
69
|
-
extendedFields?: ExtendedFields;
|
|
70
|
-
}
|
|
71
|
-
/** A description of the booking policy to display to participants. */
|
|
72
|
-
export interface PolicyDescription {
|
|
73
|
-
/**
|
|
74
|
-
* Whether the description is displayed to the participant. `true` means the
|
|
75
|
-
* description is displayed.
|
|
76
|
-
*
|
|
77
|
-
* Default: `false`
|
|
78
|
-
*/
|
|
79
|
-
enabled?: boolean;
|
|
80
|
-
/**
|
|
81
|
-
* Description of the booking policy.
|
|
82
|
-
*
|
|
83
|
-
* Default: Empty
|
|
84
|
-
* Max length: 2500 characters
|
|
85
|
-
* @maxLength 2500
|
|
86
|
-
*/
|
|
87
|
-
description?: string;
|
|
88
|
-
}
|
|
89
|
-
/** The rule for limiting early bookings. */
|
|
90
|
-
export interface LimitEarlyBookingPolicy {
|
|
91
|
-
/**
|
|
92
|
-
* Whether there's a limit about how early a customer can book. `false` means there's
|
|
93
|
-
* no limit to the earliest supported booking time.
|
|
94
|
-
*
|
|
95
|
-
* Default: `false`
|
|
96
|
-
*/
|
|
97
|
-
enabled?: boolean;
|
|
98
|
-
/**
|
|
99
|
-
* Maximum number of minutes before the start of a session or course customers can book.
|
|
100
|
-
* Must be greater than `limitLateBookingPolicy.latestBookingInMinutes`.
|
|
101
|
-
*
|
|
102
|
-
* Default: `10080` minutes (7 days)
|
|
103
|
-
* Min: `1` minute
|
|
104
|
-
* @min 1
|
|
105
|
-
*/
|
|
106
|
-
earliestBookingInMinutes?: number;
|
|
107
|
-
}
|
|
108
|
-
/**
|
|
109
|
-
* Rule limiting late bookings.
|
|
110
|
-
*
|
|
111
|
-
* This rule and `bookAfterStartPolicy` can't be both enabled at the same time.
|
|
112
|
-
*/
|
|
113
|
-
export interface LimitLateBookingPolicy {
|
|
114
|
-
/**
|
|
115
|
-
* Whether there's a limit about how late customers can book. `false` means
|
|
116
|
-
* customers can book up to the last minute. If specified as `true`,
|
|
117
|
-
* `bookAfterStartPolicy.enabled` must be `false`.
|
|
118
|
-
*
|
|
119
|
-
* Default: `false`
|
|
120
|
-
*/
|
|
121
|
-
enabled?: boolean;
|
|
122
|
-
/**
|
|
123
|
-
* Minimum number of minutes before the start of the session customers can book.
|
|
124
|
-
* For courses, this is relative to the start time of the next session and doesn't
|
|
125
|
-
* consider course sessions in the past. This value must be less than
|
|
126
|
-
* `limitEarlyBookingPolicy.earliestBookingInMinutes`.
|
|
127
|
-
*
|
|
128
|
-
* Default: `1440` minutes (1 day)
|
|
129
|
-
* Min: `1` minute
|
|
130
|
-
* @min 1
|
|
131
|
-
*/
|
|
132
|
-
latestBookingInMinutes?: number;
|
|
133
|
-
}
|
|
134
|
-
/**
|
|
135
|
-
* The rule for whether a session can be booked after the start of the schedule.
|
|
136
|
-
* This rule and `LimitLateBookingPolicy` cannot be enabled at the same time. So if this rule
|
|
137
|
-
* is enabled, the `LimitLateBookingPolicy` rule must be disabled.
|
|
138
|
-
*/
|
|
139
|
-
export interface BookAfterStartPolicy {
|
|
140
|
-
/**
|
|
141
|
-
* Whether customers can book after the session has started. `true` means
|
|
142
|
-
* customers can book after the session has started. For courses, this refers to
|
|
143
|
-
* the start of the last course session. If specified as `true`,
|
|
144
|
-
* `limitLateBookingPolicy.enabled` must be `false`.
|
|
145
|
-
*
|
|
146
|
-
* Default: `false`
|
|
147
|
-
*/
|
|
148
|
-
enabled?: boolean;
|
|
149
|
-
}
|
|
150
|
-
/** The rule for canceling a booked session. */
|
|
151
|
-
export interface CancellationPolicy {
|
|
152
|
-
/**
|
|
153
|
-
* Whether customers can cancel the booking. `true` means customers can cancel
|
|
154
|
-
* the booking.
|
|
155
|
-
*
|
|
156
|
-
* Default: `false`
|
|
157
|
-
*/
|
|
158
|
-
enabled?: boolean;
|
|
159
|
-
/**
|
|
160
|
-
* Whether there's a limit on the latest cancellation time. `false` means customers
|
|
161
|
-
* can cancel the booking until the last minute before the course or session starts.
|
|
162
|
-
*
|
|
163
|
-
* Default: `false`
|
|
164
|
-
*/
|
|
165
|
-
limitLatestCancellation?: boolean;
|
|
166
|
-
/**
|
|
167
|
-
* Minimum number of minutes before the start of the session customers can cancel.
|
|
168
|
-
* For courses, this refers to the start of the first course session.
|
|
169
|
-
*
|
|
170
|
-
* Default: `1440` minutes (1 day)
|
|
171
|
-
* Min: `1` minute
|
|
172
|
-
* @min 1
|
|
173
|
-
*/
|
|
174
|
-
latestCancellationInMinutes?: number;
|
|
175
|
-
}
|
|
176
|
-
/** The rule for rescheduling a booked session. */
|
|
177
|
-
export interface ReschedulePolicy {
|
|
178
|
-
/**
|
|
179
|
-
* Whether customers can reschedule a booking for an appointment-based service.
|
|
180
|
-
* `true` means customers can reschedule.
|
|
181
|
-
*
|
|
182
|
-
* Default: `false`
|
|
183
|
-
*/
|
|
184
|
-
enabled?: boolean;
|
|
185
|
-
/**
|
|
186
|
-
* Whether there's a limit on the latest supported rescheduling time. `false`
|
|
187
|
-
* means customers can reschedule until the last minute before the session start.
|
|
188
|
-
*
|
|
189
|
-
* Default: `false`
|
|
190
|
-
*/
|
|
191
|
-
limitLatestReschedule?: boolean;
|
|
192
|
-
/**
|
|
193
|
-
* Minimum number of minutes before the session start session customers can
|
|
194
|
-
* reschedule their booking.
|
|
195
|
-
*
|
|
196
|
-
* Default: `1440` minutes (1 day)
|
|
197
|
-
* Min: `1` minute
|
|
198
|
-
* @min 1
|
|
199
|
-
*/
|
|
200
|
-
latestRescheduleInMinutes?: number;
|
|
201
|
-
}
|
|
202
|
-
/** The rule for the waitlist. */
|
|
203
|
-
export interface WaitlistPolicy {
|
|
204
|
-
/**
|
|
205
|
-
* Whether the service has a waitlist. `true` means there's a waitlist.
|
|
206
|
-
*
|
|
207
|
-
* Default: `false`
|
|
208
|
-
*/
|
|
209
|
-
enabled?: boolean;
|
|
210
|
-
/**
|
|
211
|
-
* Number of spots in the waitlist.
|
|
212
|
-
*
|
|
213
|
-
* Default: `10` spots
|
|
214
|
-
* Min: `1` spot
|
|
215
|
-
* @min 1
|
|
216
|
-
*/
|
|
217
|
-
capacity?: number;
|
|
218
|
-
/**
|
|
219
|
-
* Time in minutes the potential customer is given to book after they've been
|
|
220
|
-
* notified that a spot has opened up for them. If they don't respond in time,
|
|
221
|
-
* the open spot is offered to the next potential customer on the waitlist.
|
|
222
|
-
*
|
|
223
|
-
* Default: `10` minutes
|
|
224
|
-
* Min: `1` minute
|
|
225
|
-
* @min 1
|
|
226
|
-
*/
|
|
227
|
-
reservationTimeInMinutes?: number;
|
|
228
|
-
}
|
|
229
|
-
/** The rule for the maximum number of participants per booking. */
|
|
230
|
-
export interface ParticipantsPolicy {
|
|
231
|
-
/**
|
|
232
|
-
* Maximum number of participants per booking.
|
|
233
|
-
*
|
|
234
|
-
* Default: `1` participant
|
|
235
|
-
* Min: `1` participant
|
|
236
|
-
* @min 1
|
|
237
|
-
*/
|
|
238
|
-
maxParticipantsPerBooking?: number;
|
|
239
|
-
}
|
|
240
|
-
/** The rule regarding the allocation of resources (e.g. staff members). */
|
|
241
|
-
export interface ResourcesPolicy {
|
|
242
|
-
/**
|
|
243
|
-
* Whether the customer must select a resource, for example a staff member, when
|
|
244
|
-
* booking. `false` means the customer can book without selecting a resource.
|
|
245
|
-
*
|
|
246
|
-
* Default: `false`
|
|
247
|
-
*/
|
|
248
|
-
enabled?: boolean;
|
|
249
|
-
/**
|
|
250
|
-
* Whether Wix Bookings automatically assigns a resource, for example a *staff member*
|
|
251
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction)),
|
|
252
|
-
* to the booking. `false` means the customer must select the resource
|
|
253
|
-
* themselves and Wix Bookings doesn't assign it automatically.
|
|
254
|
-
*
|
|
255
|
-
* Default: `false`
|
|
256
|
-
*/
|
|
257
|
-
autoAssignAllowed?: boolean;
|
|
258
|
-
}
|
|
259
|
-
export interface CancellationFeePolicy {
|
|
260
|
-
/**
|
|
261
|
-
* Whether customers must pay a cancellation fee when canceling a booking.
|
|
262
|
-
*
|
|
263
|
-
* Default: `false`
|
|
264
|
-
*/
|
|
265
|
-
enabled?: boolean;
|
|
266
|
-
/**
|
|
267
|
-
* Time windows relative to the session start during which customers can cancel
|
|
268
|
-
* their booking. Each window includes details about the fee for canceling within it.
|
|
269
|
-
* @maxSize 2
|
|
270
|
-
*/
|
|
271
|
-
cancellationWindows?: CancellationWindow[];
|
|
272
|
-
/**
|
|
273
|
-
* Whether Wix automatically charges the cancellation fee from the customer once
|
|
274
|
-
* they cancel their booking.
|
|
275
|
-
*
|
|
276
|
-
* Default: `true`
|
|
277
|
-
*/
|
|
278
|
-
autoCollectFeeEnabled?: boolean | null;
|
|
279
|
-
}
|
|
280
|
-
/**
|
|
281
|
-
* Money.
|
|
282
|
-
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
283
|
-
*/
|
|
284
|
-
export interface Money {
|
|
285
|
-
/**
|
|
286
|
-
* Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.
|
|
287
|
-
* @format DECIMAL_VALUE
|
|
288
|
-
* @decimalValue options { gt:0, maxScale:2 }
|
|
289
|
-
*/
|
|
290
|
-
value?: string;
|
|
291
|
-
/**
|
|
292
|
-
* Currency code. Must be valid ISO 4217 currency code (e.g., USD).
|
|
293
|
-
* @format CURRENCY
|
|
294
|
-
* @readonly
|
|
295
|
-
*/
|
|
296
|
-
currency?: string;
|
|
297
|
-
/**
|
|
298
|
-
* Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.
|
|
299
|
-
* @maxLength 50
|
|
300
|
-
*/
|
|
301
|
-
formattedValue?: string | null;
|
|
302
|
-
}
|
|
303
|
-
export interface CancellationWindow extends CancellationWindowFeeOneOf {
|
|
304
|
-
/** Fixed amount customers must pay when canceling the booking within this window. */
|
|
305
|
-
amount?: Money;
|
|
306
|
-
/**
|
|
307
|
-
* Percentage of the booking price customers must pay when canceling within
|
|
308
|
-
* this window.
|
|
309
|
-
*
|
|
310
|
-
* Min: `0.01` percent
|
|
311
|
-
* Max: `100` percent
|
|
312
|
-
* @decimalValue options { gt:0, lte:100, maxScale:2 }
|
|
313
|
-
*/
|
|
314
|
-
percentage?: string;
|
|
315
|
-
/**
|
|
316
|
-
* Start of the cancellation window in minutes before the session start. For
|
|
317
|
-
* courses, this refers to the start of the first course session.
|
|
318
|
-
* @min 1
|
|
319
|
-
*/
|
|
320
|
-
startInMinutes?: number | null;
|
|
321
|
-
}
|
|
322
|
-
/** @oneof */
|
|
323
|
-
export interface CancellationWindowFeeOneOf {
|
|
324
|
-
/** Fixed amount customers must pay when canceling the booking within this window. */
|
|
325
|
-
amount?: Money;
|
|
326
|
-
/**
|
|
327
|
-
* Percentage of the booking price customers must pay when canceling within
|
|
328
|
-
* this window.
|
|
329
|
-
*
|
|
330
|
-
* Min: `0.01` percent
|
|
331
|
-
* Max: `100` percent
|
|
332
|
-
* @decimalValue options { gt:0, lte:100, maxScale:2 }
|
|
333
|
-
*/
|
|
334
|
-
percentage?: string;
|
|
335
|
-
}
|
|
336
|
-
export interface SaveCreditCardPolicy {
|
|
337
|
-
/**
|
|
338
|
-
* Whether Wix stores credit card details of the customer. Storing the details
|
|
339
|
-
* allows Wix to prefill the *eCommerce checkout*
|
|
340
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction))
|
|
341
|
-
* and thus increases the likelihood that the customer completes the booking
|
|
342
|
-
* process.
|
|
343
|
-
*
|
|
344
|
-
* Default: `false`
|
|
345
|
-
*/
|
|
346
|
-
enabled?: boolean;
|
|
347
|
-
}
|
|
348
|
-
export interface ExtendedFields {
|
|
349
|
-
/**
|
|
350
|
-
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
351
|
-
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
352
|
-
*
|
|
353
|
-
* You can only access fields for which you have the appropriate permissions.
|
|
354
|
-
*
|
|
355
|
-
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
356
|
-
*/
|
|
357
|
-
namespaces?: Record<string, Record<string, any>>;
|
|
358
|
-
}
|
|
359
|
-
/** This event is triggered when a different booking policy has been set as the default policy. */
|
|
360
|
-
export interface DefaultBookingPolicySet {
|
|
361
|
-
/** The new default booking policy. */
|
|
362
|
-
currentDefaultBookingPolicy?: BookingPolicy;
|
|
363
|
-
/**
|
|
364
|
-
* The booking policy that was the default before this endpoint was called.
|
|
365
|
-
* This field will be empty if there was no default booking policy before this method was called.
|
|
366
|
-
*/
|
|
367
|
-
previousDefaultBookingPolicy?: BookingPolicy;
|
|
368
|
-
}
|
|
369
|
-
export interface CreateBookingPolicyRequest {
|
|
370
|
-
/** Booking policy to create. */
|
|
371
|
-
bookingPolicy: BookingPolicy;
|
|
372
|
-
}
|
|
373
|
-
export interface CreateBookingPolicyResponse {
|
|
374
|
-
/** Created booking policy. */
|
|
375
|
-
bookingPolicy?: BookingPolicy;
|
|
376
|
-
}
|
|
377
|
-
export interface GetBookingPolicyRequest {
|
|
378
|
-
/**
|
|
379
|
-
* ID of the booking policy to retrieve.
|
|
380
|
-
* @format GUID
|
|
381
|
-
*/
|
|
382
|
-
bookingPolicyId: string;
|
|
383
|
-
}
|
|
384
|
-
export interface GetBookingPolicyResponse {
|
|
385
|
-
/** Retrieved booking policy. */
|
|
386
|
-
bookingPolicy?: BookingPolicy;
|
|
387
|
-
}
|
|
388
|
-
export interface GetStrictestBookingPolicyRequest {
|
|
389
|
-
/**
|
|
390
|
-
* IDs of the booking policies for which to retrieve the strictest rules for.
|
|
391
|
-
* @format GUID
|
|
392
|
-
* @maxSize 100
|
|
393
|
-
*/
|
|
394
|
-
bookingPolicyIds: string[];
|
|
395
|
-
}
|
|
396
|
-
export interface GetStrictestBookingPolicyResponse {
|
|
397
|
-
/**
|
|
398
|
-
* Hypothetical `bookingPolicy` object that combines the strictest version of
|
|
399
|
-
* each rule. `bookingPolicy.id` is `null` and the returned object isn't actually
|
|
400
|
-
* created. To create a new policy, you can call *Create Booking Policy*
|
|
401
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/create-booking-policy) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/create-booking-policy)).
|
|
402
|
-
*/
|
|
403
|
-
bookingPolicy?: BookingPolicy;
|
|
404
|
-
}
|
|
405
|
-
export interface UpdateBookingPolicyRequest {
|
|
406
|
-
/** Booking policy to update. */
|
|
407
|
-
bookingPolicy: BookingPolicy;
|
|
408
|
-
}
|
|
409
|
-
export interface UpdateBookingPolicyResponse {
|
|
410
|
-
/** Updated booking policy. */
|
|
411
|
-
bookingPolicy?: BookingPolicy;
|
|
412
|
-
}
|
|
413
|
-
export interface SetDefaultBookingPolicyRequest {
|
|
414
|
-
/**
|
|
415
|
-
* ID of the booking policy that's set as default.
|
|
416
|
-
* @format GUID
|
|
417
|
-
*/
|
|
418
|
-
bookingPolicyId: string;
|
|
419
|
-
}
|
|
420
|
-
export interface SetDefaultBookingPolicyResponse {
|
|
421
|
-
/** New default booking policy. */
|
|
422
|
-
currentDefaultBookingPolicy?: BookingPolicy;
|
|
423
|
-
/**
|
|
424
|
-
* Previous default booking policy. Not available if the provided booking policy
|
|
425
|
-
* was already the default.
|
|
426
|
-
*/
|
|
427
|
-
previousDefaultBookingPolicy?: BookingPolicy;
|
|
428
|
-
}
|
|
429
|
-
export interface DeleteBookingPolicyRequest {
|
|
430
|
-
/**
|
|
431
|
-
* ID of the booking policy to delete.
|
|
432
|
-
* @format GUID
|
|
433
|
-
*/
|
|
434
|
-
bookingPolicyId: string;
|
|
435
|
-
}
|
|
436
|
-
export interface DeleteBookingPolicyResponse {
|
|
437
|
-
}
|
|
438
|
-
export interface QueryBookingPoliciesRequest {
|
|
439
|
-
/**
|
|
440
|
-
* The query by which to select booking policies. See
|
|
441
|
-
* [the supported filters article](https://dev.wix.com/docs/rest/business-solutions/bookings/services/booking-policy/supported-filters)
|
|
442
|
-
* for details.
|
|
443
|
-
*/
|
|
444
|
-
query: CursorQuery;
|
|
445
|
-
}
|
|
446
|
-
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
447
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
448
|
-
cursorPaging?: CursorPaging;
|
|
449
|
-
/**
|
|
450
|
-
* Filter object in the following format:
|
|
451
|
-
* `"filter" : {
|
|
452
|
-
* "fieldName1": "value1",
|
|
453
|
-
* "fieldName2":{"$operator":"value2"}
|
|
454
|
-
* }`
|
|
455
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
456
|
-
*/
|
|
457
|
-
filter?: Record<string, any> | null;
|
|
458
|
-
/**
|
|
459
|
-
* Sort object in the following format:
|
|
460
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
461
|
-
* @maxSize 10
|
|
462
|
-
*/
|
|
463
|
-
sort?: Sorting[];
|
|
464
|
-
}
|
|
465
|
-
/** @oneof */
|
|
466
|
-
export interface CursorQueryPagingMethodOneOf {
|
|
467
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
468
|
-
cursorPaging?: CursorPaging;
|
|
469
|
-
}
|
|
470
|
-
export interface Sorting {
|
|
471
|
-
/**
|
|
472
|
-
* Name of the field to sort by.
|
|
473
|
-
* @maxLength 512
|
|
474
|
-
*/
|
|
475
|
-
fieldName?: string;
|
|
476
|
-
/** Sort order. */
|
|
477
|
-
order?: SortOrderWithLiterals;
|
|
478
|
-
}
|
|
479
|
-
export declare enum SortOrder {
|
|
480
|
-
ASC = "ASC",
|
|
481
|
-
DESC = "DESC"
|
|
482
|
-
}
|
|
483
|
-
/** @enumType */
|
|
484
|
-
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
485
|
-
export interface CursorPaging {
|
|
486
|
-
/**
|
|
487
|
-
* Number of items to load.
|
|
488
|
-
* @max 100
|
|
489
|
-
*/
|
|
490
|
-
limit?: number | null;
|
|
491
|
-
/**
|
|
492
|
-
* Pointer to the next or previous page in the list of results.
|
|
493
|
-
*
|
|
494
|
-
* You can get the relevant cursor token
|
|
495
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
496
|
-
* Not relevant for the first request.
|
|
497
|
-
* @maxLength 16000
|
|
498
|
-
*/
|
|
499
|
-
cursor?: string | null;
|
|
500
|
-
}
|
|
501
|
-
export interface QueryBookingPoliciesResponse {
|
|
502
|
-
/** Retrieved booking policies. */
|
|
503
|
-
bookingPolicies?: BookingPolicy[];
|
|
504
|
-
/** Paging metadata. */
|
|
505
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
506
|
-
}
|
|
507
|
-
export interface CursorPagingMetadata {
|
|
508
|
-
/** Number of items returned in the response. */
|
|
509
|
-
count?: number | null;
|
|
510
|
-
/** Offset that was requested. */
|
|
511
|
-
cursors?: Cursors;
|
|
512
|
-
/**
|
|
513
|
-
* Indicates if there are more results after the current page.
|
|
514
|
-
* If `true`, another page of results can be retrieved.
|
|
515
|
-
* If `false`, this is the last page.
|
|
516
|
-
*/
|
|
517
|
-
hasNext?: boolean | null;
|
|
518
|
-
}
|
|
519
|
-
export interface Cursors {
|
|
520
|
-
/**
|
|
521
|
-
* Cursor pointing to next page in the list of results.
|
|
522
|
-
* @maxLength 16000
|
|
523
|
-
*/
|
|
524
|
-
next?: string | null;
|
|
525
|
-
/**
|
|
526
|
-
* Cursor pointing to previous page in the list of results.
|
|
527
|
-
* @maxLength 16000
|
|
528
|
-
*/
|
|
529
|
-
prev?: string | null;
|
|
530
|
-
}
|
|
531
|
-
export interface CountBookingPoliciesRequest {
|
|
532
|
-
/**
|
|
533
|
-
* Filter to base the count on. See
|
|
534
|
-
* supported filters*
|
|
535
|
-
* ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/supported-filters))
|
|
536
|
-
* for details.
|
|
537
|
-
*/
|
|
538
|
-
filter?: Record<string, any> | null;
|
|
539
|
-
}
|
|
540
|
-
export interface CountBookingPoliciesResponse {
|
|
541
|
-
/** Number of booking policies matching the provided filter. */
|
|
542
|
-
count?: number;
|
|
543
|
-
}
|
|
544
|
-
export interface UpdateAllPoliciesRequest {
|
|
545
|
-
/** Fields to set to all booking policies. */
|
|
546
|
-
bookingPolicy?: BookingPolicy;
|
|
547
|
-
}
|
|
548
|
-
export interface UpdateAllPoliciesResponse {
|
|
549
|
-
}
|
|
550
|
-
export interface CreateMissingDefaultPolicyRequest {
|
|
551
|
-
}
|
|
552
|
-
export interface CreateMissingDefaultPolicyResponse {
|
|
553
|
-
/** The default booking policy. */
|
|
554
|
-
defaultBookingPolicy?: BookingPolicy;
|
|
555
|
-
/** Whether a new default policy was created. */
|
|
556
|
-
wasANewPolicyCreated?: boolean;
|
|
557
|
-
}
|
|
558
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
559
|
-
createdEvent?: EntityCreatedEvent;
|
|
560
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
561
|
-
deletedEvent?: EntityDeletedEvent;
|
|
562
|
-
actionEvent?: ActionEvent;
|
|
563
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
564
|
-
id?: string;
|
|
565
|
-
/**
|
|
566
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
567
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
568
|
-
*/
|
|
569
|
-
entityFqdn?: string;
|
|
570
|
-
/**
|
|
571
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
572
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
573
|
-
*/
|
|
574
|
-
slug?: string;
|
|
575
|
-
/** ID of the entity associated with the event. */
|
|
576
|
-
entityId?: string;
|
|
577
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
578
|
-
eventTime?: Date | null;
|
|
579
|
-
/**
|
|
580
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
581
|
-
* (for example, GDPR).
|
|
582
|
-
*/
|
|
583
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
584
|
-
/** If present, indicates the action that triggered the event. */
|
|
585
|
-
originatedFrom?: string | null;
|
|
586
|
-
/**
|
|
587
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
588
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
589
|
-
*/
|
|
590
|
-
entityEventSequence?: string | null;
|
|
591
|
-
}
|
|
592
|
-
/** @oneof */
|
|
593
|
-
export interface DomainEventBodyOneOf {
|
|
594
|
-
createdEvent?: EntityCreatedEvent;
|
|
595
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
596
|
-
deletedEvent?: EntityDeletedEvent;
|
|
597
|
-
actionEvent?: ActionEvent;
|
|
598
|
-
}
|
|
599
|
-
export interface EntityCreatedEvent {
|
|
600
|
-
entityAsJson?: string;
|
|
601
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
602
|
-
restoreInfo?: RestoreInfo;
|
|
603
|
-
}
|
|
604
|
-
export interface RestoreInfo {
|
|
605
|
-
deletedDate?: Date | null;
|
|
606
|
-
}
|
|
607
|
-
export interface EntityUpdatedEvent {
|
|
608
|
-
/**
|
|
609
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
610
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
611
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
612
|
-
*/
|
|
613
|
-
currentEntityAsJson?: string;
|
|
614
|
-
}
|
|
615
|
-
export interface EntityDeletedEvent {
|
|
616
|
-
/** Entity that was deleted. */
|
|
617
|
-
deletedEntityAsJson?: string | null;
|
|
618
|
-
}
|
|
619
|
-
export interface ActionEvent {
|
|
620
|
-
bodyAsJson?: string;
|
|
621
|
-
}
|
|
622
|
-
export interface Empty {
|
|
623
|
-
}
|
|
624
|
-
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
625
|
-
export interface SitePropertiesNotification {
|
|
626
|
-
/** The site ID for which this update notification applies. */
|
|
627
|
-
metasiteId?: string;
|
|
628
|
-
/** The actual update event. */
|
|
629
|
-
event?: SitePropertiesEvent;
|
|
630
|
-
/**
|
|
631
|
-
* A convenience set of mappings from the MetaSite ID to its constituent services.
|
|
632
|
-
* @maxSize 500
|
|
633
|
-
*/
|
|
634
|
-
translations?: Translation[];
|
|
635
|
-
/** Context of the notification */
|
|
636
|
-
changeContext?: ChangeContext;
|
|
637
|
-
}
|
|
638
|
-
/** The actual update event for a particular notification. */
|
|
639
|
-
export interface SitePropertiesEvent {
|
|
640
|
-
/** Version of the site's properties represented by this update. */
|
|
641
|
-
version?: number;
|
|
642
|
-
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
643
|
-
fields?: string[];
|
|
644
|
-
/** Updated properties. */
|
|
645
|
-
properties?: Properties;
|
|
646
|
-
}
|
|
647
|
-
export interface Properties {
|
|
648
|
-
/** Site categories. */
|
|
649
|
-
categories?: Categories;
|
|
650
|
-
/** Site locale. */
|
|
651
|
-
locale?: Locale;
|
|
652
|
-
/**
|
|
653
|
-
* Site language.
|
|
654
|
-
*
|
|
655
|
-
* Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
656
|
-
*/
|
|
657
|
-
language?: string | null;
|
|
658
|
-
/**
|
|
659
|
-
* Site currency format used to bill customers.
|
|
660
|
-
*
|
|
661
|
-
* Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
662
|
-
*/
|
|
663
|
-
paymentCurrency?: string | null;
|
|
664
|
-
/** Timezone in `America/New_York` format. */
|
|
665
|
-
timeZone?: string | null;
|
|
666
|
-
/** Email address. */
|
|
667
|
-
email?: string | null;
|
|
668
|
-
/** Phone number. */
|
|
669
|
-
phone?: string | null;
|
|
670
|
-
/** Fax number. */
|
|
671
|
-
fax?: string | null;
|
|
672
|
-
/** Address. */
|
|
673
|
-
address?: Address;
|
|
674
|
-
/** Site display name. */
|
|
675
|
-
siteDisplayName?: string | null;
|
|
676
|
-
/** Business name. */
|
|
677
|
-
businessName?: string | null;
|
|
678
|
-
/** Path to the site's logo in Wix Media (without Wix Media base URL). */
|
|
679
|
-
logo?: string | null;
|
|
680
|
-
/** Site description. */
|
|
681
|
-
description?: string | null;
|
|
682
|
-
/**
|
|
683
|
-
* Business schedule. Regular and exceptional time periods when the business is open or the service is available.
|
|
684
|
-
*
|
|
685
|
-
* __Note:__ Not supported by Wix Bookings.
|
|
686
|
-
*/
|
|
687
|
-
businessSchedule?: BusinessSchedule;
|
|
688
|
-
/** Supported languages of a site and the primary language. */
|
|
689
|
-
multilingual?: Multilingual;
|
|
690
|
-
/** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
|
|
691
|
-
consentPolicy?: ConsentPolicy;
|
|
692
|
-
/**
|
|
693
|
-
* Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
|
|
694
|
-
*
|
|
695
|
-
* Site business type.
|
|
696
|
-
*/
|
|
697
|
-
businessConfig?: string | null;
|
|
698
|
-
/** External site URL that uses Wix as its headless business solution. */
|
|
699
|
-
externalSiteUrl?: string | null;
|
|
700
|
-
/** Track clicks analytics. */
|
|
701
|
-
trackClicksAnalytics?: boolean;
|
|
702
|
-
}
|
|
703
|
-
export interface Categories {
|
|
704
|
-
/** Primary site category. */
|
|
705
|
-
primary?: string;
|
|
706
|
-
/**
|
|
707
|
-
* Secondary site category.
|
|
708
|
-
* @maxSize 50
|
|
709
|
-
*/
|
|
710
|
-
secondary?: string[];
|
|
711
|
-
/** Business Term Id */
|
|
712
|
-
businessTermId?: string | null;
|
|
713
|
-
}
|
|
714
|
-
export interface Locale {
|
|
715
|
-
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
716
|
-
languageCode?: string;
|
|
717
|
-
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
718
|
-
country?: string;
|
|
719
|
-
}
|
|
720
|
-
export interface Address {
|
|
721
|
-
/** Street name. */
|
|
722
|
-
street?: string;
|
|
723
|
-
/** City name. */
|
|
724
|
-
city?: string;
|
|
725
|
-
/** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
|
|
726
|
-
country?: string;
|
|
727
|
-
/** State. */
|
|
728
|
-
state?: string;
|
|
729
|
-
/**
|
|
730
|
-
* Zip or postal code.
|
|
731
|
-
* @maxLength 20
|
|
732
|
-
*/
|
|
733
|
-
zip?: string;
|
|
734
|
-
/** Extra information to be displayed in the address. */
|
|
735
|
-
hint?: AddressHint;
|
|
736
|
-
/** Whether this address represents a physical location. */
|
|
737
|
-
isPhysical?: boolean;
|
|
738
|
-
/** Google-formatted version of this address. */
|
|
739
|
-
googleFormattedAddress?: string;
|
|
740
|
-
/** Street number. */
|
|
741
|
-
streetNumber?: string;
|
|
742
|
-
/** Apartment number. */
|
|
743
|
-
apartmentNumber?: string;
|
|
744
|
-
/** Geographic coordinates of location. */
|
|
745
|
-
coordinates?: GeoCoordinates;
|
|
746
|
-
}
|
|
747
|
-
/**
|
|
748
|
-
* Extra information on displayed addresses.
|
|
749
|
-
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
750
|
-
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
751
|
-
*/
|
|
752
|
-
export interface AddressHint {
|
|
753
|
-
/** Extra text displayed next to, or instead of, the actual address. */
|
|
754
|
-
text?: string;
|
|
755
|
-
/** Where the extra text should be displayed. */
|
|
756
|
-
placement?: PlacementTypeWithLiterals;
|
|
757
|
-
}
|
|
758
|
-
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
759
|
-
export declare enum PlacementType {
|
|
760
|
-
BEFORE = "BEFORE",
|
|
761
|
-
AFTER = "AFTER",
|
|
762
|
-
REPLACE = "REPLACE"
|
|
763
|
-
}
|
|
764
|
-
/** @enumType */
|
|
765
|
-
export type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
|
|
766
|
-
/** Geocoordinates for a particular address. */
|
|
767
|
-
export interface GeoCoordinates {
|
|
768
|
-
/** Latitude of the location. Must be between -90 and 90. */
|
|
769
|
-
latitude?: number;
|
|
770
|
-
/** Longitude of the location. Must be between -180 and 180. */
|
|
771
|
-
longitude?: number;
|
|
772
|
-
}
|
|
773
|
-
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
774
|
-
export interface BusinessSchedule {
|
|
775
|
-
/**
|
|
776
|
-
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
777
|
-
* @maxSize 100
|
|
778
|
-
*/
|
|
779
|
-
periods?: TimePeriod[];
|
|
780
|
-
/**
|
|
781
|
-
* Exceptions to the business's regular hours. The business can be open or closed during the exception.
|
|
782
|
-
* @maxSize 100
|
|
783
|
-
*/
|
|
784
|
-
specialHourPeriod?: SpecialHourPeriod[];
|
|
785
|
-
}
|
|
786
|
-
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
787
|
-
export interface TimePeriod {
|
|
788
|
-
/** Day of the week the period starts on. */
|
|
789
|
-
openDay?: DayOfWeekWithLiterals;
|
|
790
|
-
/**
|
|
791
|
-
* Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
792
|
-
* midnight at the end of the specified day.
|
|
793
|
-
*/
|
|
794
|
-
openTime?: string;
|
|
795
|
-
/** Day of the week the period ends on. */
|
|
796
|
-
closeDay?: DayOfWeekWithLiterals;
|
|
797
|
-
/**
|
|
798
|
-
* Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
799
|
-
* midnight at the end of the specified day.
|
|
800
|
-
*
|
|
801
|
-
* __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
|
|
802
|
-
*/
|
|
803
|
-
closeTime?: string;
|
|
804
|
-
}
|
|
805
|
-
/** Enumerates the days of the week. */
|
|
806
|
-
export declare enum DayOfWeek {
|
|
807
|
-
MONDAY = "MONDAY",
|
|
808
|
-
TUESDAY = "TUESDAY",
|
|
809
|
-
WEDNESDAY = "WEDNESDAY",
|
|
810
|
-
THURSDAY = "THURSDAY",
|
|
811
|
-
FRIDAY = "FRIDAY",
|
|
812
|
-
SATURDAY = "SATURDAY",
|
|
813
|
-
SUNDAY = "SUNDAY"
|
|
814
|
-
}
|
|
815
|
-
/** @enumType */
|
|
816
|
-
export type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
817
|
-
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
818
|
-
export interface SpecialHourPeriod {
|
|
819
|
-
/** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
820
|
-
startDate?: string;
|
|
821
|
-
/** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
822
|
-
endDate?: string;
|
|
823
|
-
/**
|
|
824
|
-
* Whether the business is closed (or the service is not available) during the exception.
|
|
825
|
-
*
|
|
826
|
-
* Default: `true`.
|
|
827
|
-
*/
|
|
828
|
-
isClosed?: boolean;
|
|
829
|
-
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
830
|
-
comment?: string;
|
|
831
|
-
}
|
|
832
|
-
export interface Multilingual {
|
|
833
|
-
/**
|
|
834
|
-
* Supported languages list.
|
|
835
|
-
* @maxSize 200
|
|
836
|
-
*/
|
|
837
|
-
supportedLanguages?: SupportedLanguage[];
|
|
838
|
-
/** Whether to redirect to user language. */
|
|
839
|
-
autoRedirect?: boolean;
|
|
840
|
-
}
|
|
841
|
-
export interface SupportedLanguage {
|
|
842
|
-
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
843
|
-
languageCode?: string;
|
|
844
|
-
/** Locale. */
|
|
845
|
-
locale?: Locale;
|
|
846
|
-
/** Whether the supported language is the primary language for the site. */
|
|
847
|
-
isPrimary?: boolean;
|
|
848
|
-
/** Language icon. */
|
|
849
|
-
countryCode?: string;
|
|
850
|
-
/** How the language will be resolved. For internal use. */
|
|
851
|
-
resolutionMethod?: ResolutionMethodWithLiterals;
|
|
852
|
-
/** Whether the supported language is the primary language for site visitors. */
|
|
853
|
-
isVisitorPrimary?: boolean | null;
|
|
854
|
-
}
|
|
855
|
-
export declare enum ResolutionMethod {
|
|
856
|
-
QUERY_PARAM = "QUERY_PARAM",
|
|
857
|
-
SUBDOMAIN = "SUBDOMAIN",
|
|
858
|
-
SUBDIRECTORY = "SUBDIRECTORY"
|
|
859
|
-
}
|
|
860
|
-
/** @enumType */
|
|
861
|
-
export type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
|
|
862
|
-
export interface ConsentPolicy {
|
|
863
|
-
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
864
|
-
essential?: boolean | null;
|
|
865
|
-
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
866
|
-
functional?: boolean | null;
|
|
867
|
-
/** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
|
|
868
|
-
analytics?: boolean | null;
|
|
869
|
-
/** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
|
|
870
|
-
advertising?: boolean | null;
|
|
871
|
-
/** CCPA compliance flag. */
|
|
872
|
-
dataToThirdParty?: boolean | null;
|
|
873
|
-
}
|
|
874
|
-
/** A single mapping from the MetaSite ID to a particular service. */
|
|
875
|
-
export interface Translation {
|
|
876
|
-
/** The service type. */
|
|
877
|
-
serviceType?: string;
|
|
878
|
-
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
879
|
-
appDefId?: string;
|
|
880
|
-
/** The instance ID of the service. */
|
|
881
|
-
instanceId?: string;
|
|
882
|
-
}
|
|
883
|
-
export interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
884
|
-
/** Properties were updated. */
|
|
885
|
-
propertiesChange?: PropertiesChange;
|
|
886
|
-
/** Default properties were created on site creation. */
|
|
887
|
-
siteCreated?: V4SiteCreated;
|
|
888
|
-
/** Properties were cloned on site cloning. */
|
|
889
|
-
siteCloned?: SiteCloned;
|
|
890
|
-
}
|
|
891
|
-
/** @oneof */
|
|
892
|
-
export interface ChangeContextPayloadOneOf {
|
|
893
|
-
/** Properties were updated. */
|
|
894
|
-
propertiesChange?: PropertiesChange;
|
|
895
|
-
/** Default properties were created on site creation. */
|
|
896
|
-
siteCreated?: V4SiteCreated;
|
|
897
|
-
/** Properties were cloned on site cloning. */
|
|
898
|
-
siteCloned?: SiteCloned;
|
|
899
|
-
}
|
|
900
|
-
export interface PropertiesChange {
|
|
901
|
-
}
|
|
902
|
-
export interface V4SiteCreated {
|
|
903
|
-
/** Origin template site id. */
|
|
904
|
-
originTemplateId?: string | null;
|
|
905
|
-
}
|
|
906
|
-
export interface SiteCloned {
|
|
907
|
-
/** Origin site id. */
|
|
908
|
-
originMetaSiteId?: string;
|
|
909
|
-
}
|
|
910
|
-
export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
911
|
-
/** Emitted on a meta site creation. */
|
|
912
|
-
siteCreated?: SiteCreated;
|
|
913
|
-
/** Emitted on a meta site transfer completion. */
|
|
914
|
-
siteTransferred?: SiteTransferred;
|
|
915
|
-
/** Emitted on a meta site deletion. */
|
|
916
|
-
siteDeleted?: SiteDeleted;
|
|
917
|
-
/** Emitted on a meta site restoration. */
|
|
918
|
-
siteUndeleted?: SiteUndeleted;
|
|
919
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
920
|
-
sitePublished?: SitePublished;
|
|
921
|
-
/** Emitted on a meta site unpublish. */
|
|
922
|
-
siteUnpublished?: SiteUnpublished;
|
|
923
|
-
/** Emitted when meta site is marked as template. */
|
|
924
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
925
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
926
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
927
|
-
/** Emitted when an application is provisioned (installed). */
|
|
928
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
929
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
930
|
-
serviceRemoved?: ServiceRemoved;
|
|
931
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
932
|
-
siteRenamedPayload?: SiteRenamed;
|
|
933
|
-
/** Emitted when meta site was permanently deleted. */
|
|
934
|
-
hardDeleted?: SiteHardDeleted;
|
|
935
|
-
/** Emitted on a namespace change. */
|
|
936
|
-
namespaceChanged?: NamespaceChanged;
|
|
937
|
-
/** Emitted when Studio is attached. */
|
|
938
|
-
studioAssigned?: StudioAssigned;
|
|
939
|
-
/** Emitted when Studio is detached. */
|
|
940
|
-
studioUnassigned?: StudioUnassigned;
|
|
941
|
-
/**
|
|
942
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
943
|
-
* the actual URL.
|
|
944
|
-
*
|
|
945
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
946
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
947
|
-
*/
|
|
948
|
-
urlChanged?: SiteUrlChanged;
|
|
949
|
-
/** Site is marked as PurgedExternally */
|
|
950
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
951
|
-
/** Emitted when Odeditor is attached. */
|
|
952
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
953
|
-
/** Emitted when Odeditor is detached. */
|
|
954
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
955
|
-
/** Emitted when Picasso is attached. */
|
|
956
|
-
picassoAssigned?: PicassoAssigned;
|
|
957
|
-
/** Emitted when Picasso is detached. */
|
|
958
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
959
|
-
/**
|
|
960
|
-
* A meta site id.
|
|
961
|
-
* @format GUID
|
|
962
|
-
*/
|
|
963
|
-
metaSiteId?: string;
|
|
964
|
-
/** A meta site version. Monotonically increasing. */
|
|
965
|
-
version?: string;
|
|
966
|
-
/** A timestamp of the event. */
|
|
967
|
-
timestamp?: string;
|
|
968
|
-
/**
|
|
969
|
-
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
970
|
-
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
971
|
-
* @maxSize 4000
|
|
972
|
-
*/
|
|
973
|
-
assets?: Asset[];
|
|
974
|
-
}
|
|
975
|
-
/** @oneof */
|
|
976
|
-
export interface MetaSiteSpecialEventPayloadOneOf {
|
|
977
|
-
/** Emitted on a meta site creation. */
|
|
978
|
-
siteCreated?: SiteCreated;
|
|
979
|
-
/** Emitted on a meta site transfer completion. */
|
|
980
|
-
siteTransferred?: SiteTransferred;
|
|
981
|
-
/** Emitted on a meta site deletion. */
|
|
982
|
-
siteDeleted?: SiteDeleted;
|
|
983
|
-
/** Emitted on a meta site restoration. */
|
|
984
|
-
siteUndeleted?: SiteUndeleted;
|
|
985
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
986
|
-
sitePublished?: SitePublished;
|
|
987
|
-
/** Emitted on a meta site unpublish. */
|
|
988
|
-
siteUnpublished?: SiteUnpublished;
|
|
989
|
-
/** Emitted when meta site is marked as template. */
|
|
990
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
991
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
992
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
993
|
-
/** Emitted when an application is provisioned (installed). */
|
|
994
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
995
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
996
|
-
serviceRemoved?: ServiceRemoved;
|
|
997
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
998
|
-
siteRenamedPayload?: SiteRenamed;
|
|
999
|
-
/** Emitted when meta site was permanently deleted. */
|
|
1000
|
-
hardDeleted?: SiteHardDeleted;
|
|
1001
|
-
/** Emitted on a namespace change. */
|
|
1002
|
-
namespaceChanged?: NamespaceChanged;
|
|
1003
|
-
/** Emitted when Studio is attached. */
|
|
1004
|
-
studioAssigned?: StudioAssigned;
|
|
1005
|
-
/** Emitted when Studio is detached. */
|
|
1006
|
-
studioUnassigned?: StudioUnassigned;
|
|
1007
|
-
/**
|
|
1008
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
1009
|
-
* the actual URL.
|
|
1010
|
-
*
|
|
1011
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
1012
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
1013
|
-
*/
|
|
1014
|
-
urlChanged?: SiteUrlChanged;
|
|
1015
|
-
/** Site is marked as PurgedExternally */
|
|
1016
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
1017
|
-
/** Emitted when Odeditor is attached. */
|
|
1018
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
1019
|
-
/** Emitted when Odeditor is detached. */
|
|
1020
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
1021
|
-
/** Emitted when Picasso is attached. */
|
|
1022
|
-
picassoAssigned?: PicassoAssigned;
|
|
1023
|
-
/** Emitted when Picasso is detached. */
|
|
1024
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
1025
|
-
}
|
|
1026
|
-
export interface Asset {
|
|
1027
|
-
/**
|
|
1028
|
-
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
1029
|
-
* @maxLength 36
|
|
1030
|
-
*/
|
|
1031
|
-
appDefId?: string;
|
|
1032
|
-
/**
|
|
1033
|
-
* An instance id. For legacy reasons may be UUID or a string.
|
|
1034
|
-
* @maxLength 200
|
|
1035
|
-
*/
|
|
1036
|
-
instanceId?: string;
|
|
1037
|
-
/** An application state. */
|
|
1038
|
-
state?: StateWithLiterals;
|
|
1039
|
-
}
|
|
1040
|
-
export declare enum State {
|
|
1041
|
-
UNKNOWN = "UNKNOWN",
|
|
1042
|
-
ENABLED = "ENABLED",
|
|
1043
|
-
DISABLED = "DISABLED",
|
|
1044
|
-
PENDING = "PENDING",
|
|
1045
|
-
DEMO = "DEMO"
|
|
1046
|
-
}
|
|
1047
|
-
/** @enumType */
|
|
1048
|
-
export type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
1049
|
-
export interface SiteCreated {
|
|
1050
|
-
/**
|
|
1051
|
-
* A template identifier (empty if not created from a template).
|
|
1052
|
-
* @maxLength 36
|
|
1053
|
-
*/
|
|
1054
|
-
originTemplateId?: string;
|
|
1055
|
-
/**
|
|
1056
|
-
* An account id of the owner.
|
|
1057
|
-
* @format GUID
|
|
1058
|
-
*/
|
|
1059
|
-
ownerId?: string;
|
|
1060
|
-
/** A context in which meta site was created. */
|
|
1061
|
-
context?: SiteCreatedContextWithLiterals;
|
|
1062
|
-
/**
|
|
1063
|
-
* A meta site id from which this site was created.
|
|
1064
|
-
*
|
|
1065
|
-
* In case of a creation from a template it's a template id.
|
|
1066
|
-
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
1067
|
-
* @format GUID
|
|
1068
|
-
*/
|
|
1069
|
-
originMetaSiteId?: string | null;
|
|
1070
|
-
/**
|
|
1071
|
-
* A meta site name (URL slug).
|
|
1072
|
-
* @maxLength 20
|
|
1073
|
-
*/
|
|
1074
|
-
siteName?: string;
|
|
1075
|
-
/** A namespace. */
|
|
1076
|
-
namespace?: NamespaceWithLiterals;
|
|
1077
|
-
}
|
|
1078
|
-
export declare enum SiteCreatedContext {
|
|
1079
|
-
/** A valid option, we don't expose all reasons why site might be created. */
|
|
1080
|
-
OTHER = "OTHER",
|
|
1081
|
-
/** A meta site was created from template. */
|
|
1082
|
-
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
1083
|
-
/** A meta site was created by copying of the transfferred meta site. */
|
|
1084
|
-
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
1085
|
-
/** A copy of existing meta site. */
|
|
1086
|
-
DUPLICATE = "DUPLICATE",
|
|
1087
|
-
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
1088
|
-
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
1089
|
-
/** deprecated A meta site was created for Flash editor. */
|
|
1090
|
-
FLASH = "FLASH"
|
|
1091
|
-
}
|
|
1092
|
-
/** @enumType */
|
|
1093
|
-
export type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
1094
|
-
export declare enum Namespace {
|
|
1095
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
1096
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
1097
|
-
WIX = "WIX",
|
|
1098
|
-
/** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1099
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
1100
|
-
/** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1101
|
-
ALBUMS = "ALBUMS",
|
|
1102
|
-
/** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1103
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
1104
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1105
|
-
HOTELS = "HOTELS",
|
|
1106
|
-
/** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1107
|
-
CLUBS = "CLUBS",
|
|
1108
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1109
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
1110
|
-
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1111
|
-
DEV_SITE = "DEV_SITE",
|
|
1112
|
-
/** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1113
|
-
LOGOS = "LOGOS",
|
|
1114
|
-
/** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1115
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
1116
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1117
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
1118
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1119
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
1120
|
-
/**
|
|
1121
|
-
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
1122
|
-
*
|
|
1123
|
-
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
1124
|
-
*/
|
|
1125
|
-
HTML_DRAFT = "HTML_DRAFT",
|
|
1126
|
-
/**
|
|
1127
|
-
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
1128
|
-
* Will be accessible from Site List and will not have a website app.
|
|
1129
|
-
* Once the user attaches a site, the site will become a regular wixsite.
|
|
1130
|
-
*/
|
|
1131
|
-
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
1132
|
-
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
1133
|
-
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
1134
|
-
/** It is to be used in the Business First efforts. */
|
|
1135
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
1136
|
-
/** Bookings business flow with no site. */
|
|
1137
|
-
ANYWHERE = "ANYWHERE",
|
|
1138
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
1139
|
-
HEADLESS = "HEADLESS",
|
|
1140
|
-
/**
|
|
1141
|
-
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
1142
|
-
* The site will be used for account level CSM feature for enterprise
|
|
1143
|
-
*/
|
|
1144
|
-
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
1145
|
-
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
1146
|
-
RISE = "RISE",
|
|
1147
|
-
/**
|
|
1148
|
-
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
1149
|
-
* There's a blank site behind the scene but it's blank).
|
|
1150
|
-
* The Mobile company will be the owner of this namespace.
|
|
1151
|
-
*/
|
|
1152
|
-
BRANDED_FIRST = "BRANDED_FIRST",
|
|
1153
|
-
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
1154
|
-
NOWNIA = "NOWNIA",
|
|
1155
|
-
/**
|
|
1156
|
-
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
1157
|
-
* The Partners company owns this namespace.
|
|
1158
|
-
*/
|
|
1159
|
-
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
1160
|
-
/** Codux Headless Sites */
|
|
1161
|
-
CODUX = "CODUX",
|
|
1162
|
-
/** Bobb - AI Design Creator. */
|
|
1163
|
-
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
1164
|
-
/**
|
|
1165
|
-
* Shared Blog Site is a unique single site across Enterprise account,
|
|
1166
|
-
* This site will hold all Blog posts related to the Marketing product.
|
|
1167
|
-
*/
|
|
1168
|
-
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
1169
|
-
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1170
|
-
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
1171
|
-
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1172
|
-
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
1173
|
-
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
1174
|
-
MIMIR = "MIMIR"
|
|
1175
|
-
}
|
|
1176
|
-
/** @enumType */
|
|
1177
|
-
export type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
|
|
1178
|
-
/** Site transferred to another user. */
|
|
1179
|
-
export interface SiteTransferred {
|
|
1180
|
-
/**
|
|
1181
|
-
* A previous owner id (user that transfers meta site).
|
|
1182
|
-
* @format GUID
|
|
1183
|
-
*/
|
|
1184
|
-
oldOwnerId?: string;
|
|
1185
|
-
/**
|
|
1186
|
-
* A new owner id (user that accepts meta site).
|
|
1187
|
-
* @format GUID
|
|
1188
|
-
*/
|
|
1189
|
-
newOwnerId?: string;
|
|
1190
|
-
}
|
|
1191
|
-
/** Soft deletion of the meta site. Could be restored. */
|
|
1192
|
-
export interface SiteDeleted {
|
|
1193
|
-
/** A deletion context. */
|
|
1194
|
-
deleteContext?: DeleteContext;
|
|
1195
|
-
}
|
|
1196
|
-
export interface DeleteContext {
|
|
1197
|
-
/** When the meta site was deleted. */
|
|
1198
|
-
dateDeleted?: Date | null;
|
|
1199
|
-
/** A status. */
|
|
1200
|
-
deleteStatus?: DeleteStatusWithLiterals;
|
|
1201
|
-
/**
|
|
1202
|
-
* A reason (flow).
|
|
1203
|
-
* @maxLength 255
|
|
1204
|
-
*/
|
|
1205
|
-
deleteOrigin?: string;
|
|
1206
|
-
/**
|
|
1207
|
-
* A service that deleted it.
|
|
1208
|
-
* @maxLength 255
|
|
1209
|
-
*/
|
|
1210
|
-
initiatorId?: string | null;
|
|
1211
|
-
}
|
|
1212
|
-
export declare enum DeleteStatus {
|
|
1213
|
-
UNKNOWN = "UNKNOWN",
|
|
1214
|
-
TRASH = "TRASH",
|
|
1215
|
-
DELETED = "DELETED",
|
|
1216
|
-
PENDING_PURGE = "PENDING_PURGE",
|
|
1217
|
-
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
1218
|
-
}
|
|
1219
|
-
/** @enumType */
|
|
1220
|
-
export type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
1221
|
-
/** Restoration of the meta site. */
|
|
1222
|
-
export interface SiteUndeleted {
|
|
1223
|
-
}
|
|
1224
|
-
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
1225
|
-
export interface SitePublished {
|
|
1226
|
-
}
|
|
1227
|
-
export interface SiteUnpublished {
|
|
1228
|
-
/**
|
|
1229
|
-
* A list of URLs previously associated with the meta site.
|
|
1230
|
-
* @maxLength 4000
|
|
1231
|
-
* @maxSize 10000
|
|
1232
|
-
*/
|
|
1233
|
-
urls?: string[];
|
|
1234
|
-
}
|
|
1235
|
-
export interface SiteMarkedAsTemplate {
|
|
1236
|
-
}
|
|
1237
|
-
export interface SiteMarkedAsWixSite {
|
|
1238
|
-
}
|
|
1239
|
-
/**
|
|
1240
|
-
* Represents a service provisioned a site.
|
|
1241
|
-
*
|
|
1242
|
-
* Note on `origin_instance_id`:
|
|
1243
|
-
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
1244
|
-
* This is because of the following scenario:
|
|
1245
|
-
*
|
|
1246
|
-
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
1247
|
-
* such as a product catalog. When you create a site from this template, you inherit this
|
|
1248
|
-
* default product catalog. However, if the template's product catalog is modified,
|
|
1249
|
-
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
1250
|
-
* your site remains consistent with what you initially received and does not include any
|
|
1251
|
-
* changes made to the original template afterward.
|
|
1252
|
-
* To ensure this, the TPA on the template gets a new instance_id.
|
|
1253
|
-
*/
|
|
1254
|
-
export interface ServiceProvisioned {
|
|
1255
|
-
/**
|
|
1256
|
-
* Either UUID or EmbeddedServiceType.
|
|
1257
|
-
* @maxLength 36
|
|
1258
|
-
*/
|
|
1259
|
-
appDefId?: string;
|
|
1260
|
-
/**
|
|
1261
|
-
* Not only UUID. Something here could be something weird.
|
|
1262
|
-
* @maxLength 36
|
|
1263
|
-
*/
|
|
1264
|
-
instanceId?: string;
|
|
1265
|
-
/**
|
|
1266
|
-
* An instance id from which this instance is originated.
|
|
1267
|
-
* @maxLength 36
|
|
1268
|
-
*/
|
|
1269
|
-
originInstanceId?: string;
|
|
1270
|
-
/**
|
|
1271
|
-
* A version.
|
|
1272
|
-
* @maxLength 500
|
|
1273
|
-
*/
|
|
1274
|
-
version?: string | null;
|
|
1275
|
-
/**
|
|
1276
|
-
* The origin meta site id
|
|
1277
|
-
* @format GUID
|
|
1278
|
-
*/
|
|
1279
|
-
originMetaSiteId?: string | null;
|
|
1280
|
-
}
|
|
1281
|
-
export interface ServiceRemoved {
|
|
1282
|
-
/**
|
|
1283
|
-
* Either UUID or EmbeddedServiceType.
|
|
1284
|
-
* @maxLength 36
|
|
1285
|
-
*/
|
|
1286
|
-
appDefId?: string;
|
|
1287
|
-
/**
|
|
1288
|
-
* Not only UUID. Something here could be something weird.
|
|
1289
|
-
* @maxLength 36
|
|
1290
|
-
*/
|
|
1291
|
-
instanceId?: string;
|
|
1292
|
-
/**
|
|
1293
|
-
* A version.
|
|
1294
|
-
* @maxLength 500
|
|
1295
|
-
*/
|
|
1296
|
-
version?: string | null;
|
|
1297
|
-
}
|
|
1298
|
-
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
1299
|
-
export interface SiteRenamed {
|
|
1300
|
-
/**
|
|
1301
|
-
* A new meta site name (URL slug).
|
|
1302
|
-
* @maxLength 20
|
|
1303
|
-
*/
|
|
1304
|
-
newSiteName?: string;
|
|
1305
|
-
/**
|
|
1306
|
-
* A previous meta site name (URL slug).
|
|
1307
|
-
* @maxLength 255
|
|
1308
|
-
*/
|
|
1309
|
-
oldSiteName?: string;
|
|
1310
|
-
}
|
|
1311
|
-
/**
|
|
1312
|
-
* Hard deletion of the meta site.
|
|
1313
|
-
*
|
|
1314
|
-
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
1315
|
-
*/
|
|
1316
|
-
export interface SiteHardDeleted {
|
|
1317
|
-
/** A deletion context. */
|
|
1318
|
-
deleteContext?: DeleteContext;
|
|
1319
|
-
}
|
|
1320
|
-
export interface NamespaceChanged {
|
|
1321
|
-
/** A previous namespace. */
|
|
1322
|
-
oldNamespace?: NamespaceWithLiterals;
|
|
1323
|
-
/** A new namespace. */
|
|
1324
|
-
newNamespace?: NamespaceWithLiterals;
|
|
1325
|
-
}
|
|
1326
|
-
/** Assigned Studio editor */
|
|
1327
|
-
export interface StudioAssigned {
|
|
1328
|
-
}
|
|
1329
|
-
/** Unassigned Studio editor */
|
|
1330
|
-
export interface StudioUnassigned {
|
|
1331
|
-
}
|
|
1332
|
-
/**
|
|
1333
|
-
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
1334
|
-
*
|
|
1335
|
-
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
1336
|
-
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
1337
|
-
*
|
|
1338
|
-
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
1339
|
-
*/
|
|
1340
|
-
export interface SiteUrlChanged {
|
|
1341
|
-
}
|
|
1342
|
-
/**
|
|
1343
|
-
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
1344
|
-
* Consumed by other teams to remove relevant data.
|
|
1345
|
-
*/
|
|
1346
|
-
export interface SitePurgedExternally {
|
|
1347
|
-
/**
|
|
1348
|
-
* @maxLength 2048
|
|
1349
|
-
* @maxSize 100
|
|
1350
|
-
* @deprecated
|
|
1351
|
-
* @targetRemovalDate 2025-04-15
|
|
1352
|
-
*/
|
|
1353
|
-
appDefId?: string[];
|
|
1354
|
-
}
|
|
1355
|
-
/** Assigned Odeditor */
|
|
1356
|
-
export interface OdeditorAssigned {
|
|
1357
|
-
}
|
|
1358
|
-
/** Unassigned Odeditor */
|
|
1359
|
-
export interface OdeditorUnassigned {
|
|
1360
|
-
}
|
|
1361
|
-
/** Assigned Picasso editor */
|
|
1362
|
-
export interface PicassoAssigned {
|
|
1363
|
-
}
|
|
1364
|
-
/** Unassigned Picasso */
|
|
1365
|
-
export interface PicassoUnassigned {
|
|
1366
|
-
}
|
|
1367
|
-
export interface MessageEnvelope {
|
|
1368
|
-
/**
|
|
1369
|
-
* App instance ID.
|
|
1370
|
-
* @format GUID
|
|
1371
|
-
*/
|
|
1372
|
-
instanceId?: string | null;
|
|
1373
|
-
/**
|
|
1374
|
-
* Event type.
|
|
1375
|
-
* @maxLength 150
|
|
1376
|
-
*/
|
|
1377
|
-
eventType?: string;
|
|
1378
|
-
/** The identification type and identity data. */
|
|
1379
|
-
identity?: IdentificationData;
|
|
1380
|
-
/** Stringify payload. */
|
|
1381
|
-
data?: string;
|
|
1382
|
-
}
|
|
1383
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1384
|
-
/**
|
|
1385
|
-
* ID of a site visitor that has not logged in to the site.
|
|
1386
|
-
* @format GUID
|
|
1387
|
-
*/
|
|
1388
|
-
anonymousVisitorId?: string;
|
|
1389
|
-
/**
|
|
1390
|
-
* ID of a site visitor that has logged in to the site.
|
|
1391
|
-
* @format GUID
|
|
1392
|
-
*/
|
|
1393
|
-
memberId?: string;
|
|
1394
|
-
/**
|
|
1395
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
1396
|
-
* @format GUID
|
|
1397
|
-
*/
|
|
1398
|
-
wixUserId?: string;
|
|
1399
|
-
/**
|
|
1400
|
-
* ID of an app.
|
|
1401
|
-
* @format GUID
|
|
1402
|
-
*/
|
|
1403
|
-
appId?: string;
|
|
1404
|
-
/** @readonly */
|
|
1405
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1406
|
-
}
|
|
1407
|
-
/** @oneof */
|
|
1408
|
-
export interface IdentificationDataIdOneOf {
|
|
1409
|
-
/**
|
|
1410
|
-
* ID of a site visitor that has not logged in to the site.
|
|
1411
|
-
* @format GUID
|
|
1412
|
-
*/
|
|
1413
|
-
anonymousVisitorId?: string;
|
|
1414
|
-
/**
|
|
1415
|
-
* ID of a site visitor that has logged in to the site.
|
|
1416
|
-
* @format GUID
|
|
1417
|
-
*/
|
|
1418
|
-
memberId?: string;
|
|
1419
|
-
/**
|
|
1420
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
1421
|
-
* @format GUID
|
|
1422
|
-
*/
|
|
1423
|
-
wixUserId?: string;
|
|
1424
|
-
/**
|
|
1425
|
-
* ID of an app.
|
|
1426
|
-
* @format GUID
|
|
1427
|
-
*/
|
|
1428
|
-
appId?: string;
|
|
1429
|
-
}
|
|
1430
|
-
export declare enum WebhookIdentityType {
|
|
1431
|
-
UNKNOWN = "UNKNOWN",
|
|
1432
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1433
|
-
MEMBER = "MEMBER",
|
|
1434
|
-
WIX_USER = "WIX_USER",
|
|
1435
|
-
APP = "APP"
|
|
1436
|
-
}
|
|
1437
|
-
/** @enumType */
|
|
1438
|
-
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|