@wix/auto_sdk_online-programs_participants 1.0.1 → 1.0.3

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.
@@ -201,6 +201,10 @@ interface JoinProgramResponse {
201
201
  /** Created participant with corresponding state */
202
202
  participant?: Participant;
203
203
  }
204
+ interface ParticipantJoined {
205
+ /** Joined participant */
206
+ participant?: Participant;
207
+ }
204
208
  interface GetParticipantRequest {
205
209
  /**
206
210
  * Participant id to fetch
@@ -221,6 +225,37 @@ interface LeaveProgramRequest {
221
225
  }
222
226
  interface LeaveProgramResponse {
223
227
  }
228
+ interface ParticipantLeft {
229
+ /**
230
+ * Participant id who left
231
+ * @format GUID
232
+ */
233
+ participantId?: string;
234
+ /**
235
+ * Program id participant left
236
+ * @format GUID
237
+ */
238
+ programId?: string;
239
+ /**
240
+ * Participant's member id
241
+ * @format GUID
242
+ */
243
+ memberId?: string;
244
+ /** Reason for removal */
245
+ removalReason?: RemovalReasonWithLiterals;
246
+ }
247
+ declare enum RemovalReason {
248
+ /** Default for backward compatibility */
249
+ UNKNOWN_REMOVAL_REASON = "UNKNOWN_REMOVAL_REASON",
250
+ /** User-initiated leave */
251
+ LEGITIMATE_LEAVE = "LEGITIMATE_LEAVE",
252
+ /** Cleanup during rejoin flow */
253
+ CLEANUP_FOR_REJOIN = "CLEANUP_FOR_REJOIN",
254
+ /** Cleanup during manual addition */
255
+ CLEANUP_FOR_MANUAL_ADD = "CLEANUP_FOR_MANUAL_ADD"
256
+ }
257
+ /** @enumType */
258
+ type RemovalReasonWithLiterals = RemovalReason | 'UNKNOWN_REMOVAL_REASON' | 'LEGITIMATE_LEAVE' | 'CLEANUP_FOR_REJOIN' | 'CLEANUP_FOR_MANUAL_ADD';
224
259
  interface QueryParticipantsRequest {
225
260
  /** Platformized query */
226
261
  query?: CursorQuery;
@@ -333,6 +368,721 @@ interface RevertCouponRequest {
333
368
  interface RevertCouponResponse {
334
369
  total?: number;
335
370
  }
371
+ /** This webhook is triggered whenever a payment transaction is updated (including refunds) via specific [Wix Apps](https://dev.wix.com/api/rest/wix-payments/about-wix-payments). */
372
+ interface PaymentEvent extends PaymentEventEventOneOf {
373
+ /** `TRANSACTION_STATUS_CHANGED` event details. */
374
+ transactionStatusChangedEvent?: TransactionStatusChangedEvent;
375
+ /** `REFUND_STATUS_CHANGED` event details. */
376
+ refundStatusChangedEvent?: RefundStatusChangedEvent;
377
+ /**
378
+ * `RECURRING_PAYMENT_STATUS_CHANGED` event details.
379
+ * @deprecated `RECURRING_PAYMENT_STATUS_CHANGED` event details.
380
+ * @targetRemovalDate 2026-06-30
381
+ */
382
+ recurringPaymentStatusChangedEvent?: RecurringPaymentStatusChangedEvent;
383
+ /** `TRANSACTION_UPDATED` event details. */
384
+ transactionUpdatedEvent?: TransactionUpdatedEvent;
385
+ /** `TRANSACTION_CREATED` event details. */
386
+ transactionCreatedEvent?: TransactionCreatedEvent;
387
+ /**
388
+ * Unique event ID.
389
+ * @format GUID
390
+ */
391
+ id?: string;
392
+ /** Event timestamp */
393
+ eventTime?: Date | null;
394
+ /**
395
+ * ID of the [Wix app](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions) that triggered this event.
396
+ * @maxLength 100
397
+ */
398
+ wixAppId?: string;
399
+ /**
400
+ * Unique ID assigned to each Wix app in each site.
401
+ * @format GUID
402
+ */
403
+ wixAppInstanceId?: string;
404
+ /** Event type. */
405
+ eventType?: EventTypeWithLiterals;
406
+ /**
407
+ * ID of Wix app that mediated between Wix Payments and the Wix app that triggered the event (if relevant).
408
+ * @maxLength 100
409
+ */
410
+ managingWixAppId?: string | null;
411
+ }
412
+ /** @oneof */
413
+ interface PaymentEventEventOneOf {
414
+ /** `TRANSACTION_STATUS_CHANGED` event details. */
415
+ transactionStatusChangedEvent?: TransactionStatusChangedEvent;
416
+ /** `REFUND_STATUS_CHANGED` event details. */
417
+ refundStatusChangedEvent?: RefundStatusChangedEvent;
418
+ /**
419
+ * `RECURRING_PAYMENT_STATUS_CHANGED` event details.
420
+ * @deprecated `RECURRING_PAYMENT_STATUS_CHANGED` event details.
421
+ * @targetRemovalDate 2026-06-30
422
+ */
423
+ recurringPaymentStatusChangedEvent?: RecurringPaymentStatusChangedEvent;
424
+ /** `TRANSACTION_UPDATED` event details. */
425
+ transactionUpdatedEvent?: TransactionUpdatedEvent;
426
+ /** `TRANSACTION_CREATED` event details. */
427
+ transactionCreatedEvent?: TransactionCreatedEvent;
428
+ }
429
+ declare enum EventType {
430
+ UNDEFINED = "UNDEFINED",
431
+ /** Fired when a transaction's status changes. */
432
+ TRANSACTION_STATUS_CHANGED = "TRANSACTION_STATUS_CHANGED",
433
+ /** Fired when a refund's status changes. */
434
+ REFUND_STATUS_CHANGED = "REFUND_STATUS_CHANGED",
435
+ /** Fired when a legacy subscription's status changes. */
436
+ RECURRING_PAYMENT_STATUS_CHANGED = "RECURRING_PAYMENT_STATUS_CHANGED",
437
+ /** Fired when a transaction is updated. */
438
+ TRANSACTION_UPDATED = "TRANSACTION_UPDATED",
439
+ /** Fired when a transaction is created. */
440
+ TRANSACTION_CREATED = "TRANSACTION_CREATED"
441
+ }
442
+ /** @enumType */
443
+ type EventTypeWithLiterals = EventType | 'UNDEFINED' | 'TRANSACTION_STATUS_CHANGED' | 'REFUND_STATUS_CHANGED' | 'RECURRING_PAYMENT_STATUS_CHANGED' | 'TRANSACTION_UPDATED' | 'TRANSACTION_CREATED';
444
+ interface TransactionStatusChangedEvent {
445
+ /** Order details (limited to 30 items). */
446
+ order?: Order;
447
+ /** New transaction details. */
448
+ transaction?: Transaction;
449
+ /** Previous transaction status. */
450
+ previousStatus?: TransactionStatusWithLiterals;
451
+ }
452
+ interface Order {
453
+ id?: string;
454
+ /** Wix app order ID */
455
+ wixAppOrderId?: string;
456
+ /** Wix app buyer ID */
457
+ wixAppBuyerId?: string | null;
458
+ /** Items included in the order */
459
+ items?: OrderItem[];
460
+ /**
461
+ * total number of items in order
462
+ * items_total_count > `items`.size if `items` doesn't contain all items
463
+ */
464
+ itemsTotalCount?: number;
465
+ /** Additional charges to the order - e.g., tax, shipping or discount (optional) */
466
+ additionalCharges?: OrderAdditionalCharges;
467
+ /** Customer's shipping address (optional) */
468
+ shippingAddress?: Address;
469
+ /** Customer's shipping address details (optional) */
470
+ shippingAddressContacts?: FullAddressContactDetails;
471
+ /** Order creation date */
472
+ createdAt?: Date | null;
473
+ /** External data which is stored with the order */
474
+ externalData?: Record<string, string>;
475
+ /**
476
+ * Vertical invoice ID
477
+ * @maxLength 200
478
+ */
479
+ verticalInvoiceId?: string | null;
480
+ /** the part of total amount taken by platform from the amount sent to merchant */
481
+ platformFee?: number | null;
482
+ }
483
+ /** Item included in order */
484
+ interface OrderItem {
485
+ /** Order item ID (required) */
486
+ id?: string;
487
+ /** Order item name (required) */
488
+ name?: string;
489
+ /** Quantity (required) */
490
+ quantity?: number;
491
+ /** Total price charged for this item in the order - quantity * price (required) */
492
+ price?: number;
493
+ /** Order item description */
494
+ description?: string;
495
+ /** Weight of one item */
496
+ weightInKg?: number;
497
+ /** Whether the item is a physical a digital product */
498
+ category?: OrderItemCategoryWithLiterals;
499
+ }
500
+ /** Order item type */
501
+ declare enum OrderItemCategory {
502
+ UNDEFINED = "UNDEFINED",
503
+ /** Physical product */
504
+ PHYSICAL = "PHYSICAL",
505
+ /** Digital product */
506
+ DIGITAL = "DIGITAL"
507
+ }
508
+ /** @enumType */
509
+ type OrderItemCategoryWithLiterals = OrderItemCategory | 'UNDEFINED' | 'PHYSICAL' | 'DIGITAL';
510
+ /** Describing any additional charges in the order. They are not required, but can't be added later. */
511
+ interface OrderAdditionalCharges {
512
+ /** Absolute taxes charged to the order */
513
+ tax?: number;
514
+ /** Shipping cost charged to the order */
515
+ shipping?: number;
516
+ /** Discount amount applied to the order */
517
+ discount?: number;
518
+ /** Application fee */
519
+ applicationFee?: number;
520
+ }
521
+ /** Physical address */
522
+ interface Address extends AddressStreetOneOf {
523
+ /** Street name and number. */
524
+ streetAddress?: StreetAddress;
525
+ /** Main address line, usually street and number as free text. */
526
+ addressLine?: string | null;
527
+ /**
528
+ * Country code.
529
+ * @format COUNTRY
530
+ */
531
+ country?: string | null;
532
+ /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
533
+ subdivision?: string | null;
534
+ /** City name. */
535
+ city?: string | null;
536
+ /** Zip/postal code. */
537
+ postalCode?: string | null;
538
+ /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
539
+ addressLine2?: string | null;
540
+ }
541
+ /** @oneof */
542
+ interface AddressStreetOneOf {
543
+ /** Street name and number. */
544
+ streetAddress?: StreetAddress;
545
+ /** Main address line, usually street and number as free text. */
546
+ addressLine?: string | null;
547
+ }
548
+ interface StreetAddress {
549
+ /** Street number. */
550
+ number?: string;
551
+ /** Street name. */
552
+ name?: string;
553
+ }
554
+ interface AddressLocation {
555
+ /** Address latitude. */
556
+ latitude?: number | null;
557
+ /** Address longitude. */
558
+ longitude?: number | null;
559
+ }
560
+ interface Subdivision {
561
+ /** Short subdivision code. */
562
+ code?: string;
563
+ /** Subdivision full name. */
564
+ name?: string;
565
+ }
566
+ declare enum SubdivisionType {
567
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
568
+ /** State */
569
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
570
+ /** County */
571
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
572
+ /** City/town */
573
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
574
+ /** Neighborhood/quarter */
575
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
576
+ /** Street/block */
577
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
578
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
579
+ COUNTRY = "COUNTRY"
580
+ }
581
+ /** @enumType */
582
+ 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';
583
+ /** Subdivision Concordance values */
584
+ interface StandardDetails {
585
+ /**
586
+ * subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
587
+ * @maxLength 20
588
+ */
589
+ iso31662?: string | null;
590
+ }
591
+ /** Full contact details for an address */
592
+ interface FullAddressContactDetails {
593
+ /** Contact's first name. */
594
+ firstName?: string | null;
595
+ /** Contact's last name. */
596
+ lastName?: string | null;
597
+ /**
598
+ * Contact's phone number.
599
+ * @format PHONE
600
+ */
601
+ phone?: string | null;
602
+ /** Contact's company name. */
603
+ company?: string | null;
604
+ /**
605
+ * Email associated with the address.
606
+ * @format EMAIL
607
+ */
608
+ email?: string | null;
609
+ /** Tax info. Currently usable only in Brazil. */
610
+ vatId?: VatId;
611
+ }
612
+ interface VatId {
613
+ /** Customer's tax ID. */
614
+ id?: string;
615
+ /**
616
+ * Tax type.
617
+ *
618
+ * Supported values:
619
+ * + `CPF`: for individual tax payers
620
+ * + `CNPJ`: for corporations
621
+ */
622
+ type?: VatTypeWithLiterals;
623
+ }
624
+ /** tax info types */
625
+ declare enum VatType {
626
+ UNSPECIFIED = "UNSPECIFIED",
627
+ /** CPF - for individual tax payers. */
628
+ CPF = "CPF",
629
+ /** CNPJ - for corporations */
630
+ CNPJ = "CNPJ"
631
+ }
632
+ /** @enumType */
633
+ type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
634
+ interface Transaction extends TransactionPaymentMethodDataOneOf {
635
+ creditCardPaymentMethodData?: CreditCardPaymentMethodData;
636
+ /** Transaction ID */
637
+ id?: string;
638
+ /** Provider transaction ID */
639
+ providerTransactionId?: string | null;
640
+ /** Amount and currency of transaction */
641
+ amount?: CurrencyAmount;
642
+ /** Refunded amount and currency of transaction */
643
+ refundedAmount?: CurrencyAmount;
644
+ /** Updated transaction status */
645
+ status?: TransactionStatusWithLiterals;
646
+ /** Reason provided for status change */
647
+ reasonCode?: string | null;
648
+ /** Payment method */
649
+ paymentMethod?: string;
650
+ /** Payment service provider */
651
+ paymentProvider?: string;
652
+ /** Customer's billing address (optional) */
653
+ billingAddress?: Address;
654
+ /** Customer's billing address - contact details (optional) */
655
+ billingAddressContacts?: FullAddressContactDetails;
656
+ /** Details of subscription, which (if) the transaction is a part of */
657
+ recurringPaymentDetails?: RecurringPaymentDetails;
658
+ /** The details of a payment method account. */
659
+ paymentMethodAccountInfo?: AccountInfo;
660
+ /** Transaction creation date */
661
+ createdAt?: Date | null;
662
+ /** Total number of installments */
663
+ installments?: number;
664
+ /** Scheduled action for this transaction */
665
+ scheduledAction?: ScheduledAction;
666
+ /**
667
+ * order id associated with the transaction on the vertical side
668
+ * @minLength 1
669
+ * @maxLength 100
670
+ */
671
+ verticalOrderId?: string | null;
672
+ }
673
+ /** @oneof */
674
+ interface TransactionPaymentMethodDataOneOf {
675
+ creditCardPaymentMethodData?: CreditCardPaymentMethodData;
676
+ }
677
+ interface CurrencyAmount {
678
+ /** Amount */
679
+ amount?: number;
680
+ currency?: string;
681
+ }
682
+ declare enum TransactionStatus {
683
+ UNDEFINED = "UNDEFINED",
684
+ APPROVED = "APPROVED",
685
+ PENDING = "PENDING",
686
+ PENDING_MERCHANT = "PENDING_MERCHANT",
687
+ CANCELED = "CANCELED",
688
+ DECLINED = "DECLINED",
689
+ REFUNDED = "REFUNDED",
690
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
691
+ AUTHORIZED = "AUTHORIZED",
692
+ VOIDED = "VOIDED"
693
+ }
694
+ /** @enumType */
695
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
696
+ interface RecurringPaymentDetails {
697
+ /** Current cycle number (Recurring payments only) */
698
+ cycleNumber?: number;
699
+ }
700
+ interface CreditCardPaymentMethodData {
701
+ /** Card issuing network */
702
+ network?: string;
703
+ /** Card number with only bin and last4 positions showed (non-PCI data) */
704
+ maskedCreditCard?: string;
705
+ /** Card holder's full name specified on the card. */
706
+ holderName?: string;
707
+ /** Card expiration month. */
708
+ expiryMonth?: string;
709
+ /**
710
+ * Card expiration year.
711
+ * @minLength 4
712
+ * @maxLength 4
713
+ */
714
+ expiryYear?: string | null;
715
+ /**
716
+ * Card last 4 digits.
717
+ * @minLength 4
718
+ * @maxLength 4
719
+ */
720
+ lastFourDigits?: string | null;
721
+ /**
722
+ * Card BIN (Bank Identification Number). It's the first 4-8 digits of a card number.
723
+ * @minLength 4
724
+ * @maxLength 8
725
+ */
726
+ bin?: string | null;
727
+ }
728
+ interface AccountInfo {
729
+ /**
730
+ * The email of an Account used by Payment Method
731
+ * @format EMAIL
732
+ */
733
+ email?: string | null;
734
+ }
735
+ interface ScheduledAction {
736
+ /** type of the action */
737
+ type?: ScheduledActionTypeWithLiterals;
738
+ /** the date and time of the action */
739
+ executionDate?: Date | null;
740
+ }
741
+ declare enum ScheduledActionType {
742
+ VOID = "VOID",
743
+ CAPTURE = "CAPTURE"
744
+ }
745
+ /** @enumType */
746
+ type ScheduledActionTypeWithLiterals = ScheduledActionType | 'VOID' | 'CAPTURE';
747
+ interface RefundStatusChangedEvent {
748
+ /** Order details (limited to 30 items). */
749
+ order?: Order;
750
+ /** Updated transaction details. */
751
+ transaction?: Transaction;
752
+ /** Updated refund details. */
753
+ refund?: Refund;
754
+ /** Previous refund status. */
755
+ previousStatus?: RefundStatusWithLiterals;
756
+ }
757
+ interface Refund {
758
+ id?: string;
759
+ /** Amount and currency of refund */
760
+ amount?: CurrencyAmount;
761
+ /** Updated refund status */
762
+ status?: RefundStatusWithLiterals;
763
+ /** Reason provided for status change */
764
+ reasonCode?: string | null;
765
+ /** Refund creation date */
766
+ createdAt?: Date | null;
767
+ }
768
+ declare enum RefundStatus {
769
+ UNDEFINED = "UNDEFINED",
770
+ APPROVED = "APPROVED",
771
+ PENDING = "PENDING",
772
+ DECLINED = "DECLINED"
773
+ }
774
+ /** @enumType */
775
+ type RefundStatusWithLiterals = RefundStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'DECLINED';
776
+ interface RecurringPaymentStatusChangedEvent {
777
+ /** Order details(limited to 30 items). */
778
+ order?: Order;
779
+ /** Recurring payment status. */
780
+ status?: StatusWithLiterals;
781
+ /** Previous recurring payment status. */
782
+ previousStatus?: StatusWithLiterals;
783
+ /** Details of RecurringPayment cancellation (empty if `status` is not CANCELLED). */
784
+ cancellationDetails?: RecurringPaymentCancellationDetails;
785
+ }
786
+ declare enum Status {
787
+ UNDEFINED = "UNDEFINED",
788
+ PENDING = "PENDING",
789
+ ACTIVE = "ACTIVE",
790
+ CANCELLED = "CANCELLED",
791
+ FINISHED = "FINISHED",
792
+ SUSPENDED = "SUSPENDED"
793
+ }
794
+ /** @enumType */
795
+ type StatusWithLiterals = Status | 'UNDEFINED' | 'PENDING' | 'ACTIVE' | 'CANCELLED' | 'FINISHED' | 'SUSPENDED';
796
+ interface RecurringPaymentCancellationDetails {
797
+ /** Initiator of cancellation */
798
+ initiator?: InitiatorWithLiterals;
799
+ /** Successfully paid recurring cycles count before the cancellation */
800
+ paidRegularCycleCount?: number;
801
+ }
802
+ declare enum Initiator {
803
+ UNDEFINED = "UNDEFINED",
804
+ BUYER = "BUYER",
805
+ MERCHANT = "MERCHANT",
806
+ PAYMENT = "PAYMENT",
807
+ SETUP = "SETUP"
808
+ }
809
+ /** @enumType */
810
+ type InitiatorWithLiterals = Initiator | 'UNDEFINED' | 'BUYER' | 'MERCHANT' | 'PAYMENT' | 'SETUP';
811
+ interface TransactionUpdatedEvent {
812
+ /** Order details (limited to 30 items). */
813
+ order?: Order;
814
+ /** Updated transaction details. */
815
+ transaction?: Transaction;
816
+ /** Is event triggered by request to clean user data */
817
+ triggeredByAnonymizeRequest?: boolean | null;
818
+ }
819
+ interface TransactionCreatedEvent {
820
+ /** Order details (limited to 30 items). */
821
+ order?: Order;
822
+ /** Updated transaction details. */
823
+ transaction?: Transaction;
824
+ }
825
+ interface Empty {
826
+ }
827
+ interface OfflinePaymentSent {
828
+ /** Participant who started offline payment */
829
+ participant?: Participant;
830
+ }
831
+ interface PaymentFailed {
832
+ /** Participant whose payment was failed */
833
+ participant?: Participant;
834
+ }
835
+ interface SinglePaymentConfirmed {
836
+ /** Participant whose payment was confirmed */
837
+ participant?: Participant;
838
+ }
839
+ interface SinglePaymentDeclined {
840
+ /** Participant whose payment was declined */
841
+ participant?: Participant;
842
+ }
843
+ interface DomainEvent extends DomainEventBodyOneOf {
844
+ createdEvent?: EntityCreatedEvent;
845
+ updatedEvent?: EntityUpdatedEvent;
846
+ deletedEvent?: EntityDeletedEvent;
847
+ actionEvent?: ActionEvent;
848
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
849
+ id?: string;
850
+ /**
851
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
852
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
853
+ */
854
+ entityFqdn?: string;
855
+ /**
856
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
857
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
858
+ */
859
+ slug?: string;
860
+ /** ID of the entity associated with the event. */
861
+ entityId?: string;
862
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
863
+ eventTime?: Date | null;
864
+ /**
865
+ * Whether the event was triggered as a result of a privacy regulation application
866
+ * (for example, GDPR).
867
+ */
868
+ triggeredByAnonymizeRequest?: boolean | null;
869
+ /** If present, indicates the action that triggered the event. */
870
+ originatedFrom?: string | null;
871
+ /**
872
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
873
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
874
+ */
875
+ entityEventSequence?: string | null;
876
+ }
877
+ /** @oneof */
878
+ interface DomainEventBodyOneOf {
879
+ createdEvent?: EntityCreatedEvent;
880
+ updatedEvent?: EntityUpdatedEvent;
881
+ deletedEvent?: EntityDeletedEvent;
882
+ actionEvent?: ActionEvent;
883
+ }
884
+ interface EntityCreatedEvent {
885
+ entityAsJson?: string;
886
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
887
+ restoreInfo?: RestoreInfo;
888
+ }
889
+ interface RestoreInfo {
890
+ deletedDate?: Date | null;
891
+ }
892
+ interface EntityUpdatedEvent {
893
+ /**
894
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
895
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
896
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
897
+ */
898
+ currentEntityAsJson?: string;
899
+ }
900
+ interface EntityDeletedEvent {
901
+ /** Entity that was deleted. */
902
+ deletedEntityAsJson?: string | null;
903
+ }
904
+ interface ActionEvent {
905
+ bodyAsJson?: string;
906
+ }
907
+ interface BenefitNotification {
908
+ /**
909
+ * Plan unique ID
910
+ * @format GUID
911
+ */
912
+ planId?: string;
913
+ /**
914
+ * App def ID
915
+ * @format GUID
916
+ */
917
+ appDefId?: string;
918
+ /** Current benefit details */
919
+ benefit?: Benefit;
920
+ /** Previous benefit */
921
+ prevBenefit?: Benefit;
922
+ /** Notification event */
923
+ event?: EventWithLiterals;
924
+ }
925
+ interface Benefit {
926
+ /**
927
+ * Benefit unique ID
928
+ * @format GUID
929
+ * @readonly
930
+ */
931
+ id?: string | null;
932
+ /** Benefit Type */
933
+ benefitType?: BenefitTypeWithLiterals;
934
+ /**
935
+ * Resource IDs that serves by this benefit
936
+ * @format GUID
937
+ */
938
+ resourceIds?: string[];
939
+ /** Amount of credits that provided by this benefit */
940
+ creditAmount?: number | null;
941
+ /**
942
+ * additional details related to benefit; limited to 20 entries, 20 symbols for key and 20 symbols for value
943
+ * @maxSize 20
944
+ */
945
+ customFields?: Record<string, string>;
946
+ /** return value only in case it required in the ListRequest, true means that benefit's type could be updated */
947
+ editable?: boolean | null;
948
+ /** Benefit behavior */
949
+ behavior?: Behavior;
950
+ /**
951
+ * Id of the app associated with this benefit
952
+ * @format GUID
953
+ * @readonly
954
+ */
955
+ appDefId?: string | null;
956
+ }
957
+ interface EntryPass {
958
+ }
959
+ interface Discount extends DiscountDiscountOneOf {
960
+ /**
961
+ * Fixed-rate percent off discount
962
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
963
+ */
964
+ percentOffRate?: string;
965
+ /**
966
+ * Absolute amount discount
967
+ * @decimalValue options { gt:0, maxScale:2 }
968
+ */
969
+ moneyOffAmount?: string;
970
+ }
971
+ /** @oneof */
972
+ interface DiscountDiscountOneOf {
973
+ /**
974
+ * Fixed-rate percent off discount
975
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
976
+ */
977
+ percentOffRate?: string;
978
+ /**
979
+ * Absolute amount discount
980
+ * @decimalValue options { gt:0, maxScale:2 }
981
+ */
982
+ moneyOffAmount?: string;
983
+ }
984
+ declare enum BenefitType {
985
+ /** Should never be used */
986
+ UNDEFINED = "UNDEFINED",
987
+ /** Limited benefit type */
988
+ LIMITED = "LIMITED",
989
+ /** Unlimited benefit type */
990
+ UNLIMITED = "UNLIMITED"
991
+ }
992
+ /** @enumType */
993
+ type BenefitTypeWithLiterals = BenefitType | 'UNDEFINED' | 'LIMITED' | 'UNLIMITED';
994
+ interface Behavior extends BehaviorBehaviorOneOf {
995
+ /** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
996
+ defaultBehavior?: EntryPass;
997
+ /** Discount applied to paid resources */
998
+ discount?: Discount;
999
+ }
1000
+ /** @oneof */
1001
+ interface BehaviorBehaviorOneOf {
1002
+ /** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
1003
+ defaultBehavior?: EntryPass;
1004
+ /** Discount applied to paid resources */
1005
+ discount?: Discount;
1006
+ }
1007
+ declare enum Event {
1008
+ Updated = "Updated",
1009
+ Deleted = "Deleted",
1010
+ Created = "Created"
1011
+ }
1012
+ /** @enumType */
1013
+ type EventWithLiterals = Event | 'Updated' | 'Deleted' | 'Created';
1014
+ interface MessageEnvelope {
1015
+ /**
1016
+ * App instance ID.
1017
+ * @format GUID
1018
+ */
1019
+ instanceId?: string | null;
1020
+ /**
1021
+ * Event type.
1022
+ * @maxLength 150
1023
+ */
1024
+ eventType?: string;
1025
+ /** The identification type and identity data. */
1026
+ identity?: IdentificationData;
1027
+ /** Stringify payload. */
1028
+ data?: string;
1029
+ }
1030
+ interface IdentificationData extends IdentificationDataIdOneOf {
1031
+ /**
1032
+ * ID of a site visitor that has not logged in to the site.
1033
+ * @format GUID
1034
+ */
1035
+ anonymousVisitorId?: string;
1036
+ /**
1037
+ * ID of a site visitor that has logged in to the site.
1038
+ * @format GUID
1039
+ */
1040
+ memberId?: string;
1041
+ /**
1042
+ * ID of a Wix user (site owner, contributor, etc.).
1043
+ * @format GUID
1044
+ */
1045
+ wixUserId?: string;
1046
+ /**
1047
+ * ID of an app.
1048
+ * @format GUID
1049
+ */
1050
+ appId?: string;
1051
+ /** @readonly */
1052
+ identityType?: WebhookIdentityTypeWithLiterals;
1053
+ }
1054
+ /** @oneof */
1055
+ interface IdentificationDataIdOneOf {
1056
+ /**
1057
+ * ID of a site visitor that has not logged in to the site.
1058
+ * @format GUID
1059
+ */
1060
+ anonymousVisitorId?: string;
1061
+ /**
1062
+ * ID of a site visitor that has logged in to the site.
1063
+ * @format GUID
1064
+ */
1065
+ memberId?: string;
1066
+ /**
1067
+ * ID of a Wix user (site owner, contributor, etc.).
1068
+ * @format GUID
1069
+ */
1070
+ wixUserId?: string;
1071
+ /**
1072
+ * ID of an app.
1073
+ * @format GUID
1074
+ */
1075
+ appId?: string;
1076
+ }
1077
+ declare enum WebhookIdentityType {
1078
+ UNKNOWN = "UNKNOWN",
1079
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1080
+ MEMBER = "MEMBER",
1081
+ WIX_USER = "WIX_USER",
1082
+ APP = "APP"
1083
+ }
1084
+ /** @enumType */
1085
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
336
1086
  interface BulkInviteToProgramRequest {
337
1087
  /**
338
1088
  * Program to which bulk invite participants.
@@ -387,6 +1137,18 @@ interface BulkActionMetadata {
387
1137
  /** Number of failures without details because detailed failure threshold was exceeded. */
388
1138
  undetailedFailures?: number;
389
1139
  }
1140
+ interface ParticipantInvited {
1141
+ /**
1142
+ * Program to which bulk invite participants.
1143
+ * @format GUID
1144
+ */
1145
+ programId?: string;
1146
+ /**
1147
+ * Invited member to program
1148
+ * @format GUID
1149
+ */
1150
+ memberId?: string;
1151
+ }
390
1152
  interface BulkInviteAllToProgramRequest {
391
1153
  /**
392
1154
  * Program to which bulk add participants.
@@ -432,6 +1194,18 @@ interface BulkAddToProgramResult {
432
1194
  /** Added participant */
433
1195
  item?: Participant;
434
1196
  }
1197
+ interface ParticipantAdded {
1198
+ /**
1199
+ * Program ID which participant was added
1200
+ * @format GUID
1201
+ */
1202
+ programId?: string;
1203
+ /**
1204
+ * Member ID of participant on site
1205
+ * @format GUID
1206
+ */
1207
+ memberId?: string;
1208
+ }
435
1209
  interface BulkAddAllToProgramRequest {
436
1210
  /**
437
1211
  * Program to which bulk add participants.
@@ -476,6 +1250,18 @@ interface BulkApproveParticipantResult {
476
1250
  /** Approved or existing participant */
477
1251
  item?: Participant;
478
1252
  }
1253
+ interface ParticipantApproved {
1254
+ /**
1255
+ * Program ID which participant approved
1256
+ * @format GUID
1257
+ */
1258
+ programId?: string;
1259
+ /**
1260
+ * Member ID of participant approved
1261
+ * @format GUID
1262
+ */
1263
+ memberId?: string;
1264
+ }
479
1265
  interface BulkApproveAllParticipantRequest {
480
1266
  /**
481
1267
  * Program to approve all participants.
@@ -505,6 +1291,18 @@ interface DeleteParticipantRequest {
505
1291
  }
506
1292
  interface DeleteParticipantResponse {
507
1293
  }
1294
+ interface ParticipantRejected {
1295
+ /**
1296
+ * Program ID which participant rejected
1297
+ * @format GUID
1298
+ */
1299
+ programId?: string;
1300
+ /**
1301
+ * Member ID of participant rejected
1302
+ * @format GUID
1303
+ */
1304
+ memberId?: string;
1305
+ }
508
1306
  interface IssueCertificateRequest {
509
1307
  /**
510
1308
  * Participant to get certificate
@@ -548,6 +1346,25 @@ interface ExportParticipantsStatsRequest {
548
1346
  }
549
1347
  interface ExportParticipantsStatsResponse {
550
1348
  }
1349
+ interface ParticipantExportsFinished {
1350
+ /**
1351
+ * program id from which stats were exported
1352
+ * @format GUID
1353
+ */
1354
+ programId?: string;
1355
+ /**
1356
+ * user id of program owner
1357
+ * @format GUID
1358
+ */
1359
+ userId?: string;
1360
+ /**
1361
+ * url to download report
1362
+ * @format WEB_URL
1363
+ */
1364
+ downloadUrl?: string;
1365
+ /** days url will be downloadable */
1366
+ downloadUrlTtlDays?: number;
1367
+ }
551
1368
 
552
1369
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
553
1370
  getUrl: (context: any) => string;
@@ -596,4 +1413,4 @@ declare function exportParticipantsStats(): __PublicMethodMetaInfo<'GET', {
596
1413
  programId: string;
597
1414
  }, ExportParticipantsStatsRequest$1, ExportParticipantsStatsRequest, ExportParticipantsStatsResponse$1, ExportParticipantsStatsResponse>;
598
1415
 
599
- export { type __PublicMethodMetaInfo, applyCoupon, bulkAddAllToProgram, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkInviteAllToProgram, bulkInviteToProgram, deleteParticipant, exportParticipantsStats, getAccessStatus, getCompletionStats, getParticipant, getPremiumStats, issueCertificate, joinProgram, leaveProgram, queryParticipants, revertCoupon };
1416
+ export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressStreetOneOf as AddressStreetOneOfOriginal, type ApplicationError as ApplicationErrorOriginal, type ApplyCouponRequest as ApplyCouponRequestOriginal, type ApplyCouponResponse as ApplyCouponResponseOriginal, type AutoRemovedOptions as AutoRemovedOptionsOriginal, type BehaviorBehaviorOneOf as BehaviorBehaviorOneOfOriginal, type Behavior as BehaviorOriginal, type BenefitNotification as BenefitNotificationOriginal, type Benefit as BenefitOriginal, BenefitType as BenefitTypeOriginal, type BenefitTypeWithLiterals as BenefitTypeWithLiteralsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkAddAllToProgramRequest as BulkAddAllToProgramRequestOriginal, type BulkAddAllToProgramResponse as BulkAddAllToProgramResponseOriginal, type BulkAddToProgramRequest as BulkAddToProgramRequestOriginal, type BulkAddToProgramResponse as BulkAddToProgramResponseOriginal, type BulkAddToProgramResult as BulkAddToProgramResultOriginal, type BulkApproveAllParticipantRequest as BulkApproveAllParticipantRequestOriginal, type BulkApproveAllParticipantResponse as BulkApproveAllParticipantResponseOriginal, type BulkApproveParticipantRequest as BulkApproveParticipantRequestOriginal, type BulkApproveParticipantResponse as BulkApproveParticipantResponseOriginal, type BulkApproveParticipantResult as BulkApproveParticipantResultOriginal, type BulkInviteAllToProgramRequest as BulkInviteAllToProgramRequestOriginal, type BulkInviteAllToProgramResponse as BulkInviteAllToProgramResponseOriginal, type BulkInviteToProgramRequest as BulkInviteToProgramRequestOriginal, type BulkInviteToProgramResponse as BulkInviteToProgramResponseOriginal, type BulkInviteToProgramResult as BulkInviteToProgramResultOriginal, type Certificate as CertificateOriginal, type CompletedOptions as CompletedOptionsOriginal, type CreditCardPaymentMethodData as CreditCardPaymentMethodDataOriginal, type CurrencyAmount as CurrencyAmountOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DeleteParticipantRequest as DeleteParticipantRequestOriginal, type DeleteParticipantResponse as DeleteParticipantResponseOriginal, type DiscountDiscountOneOf as DiscountDiscountOneOfOriginal, type Discount as DiscountOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type EntryPass as EntryPassOriginal, Event as EventOriginal, EventType as EventTypeOriginal, type EventTypeWithLiterals as EventTypeWithLiteralsOriginal, type EventWithLiterals as EventWithLiteralsOriginal, type ExportParticipantsStatsRequest as ExportParticipantsStatsRequestOriginal, type ExportParticipantsStatsResponse as ExportParticipantsStatsResponseOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FailedOptions as FailedOptionsOriginal, type FreeCouponOptions as FreeCouponOptionsOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type GetAccessStatusRequest as GetAccessStatusRequestOriginal, type GetAccessStatusResponse as GetAccessStatusResponseOriginal, type GetCompletionStatsRequest as GetCompletionStatsRequestOriginal, type GetCompletionStatsResponse as GetCompletionStatsResponseOriginal, type GetParticipantRequest as GetParticipantRequestOriginal, type GetParticipantResponse as GetParticipantResponseOriginal, type GetPremiumStatsRequest as GetPremiumStatsRequestOriginal, type GetPremiumStatsResponse as GetPremiumStatsResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, Initiator as InitiatorOriginal, type InitiatorWithLiterals as InitiatorWithLiteralsOriginal, type IssueCertificateRequest as IssueCertificateRequestOriginal, type IssueCertificateResponse as IssueCertificateResponseOriginal, type ItemMetadata as ItemMetadataOriginal, JoinPath as JoinPathOriginal, type JoinPathWithLiterals as JoinPathWithLiteralsOriginal, type JoinProgramRequest as JoinProgramRequestOriginal, type JoinProgramResponse as JoinProgramResponseOriginal, type JoinedOptionsJoinPathOptionsOneOf as JoinedOptionsJoinPathOptionsOneOfOriginal, type JoinedOptions as JoinedOptionsOriginal, type LeaveProgramRequest as LeaveProgramRequestOriginal, type LeaveProgramResponse as LeaveProgramResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type OfflinePaymentSent as OfflinePaymentSentOriginal, type OrderAdditionalCharges as OrderAdditionalChargesOriginal, OrderItemCategory as OrderItemCategoryOriginal, type OrderItemCategoryWithLiterals as OrderItemCategoryWithLiteralsOriginal, type OrderItem as OrderItemOriginal, type Order as OrderOriginal, type PaidPlanOptions as PaidPlanOptionsOriginal, type ParticipantAdded as ParticipantAddedOriginal, type ParticipantApproved as ParticipantApprovedOriginal, type ParticipantExportsFinished as ParticipantExportsFinishedOriginal, type ParticipantInvited as ParticipantInvitedOriginal, type ParticipantJoined as ParticipantJoinedOriginal, type ParticipantLeft as ParticipantLeftOriginal, type Participant as ParticipantOriginal, type ParticipantRejected as ParticipantRejectedOriginal, type ParticipantStateOptionsOneOf as ParticipantStateOptionsOneOfOriginal, type PaymentEventEventOneOf as PaymentEventEventOneOfOriginal, type PaymentEvent as PaymentEventOriginal, type PaymentFailed as PaymentFailedOriginal, type PaymentPendingOptions as PaymentPendingOptionsOriginal, type Progress as ProgressOriginal, type QueryParticipantsRequest as QueryParticipantsRequestOriginal, type QueryParticipantsResponse as QueryParticipantsResponseOriginal, type RecurringPaymentCancellationDetails as RecurringPaymentCancellationDetailsOriginal, type RecurringPaymentDetails as RecurringPaymentDetailsOriginal, type RecurringPaymentStatusChangedEvent as RecurringPaymentStatusChangedEventOriginal, type Refund as RefundOriginal, type RefundStatusChangedEvent as RefundStatusChangedEventOriginal, RefundStatus as RefundStatusOriginal, type RefundStatusWithLiterals as RefundStatusWithLiteralsOriginal, RemovalReason as RemovalReasonOriginal, type RemovalReasonWithLiterals as RemovalReasonWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type RevertCouponRequest as RevertCouponRequestOriginal, type RevertCouponResponse as RevertCouponResponseOriginal, type ScheduledAction as ScheduledActionOriginal, ScheduledActionType as ScheduledActionTypeOriginal, type ScheduledActionTypeWithLiterals as ScheduledActionTypeWithLiteralsOriginal, type SinglePaymentConfirmed as SinglePaymentConfirmedOriginal, type SinglePaymentDeclined as SinglePaymentDeclinedOriginal, type SinglePaymentOptions as SinglePaymentOptionsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type StandardDetails as StandardDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type SuspendedOptions as SuspendedOptionsOriginal, type TransactionCreatedEvent as TransactionCreatedEventOriginal, type Transaction as TransactionOriginal, type TransactionPaymentMethodDataOneOf as TransactionPaymentMethodDataOneOfOriginal, type TransactionStatusChangedEvent as TransactionStatusChangedEventOriginal, TransactionStatus as TransactionStatusOriginal, type TransactionStatusWithLiterals as TransactionStatusWithLiteralsOriginal, type TransactionUpdatedEvent as TransactionUpdatedEventOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, applyCoupon, bulkAddAllToProgram, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkInviteAllToProgram, bulkInviteToProgram, deleteParticipant, exportParticipantsStats, getAccessStatus, getCompletionStats, getParticipant, getPremiumStats, issueCertificate, joinProgram, leaveProgram, queryParticipants, revertCoupon };