@wix/auto_sdk_events_wix-events-v-2 1.0.36 → 1.0.38
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +19 -7
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/{events-v3-event-wix-events-v-2.universal-BaXE7UV0.d.ts → index.typings.d.ts} +600 -5
- package/build/cjs/index.typings.js +2154 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +2 -1
- package/build/es/index.d.mts +19 -7
- package/build/es/index.mjs.map +1 -1
- package/build/es/{events-v3-event-wix-events-v-2.universal-BaXE7UV0.d.mts → index.typings.d.mts} +600 -5
- package/build/es/index.typings.mjs +2057 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +2 -1
- package/build/internal/cjs/index.d.ts +19 -7
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/{events-v3-event-wix-events-v-2.universal-BaXE7UV0.d.ts → index.typings.d.ts} +600 -5
- package/build/internal/cjs/index.typings.js +2154 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +2 -1
- package/build/internal/es/index.d.mts +19 -7
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/{events-v3-event-wix-events-v-2.universal-BaXE7UV0.d.mts → index.typings.d.mts} +600 -5
- package/build/internal/es/index.typings.mjs +2057 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +2 -1
- package/package.json +3 -3
package/build/es/{events-v3-event-wix-events-v-2.universal-BaXE7UV0.d.mts → index.typings.d.mts}
RENAMED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
interface V3Event {
|
|
2
4
|
/**
|
|
3
5
|
* Event ID.
|
|
@@ -260,6 +262,8 @@ declare enum SubdivisionSubdivisionType {
|
|
|
260
262
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
261
263
|
COUNTRY = "COUNTRY"
|
|
262
264
|
}
|
|
265
|
+
/** @enumType */
|
|
266
|
+
type SubdivisionSubdivisionTypeWithLiterals = SubdivisionSubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
263
267
|
interface DateAndTimeSettings {
|
|
264
268
|
/** Whether the event date and time are TBD. */
|
|
265
269
|
dateAndTimeTbd?: boolean | null;
|
|
@@ -2585,6 +2589,8 @@ declare enum NullValue {
|
|
|
2585
2589
|
/** Null value. */
|
|
2586
2590
|
NULL_VALUE = "NULL_VALUE"
|
|
2587
2591
|
}
|
|
2592
|
+
/** @enumType */
|
|
2593
|
+
type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
2588
2594
|
/**
|
|
2589
2595
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
2590
2596
|
*
|
|
@@ -3108,20 +3114,20 @@ interface ExportEventsRequest {
|
|
|
3108
3114
|
query?: QueryV2;
|
|
3109
3115
|
}
|
|
3110
3116
|
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
3111
|
-
/** Paging options to limit and
|
|
3117
|
+
/** Paging options to limit and offset the number of items. */
|
|
3112
3118
|
paging?: Paging;
|
|
3113
3119
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
3114
3120
|
cursorPaging?: CursorPaging;
|
|
3115
3121
|
/**
|
|
3116
3122
|
* Filter object.
|
|
3117
3123
|
*
|
|
3118
|
-
* Learn more about
|
|
3124
|
+
* Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
|
|
3119
3125
|
*/
|
|
3120
3126
|
filter?: Record<string, any> | null;
|
|
3121
3127
|
/**
|
|
3122
3128
|
* Sort object.
|
|
3123
3129
|
*
|
|
3124
|
-
* Learn more about
|
|
3130
|
+
* Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
|
|
3125
3131
|
*/
|
|
3126
3132
|
sort?: Sorting[];
|
|
3127
3133
|
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
@@ -3131,7 +3137,7 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
3131
3137
|
}
|
|
3132
3138
|
/** @oneof */
|
|
3133
3139
|
interface QueryV2PagingMethodOneOf {
|
|
3134
|
-
/** Paging options to limit and
|
|
3140
|
+
/** Paging options to limit and offset the number of items. */
|
|
3135
3141
|
paging?: Paging;
|
|
3136
3142
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
3137
3143
|
cursorPaging?: CursorPaging;
|
|
@@ -3529,6 +3535,8 @@ declare enum SubdivisionType {
|
|
|
3529
3535
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
3530
3536
|
COUNTRY = "COUNTRY"
|
|
3531
3537
|
}
|
|
3538
|
+
/** @enumType */
|
|
3539
|
+
type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
3532
3540
|
interface ScheduleConfig {
|
|
3533
3541
|
/**
|
|
3534
3542
|
* Defines event as TBD (To Be Determined) schedule.
|
|
@@ -4396,6 +4404,62 @@ declare enum WebhookIdentityType {
|
|
|
4396
4404
|
}
|
|
4397
4405
|
/** @enumType */
|
|
4398
4406
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
4407
|
+
type CreateEventApplicationErrors = {
|
|
4408
|
+
code?: 'INVALID_SLUG_FORMAT';
|
|
4409
|
+
description?: string;
|
|
4410
|
+
data?: Record<string, any>;
|
|
4411
|
+
} | {
|
|
4412
|
+
code?: 'EVENT_LIMIT_REACHED';
|
|
4413
|
+
description?: string;
|
|
4414
|
+
data?: Record<string, any>;
|
|
4415
|
+
} | {
|
|
4416
|
+
code?: 'SLUG_ALREADY_IN_USE';
|
|
4417
|
+
description?: string;
|
|
4418
|
+
data?: Record<string, any>;
|
|
4419
|
+
};
|
|
4420
|
+
type CreateEventValidationErrors = {
|
|
4421
|
+
ruleName?: 'INVALID_EVENT_CONFIGURATION';
|
|
4422
|
+
};
|
|
4423
|
+
type UpdateEventApplicationErrors = {
|
|
4424
|
+
code?: 'INVALID_EVENT_STATUS_TRANSITION';
|
|
4425
|
+
description?: string;
|
|
4426
|
+
data?: Record<string, any>;
|
|
4427
|
+
} | {
|
|
4428
|
+
code?: 'INVALID_SLUG_FORMAT';
|
|
4429
|
+
description?: string;
|
|
4430
|
+
data?: Record<string, any>;
|
|
4431
|
+
} | {
|
|
4432
|
+
code?: 'SLUG_ALREADY_IN_USE';
|
|
4433
|
+
description?: string;
|
|
4434
|
+
data?: Record<string, any>;
|
|
4435
|
+
};
|
|
4436
|
+
type UpdateEventValidationErrors = {
|
|
4437
|
+
ruleName?: 'INVALID_EVENT_CONFIGURATION';
|
|
4438
|
+
};
|
|
4439
|
+
type PublishDraftEventApplicationErrors = {
|
|
4440
|
+
code?: 'INVALID_EVENT_STATUS_TRANSITION';
|
|
4441
|
+
description?: string;
|
|
4442
|
+
data?: Record<string, any>;
|
|
4443
|
+
} | {
|
|
4444
|
+
code?: 'EVENT_ALREADY_PUBLISHED';
|
|
4445
|
+
description?: string;
|
|
4446
|
+
data?: Record<string, any>;
|
|
4447
|
+
};
|
|
4448
|
+
type CancelEventApplicationErrors = {
|
|
4449
|
+
code?: 'INVALID_EVENT_STATUS_TRANSITION';
|
|
4450
|
+
description?: string;
|
|
4451
|
+
data?: Record<string, any>;
|
|
4452
|
+
};
|
|
4453
|
+
type QueryEventsApplicationErrors = {
|
|
4454
|
+
code?: 'FILTER_PARSER_ERROR';
|
|
4455
|
+
description?: string;
|
|
4456
|
+
data?: Record<string, any>;
|
|
4457
|
+
};
|
|
4458
|
+
type CountEventsByStatusApplicationErrors = {
|
|
4459
|
+
code?: 'FILTER_PARSER_ERROR';
|
|
4460
|
+
description?: string;
|
|
4461
|
+
data?: Record<string, any>;
|
|
4462
|
+
};
|
|
4399
4463
|
interface BaseEventMetadata {
|
|
4400
4464
|
/**
|
|
4401
4465
|
* App instance ID.
|
|
@@ -4444,37 +4508,394 @@ interface EventCanceledEnvelope {
|
|
|
4444
4508
|
data: EventEventCanceled;
|
|
4445
4509
|
metadata: EventMetadata;
|
|
4446
4510
|
}
|
|
4511
|
+
/**
|
|
4512
|
+
* Triggered when event is canceled.
|
|
4513
|
+
* @permissionScope Manage Stores
|
|
4514
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4515
|
+
* @permissionScope Read Events - all read permissions
|
|
4516
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4517
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4518
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4519
|
+
* @permissionScope Manage Events - all permissions
|
|
4520
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4521
|
+
* @permissionScope Manage Events
|
|
4522
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4523
|
+
* @permissionScope Read Events
|
|
4524
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4525
|
+
* @permissionScope Manage Challenges
|
|
4526
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4527
|
+
* @permissionScope Manage Portfolio
|
|
4528
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4529
|
+
* @permissionScope Manage Blog
|
|
4530
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4531
|
+
* @permissionScope Access Verticals by Automations
|
|
4532
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4533
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4534
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4535
|
+
* @permissionScope Set Up Automations
|
|
4536
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4537
|
+
* @permissionScope Manage Guest List
|
|
4538
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4539
|
+
* @permissionScope Manage Events
|
|
4540
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4541
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4542
|
+
* @webhook
|
|
4543
|
+
* @eventType wix.events.v3.event_canceled
|
|
4544
|
+
* @slug canceled
|
|
4545
|
+
*/
|
|
4546
|
+
declare function onEventCanceled(handler: (event: EventCanceledEnvelope) => void | Promise<void>): void;
|
|
4447
4547
|
interface EventClonedEnvelope {
|
|
4448
4548
|
data: EventCloned;
|
|
4449
4549
|
metadata: EventMetadata;
|
|
4450
4550
|
}
|
|
4551
|
+
/**
|
|
4552
|
+
* Triggered when event is cloned.
|
|
4553
|
+
* @permissionScope Manage Stores
|
|
4554
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4555
|
+
* @permissionScope Read Events - all read permissions
|
|
4556
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4557
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4558
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4559
|
+
* @permissionScope Manage Events - all permissions
|
|
4560
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4561
|
+
* @permissionScope Manage Events
|
|
4562
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4563
|
+
* @permissionScope Read Events
|
|
4564
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4565
|
+
* @permissionScope Manage Challenges
|
|
4566
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4567
|
+
* @permissionScope Manage Portfolio
|
|
4568
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4569
|
+
* @permissionScope Manage Blog
|
|
4570
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4571
|
+
* @permissionScope Access Verticals by Automations
|
|
4572
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4573
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4574
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4575
|
+
* @permissionScope Set Up Automations
|
|
4576
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4577
|
+
* @permissionScope Manage Guest List
|
|
4578
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4579
|
+
* @permissionScope Manage Events
|
|
4580
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4581
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4582
|
+
* @webhook
|
|
4583
|
+
* @eventType wix.events.v3.event_cloned
|
|
4584
|
+
* @slug cloned
|
|
4585
|
+
*/
|
|
4586
|
+
declare function onEventCloned(handler: (event: EventClonedEnvelope) => void | Promise<void>): void;
|
|
4451
4587
|
interface EventCreatedEnvelope {
|
|
4452
4588
|
entity: V3Event;
|
|
4453
4589
|
metadata: EventMetadata;
|
|
4454
4590
|
}
|
|
4591
|
+
/**
|
|
4592
|
+
* Triggered when event is created.
|
|
4593
|
+
* @permissionScope Manage Stores
|
|
4594
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4595
|
+
* @permissionScope Read Events - all read permissions
|
|
4596
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4597
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4598
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4599
|
+
* @permissionScope Manage Events - all permissions
|
|
4600
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4601
|
+
* @permissionScope Manage Events
|
|
4602
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4603
|
+
* @permissionScope Read Events
|
|
4604
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4605
|
+
* @permissionScope Manage Challenges
|
|
4606
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4607
|
+
* @permissionScope Manage Portfolio
|
|
4608
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4609
|
+
* @permissionScope Manage Blog
|
|
4610
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4611
|
+
* @permissionScope Access Verticals by Automations
|
|
4612
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4613
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4614
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4615
|
+
* @permissionScope Set Up Automations
|
|
4616
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4617
|
+
* @permissionScope Manage Guest List
|
|
4618
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4619
|
+
* @permissionScope Manage Events
|
|
4620
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4621
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4622
|
+
* @webhook
|
|
4623
|
+
* @eventType wix.events.v3.event_created
|
|
4624
|
+
* @slug created
|
|
4625
|
+
*/
|
|
4626
|
+
declare function onEventCreated(handler: (event: EventCreatedEnvelope) => void | Promise<void>): void;
|
|
4455
4627
|
interface EventDeletedEnvelope {
|
|
4456
4628
|
metadata: EventMetadata;
|
|
4457
4629
|
}
|
|
4630
|
+
/**
|
|
4631
|
+
* Triggered when event is deleted.
|
|
4632
|
+
* @permissionScope Manage Stores
|
|
4633
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4634
|
+
* @permissionScope Read Events - all read permissions
|
|
4635
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4636
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4637
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4638
|
+
* @permissionScope Manage Events - all permissions
|
|
4639
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4640
|
+
* @permissionScope Manage Events
|
|
4641
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4642
|
+
* @permissionScope Read Events
|
|
4643
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4644
|
+
* @permissionScope Manage Challenges
|
|
4645
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4646
|
+
* @permissionScope Manage Portfolio
|
|
4647
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4648
|
+
* @permissionScope Manage Blog
|
|
4649
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4650
|
+
* @permissionScope Access Verticals by Automations
|
|
4651
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4652
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4653
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4654
|
+
* @permissionScope Set Up Automations
|
|
4655
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4656
|
+
* @permissionScope Manage Guest List
|
|
4657
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4658
|
+
* @permissionScope Manage Events
|
|
4659
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4660
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4661
|
+
* @webhook
|
|
4662
|
+
* @eventType wix.events.v3.event_deleted
|
|
4663
|
+
* @slug deleted
|
|
4664
|
+
*/
|
|
4665
|
+
declare function onEventDeleted(handler: (event: EventDeletedEnvelope) => void | Promise<void>): void;
|
|
4458
4666
|
interface EventEndedEnvelope {
|
|
4459
4667
|
data: EventEventEnded;
|
|
4460
4668
|
metadata: EventMetadata;
|
|
4461
4669
|
}
|
|
4670
|
+
/**
|
|
4671
|
+
* Triggered when event has ended.
|
|
4672
|
+
* @permissionScope Manage Stores
|
|
4673
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4674
|
+
* @permissionScope Read Events - all read permissions
|
|
4675
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4676
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4677
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4678
|
+
* @permissionScope Manage Events - all permissions
|
|
4679
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4680
|
+
* @permissionScope Manage Events
|
|
4681
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4682
|
+
* @permissionScope Read Events
|
|
4683
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4684
|
+
* @permissionScope Manage Challenges
|
|
4685
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4686
|
+
* @permissionScope Manage Portfolio
|
|
4687
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4688
|
+
* @permissionScope Manage Blog
|
|
4689
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4690
|
+
* @permissionScope Access Verticals by Automations
|
|
4691
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4692
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4693
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4694
|
+
* @permissionScope Set Up Automations
|
|
4695
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4696
|
+
* @permissionScope Manage Guest List
|
|
4697
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4698
|
+
* @permissionScope Manage Events
|
|
4699
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4700
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4701
|
+
* @webhook
|
|
4702
|
+
* @eventType wix.events.v3.event_ended
|
|
4703
|
+
* @slug ended
|
|
4704
|
+
*/
|
|
4705
|
+
declare function onEventEnded(handler: (event: EventEndedEnvelope) => void | Promise<void>): void;
|
|
4462
4706
|
interface EventPublishedEnvelope {
|
|
4463
4707
|
data: EventEventPublished;
|
|
4464
4708
|
metadata: EventMetadata;
|
|
4465
4709
|
}
|
|
4710
|
+
/**
|
|
4711
|
+
* Triggered when event is published.
|
|
4712
|
+
* @permissionScope Manage Stores
|
|
4713
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4714
|
+
* @permissionScope Read Events - all read permissions
|
|
4715
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4716
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4717
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4718
|
+
* @permissionScope Manage Events - all permissions
|
|
4719
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4720
|
+
* @permissionScope Manage Events
|
|
4721
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4722
|
+
* @permissionScope Read Events
|
|
4723
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4724
|
+
* @permissionScope Manage Challenges
|
|
4725
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4726
|
+
* @permissionScope Manage Portfolio
|
|
4727
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4728
|
+
* @permissionScope Manage Blog
|
|
4729
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4730
|
+
* @permissionScope Access Verticals by Automations
|
|
4731
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4732
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4733
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4734
|
+
* @permissionScope Set Up Automations
|
|
4735
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4736
|
+
* @permissionScope Manage Guest List
|
|
4737
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4738
|
+
* @permissionScope Manage Events
|
|
4739
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4740
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4741
|
+
* @webhook
|
|
4742
|
+
* @eventType wix.events.v3.event_published
|
|
4743
|
+
* @slug published
|
|
4744
|
+
*/
|
|
4745
|
+
declare function onEventPublished(handler: (event: EventPublishedEnvelope) => void | Promise<void>): void;
|
|
4466
4746
|
interface EventReminderEnvelope {
|
|
4467
4747
|
data: EventEventReminder;
|
|
4468
4748
|
metadata: EventMetadata;
|
|
4469
4749
|
}
|
|
4750
|
+
/**
|
|
4751
|
+
* Triggered when a certain amount of time is left until the event. In total there are 6 reminders:
|
|
4752
|
+
* - 7 days
|
|
4753
|
+
* - 3 days
|
|
4754
|
+
* - 1 day
|
|
4755
|
+
* - 2 hours
|
|
4756
|
+
* - 1 hour
|
|
4757
|
+
* - 30 minutes
|
|
4758
|
+
* @permissionScope Manage Stores
|
|
4759
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4760
|
+
* @permissionScope Read Events - all read permissions
|
|
4761
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4762
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4763
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4764
|
+
* @permissionScope Manage Events - all permissions
|
|
4765
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4766
|
+
* @permissionScope Manage Events
|
|
4767
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4768
|
+
* @permissionScope Read Events
|
|
4769
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4770
|
+
* @permissionScope Manage Challenges
|
|
4771
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4772
|
+
* @permissionScope Manage Portfolio
|
|
4773
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4774
|
+
* @permissionScope Manage Blog
|
|
4775
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4776
|
+
* @permissionScope Access Verticals by Automations
|
|
4777
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4778
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4779
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4780
|
+
* @permissionScope Set Up Automations
|
|
4781
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4782
|
+
* @permissionScope Manage Guest List
|
|
4783
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4784
|
+
* @permissionScope Manage Events
|
|
4785
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4786
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4787
|
+
* @webhook
|
|
4788
|
+
* @eventType wix.events.v3.event_reminder
|
|
4789
|
+
* @slug reminder
|
|
4790
|
+
*/
|
|
4791
|
+
declare function onEventReminder(handler: (event: EventReminderEnvelope) => void | Promise<void>): void;
|
|
4470
4792
|
interface EventStartedEnvelope {
|
|
4471
4793
|
data: EventEventStarted;
|
|
4472
4794
|
metadata: EventMetadata;
|
|
4473
4795
|
}
|
|
4796
|
+
/**
|
|
4797
|
+
* Triggered when event has started.
|
|
4798
|
+
* @permissionScope Manage Stores
|
|
4799
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4800
|
+
* @permissionScope Read Events - all read permissions
|
|
4801
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4802
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4803
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4804
|
+
* @permissionScope Manage Events - all permissions
|
|
4805
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4806
|
+
* @permissionScope Manage Events
|
|
4807
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4808
|
+
* @permissionScope Read Events
|
|
4809
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4810
|
+
* @permissionScope Manage Challenges
|
|
4811
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4812
|
+
* @permissionScope Manage Portfolio
|
|
4813
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4814
|
+
* @permissionScope Manage Blog
|
|
4815
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4816
|
+
* @permissionScope Access Verticals by Automations
|
|
4817
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4818
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4819
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4820
|
+
* @permissionScope Set Up Automations
|
|
4821
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4822
|
+
* @permissionScope Manage Guest List
|
|
4823
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4824
|
+
* @permissionScope Manage Events
|
|
4825
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4826
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4827
|
+
* @webhook
|
|
4828
|
+
* @eventType wix.events.v3.event_started
|
|
4829
|
+
* @slug started
|
|
4830
|
+
*/
|
|
4831
|
+
declare function onEventStarted(handler: (event: EventStartedEnvelope) => void | Promise<void>): void;
|
|
4474
4832
|
interface EventUpdatedEnvelope {
|
|
4475
4833
|
entity: V3Event;
|
|
4476
4834
|
metadata: EventMetadata;
|
|
4477
4835
|
}
|
|
4836
|
+
/**
|
|
4837
|
+
* Triggered when event is updated.
|
|
4838
|
+
* @permissionScope Manage Stores
|
|
4839
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4840
|
+
* @permissionScope Read Events - all read permissions
|
|
4841
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4842
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4843
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4844
|
+
* @permissionScope Manage Events - all permissions
|
|
4845
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4846
|
+
* @permissionScope Manage Events
|
|
4847
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4848
|
+
* @permissionScope Read Events
|
|
4849
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4850
|
+
* @permissionScope Manage Challenges
|
|
4851
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4852
|
+
* @permissionScope Manage Portfolio
|
|
4853
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4854
|
+
* @permissionScope Manage Blog
|
|
4855
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4856
|
+
* @permissionScope Access Verticals by Automations
|
|
4857
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4858
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4859
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4860
|
+
* @permissionScope Set Up Automations
|
|
4861
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4862
|
+
* @permissionScope Manage Guest List
|
|
4863
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4864
|
+
* @permissionScope Manage Events
|
|
4865
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4866
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4867
|
+
* @webhook
|
|
4868
|
+
* @eventType wix.events.v3.event_updated
|
|
4869
|
+
* @slug updated
|
|
4870
|
+
*/
|
|
4871
|
+
declare function onEventUpdated(handler: (event: EventUpdatedEnvelope) => void | Promise<void>): void;
|
|
4872
|
+
type EventNonNullablePaths = `_id` | `location.type` | `location.address.streetAddress.number` | `location.address.streetAddress.name` | `dateAndTimeSettings.recurrenceStatus` | `dateAndTimeSettings.recurringEvents.individualEventDates` | `dateAndTimeSettings.recurringEvents.individualEventDates.${number}.showTimeZone` | `slug` | `status` | `registration.type` | `registration.status` | `registration.rsvp.responseType` | `registration.rsvp.waitlistEnabled` | `registration.tickets.guestsAssignedSeparately` | `registration.tickets.ticketLimitPerOrder` | `registration.tickets.lowestPrice.value` | `registration.tickets.lowestPrice.currency` | `registration.tickets.taxSettings.type` | `registration.allowedGuestTypes` | `registration.initialType` | `registration.registrationPaused` | `registration.registrationDisabled` | `calendarUrls.google` | `calendarUrls.ics` | `form.controls` | `form.controls.${number}.type` | `form.controls.${number}.system` | `form.controls.${number}.name` | `form.controls.${number}.label` | `form.controls.${number}.orderIndex` | `form.controls.${number}._id` | `form.messages.rsvp.rsvpYesOption` | `form.messages.rsvp.rsvpNoOption` | `form.messages.rsvp.positiveMessages.title` | `form.messages.rsvp.positiveMessages.confirmation.title` | `form.messages.rsvp.positiveMessages.confirmation.message` | `form.messages.rsvp.positiveMessages.confirmation.addToCalendarActionLabel` | `form.messages.rsvp.positiveMessages.confirmation.shareActionLabel` | `form.messages.rsvp.negativeMessages.title` | `form.messages.rsvp.negativeMessages.confirmation.title` | `form.messages.rsvp.negativeMessages.confirmation.shareActionLabel` | `form.messages.rsvp.submitActionLabel` | `form.messages.checkout.title` | `form.messages.checkout.submitActionLabel` | `form.messages.checkout.confirmation.title` | `form.messages.checkout.confirmation.message` | `form.messages.checkout.confirmation.downloadTicketsLabel` | `form.messages.checkout.confirmation.addToCalendarLabel` | `form.messages.checkout.confirmation.shareEventLabel` | `form.messages.registrationClosed.message` | `form.messages.registrationClosed.exploreEventsActionLabel` | `form.messages.ticketsUnavailable.message` | `form.messages.ticketsUnavailable.exploreEventsActionLabel` | `summaries.rsvps.totalCount` | `summaries.rsvps.yesCount` | `summaries.rsvps.noCount` | `summaries.rsvps.waitlistCount` | `summaries.tickets.ticketsSold` | `summaries.tickets.revenue.amount` | `summaries.tickets.revenue.currency` | `summaries.tickets.currencyLocked` | `summaries.tickets.totalOrders` | `instanceId` | `guestListSettings.displayedPublicly` | `userId` | `onlineConferencing.enabled` | `onlineConferencing.type` | `onlineConferencing.session.hostLink` | `onlineConferencing.session.guestLink` | `seoSettings.slug` | `seoSettings.advancedSeoData.tags` | `seoSettings.advancedSeoData.tags.${number}.type` | `seoSettings.advancedSeoData.tags.${number}.children` | `seoSettings.advancedSeoData.tags.${number}.custom` | `seoSettings.advancedSeoData.tags.${number}.disabled` | `seoSettings.advancedSeoData.settings.preventAutoRedirect` | `seoSettings.advancedSeoData.settings.keywords` | `seoSettings.advancedSeoData.settings.keywords.${number}.term` | `seoSettings.advancedSeoData.settings.keywords.${number}.isMain` | `agendaSettings.enabled`;
|
|
4873
|
+
/**
|
|
4874
|
+
* Creates an event.
|
|
4875
|
+
*
|
|
4876
|
+
*
|
|
4877
|
+
* 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.
|
|
4878
|
+
*
|
|
4879
|
+
* You can create the event as a draft by setting the draft value to true. Otherwise, the event is published right away.
|
|
4880
|
+
*
|
|
4881
|
+
* The event is automatically set up to send daily summary reports of new guests to your business email.
|
|
4882
|
+
* @param event - Event data.
|
|
4883
|
+
* @public
|
|
4884
|
+
* @requiredField event
|
|
4885
|
+
* @requiredField event.dateAndTimeSettings
|
|
4886
|
+
* @requiredField event.location
|
|
4887
|
+
* @requiredField event.registration.initialType
|
|
4888
|
+
* @requiredField event.title
|
|
4889
|
+
* @param options - Optional fields.
|
|
4890
|
+
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
4891
|
+
* @applicableIdentity APP
|
|
4892
|
+
* @returns Created event.
|
|
4893
|
+
* @fqn wix.events.events.v3.EventManagement.CreateEvent
|
|
4894
|
+
*/
|
|
4895
|
+
declare function createEvent(event: NonNullablePaths<V3Event, `dateAndTimeSettings` | `location` | `registration.initialType` | `title`>, options?: CreateEventOptions): Promise<NonNullablePaths<V3Event, EventNonNullablePaths> & {
|
|
4896
|
+
__applicationErrorsType?: CreateEventApplicationErrors;
|
|
4897
|
+
__validationErrorsType?: CreateEventValidationErrors;
|
|
4898
|
+
}>;
|
|
4478
4899
|
interface CreateEventOptions {
|
|
4479
4900
|
/** Whether to create the event as a draft. */
|
|
4480
4901
|
draft?: boolean;
|
|
@@ -4484,6 +4905,23 @@ interface CreateEventOptions {
|
|
|
4484
4905
|
*/
|
|
4485
4906
|
fields?: RequestedFieldsWithLiterals[];
|
|
4486
4907
|
}
|
|
4908
|
+
/**
|
|
4909
|
+
* Clones an event, including the registration form, notifications, multilingual translations and ticket configuration from the original event.
|
|
4910
|
+
*
|
|
4911
|
+
*
|
|
4912
|
+
* The new event's date is automatically set to 14 days from the original event date.
|
|
4913
|
+
* 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.
|
|
4914
|
+
* @param eventId - Event ID.
|
|
4915
|
+
* @public
|
|
4916
|
+
* @requiredField eventId
|
|
4917
|
+
* @param options - Optional fields.
|
|
4918
|
+
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
4919
|
+
* @applicableIdentity APP
|
|
4920
|
+
* @fqn wix.events.events.v3.EventManagement.CloneEvent
|
|
4921
|
+
*/
|
|
4922
|
+
declare function cloneEvent(eventId: string, options?: CloneEventOptions): Promise<NonNullablePaths<CloneEventResponse, {
|
|
4923
|
+
[P in EventNonNullablePaths]: `event.${P}`;
|
|
4924
|
+
}[EventNonNullablePaths]>>;
|
|
4487
4925
|
interface CloneEventOptions {
|
|
4488
4926
|
/** Field values to be changed when cloning the event. */
|
|
4489
4927
|
event?: V3Event;
|
|
@@ -4495,6 +4933,21 @@ interface CloneEventOptions {
|
|
|
4495
4933
|
*/
|
|
4496
4934
|
fields?: RequestedFieldsWithLiterals[];
|
|
4497
4935
|
}
|
|
4936
|
+
/**
|
|
4937
|
+
* Updates an event.
|
|
4938
|
+
* @param _id - Event ID.
|
|
4939
|
+
* @public
|
|
4940
|
+
* @requiredField _id
|
|
4941
|
+
* @param options - Optional fields.
|
|
4942
|
+
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
4943
|
+
* @applicableIdentity APP
|
|
4944
|
+
* @returns Updated event.
|
|
4945
|
+
* @fqn wix.events.events.v3.EventManagement.UpdateEvent
|
|
4946
|
+
*/
|
|
4947
|
+
declare function updateEvent(_id: string, options?: UpdateEventOptions): Promise<NonNullablePaths<V3Event, EventNonNullablePaths> & {
|
|
4948
|
+
__applicationErrorsType?: UpdateEventApplicationErrors;
|
|
4949
|
+
__validationErrorsType?: UpdateEventValidationErrors;
|
|
4950
|
+
}>;
|
|
4498
4951
|
interface UpdateEventOptions {
|
|
4499
4952
|
/** Event to update. */
|
|
4500
4953
|
event: {
|
|
@@ -4639,6 +5092,24 @@ interface UpdateEventOptions {
|
|
|
4639
5092
|
*/
|
|
4640
5093
|
fields?: RequestedFieldsWithLiterals[];
|
|
4641
5094
|
}
|
|
5095
|
+
/**
|
|
5096
|
+
* Publishes a draft event to your live site. Once published, the event's status changes from `DRAFT` to `UPCOMING.`
|
|
5097
|
+
*
|
|
5098
|
+
*
|
|
5099
|
+
* It's impossible to revert the `DRAFT` status after publishing. The only option is to clone the event, and then delete the original one.
|
|
5100
|
+
* @param eventId - Event ID.
|
|
5101
|
+
* @public
|
|
5102
|
+
* @requiredField eventId
|
|
5103
|
+
* @param options - Optional fields.
|
|
5104
|
+
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
5105
|
+
* @applicableIdentity APP
|
|
5106
|
+
* @fqn wix.events.events.v3.EventManagement.PublishDraftEvent
|
|
5107
|
+
*/
|
|
5108
|
+
declare function publishDraftEvent(eventId: string, options?: PublishDraftEventOptions): Promise<NonNullablePaths<PublishDraftEventResponse, {
|
|
5109
|
+
[P in EventNonNullablePaths]: `event.${P}`;
|
|
5110
|
+
}[EventNonNullablePaths]> & {
|
|
5111
|
+
__applicationErrorsType?: PublishDraftEventApplicationErrors;
|
|
5112
|
+
}>;
|
|
4642
5113
|
interface PublishDraftEventOptions {
|
|
4643
5114
|
/**
|
|
4644
5115
|
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
@@ -4646,6 +5117,25 @@ interface PublishDraftEventOptions {
|
|
|
4646
5117
|
*/
|
|
4647
5118
|
fields?: RequestedFieldsWithLiterals[];
|
|
4648
5119
|
}
|
|
5120
|
+
/**
|
|
5121
|
+
* Cancels an event.
|
|
5122
|
+
*
|
|
5123
|
+
*
|
|
5124
|
+
* 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.
|
|
5125
|
+
* If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
|
|
5126
|
+
* @param eventId - Event ID.
|
|
5127
|
+
* @public
|
|
5128
|
+
* @requiredField eventId
|
|
5129
|
+
* @param options - Optional fields.
|
|
5130
|
+
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
5131
|
+
* @applicableIdentity APP
|
|
5132
|
+
* @fqn wix.events.events.v3.EventManagement.CancelEvent
|
|
5133
|
+
*/
|
|
5134
|
+
declare function cancelEvent(eventId: string, options?: CancelEventOptions): Promise<NonNullablePaths<CancelEventResponse, {
|
|
5135
|
+
[P in EventNonNullablePaths]: `event.${P}`;
|
|
5136
|
+
}[EventNonNullablePaths]> & {
|
|
5137
|
+
__applicationErrorsType?: CancelEventApplicationErrors;
|
|
5138
|
+
}>;
|
|
4649
5139
|
interface CancelEventOptions {
|
|
4650
5140
|
/**
|
|
4651
5141
|
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
@@ -4653,14 +5143,77 @@ interface CancelEventOptions {
|
|
|
4653
5143
|
*/
|
|
4654
5144
|
fields?: RequestedFieldsWithLiterals[];
|
|
4655
5145
|
}
|
|
5146
|
+
/**
|
|
5147
|
+
* Cancels multiple events that meet the given criteria.
|
|
5148
|
+
*
|
|
5149
|
+
*
|
|
5150
|
+
* 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.
|
|
5151
|
+
* If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
|
|
5152
|
+
* @public
|
|
5153
|
+
* @requiredField options.filter.filter
|
|
5154
|
+
* @param options - Optional fields.
|
|
5155
|
+
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
5156
|
+
* @applicableIdentity APP
|
|
5157
|
+
* @fqn wix.events.events.v3.EventManagement.BulkCancelEventsByFilter
|
|
5158
|
+
*/
|
|
5159
|
+
declare function bulkCancelEventsByFilter(options?: NonNullablePaths<BulkCancelEventsByFilterOptions, `filter.filter`>): Promise<void>;
|
|
4656
5160
|
interface BulkCancelEventsByFilterOptions {
|
|
4657
5161
|
/** Filter. */
|
|
4658
5162
|
filter?: CommonQueryV2;
|
|
4659
5163
|
}
|
|
5164
|
+
/**
|
|
5165
|
+
* Permanently deletes an event. <br> <br>
|
|
5166
|
+
* You can retrieve the deleted event through a GDPR access request.
|
|
5167
|
+
* @param eventId - Event ID.
|
|
5168
|
+
* @public
|
|
5169
|
+
* @requiredField eventId
|
|
5170
|
+
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
5171
|
+
* @applicableIdentity APP
|
|
5172
|
+
* @fqn wix.events.events.v3.EventManagement.DeleteEvent
|
|
5173
|
+
*/
|
|
5174
|
+
declare function deleteEvent(eventId: string): Promise<NonNullablePaths<DeleteEventResponse, `eventId`>>;
|
|
5175
|
+
/**
|
|
5176
|
+
* Permanently deletes multiple events that meet the given criteria.
|
|
5177
|
+
*
|
|
5178
|
+
*
|
|
5179
|
+
* You can retrieve the deleted events through a GDPR access request.
|
|
5180
|
+
* @public
|
|
5181
|
+
* @requiredField options.filter.filter
|
|
5182
|
+
* @param options - Optional fields.
|
|
5183
|
+
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
5184
|
+
* @applicableIdentity APP
|
|
5185
|
+
* @fqn wix.events.events.v3.EventManagement.BulkDeleteEventsByFilter
|
|
5186
|
+
*/
|
|
5187
|
+
declare function bulkDeleteEventsByFilter(options?: NonNullablePaths<BulkDeleteEventsByFilterOptions, `filter.filter`>): Promise<void>;
|
|
4660
5188
|
interface BulkDeleteEventsByFilterOptions {
|
|
4661
5189
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
4662
5190
|
filter?: CommonQueryV2;
|
|
4663
5191
|
}
|
|
5192
|
+
/**
|
|
5193
|
+
* Creates a query to retrieve a list of events.
|
|
5194
|
+
*
|
|
5195
|
+
*
|
|
5196
|
+
* 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.
|
|
5197
|
+
*
|
|
5198
|
+
* 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.
|
|
5199
|
+
*
|
|
5200
|
+
* 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.
|
|
5201
|
+
*
|
|
5202
|
+
* `queryEvents()` runs with these `EventsQueryBuilder` defaults, which you can override:
|
|
5203
|
+
*
|
|
5204
|
+
* - [`skip(0)`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/skip)
|
|
5205
|
+
* - [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/limit)
|
|
5206
|
+
* - [`descending("_createdDate")`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/descending)
|
|
5207
|
+
*
|
|
5208
|
+
* 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`.
|
|
5209
|
+
* @public
|
|
5210
|
+
* @param options - Optional fields.
|
|
5211
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
5212
|
+
* @applicableIdentity APP
|
|
5213
|
+
* @applicableIdentity VISITOR
|
|
5214
|
+
* @fqn wix.events.events.v3.EventManagement.QueryEvents
|
|
5215
|
+
*/
|
|
5216
|
+
declare function queryEvents(options?: QueryEventsOptions): EventsQueryBuilder;
|
|
4664
5217
|
interface QueryEventsOptions {
|
|
4665
5218
|
/**
|
|
4666
5219
|
* Predefined sets of fields to return.
|
|
@@ -4724,6 +5277,18 @@ interface EventsQueryBuilder {
|
|
|
4724
5277
|
skip: (skip: number) => EventsQueryBuilder;
|
|
4725
5278
|
find: () => Promise<EventsQueryResult>;
|
|
4726
5279
|
}
|
|
5280
|
+
/**
|
|
5281
|
+
* Counts events by status.
|
|
5282
|
+
* @public
|
|
5283
|
+
* @param options - Optional fields.
|
|
5284
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
5285
|
+
* @applicableIdentity APP
|
|
5286
|
+
* @applicableIdentity VISITOR
|
|
5287
|
+
* @fqn wix.events.events.v3.EventManagement.CountEventsByStatus
|
|
5288
|
+
*/
|
|
5289
|
+
declare function countEventsByStatus(options?: CountEventsByStatusOptions): Promise<CountEventsByStatusResponse & {
|
|
5290
|
+
__applicationErrorsType?: CountEventsByStatusApplicationErrors;
|
|
5291
|
+
}>;
|
|
4727
5292
|
interface CountEventsByStatusOptions {
|
|
4728
5293
|
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
4729
5294
|
filter?: Record<string, any> | null;
|
|
@@ -4739,6 +5304,19 @@ interface CountEventsByStatusOptions {
|
|
|
4739
5304
|
*/
|
|
4740
5305
|
includeDrafts?: boolean;
|
|
4741
5306
|
}
|
|
5307
|
+
/**
|
|
5308
|
+
* Retrieves an event by ID.
|
|
5309
|
+
* @param eventId - Event ID.
|
|
5310
|
+
* @public
|
|
5311
|
+
* @requiredField eventId
|
|
5312
|
+
* @param options - Optional fields.
|
|
5313
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
5314
|
+
* @applicableIdentity APP
|
|
5315
|
+
* @applicableIdentity VISITOR
|
|
5316
|
+
* @returns Event.
|
|
5317
|
+
* @fqn wix.events.events.v3.EventManagement.GetEvent
|
|
5318
|
+
*/
|
|
5319
|
+
declare function getEvent(eventId: string, options?: GetEventOptions): Promise<NonNullablePaths<V3Event, EventNonNullablePaths>>;
|
|
4742
5320
|
interface GetEventOptions {
|
|
4743
5321
|
/**
|
|
4744
5322
|
* Predefined sets of fields to return.
|
|
@@ -4746,9 +5324,26 @@ interface GetEventOptions {
|
|
|
4746
5324
|
*/
|
|
4747
5325
|
fields?: RequestedFieldsWithLiterals[];
|
|
4748
5326
|
}
|
|
5327
|
+
/**
|
|
5328
|
+
* Retrieves an event by the `slug` URL.
|
|
5329
|
+
*
|
|
5330
|
+
*
|
|
5331
|
+
* 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`.
|
|
5332
|
+
* @param slug - URL slug.
|
|
5333
|
+
* @public
|
|
5334
|
+
* @requiredField slug
|
|
5335
|
+
* @param options - Optional fields.
|
|
5336
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
5337
|
+
* @applicableIdentity APP
|
|
5338
|
+
* @applicableIdentity VISITOR
|
|
5339
|
+
* @fqn wix.events.events.v3.EventManagement.GetEventBySlug
|
|
5340
|
+
*/
|
|
5341
|
+
declare function getEventBySlug(slug: string, options?: GetEventBySlugOptions): Promise<NonNullablePaths<GetEventBySlugResponse, {
|
|
5342
|
+
[P in EventNonNullablePaths]: `event.${P}`;
|
|
5343
|
+
}[EventNonNullablePaths]>>;
|
|
4749
5344
|
interface GetEventBySlugOptions {
|
|
4750
5345
|
/** @maxSize 20 */
|
|
4751
5346
|
fields?: RequestedFieldsWithLiterals[];
|
|
4752
5347
|
}
|
|
4753
5348
|
|
|
4754
|
-
export {
|
|
5349
|
+
export { type ActionEvent, type Address, type AddressLocation, type AddressStreetOneOf, type Agenda, type AgendaSettings, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, BackgroundType, type BackgroundTypeWithLiterals, type Badge, type BadgeList, BadgeTypeType, type BadgeTypeTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BookingData, type Border, type BorderColors, type BulkCancelEventsByFilterOptions, type BulkCancelEventsByFilterRequest, type BulkCancelEventsByFilterResponse, type BulkDeleteEventsByFilterOptions, type BulkDeleteEventsByFilterRequest, type BulkDeleteEventsByFilterResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type CalendarLinks, type CalendarUrls, type CancelEventApplicationErrors, type CancelEventOptions, type CancelEventRequest, type CancelEventResponse, type CaptionData, type Category, type CategoryCounts, CategoryTypeType, type CategoryTypeTypeWithLiterals, type CellStyle, type CheckoutFormMessages, type CloneEventFromOtherSiteRequest, type CloneEventFromOtherSiteResponse, type CloneEventOptions, type CloneEventRequest, type CloneEventResponse, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CommonAddress, type CommonAddressLocation, type CommonAddressStreetOneOf, type CommonCursors, type CommonPaging, type CommonPagingMetadataV2, type CommonQueryV2, type CommonQueryV2PagingMethodOneOf, CommonSortOrder, type CommonSortOrderWithLiterals, type CommonSorting, type CommonStreetAddress, type CommonSubdivision, ConferenceType, ConferenceTypeType, type ConferenceTypeTypeWithLiterals, type ConferenceTypeWithLiterals, type CountEventsByStatusApplicationErrors, type CountEventsByStatusOptions, type CountEventsByStatusRequest, type CountEventsByStatusResponse, type CreateEventApplicationErrors, type CreateEventOptions, type CreateEventRequest, type CreateEventResponse, type CreateEventValidationErrors, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Dashboard, type DateAndTimeSettings, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeleteEventRequest, type DeleteEventResponse, type Design, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type Event, type EventCanceled, type EventCanceledEnvelope, type EventCategories, type EventCategory, type EventCloned, type EventClonedEnvelope, type EventCopied, type EventCreated, type EventCreatedEnvelope, type EventData, type EventDeleted, type EventDeletedEnvelope, type EventDisplaySettings, type EventEnded, type EventEndedEnvelope, type EventEventCanceled, type EventEventEnded, type EventEventPublished, type EventEventReminder, type EventEventStarted, type EventMetadata, type EventPublished, type EventPublishedEnvelope, type EventReminder, type EventReminderEnvelope, type EventStarted, type EventStartedEnvelope, EventStatus, type EventStatusWithLiterals, EventType, type EventTypeWithLiterals, type EventUpdated, type EventUpdatedEnvelope, type EventsFeed, type EventsLabellingSettings, type EventsLocation, type EventsMoney, type EventsOccurrence, type EventsOnlineConferencing, type EventsOnlineConferencingSession, type EventsQueryBuilder, type EventsQueryResult, EventsRecurrenceStatusStatus, type EventsRecurrenceStatusStatusWithLiterals, type EventsRecurrences, type EventsRegistration, type EventsSeoSettings, EventsTaxType, type EventsTaxTypeWithLiterals, type ExportEventsRequest, type ExportEventsResponse, type ExternalEvent, type ExternalRegistration, type FacetCounts, type Feed, type FileData, type FileSource, type FileSourceDataOneOf, type FindEventRequest, type FindEventRequestFindByOneOf, type FindEventResponse, type FontSizeData, FontType, type FontTypeWithLiterals, type Form, type FormMessages, type Formatted, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GetEventBySlugOptions, type GetEventBySlugRequest, type GetEventBySlugResponse, type GetEventOptions, type GetEventRequest, type GetEventResponse, type Gradient, type GuestListConfig, type GuestListSettings, GuestTypeType, type GuestTypeTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, InitialRegistrationTypeType, type InitialRegistrationTypeTypeWithLiterals, type Input, type InputControl, InputControlType, type InputControlTypeWithLiterals, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, type Label, type LabellingSettings, type Layout, type LayoutCellData, LayoutType, type LayoutTypeWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListEventsByCategoryRequest, type ListEventsByCategoryResponse, type ListUserEventsRequest, type ListUserEventsResponse, type ListValue, type Location, LocationLocationType, type LocationLocationTypeWithLiterals, LocationType, type LocationTypeWithLiterals, type MapCoordinates, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MentionData, type MessageEnvelope, type Metadata, type Money, type Negative, type NegativeResponseConfirmation, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Occurrence, type Oembed, type OnlineConferencing, type OnlineConferencingConfig, type OnlineConferencingSession, type Option, type OptionDesign, type OptionLayout, type OptionSelection, type OptionSelectionSelectedOptionOneOf, type OrderedListData, Orientation, type OrientationWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type Permissions, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Positive, type PositiveResponseConfirmation, type PublishDraftEventApplicationErrors, type PublishDraftEventOptions, type PublishDraftEventRequest, type PublishDraftEventResponse, type QueryEventsApplicationErrors, type QueryEventsOptions, type QueryEventsRequest, type QueryEventsResponse, type QueryV2, type QueryV2PagingMethodOneOf, RecurrenceStatusStatus, type RecurrenceStatusStatusWithLiterals, type Recurrences, type Registration, type RegistrationClosedMessages, RegistrationStatus, RegistrationStatusStatus, type RegistrationStatusStatusWithLiterals, type RegistrationStatusWithLiterals, RegistrationTypeType, type RegistrationTypeTypeWithLiterals, type Rel, Relation, type RelationWithLiterals, RequestedFields, type RequestedFieldsWithLiterals, type ResponseConfirmation, ResponseType, type ResponseTypeWithLiterals, type RestoreInfo, type RichContent, type RsvpCollection, type RsvpCollectionConfig, type RsvpFormMessages, type RsvpRegistration, RsvpStatusOptions, type RsvpStatusOptionsWithLiterals, type RsvpSummary, type Rsvps, type ScheduleConfig, type Scheduling, type SeoSchema, type SeoSettings, type Settings, type SiteUrl, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, State, type StateWithLiterals, Status, type StatusWithLiterals, type StreetAddress, type Styles, type StylesBorder, type Subdivision, SubdivisionSubdivisionType, type SubdivisionSubdivisionTypeWithLiterals, SubdivisionType, type SubdivisionTypeWithLiterals, type Summaries, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, type TaxConfig, type TaxSettings, TaxType, type TaxTypeWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type Ticketing, type TicketingConfig, type TicketingSummary, type Tickets, type TicketsRegistration, type TicketsUnavailableMessages, type TimeDuration, Type, type TypeWithLiterals, type UpdateEventApplicationErrors, type UpdateEventOptions, type UpdateEventRequest, type UpdateEventResponse, type UpdateEventValidationErrors, type UserFilter, type V3Badge, type V3Event, type V3EventDisplaySettings, ValueType, type ValueTypeWithLiterals, VerticalAlignment, type VerticalAlignmentWithLiterals, type Video, type VideoData, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VisitorType, type VisitorTypeWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, bulkCancelEventsByFilter, bulkDeleteEventsByFilter, cancelEvent, cloneEvent, countEventsByStatus, createEvent, deleteEvent, getEvent, getEventBySlug, onEventCanceled, onEventCloned, onEventCreated, onEventDeleted, onEventEnded, onEventPublished, onEventReminder, onEventStarted, onEventUpdated, publishDraftEvent, queryEvents, updateEvent };
|