@wix/events 1.0.250 → 1.0.251
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/package.json +16 -16
- package/type-bundles/context.bundle.d.ts +1433 -170
- package/type-bundles/index.bundle.d.ts +1433 -170
|
@@ -1,3 +1,47 @@
|
|
|
1
|
+
type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
|
|
2
|
+
interface HttpClient {
|
|
3
|
+
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
4
|
+
fetchWithAuth: typeof fetch;
|
|
5
|
+
wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
|
|
6
|
+
}
|
|
7
|
+
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
8
|
+
type HttpResponse<T = any> = {
|
|
9
|
+
data: T;
|
|
10
|
+
status: number;
|
|
11
|
+
statusText: string;
|
|
12
|
+
headers: any;
|
|
13
|
+
request?: any;
|
|
14
|
+
};
|
|
15
|
+
type RequestOptions<_TResponse = any, Data = any> = {
|
|
16
|
+
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
17
|
+
url: string;
|
|
18
|
+
data?: Data;
|
|
19
|
+
params?: URLSearchParams;
|
|
20
|
+
} & APIMetadata;
|
|
21
|
+
type APIMetadata = {
|
|
22
|
+
methodFqn?: string;
|
|
23
|
+
entityFqdn?: string;
|
|
24
|
+
packageName?: string;
|
|
25
|
+
};
|
|
26
|
+
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
|
|
27
|
+
type EventDefinition<Payload = unknown, Type extends string = string> = {
|
|
28
|
+
__type: 'event-definition';
|
|
29
|
+
type: Type;
|
|
30
|
+
isDomainEvent?: boolean;
|
|
31
|
+
transformations?: (envelope: unknown) => Payload;
|
|
32
|
+
__payload: Payload;
|
|
33
|
+
};
|
|
34
|
+
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
|
|
35
|
+
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
|
|
36
|
+
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
|
|
37
|
+
|
|
38
|
+
declare global {
|
|
39
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
40
|
+
interface SymbolConstructor {
|
|
41
|
+
readonly observable: symbol;
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
|
|
1
45
|
interface EventGuest$1 {
|
|
2
46
|
/** Guest ID. */
|
|
3
47
|
_id?: string | null;
|
|
@@ -1169,51 +1213,30 @@ interface GuestsQueryBuilder {
|
|
|
1169
1213
|
find: () => Promise<GuestsQueryResult>;
|
|
1170
1214
|
}
|
|
1171
1215
|
|
|
1172
|
-
|
|
1173
|
-
interface
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
|
|
1195
|
-
packageName?: string;
|
|
1196
|
-
};
|
|
1197
|
-
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
|
|
1198
|
-
type EventDefinition<Payload = unknown, Type extends string = string> = {
|
|
1199
|
-
__type: 'event-definition';
|
|
1200
|
-
type: Type;
|
|
1201
|
-
isDomainEvent?: boolean;
|
|
1202
|
-
transformations?: (envelope: unknown) => Payload;
|
|
1203
|
-
__payload: Payload;
|
|
1204
|
-
};
|
|
1205
|
-
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
|
|
1206
|
-
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
|
|
1207
|
-
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
|
|
1208
|
-
|
|
1209
|
-
declare global {
|
|
1210
|
-
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
1211
|
-
interface SymbolConstructor {
|
|
1212
|
-
readonly observable: symbol;
|
|
1213
|
-
}
|
|
1216
|
+
declare function queryGuests$1(httpClient: HttpClient): QueryGuestsSignature;
|
|
1217
|
+
interface QueryGuestsSignature {
|
|
1218
|
+
/**
|
|
1219
|
+
* Creates a query to retrieve a list of guests.
|
|
1220
|
+
*
|
|
1221
|
+
*
|
|
1222
|
+
* The `queryGuests()` function builds a query to retrieve a list of guests and returns a [GuestsQueryBuilder](https://www.wix.com/velo/reference/wix-events-v2/guests/guestsquerybuilder) object.
|
|
1223
|
+
*
|
|
1224
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
|
1225
|
+
*
|
|
1226
|
+
* You can refine the query by chaining `GuestsQueryBuilder` functions onto the query. `GuestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryGuests.find()` returns.
|
|
1227
|
+
*
|
|
1228
|
+
* The query runs with the following `GuestsQueryBuilder` defaults that you can override:
|
|
1229
|
+
*
|
|
1230
|
+
* - [`skip(0)`](https://www.wix.com/velo/reference/wix-events-v2/guests/guestsquerybuilder/skipto)
|
|
1231
|
+
* - [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/guests/guestsquerybuilder/limit)
|
|
1232
|
+
* - [`descending("_createdDate")`](https://www.wix.com/velo/reference/wix-events-v2/guests/guestsquerybuilder/descending)
|
|
1233
|
+
*
|
|
1234
|
+
* The functions that are chained to `queryGuests()` are applied in the order they are called. For example, if you apply `ascending ('_createdDate')` and then `descending ('_updatedDate')`, the results are sorted first by the created date and then, if there are multiple results with the same date, the items are sorted by the updated date.
|
|
1235
|
+
*
|
|
1236
|
+
* The table below shows which `GuestsQueryBuilder` functions are supported for `queryGuests()`. You can only use one filter function for each property. Only the first filter will work if a property is used in more than one filter.
|
|
1237
|
+
*/
|
|
1238
|
+
(options?: QueryEventGuestsOptions | undefined): GuestsQueryBuilder;
|
|
1214
1239
|
}
|
|
1215
|
-
|
|
1216
|
-
declare function queryGuests$1(httpClient: HttpClient): (options?: QueryEventGuestsOptions) => GuestsQueryBuilder;
|
|
1217
1240
|
declare const onGuestCreated$1: EventDefinition<GuestCreatedEnvelope, "wix.events.guests.v1.guest_created">;
|
|
1218
1241
|
declare const onGuestUpdated$1: EventDefinition<GuestUpdatedEnvelope, "wix.events.guests.v1.guest_updated">;
|
|
1219
1242
|
declare const onGuestDeleted$1: EventDefinition<GuestDeletedEnvelope, "wix.events.guests.v1.guest_deleted">;
|
|
@@ -1226,12 +1249,15 @@ type _publicQueryGuestsType = typeof queryGuests$1;
|
|
|
1226
1249
|
declare const queryGuests: ReturnType<typeof createRESTModule$d<_publicQueryGuestsType>>;
|
|
1227
1250
|
|
|
1228
1251
|
type _publicOnGuestCreatedType = typeof onGuestCreated$1;
|
|
1252
|
+
/** */
|
|
1229
1253
|
declare const onGuestCreated: ReturnType<typeof createEventModule$a<_publicOnGuestCreatedType>>;
|
|
1230
1254
|
|
|
1231
1255
|
type _publicOnGuestUpdatedType = typeof onGuestUpdated$1;
|
|
1256
|
+
/** */
|
|
1232
1257
|
declare const onGuestUpdated: ReturnType<typeof createEventModule$a<_publicOnGuestUpdatedType>>;
|
|
1233
1258
|
|
|
1234
1259
|
type _publicOnGuestDeletedType = typeof onGuestDeleted$1;
|
|
1260
|
+
/** */
|
|
1235
1261
|
declare const onGuestDeleted: ReturnType<typeof createEventModule$a<_publicOnGuestDeletedType>>;
|
|
1236
1262
|
|
|
1237
1263
|
type index_d$d_GuestCount = GuestCount;
|
|
@@ -3416,9 +3442,29 @@ interface UpsertNotificationConfig {
|
|
|
3416
3442
|
orderConfirmationWithTicketsLink?: EmailNotificationConfig;
|
|
3417
3443
|
}
|
|
3418
3444
|
|
|
3419
|
-
declare function triggerNotification$1(httpClient: HttpClient):
|
|
3420
|
-
|
|
3421
|
-
|
|
3445
|
+
declare function triggerNotification$1(httpClient: HttpClient): TriggerNotificationSignature;
|
|
3446
|
+
interface TriggerNotificationSignature {
|
|
3447
|
+
/**
|
|
3448
|
+
* Triggers notification
|
|
3449
|
+
*/
|
|
3450
|
+
(options?: TriggerNotificationOptions | undefined): Promise<void>;
|
|
3451
|
+
}
|
|
3452
|
+
declare function resolveNotificationConfig$1(httpClient: HttpClient): ResolveNotificationConfigSignature;
|
|
3453
|
+
interface ResolveNotificationConfigSignature {
|
|
3454
|
+
/**
|
|
3455
|
+
* Resolves a NotificationConfig by id. Returns saved value or default value if not saved yet.
|
|
3456
|
+
* @param - Id of the NotificationConfig to retrieve
|
|
3457
|
+
*/
|
|
3458
|
+
(notificationConfigId: string): Promise<ResolveNotificationConfigResponse & ResolveNotificationConfigResponseNonNullableFields>;
|
|
3459
|
+
}
|
|
3460
|
+
declare function upsertNotificationConfig$1(httpClient: HttpClient): UpsertNotificationConfigSignature;
|
|
3461
|
+
interface UpsertNotificationConfigSignature {
|
|
3462
|
+
/**
|
|
3463
|
+
* Upsert a NotificationConfig
|
|
3464
|
+
* @param - Event ID.
|
|
3465
|
+
*/
|
|
3466
|
+
(_id: string | null, notificationConfig: UpsertNotificationConfig): Promise<UpsertNotificationConfigResponse & UpsertNotificationConfigResponseNonNullableFields>;
|
|
3467
|
+
}
|
|
3422
3468
|
declare const onNotificationConfigCreated$1: EventDefinition<NotificationConfigCreatedEnvelope, "wix.events.notifications.v2.notification_config_created">;
|
|
3423
3469
|
declare const onNotificationConfigUpdated$1: EventDefinition<NotificationConfigUpdatedEnvelope, "wix.events.notifications.v2.notification_config_updated">;
|
|
3424
3470
|
declare const onNotificationConfigDeleted$1: EventDefinition<NotificationConfigDeletedEnvelope, "wix.events.notifications.v2.notification_config_deleted">;
|
|
@@ -3435,12 +3481,15 @@ type _publicUpsertNotificationConfigType = typeof upsertNotificationConfig$1;
|
|
|
3435
3481
|
declare const upsertNotificationConfig: ReturnType<typeof createRESTModule$c<_publicUpsertNotificationConfigType>>;
|
|
3436
3482
|
|
|
3437
3483
|
type _publicOnNotificationConfigCreatedType = typeof onNotificationConfigCreated$1;
|
|
3484
|
+
/** */
|
|
3438
3485
|
declare const onNotificationConfigCreated: ReturnType<typeof createEventModule$9<_publicOnNotificationConfigCreatedType>>;
|
|
3439
3486
|
|
|
3440
3487
|
type _publicOnNotificationConfigUpdatedType = typeof onNotificationConfigUpdated$1;
|
|
3488
|
+
/** */
|
|
3441
3489
|
declare const onNotificationConfigUpdated: ReturnType<typeof createEventModule$9<_publicOnNotificationConfigUpdatedType>>;
|
|
3442
3490
|
|
|
3443
3491
|
type _publicOnNotificationConfigDeletedType = typeof onNotificationConfigDeleted$1;
|
|
3492
|
+
/** */
|
|
3444
3493
|
declare const onNotificationConfigDeleted: ReturnType<typeof createEventModule$9<_publicOnNotificationConfigDeletedType>>;
|
|
3445
3494
|
|
|
3446
3495
|
type index_d$c_AttendanceStatus = AttendanceStatus;
|
|
@@ -3887,9 +3936,32 @@ interface ListBookmarksResponseNonNullableFields$1 {
|
|
|
3887
3936
|
}
|
|
3888
3937
|
type GoogleProtoDuration$1 = any;
|
|
3889
3938
|
|
|
3890
|
-
declare function listBookmarks$1(httpClient: HttpClient):
|
|
3891
|
-
|
|
3892
|
-
|
|
3939
|
+
declare function listBookmarks$1(httpClient: HttpClient): ListBookmarksSignature;
|
|
3940
|
+
interface ListBookmarksSignature {
|
|
3941
|
+
/**
|
|
3942
|
+
* Retrieves a list of bookmarked schedule items for a currently logged-in member.
|
|
3943
|
+
* @param - Event ID to which the schedule belongs.
|
|
3944
|
+
*/
|
|
3945
|
+
(eventId: string): Promise<ListBookmarksResponse$1 & ListBookmarksResponseNonNullableFields$1>;
|
|
3946
|
+
}
|
|
3947
|
+
declare function createBookmark$1(httpClient: HttpClient): CreateBookmarkSignature;
|
|
3948
|
+
interface CreateBookmarkSignature {
|
|
3949
|
+
/**
|
|
3950
|
+
* Bookmarks a schedule item for a currently logged-in member.
|
|
3951
|
+
* @param - Schedule item ID.
|
|
3952
|
+
* @param - Event ID to which the schedule belongs.
|
|
3953
|
+
*/
|
|
3954
|
+
(itemId: string, eventId: string): Promise<void>;
|
|
3955
|
+
}
|
|
3956
|
+
declare function deleteBookmark$1(httpClient: HttpClient): DeleteBookmarkSignature;
|
|
3957
|
+
interface DeleteBookmarkSignature {
|
|
3958
|
+
/**
|
|
3959
|
+
* Removes a schedule item bookmark for a currently logged-in member.
|
|
3960
|
+
* @param - Schedule item ID.
|
|
3961
|
+
* @param - Event ID to which the schedule belongs.
|
|
3962
|
+
*/
|
|
3963
|
+
(itemId: string, eventId: string): Promise<void>;
|
|
3964
|
+
}
|
|
3893
3965
|
|
|
3894
3966
|
declare function createRESTModule$b<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
3895
3967
|
|
|
@@ -4402,15 +4474,97 @@ interface RescheduleDraftOptions {
|
|
|
4402
4474
|
timeSlotOffset?: GoogleProtoDuration;
|
|
4403
4475
|
}
|
|
4404
4476
|
|
|
4405
|
-
declare function listScheduleItems$1(httpClient: HttpClient):
|
|
4406
|
-
|
|
4407
|
-
|
|
4408
|
-
|
|
4409
|
-
|
|
4410
|
-
|
|
4411
|
-
|
|
4412
|
-
|
|
4413
|
-
declare function
|
|
4477
|
+
declare function listScheduleItems$1(httpClient: HttpClient): ListScheduleItemsSignature;
|
|
4478
|
+
interface ListScheduleItemsSignature {
|
|
4479
|
+
/**
|
|
4480
|
+
* Retrieves a list of up to 100 schedule items
|
|
4481
|
+
* @param - Optional fields.
|
|
4482
|
+
*/
|
|
4483
|
+
(options?: ListScheduleItemsOptions | undefined): Promise<ListScheduleItemsResponse & ListScheduleItemsResponseNonNullableFields>;
|
|
4484
|
+
}
|
|
4485
|
+
declare function queryScheduleItems$1(httpClient: HttpClient): QueryScheduleItemsSignature;
|
|
4486
|
+
interface QueryScheduleItemsSignature {
|
|
4487
|
+
/**
|
|
4488
|
+
* Creates a query to retrieve a list of schedule items.
|
|
4489
|
+
*
|
|
4490
|
+
* The `queryScheduleItems( )` function builds a query to retrieve a list of schedule items and returns a [`ItemsQueryBuilder`](https://www.wix.com/velo/reference/wix-events-v2/schedule/itemsquerybuilder) object.
|
|
4491
|
+
*
|
|
4492
|
+
* The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-events-v2/schedule/itemsquerybuilder/find) function.
|
|
4493
|
+
*
|
|
4494
|
+
* You can refine the query by chaining `ItemsQueryBuilder` functions onto the query. `ItemsQueryBuilder` functions enable you to sort, filter, and control the results `queryScheduleItems( )` returns.
|
|
4495
|
+
*
|
|
4496
|
+
* `queryScheduleItems( )` runs with these `ItemsQueryBuilder` defaults, which you can override:
|
|
4497
|
+
*
|
|
4498
|
+
* - [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/schedule/itemsquerybuilder/limit)
|
|
4499
|
+
* - [`descending("_createdDate")`](https://www.wix.com/velo/reference/wix-events-v2/schedule/itemsquerybuilder/descending)
|
|
4500
|
+
*
|
|
4501
|
+
* The functions that are chained to `queryScheduleItems( )` are applied in the order they're called. For example, if you apply `ascending('name')` and then `descending('stageName')`, the results are sorted first by the `name`, and then, if there are multiple results with the same `name`, the items are sorted by `stageName`.
|
|
4502
|
+
*/
|
|
4503
|
+
(): ItemsQueryBuilder;
|
|
4504
|
+
}
|
|
4505
|
+
declare function getScheduleItem$1(httpClient: HttpClient): GetScheduleItemSignature;
|
|
4506
|
+
interface GetScheduleItemSignature {
|
|
4507
|
+
/**
|
|
4508
|
+
* Retrieves schedule item by ID.
|
|
4509
|
+
* @param - Schedule item ID.
|
|
4510
|
+
* @param - Optional fields.
|
|
4511
|
+
* @returns Schedule item.
|
|
4512
|
+
*/
|
|
4513
|
+
(itemId: string, options?: GetScheduleItemOptions | undefined): Promise<ScheduleItem & ScheduleItemNonNullableFields>;
|
|
4514
|
+
}
|
|
4515
|
+
declare function addScheduleItem$1(httpClient: HttpClient): AddScheduleItemSignature;
|
|
4516
|
+
interface AddScheduleItemSignature {
|
|
4517
|
+
/**
|
|
4518
|
+
* Adds a schedule item to the draft schedule.
|
|
4519
|
+
* @param - Event ID to which the schedule belongs.
|
|
4520
|
+
* @param - Optional fields.
|
|
4521
|
+
*/
|
|
4522
|
+
(eventId: string, options?: AddScheduleItemOptions | undefined): Promise<AddScheduleItemResponse & AddScheduleItemResponseNonNullableFields>;
|
|
4523
|
+
}
|
|
4524
|
+
declare function updateScheduleItem$1(httpClient: HttpClient): UpdateScheduleItemSignature;
|
|
4525
|
+
interface UpdateScheduleItemSignature {
|
|
4526
|
+
/**
|
|
4527
|
+
* Updates a schedule item in a draft schedule.
|
|
4528
|
+
* @param - Schedule item ID.
|
|
4529
|
+
* @param - Event ID to which the schedule belongs.
|
|
4530
|
+
* @param - Optional fields.
|
|
4531
|
+
*/
|
|
4532
|
+
(itemId: string, eventId: string, options?: UpdateScheduleItemOptions | undefined): Promise<UpdateScheduleItemResponse & UpdateScheduleItemResponseNonNullableFields>;
|
|
4533
|
+
}
|
|
4534
|
+
declare function deleteScheduleItem$1(httpClient: HttpClient): DeleteScheduleItemSignature;
|
|
4535
|
+
interface DeleteScheduleItemSignature {
|
|
4536
|
+
/**
|
|
4537
|
+
* Deletes schedule items from the draft schedule.
|
|
4538
|
+
* @param - Event ID to which the schedule belongs.
|
|
4539
|
+
* @param - Optional fields.
|
|
4540
|
+
*/
|
|
4541
|
+
(eventId: string, options?: DeleteScheduleItemOptions | undefined): Promise<void>;
|
|
4542
|
+
}
|
|
4543
|
+
declare function discardDraft$3(httpClient: HttpClient): DiscardDraftSignature$1;
|
|
4544
|
+
interface DiscardDraftSignature$1 {
|
|
4545
|
+
/**
|
|
4546
|
+
* Clears all changes to the draft schedule.
|
|
4547
|
+
* @param - Event ID to which the schedule belongs.
|
|
4548
|
+
*/
|
|
4549
|
+
(eventId: string): Promise<void>;
|
|
4550
|
+
}
|
|
4551
|
+
declare function publishDraft$3(httpClient: HttpClient): PublishDraftSignature$1;
|
|
4552
|
+
interface PublishDraftSignature$1 {
|
|
4553
|
+
/**
|
|
4554
|
+
* Publishes the draft schedule.
|
|
4555
|
+
* @param - Event ID to which the schedule belongs.
|
|
4556
|
+
*/
|
|
4557
|
+
(eventId: string): Promise<void>;
|
|
4558
|
+
}
|
|
4559
|
+
declare function rescheduleDraft$1(httpClient: HttpClient): RescheduleDraftSignature;
|
|
4560
|
+
interface RescheduleDraftSignature {
|
|
4561
|
+
/**
|
|
4562
|
+
* Adjusts the time of all draft schedule items at once per event.
|
|
4563
|
+
* @param - Event ID to which the schedule belongs.
|
|
4564
|
+
* @param - Optional fields.
|
|
4565
|
+
*/
|
|
4566
|
+
(eventId: string, options?: RescheduleDraftOptions | undefined): Promise<void>;
|
|
4567
|
+
}
|
|
4414
4568
|
|
|
4415
4569
|
declare function createRESTModule$a<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
4416
4570
|
|
|
@@ -5006,13 +5160,72 @@ interface StaffMembersQueryBuilder {
|
|
|
5006
5160
|
find: () => Promise<StaffMembersQueryResult>;
|
|
5007
5161
|
}
|
|
5008
5162
|
|
|
5009
|
-
declare function createStaffMember$1(httpClient: HttpClient):
|
|
5010
|
-
|
|
5011
|
-
|
|
5012
|
-
|
|
5013
|
-
|
|
5014
|
-
|
|
5015
|
-
|
|
5163
|
+
declare function createStaffMember$1(httpClient: HttpClient): CreateStaffMemberSignature;
|
|
5164
|
+
interface CreateStaffMemberSignature {
|
|
5165
|
+
/**
|
|
5166
|
+
* Creates a staff member.
|
|
5167
|
+
* @param - Staff member to be created.
|
|
5168
|
+
* @returns The created staff member.
|
|
5169
|
+
*/
|
|
5170
|
+
(staffMember: StaffMember): Promise<StaffMember & StaffMemberNonNullableFields>;
|
|
5171
|
+
}
|
|
5172
|
+
declare function getStaffMember$1(httpClient: HttpClient): GetStaffMemberSignature;
|
|
5173
|
+
interface GetStaffMemberSignature {
|
|
5174
|
+
/**
|
|
5175
|
+
* Retrieves a staff member.
|
|
5176
|
+
* @param - ID of the staff member to retrieve.
|
|
5177
|
+
* @returns The requested staff member.
|
|
5178
|
+
*/
|
|
5179
|
+
(staffMemberId: string, options?: GetStaffMemberOptions | undefined): Promise<StaffMember & StaffMemberNonNullableFields>;
|
|
5180
|
+
}
|
|
5181
|
+
declare function updateStaffMember$1(httpClient: HttpClient): UpdateStaffMemberSignature;
|
|
5182
|
+
interface UpdateStaffMemberSignature {
|
|
5183
|
+
/**
|
|
5184
|
+
* Updates a staff member.
|
|
5185
|
+
*
|
|
5186
|
+
* Each time the staff member is updated,
|
|
5187
|
+
* `revision` increments by 1.
|
|
5188
|
+
* The current `revision` must be passed when updating the staff member.
|
|
5189
|
+
* This ensures you're working with the latest staff member
|
|
5190
|
+
* and prevents unintended overwrites.
|
|
5191
|
+
* @param - Staff member ID.
|
|
5192
|
+
* @returns Updated staff member.
|
|
5193
|
+
*/
|
|
5194
|
+
(_id: string | null, staffMember: UpdateStaffMember): Promise<StaffMember & StaffMemberNonNullableFields>;
|
|
5195
|
+
}
|
|
5196
|
+
declare function deleteStaffMember$1(httpClient: HttpClient): DeleteStaffMemberSignature;
|
|
5197
|
+
interface DeleteStaffMemberSignature {
|
|
5198
|
+
/**
|
|
5199
|
+
* Deletes a staff member.
|
|
5200
|
+
*
|
|
5201
|
+
* Deleting a staff member permanently removes them from the staff member List.
|
|
5202
|
+
* @param - Id of the staff member to delete.
|
|
5203
|
+
*/
|
|
5204
|
+
(staffMemberId: string): Promise<void>;
|
|
5205
|
+
}
|
|
5206
|
+
declare function queryStaffMembers$1(httpClient: HttpClient): QueryStaffMembersSignature;
|
|
5207
|
+
interface QueryStaffMembersSignature {
|
|
5208
|
+
/**
|
|
5209
|
+
* Retrieves a list of staff members, given the provided paging, filtering, and sorting.
|
|
5210
|
+
*/
|
|
5211
|
+
(options?: QueryStaffMembersOptions | undefined): StaffMembersQueryBuilder;
|
|
5212
|
+
}
|
|
5213
|
+
declare function joinStaffMember$1(httpClient: HttpClient): JoinStaffMemberSignature;
|
|
5214
|
+
interface JoinStaffMemberSignature {
|
|
5215
|
+
/**
|
|
5216
|
+
* Joins as staff member if he's not in suspended status via provided token.
|
|
5217
|
+
* @param - Used to authorise staff member
|
|
5218
|
+
*/
|
|
5219
|
+
(joinToken: string): Promise<JoinStaffMemberResponse & JoinStaffMemberResponseNonNullableFields>;
|
|
5220
|
+
}
|
|
5221
|
+
declare function accessStaffMember$1(httpClient: HttpClient): AccessStaffMemberSignature;
|
|
5222
|
+
interface AccessStaffMemberSignature {
|
|
5223
|
+
/**
|
|
5224
|
+
* Retrieves a staff by access token.
|
|
5225
|
+
* @param - Used to authorise staff member
|
|
5226
|
+
*/
|
|
5227
|
+
(accessToken: string): Promise<AccessStaffMemberResponse & AccessStaffMemberResponseNonNullableFields>;
|
|
5228
|
+
}
|
|
5016
5229
|
declare const onStaffMemberCreated$1: EventDefinition<StaffMemberCreatedEnvelope, "wix.events.staffmembers.v1.staff_member_created">;
|
|
5017
5230
|
declare const onStaffMemberUpdated$1: EventDefinition<StaffMemberUpdatedEnvelope, "wix.events.staffmembers.v1.staff_member_updated">;
|
|
5018
5231
|
declare const onStaffMemberDeleted$1: EventDefinition<StaffMemberDeletedEnvelope, "wix.events.staffmembers.v1.staff_member_deleted">;
|
|
@@ -5037,12 +5250,15 @@ type _publicAccessStaffMemberType = typeof accessStaffMember$1;
|
|
|
5037
5250
|
declare const accessStaffMember: ReturnType<typeof createRESTModule$9<_publicAccessStaffMemberType>>;
|
|
5038
5251
|
|
|
5039
5252
|
type _publicOnStaffMemberCreatedType = typeof onStaffMemberCreated$1;
|
|
5253
|
+
/** */
|
|
5040
5254
|
declare const onStaffMemberCreated: ReturnType<typeof createEventModule$8<_publicOnStaffMemberCreatedType>>;
|
|
5041
5255
|
|
|
5042
5256
|
type _publicOnStaffMemberUpdatedType = typeof onStaffMemberUpdated$1;
|
|
5257
|
+
/** */
|
|
5043
5258
|
declare const onStaffMemberUpdated: ReturnType<typeof createEventModule$8<_publicOnStaffMemberUpdatedType>>;
|
|
5044
5259
|
|
|
5045
5260
|
type _publicOnStaffMemberDeletedType = typeof onStaffMemberDeleted$1;
|
|
5261
|
+
/** */
|
|
5046
5262
|
declare const onStaffMemberDeleted: ReturnType<typeof createEventModule$8<_publicOnStaffMemberDeletedType>>;
|
|
5047
5263
|
|
|
5048
5264
|
type index_d$9_AccessStaffMemberRequest = AccessStaffMemberRequest;
|
|
@@ -5643,19 +5859,141 @@ interface ReorderCategoryEventsOptions extends ReorderCategoryEventsRequestRefer
|
|
|
5643
5859
|
afterEventId?: string;
|
|
5644
5860
|
}
|
|
5645
5861
|
|
|
5646
|
-
declare function createCategory$1(httpClient: HttpClient):
|
|
5647
|
-
|
|
5648
|
-
|
|
5649
|
-
|
|
5650
|
-
|
|
5651
|
-
|
|
5652
|
-
|
|
5653
|
-
|
|
5654
|
-
|
|
5655
|
-
declare function
|
|
5656
|
-
|
|
5657
|
-
|
|
5658
|
-
|
|
5862
|
+
declare function createCategory$1(httpClient: HttpClient): CreateCategorySignature;
|
|
5863
|
+
interface CreateCategorySignature {
|
|
5864
|
+
/**
|
|
5865
|
+
* Creates a category.
|
|
5866
|
+
* @param - Category to create.
|
|
5867
|
+
* @returns Created category.
|
|
5868
|
+
*/
|
|
5869
|
+
(category: Category$3): Promise<Category$3 & CategoryNonNullableFields>;
|
|
5870
|
+
}
|
|
5871
|
+
declare function bulkCreateCategory$1(httpClient: HttpClient): BulkCreateCategorySignature;
|
|
5872
|
+
interface BulkCreateCategorySignature {
|
|
5873
|
+
/**
|
|
5874
|
+
* Creates multipe categories at once.
|
|
5875
|
+
* @param - Categories to create.
|
|
5876
|
+
*/
|
|
5877
|
+
(categories: Category$3[]): Promise<BulkCreateCategoryResponse & BulkCreateCategoryResponseNonNullableFields>;
|
|
5878
|
+
}
|
|
5879
|
+
declare function updateCategory$1(httpClient: HttpClient): UpdateCategorySignature;
|
|
5880
|
+
interface UpdateCategorySignature {
|
|
5881
|
+
/**
|
|
5882
|
+
* Updates an existing category.
|
|
5883
|
+
* @param - Category ID.
|
|
5884
|
+
* @returns Updated category.
|
|
5885
|
+
*/
|
|
5886
|
+
(_id: string, category: UpdateCategory): Promise<Category$3 & CategoryNonNullableFields>;
|
|
5887
|
+
}
|
|
5888
|
+
declare function deleteCategory$1(httpClient: HttpClient): DeleteCategorySignature;
|
|
5889
|
+
interface DeleteCategorySignature {
|
|
5890
|
+
/**
|
|
5891
|
+
* Deletes a category.
|
|
5892
|
+
* @param - ID of category to be deleted.
|
|
5893
|
+
*/
|
|
5894
|
+
(categoryId: string): Promise<void>;
|
|
5895
|
+
}
|
|
5896
|
+
declare function queryCategories$1(httpClient: HttpClient): QueryCategoriesSignature;
|
|
5897
|
+
interface QueryCategoriesSignature {
|
|
5898
|
+
/**
|
|
5899
|
+
* Creates a query to retrieve a list of categories.
|
|
5900
|
+
*
|
|
5901
|
+
*
|
|
5902
|
+
* The `queryCategories()` function builds a query to retrieve a list of categories and returns a [`CategoriesQueryBuilder`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder) object.
|
|
5903
|
+
*
|
|
5904
|
+
* The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/find) function.
|
|
5905
|
+
*
|
|
5906
|
+
* You can refine the query by chaining `CategoriesQueryBuilder` functions onto the query. `CategoriesQueryBuilder` functions enable you to sort, filter, and control the results `queryCategories()` returns.
|
|
5907
|
+
*
|
|
5908
|
+
* `queryCategories()` runs with these `CategoriesQueryBuilder` defaults, which you can override:
|
|
5909
|
+
*
|
|
5910
|
+
* - [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/limit)
|
|
5911
|
+
* @param - Options to use when querying categories.
|
|
5912
|
+
*/
|
|
5913
|
+
(options?: QueryCategoriesOptions | undefined): CategoriesQueryBuilder;
|
|
5914
|
+
}
|
|
5915
|
+
declare function assignEvents$1(httpClient: HttpClient): AssignEventsSignature;
|
|
5916
|
+
interface AssignEventsSignature {
|
|
5917
|
+
/**
|
|
5918
|
+
* Assigns events to a single category.
|
|
5919
|
+
* @param - ID of category to which events should be assigned.
|
|
5920
|
+
* @param - A list of events IDs.
|
|
5921
|
+
*/
|
|
5922
|
+
(categoryId: string, eventId: string[]): Promise<void>;
|
|
5923
|
+
}
|
|
5924
|
+
declare function bulkAssignEvents$1(httpClient: HttpClient): BulkAssignEventsSignature;
|
|
5925
|
+
interface BulkAssignEventsSignature {
|
|
5926
|
+
/**
|
|
5927
|
+
* Assigns events to multiple categories at once.
|
|
5928
|
+
* @param - A list of category IDs to which events should be assigned.
|
|
5929
|
+
* @param - Options to use when assigning events to multiple categories.
|
|
5930
|
+
*/
|
|
5931
|
+
(categoryId: string[], options: BulkAssignEventsOptions): Promise<BulkAssignEventsResponse & BulkAssignEventsResponseNonNullableFields>;
|
|
5932
|
+
}
|
|
5933
|
+
declare function bulkAssignEventsAsync$1(httpClient: HttpClient): BulkAssignEventsAsyncSignature;
|
|
5934
|
+
interface BulkAssignEventsAsyncSignature {
|
|
5935
|
+
/**
|
|
5936
|
+
* Assigns events that match given filter criteria to multiple categories.
|
|
5937
|
+
*
|
|
5938
|
+
* Unlike the [`bulkAssignEvents()`](https://www.wix.com/velo/reference/wix-events-v2/categories/bulkassignevents) function, this function can handle numerous requests and is less prone to failures.
|
|
5939
|
+
*
|
|
5940
|
+
* However, the events will not be instantly assigned to the categories (as with `bulkAssignEvents()`), but rather after some time. In this case, if try to [`listEventCategories`](https://www.wix.com/velo/reference/wix-events-v2/categories/listeventcategories) or [`queryCategories`](https://www.wix.com/velo/reference/wix-events-v2/categories/querycategories), you might not get the correct response.
|
|
5941
|
+
* @param - Category IDs.
|
|
5942
|
+
* @param - Options to use when assigning events to multiple categories.
|
|
5943
|
+
*/
|
|
5944
|
+
(categoryId: string[], options: BulkAssignEventsAsyncOptions): Promise<void>;
|
|
5945
|
+
}
|
|
5946
|
+
declare function unassignEvents$1(httpClient: HttpClient): UnassignEventsSignature;
|
|
5947
|
+
interface UnassignEventsSignature {
|
|
5948
|
+
/**
|
|
5949
|
+
* Unassigns events from a category.
|
|
5950
|
+
* @param - Category ID.
|
|
5951
|
+
* @param - A list of events IDs.
|
|
5952
|
+
*/
|
|
5953
|
+
(categoryId: string, eventId: string[]): Promise<void>;
|
|
5954
|
+
}
|
|
5955
|
+
declare function bulkUnassignEvents$1(httpClient: HttpClient): BulkUnassignEventsSignature;
|
|
5956
|
+
interface BulkUnassignEventsSignature {
|
|
5957
|
+
/**
|
|
5958
|
+
* Unassigns events from multiple categories at once.
|
|
5959
|
+
* @param - A list of category IDs.
|
|
5960
|
+
* @param - Options to use when removing events from multiple categories.
|
|
5961
|
+
*/
|
|
5962
|
+
(categoryId: string[], options?: BulkUnassignEventsOptions | undefined): Promise<BulkUnassignEventsResponse & BulkUnassignEventsResponseNonNullableFields>;
|
|
5963
|
+
}
|
|
5964
|
+
declare function bulkUnassignEventsAsync$1(httpClient: HttpClient): BulkUnassignEventsAsyncSignature;
|
|
5965
|
+
interface BulkUnassignEventsAsyncSignature {
|
|
5966
|
+
/**
|
|
5967
|
+
* Removes events that match given filter criteria from multiple categories.
|
|
5968
|
+
*
|
|
5969
|
+
* Unlike the [`bulkUnassignEvents()`](https://www.wix.com/velo/reference/wix-events-v2/categories/bulkunassignevents) function, this function can handle numerous requests and is less prone to failures.
|
|
5970
|
+
*
|
|
5971
|
+
* However, the events will not be instantly removed from the categories (as with `bulkUnassignEvents()`), but rather after some time. In this case, if try to [`listEventCategories`](https://www.wix.com/velo/reference/wix-events-v2/categories/listeventcategories) or [`queryCategories`](https://www.wix.com/velo/reference/wix-events-v2/categories/querycategories), you might not get the correct response.
|
|
5972
|
+
* @param - Category ID.
|
|
5973
|
+
* @param - Options to use when removing events from multiple categories.
|
|
5974
|
+
*/
|
|
5975
|
+
(categoryId: string[], options: BulkUnassignEventsAsyncOptions): Promise<void>;
|
|
5976
|
+
}
|
|
5977
|
+
declare function listEventCategories$1(httpClient: HttpClient): ListEventCategoriesSignature;
|
|
5978
|
+
interface ListEventCategoriesSignature {
|
|
5979
|
+
/**
|
|
5980
|
+
* Retrieves a list of categories that are not in the `HIDDEN` state.
|
|
5981
|
+
* @param - Event ID.
|
|
5982
|
+
*/
|
|
5983
|
+
(eventId: string): Promise<ListEventCategoriesResponse & ListEventCategoriesResponseNonNullableFields>;
|
|
5984
|
+
}
|
|
5985
|
+
declare function reorderCategoryEvents$1(httpClient: HttpClient): ReorderCategoryEventsSignature;
|
|
5986
|
+
interface ReorderCategoryEventsSignature {
|
|
5987
|
+
/**
|
|
5988
|
+
* Change the order of events that are assigned to the same category on the Events Widget.
|
|
5989
|
+
*
|
|
5990
|
+
*
|
|
5991
|
+
* For more information see [this article](https://support.wix.com/en/article/creating-and-displaying-event-categories)
|
|
5992
|
+
* @param - Category ID.
|
|
5993
|
+
* @param - Options to use when reordering events.
|
|
5994
|
+
*/
|
|
5995
|
+
(categoryId: string, options?: ReorderCategoryEventsOptions | undefined): Promise<void>;
|
|
5996
|
+
}
|
|
5659
5997
|
|
|
5660
5998
|
declare function createRESTModule$8<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
5661
5999
|
|
|
@@ -7234,13 +7572,69 @@ interface UpdateMessagesOptions {
|
|
|
7234
7572
|
messages?: FormMessages$2;
|
|
7235
7573
|
}
|
|
7236
7574
|
|
|
7237
|
-
declare function getForm$1(httpClient: HttpClient):
|
|
7238
|
-
|
|
7239
|
-
|
|
7240
|
-
|
|
7241
|
-
|
|
7242
|
-
|
|
7243
|
-
|
|
7575
|
+
declare function getForm$1(httpClient: HttpClient): GetFormSignature;
|
|
7576
|
+
interface GetFormSignature {
|
|
7577
|
+
/**
|
|
7578
|
+
* Retrieves an event registration form (both the draft and published versions).
|
|
7579
|
+
* @param - Event ID to which the form belongs.
|
|
7580
|
+
* @param - Optional fields.
|
|
7581
|
+
* @returns Currently published event form.
|
|
7582
|
+
* Published form is visible to site visitors.
|
|
7583
|
+
*/
|
|
7584
|
+
(eventId: string): Promise<Form$2 & FormNonNullableFields$1>;
|
|
7585
|
+
}
|
|
7586
|
+
declare function addControl$1(httpClient: HttpClient): AddControlSignature;
|
|
7587
|
+
interface AddControlSignature {
|
|
7588
|
+
/**
|
|
7589
|
+
* Adds an input control to the draft form.
|
|
7590
|
+
* @param - Event ID to which the form belongs.
|
|
7591
|
+
* @param - Optional fields.
|
|
7592
|
+
*/
|
|
7593
|
+
(eventId: string, options?: AddControlOptions | undefined): Promise<AddControlResponse & AddControlResponseNonNullableFields>;
|
|
7594
|
+
}
|
|
7595
|
+
declare function updateControl$1(httpClient: HttpClient): UpdateControlSignature;
|
|
7596
|
+
interface UpdateControlSignature {
|
|
7597
|
+
/**
|
|
7598
|
+
* Updates an existing input control in the draft form.
|
|
7599
|
+
* @param - Optional fields.
|
|
7600
|
+
* @param - Identifies what form to update.
|
|
7601
|
+
*/
|
|
7602
|
+
(identifiers: UpdateControlIdentifiers, options?: UpdateControlOptions | undefined): Promise<UpdateControlResponse & UpdateControlResponseNonNullableFields>;
|
|
7603
|
+
}
|
|
7604
|
+
declare function deleteControl$1(httpClient: HttpClient): DeleteControlSignature;
|
|
7605
|
+
interface DeleteControlSignature {
|
|
7606
|
+
/**
|
|
7607
|
+
* Deletes an input control from the draft form.
|
|
7608
|
+
* @param - Identifies what form to delete.
|
|
7609
|
+
*/
|
|
7610
|
+
(identifiers: DeleteControlIdentifiers): Promise<DeleteControlResponse & DeleteControlResponseNonNullableFields>;
|
|
7611
|
+
}
|
|
7612
|
+
declare function updateMessages$1(httpClient: HttpClient): UpdateMessagesSignature;
|
|
7613
|
+
interface UpdateMessagesSignature {
|
|
7614
|
+
/**
|
|
7615
|
+
* Updates draft form messages, as displayed in the Wix UI before, during, and after the registration flow.
|
|
7616
|
+
* Configurable messages include form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
7617
|
+
* @param - Event ID to which the form belongs.
|
|
7618
|
+
* @param - Optional fields.
|
|
7619
|
+
*/
|
|
7620
|
+
(eventId: string, options?: UpdateMessagesOptions | undefined): Promise<UpdateMessagesResponse & UpdateMessagesResponseNonNullableFields>;
|
|
7621
|
+
}
|
|
7622
|
+
declare function publishDraft$1(httpClient: HttpClient): PublishDraftSignature;
|
|
7623
|
+
interface PublishDraftSignature {
|
|
7624
|
+
/**
|
|
7625
|
+
* Publishes the draft form.
|
|
7626
|
+
* @param - Event ID to which the form belongs.
|
|
7627
|
+
*/
|
|
7628
|
+
(eventId: string): Promise<PublishDraftResponse & PublishDraftResponseNonNullableFields>;
|
|
7629
|
+
}
|
|
7630
|
+
declare function discardDraft$1(httpClient: HttpClient): DiscardDraftSignature;
|
|
7631
|
+
interface DiscardDraftSignature {
|
|
7632
|
+
/**
|
|
7633
|
+
* Clears all changes to the draft form.
|
|
7634
|
+
* @param - Event ID to which the form belongs.
|
|
7635
|
+
*/
|
|
7636
|
+
(eventId: string): Promise<void>;
|
|
7637
|
+
}
|
|
7244
7638
|
declare const onFormEventUpdated$1: EventDefinition<FormEventUpdatedEnvelope, "wix.events.events.EventUpdated">;
|
|
7245
7639
|
|
|
7246
7640
|
declare function createRESTModule$7<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
@@ -7263,6 +7657,7 @@ type _publicDiscardDraftType = typeof discardDraft$1;
|
|
|
7263
7657
|
declare const discardDraft: ReturnType<typeof createRESTModule$7<_publicDiscardDraftType>>;
|
|
7264
7658
|
|
|
7265
7659
|
type _publicOnFormEventUpdatedType = typeof onFormEventUpdated$1;
|
|
7660
|
+
/** */
|
|
7266
7661
|
declare const onFormEventUpdated: ReturnType<typeof createEventModule$7<_publicOnFormEventUpdatedType>>;
|
|
7267
7662
|
|
|
7268
7663
|
type index_d$7_AddControlOptions = AddControlOptions;
|
|
@@ -9340,33 +9735,188 @@ interface PosCheckoutOptions {
|
|
|
9340
9735
|
paymentDetailsId?: string | null;
|
|
9341
9736
|
}
|
|
9342
9737
|
|
|
9343
|
-
declare function listOrders$1(httpClient: HttpClient):
|
|
9344
|
-
|
|
9345
|
-
|
|
9346
|
-
|
|
9347
|
-
|
|
9348
|
-
|
|
9349
|
-
|
|
9350
|
-
|
|
9351
|
-
declare function
|
|
9352
|
-
|
|
9353
|
-
|
|
9354
|
-
|
|
9355
|
-
|
|
9356
|
-
|
|
9357
|
-
|
|
9358
|
-
|
|
9359
|
-
|
|
9360
|
-
|
|
9361
|
-
|
|
9362
|
-
|
|
9363
|
-
|
|
9364
|
-
|
|
9365
|
-
|
|
9366
|
-
|
|
9367
|
-
|
|
9368
|
-
|
|
9369
|
-
|
|
9738
|
+
declare function listOrders$1(httpClient: HttpClient): ListOrdersSignature;
|
|
9739
|
+
interface ListOrdersSignature {
|
|
9740
|
+
/**
|
|
9741
|
+
* Retrieves a list of orders, including ticket data.
|
|
9742
|
+
* @param - An object representing the available options for retrieving a list of orders.
|
|
9743
|
+
*/
|
|
9744
|
+
(options?: ListOrdersOptions | undefined): Promise<ListOrdersResponse & ListOrdersResponseNonNullableFields>;
|
|
9745
|
+
}
|
|
9746
|
+
declare function getOrder$1(httpClient: HttpClient): GetOrderSignature;
|
|
9747
|
+
interface GetOrderSignature {
|
|
9748
|
+
/**
|
|
9749
|
+
* Retrieves an order, including ticket data.
|
|
9750
|
+
* <!--
|
|
9751
|
+
* >The fieldsets in this function are restricted and only run if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
9752
|
+
* -->
|
|
9753
|
+
* @param - An object representing the available options for getting an order.
|
|
9754
|
+
* @param - An object containing identifiers for the order to be retrieved.
|
|
9755
|
+
* @returns Requested order.
|
|
9756
|
+
*/
|
|
9757
|
+
(identifiers: GetOrderIdentifiers, options?: GetOrderOptions | undefined): Promise<Order & OrderNonNullableFields>;
|
|
9758
|
+
}
|
|
9759
|
+
declare function updateOrder$1(httpClient: HttpClient): UpdateOrderSignature;
|
|
9760
|
+
interface UpdateOrderSignature {
|
|
9761
|
+
/**
|
|
9762
|
+
* Updates an order.
|
|
9763
|
+
* @param - An object representing the available options for updating an order.
|
|
9764
|
+
* @param - An object containing identifiers for the order to be updated.
|
|
9765
|
+
*/
|
|
9766
|
+
(identifiers: UpdateOrderIdentifiers, options?: UpdateOrderOptions | undefined): Promise<UpdateOrderResponse & UpdateOrderResponseNonNullableFields>;
|
|
9767
|
+
}
|
|
9768
|
+
declare function bulkUpdateOrders$1(httpClient: HttpClient): BulkUpdateOrdersSignature;
|
|
9769
|
+
interface BulkUpdateOrdersSignature {
|
|
9770
|
+
/**
|
|
9771
|
+
* Archives multiple orders.
|
|
9772
|
+
* @param - An object representing the available options for confirming an order.
|
|
9773
|
+
* @param - Event ID to which the order belongs.
|
|
9774
|
+
*/
|
|
9775
|
+
(eventId: string, options?: BulkUpdateOrdersOptions | undefined): Promise<BulkUpdateOrdersResponse & BulkUpdateOrdersResponseNonNullableFields>;
|
|
9776
|
+
}
|
|
9777
|
+
declare function confirmOrder$1(httpClient: HttpClient): ConfirmOrderSignature;
|
|
9778
|
+
interface ConfirmOrderSignature {
|
|
9779
|
+
/**
|
|
9780
|
+
* Confirms an order.
|
|
9781
|
+
*
|
|
9782
|
+
*
|
|
9783
|
+
* This function changes order status from `INITIATED`, `PENDING`, `OFFLINE_PENDING` to `PAID`.
|
|
9784
|
+
* Confirming orders with `INITIATED` or `PENDING` status triggers an email with the tickets to the buyer (and to additional guests, if provided).
|
|
9785
|
+
* @param - An object representing the available options for confirming an order.
|
|
9786
|
+
* @param - Event ID to which the order belongs.
|
|
9787
|
+
*/
|
|
9788
|
+
(eventId: string, options?: ConfirmOrderOptions | undefined): Promise<ConfirmOrderResponse & ConfirmOrderResponseNonNullableFields>;
|
|
9789
|
+
}
|
|
9790
|
+
declare function getSummary$1(httpClient: HttpClient): GetSummarySignature;
|
|
9791
|
+
interface GetSummarySignature {
|
|
9792
|
+
/**
|
|
9793
|
+
* Retrieves a summary of total ticket sales.
|
|
9794
|
+
* <!--
|
|
9795
|
+
* > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
9796
|
+
* -->
|
|
9797
|
+
* @param - An object representing the available options for retrieving a summary of total ticket sales.
|
|
9798
|
+
*/
|
|
9799
|
+
(options?: GetSummaryOptions | undefined): Promise<GetSummaryResponse & GetSummaryResponseNonNullableFields>;
|
|
9800
|
+
}
|
|
9801
|
+
declare function getCheckoutOptions$1(httpClient: HttpClient): GetCheckoutOptionsSignature;
|
|
9802
|
+
interface GetCheckoutOptionsSignature {
|
|
9803
|
+
/**
|
|
9804
|
+
* Retrieves checkout details.
|
|
9805
|
+
*/
|
|
9806
|
+
(): Promise<GetCheckoutOptionsResponse & GetCheckoutOptionsResponseNonNullableFields>;
|
|
9807
|
+
}
|
|
9808
|
+
declare function listAvailableTickets$1(httpClient: HttpClient): ListAvailableTicketsSignature;
|
|
9809
|
+
interface ListAvailableTicketsSignature {
|
|
9810
|
+
/**
|
|
9811
|
+
* Returns tickets available to reserve.
|
|
9812
|
+
* <!--
|
|
9813
|
+
* > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
9814
|
+
* -->
|
|
9815
|
+
* @param - An object representing the available options for retrieving a list of tickets available for reservation.
|
|
9816
|
+
*/
|
|
9817
|
+
(options?: ListAvailableTicketsOptions | undefined): Promise<ListAvailableTicketsResponse & ListAvailableTicketsResponseNonNullableFields>;
|
|
9818
|
+
}
|
|
9819
|
+
declare function queryAvailableTickets$1(httpClient: HttpClient): QueryAvailableTicketsSignature;
|
|
9820
|
+
interface QueryAvailableTicketsSignature {
|
|
9821
|
+
/**
|
|
9822
|
+
* Returns tickets available to reserve.
|
|
9823
|
+
* <!--
|
|
9824
|
+
* > Note: The fieldsets in this function are restricted and only run if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
9825
|
+
* -->
|
|
9826
|
+
* @param - An object representing the available options for retrieving a list of tickets available for reservation.
|
|
9827
|
+
*/
|
|
9828
|
+
(options?: QueryAvailableTicketsOptions | undefined): Promise<QueryAvailableTicketsResponse & QueryAvailableTicketsResponseNonNullableFields>;
|
|
9829
|
+
}
|
|
9830
|
+
declare function createReservation$1(httpClient: HttpClient): CreateReservationSignature;
|
|
9831
|
+
interface CreateReservationSignature {
|
|
9832
|
+
/**
|
|
9833
|
+
* Reserves tickets for 20 minutes.
|
|
9834
|
+
*
|
|
9835
|
+
*
|
|
9836
|
+
* Reserved tickets are deducted from ticket stock and cannot be bought by another site visitor.
|
|
9837
|
+
* When the reservation expires, the tickets are added back to the stock.
|
|
9838
|
+
* @param - An object representing the available options for creating a reservation.
|
|
9839
|
+
* @param - Event ID to which the reservation belongs.
|
|
9840
|
+
*/
|
|
9841
|
+
(eventId: string, options?: CreateReservationOptions | undefined): Promise<CreateReservationResponse & CreateReservationResponseNonNullableFields>;
|
|
9842
|
+
}
|
|
9843
|
+
declare function cancelReservation$1(httpClient: HttpClient): CancelReservationSignature;
|
|
9844
|
+
interface CancelReservationSignature {
|
|
9845
|
+
/**
|
|
9846
|
+
* Cancels ticket reservation and returns tickets to stock.
|
|
9847
|
+
* <!--
|
|
9848
|
+
* > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
9849
|
+
* -->
|
|
9850
|
+
* @param - Reservation ID.
|
|
9851
|
+
* @param - An object containing identifiers for the reservation to be cancelled.
|
|
9852
|
+
* @param - Event ID to which the reservation belongs.
|
|
9853
|
+
*/
|
|
9854
|
+
(_id: string, eventId: string): Promise<void>;
|
|
9855
|
+
}
|
|
9856
|
+
declare function getInvoice$1(httpClient: HttpClient): GetInvoiceSignature;
|
|
9857
|
+
interface GetInvoiceSignature {
|
|
9858
|
+
/**
|
|
9859
|
+
* Generates a preview of an invoice, including the given coupon or pricing plan.
|
|
9860
|
+
* @param - Reservation ID.
|
|
9861
|
+
* @param - An object representing the available options for generating a preview of a reservation invoice.
|
|
9862
|
+
* @param - An object containing identifiers for the reservation invoice preview to be generated.
|
|
9863
|
+
* @param - Event ID to which the invoice belongs.
|
|
9864
|
+
*/
|
|
9865
|
+
(reservationId: string, eventId: string, options?: GetInvoiceOptions | undefined): Promise<GetInvoiceResponse & GetInvoiceResponseNonNullableFields>;
|
|
9866
|
+
}
|
|
9867
|
+
declare function checkout$1(httpClient: HttpClient): CheckoutSignature;
|
|
9868
|
+
interface CheckoutSignature {
|
|
9869
|
+
/**
|
|
9870
|
+
* Checkouts the reserved tickets.
|
|
9871
|
+
*
|
|
9872
|
+
*
|
|
9873
|
+
* Creates an order and associates it with a site visitor contact.
|
|
9874
|
+
* Guest details are received from the [Registration Form](https://www.wix.com/velo/reference/wix-events-v2/forms/introduction) input fields.
|
|
9875
|
+
*
|
|
9876
|
+
* There is a possibility to use a separate ready-made Wix checkout form where the user will be redirected from your non-Wix site or a custom ticket picker created with Velo.
|
|
9877
|
+
* To build the checkout form path, get your event base URL by using the [`getEvent()`](https://www.wix.com/velo/reference/wix-events-backend/wixevents/getevent) function and add the following path:
|
|
9878
|
+
* `/{{EVENT_PAGE_SLUG}}/{{SLUG}}/ticket-form?reservationId={{YOUR_RESERVATION_ID}}`
|
|
9879
|
+
*
|
|
9880
|
+
* Example: `https://johndoe.wixsite.com/weddings/event-details/doe-wedding/ticket-form?reservationId=2be6d34a-2a1e-459f-897b-b4a66e73f69a`
|
|
9881
|
+
* @param - An object representing the available options for checking out a reserved ticket.
|
|
9882
|
+
* @param - Event ID to which the checkout belongs.
|
|
9883
|
+
*/
|
|
9884
|
+
(eventId: string, options?: CheckoutOptionsForRequest | undefined): Promise<CheckoutResponse & CheckoutResponseNonNullableFields>;
|
|
9885
|
+
}
|
|
9886
|
+
declare function updateCheckout$1(httpClient: HttpClient): UpdateCheckoutSignature;
|
|
9887
|
+
interface UpdateCheckoutSignature {
|
|
9888
|
+
/**
|
|
9889
|
+
* Updates order and tickets.
|
|
9890
|
+
*
|
|
9891
|
+
*
|
|
9892
|
+
* Only applicable for orders with `INITIATED`, `PENDING`, `OFFLINE_PENDING` statuses.
|
|
9893
|
+
* @param - Unique order number.
|
|
9894
|
+
* @param - An object representing the available options for updating an order and tickets.
|
|
9895
|
+
* @param - An object containing identifiers for the order and tickets to be updated.
|
|
9896
|
+
* @param - Event ID to which the checkout belongs.
|
|
9897
|
+
*/
|
|
9898
|
+
(orderNumber: string, eventId: string, options?: UpdateCheckoutOptions | undefined): Promise<UpdateCheckoutResponse & UpdateCheckoutResponseNonNullableFields>;
|
|
9899
|
+
}
|
|
9900
|
+
declare function posCheckout$1(httpClient: HttpClient): PosCheckoutSignature;
|
|
9901
|
+
interface PosCheckoutSignature {
|
|
9902
|
+
/**
|
|
9903
|
+
* Creates order with payment details already initiated via Cashier Pay API.
|
|
9904
|
+
* @param - Event ID to which the checkout belongs.
|
|
9905
|
+
*/
|
|
9906
|
+
(eventId: string, options?: PosCheckoutOptions | undefined): Promise<PosCheckoutResponse & PosCheckoutResponseNonNullableFields>;
|
|
9907
|
+
}
|
|
9908
|
+
declare const onOrderDeleted$1: EventDefinition<OrderDeletedEnvelope, "wix.events.ticketing.events.OrderDeleted">;
|
|
9909
|
+
declare const onOrderUpdated$1: EventDefinition<OrderUpdatedEnvelope, "wix.events.ticketing.events.OrderUpdated">;
|
|
9910
|
+
declare const onOrderConfirmed$1: EventDefinition<OrderConfirmedEnvelope, "wix.events.ticketing.events.OrderConfirmed">;
|
|
9911
|
+
declare const onOrderReservationCreated$1: EventDefinition<OrderReservationCreatedEnvelope, "wix.events.ticketing.events.ReservationCreated">;
|
|
9912
|
+
declare const onOrderReservationUpdated$1: EventDefinition<OrderReservationUpdatedEnvelope, "wix.events.ticketing.events.ReservationUpdated">;
|
|
9913
|
+
declare const onOrderInitiated$1: EventDefinition<OrderInitiatedEnvelope, "wix.events.ticketing.events.OrderInitiated">;
|
|
9914
|
+
|
|
9915
|
+
declare function createRESTModule$6<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
9916
|
+
|
|
9917
|
+
declare function createEventModule$6<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
9918
|
+
|
|
9919
|
+
type _publicListOrdersType = typeof listOrders$1;
|
|
9370
9920
|
declare const listOrders: ReturnType<typeof createRESTModule$6<_publicListOrdersType>>;
|
|
9371
9921
|
type _publicGetOrderType = typeof getOrder$1;
|
|
9372
9922
|
declare const getOrder: ReturnType<typeof createRESTModule$6<_publicGetOrderType>>;
|
|
@@ -9398,21 +9948,29 @@ type _publicPosCheckoutType = typeof posCheckout$1;
|
|
|
9398
9948
|
declare const posCheckout: ReturnType<typeof createRESTModule$6<_publicPosCheckoutType>>;
|
|
9399
9949
|
|
|
9400
9950
|
type _publicOnOrderDeletedType = typeof onOrderDeleted$1;
|
|
9951
|
+
/**
|
|
9952
|
+
* This event is triggered when an order is deleted via GDPR request.
|
|
9953
|
+
*/
|
|
9401
9954
|
declare const onOrderDeleted: ReturnType<typeof createEventModule$6<_publicOnOrderDeletedType>>;
|
|
9402
9955
|
|
|
9403
9956
|
type _publicOnOrderUpdatedType = typeof onOrderUpdated$1;
|
|
9957
|
+
/** */
|
|
9404
9958
|
declare const onOrderUpdated: ReturnType<typeof createEventModule$6<_publicOnOrderUpdatedType>>;
|
|
9405
9959
|
|
|
9406
9960
|
type _publicOnOrderConfirmedType = typeof onOrderConfirmed$1;
|
|
9961
|
+
/** */
|
|
9407
9962
|
declare const onOrderConfirmed: ReturnType<typeof createEventModule$6<_publicOnOrderConfirmedType>>;
|
|
9408
9963
|
|
|
9409
9964
|
type _publicOnOrderReservationCreatedType = typeof onOrderReservationCreated$1;
|
|
9965
|
+
/** */
|
|
9410
9966
|
declare const onOrderReservationCreated: ReturnType<typeof createEventModule$6<_publicOnOrderReservationCreatedType>>;
|
|
9411
9967
|
|
|
9412
9968
|
type _publicOnOrderReservationUpdatedType = typeof onOrderReservationUpdated$1;
|
|
9969
|
+
/** */
|
|
9413
9970
|
declare const onOrderReservationUpdated: ReturnType<typeof createEventModule$6<_publicOnOrderReservationUpdatedType>>;
|
|
9414
9971
|
|
|
9415
9972
|
type _publicOnOrderInitiatedType = typeof onOrderInitiated$1;
|
|
9973
|
+
/** */
|
|
9416
9974
|
declare const onOrderInitiated: ReturnType<typeof createEventModule$6<_publicOnOrderInitiatedType>>;
|
|
9417
9975
|
|
|
9418
9976
|
type index_d$6_BulkUpdateOrdersOptions = BulkUpdateOrdersOptions;
|
|
@@ -10033,6 +10591,16 @@ interface BulkUpdateRsvpResponse {
|
|
|
10033
10591
|
/** Updated RSVPs. */
|
|
10034
10592
|
rsvps?: Rsvp[];
|
|
10035
10593
|
}
|
|
10594
|
+
interface BulkUpdateRsvpContactIdRequest {
|
|
10595
|
+
/** Event ID. */
|
|
10596
|
+
eventId?: string | null;
|
|
10597
|
+
/** RSVPs to update. */
|
|
10598
|
+
rsvpId?: string[] | null;
|
|
10599
|
+
/** New RSVP contact ID. */
|
|
10600
|
+
contactId?: string | null;
|
|
10601
|
+
}
|
|
10602
|
+
interface BulkUpdateRsvpContactIdResponse {
|
|
10603
|
+
}
|
|
10036
10604
|
interface DeleteRsvpRequest {
|
|
10037
10605
|
/** Event ID to which RSVP belongs. */
|
|
10038
10606
|
eventId: string;
|
|
@@ -10079,13 +10647,13 @@ interface DeleteRsvpCheckInResponse {
|
|
|
10079
10647
|
/** Updated RSVP. */
|
|
10080
10648
|
rsvp?: Rsvp;
|
|
10081
10649
|
}
|
|
10082
|
-
interface
|
|
10650
|
+
interface FindRsvpSummaryRequest {
|
|
10083
10651
|
/** Event id. */
|
|
10084
10652
|
eventId?: string | null;
|
|
10085
10653
|
/** Consistent read. */
|
|
10086
10654
|
consistentRead?: boolean | null;
|
|
10087
10655
|
}
|
|
10088
|
-
interface
|
|
10656
|
+
interface FindRsvpSummaryResponse {
|
|
10089
10657
|
/** RSVP summary. */
|
|
10090
10658
|
rsvpSummary?: RsvpSummary$2;
|
|
10091
10659
|
}
|
|
@@ -10388,15 +10956,86 @@ interface DeleteRsvpCheckInOptions {
|
|
|
10388
10956
|
guestId?: number[];
|
|
10389
10957
|
}
|
|
10390
10958
|
|
|
10391
|
-
declare function listRsvp$1(httpClient: HttpClient):
|
|
10392
|
-
|
|
10393
|
-
|
|
10394
|
-
|
|
10395
|
-
|
|
10396
|
-
|
|
10397
|
-
|
|
10398
|
-
|
|
10399
|
-
declare function
|
|
10959
|
+
declare function listRsvp$1(httpClient: HttpClient): ListRsvpSignature;
|
|
10960
|
+
interface ListRsvpSignature {
|
|
10961
|
+
/**
|
|
10962
|
+
* Retrieves a list of up to 100 RSVPs.
|
|
10963
|
+
* @param - Optional fields.
|
|
10964
|
+
*/
|
|
10965
|
+
(options?: ListRsvpOptions | undefined): Promise<ListRsvpResponse & ListRsvpResponseNonNullableFields>;
|
|
10966
|
+
}
|
|
10967
|
+
declare function queryRsvp$1(httpClient: HttpClient): QueryRsvpSignature;
|
|
10968
|
+
interface QueryRsvpSignature {
|
|
10969
|
+
/**
|
|
10970
|
+
* Retrieves a list of up to 100 RSVPs.
|
|
10971
|
+
* @param - Optional fields.
|
|
10972
|
+
*/
|
|
10973
|
+
(options?: QueryRsvpOptions | undefined): Promise<QueryRsvpResponse & QueryRsvpResponseNonNullableFields>;
|
|
10974
|
+
}
|
|
10975
|
+
declare function getRsvp$1(httpClient: HttpClient): GetRsvpSignature;
|
|
10976
|
+
interface GetRsvpSignature {
|
|
10977
|
+
/**
|
|
10978
|
+
* Retrieves an RSVP.
|
|
10979
|
+
* @param - RSVP ID.
|
|
10980
|
+
* @param - Optional fields.
|
|
10981
|
+
* @returns RSVP.
|
|
10982
|
+
*/
|
|
10983
|
+
(rsvpId: string, options?: GetRsvpOptions | undefined): Promise<Rsvp & RsvpNonNullableFields>;
|
|
10984
|
+
}
|
|
10985
|
+
declare function createRsvp$1(httpClient: HttpClient): CreateRsvpSignature;
|
|
10986
|
+
interface CreateRsvpSignature {
|
|
10987
|
+
/**
|
|
10988
|
+
* Creates an RSVP, associated with a contact of the site.
|
|
10989
|
+
* @param - Optional fields.
|
|
10990
|
+
*/
|
|
10991
|
+
(options?: CreateRsvpOptions | undefined): Promise<CreateRsvpResponse & CreateRsvpResponseNonNullableFields>;
|
|
10992
|
+
}
|
|
10993
|
+
declare function updateRsvp$1(httpClient: HttpClient): UpdateRsvpSignature;
|
|
10994
|
+
interface UpdateRsvpSignature {
|
|
10995
|
+
/**
|
|
10996
|
+
* Updates an RSVP.
|
|
10997
|
+
* @param - RSVP ID.
|
|
10998
|
+
* @param - Event ID to which RSVP belongs.
|
|
10999
|
+
* @param - Optional fields.
|
|
11000
|
+
*/
|
|
11001
|
+
(rsvpId: string, eventId: string, options?: UpdateRsvpOptions | undefined): Promise<UpdateRsvpResponse & UpdateRsvpResponseNonNullableFields>;
|
|
11002
|
+
}
|
|
11003
|
+
declare function bulkUpdateRsvp$1(httpClient: HttpClient): BulkUpdateRsvpSignature;
|
|
11004
|
+
interface BulkUpdateRsvpSignature {
|
|
11005
|
+
/**
|
|
11006
|
+
* Updates statuses of multiple RSVPs.
|
|
11007
|
+
* @param - Event ID to which RSVP belongs.
|
|
11008
|
+
* @param - Optional fields.
|
|
11009
|
+
*/
|
|
11010
|
+
(eventId: string, options?: BulkUpdateRsvpOptions | undefined): Promise<BulkUpdateRsvpResponse & BulkUpdateRsvpResponseNonNullableFields>;
|
|
11011
|
+
}
|
|
11012
|
+
declare function deleteRsvp$1(httpClient: HttpClient): DeleteRsvpSignature;
|
|
11013
|
+
interface DeleteRsvpSignature {
|
|
11014
|
+
/**
|
|
11015
|
+
* Deletes an RSVP.
|
|
11016
|
+
* @param - Event ID to which RSVP belongs.
|
|
11017
|
+
* @param - Optional fields.
|
|
11018
|
+
*/
|
|
11019
|
+
(eventId: string, options?: DeleteRsvpOptions | undefined): Promise<void>;
|
|
11020
|
+
}
|
|
11021
|
+
declare function checkInRsvp$1(httpClient: HttpClient): CheckInRsvpSignature;
|
|
11022
|
+
interface CheckInRsvpSignature {
|
|
11023
|
+
/**
|
|
11024
|
+
* Checks-in an RSVP.
|
|
11025
|
+
* @param - Event ID to which RSVP belongs.
|
|
11026
|
+
* @param - Optional fields.
|
|
11027
|
+
*/
|
|
11028
|
+
(eventId: string, options?: CheckInRsvpOptions | undefined): Promise<CheckInRsvpResponse & CheckInRsvpResponseNonNullableFields>;
|
|
11029
|
+
}
|
|
11030
|
+
declare function deleteRsvpCheckIn$1(httpClient: HttpClient): DeleteRsvpCheckInSignature;
|
|
11031
|
+
interface DeleteRsvpCheckInSignature {
|
|
11032
|
+
/**
|
|
11033
|
+
* Deletes an RSVP check-in.
|
|
11034
|
+
* @param - Event ID to which RSVP belongs.
|
|
11035
|
+
* @param - Optional fields.
|
|
11036
|
+
*/
|
|
11037
|
+
(eventId: string, options?: DeleteRsvpCheckInOptions | undefined): Promise<DeleteRsvpCheckInResponse & DeleteRsvpCheckInResponseNonNullableFields>;
|
|
11038
|
+
}
|
|
10400
11039
|
declare const onRsvpCreated$1: EventDefinition<RsvpCreatedEnvelope, "wix.events.rsvp.events.RsvpCreated">;
|
|
10401
11040
|
declare const onRsvpUpdated$1: EventDefinition<RsvpUpdatedEnvelope, "wix.events.rsvp.events.RsvpUpdated">;
|
|
10402
11041
|
declare const onRsvpDeleted$1: EventDefinition<RsvpDeletedEnvelope, "wix.events.rsvp.events.RsvpDeleted">;
|
|
@@ -10425,14 +11064,19 @@ type _publicDeleteRsvpCheckInType = typeof deleteRsvpCheckIn$1;
|
|
|
10425
11064
|
declare const deleteRsvpCheckIn: ReturnType<typeof createRESTModule$5<_publicDeleteRsvpCheckInType>>;
|
|
10426
11065
|
|
|
10427
11066
|
type _publicOnRsvpCreatedType = typeof onRsvpCreated$1;
|
|
11067
|
+
/** */
|
|
10428
11068
|
declare const onRsvpCreated: ReturnType<typeof createEventModule$5<_publicOnRsvpCreatedType>>;
|
|
10429
11069
|
|
|
10430
11070
|
type _publicOnRsvpUpdatedType = typeof onRsvpUpdated$1;
|
|
11071
|
+
/** */
|
|
10431
11072
|
declare const onRsvpUpdated: ReturnType<typeof createEventModule$5<_publicOnRsvpUpdatedType>>;
|
|
10432
11073
|
|
|
10433
11074
|
type _publicOnRsvpDeletedType = typeof onRsvpDeleted$1;
|
|
11075
|
+
/** */
|
|
10434
11076
|
declare const onRsvpDeleted: ReturnType<typeof createEventModule$5<_publicOnRsvpDeletedType>>;
|
|
10435
11077
|
|
|
11078
|
+
type index_d$5_BulkUpdateRsvpContactIdRequest = BulkUpdateRsvpContactIdRequest;
|
|
11079
|
+
type index_d$5_BulkUpdateRsvpContactIdResponse = BulkUpdateRsvpContactIdResponse;
|
|
10436
11080
|
type index_d$5_BulkUpdateRsvpOptions = BulkUpdateRsvpOptions;
|
|
10437
11081
|
type index_d$5_BulkUpdateRsvpRequest = BulkUpdateRsvpRequest;
|
|
10438
11082
|
type index_d$5_BulkUpdateRsvpResponse = BulkUpdateRsvpResponse;
|
|
@@ -10452,12 +11096,12 @@ type index_d$5_DeleteRsvpCheckInResponseNonNullableFields = DeleteRsvpCheckInRes
|
|
|
10452
11096
|
type index_d$5_DeleteRsvpOptions = DeleteRsvpOptions;
|
|
10453
11097
|
type index_d$5_DeleteRsvpRequest = DeleteRsvpRequest;
|
|
10454
11098
|
type index_d$5_DeleteRsvpResponse = DeleteRsvpResponse;
|
|
11099
|
+
type index_d$5_FindRsvpSummaryRequest = FindRsvpSummaryRequest;
|
|
11100
|
+
type index_d$5_FindRsvpSummaryResponse = FindRsvpSummaryResponse;
|
|
10455
11101
|
type index_d$5_GetRsvpOptions = GetRsvpOptions;
|
|
10456
11102
|
type index_d$5_GetRsvpRequest = GetRsvpRequest;
|
|
10457
11103
|
type index_d$5_GetRsvpResponse = GetRsvpResponse;
|
|
10458
11104
|
type index_d$5_GetRsvpResponseNonNullableFields = GetRsvpResponseNonNullableFields;
|
|
10459
|
-
type index_d$5_GetRsvpSummaryRequest = GetRsvpSummaryRequest;
|
|
10460
|
-
type index_d$5_GetRsvpSummaryResponse = GetRsvpSummaryResponse;
|
|
10461
11105
|
type index_d$5_Guest = Guest;
|
|
10462
11106
|
type index_d$5_ListRsvpOptions = ListRsvpOptions;
|
|
10463
11107
|
type index_d$5_ListRsvpRequest = ListRsvpRequest;
|
|
@@ -10513,7 +11157,7 @@ declare const index_d$5_onRsvpUpdated: typeof onRsvpUpdated;
|
|
|
10513
11157
|
declare const index_d$5_queryRsvp: typeof queryRsvp;
|
|
10514
11158
|
declare const index_d$5_updateRsvp: typeof updateRsvp;
|
|
10515
11159
|
declare namespace index_d$5 {
|
|
10516
|
-
export { type Address$4 as Address, type AddressLocation$4 as AddressLocation, type AddressStreetOneOf$4 as AddressStreetOneOf, type BaseEventMetadata$5 as BaseEventMetadata, type index_d$5_BulkUpdateRsvpOptions as BulkUpdateRsvpOptions, type index_d$5_BulkUpdateRsvpRequest as BulkUpdateRsvpRequest, type index_d$5_BulkUpdateRsvpResponse as BulkUpdateRsvpResponse, type index_d$5_BulkUpdateRsvpResponseNonNullableFields as BulkUpdateRsvpResponseNonNullableFields, type CalendarLinks$2 as CalendarLinks, type CheckIn$1 as CheckIn, type index_d$5_CheckInRsvpOptions as CheckInRsvpOptions, type index_d$5_CheckInRsvpRequest as CheckInRsvpRequest, type index_d$5_CheckInRsvpResponse as CheckInRsvpResponse, type index_d$5_CheckInRsvpResponseNonNullableFields as CheckInRsvpResponseNonNullableFields, type Counts$1 as Counts, type index_d$5_CreateRsvpOptions as CreateRsvpOptions, type index_d$5_CreateRsvpRequest as CreateRsvpRequest, type index_d$5_CreateRsvpResponse as CreateRsvpResponse, type index_d$5_CreateRsvpResponseNonNullableFields as CreateRsvpResponseNonNullableFields, type index_d$5_DeleteRsvpCheckInOptions as DeleteRsvpCheckInOptions, type index_d$5_DeleteRsvpCheckInRequest as DeleteRsvpCheckInRequest, type index_d$5_DeleteRsvpCheckInResponse as DeleteRsvpCheckInResponse, type index_d$5_DeleteRsvpCheckInResponseNonNullableFields as DeleteRsvpCheckInResponseNonNullableFields, type index_d$5_DeleteRsvpOptions as DeleteRsvpOptions, type index_d$5_DeleteRsvpRequest as DeleteRsvpRequest, type index_d$5_DeleteRsvpResponse as DeleteRsvpResponse, type FacetCounts$4 as FacetCounts, type
|
|
11160
|
+
export { type Address$4 as Address, type AddressLocation$4 as AddressLocation, type AddressStreetOneOf$4 as AddressStreetOneOf, type BaseEventMetadata$5 as BaseEventMetadata, type index_d$5_BulkUpdateRsvpContactIdRequest as BulkUpdateRsvpContactIdRequest, type index_d$5_BulkUpdateRsvpContactIdResponse as BulkUpdateRsvpContactIdResponse, type index_d$5_BulkUpdateRsvpOptions as BulkUpdateRsvpOptions, type index_d$5_BulkUpdateRsvpRequest as BulkUpdateRsvpRequest, type index_d$5_BulkUpdateRsvpResponse as BulkUpdateRsvpResponse, type index_d$5_BulkUpdateRsvpResponseNonNullableFields as BulkUpdateRsvpResponseNonNullableFields, type CalendarLinks$2 as CalendarLinks, type CheckIn$1 as CheckIn, type index_d$5_CheckInRsvpOptions as CheckInRsvpOptions, type index_d$5_CheckInRsvpRequest as CheckInRsvpRequest, type index_d$5_CheckInRsvpResponse as CheckInRsvpResponse, type index_d$5_CheckInRsvpResponseNonNullableFields as CheckInRsvpResponseNonNullableFields, type Counts$1 as Counts, type index_d$5_CreateRsvpOptions as CreateRsvpOptions, type index_d$5_CreateRsvpRequest as CreateRsvpRequest, type index_d$5_CreateRsvpResponse as CreateRsvpResponse, type index_d$5_CreateRsvpResponseNonNullableFields as CreateRsvpResponseNonNullableFields, type index_d$5_DeleteRsvpCheckInOptions as DeleteRsvpCheckInOptions, type index_d$5_DeleteRsvpCheckInRequest as DeleteRsvpCheckInRequest, type index_d$5_DeleteRsvpCheckInResponse as DeleteRsvpCheckInResponse, type index_d$5_DeleteRsvpCheckInResponseNonNullableFields as DeleteRsvpCheckInResponseNonNullableFields, type index_d$5_DeleteRsvpOptions as DeleteRsvpOptions, type index_d$5_DeleteRsvpRequest as DeleteRsvpRequest, type index_d$5_DeleteRsvpResponse as DeleteRsvpResponse, type FacetCounts$4 as FacetCounts, type index_d$5_FindRsvpSummaryRequest as FindRsvpSummaryRequest, type index_d$5_FindRsvpSummaryResponse as FindRsvpSummaryResponse, type FormResponse$1 as FormResponse, type FormattedAddress$1 as FormattedAddress, type index_d$5_GetRsvpOptions as GetRsvpOptions, type index_d$5_GetRsvpRequest as GetRsvpRequest, type index_d$5_GetRsvpResponse as GetRsvpResponse, type index_d$5_GetRsvpResponseNonNullableFields as GetRsvpResponseNonNullableFields, type index_d$5_Guest as Guest, type IdentificationData$5 as IdentificationData, type IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf, type InputValue$1 as InputValue, type index_d$5_ListRsvpOptions as ListRsvpOptions, type index_d$5_ListRsvpRequest as ListRsvpRequest, type index_d$5_ListRsvpResponse as ListRsvpResponse, type index_d$5_ListRsvpResponseNonNullableFields as ListRsvpResponseNonNullableFields, type MessageEnvelope$5 as MessageEnvelope, type index_d$5_ModificationOptions as ModificationOptions, type OnlineConferencingLogin$1 as OnlineConferencingLogin, type index_d$5_QueryRsvpOptions as QueryRsvpOptions, type index_d$5_QueryRsvpRequest as QueryRsvpRequest, type index_d$5_QueryRsvpResponse as QueryRsvpResponse, type index_d$5_QueryRsvpResponseNonNullableFields as QueryRsvpResponseNonNullableFields, type index_d$5_Rsvp as Rsvp, type index_d$5_RsvpCreated as RsvpCreated, type index_d$5_RsvpCreatedEnvelope as RsvpCreatedEnvelope, type index_d$5_RsvpDeleted as RsvpDeleted, type index_d$5_RsvpDeletedEnvelope as RsvpDeletedEnvelope, type index_d$5_RsvpFacetCounts as RsvpFacetCounts, type index_d$5_RsvpFacets as RsvpFacets, index_d$5_RsvpFieldset as RsvpFieldset, type index_d$5_RsvpNonNullableFields as RsvpNonNullableFields, index_d$5_RsvpStatus as RsvpStatus, type RsvpSummary$2 as RsvpSummary, index_d$5_RsvpTag as RsvpTag, type index_d$5_RsvpUpdated as RsvpUpdated, type index_d$5_RsvpUpdatedEnvelope as RsvpUpdatedEnvelope, type StandardDetails$1 as StandardDetails, type StreetAddress$4 as StreetAddress, type Subdivision$4 as Subdivision, SubdivisionType$4 as SubdivisionType, type index_d$5_UpdateRsvpOptions as UpdateRsvpOptions, type index_d$5_UpdateRsvpRequest as UpdateRsvpRequest, type index_d$5_UpdateRsvpResponse as UpdateRsvpResponse, type index_d$5_UpdateRsvpResponseNonNullableFields as UpdateRsvpResponseNonNullableFields, WebhookIdentityType$5 as WebhookIdentityType, type index_d$5__publicBulkUpdateRsvpType as _publicBulkUpdateRsvpType, type index_d$5__publicCheckInRsvpType as _publicCheckInRsvpType, type index_d$5__publicCreateRsvpType as _publicCreateRsvpType, type index_d$5__publicDeleteRsvpCheckInType as _publicDeleteRsvpCheckInType, type index_d$5__publicDeleteRsvpType as _publicDeleteRsvpType, type index_d$5__publicGetRsvpType as _publicGetRsvpType, type index_d$5__publicListRsvpType as _publicListRsvpType, type index_d$5__publicOnRsvpCreatedType as _publicOnRsvpCreatedType, type index_d$5__publicOnRsvpDeletedType as _publicOnRsvpDeletedType, type index_d$5__publicOnRsvpUpdatedType as _publicOnRsvpUpdatedType, type index_d$5__publicQueryRsvpType as _publicQueryRsvpType, type index_d$5__publicUpdateRsvpType as _publicUpdateRsvpType, index_d$5_bulkUpdateRsvp as bulkUpdateRsvp, index_d$5_checkInRsvp as checkInRsvp, index_d$5_createRsvp as createRsvp, index_d$5_deleteRsvp as deleteRsvp, index_d$5_deleteRsvpCheckIn as deleteRsvpCheckIn, index_d$5_getRsvp as getRsvp, index_d$5_listRsvp as listRsvp, index_d$5_onRsvpCreated as onRsvpCreated, index_d$5_onRsvpDeleted as onRsvpDeleted, index_d$5_onRsvpUpdated as onRsvpUpdated, onRsvpCreated$1 as publicOnRsvpCreated, onRsvpDeleted$1 as publicOnRsvpDeleted, onRsvpUpdated$1 as publicOnRsvpUpdated, index_d$5_queryRsvp as queryRsvp, index_d$5_updateRsvp as updateRsvp };
|
|
10517
11161
|
}
|
|
10518
11162
|
|
|
10519
11163
|
interface TicketingTicket {
|
|
@@ -11261,12 +11905,65 @@ interface BulkUpdateTicketsOptions {
|
|
|
11261
11905
|
archived?: boolean;
|
|
11262
11906
|
}
|
|
11263
11907
|
|
|
11264
|
-
declare function listTickets$1(httpClient: HttpClient):
|
|
11265
|
-
|
|
11266
|
-
|
|
11267
|
-
|
|
11268
|
-
|
|
11269
|
-
|
|
11908
|
+
declare function listTickets$1(httpClient: HttpClient): ListTicketsSignature;
|
|
11909
|
+
interface ListTicketsSignature {
|
|
11910
|
+
/**
|
|
11911
|
+
* Retrieves a list of up to 100 tickets.
|
|
11912
|
+
*
|
|
11913
|
+
* <!--
|
|
11914
|
+
* >**Note:** This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
11915
|
+
* -->
|
|
11916
|
+
* @param - Event IDs.
|
|
11917
|
+
* @param - Options for defining the returned list of tickets.
|
|
11918
|
+
*/
|
|
11919
|
+
(eventId: string[], options?: ListTicketsOptions | undefined): Promise<ListTicketsResponse & ListTicketsResponseNonNullableFields>;
|
|
11920
|
+
}
|
|
11921
|
+
declare function getTicket$1(httpClient: HttpClient): GetTicketSignature;
|
|
11922
|
+
interface GetTicketSignature {
|
|
11923
|
+
/**
|
|
11924
|
+
* Retrieves a ticket by the unique ticket number.
|
|
11925
|
+
* @param - Details for the ticket to retrieve.
|
|
11926
|
+
* @param - Options for the returned ticket data.
|
|
11927
|
+
* @returns Ticket.
|
|
11928
|
+
*/
|
|
11929
|
+
(identifiers: GetTicketIdentifiers, options?: GetTicketOptions | undefined): Promise<TicketingTicket & TicketingTicketNonNullableFields>;
|
|
11930
|
+
}
|
|
11931
|
+
declare function checkInTickets$1(httpClient: HttpClient): CheckInTicketsSignature;
|
|
11932
|
+
interface CheckInTicketsSignature {
|
|
11933
|
+
/**
|
|
11934
|
+
* Checks in 1 or more tickets.
|
|
11935
|
+
* @param - Event ID to which the ticket belongs.
|
|
11936
|
+
* @param - Options for tickets to check-in.
|
|
11937
|
+
*/
|
|
11938
|
+
(eventId: string, options?: CheckInTicketsOptions | undefined): Promise<CheckInTicketResponse & CheckInTicketResponseNonNullableFields>;
|
|
11939
|
+
}
|
|
11940
|
+
declare function deleteTicketCheckIns$1(httpClient: HttpClient): DeleteTicketCheckInsSignature;
|
|
11941
|
+
interface DeleteTicketCheckInsSignature {
|
|
11942
|
+
/**
|
|
11943
|
+
* Deletes check-ins for 1 or more tickets.
|
|
11944
|
+
* @param - Event ID to which the ticket belongs.
|
|
11945
|
+
* @param - Options for tickets to delete.
|
|
11946
|
+
*/
|
|
11947
|
+
(eventId: string, options?: DeleteTicketCheckInsOptions | undefined): Promise<DeleteTicketCheckInResponse & DeleteTicketCheckInResponseNonNullableFields>;
|
|
11948
|
+
}
|
|
11949
|
+
declare function updateTicket$1(httpClient: HttpClient): UpdateTicketSignature;
|
|
11950
|
+
interface UpdateTicketSignature {
|
|
11951
|
+
/**
|
|
11952
|
+
* Updates a ticket.
|
|
11953
|
+
* @param - Details for the ticket to update.
|
|
11954
|
+
* @param - Ticket details to update.
|
|
11955
|
+
*/
|
|
11956
|
+
(identifiers: UpdateTicketIdentifiers, options?: UpdateTicketOptions | undefined): Promise<UpdateTicketResponse & UpdateTicketResponseNonNullableFields>;
|
|
11957
|
+
}
|
|
11958
|
+
declare function bulkUpdateTickets$1(httpClient: HttpClient): BulkUpdateTicketsSignature;
|
|
11959
|
+
interface BulkUpdateTicketsSignature {
|
|
11960
|
+
/**
|
|
11961
|
+
* Archives multiple tickets.
|
|
11962
|
+
* @param - Options for updating the tickets.
|
|
11963
|
+
* @param - Event ID to which the ticket belongs.
|
|
11964
|
+
*/
|
|
11965
|
+
(eventId: string, options?: BulkUpdateTicketsOptions | undefined): Promise<BulkUpdateTicketsResponse & BulkUpdateTicketsResponseNonNullableFields>;
|
|
11966
|
+
}
|
|
11270
11967
|
declare const onTicketOrderUpdated$1: EventDefinition<TicketOrderUpdatedEnvelope, "wix.events.ticketing.events.OrderUpdated">;
|
|
11271
11968
|
|
|
11272
11969
|
declare function createRESTModule$4<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
@@ -11287,6 +11984,7 @@ type _publicBulkUpdateTicketsType = typeof bulkUpdateTickets$1;
|
|
|
11287
11984
|
declare const bulkUpdateTickets: ReturnType<typeof createRESTModule$4<_publicBulkUpdateTicketsType>>;
|
|
11288
11985
|
|
|
11289
11986
|
type _publicOnTicketOrderUpdatedType = typeof onTicketOrderUpdated$1;
|
|
11987
|
+
/** */
|
|
11290
11988
|
declare const onTicketOrderUpdated: ReturnType<typeof createEventModule$4<_publicOnTicketOrderUpdatedType>>;
|
|
11291
11989
|
|
|
11292
11990
|
type index_d$4_BulkUpdateTicketsOptions = BulkUpdateTicketsOptions;
|
|
@@ -12112,14 +12810,165 @@ interface ChangeCurrencyOptions$1 {
|
|
|
12112
12810
|
currency: string;
|
|
12113
12811
|
}
|
|
12114
12812
|
|
|
12115
|
-
declare function queryTicketDefinitions$3(httpClient: HttpClient):
|
|
12116
|
-
|
|
12117
|
-
|
|
12118
|
-
|
|
12119
|
-
|
|
12120
|
-
|
|
12121
|
-
|
|
12122
|
-
|
|
12813
|
+
declare function queryTicketDefinitions$3(httpClient: HttpClient): QueryTicketDefinitionsSignature$1;
|
|
12814
|
+
interface QueryTicketDefinitionsSignature$1 {
|
|
12815
|
+
/**
|
|
12816
|
+
* **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use [`queryTicketDefinitions()`](/ticket-definitions-v2/query-ticket-definitions) function instead.
|
|
12817
|
+
* >**Migration Instructions**.
|
|
12818
|
+
* > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`queryTicketDefinition()`](/ticket-definitions-v2/query-ticket-definitions).
|
|
12819
|
+
* > To migrate to the new function:
|
|
12820
|
+
* > 1. Add the new import statement:
|
|
12821
|
+
* > ```js
|
|
12822
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
12823
|
+
* > ```
|
|
12824
|
+
* > 2. Look for any code that uses `ticketDefinitions.queryTicketDefinition()`, and replace it with `ticketDefinitionsV2.queryTicketDefinition()`. Update your code to work with the new `createTicketDefinition()` response properties.
|
|
12825
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
12826
|
+
*
|
|
12827
|
+
* Retrieves a list of up to 100 ticket definitions.
|
|
12828
|
+
*/
|
|
12829
|
+
(options?: QueryTicketDefinitionsOptions$1 | undefined): Promise<QueryTicketDefinitionsResponse$1 & QueryTicketDefinitionsResponseNonNullableFields$1>;
|
|
12830
|
+
}
|
|
12831
|
+
declare function queryTicketDefinitionsV2$1(httpClient: HttpClient): QueryTicketDefinitionsV2Signature;
|
|
12832
|
+
interface QueryTicketDefinitionsV2Signature {
|
|
12833
|
+
/**
|
|
12834
|
+
* **Deprecated.** This function will continue to work until October 29, 2024, but a newer version is available at [`queryTicketDefinitions()`](/ticket-definitions-v2/query-ticket-definitions).
|
|
12835
|
+
* >**Migration Instructions**.
|
|
12836
|
+
* > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`queryTicketDefinitions()`](/ticket-definitions-v2/query-ticket-definitions).
|
|
12837
|
+
* > To migrate to the new function:
|
|
12838
|
+
* > 1. Add the new import statement:
|
|
12839
|
+
* > ```js
|
|
12840
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
12841
|
+
* > ```
|
|
12842
|
+
* > 2. Look for any code that uses `ticketDefinitions.queryTicketDefinitions()`, and replace it with `ticketDefinitionsV2.queryTicketDefinitions()`. Update your code to work with the new `queryTicketDefinition()` response properties.
|
|
12843
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
12844
|
+
*
|
|
12845
|
+
* Retrieves a list of up to 1,000 ticket definitions, given the provided paging and filtering.
|
|
12846
|
+
*/
|
|
12847
|
+
(options?: QueryTicketDefinitionsV2Options | undefined): DefinitionsQueryBuilder;
|
|
12848
|
+
}
|
|
12849
|
+
declare function listTicketDefinitions$1(httpClient: HttpClient): ListTicketDefinitionsSignature;
|
|
12850
|
+
interface ListTicketDefinitionsSignature {
|
|
12851
|
+
/**
|
|
12852
|
+
* **Deprecated.** This function will continue to work until November 8, 2024, but a substitute is available. Use the [`queryTicketDefinitions()`](/ticket-definitions-v2/query-ticket-definitions) function instead.
|
|
12853
|
+
* >**Migration Instructions**.
|
|
12854
|
+
* > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`queryTicketDefinitions()`](/ticket-definitions-v2/query-ticket-definitions).
|
|
12855
|
+
* > To migrate to the new function:
|
|
12856
|
+
* > 1. Add the new import statement:
|
|
12857
|
+
* > ```js
|
|
12858
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
12859
|
+
* > ```
|
|
12860
|
+
* > 2. Look for any code that uses `ticketDefinitions.queryTicketDefinitions()`, and replace it with `ticketDefinitionsV2.queryTicketDefinitions()`. Update your code to work with the new `queryTicketDefinition()` response properties.
|
|
12861
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
12862
|
+
*
|
|
12863
|
+
* Retrieves a list of up to 100 ticket definitions, with basic filter support.
|
|
12864
|
+
* @param - Details for the tickets to retrieve.
|
|
12865
|
+
*/
|
|
12866
|
+
(options?: ListTicketDefinitionsOptions | undefined): Promise<ListTicketDefinitionsResponse & ListTicketDefinitionsResponseNonNullableFields>;
|
|
12867
|
+
}
|
|
12868
|
+
declare function getTicketDefinition$3(httpClient: HttpClient): GetTicketDefinitionSignature$1;
|
|
12869
|
+
interface GetTicketDefinitionSignature$1 {
|
|
12870
|
+
/**
|
|
12871
|
+
* **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`getTicketDefinition()`](/ticket-definitions-v2/get-ticket-definition) function instead.
|
|
12872
|
+
* >**Migration Instructions**.
|
|
12873
|
+
* > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`getTicketDefinition()`](/ticket-definitions-v2/get-ticket-definition).
|
|
12874
|
+
* > To migrate to the new function:
|
|
12875
|
+
* > 1. Add the new import statement:
|
|
12876
|
+
* > ```js
|
|
12877
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
12878
|
+
* > ```
|
|
12879
|
+
* > 2. Look for any code that uses `ticketDefinitions.getTicketDefinition()`, and replace it with `ticketDefinitionsV2.getTicketDefinition()`. Update your code to work with the new `getTicketDefinition()` response properties.
|
|
12880
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
12881
|
+
*
|
|
12882
|
+
* Retrieves a ticket definition.
|
|
12883
|
+
* @param - Ticket definition ID.
|
|
12884
|
+
* @param - Details for the ticket to retrieve.
|
|
12885
|
+
* @returns Retrieved ticket definition.
|
|
12886
|
+
*/
|
|
12887
|
+
(definitionId: string, options?: GetTicketDefinitionOptions$1 | undefined): Promise<TicketDefinition$1 & TicketDefinitionNonNullableFields$1>;
|
|
12888
|
+
}
|
|
12889
|
+
declare function createTicketDefinition$3(httpClient: HttpClient): CreateTicketDefinitionSignature$1;
|
|
12890
|
+
interface CreateTicketDefinitionSignature$1 {
|
|
12891
|
+
/**
|
|
12892
|
+
* **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`createTicketDefinition()`](/ticket-definitions-v2/create-ticket-definition) function instead.
|
|
12893
|
+
* >**Migration Instructions**.
|
|
12894
|
+
* > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`createTicketDefinition()`](/ticket-definitions-v2/create-ticket-definition).
|
|
12895
|
+
* > To migrate to the new function:
|
|
12896
|
+
* > 1. Add the new import statement:
|
|
12897
|
+
* > ```js
|
|
12898
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
12899
|
+
* > ```
|
|
12900
|
+
* > 2. Look for any code that uses `ticketDefinitions.createTicketDefinition()`, and replace it with `ticketDefinitionsV2.createTicketDefinition()`. Update your code to work with the new `createTicketDefinition()` response properties.
|
|
12901
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
12902
|
+
*
|
|
12903
|
+
* Creates a ticket definition (and enables ticket sales).
|
|
12904
|
+
* @param - Event ID.
|
|
12905
|
+
*/
|
|
12906
|
+
(eventId: string, options: CreateTicketDefinitionOptions$1): Promise<CreateTicketDefinitionResponse$1 & CreateTicketDefinitionResponseNonNullableFields$1>;
|
|
12907
|
+
}
|
|
12908
|
+
declare function updateTicketDefinition$3(httpClient: HttpClient): UpdateTicketDefinitionSignature$1;
|
|
12909
|
+
interface UpdateTicketDefinitionSignature$1 {
|
|
12910
|
+
/**
|
|
12911
|
+
* **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`updateTicketDefinition()`](/ticket-definitions-v2/update-ticket-definition) function instead.
|
|
12912
|
+
* >**Migration Instructions**.
|
|
12913
|
+
* > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`updateTicketDefinition()`](/ticket-definitions-v2/update-ticket-definition).
|
|
12914
|
+
* > To migrate to the new function:
|
|
12915
|
+
* > 1. Add the new import statement:
|
|
12916
|
+
* > ```js
|
|
12917
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
12918
|
+
* > ```
|
|
12919
|
+
* > 2. Look for any code that uses `ticketDefinitions.updateTicketDefinition()`, and replace it with `ticketDefinitionsV2.updateTicketDefinition()`. Update your code to work with the new `updateTicketDefinition()` response properties.
|
|
12920
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
12921
|
+
*
|
|
12922
|
+
*
|
|
12923
|
+
* Updates a ticket definition.
|
|
12924
|
+
*
|
|
12925
|
+
* See [Partial Updates](/wix-events-v2/partial-updates) for more information.
|
|
12926
|
+
* @param - Ticket definition ID.
|
|
12927
|
+
* @param - Event ID.
|
|
12928
|
+
* @param - Details of the ticket definition to update.
|
|
12929
|
+
* @param - Ticket definition details to update.
|
|
12930
|
+
*/
|
|
12931
|
+
(definitionId: string, eventId: string, options?: UpdateTicketDefinitionOptions$1 | undefined): Promise<UpdateTicketDefinitionResponse$1 & UpdateTicketDefinitionResponseNonNullableFields$1>;
|
|
12932
|
+
}
|
|
12933
|
+
declare function deleteTicketDefinition$3(httpClient: HttpClient): DeleteTicketDefinitionSignature$1;
|
|
12934
|
+
interface DeleteTicketDefinitionSignature$1 {
|
|
12935
|
+
/**
|
|
12936
|
+
* **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`deleteTicketDefinition()`](/ticket-definitions-v2/delete-ticket-definition) function instead.
|
|
12937
|
+
* >**Migration Instructions**.
|
|
12938
|
+
* > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`deleteTicketDefinition()`](/ticket-definitions-v2/delete-ticket-definition).
|
|
12939
|
+
* > To migrate to the new function:
|
|
12940
|
+
* > 1. Add the new import statement:
|
|
12941
|
+
* > ```js
|
|
12942
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
12943
|
+
* > ```
|
|
12944
|
+
* > 2. Look for any code that uses `ticketDefinitions.deleteTicketDefinition()`, and replace it with `ticketDefinitionsV2.deleteTicketDefinition()`. Update your code to work with the new `deleteTicketDefinition()` response properties.
|
|
12945
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
12946
|
+
*
|
|
12947
|
+
* Deletes a ticket definition.
|
|
12948
|
+
* @param - Event ID.
|
|
12949
|
+
* @param - Details of tickets to delete.
|
|
12950
|
+
*/
|
|
12951
|
+
(eventId: string, options?: DeleteTicketDefinitionOptions | undefined): Promise<void>;
|
|
12952
|
+
}
|
|
12953
|
+
declare function changeCurrency$3(httpClient: HttpClient): ChangeCurrencySignature$1;
|
|
12954
|
+
interface ChangeCurrencySignature$1 {
|
|
12955
|
+
/**
|
|
12956
|
+
* **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available at [`changeCurrency()`](/ticket-definitions-v2/change-currency).
|
|
12957
|
+
* >**Migration Instructions**.
|
|
12958
|
+
* > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`changeCurrency()`](/ticket-definitions-v2/change-currency).
|
|
12959
|
+
* > To migrate to the new function:
|
|
12960
|
+
* > 1. Add the new import statement:
|
|
12961
|
+
* > ```js
|
|
12962
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
12963
|
+
* > ```
|
|
12964
|
+
* > 2. Look for any code that uses `ticketDefinitions.changeCurrency()`, and replace it with `ticketDefinitionsV2.changeCurrency()`. Update your code to work with the new `changeCurrency()` response properties.
|
|
12965
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
12966
|
+
*
|
|
12967
|
+
* Changes the currency for all tickets per event.
|
|
12968
|
+
*
|
|
12969
|
+
*/
|
|
12970
|
+
(options?: ChangeCurrencyOptions$1 | undefined): Promise<void>;
|
|
12971
|
+
}
|
|
12123
12972
|
declare const onTicketDefinitionCreated$3: EventDefinition<TicketDefinitionCreatedEnvelope$1, "wix.events.ticketing.events.TicketDefinitionCreated">;
|
|
12124
12973
|
declare const onTicketDefinitionUpdated$3: EventDefinition<TicketDefinitionUpdatedEnvelope$1, "wix.events.ticketing.events.TicketDefinitionUpdated">;
|
|
12125
12974
|
declare const onTicketDefinitionDeleted$3: EventDefinition<TicketDefinitionDeletedEnvelope$1, "wix.events.ticketing.events.TicketDefinitionDeleted">;
|
|
@@ -12146,12 +12995,15 @@ type _publicChangeCurrencyType$1 = typeof changeCurrency$3;
|
|
|
12146
12995
|
declare const changeCurrency$2: ReturnType<typeof createRESTModule$3<_publicChangeCurrencyType>>;
|
|
12147
12996
|
|
|
12148
12997
|
type _publicOnTicketDefinitionCreatedType$1 = typeof onTicketDefinitionCreated$3;
|
|
12998
|
+
/** */
|
|
12149
12999
|
declare const onTicketDefinitionCreated$2: ReturnType<typeof createEventModule$3<_publicOnTicketDefinitionCreatedType>>;
|
|
12150
13000
|
|
|
12151
13001
|
type _publicOnTicketDefinitionUpdatedType$1 = typeof onTicketDefinitionUpdated$3;
|
|
13002
|
+
/** */
|
|
12152
13003
|
declare const onTicketDefinitionUpdated$2: ReturnType<typeof createEventModule$3<_publicOnTicketDefinitionUpdatedType>>;
|
|
12153
13004
|
|
|
12154
13005
|
type _publicOnTicketDefinitionDeletedType$1 = typeof onTicketDefinitionDeleted$3;
|
|
13006
|
+
/** */
|
|
12155
13007
|
declare const onTicketDefinitionDeleted$2: ReturnType<typeof createEventModule$3<_publicOnTicketDefinitionDeletedType>>;
|
|
12156
13008
|
|
|
12157
13009
|
type index_d$3_ById = ById;
|
|
@@ -12861,12 +13713,114 @@ interface ReorderEventPoliciesOptions extends ReorderEventPoliciesRequestReferen
|
|
|
12861
13713
|
afterPolicyId?: string;
|
|
12862
13714
|
}
|
|
12863
13715
|
|
|
12864
|
-
declare function createPolicy$1(httpClient: HttpClient):
|
|
12865
|
-
|
|
12866
|
-
|
|
12867
|
-
|
|
12868
|
-
|
|
12869
|
-
|
|
13716
|
+
declare function createPolicy$1(httpClient: HttpClient): CreatePolicySignature;
|
|
13717
|
+
interface CreatePolicySignature {
|
|
13718
|
+
/**
|
|
13719
|
+
* Creates a policy.
|
|
13720
|
+
*
|
|
13721
|
+
*
|
|
13722
|
+
* <!--
|
|
13723
|
+
* > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
13724
|
+
* -->
|
|
13725
|
+
*
|
|
13726
|
+
* The `createPolicy()` function returns a Promise that resolves to the newly-created policy.
|
|
13727
|
+
*
|
|
13728
|
+
* You can create up to 3 policies per event. If you try to create more than 3, you'll get the "Maximum number of policies for the event has been reached" error.
|
|
13729
|
+
* @param - Policy info.
|
|
13730
|
+
* @returns Created policy.
|
|
13731
|
+
*/
|
|
13732
|
+
(policy: Policy): Promise<Policy & PolicyNonNullableFields>;
|
|
13733
|
+
}
|
|
13734
|
+
declare function updatePolicy$1(httpClient: HttpClient): UpdatePolicySignature;
|
|
13735
|
+
interface UpdatePolicySignature {
|
|
13736
|
+
/**
|
|
13737
|
+
* Updates a policy.
|
|
13738
|
+
*
|
|
13739
|
+
* <!--
|
|
13740
|
+
* > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
13741
|
+
* -->
|
|
13742
|
+
*
|
|
13743
|
+
* The `updatePolicy()` function returns a Promise that resolves to the newly-updated policy.
|
|
13744
|
+
*
|
|
13745
|
+
* Each time the policy is updated, `revision` increments by 1. The existing `revision` must be included when updating the policy. This ensures you're working with the latest policy and prevents unintended overwrites.
|
|
13746
|
+
* @param - Policy to update.
|
|
13747
|
+
* @param - Policy ID.
|
|
13748
|
+
* @returns The updated policy.
|
|
13749
|
+
*/
|
|
13750
|
+
(_id: string | null, policy: UpdatePolicy): Promise<Policy & PolicyNonNullableFields>;
|
|
13751
|
+
}
|
|
13752
|
+
declare function deletePolicy$1(httpClient: HttpClient): DeletePolicySignature;
|
|
13753
|
+
interface DeletePolicySignature {
|
|
13754
|
+
/**
|
|
13755
|
+
* Permanently deletes a policy.
|
|
13756
|
+
*
|
|
13757
|
+
*
|
|
13758
|
+
* <!--
|
|
13759
|
+
* > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
13760
|
+
* -->
|
|
13761
|
+
*
|
|
13762
|
+
* The `deletePolicy()` function returns a Promise that resolves when the specified policy is deleted.
|
|
13763
|
+
*
|
|
13764
|
+
* Deleted policies are not returned by the `getPolicy()` or `queryPolicies()` functions.
|
|
13765
|
+
* @param - Options for Delete Policy function.
|
|
13766
|
+
* @param - ID of the policy to delete.
|
|
13767
|
+
*/
|
|
13768
|
+
(policyId: string): Promise<void>;
|
|
13769
|
+
}
|
|
13770
|
+
declare function queryPolicies$1(httpClient: HttpClient): QueryPoliciesSignature;
|
|
13771
|
+
interface QueryPoliciesSignature {
|
|
13772
|
+
/**
|
|
13773
|
+
* Creates a query to retrieve a list of policies, given the provided paging and filter.
|
|
13774
|
+
*
|
|
13775
|
+
*
|
|
13776
|
+
* The `queryPolicies()` function builds a query to retrieve a list of policies and returns a [PoliciesQueryBuilder](https://www.wix.com/velo/reference/wix-events-v2/policies/policiesquerybuilder) object.
|
|
13777
|
+
*
|
|
13778
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-events-v2/policies/policiesquerybuilder/find) function.
|
|
13779
|
+
*
|
|
13780
|
+
* You can refine the query by chaining `PoliciesQueryBuilder` functions onto the query. `PoliciesQueryBuilder` functions enable you to sort, filter and control the results that `PoliciesQueryBuilder.find()` returns.
|
|
13781
|
+
*
|
|
13782
|
+
* The query runs with the following `PoliciesQueryBuilder` defaults that you can override:
|
|
13783
|
+
*
|
|
13784
|
+
* [`limit`](https://www.wix.com/velo/reference/wix-events-v2/policies/policiesquerybuilder/limit): `50`
|
|
13785
|
+
* [`descending`](https://www.wix.com/velo/reference/wix-events-v2/policies/policiesquerybuilder/descending): `_createdDate`
|
|
13786
|
+
*
|
|
13787
|
+
* The functions that are chained to `queryPolicies()` are applied in the order they are called. For example, if you sort on the `_createdDate` property in ascending order and then on the id property in descending order, the results are sorted by the created date and then, if there are multiple results with the same date, the items are sorted by the id.
|
|
13788
|
+
*
|
|
13789
|
+
* The table below shows which `PoliciesQueryBuilder` functions are supported for `queryPoliciesGuests()`. You can only use one filter function for each property. If a property is used in more than one filter, only the first filter will work.
|
|
13790
|
+
*/
|
|
13791
|
+
(): PoliciesQueryBuilder;
|
|
13792
|
+
}
|
|
13793
|
+
declare function reorderEventPolicies$1(httpClient: HttpClient): ReorderEventPoliciesSignature;
|
|
13794
|
+
interface ReorderEventPoliciesSignature {
|
|
13795
|
+
/**
|
|
13796
|
+
* Changes policy order in an event dashboard and agreement checkbox on the checkout form.
|
|
13797
|
+
* For example, if we have 3 policies in the list, after using this function the 3rd policy will become the 1st, and other policies will move by 1 position. By default, the policies are arranged by the created date in descending order.
|
|
13798
|
+
*
|
|
13799
|
+
* > **Note**: it is possible to use both `beforePolicyId` and `afterPolicyId` at the same time but only the last one defined will be executed.
|
|
13800
|
+
*
|
|
13801
|
+
* <!--
|
|
13802
|
+
* > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
13803
|
+
* -->
|
|
13804
|
+
*
|
|
13805
|
+
* The `reorderEventPolicies()` function returns a Promise that resolves to the newly-reordered policy.
|
|
13806
|
+
* @param - Event policy ID.
|
|
13807
|
+
* @param - Event ID.
|
|
13808
|
+
* @param - Options for Reorder Event Policies function.
|
|
13809
|
+
*/
|
|
13810
|
+
(policyId: string, eventId: string, options?: ReorderEventPoliciesOptions | undefined): Promise<ReorderEventPoliciesResponse & ReorderEventPoliciesResponseNonNullableFields>;
|
|
13811
|
+
}
|
|
13812
|
+
declare function getPolicy$1(httpClient: HttpClient): GetPolicySignature;
|
|
13813
|
+
interface GetPolicySignature {
|
|
13814
|
+
/**
|
|
13815
|
+
* Retrieves a policy by ID.
|
|
13816
|
+
*
|
|
13817
|
+
*
|
|
13818
|
+
* The `getPolicy()` function returns a Promise that resolves to a policy whose ID matches the given ID.
|
|
13819
|
+
* @param - Policy ID.
|
|
13820
|
+
* @returns The requested policy.
|
|
13821
|
+
*/
|
|
13822
|
+
(policyId: string): Promise<Policy & PolicyNonNullableFields>;
|
|
13823
|
+
}
|
|
12870
13824
|
declare const onPolicyCreated$1: EventDefinition<PolicyCreatedEnvelope, "wix.events.v2.policy_created">;
|
|
12871
13825
|
declare const onPolicyUpdated$1: EventDefinition<PolicyUpdatedEnvelope, "wix.events.v2.policy_updated">;
|
|
12872
13826
|
declare const onPolicyDeleted$1: EventDefinition<PolicyDeletedEnvelope, "wix.events.v2.policy_deleted">;
|
|
@@ -12889,12 +13843,21 @@ type _publicGetPolicyType = typeof getPolicy$1;
|
|
|
12889
13843
|
declare const getPolicy: ReturnType<typeof createRESTModule$2<_publicGetPolicyType>>;
|
|
12890
13844
|
|
|
12891
13845
|
type _publicOnPolicyCreatedType = typeof onPolicyCreated$1;
|
|
13846
|
+
/**
|
|
13847
|
+
* Triggered when a policy is created.
|
|
13848
|
+
*/
|
|
12892
13849
|
declare const onPolicyCreated: ReturnType<typeof createEventModule$2<_publicOnPolicyCreatedType>>;
|
|
12893
13850
|
|
|
12894
13851
|
type _publicOnPolicyUpdatedType = typeof onPolicyUpdated$1;
|
|
13852
|
+
/**
|
|
13853
|
+
* Triggered when a policy is updated.
|
|
13854
|
+
*/
|
|
12895
13855
|
declare const onPolicyUpdated: ReturnType<typeof createEventModule$2<_publicOnPolicyUpdatedType>>;
|
|
12896
13856
|
|
|
12897
13857
|
type _publicOnPolicyDeletedType = typeof onPolicyDeleted$1;
|
|
13858
|
+
/**
|
|
13859
|
+
* Triggered when a policy is deleted.
|
|
13860
|
+
*/
|
|
12898
13861
|
declare const onPolicyDeleted: ReturnType<typeof createEventModule$2<_publicOnPolicyDeletedType>>;
|
|
12899
13862
|
|
|
12900
13863
|
type index_d$2_CreatePolicyRequest = CreatePolicyRequest;
|
|
@@ -15989,18 +16952,156 @@ interface GetEventBySlugOptions {
|
|
|
15989
16952
|
fields?: RequestedFields[];
|
|
15990
16953
|
}
|
|
15991
16954
|
|
|
15992
|
-
declare function createEvent$1(httpClient: HttpClient):
|
|
15993
|
-
|
|
15994
|
-
|
|
15995
|
-
|
|
15996
|
-
|
|
15997
|
-
|
|
15998
|
-
|
|
15999
|
-
|
|
16000
|
-
|
|
16001
|
-
|
|
16002
|
-
|
|
16003
|
-
|
|
16955
|
+
declare function createEvent$1(httpClient: HttpClient): CreateEventSignature;
|
|
16956
|
+
interface CreateEventSignature {
|
|
16957
|
+
/**
|
|
16958
|
+
* Creates an event.
|
|
16959
|
+
*
|
|
16960
|
+
*
|
|
16961
|
+
* The event includes a default registration form in the selected language, which consists of input fields for first name, last name, and email. See [Registration Form](https://www.wix.com/velo/reference/wix-events-v2/forms/introduction) for more information.
|
|
16962
|
+
*
|
|
16963
|
+
* You can create the event as a draft by setting the draft value to true. Otherwise, the event is published right away.
|
|
16964
|
+
*
|
|
16965
|
+
* The event is automatically set up to send daily summary reports of new guests to your business email.
|
|
16966
|
+
* @param - Event data.
|
|
16967
|
+
* @param - Optional fields.
|
|
16968
|
+
* @returns Created event.
|
|
16969
|
+
*/
|
|
16970
|
+
(event: V3Event, options?: CreateEventOptions | undefined): Promise<V3Event & V3EventNonNullableFields>;
|
|
16971
|
+
}
|
|
16972
|
+
declare function cloneEvent$1(httpClient: HttpClient): CloneEventSignature;
|
|
16973
|
+
interface CloneEventSignature {
|
|
16974
|
+
/**
|
|
16975
|
+
* Clones an event, including the registration form, notifications, multilingual translations and ticket configuration from the original event.
|
|
16976
|
+
*
|
|
16977
|
+
*
|
|
16978
|
+
* The new event's date is automatically set to 14 days from the original event date.
|
|
16979
|
+
* If an event with the same title already exists, the new event's title gets a sequence number. For example, if you clone an event named "Leather Crafting 101", the new event's title is "Leather Crafting 101 (1)". You can change the required entity field values while cloning an event.
|
|
16980
|
+
* @param - Event ID.
|
|
16981
|
+
* @param - Optional fields.
|
|
16982
|
+
*/
|
|
16983
|
+
(eventId: string, options?: CloneEventOptions | undefined): Promise<CloneEventResponse & CloneEventResponseNonNullableFields>;
|
|
16984
|
+
}
|
|
16985
|
+
declare function updateEvent$1(httpClient: HttpClient): UpdateEventSignature;
|
|
16986
|
+
interface UpdateEventSignature {
|
|
16987
|
+
/**
|
|
16988
|
+
* Updates an event.
|
|
16989
|
+
* @param - Event ID.
|
|
16990
|
+
* @param - Optional fields.
|
|
16991
|
+
* @returns Updated event.
|
|
16992
|
+
*/
|
|
16993
|
+
(_id: string, options?: UpdateEventOptions | undefined): Promise<V3Event & V3EventNonNullableFields>;
|
|
16994
|
+
}
|
|
16995
|
+
declare function publishDraftEvent$1(httpClient: HttpClient): PublishDraftEventSignature;
|
|
16996
|
+
interface PublishDraftEventSignature {
|
|
16997
|
+
/**
|
|
16998
|
+
* Publishes a draft event to your live site. Once published, the event's status changes from `DRAFT` to `UPCOMING.`
|
|
16999
|
+
*
|
|
17000
|
+
*
|
|
17001
|
+
* It's impossible to revert the `DRAFT` status after publishing. The only option is to clone the event, and then delete the original one.
|
|
17002
|
+
* @param - Event ID.
|
|
17003
|
+
* @param - Optional fields.
|
|
17004
|
+
*/
|
|
17005
|
+
(eventId: string, options?: PublishDraftEventOptions | undefined): Promise<PublishDraftEventResponse & PublishDraftEventResponseNonNullableFields>;
|
|
17006
|
+
}
|
|
17007
|
+
declare function cancelEvent$1(httpClient: HttpClient): CancelEventSignature;
|
|
17008
|
+
interface CancelEventSignature {
|
|
17009
|
+
/**
|
|
17010
|
+
* Cancels an event.
|
|
17011
|
+
*
|
|
17012
|
+
*
|
|
17013
|
+
* After cancellation, registration for an event is closed. To reuse the event, [clone](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/cloneevent) and [publish](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/publishdraftevent) it again.
|
|
17014
|
+
* If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
|
|
17015
|
+
* @param - Event ID.
|
|
17016
|
+
* @param - Optional fields.
|
|
17017
|
+
*/
|
|
17018
|
+
(eventId: string, options?: CancelEventOptions | undefined): Promise<CancelEventResponse & CancelEventResponseNonNullableFields>;
|
|
17019
|
+
}
|
|
17020
|
+
declare function bulkCancelEventsByFilter$1(httpClient: HttpClient): BulkCancelEventsByFilterSignature;
|
|
17021
|
+
interface BulkCancelEventsByFilterSignature {
|
|
17022
|
+
/**
|
|
17023
|
+
* Cancels multiple events that meet the given criteria.
|
|
17024
|
+
*
|
|
17025
|
+
*
|
|
17026
|
+
* After cancellation, registration for an event is closed. To reuse the event, [clone](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/cloneevent) and [publish](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/publishdraftevent) it again.
|
|
17027
|
+
* If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
|
|
17028
|
+
* @param - Optional fields.
|
|
17029
|
+
*/
|
|
17030
|
+
(options?: BulkCancelEventsByFilterOptions | undefined): Promise<void>;
|
|
17031
|
+
}
|
|
17032
|
+
declare function deleteEvent$1(httpClient: HttpClient): DeleteEventSignature;
|
|
17033
|
+
interface DeleteEventSignature {
|
|
17034
|
+
/**
|
|
17035
|
+
* Permanently deletes an event. <br> <br>
|
|
17036
|
+
* You can retrieve the deleted event through a GDPR access request.
|
|
17037
|
+
* @param - Event ID.
|
|
17038
|
+
*/
|
|
17039
|
+
(eventId: string): Promise<DeleteEventResponse & DeleteEventResponseNonNullableFields>;
|
|
17040
|
+
}
|
|
17041
|
+
declare function bulkDeleteEventsByFilter$1(httpClient: HttpClient): BulkDeleteEventsByFilterSignature;
|
|
17042
|
+
interface BulkDeleteEventsByFilterSignature {
|
|
17043
|
+
/**
|
|
17044
|
+
* Permanently deletes multiple events that meet the given criteria.
|
|
17045
|
+
*
|
|
17046
|
+
*
|
|
17047
|
+
* You can retrieve the deleted events through a GDPR access request.
|
|
17048
|
+
* @param - Optional fields.
|
|
17049
|
+
*/
|
|
17050
|
+
(options?: BulkDeleteEventsByFilterOptions | undefined): Promise<void>;
|
|
17051
|
+
}
|
|
17052
|
+
declare function queryEvents$1(httpClient: HttpClient): QueryEventsSignature;
|
|
17053
|
+
interface QueryEventsSignature {
|
|
17054
|
+
/**
|
|
17055
|
+
* Creates a query to retrieve a list of events.
|
|
17056
|
+
*
|
|
17057
|
+
*
|
|
17058
|
+
* The `queryEvents()` function builds a query to retrieve a list of events and returns a [`EventsQueryBuilder`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder) object.
|
|
17059
|
+
*
|
|
17060
|
+
* The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/find) function.
|
|
17061
|
+
*
|
|
17062
|
+
* You can refine the query by chaining `EventsQueryBuilder` functions onto the query. `EventsQueryBuilder` functions enable you to sort, filter, and control the results `queryEvents()` returns.
|
|
17063
|
+
*
|
|
17064
|
+
* `queryEvents()` runs with these `EventsQueryBuilder` defaults, which you can override:
|
|
17065
|
+
*
|
|
17066
|
+
* - [`skip(0)`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/skip)
|
|
17067
|
+
* - [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/limit)
|
|
17068
|
+
* - [`descending("_createdDate")`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/descending)
|
|
17069
|
+
*
|
|
17070
|
+
* The functions that are chained to `queryEvents()` are applied in the order they're called. For example, if you apply `ascending('title')` and then `descending('status')`, the results are sorted first by the `title`, and then, if there are multiple results with the same `title`, the items are sorted by `status`.
|
|
17071
|
+
* @param - Optional fields.
|
|
17072
|
+
*/
|
|
17073
|
+
(options?: QueryEventsOptions | undefined): EventsQueryBuilder;
|
|
17074
|
+
}
|
|
17075
|
+
declare function countEventsByStatus$1(httpClient: HttpClient): CountEventsByStatusSignature;
|
|
17076
|
+
interface CountEventsByStatusSignature {
|
|
17077
|
+
/**
|
|
17078
|
+
* Counts events by status.
|
|
17079
|
+
* @param - Optional fields.
|
|
17080
|
+
*/
|
|
17081
|
+
(options?: CountEventsByStatusOptions | undefined): Promise<CountEventsByStatusResponse>;
|
|
17082
|
+
}
|
|
17083
|
+
declare function getEvent$1(httpClient: HttpClient): GetEventSignature;
|
|
17084
|
+
interface GetEventSignature {
|
|
17085
|
+
/**
|
|
17086
|
+
* Retrieves an event by ID.
|
|
17087
|
+
* @param - Event ID.
|
|
17088
|
+
* @param - Optional fields.
|
|
17089
|
+
* @returns Event.
|
|
17090
|
+
*/
|
|
17091
|
+
(eventId: string | null, options?: GetEventOptions | undefined): Promise<V3Event & V3EventNonNullableFields>;
|
|
17092
|
+
}
|
|
17093
|
+
declare function getEventBySlug$1(httpClient: HttpClient): GetEventBySlugSignature;
|
|
17094
|
+
interface GetEventBySlugSignature {
|
|
17095
|
+
/**
|
|
17096
|
+
* Retrieves an event by the `slug` URL.
|
|
17097
|
+
*
|
|
17098
|
+
*
|
|
17099
|
+
* The slug is the end of an event URL that refers to a specific event. For example, if an events' URL is `https://example.com/events/event/{my-event-slug}`, the slug is `my-event-slug`.
|
|
17100
|
+
* @param - URL slug.
|
|
17101
|
+
* @param - Optional fields.
|
|
17102
|
+
*/
|
|
17103
|
+
(slug: string | null, options?: GetEventBySlugOptions | undefined): Promise<GetEventBySlugResponse & GetEventBySlugResponseNonNullableFields>;
|
|
17104
|
+
}
|
|
16004
17105
|
declare const onEventCreated$1: EventDefinition<EventCreatedEnvelope, "wix.events.v3.event_created">;
|
|
16005
17106
|
declare const onEventUpdated$1: EventDefinition<EventUpdatedEnvelope, "wix.events.v3.event_updated">;
|
|
16006
17107
|
declare const onEventDeleted$1: EventDefinition<EventDeletedEnvelope, "wix.events.v3.event_deleted">;
|
|
@@ -16041,30 +17142,57 @@ type _publicGetEventBySlugType = typeof getEventBySlug$1;
|
|
|
16041
17142
|
declare const getEventBySlug: ReturnType<typeof createRESTModule$1<_publicGetEventBySlugType>>;
|
|
16042
17143
|
|
|
16043
17144
|
type _publicOnEventCreatedType = typeof onEventCreated$1;
|
|
17145
|
+
/** */
|
|
16044
17146
|
declare const onEventCreated: ReturnType<typeof createEventModule$1<_publicOnEventCreatedType>>;
|
|
16045
17147
|
|
|
16046
17148
|
type _publicOnEventUpdatedType = typeof onEventUpdated$1;
|
|
17149
|
+
/** */
|
|
16047
17150
|
declare const onEventUpdated: ReturnType<typeof createEventModule$1<_publicOnEventUpdatedType>>;
|
|
16048
17151
|
|
|
16049
17152
|
type _publicOnEventDeletedType = typeof onEventDeleted$1;
|
|
17153
|
+
/** */
|
|
16050
17154
|
declare const onEventDeleted: ReturnType<typeof createEventModule$1<_publicOnEventDeletedType>>;
|
|
16051
17155
|
|
|
16052
17156
|
type _publicOnEventStartedType = typeof onEventStarted$1;
|
|
17157
|
+
/**
|
|
17158
|
+
* Triggered when an event is started.
|
|
17159
|
+
*/
|
|
16053
17160
|
declare const onEventStarted: ReturnType<typeof createEventModule$1<_publicOnEventStartedType>>;
|
|
16054
17161
|
|
|
16055
17162
|
type _publicOnEventEndedType = typeof onEventEnded$1;
|
|
17163
|
+
/**
|
|
17164
|
+
* Triggered when an event has ended.
|
|
17165
|
+
*/
|
|
16056
17166
|
declare const onEventEnded: ReturnType<typeof createEventModule$1<_publicOnEventEndedType>>;
|
|
16057
17167
|
|
|
16058
17168
|
type _publicOnEventReminderType = typeof onEventReminder$1;
|
|
17169
|
+
/**
|
|
17170
|
+
* Triggered when a certain amount of time is left until the event. In total there are 6 reminders:
|
|
17171
|
+
* - 7 days
|
|
17172
|
+
* - 3 days
|
|
17173
|
+
* - 1 day
|
|
17174
|
+
* - 2 hours
|
|
17175
|
+
* - 1 hour
|
|
17176
|
+
* - 30 minutes
|
|
17177
|
+
*/
|
|
16059
17178
|
declare const onEventReminder: ReturnType<typeof createEventModule$1<_publicOnEventReminderType>>;
|
|
16060
17179
|
|
|
16061
17180
|
type _publicOnEventPublishedType = typeof onEventPublished$1;
|
|
17181
|
+
/**
|
|
17182
|
+
* Triggered when an event is published
|
|
17183
|
+
*/
|
|
16062
17184
|
declare const onEventPublished: ReturnType<typeof createEventModule$1<_publicOnEventPublishedType>>;
|
|
16063
17185
|
|
|
16064
17186
|
type _publicOnEventClonedType = typeof onEventCloned$1;
|
|
17187
|
+
/**
|
|
17188
|
+
* Triggered when an event is cloned
|
|
17189
|
+
*/
|
|
16065
17190
|
declare const onEventCloned: ReturnType<typeof createEventModule$1<_publicOnEventClonedType>>;
|
|
16066
17191
|
|
|
16067
17192
|
type _publicOnEventCanceledType = typeof onEventCanceled$1;
|
|
17193
|
+
/**
|
|
17194
|
+
* Triggered when an event is canceled
|
|
17195
|
+
*/
|
|
16068
17196
|
declare const onEventCanceled: ReturnType<typeof createEventModule$1<_publicOnEventCanceledType>>;
|
|
16069
17197
|
|
|
16070
17198
|
type index_d$1_AgendaSettings = AgendaSettings;
|
|
@@ -18582,17 +19710,140 @@ interface ChangeCurrencyOptions {
|
|
|
18582
19710
|
currency: string;
|
|
18583
19711
|
}
|
|
18584
19712
|
|
|
18585
|
-
declare function createTicketDefinition$1(httpClient: HttpClient):
|
|
18586
|
-
|
|
18587
|
-
|
|
18588
|
-
|
|
18589
|
-
|
|
18590
|
-
|
|
18591
|
-
|
|
18592
|
-
|
|
18593
|
-
|
|
18594
|
-
|
|
18595
|
-
|
|
19713
|
+
declare function createTicketDefinition$1(httpClient: HttpClient): CreateTicketDefinitionSignature;
|
|
19714
|
+
interface CreateTicketDefinitionSignature {
|
|
19715
|
+
/**
|
|
19716
|
+
* > **Note:** This function replaces the deprecated `createTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/createticketdefinition).
|
|
19717
|
+
*
|
|
19718
|
+
*
|
|
19719
|
+
* Creates a ticket definition.
|
|
19720
|
+
*
|
|
19721
|
+
*
|
|
19722
|
+
* It is allowed to create up to 100 definitions per event.
|
|
19723
|
+
* @param - Ticket definition info.
|
|
19724
|
+
* @param - Optional fields.
|
|
19725
|
+
* @returns Created ticket definition.
|
|
19726
|
+
*/
|
|
19727
|
+
(ticketDefinition: TicketDefinition, options?: CreateTicketDefinitionOptions | undefined): Promise<TicketDefinition & TicketDefinitionNonNullableFields>;
|
|
19728
|
+
}
|
|
19729
|
+
declare function updateTicketDefinition$1(httpClient: HttpClient): UpdateTicketDefinitionSignature;
|
|
19730
|
+
interface UpdateTicketDefinitionSignature {
|
|
19731
|
+
/**
|
|
19732
|
+
* > **Note:** This function replaces the deprecated `updateTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/updateticketdefinition).
|
|
19733
|
+
*
|
|
19734
|
+
* Updates a ticket definition.
|
|
19735
|
+
*
|
|
19736
|
+
*
|
|
19737
|
+
* Each time the ticket definition is updated, `revision` increments by 1. The existing `revision` must be included when updating the ticket definition. This ensures you're working with the latest ticket definition and prevents unintended overwrites.
|
|
19738
|
+
* @param - Ticket definition ID.
|
|
19739
|
+
* @param - Optional fields.
|
|
19740
|
+
* @param - Ticket definition to update.
|
|
19741
|
+
* @returns The updated ticket definition.
|
|
19742
|
+
*/
|
|
19743
|
+
(_id: string | null, ticketDefinition: UpdateTicketDefinition, options?: UpdateTicketDefinitionOptions | undefined): Promise<TicketDefinition & TicketDefinitionNonNullableFields>;
|
|
19744
|
+
}
|
|
19745
|
+
declare function getTicketDefinition$1(httpClient: HttpClient): GetTicketDefinitionSignature;
|
|
19746
|
+
interface GetTicketDefinitionSignature {
|
|
19747
|
+
/**
|
|
19748
|
+
* > **Note:** This function replaces the deprecated `getTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/getticketdefinition).
|
|
19749
|
+
*
|
|
19750
|
+
* Retrieves a ticket definition by ID.
|
|
19751
|
+
* @param - Ticket definition ID.
|
|
19752
|
+
* @param - Optional fields.
|
|
19753
|
+
* @returns The requested ticket definition.
|
|
19754
|
+
*/
|
|
19755
|
+
(ticketDefinitionId: string, options?: GetTicketDefinitionOptions | undefined): Promise<TicketDefinition & TicketDefinitionNonNullableFields>;
|
|
19756
|
+
}
|
|
19757
|
+
declare function deleteTicketDefinition$1(httpClient: HttpClient): DeleteTicketDefinitionSignature;
|
|
19758
|
+
interface DeleteTicketDefinitionSignature {
|
|
19759
|
+
/**
|
|
19760
|
+
* > **Note:** This function replaces the deprecated `deleteTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/deleteticketdefinition).
|
|
19761
|
+
*
|
|
19762
|
+
* Permanently deletes a ticket definition.
|
|
19763
|
+
* @param - ID of the ticket definition to delete.
|
|
19764
|
+
*/
|
|
19765
|
+
(ticketDefinitionId: string): Promise<void>;
|
|
19766
|
+
}
|
|
19767
|
+
declare function reorderTicketDefinitions$1(httpClient: HttpClient): ReorderTicketDefinitionsSignature;
|
|
19768
|
+
interface ReorderTicketDefinitionsSignature {
|
|
19769
|
+
/**
|
|
19770
|
+
* Changes ticket definitions order in an event dashboard and the list of available tickets in the ticket picker.
|
|
19771
|
+
* > **Note:** It is possible to use both `beforeTicketDefinitionId` and `afterTicketDefinitionId` at the same time but only the last one defined will be executed.
|
|
19772
|
+
* @param - Event ID.
|
|
19773
|
+
* @param - Optional fields.
|
|
19774
|
+
*/
|
|
19775
|
+
(eventId: string, options?: ReorderTicketDefinitionsOptions | undefined): Promise<void>;
|
|
19776
|
+
}
|
|
19777
|
+
declare function queryTicketDefinitions$1(httpClient: HttpClient): QueryTicketDefinitionsSignature;
|
|
19778
|
+
interface QueryTicketDefinitionsSignature {
|
|
19779
|
+
/**
|
|
19780
|
+
* > **Note:** This function replaces the deprecated `listTicketDefinition()` and `queryTicketDefinitions` functions. The deprecated functions will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/queryticketdefinitions).
|
|
19781
|
+
*
|
|
19782
|
+
* Retrieves a list of ticket definitions, given the provided paging, filtering, and sorting.
|
|
19783
|
+
* Query Ticket Definitions runs with these defaults, which you can override:
|
|
19784
|
+
* - `createdDate` is sorted in `ASC` order
|
|
19785
|
+
* - `paging.limit` is `100`
|
|
19786
|
+
* - `paging.offset` is `0`
|
|
19787
|
+
* @param - Optional fields.
|
|
19788
|
+
*/
|
|
19789
|
+
(options?: QueryTicketDefinitionsOptions | undefined): TicketDefinitionsQueryBuilder;
|
|
19790
|
+
}
|
|
19791
|
+
declare function queryAvailableTicketDefinitions$1(httpClient: HttpClient): QueryAvailableTicketDefinitionsSignature;
|
|
19792
|
+
interface QueryAvailableTicketDefinitionsSignature {
|
|
19793
|
+
/**
|
|
19794
|
+
* Retrieves a list of available ticket definitions, given the provided paging, filtering, and sorting. <br>
|
|
19795
|
+
* This endpoint retrieves ticket definitions that aren't in the `hidden` state. They can be retrieved by site visitors, but to get the `salesDetails` field, the `WIX_EVENTS.READ_TICKET_DEFINITIONS` permission is required. <br>
|
|
19796
|
+
* Query Available Ticket Definitions runs with these defaults, which you can override:
|
|
19797
|
+
* - `createdDate` is sorted in `ASC` order
|
|
19798
|
+
* - `paging.limit` is `100`
|
|
19799
|
+
* - `paging.offset` is `0`
|
|
19800
|
+
* <br>
|
|
19801
|
+
* For field support for filters and sorting, see [Ticket Definitions: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/filter-and-sort).
|
|
19802
|
+
* To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
19803
|
+
* @param - Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details.
|
|
19804
|
+
* @param - Optional fields.
|
|
19805
|
+
*/
|
|
19806
|
+
(query: QueryV2, options?: QueryAvailableTicketDefinitionsOptions | undefined): Promise<QueryAvailableTicketDefinitionsResponse & QueryAvailableTicketDefinitionsResponseNonNullableFields>;
|
|
19807
|
+
}
|
|
19808
|
+
declare function countTicketDefinitions$1(httpClient: HttpClient): CountTicketDefinitionsSignature;
|
|
19809
|
+
interface CountTicketDefinitionsSignature {
|
|
19810
|
+
/**
|
|
19811
|
+
* Counts ticket definitions by the `saleStatus` and `hidden` fields. <br> <br>
|
|
19812
|
+
* To learn about working with _query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
19813
|
+
* @param - Optional fields.
|
|
19814
|
+
*/
|
|
19815
|
+
(options?: CountTicketDefinitionsOptions | undefined): Promise<CountTicketDefinitionsResponse>;
|
|
19816
|
+
}
|
|
19817
|
+
declare function countAvailableTicketDefinitions$1(httpClient: HttpClient): CountAvailableTicketDefinitionsSignature;
|
|
19818
|
+
interface CountAvailableTicketDefinitionsSignature {
|
|
19819
|
+
/**
|
|
19820
|
+
* Counts ticket definitions that aren't in the `hidden` state. This endpoint counts tickets by the `saleStatus` field. <br> <br>
|
|
19821
|
+
* To learn about working with _query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
19822
|
+
* @param - Optional fields.
|
|
19823
|
+
*/
|
|
19824
|
+
(options?: CountAvailableTicketDefinitionsOptions | undefined): Promise<CountAvailableTicketDefinitionsResponse>;
|
|
19825
|
+
}
|
|
19826
|
+
declare function bulkDeleteTicketDefinitionsByFilter$1(httpClient: HttpClient): BulkDeleteTicketDefinitionsByFilterSignature;
|
|
19827
|
+
interface BulkDeleteTicketDefinitionsByFilterSignature {
|
|
19828
|
+
/**
|
|
19829
|
+
* Deletes multiple ticket definitions.
|
|
19830
|
+
*
|
|
19831
|
+
* All ticket definitions that meet the specified `filter` criteria are deleted.
|
|
19832
|
+
* @param - Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. <br/> <br/> **Example:** <br/> `"filter" : { "eventId": "3d3d5c04-ece0-45a8-85f0-11a58edaa192" }`
|
|
19833
|
+
*/
|
|
19834
|
+
(filter: Record<string, any> | null): Promise<void>;
|
|
19835
|
+
}
|
|
19836
|
+
declare function changeCurrency$1(httpClient: HttpClient): ChangeCurrencySignature;
|
|
19837
|
+
interface ChangeCurrencySignature {
|
|
19838
|
+
/**
|
|
19839
|
+
* > **Note:** This function replaces the deprecated `changeCurrency()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/changecurrency).
|
|
19840
|
+
*
|
|
19841
|
+
* Changes ticket price currency per event.
|
|
19842
|
+
* @param - Event ID.
|
|
19843
|
+
* @param - Optional fields.
|
|
19844
|
+
*/
|
|
19845
|
+
(eventId: string, options: ChangeCurrencyOptions): Promise<void>;
|
|
19846
|
+
}
|
|
18596
19847
|
declare const onTicketDefinitionCreated$1: EventDefinition<TicketDefinitionCreatedEnvelope, "wix.events.v3.ticket_definition_created">;
|
|
18597
19848
|
declare const onTicketDefinitionUpdated$1: EventDefinition<TicketDefinitionUpdatedEnvelope, "wix.events.v3.ticket_definition_updated">;
|
|
18598
19849
|
declare const onTicketDefinitionDeleted$1: EventDefinition<TicketDefinitionDeletedEnvelope, "wix.events.v3.ticket_definition_deleted">;
|
|
@@ -18626,15 +19877,27 @@ type _publicChangeCurrencyType = typeof changeCurrency$1;
|
|
|
18626
19877
|
declare const changeCurrency: ReturnType<typeof createRESTModule<_publicChangeCurrencyType>>;
|
|
18627
19878
|
|
|
18628
19879
|
type _publicOnTicketDefinitionCreatedType = typeof onTicketDefinitionCreated$1;
|
|
19880
|
+
/**
|
|
19881
|
+
* Triggered when a ticket definition is created.
|
|
19882
|
+
*/
|
|
18629
19883
|
declare const onTicketDefinitionCreated: ReturnType<typeof createEventModule<_publicOnTicketDefinitionCreatedType>>;
|
|
18630
19884
|
|
|
18631
19885
|
type _publicOnTicketDefinitionUpdatedType = typeof onTicketDefinitionUpdated$1;
|
|
19886
|
+
/**
|
|
19887
|
+
* Triggered when a ticket definition is updated.
|
|
19888
|
+
*/
|
|
18632
19889
|
declare const onTicketDefinitionUpdated: ReturnType<typeof createEventModule<_publicOnTicketDefinitionUpdatedType>>;
|
|
18633
19890
|
|
|
18634
19891
|
type _publicOnTicketDefinitionDeletedType = typeof onTicketDefinitionDeleted$1;
|
|
19892
|
+
/**
|
|
19893
|
+
* Triggered when a ticket definition is deleted.
|
|
19894
|
+
*/
|
|
18635
19895
|
declare const onTicketDefinitionDeleted: ReturnType<typeof createEventModule<_publicOnTicketDefinitionDeletedType>>;
|
|
18636
19896
|
|
|
18637
19897
|
type _publicOnTicketDefinitionSalePeriodUpdatedType = typeof onTicketDefinitionSalePeriodUpdated$1;
|
|
19898
|
+
/**
|
|
19899
|
+
* Triggered when sale period is updated.
|
|
19900
|
+
*/
|
|
18638
19901
|
declare const onTicketDefinitionSalePeriodUpdated: ReturnType<typeof createEventModule<_publicOnTicketDefinitionSalePeriodUpdatedType>>;
|
|
18639
19902
|
|
|
18640
19903
|
type index_d_ActionEvent = ActionEvent;
|