@wix/auto_sdk_events_ticket-definitions 1.0.22 → 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/{events-v1-ticket-definition-ticket-definitions.universal-C4hDlHAW.d.ts → index.typings.d.ts} +252 -1
- package/build/cjs/index.typings.js +966 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +2 -1
- package/build/es/index.d.mts +2 -2
- package/build/es/{events-v1-ticket-definition-ticket-definitions.universal-C4hDlHAW.d.mts → index.typings.d.mts} +252 -1
- package/build/es/index.typings.mjs +926 -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 +2 -2
- package/build/internal/cjs/{events-v1-ticket-definition-ticket-definitions.universal-CpUuZoky.d.ts → index.typings.d.ts} +252 -1
- 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 +2 -1
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/{events-v1-ticket-definition-ticket-definitions.universal-CpUuZoky.d.mts → index.typings.d.mts} +252 -1
- 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 +2 -1
- package/package.json +3 -3
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
import {
|
|
3
|
-
export {
|
|
2
|
+
import { QueryTicketDefinitionsOptions, QueryTicketDefinitionsResponse, DefinitionsQueryBuilder, ListTicketDefinitionsOptions, ListTicketDefinitionsResponse, GetTicketDefinitionOptions, TicketDefinition, CreateTicketDefinitionOptions, CreateTicketDefinitionResponse, UpdateTicketDefinitionOptions, UpdateTicketDefinitionResponse, DeleteTicketDefinitionOptions, ChangeCurrencyOptions, TicketDefinitionCreatedEnvelope, TicketDefinitionDeletedEnvelope, TicketDefinitionUpdatedEnvelope } from './index.typings.js';
|
|
3
|
+
export { BaseEventMetadata, BulkCopyTicketDefinitionsByEventIdRequest, BulkCopyTicketDefinitionsByEventIdResponse, ById, ChangeCurrencyRequest, ChangeCurrencyResponse, CopiedTicketDefinition, CreateTicketDefinitionRequest, CursorPaging, Cursors, Dashboard, DefinitionsQueryResult, DeleteTicketDefinitionOptionsDeleteOneOf, DeleteTicketDefinitionRequest, DeleteTicketDefinitionRequestDeleteOneOf, DeleteTicketDefinitionResponse, FacetCounts, FeeType, GetTicketDefinitionRequest, GetTicketDefinitionResponse, GroupBy, IdentificationData, IdentificationDataIdOneOf, ListTicketDefinitionsRequest, MessageEnvelope, Money, OriginatedFrom, Paging, PagingMetadataV2, PaidTicketDefinitionExistsRequest, PaidTicketDefinitionExistsResponse, PricingOption, PricingOptions, QueryTicketDefinitionsRequest, QueryTicketDefinitionsV2Request, QueryTicketDefinitionsV2Response, QueryV2, QueryV2PagingMethodOneOf, ResponseMetaData, SortOrder, Sorting, State, TicketDefinitionCreated, TicketDefinitionData, TicketDefinitionDeleted, TicketDefinitionFieldset, TicketDefinitionStateEnumState, TicketDefinitionUpdated, TicketPricing, TicketPricingPriceOneOf, TicketSalePeriod, TicketSaleStatus, Type, UpdateTicketDefinitionRequest, WebhookIdentityType, WixFeeConfig } from './index.typings.js';
|
|
4
4
|
|
|
5
5
|
declare function queryTicketDefinitions$1(httpClient: HttpClient): QueryTicketDefinitionsSignature;
|
|
6
6
|
interface QueryTicketDefinitionsSignature {
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
interface TicketDefinition {
|
|
2
4
|
/**
|
|
3
5
|
* Ticket definition ID.
|
|
@@ -401,6 +403,8 @@ declare enum GroupBy {
|
|
|
401
403
|
/** Groups by event created date with ascending sorting. */
|
|
402
404
|
EVENT_CREATED_ASC = "EVENT_CREATED_ASC"
|
|
403
405
|
}
|
|
406
|
+
/** @enumType */
|
|
407
|
+
type GroupByWithLiterals = GroupBy | 'NONE' | 'EVENT_CREATED_DESC' | 'EVENT_CREATED_ASC';
|
|
404
408
|
interface ListTicketDefinitionsResponse {
|
|
405
409
|
/** Meta data. */
|
|
406
410
|
metaData?: ResponseMetaData;
|
|
@@ -732,14 +736,83 @@ interface TicketDefinitionCreatedEnvelope {
|
|
|
732
736
|
data: TicketDefinitionCreated;
|
|
733
737
|
metadata: BaseEventMetadata;
|
|
734
738
|
}
|
|
739
|
+
/** @permissionScope Manage Events - all permissions
|
|
740
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
741
|
+
* @permissionScope Manage Events
|
|
742
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
743
|
+
* @permissionScope Manage Orders
|
|
744
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
745
|
+
* @permissionScope Manage Ticket Definitions
|
|
746
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
747
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
748
|
+
* @webhook
|
|
749
|
+
* @eventType wix.events.ticketing.events.TicketDefinitionCreated
|
|
750
|
+
* @serviceIdentifier wix.events.ticketing.TicketDefinitionManagement
|
|
751
|
+
* @slug ticket_definition_created
|
|
752
|
+
*/
|
|
753
|
+
declare function onTicketDefinitionCreated(handler: (event: TicketDefinitionCreatedEnvelope) => void | Promise<void>): void;
|
|
735
754
|
interface TicketDefinitionDeletedEnvelope {
|
|
736
755
|
data: TicketDefinitionDeleted;
|
|
737
756
|
metadata: BaseEventMetadata;
|
|
738
757
|
}
|
|
758
|
+
/** @permissionScope Manage Events - all permissions
|
|
759
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
760
|
+
* @permissionScope Manage Events
|
|
761
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
762
|
+
* @permissionScope Manage Orders
|
|
763
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
764
|
+
* @permissionScope Manage Ticket Definitions
|
|
765
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
766
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
767
|
+
* @webhook
|
|
768
|
+
* @eventType wix.events.ticketing.events.TicketDefinitionDeleted
|
|
769
|
+
* @serviceIdentifier wix.events.ticketing.TicketDefinitionManagement
|
|
770
|
+
* @slug ticket_definition_deleted
|
|
771
|
+
*/
|
|
772
|
+
declare function onTicketDefinitionDeleted(handler: (event: TicketDefinitionDeletedEnvelope) => void | Promise<void>): void;
|
|
739
773
|
interface TicketDefinitionUpdatedEnvelope {
|
|
740
774
|
data: TicketDefinitionUpdated;
|
|
741
775
|
metadata: BaseEventMetadata;
|
|
742
776
|
}
|
|
777
|
+
/** @permissionScope Manage Events - all permissions
|
|
778
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
779
|
+
* @permissionScope Manage Events
|
|
780
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
781
|
+
* @permissionScope Manage Orders
|
|
782
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
783
|
+
* @permissionScope Manage Ticket Definitions
|
|
784
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
785
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
786
|
+
* @webhook
|
|
787
|
+
* @eventType wix.events.ticketing.events.TicketDefinitionUpdated
|
|
788
|
+
* @serviceIdentifier wix.events.ticketing.TicketDefinitionManagement
|
|
789
|
+
* @slug ticket_definition_updated
|
|
790
|
+
*/
|
|
791
|
+
declare function onTicketDefinitionUpdated(handler: (event: TicketDefinitionUpdatedEnvelope) => void | Promise<void>): void;
|
|
792
|
+
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`;
|
|
793
|
+
/**
|
|
794
|
+
* **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.
|
|
795
|
+
* >**Migration Instructions**.
|
|
796
|
+
* > 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).
|
|
797
|
+
* > To migrate to the new function:
|
|
798
|
+
* > 1. Add the new import statement:
|
|
799
|
+
* > ```js
|
|
800
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
801
|
+
* > ```
|
|
802
|
+
* > 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.
|
|
803
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
804
|
+
*
|
|
805
|
+
* Retrieves a list of up to 100 ticket definitions.
|
|
806
|
+
* @public
|
|
807
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
808
|
+
* @applicableIdentity APP
|
|
809
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.QueryTicketDefinitions
|
|
810
|
+
* @deprecated
|
|
811
|
+
* @targetRemovalDate 2024-12-01
|
|
812
|
+
*/
|
|
813
|
+
declare function queryTicketDefinitions(options?: QueryTicketDefinitionsOptions): Promise<NonNullablePaths<QueryTicketDefinitionsResponse, `total` | `offset` | `limit` | {
|
|
814
|
+
[P in TicketDefinitionNonNullablePaths]: `definitions.${number}.${P}`;
|
|
815
|
+
}[TicketDefinitionNonNullablePaths]>>;
|
|
743
816
|
interface QueryTicketDefinitionsOptions {
|
|
744
817
|
/** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
|
|
745
818
|
offset?: number;
|
|
@@ -769,6 +842,28 @@ interface QueryTicketDefinitionsOptions {
|
|
|
769
842
|
*/
|
|
770
843
|
facet?: string[];
|
|
771
844
|
}
|
|
845
|
+
/**
|
|
846
|
+
* **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).
|
|
847
|
+
* >**Migration Instructions**.
|
|
848
|
+
* > 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).
|
|
849
|
+
* > To migrate to the new function:
|
|
850
|
+
* > 1. Add the new import statement:
|
|
851
|
+
* > ```js
|
|
852
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
853
|
+
* > ```
|
|
854
|
+
* > 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.
|
|
855
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
856
|
+
*
|
|
857
|
+
* Retrieves a list of up to 1,000 ticket definitions, given the provided paging and filtering.
|
|
858
|
+
* @public
|
|
859
|
+
* @documentationMaturity preview
|
|
860
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
861
|
+
* @applicableIdentity APP
|
|
862
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.QueryTicketDefinitionsV2
|
|
863
|
+
* @deprecated
|
|
864
|
+
* @targetRemovalDate 2024-12-01
|
|
865
|
+
*/
|
|
866
|
+
declare function queryTicketDefinitionsV2(): DefinitionsQueryBuilder;
|
|
772
867
|
interface QueryCursorResult {
|
|
773
868
|
cursors: Cursors;
|
|
774
869
|
hasNext: () => boolean;
|
|
@@ -794,6 +889,30 @@ interface DefinitionsQueryBuilder {
|
|
|
794
889
|
/** @documentationMaturity preview */
|
|
795
890
|
find: () => Promise<DefinitionsQueryResult>;
|
|
796
891
|
}
|
|
892
|
+
/**
|
|
893
|
+
* **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.
|
|
894
|
+
* >**Migration Instructions**.
|
|
895
|
+
* > 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).
|
|
896
|
+
* > To migrate to the new function:
|
|
897
|
+
* > 1. Add the new import statement:
|
|
898
|
+
* > ```js
|
|
899
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
900
|
+
* > ```
|
|
901
|
+
* > 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.
|
|
902
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
903
|
+
*
|
|
904
|
+
* Retrieves a list of up to 100 ticket definitions, with basic filter support.
|
|
905
|
+
* @public
|
|
906
|
+
* @param options - Details for the tickets to retrieve.
|
|
907
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
908
|
+
* @applicableIdentity APP
|
|
909
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.ListTicketDefinitions
|
|
910
|
+
* @deprecated
|
|
911
|
+
* @targetRemovalDate 2024-12-01
|
|
912
|
+
*/
|
|
913
|
+
declare function listTicketDefinitions(options?: ListTicketDefinitionsOptions): Promise<NonNullablePaths<ListTicketDefinitionsResponse, `metaData.count` | `metaData.offset` | `metaData.total` | {
|
|
914
|
+
[P in TicketDefinitionNonNullablePaths]: `definitions.${number}.${P}`;
|
|
915
|
+
}[TicketDefinitionNonNullablePaths]>>;
|
|
797
916
|
interface ListTicketDefinitionsOptions {
|
|
798
917
|
/**
|
|
799
918
|
* Event ID.
|
|
@@ -857,6 +976,31 @@ interface ListTicketDefinitionsOptions {
|
|
|
857
976
|
*/
|
|
858
977
|
facet?: string[];
|
|
859
978
|
}
|
|
979
|
+
/**
|
|
980
|
+
* **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.
|
|
981
|
+
* >**Migration Instructions**.
|
|
982
|
+
* > 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).
|
|
983
|
+
* > To migrate to the new function:
|
|
984
|
+
* > 1. Add the new import statement:
|
|
985
|
+
* > ```js
|
|
986
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
987
|
+
* > ```
|
|
988
|
+
* > 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.
|
|
989
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
990
|
+
*
|
|
991
|
+
* Retrieves a ticket definition.
|
|
992
|
+
* @param definitionId - Ticket definition ID.
|
|
993
|
+
* @public
|
|
994
|
+
* @requiredField definitionId
|
|
995
|
+
* @param options - Details for the ticket to retrieve.
|
|
996
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
997
|
+
* @applicableIdentity APP
|
|
998
|
+
* @returns Retrieved ticket definition.
|
|
999
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.GetTicketDefinition
|
|
1000
|
+
* @deprecated
|
|
1001
|
+
* @targetRemovalDate 2024-12-01
|
|
1002
|
+
*/
|
|
1003
|
+
declare function getTicketDefinition(definitionId: string, options?: GetTicketDefinitionOptions): Promise<NonNullablePaths<TicketDefinition, TicketDefinitionNonNullablePaths>>;
|
|
860
1004
|
interface GetTicketDefinitionOptions {
|
|
861
1005
|
/**
|
|
862
1006
|
* Predefined sets of fields to return.
|
|
@@ -868,16 +1012,100 @@ interface GetTicketDefinitionOptions {
|
|
|
868
1012
|
*/
|
|
869
1013
|
fieldset?: TicketDefinitionFieldsetWithLiterals[];
|
|
870
1014
|
}
|
|
1015
|
+
/**
|
|
1016
|
+
* **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.
|
|
1017
|
+
* >**Migration Instructions**.
|
|
1018
|
+
* > 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).
|
|
1019
|
+
* > To migrate to the new function:
|
|
1020
|
+
* > 1. Add the new import statement:
|
|
1021
|
+
* > ```js
|
|
1022
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
1023
|
+
* > ```
|
|
1024
|
+
* > 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.
|
|
1025
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
1026
|
+
*
|
|
1027
|
+
* Creates a ticket definition (and enables ticket sales).
|
|
1028
|
+
* @param eventId - Event ID.
|
|
1029
|
+
* @public
|
|
1030
|
+
* @requiredField eventId
|
|
1031
|
+
* @requiredField options
|
|
1032
|
+
* @requiredField options.definition
|
|
1033
|
+
* @requiredField options.definition.name
|
|
1034
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
1035
|
+
* @applicableIdentity APP
|
|
1036
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.CreateTicketDefinition
|
|
1037
|
+
* @deprecated
|
|
1038
|
+
* @targetRemovalDate 2024-12-01
|
|
1039
|
+
*/
|
|
1040
|
+
declare function createTicketDefinition(eventId: string, options: NonNullablePaths<CreateTicketDefinitionOptions, `definition` | `definition.name`>): Promise<NonNullablePaths<CreateTicketDefinitionResponse, {
|
|
1041
|
+
[P in TicketDefinitionNonNullablePaths]: `definition.${P}`;
|
|
1042
|
+
}[TicketDefinitionNonNullablePaths]>>;
|
|
871
1043
|
interface CreateTicketDefinitionOptions {
|
|
872
1044
|
/** Ticket definition data. */
|
|
873
1045
|
definition: TicketDefinitionData;
|
|
874
1046
|
}
|
|
1047
|
+
/**
|
|
1048
|
+
* **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.
|
|
1049
|
+
* >**Migration Instructions**.
|
|
1050
|
+
* > 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).
|
|
1051
|
+
* > To migrate to the new function:
|
|
1052
|
+
* > 1. Add the new import statement:
|
|
1053
|
+
* > ```js
|
|
1054
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
1055
|
+
* > ```
|
|
1056
|
+
* > 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.
|
|
1057
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
1058
|
+
*
|
|
1059
|
+
*
|
|
1060
|
+
* Updates a ticket definition.
|
|
1061
|
+
*
|
|
1062
|
+
* See [Partial Updates](/wix-events-v2/partial-updates) for more information.
|
|
1063
|
+
* @param definitionId - Ticket definition ID.
|
|
1064
|
+
* @param eventId - Event ID.
|
|
1065
|
+
* @public
|
|
1066
|
+
* @requiredField definitionId
|
|
1067
|
+
* @requiredField eventId
|
|
1068
|
+
* @param identifiers - Details of the ticket definition to update.
|
|
1069
|
+
* @param options - Ticket definition details to update.
|
|
1070
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
1071
|
+
* @applicableIdentity APP
|
|
1072
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.UpdateTicketDefinition
|
|
1073
|
+
* @deprecated
|
|
1074
|
+
* @targetRemovalDate 2024-12-01
|
|
1075
|
+
*/
|
|
1076
|
+
declare function updateTicketDefinition(definitionId: string, eventId: string, options?: UpdateTicketDefinitionOptions): Promise<NonNullablePaths<UpdateTicketDefinitionResponse, {
|
|
1077
|
+
[P in TicketDefinitionNonNullablePaths]: `definition.${P}`;
|
|
1078
|
+
}[TicketDefinitionNonNullablePaths]>>;
|
|
875
1079
|
interface UpdateTicketDefinitionOptions {
|
|
876
1080
|
/** Ticket definition data. */
|
|
877
1081
|
definition?: TicketDefinitionData;
|
|
878
1082
|
/** Set of field paths, specifying which parts of ticket definition to update. */
|
|
879
1083
|
fields?: string[];
|
|
880
1084
|
}
|
|
1085
|
+
/**
|
|
1086
|
+
* **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.
|
|
1087
|
+
* >**Migration Instructions**.
|
|
1088
|
+
* > 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).
|
|
1089
|
+
* > To migrate to the new function:
|
|
1090
|
+
* > 1. Add the new import statement:
|
|
1091
|
+
* > ```js
|
|
1092
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
1093
|
+
* > ```
|
|
1094
|
+
* > 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.
|
|
1095
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
1096
|
+
*
|
|
1097
|
+
* Deletes a ticket definition.
|
|
1098
|
+
* @param eventId - Event ID.
|
|
1099
|
+
* @public
|
|
1100
|
+
* @requiredField eventId
|
|
1101
|
+
* @param options - Details of tickets to delete.
|
|
1102
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
1103
|
+
* @applicableIdentity APP
|
|
1104
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.DeleteTicketDefinition
|
|
1105
|
+
* @deprecated
|
|
1106
|
+
* @targetRemovalDate 2024-12-01
|
|
1107
|
+
*/
|
|
1108
|
+
declare function deleteTicketDefinition(eventId: string, options?: DeleteTicketDefinitionOptions): Promise<void>;
|
|
881
1109
|
interface DeleteTicketDefinitionOptions extends DeleteTicketDefinitionOptionsDeleteOneOf {
|
|
882
1110
|
/** Ticket definitions to delete. */
|
|
883
1111
|
byId?: ById;
|
|
@@ -891,6 +1119,29 @@ interface DeleteTicketDefinitionOptionsDeleteOneOf {
|
|
|
891
1119
|
/** Whether to delete all event tickets. */
|
|
892
1120
|
all?: boolean;
|
|
893
1121
|
}
|
|
1122
|
+
/**
|
|
1123
|
+
* **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available at [`changeCurrency()`](/ticket-definitions-v2/change-currency).
|
|
1124
|
+
* >**Migration Instructions**.
|
|
1125
|
+
* > 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).
|
|
1126
|
+
* > To migrate to the new function:
|
|
1127
|
+
* > 1. Add the new import statement:
|
|
1128
|
+
* > ```js
|
|
1129
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
1130
|
+
* > ```
|
|
1131
|
+
* > 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.
|
|
1132
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
1133
|
+
*
|
|
1134
|
+
* Changes the currency for all tickets per event.
|
|
1135
|
+
*
|
|
1136
|
+
* @public
|
|
1137
|
+
* @requiredField options.currency
|
|
1138
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
1139
|
+
* @applicableIdentity APP
|
|
1140
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.ChangeCurrency
|
|
1141
|
+
* @deprecated
|
|
1142
|
+
* @targetRemovalDate 2024-12-01
|
|
1143
|
+
*/
|
|
1144
|
+
declare function changeCurrency(options?: NonNullablePaths<ChangeCurrencyOptions, `currency`>): Promise<void>;
|
|
894
1145
|
interface ChangeCurrencyOptions {
|
|
895
1146
|
/**
|
|
896
1147
|
* Event ID.
|
|
@@ -905,4 +1156,4 @@ interface ChangeCurrencyOptions {
|
|
|
905
1156
|
currency: string;
|
|
906
1157
|
}
|
|
907
1158
|
|
|
908
|
-
export { type
|
|
1159
|
+
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 };
|