@wix/auto_sdk_events_ticket-definitions 1.0.21 → 1.0.23
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 +2 -2
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/{events-v1-ticket-definition-ticket-definitions.universal-Du5H8LGx.d.ts → index.typings.d.ts} +256 -5
- package/build/cjs/index.typings.js +966 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +6 -5
- package/build/es/index.d.mts +2 -2
- package/build/es/index.mjs.map +1 -1
- package/build/es/{events-v1-ticket-definition-ticket-definitions.universal-Du5H8LGx.d.mts → index.typings.d.mts} +256 -5
- package/build/es/index.typings.mjs +926 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +6 -5
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/{events-v1-ticket-definition-ticket-definitions.universal-D0E9Jwus.d.ts → index.typings.d.ts} +256 -5
- package/build/internal/cjs/index.typings.js +966 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +6 -5
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/{events-v1-ticket-definition-ticket-definitions.universal-D0E9Jwus.d.mts → index.typings.d.mts} +256 -5
- package/build/internal/es/index.typings.mjs +926 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +6 -5
- package/package.json +3 -3
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
interface TicketDefinition {
|
|
2
4
|
/**
|
|
3
5
|
* Ticket definition ID.
|
|
@@ -236,20 +238,20 @@ interface QueryTicketDefinitionsV2Request {
|
|
|
236
238
|
query?: QueryV2;
|
|
237
239
|
}
|
|
238
240
|
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
239
|
-
/** Paging options to limit and
|
|
241
|
+
/** Paging options to limit and offset the number of items. */
|
|
240
242
|
paging?: Paging;
|
|
241
243
|
/** 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`. */
|
|
242
244
|
cursorPaging?: CursorPaging;
|
|
243
245
|
/**
|
|
244
246
|
* Filter object.
|
|
245
247
|
*
|
|
246
|
-
* Learn more about
|
|
248
|
+
* Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
|
|
247
249
|
*/
|
|
248
250
|
filter?: Record<string, any> | null;
|
|
249
251
|
/**
|
|
250
252
|
* Sort object.
|
|
251
253
|
*
|
|
252
|
-
* Learn more about
|
|
254
|
+
* Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
|
|
253
255
|
*/
|
|
254
256
|
sort?: Sorting[];
|
|
255
257
|
/** 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. */
|
|
@@ -259,7 +261,7 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
259
261
|
}
|
|
260
262
|
/** @oneof */
|
|
261
263
|
interface QueryV2PagingMethodOneOf {
|
|
262
|
-
/** Paging options to limit and
|
|
264
|
+
/** Paging options to limit and offset the number of items. */
|
|
263
265
|
paging?: Paging;
|
|
264
266
|
/** 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`. */
|
|
265
267
|
cursorPaging?: CursorPaging;
|
|
@@ -408,6 +410,8 @@ declare enum GroupBy {
|
|
|
408
410
|
/** Groups by event created date with ascending sorting. */
|
|
409
411
|
EVENT_CREATED_ASC = "EVENT_CREATED_ASC"
|
|
410
412
|
}
|
|
413
|
+
/** @enumType */
|
|
414
|
+
type GroupByWithLiterals = GroupBy | 'NONE' | 'EVENT_CREATED_DESC' | 'EVENT_CREATED_ASC';
|
|
411
415
|
interface ListTicketDefinitionsResponse {
|
|
412
416
|
/** Meta data. */
|
|
413
417
|
metaData?: ResponseMetaData;
|
|
@@ -739,14 +743,83 @@ interface TicketDefinitionCreatedEnvelope {
|
|
|
739
743
|
data: TicketDefinitionCreated;
|
|
740
744
|
metadata: BaseEventMetadata;
|
|
741
745
|
}
|
|
746
|
+
/** @permissionScope Manage Events - all permissions
|
|
747
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
748
|
+
* @permissionScope Manage Events
|
|
749
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
750
|
+
* @permissionScope Manage Orders
|
|
751
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
752
|
+
* @permissionScope Manage Ticket Definitions
|
|
753
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
754
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
755
|
+
* @webhook
|
|
756
|
+
* @eventType wix.events.ticketing.events.TicketDefinitionCreated
|
|
757
|
+
* @serviceIdentifier wix.events.ticketing.TicketDefinitionManagement
|
|
758
|
+
* @slug ticket_definition_created
|
|
759
|
+
*/
|
|
760
|
+
declare function onTicketDefinitionCreated(handler: (event: TicketDefinitionCreatedEnvelope) => void | Promise<void>): void;
|
|
742
761
|
interface TicketDefinitionDeletedEnvelope {
|
|
743
762
|
data: TicketDefinitionDeleted;
|
|
744
763
|
metadata: BaseEventMetadata;
|
|
745
764
|
}
|
|
765
|
+
/** @permissionScope Manage Events - all permissions
|
|
766
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
767
|
+
* @permissionScope Manage Events
|
|
768
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
769
|
+
* @permissionScope Manage Orders
|
|
770
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
771
|
+
* @permissionScope Manage Ticket Definitions
|
|
772
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
773
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
774
|
+
* @webhook
|
|
775
|
+
* @eventType wix.events.ticketing.events.TicketDefinitionDeleted
|
|
776
|
+
* @serviceIdentifier wix.events.ticketing.TicketDefinitionManagement
|
|
777
|
+
* @slug ticket_definition_deleted
|
|
778
|
+
*/
|
|
779
|
+
declare function onTicketDefinitionDeleted(handler: (event: TicketDefinitionDeletedEnvelope) => void | Promise<void>): void;
|
|
746
780
|
interface TicketDefinitionUpdatedEnvelope {
|
|
747
781
|
data: TicketDefinitionUpdated;
|
|
748
782
|
metadata: BaseEventMetadata;
|
|
749
783
|
}
|
|
784
|
+
/** @permissionScope Manage Events - all permissions
|
|
785
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
786
|
+
* @permissionScope Manage Events
|
|
787
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
788
|
+
* @permissionScope Manage Orders
|
|
789
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
790
|
+
* @permissionScope Manage Ticket Definitions
|
|
791
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
792
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
793
|
+
* @webhook
|
|
794
|
+
* @eventType wix.events.ticketing.events.TicketDefinitionUpdated
|
|
795
|
+
* @serviceIdentifier wix.events.ticketing.TicketDefinitionManagement
|
|
796
|
+
* @slug ticket_definition_updated
|
|
797
|
+
*/
|
|
798
|
+
declare function onTicketDefinitionUpdated(handler: (event: TicketDefinitionUpdatedEnvelope) => void | Promise<void>): void;
|
|
799
|
+
type TicketDefinitionNonNullablePaths = `_id` | `price.amount` | `price.currency` | `free` | `name` | `description` | `limitPerCheckout` | `orderIndex` | `policy` | `dashboard.hidden` | `dashboard.sold` | `dashboard.limited` | `dashboard.ticketsSold` | `dashboard.ticketsReserved` | `eventId` | `wixFeeConfig.type` | `salePeriod.hideNotOnSale` | `saleStatus` | `state` | `pricing.fixedPrice.amount` | `pricing.fixedPrice.currency` | `pricing.pricingOptions.options` | `pricing.pricingType`;
|
|
800
|
+
/**
|
|
801
|
+
* **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.
|
|
802
|
+
* >**Migration Instructions**.
|
|
803
|
+
* > 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).
|
|
804
|
+
* > To migrate to the new function:
|
|
805
|
+
* > 1. Add the new import statement:
|
|
806
|
+
* > ```js
|
|
807
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
808
|
+
* > ```
|
|
809
|
+
* > 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.
|
|
810
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
811
|
+
*
|
|
812
|
+
* Retrieves a list of up to 100 ticket definitions.
|
|
813
|
+
* @public
|
|
814
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
815
|
+
* @applicableIdentity APP
|
|
816
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.QueryTicketDefinitions
|
|
817
|
+
* @deprecated
|
|
818
|
+
* @targetRemovalDate 2024-12-01
|
|
819
|
+
*/
|
|
820
|
+
declare function queryTicketDefinitions(options?: QueryTicketDefinitionsOptions): Promise<NonNullablePaths<QueryTicketDefinitionsResponse, `total` | `offset` | `limit` | {
|
|
821
|
+
[P in TicketDefinitionNonNullablePaths]: `definitions.${number}.${P}`;
|
|
822
|
+
}[TicketDefinitionNonNullablePaths]>>;
|
|
750
823
|
interface QueryTicketDefinitionsOptions {
|
|
751
824
|
/** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
|
|
752
825
|
offset?: number;
|
|
@@ -776,6 +849,28 @@ interface QueryTicketDefinitionsOptions {
|
|
|
776
849
|
*/
|
|
777
850
|
facet?: string[];
|
|
778
851
|
}
|
|
852
|
+
/**
|
|
853
|
+
* **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).
|
|
854
|
+
* >**Migration Instructions**.
|
|
855
|
+
* > 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).
|
|
856
|
+
* > To migrate to the new function:
|
|
857
|
+
* > 1. Add the new import statement:
|
|
858
|
+
* > ```js
|
|
859
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
860
|
+
* > ```
|
|
861
|
+
* > 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.
|
|
862
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
863
|
+
*
|
|
864
|
+
* Retrieves a list of up to 1,000 ticket definitions, given the provided paging and filtering.
|
|
865
|
+
* @public
|
|
866
|
+
* @documentationMaturity preview
|
|
867
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
868
|
+
* @applicableIdentity APP
|
|
869
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.QueryTicketDefinitionsV2
|
|
870
|
+
* @deprecated
|
|
871
|
+
* @targetRemovalDate 2024-12-01
|
|
872
|
+
*/
|
|
873
|
+
declare function queryTicketDefinitionsV2(): DefinitionsQueryBuilder;
|
|
779
874
|
interface QueryCursorResult {
|
|
780
875
|
cursors: Cursors;
|
|
781
876
|
hasNext: () => boolean;
|
|
@@ -801,6 +896,30 @@ interface DefinitionsQueryBuilder {
|
|
|
801
896
|
/** @documentationMaturity preview */
|
|
802
897
|
find: () => Promise<DefinitionsQueryResult>;
|
|
803
898
|
}
|
|
899
|
+
/**
|
|
900
|
+
* **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.
|
|
901
|
+
* >**Migration Instructions**.
|
|
902
|
+
* > 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).
|
|
903
|
+
* > To migrate to the new function:
|
|
904
|
+
* > 1. Add the new import statement:
|
|
905
|
+
* > ```js
|
|
906
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
907
|
+
* > ```
|
|
908
|
+
* > 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.
|
|
909
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
910
|
+
*
|
|
911
|
+
* Retrieves a list of up to 100 ticket definitions, with basic filter support.
|
|
912
|
+
* @public
|
|
913
|
+
* @param options - Details for the tickets to retrieve.
|
|
914
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
915
|
+
* @applicableIdentity APP
|
|
916
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.ListTicketDefinitions
|
|
917
|
+
* @deprecated
|
|
918
|
+
* @targetRemovalDate 2024-12-01
|
|
919
|
+
*/
|
|
920
|
+
declare function listTicketDefinitions(options?: ListTicketDefinitionsOptions): Promise<NonNullablePaths<ListTicketDefinitionsResponse, `metaData.count` | `metaData.offset` | `metaData.total` | {
|
|
921
|
+
[P in TicketDefinitionNonNullablePaths]: `definitions.${number}.${P}`;
|
|
922
|
+
}[TicketDefinitionNonNullablePaths]>>;
|
|
804
923
|
interface ListTicketDefinitionsOptions {
|
|
805
924
|
/**
|
|
806
925
|
* Event ID.
|
|
@@ -864,6 +983,31 @@ interface ListTicketDefinitionsOptions {
|
|
|
864
983
|
*/
|
|
865
984
|
facet?: string[];
|
|
866
985
|
}
|
|
986
|
+
/**
|
|
987
|
+
* **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.
|
|
988
|
+
* >**Migration Instructions**.
|
|
989
|
+
* > 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).
|
|
990
|
+
* > To migrate to the new function:
|
|
991
|
+
* > 1. Add the new import statement:
|
|
992
|
+
* > ```js
|
|
993
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
994
|
+
* > ```
|
|
995
|
+
* > 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.
|
|
996
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
997
|
+
*
|
|
998
|
+
* Retrieves a ticket definition.
|
|
999
|
+
* @param definitionId - Ticket definition ID.
|
|
1000
|
+
* @public
|
|
1001
|
+
* @requiredField definitionId
|
|
1002
|
+
* @param options - Details for the ticket to retrieve.
|
|
1003
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
1004
|
+
* @applicableIdentity APP
|
|
1005
|
+
* @returns Retrieved ticket definition.
|
|
1006
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.GetTicketDefinition
|
|
1007
|
+
* @deprecated
|
|
1008
|
+
* @targetRemovalDate 2024-12-01
|
|
1009
|
+
*/
|
|
1010
|
+
declare function getTicketDefinition(definitionId: string, options?: GetTicketDefinitionOptions): Promise<NonNullablePaths<TicketDefinition, TicketDefinitionNonNullablePaths>>;
|
|
867
1011
|
interface GetTicketDefinitionOptions {
|
|
868
1012
|
/**
|
|
869
1013
|
* Predefined sets of fields to return.
|
|
@@ -875,16 +1019,100 @@ interface GetTicketDefinitionOptions {
|
|
|
875
1019
|
*/
|
|
876
1020
|
fieldset?: TicketDefinitionFieldsetWithLiterals[];
|
|
877
1021
|
}
|
|
1022
|
+
/**
|
|
1023
|
+
* **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.
|
|
1024
|
+
* >**Migration Instructions**.
|
|
1025
|
+
* > 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).
|
|
1026
|
+
* > To migrate to the new function:
|
|
1027
|
+
* > 1. Add the new import statement:
|
|
1028
|
+
* > ```js
|
|
1029
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
1030
|
+
* > ```
|
|
1031
|
+
* > 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.
|
|
1032
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
1033
|
+
*
|
|
1034
|
+
* Creates a ticket definition (and enables ticket sales).
|
|
1035
|
+
* @param eventId - Event ID.
|
|
1036
|
+
* @public
|
|
1037
|
+
* @requiredField eventId
|
|
1038
|
+
* @requiredField options
|
|
1039
|
+
* @requiredField options.definition
|
|
1040
|
+
* @requiredField options.definition.name
|
|
1041
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
1042
|
+
* @applicableIdentity APP
|
|
1043
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.CreateTicketDefinition
|
|
1044
|
+
* @deprecated
|
|
1045
|
+
* @targetRemovalDate 2024-12-01
|
|
1046
|
+
*/
|
|
1047
|
+
declare function createTicketDefinition(eventId: string, options: NonNullablePaths<CreateTicketDefinitionOptions, `definition` | `definition.name`>): Promise<NonNullablePaths<CreateTicketDefinitionResponse, {
|
|
1048
|
+
[P in TicketDefinitionNonNullablePaths]: `definition.${P}`;
|
|
1049
|
+
}[TicketDefinitionNonNullablePaths]>>;
|
|
878
1050
|
interface CreateTicketDefinitionOptions {
|
|
879
1051
|
/** Ticket definition data. */
|
|
880
1052
|
definition: TicketDefinitionData;
|
|
881
1053
|
}
|
|
1054
|
+
/**
|
|
1055
|
+
* **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.
|
|
1056
|
+
* >**Migration Instructions**.
|
|
1057
|
+
* > 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).
|
|
1058
|
+
* > To migrate to the new function:
|
|
1059
|
+
* > 1. Add the new import statement:
|
|
1060
|
+
* > ```js
|
|
1061
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
1062
|
+
* > ```
|
|
1063
|
+
* > 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.
|
|
1064
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
1065
|
+
*
|
|
1066
|
+
*
|
|
1067
|
+
* Updates a ticket definition.
|
|
1068
|
+
*
|
|
1069
|
+
* See [Partial Updates](/wix-events-v2/partial-updates) for more information.
|
|
1070
|
+
* @param definitionId - Ticket definition ID.
|
|
1071
|
+
* @param eventId - Event ID.
|
|
1072
|
+
* @public
|
|
1073
|
+
* @requiredField definitionId
|
|
1074
|
+
* @requiredField eventId
|
|
1075
|
+
* @param identifiers - Details of the ticket definition to update.
|
|
1076
|
+
* @param options - Ticket definition details to update.
|
|
1077
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
1078
|
+
* @applicableIdentity APP
|
|
1079
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.UpdateTicketDefinition
|
|
1080
|
+
* @deprecated
|
|
1081
|
+
* @targetRemovalDate 2024-12-01
|
|
1082
|
+
*/
|
|
1083
|
+
declare function updateTicketDefinition(definitionId: string, eventId: string, options?: UpdateTicketDefinitionOptions): Promise<NonNullablePaths<UpdateTicketDefinitionResponse, {
|
|
1084
|
+
[P in TicketDefinitionNonNullablePaths]: `definition.${P}`;
|
|
1085
|
+
}[TicketDefinitionNonNullablePaths]>>;
|
|
882
1086
|
interface UpdateTicketDefinitionOptions {
|
|
883
1087
|
/** Ticket definition data. */
|
|
884
1088
|
definition?: TicketDefinitionData;
|
|
885
1089
|
/** Set of field paths, specifying which parts of ticket definition to update. */
|
|
886
1090
|
fields?: string[];
|
|
887
1091
|
}
|
|
1092
|
+
/**
|
|
1093
|
+
* **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.
|
|
1094
|
+
* >**Migration Instructions**.
|
|
1095
|
+
* > 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).
|
|
1096
|
+
* > To migrate to the new function:
|
|
1097
|
+
* > 1. Add the new import statement:
|
|
1098
|
+
* > ```js
|
|
1099
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
1100
|
+
* > ```
|
|
1101
|
+
* > 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.
|
|
1102
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
1103
|
+
*
|
|
1104
|
+
* Deletes a ticket definition.
|
|
1105
|
+
* @param eventId - Event ID.
|
|
1106
|
+
* @public
|
|
1107
|
+
* @requiredField eventId
|
|
1108
|
+
* @param options - Details of tickets to delete.
|
|
1109
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
1110
|
+
* @applicableIdentity APP
|
|
1111
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.DeleteTicketDefinition
|
|
1112
|
+
* @deprecated
|
|
1113
|
+
* @targetRemovalDate 2024-12-01
|
|
1114
|
+
*/
|
|
1115
|
+
declare function deleteTicketDefinition(eventId: string, options?: DeleteTicketDefinitionOptions): Promise<void>;
|
|
888
1116
|
interface DeleteTicketDefinitionOptions extends DeleteTicketDefinitionOptionsDeleteOneOf {
|
|
889
1117
|
/** Ticket definitions to delete. */
|
|
890
1118
|
byId?: ById;
|
|
@@ -898,6 +1126,29 @@ interface DeleteTicketDefinitionOptionsDeleteOneOf {
|
|
|
898
1126
|
/** Whether to delete all event tickets. */
|
|
899
1127
|
all?: boolean;
|
|
900
1128
|
}
|
|
1129
|
+
/**
|
|
1130
|
+
* **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available at [`changeCurrency()`](/ticket-definitions-v2/change-currency).
|
|
1131
|
+
* >**Migration Instructions**.
|
|
1132
|
+
* > 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).
|
|
1133
|
+
* > To migrate to the new function:
|
|
1134
|
+
* > 1. Add the new import statement:
|
|
1135
|
+
* > ```js
|
|
1136
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
1137
|
+
* > ```
|
|
1138
|
+
* > 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.
|
|
1139
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
1140
|
+
*
|
|
1141
|
+
* Changes the currency for all tickets per event.
|
|
1142
|
+
*
|
|
1143
|
+
* @public
|
|
1144
|
+
* @requiredField options.currency
|
|
1145
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
1146
|
+
* @applicableIdentity APP
|
|
1147
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.ChangeCurrency
|
|
1148
|
+
* @deprecated
|
|
1149
|
+
* @targetRemovalDate 2024-12-01
|
|
1150
|
+
*/
|
|
1151
|
+
declare function changeCurrency(options?: NonNullablePaths<ChangeCurrencyOptions, `currency`>): Promise<void>;
|
|
901
1152
|
interface ChangeCurrencyOptions {
|
|
902
1153
|
/**
|
|
903
1154
|
* Event ID.
|
|
@@ -912,4 +1163,4 @@ interface ChangeCurrencyOptions {
|
|
|
912
1163
|
currency: string;
|
|
913
1164
|
}
|
|
914
1165
|
|
|
915
|
-
export { type
|
|
1166
|
+
export { type BaseEventMetadata, type BulkCopyTicketDefinitionsByEventIdRequest, type BulkCopyTicketDefinitionsByEventIdResponse, type ById, type ChangeCurrencyOptions, type ChangeCurrencyRequest, type ChangeCurrencyResponse, type CopiedTicketDefinition, type CreateTicketDefinitionOptions, type CreateTicketDefinitionRequest, type CreateTicketDefinitionResponse, type CursorPaging, type Cursors, type Dashboard, type DefinitionsQueryBuilder, type DefinitionsQueryResult, type DeleteTicketDefinitionOptions, type DeleteTicketDefinitionOptionsDeleteOneOf, type DeleteTicketDefinitionRequest, type DeleteTicketDefinitionRequestDeleteOneOf, type DeleteTicketDefinitionResponse, type FacetCounts, FeeType, type FeeTypeWithLiterals, type GetTicketDefinitionOptions, type GetTicketDefinitionRequest, type GetTicketDefinitionResponse, GroupBy, type GroupByWithLiterals, type IdentificationData, type IdentificationDataIdOneOf, type ListTicketDefinitionsOptions, type ListTicketDefinitionsRequest, type ListTicketDefinitionsResponse, type MessageEnvelope, type Money, type OriginatedFrom, type Paging, type PagingMetadataV2, type PaidTicketDefinitionExistsRequest, type PaidTicketDefinitionExistsResponse, type PricingOption, type PricingOptions, type QueryTicketDefinitionsOptions, type QueryTicketDefinitionsRequest, type QueryTicketDefinitionsResponse, type QueryTicketDefinitionsV2Request, type QueryTicketDefinitionsV2Response, type QueryV2, type QueryV2PagingMethodOneOf, type ResponseMetaData, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type TicketDefinition, type TicketDefinitionCreated, type TicketDefinitionCreatedEnvelope, type TicketDefinitionData, type TicketDefinitionDeleted, type TicketDefinitionDeletedEnvelope, TicketDefinitionFieldset, type TicketDefinitionFieldsetWithLiterals, TicketDefinitionStateEnumState, type TicketDefinitionStateEnumStateWithLiterals, type TicketDefinitionUpdated, type TicketDefinitionUpdatedEnvelope, type TicketPricing, type TicketPricingPriceOneOf, type TicketSalePeriod, TicketSaleStatus, type TicketSaleStatusWithLiterals, Type, type TypeWithLiterals, type UpdateTicketDefinitionOptions, type UpdateTicketDefinitionRequest, type UpdateTicketDefinitionResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixFeeConfig, changeCurrency, createTicketDefinition, deleteTicketDefinition, getTicketDefinition, listTicketDefinitions, onTicketDefinitionCreated, onTicketDefinitionDeleted, onTicketDefinitionUpdated, queryTicketDefinitions, queryTicketDefinitionsV2, updateTicketDefinition };
|