@wix/auto_sdk_calendar_events 1.0.30 → 1.0.31
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/{calendar-v3-event-events.universal-Cfq4Piiv.d.mts → calendar-v3-event-events.universal-oZbWDSxX.d.mts} +625 -385
- package/build/{calendar-v3-event-events.universal-Cfq4Piiv.d.ts → calendar-v3-event-events.universal-oZbWDSxX.d.ts} +625 -385
- package/build/index.d.mts +39 -3
- package/build/index.d.ts +39 -3
- package/build/index.js +230 -19
- package/build/index.js.map +1 -1
- package/build/index.mjs +228 -19
- package/build/index.mjs.map +1 -1
- package/build/internal/{calendar-v3-event-events.universal-Cfq4Piiv.d.mts → calendar-v3-event-events.universal-oZbWDSxX.d.mts} +625 -385
- package/build/internal/{calendar-v3-event-events.universal-Cfq4Piiv.d.ts → calendar-v3-event-events.universal-oZbWDSxX.d.ts} +625 -385
- package/build/internal/index.d.mts +39 -3
- package/build/internal/index.d.ts +39 -3
- package/build/internal/index.js +230 -19
- package/build/internal/index.js.map +1 -1
- package/build/internal/index.mjs +228 -19
- package/build/internal/index.mjs.map +1 -1
- package/build/internal/meta.d.mts +160 -2
- package/build/internal/meta.d.ts +160 -2
- package/build/internal/meta.js +153 -0
- package/build/internal/meta.js.map +1 -1
- package/build/internal/meta.mjs +151 -0
- package/build/internal/meta.mjs.map +1 -1
- package/build/meta.d.mts +160 -2
- package/build/meta.d.ts +160 -2
- package/build/meta.js +153 -0
- package/build/meta.js.map +1 -1
- package/build/meta.mjs +151 -0
- package/build/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -669,23 +669,445 @@ interface EventUpdatedWithMetadata {
|
|
|
669
669
|
*/
|
|
670
670
|
participantNotification?: ParticipantNotification;
|
|
671
671
|
}
|
|
672
|
-
interface
|
|
673
|
-
/**
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
672
|
+
interface ListEventsByContactIdRequest {
|
|
673
|
+
/**
|
|
674
|
+
* ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
|
|
675
|
+
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
676
|
+
* @format GUID
|
|
677
|
+
*/
|
|
678
|
+
contactId: string | null;
|
|
679
|
+
/**
|
|
680
|
+
* Local start date and time from which events are returned in
|
|
681
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
682
|
+
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
683
|
+
*
|
|
684
|
+
* Events that start before the `fromLocalDate` but end after it are included in
|
|
685
|
+
* the results. Must be earlier than `toLocalDate`.
|
|
686
|
+
* @format LOCAL_DATE_TIME
|
|
687
|
+
*/
|
|
688
|
+
fromLocalDate?: string | null;
|
|
689
|
+
/**
|
|
690
|
+
* Local end date and time up to which events are returned in
|
|
691
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
692
|
+
* `2024-01-30T13:30:00`. Can't be more than a full year after
|
|
693
|
+
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
694
|
+
*
|
|
695
|
+
* Events that start before `toLocalDate` but end after it are included in the
|
|
696
|
+
* results. Must be later than `fromLocalDate`.
|
|
697
|
+
* @format LOCAL_DATE_TIME
|
|
698
|
+
*/
|
|
699
|
+
toLocalDate?: string | null;
|
|
700
|
+
/**
|
|
701
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
702
|
+
* for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
|
|
703
|
+
* `adjustedEnd`. For example, `America/New_York` or `UTC`.
|
|
704
|
+
*
|
|
705
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
706
|
+
*/
|
|
707
|
+
timeZone?: string | null;
|
|
708
|
+
/**
|
|
709
|
+
* [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
|
|
710
|
+
* to filter events by.
|
|
711
|
+
* @format GUID
|
|
712
|
+
*/
|
|
713
|
+
appId?: string | null;
|
|
714
|
+
/** Cursor to retrieve the next page of the results. */
|
|
715
|
+
cursorPaging?: CommonCursorPaging;
|
|
678
716
|
}
|
|
679
|
-
|
|
717
|
+
/** TODO Diverge */
|
|
718
|
+
interface CommonCursorPaging {
|
|
719
|
+
/**
|
|
720
|
+
* Number of events to return.
|
|
721
|
+
* Defaults to `50`. Maximum `100`.
|
|
722
|
+
* @min 1
|
|
723
|
+
* @max 100
|
|
724
|
+
*/
|
|
725
|
+
limit?: number | null;
|
|
726
|
+
/**
|
|
727
|
+
* Pointer to the next or previous page in the list of results.
|
|
728
|
+
*
|
|
729
|
+
* You can get the relevant cursor token
|
|
730
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
731
|
+
* Not relevant for the first request.
|
|
732
|
+
*/
|
|
733
|
+
cursor?: string | null;
|
|
680
734
|
}
|
|
681
|
-
interface
|
|
682
|
-
/**
|
|
683
|
-
|
|
684
|
-
/**
|
|
685
|
-
|
|
686
|
-
migrateBusinessConferenceId?: boolean;
|
|
735
|
+
interface ListEventsByContactIdResponse {
|
|
736
|
+
/** Retrieved events. */
|
|
737
|
+
events?: Event[];
|
|
738
|
+
/** Paging metadata. */
|
|
739
|
+
pagingMetadata?: CommonCursorPagingMetadata;
|
|
687
740
|
}
|
|
688
|
-
|
|
741
|
+
/** TODO Diverge */
|
|
742
|
+
interface CommonCursorPagingMetadata {
|
|
743
|
+
/** Number of items returned in the response. */
|
|
744
|
+
count?: number | null;
|
|
745
|
+
/** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
|
|
746
|
+
cursors?: CommonCursors;
|
|
747
|
+
/**
|
|
748
|
+
* Indicates if there are more results after the current page.
|
|
749
|
+
* If `true`, another page of results can be retrieved.
|
|
750
|
+
* If `false`, this is the last page.
|
|
751
|
+
*/
|
|
752
|
+
hasNext?: boolean | null;
|
|
753
|
+
}
|
|
754
|
+
interface CommonCursors {
|
|
755
|
+
/** Cursor pointing to next page in the list of results. */
|
|
756
|
+
next?: string | null;
|
|
757
|
+
}
|
|
758
|
+
interface ListEventsByMemberIdRequest {
|
|
759
|
+
/**
|
|
760
|
+
* ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
|
|
761
|
+
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
762
|
+
* Provide `me` to retrieve events for the currently logged-in member.
|
|
763
|
+
* You must have the `Read Calendars - Including PI`
|
|
764
|
+
* [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
|
|
765
|
+
* to retrieve events for members who aren't the currently logged in member.
|
|
766
|
+
* @minLength 2
|
|
767
|
+
* @maxLength 36
|
|
768
|
+
*/
|
|
769
|
+
memberId: string | null;
|
|
770
|
+
/**
|
|
771
|
+
* Local start date and time from which events are returned in
|
|
772
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
773
|
+
* `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
774
|
+
*
|
|
775
|
+
* Events that start before the `fromLocalDate` but end after it are included in
|
|
776
|
+
* the results. Must be earlier than `toLocalDate`.
|
|
777
|
+
* @format LOCAL_DATE_TIME
|
|
778
|
+
*/
|
|
779
|
+
fromLocalDate?: string | null;
|
|
780
|
+
/**
|
|
781
|
+
* Local end date and time up to which events are returned in
|
|
782
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
783
|
+
* `2024-01-30T13:30:00`. Can't be more than a full year after
|
|
784
|
+
* `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
785
|
+
*
|
|
786
|
+
* Events that start before `toLocalDate` but end after it are included in the
|
|
787
|
+
* results. Must be later than `fromLocalDate`.
|
|
788
|
+
* @format LOCAL_DATE_TIME
|
|
789
|
+
*/
|
|
790
|
+
toLocalDate?: string | null;
|
|
791
|
+
/**
|
|
792
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
793
|
+
* for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
|
|
794
|
+
* `adjustedEnd`. For example, `America/New_York` or `UTC`.
|
|
795
|
+
*
|
|
796
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
797
|
+
*/
|
|
798
|
+
timeZone?: string | null;
|
|
799
|
+
/**
|
|
800
|
+
* [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
|
|
801
|
+
* to filter events by.
|
|
802
|
+
* @format GUID
|
|
803
|
+
*/
|
|
804
|
+
appId?: string | null;
|
|
805
|
+
/** Cursor to retrieve the next page of the results. */
|
|
806
|
+
cursorPaging?: CommonCursorPaging;
|
|
807
|
+
/**
|
|
808
|
+
* IDs of the events to retrieve.
|
|
809
|
+
* If you provide a list of IDs, all other filters are ignored.
|
|
810
|
+
*
|
|
811
|
+
* Max: 100 `eventId`s
|
|
812
|
+
* @maxSize 100
|
|
813
|
+
* @minLength 36
|
|
814
|
+
* @maxLength 250
|
|
815
|
+
*/
|
|
816
|
+
eventIds?: string[];
|
|
817
|
+
}
|
|
818
|
+
interface ListEventsByMemberIdResponse {
|
|
819
|
+
/** Retrieved events. */
|
|
820
|
+
events?: Event[];
|
|
821
|
+
/** Paging metadata. */
|
|
822
|
+
pagingMetadata?: CommonCursorPagingMetadata;
|
|
823
|
+
}
|
|
824
|
+
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
825
|
+
interface SitePropertiesNotification {
|
|
826
|
+
/** The site ID for which this update notification applies. */
|
|
827
|
+
metasiteId?: string;
|
|
828
|
+
/** The actual update event. */
|
|
829
|
+
event?: SitePropertiesEvent;
|
|
830
|
+
/**
|
|
831
|
+
* A convenience set of mappings from the MetaSite ID to its constituent services.
|
|
832
|
+
* @maxSize 500
|
|
833
|
+
*/
|
|
834
|
+
translations?: Translation[];
|
|
835
|
+
/** Context of the notification */
|
|
836
|
+
changeContext?: ChangeContext;
|
|
837
|
+
}
|
|
838
|
+
/** The actual update event for a particular notification. */
|
|
839
|
+
interface SitePropertiesEvent {
|
|
840
|
+
/** Version of the site's properties represented by this update. */
|
|
841
|
+
version?: number;
|
|
842
|
+
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
843
|
+
fields?: string[];
|
|
844
|
+
/** Updated properties. */
|
|
845
|
+
properties?: Properties;
|
|
846
|
+
}
|
|
847
|
+
interface Properties {
|
|
848
|
+
/** Site categories. */
|
|
849
|
+
categories?: Categories;
|
|
850
|
+
/** Site locale. */
|
|
851
|
+
locale?: Locale;
|
|
852
|
+
/**
|
|
853
|
+
* Site language.
|
|
854
|
+
*
|
|
855
|
+
* Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
856
|
+
*/
|
|
857
|
+
language?: string | null;
|
|
858
|
+
/**
|
|
859
|
+
* Site currency format used to bill customers.
|
|
860
|
+
*
|
|
861
|
+
* Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
862
|
+
*/
|
|
863
|
+
paymentCurrency?: string | null;
|
|
864
|
+
/** Timezone in `America/New_York` format. */
|
|
865
|
+
timeZone?: string | null;
|
|
866
|
+
/** Email address. */
|
|
867
|
+
email?: string | null;
|
|
868
|
+
/** Phone number. */
|
|
869
|
+
phone?: string | null;
|
|
870
|
+
/** Fax number. */
|
|
871
|
+
fax?: string | null;
|
|
872
|
+
/** Address. */
|
|
873
|
+
address?: Address;
|
|
874
|
+
/** Site display name. */
|
|
875
|
+
siteDisplayName?: string | null;
|
|
876
|
+
/** Business name. */
|
|
877
|
+
businessName?: string | null;
|
|
878
|
+
/** Path to the site's logo in Wix Media (without Wix Media base URL). */
|
|
879
|
+
logo?: string | null;
|
|
880
|
+
/** Site description. */
|
|
881
|
+
description?: string | null;
|
|
882
|
+
/**
|
|
883
|
+
* Business schedule. Regular and exceptional time periods when the business is open or the service is available.
|
|
884
|
+
*
|
|
885
|
+
* __Note:__ Not supported by Wix Bookings.
|
|
886
|
+
*/
|
|
887
|
+
businessSchedule?: BusinessSchedule;
|
|
888
|
+
/** Supported languages of a site and the primary language. */
|
|
889
|
+
multilingual?: Multilingual;
|
|
890
|
+
/** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
|
|
891
|
+
consentPolicy?: ConsentPolicy;
|
|
892
|
+
/**
|
|
893
|
+
* Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
|
|
894
|
+
*
|
|
895
|
+
* Site business type.
|
|
896
|
+
*/
|
|
897
|
+
businessConfig?: string | null;
|
|
898
|
+
/** External site URL that uses Wix as its headless business solution. */
|
|
899
|
+
externalSiteUrl?: string | null;
|
|
900
|
+
/** Track clicks analytics. */
|
|
901
|
+
trackClicksAnalytics?: boolean;
|
|
902
|
+
}
|
|
903
|
+
interface Categories {
|
|
904
|
+
/** Primary site category. */
|
|
905
|
+
primary?: string;
|
|
906
|
+
/**
|
|
907
|
+
* Secondary site category.
|
|
908
|
+
* @maxSize 50
|
|
909
|
+
*/
|
|
910
|
+
secondary?: string[];
|
|
911
|
+
/** Business Term Id */
|
|
912
|
+
businessTermId?: string | null;
|
|
913
|
+
}
|
|
914
|
+
interface Locale {
|
|
915
|
+
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
916
|
+
languageCode?: string;
|
|
917
|
+
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
918
|
+
country?: string;
|
|
919
|
+
}
|
|
920
|
+
interface Address {
|
|
921
|
+
/** Street name. */
|
|
922
|
+
street?: string;
|
|
923
|
+
/** City name. */
|
|
924
|
+
city?: string;
|
|
925
|
+
/** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
|
|
926
|
+
country?: string;
|
|
927
|
+
/** State. */
|
|
928
|
+
state?: string;
|
|
929
|
+
/**
|
|
930
|
+
* Zip or postal code.
|
|
931
|
+
* @maxLength 20
|
|
932
|
+
*/
|
|
933
|
+
zip?: string;
|
|
934
|
+
/** Extra information to be displayed in the address. */
|
|
935
|
+
hint?: AddressHint;
|
|
936
|
+
/** Whether this address represents a physical location. */
|
|
937
|
+
isPhysical?: boolean;
|
|
938
|
+
/** Google-formatted version of this address. */
|
|
939
|
+
googleFormattedAddress?: string;
|
|
940
|
+
/** Street number. */
|
|
941
|
+
streetNumber?: string;
|
|
942
|
+
/** Apartment number. */
|
|
943
|
+
apartmentNumber?: string;
|
|
944
|
+
/** Geographic coordinates of location. */
|
|
945
|
+
coordinates?: GeoCoordinates;
|
|
946
|
+
}
|
|
947
|
+
/**
|
|
948
|
+
* Extra information on displayed addresses.
|
|
949
|
+
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
950
|
+
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
951
|
+
*/
|
|
952
|
+
interface AddressHint {
|
|
953
|
+
/** Extra text displayed next to, or instead of, the actual address. */
|
|
954
|
+
text?: string;
|
|
955
|
+
/** Where the extra text should be displayed. */
|
|
956
|
+
placement?: PlacementTypeWithLiterals;
|
|
957
|
+
}
|
|
958
|
+
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
959
|
+
declare enum PlacementType {
|
|
960
|
+
BEFORE = "BEFORE",
|
|
961
|
+
AFTER = "AFTER",
|
|
962
|
+
REPLACE = "REPLACE"
|
|
963
|
+
}
|
|
964
|
+
/** @enumType */
|
|
965
|
+
type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
|
|
966
|
+
/** Geocoordinates for a particular address. */
|
|
967
|
+
interface GeoCoordinates {
|
|
968
|
+
/** Latitude of the location. Must be between -90 and 90. */
|
|
969
|
+
latitude?: number;
|
|
970
|
+
/** Longitude of the location. Must be between -180 and 180. */
|
|
971
|
+
longitude?: number;
|
|
972
|
+
}
|
|
973
|
+
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
974
|
+
interface BusinessSchedule {
|
|
975
|
+
/**
|
|
976
|
+
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
977
|
+
* @maxSize 100
|
|
978
|
+
*/
|
|
979
|
+
periods?: TimePeriod[];
|
|
980
|
+
/**
|
|
981
|
+
* Exceptions to the business's regular hours. The business can be open or closed during the exception.
|
|
982
|
+
* @maxSize 100
|
|
983
|
+
*/
|
|
984
|
+
specialHourPeriod?: SpecialHourPeriod[];
|
|
985
|
+
}
|
|
986
|
+
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
987
|
+
interface TimePeriod {
|
|
988
|
+
/** Day of the week the period starts on. */
|
|
989
|
+
openDay?: DayOfWeekWithLiterals;
|
|
990
|
+
/**
|
|
991
|
+
* Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
992
|
+
* midnight at the end of the specified day.
|
|
993
|
+
*/
|
|
994
|
+
openTime?: string;
|
|
995
|
+
/** Day of the week the period ends on. */
|
|
996
|
+
closeDay?: DayOfWeekWithLiterals;
|
|
997
|
+
/**
|
|
998
|
+
* Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
999
|
+
* midnight at the end of the specified day.
|
|
1000
|
+
*
|
|
1001
|
+
* __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
|
|
1002
|
+
*/
|
|
1003
|
+
closeTime?: string;
|
|
1004
|
+
}
|
|
1005
|
+
/** Enumerates the days of the week. */
|
|
1006
|
+
declare enum DayOfWeek {
|
|
1007
|
+
MONDAY = "MONDAY",
|
|
1008
|
+
TUESDAY = "TUESDAY",
|
|
1009
|
+
WEDNESDAY = "WEDNESDAY",
|
|
1010
|
+
THURSDAY = "THURSDAY",
|
|
1011
|
+
FRIDAY = "FRIDAY",
|
|
1012
|
+
SATURDAY = "SATURDAY",
|
|
1013
|
+
SUNDAY = "SUNDAY"
|
|
1014
|
+
}
|
|
1015
|
+
/** @enumType */
|
|
1016
|
+
type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
1017
|
+
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
1018
|
+
interface SpecialHourPeriod {
|
|
1019
|
+
/** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
1020
|
+
startDate?: string;
|
|
1021
|
+
/** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
1022
|
+
endDate?: string;
|
|
1023
|
+
/**
|
|
1024
|
+
* Whether the business is closed (or the service is not available) during the exception.
|
|
1025
|
+
*
|
|
1026
|
+
* Default: `true`.
|
|
1027
|
+
*/
|
|
1028
|
+
isClosed?: boolean;
|
|
1029
|
+
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
1030
|
+
comment?: string;
|
|
1031
|
+
}
|
|
1032
|
+
interface Multilingual {
|
|
1033
|
+
/**
|
|
1034
|
+
* Supported languages list.
|
|
1035
|
+
* @maxSize 200
|
|
1036
|
+
*/
|
|
1037
|
+
supportedLanguages?: SupportedLanguage[];
|
|
1038
|
+
/** Whether to redirect to user language. */
|
|
1039
|
+
autoRedirect?: boolean;
|
|
1040
|
+
}
|
|
1041
|
+
interface SupportedLanguage {
|
|
1042
|
+
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1043
|
+
languageCode?: string;
|
|
1044
|
+
/** Locale. */
|
|
1045
|
+
locale?: Locale;
|
|
1046
|
+
/** Whether the supported language is the primary language for the site. */
|
|
1047
|
+
isPrimary?: boolean;
|
|
1048
|
+
/** Language icon. */
|
|
1049
|
+
countryCode?: string;
|
|
1050
|
+
/** How the language will be resolved. For internal use. */
|
|
1051
|
+
resolutionMethod?: ResolutionMethodWithLiterals;
|
|
1052
|
+
/** Whether the supported language is the primary language for site visitors. */
|
|
1053
|
+
isVisitorPrimary?: boolean | null;
|
|
1054
|
+
}
|
|
1055
|
+
declare enum ResolutionMethod {
|
|
1056
|
+
QUERY_PARAM = "QUERY_PARAM",
|
|
1057
|
+
SUBDOMAIN = "SUBDOMAIN",
|
|
1058
|
+
SUBDIRECTORY = "SUBDIRECTORY"
|
|
1059
|
+
}
|
|
1060
|
+
/** @enumType */
|
|
1061
|
+
type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
|
|
1062
|
+
interface ConsentPolicy {
|
|
1063
|
+
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
1064
|
+
essential?: boolean | null;
|
|
1065
|
+
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
1066
|
+
functional?: boolean | null;
|
|
1067
|
+
/** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
|
|
1068
|
+
analytics?: boolean | null;
|
|
1069
|
+
/** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
|
|
1070
|
+
advertising?: boolean | null;
|
|
1071
|
+
/** CCPA compliance flag. */
|
|
1072
|
+
dataToThirdParty?: boolean | null;
|
|
1073
|
+
}
|
|
1074
|
+
/** A single mapping from the MetaSite ID to a particular service. */
|
|
1075
|
+
interface Translation {
|
|
1076
|
+
/** The service type. */
|
|
1077
|
+
serviceType?: string;
|
|
1078
|
+
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
1079
|
+
appDefId?: string;
|
|
1080
|
+
/** The instance ID of the service. */
|
|
1081
|
+
instanceId?: string;
|
|
1082
|
+
}
|
|
1083
|
+
interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
1084
|
+
/** Properties were updated. */
|
|
1085
|
+
propertiesChange?: PropertiesChange;
|
|
1086
|
+
/** Default properties were created on site creation. */
|
|
1087
|
+
siteCreated?: SiteCreated;
|
|
1088
|
+
/** Properties were cloned on site cloning. */
|
|
1089
|
+
siteCloned?: SiteCloned;
|
|
1090
|
+
}
|
|
1091
|
+
/** @oneof */
|
|
1092
|
+
interface ChangeContextPayloadOneOf {
|
|
1093
|
+
/** Properties were updated. */
|
|
1094
|
+
propertiesChange?: PropertiesChange;
|
|
1095
|
+
/** Default properties were created on site creation. */
|
|
1096
|
+
siteCreated?: SiteCreated;
|
|
1097
|
+
/** Properties were cloned on site cloning. */
|
|
1098
|
+
siteCloned?: SiteCloned;
|
|
1099
|
+
}
|
|
1100
|
+
interface PropertiesChange {
|
|
1101
|
+
}
|
|
1102
|
+
interface SiteCreated {
|
|
1103
|
+
/** Origin template site id. */
|
|
1104
|
+
originTemplateId?: string | null;
|
|
1105
|
+
}
|
|
1106
|
+
interface SiteCloned {
|
|
1107
|
+
/** Origin site id. */
|
|
1108
|
+
originMetaSiteId?: string;
|
|
1109
|
+
}
|
|
1110
|
+
interface Empty {
|
|
689
1111
|
}
|
|
690
1112
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
691
1113
|
createdEvent?: EntityCreatedEvent;
|
|
@@ -812,15 +1234,33 @@ interface IdentificationDataIdOneOf {
|
|
|
812
1234
|
*/
|
|
813
1235
|
appId?: string;
|
|
814
1236
|
}
|
|
815
|
-
declare enum WebhookIdentityType {
|
|
816
|
-
UNKNOWN = "UNKNOWN",
|
|
817
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
818
|
-
MEMBER = "MEMBER",
|
|
819
|
-
WIX_USER = "WIX_USER",
|
|
820
|
-
APP = "APP"
|
|
1237
|
+
declare enum WebhookIdentityType {
|
|
1238
|
+
UNKNOWN = "UNKNOWN",
|
|
1239
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1240
|
+
MEMBER = "MEMBER",
|
|
1241
|
+
WIX_USER = "WIX_USER",
|
|
1242
|
+
APP = "APP"
|
|
1243
|
+
}
|
|
1244
|
+
/** @enumType */
|
|
1245
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1246
|
+
interface UpdateScheduleWithFixedBusinessResourceIdRequest {
|
|
1247
|
+
/** @format GUID */
|
|
1248
|
+
metaSiteId?: string;
|
|
1249
|
+
/** @format GUID */
|
|
1250
|
+
currentBusinessResourceId?: string;
|
|
1251
|
+
migrateBusinessConferenceId?: boolean;
|
|
1252
|
+
}
|
|
1253
|
+
interface UpdateScheduleWithFixedBusinessResourceIdResponse {
|
|
1254
|
+
}
|
|
1255
|
+
interface UpdateEventsWithFixedBusinessResourceIdRequest {
|
|
1256
|
+
/** @format GUID */
|
|
1257
|
+
metaSiteId?: string;
|
|
1258
|
+
/** @format GUID */
|
|
1259
|
+
currentBusinessResourceId?: string;
|
|
1260
|
+
migrateBusinessConferenceId?: boolean;
|
|
1261
|
+
}
|
|
1262
|
+
interface UpdateEventsWithFixedBusinessResourceIdResponse {
|
|
821
1263
|
}
|
|
822
|
-
/** @enumType */
|
|
823
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
824
1264
|
interface GetEventRequest {
|
|
825
1265
|
/**
|
|
826
1266
|
* ID of the event to retrieve.
|
|
@@ -1289,385 +1729,97 @@ interface RestoreEventDefaultsRequest {
|
|
|
1289
1729
|
interface RestoreEventDefaultsResponse {
|
|
1290
1730
|
/** Updated event. */
|
|
1291
1731
|
event?: Event;
|
|
1292
|
-
}
|
|
1293
|
-
interface SplitRecurringEventRequest {
|
|
1294
|
-
/**
|
|
1295
|
-
* ID of the `MASTER` event to split.
|
|
1296
|
-
* @minLength 36
|
|
1297
|
-
* @maxLength 250
|
|
1298
|
-
*/
|
|
1299
|
-
recurringEventId: string | null;
|
|
1300
|
-
/**
|
|
1301
|
-
* Local date and time at which the `MASTER` event is split in
|
|
1302
|
-
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1303
|
-
* `2025-03-11T09:00:00`.
|
|
1304
|
-
* Must be a future date that's after the `start` date of the next `INSTANCE` or
|
|
1305
|
-
* `EXCEPTION` event in the series. Additionally, there must be another
|
|
1306
|
-
* `INSTANCE` or `EXCEPTION` event following this next event, as the changes
|
|
1307
|
-
* wouldn't affect any event without a subsequent occurrence.
|
|
1308
|
-
* @format LOCAL_DATE_TIME
|
|
1309
|
-
*/
|
|
1310
|
-
splitLocalDate: string | null;
|
|
1311
|
-
/**
|
|
1312
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1313
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1314
|
-
* `America/New_York` or `UTC`.
|
|
1315
|
-
*
|
|
1316
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1317
|
-
*/
|
|
1318
|
-
timeZone?: string | null;
|
|
1319
|
-
}
|
|
1320
|
-
interface SplitRecurringEventResponse {
|
|
1321
|
-
/** Original `MASTER` event that was shortened. */
|
|
1322
|
-
updatedRecurringEventEndingBeforeSplit?: Event;
|
|
1323
|
-
/** New `MASTER` event starting with the first event after the split date. */
|
|
1324
|
-
newRecurringEventStartingFromSplit?: Event;
|
|
1325
|
-
}
|
|
1326
|
-
interface CancelEventRequest {
|
|
1327
|
-
/**
|
|
1328
|
-
* ID of the event to cancel.
|
|
1329
|
-
* @minLength 36
|
|
1330
|
-
* @maxLength 250
|
|
1331
|
-
*/
|
|
1332
|
-
eventId: string | null;
|
|
1333
|
-
/**
|
|
1334
|
-
* Information about whether participants of the canceled event are notified and
|
|
1335
|
-
* the message they receive.
|
|
1336
|
-
*/
|
|
1337
|
-
participantNotification?: ParticipantNotification;
|
|
1338
|
-
/**
|
|
1339
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1340
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1341
|
-
* `America/New_York` or `UTC`.
|
|
1342
|
-
*
|
|
1343
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1344
|
-
*/
|
|
1345
|
-
timeZone?: string | null;
|
|
1346
|
-
}
|
|
1347
|
-
interface CancelEventResponse {
|
|
1348
|
-
/** Canceled event. */
|
|
1349
|
-
event?: Event;
|
|
1350
|
-
}
|
|
1351
|
-
interface BulkCancelEventRequest {
|
|
1352
|
-
/**
|
|
1353
|
-
* IDs of the events to cancel.
|
|
1354
|
-
* @minSize 1
|
|
1355
|
-
* @maxSize 50
|
|
1356
|
-
*/
|
|
1357
|
-
eventIds: string[];
|
|
1358
|
-
/**
|
|
1359
|
-
* Whether to return the canceled events.
|
|
1360
|
-
*
|
|
1361
|
-
* Default: `false`
|
|
1362
|
-
*/
|
|
1363
|
-
returnEntity?: boolean | null;
|
|
1364
|
-
/**
|
|
1365
|
-
* Information about whether participants of the canceled events are notified and
|
|
1366
|
-
* the message they receive.
|
|
1367
|
-
*/
|
|
1368
|
-
participantNotification?: ParticipantNotification;
|
|
1369
|
-
/**
|
|
1370
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1371
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1372
|
-
* `America/New_York` or `UTC`.
|
|
1373
|
-
*
|
|
1374
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1375
|
-
*/
|
|
1376
|
-
timeZone?: string | null;
|
|
1377
|
-
}
|
|
1378
|
-
interface BulkCancelEventResponse {
|
|
1379
|
-
/** The result for each event, containing the event and whether the action was successful. */
|
|
1380
|
-
results?: BulkEventResult[];
|
|
1381
|
-
/** Total successes and failures. */
|
|
1382
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1383
|
-
}
|
|
1384
|
-
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
1385
|
-
interface SitePropertiesNotification {
|
|
1386
|
-
/** The site ID for which this update notification applies. */
|
|
1387
|
-
metasiteId?: string;
|
|
1388
|
-
/** The actual update event. */
|
|
1389
|
-
event?: SitePropertiesEvent;
|
|
1390
|
-
/**
|
|
1391
|
-
* A convenience set of mappings from the MetaSite ID to its constituent services.
|
|
1392
|
-
* @maxSize 500
|
|
1393
|
-
*/
|
|
1394
|
-
translations?: Translation[];
|
|
1395
|
-
/** Context of the notification */
|
|
1396
|
-
changeContext?: ChangeContext;
|
|
1397
|
-
}
|
|
1398
|
-
/** The actual update event for a particular notification. */
|
|
1399
|
-
interface SitePropertiesEvent {
|
|
1400
|
-
/** Version of the site's properties represented by this update. */
|
|
1401
|
-
version?: number;
|
|
1402
|
-
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
1403
|
-
fields?: string[];
|
|
1404
|
-
/** Updated properties. */
|
|
1405
|
-
properties?: Properties;
|
|
1406
|
-
}
|
|
1407
|
-
interface Properties {
|
|
1408
|
-
/** Site categories. */
|
|
1409
|
-
categories?: Categories;
|
|
1410
|
-
/** Site locale. */
|
|
1411
|
-
locale?: Locale;
|
|
1412
|
-
/**
|
|
1413
|
-
* Site language.
|
|
1414
|
-
*
|
|
1415
|
-
* Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
1416
|
-
*/
|
|
1417
|
-
language?: string | null;
|
|
1418
|
-
/**
|
|
1419
|
-
* Site currency format used to bill customers.
|
|
1420
|
-
*
|
|
1421
|
-
* Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
1422
|
-
*/
|
|
1423
|
-
paymentCurrency?: string | null;
|
|
1424
|
-
/** Timezone in `America/New_York` format. */
|
|
1425
|
-
timeZone?: string | null;
|
|
1426
|
-
/** Email address. */
|
|
1427
|
-
email?: string | null;
|
|
1428
|
-
/** Phone number. */
|
|
1429
|
-
phone?: string | null;
|
|
1430
|
-
/** Fax number. */
|
|
1431
|
-
fax?: string | null;
|
|
1432
|
-
/** Address. */
|
|
1433
|
-
address?: Address;
|
|
1434
|
-
/** Site display name. */
|
|
1435
|
-
siteDisplayName?: string | null;
|
|
1436
|
-
/** Business name. */
|
|
1437
|
-
businessName?: string | null;
|
|
1438
|
-
/** Path to the site's logo in Wix Media (without Wix Media base URL). */
|
|
1439
|
-
logo?: string | null;
|
|
1440
|
-
/** Site description. */
|
|
1441
|
-
description?: string | null;
|
|
1442
|
-
/**
|
|
1443
|
-
* Business schedule. Regular and exceptional time periods when the business is open or the service is available.
|
|
1444
|
-
*
|
|
1445
|
-
* __Note:__ Not supported by Wix Bookings.
|
|
1446
|
-
*/
|
|
1447
|
-
businessSchedule?: BusinessSchedule;
|
|
1448
|
-
/** Supported languages of a site and the primary language. */
|
|
1449
|
-
multilingual?: Multilingual;
|
|
1450
|
-
/** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
|
|
1451
|
-
consentPolicy?: ConsentPolicy;
|
|
1452
|
-
/**
|
|
1453
|
-
* Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
|
|
1454
|
-
*
|
|
1455
|
-
* Site business type.
|
|
1456
|
-
*/
|
|
1457
|
-
businessConfig?: string | null;
|
|
1458
|
-
/** External site URL that uses Wix as its headless business solution. */
|
|
1459
|
-
externalSiteUrl?: string | null;
|
|
1460
|
-
/** Track clicks analytics. */
|
|
1461
|
-
trackClicksAnalytics?: boolean;
|
|
1462
|
-
}
|
|
1463
|
-
interface Categories {
|
|
1464
|
-
/** Primary site category. */
|
|
1465
|
-
primary?: string;
|
|
1466
|
-
/**
|
|
1467
|
-
* Secondary site category.
|
|
1468
|
-
* @maxSize 50
|
|
1469
|
-
*/
|
|
1470
|
-
secondary?: string[];
|
|
1471
|
-
/** Business Term Id */
|
|
1472
|
-
businessTermId?: string | null;
|
|
1473
|
-
}
|
|
1474
|
-
interface Locale {
|
|
1475
|
-
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1476
|
-
languageCode?: string;
|
|
1477
|
-
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
1478
|
-
country?: string;
|
|
1479
|
-
}
|
|
1480
|
-
interface Address {
|
|
1481
|
-
/** Street name. */
|
|
1482
|
-
street?: string;
|
|
1483
|
-
/** City name. */
|
|
1484
|
-
city?: string;
|
|
1485
|
-
/** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
|
|
1486
|
-
country?: string;
|
|
1487
|
-
/** State. */
|
|
1488
|
-
state?: string;
|
|
1489
|
-
/**
|
|
1490
|
-
* Zip or postal code.
|
|
1491
|
-
* @maxLength 20
|
|
1492
|
-
*/
|
|
1493
|
-
zip?: string;
|
|
1494
|
-
/** Extra information to be displayed in the address. */
|
|
1495
|
-
hint?: AddressHint;
|
|
1496
|
-
/** Whether this address represents a physical location. */
|
|
1497
|
-
isPhysical?: boolean;
|
|
1498
|
-
/** Google-formatted version of this address. */
|
|
1499
|
-
googleFormattedAddress?: string;
|
|
1500
|
-
/** Street number. */
|
|
1501
|
-
streetNumber?: string;
|
|
1502
|
-
/** Apartment number. */
|
|
1503
|
-
apartmentNumber?: string;
|
|
1504
|
-
/** Geographic coordinates of location. */
|
|
1505
|
-
coordinates?: GeoCoordinates;
|
|
1506
|
-
}
|
|
1507
|
-
/**
|
|
1508
|
-
* Extra information on displayed addresses.
|
|
1509
|
-
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
1510
|
-
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
1511
|
-
*/
|
|
1512
|
-
interface AddressHint {
|
|
1513
|
-
/** Extra text displayed next to, or instead of, the actual address. */
|
|
1514
|
-
text?: string;
|
|
1515
|
-
/** Where the extra text should be displayed. */
|
|
1516
|
-
placement?: PlacementTypeWithLiterals;
|
|
1517
|
-
}
|
|
1518
|
-
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
1519
|
-
declare enum PlacementType {
|
|
1520
|
-
BEFORE = "BEFORE",
|
|
1521
|
-
AFTER = "AFTER",
|
|
1522
|
-
REPLACE = "REPLACE"
|
|
1523
|
-
}
|
|
1524
|
-
/** @enumType */
|
|
1525
|
-
type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
|
|
1526
|
-
/** Geocoordinates for a particular address. */
|
|
1527
|
-
interface GeoCoordinates {
|
|
1528
|
-
/** Latitude of the location. Must be between -90 and 90. */
|
|
1529
|
-
latitude?: number;
|
|
1530
|
-
/** Longitude of the location. Must be between -180 and 180. */
|
|
1531
|
-
longitude?: number;
|
|
1532
|
-
}
|
|
1533
|
-
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
1534
|
-
interface BusinessSchedule {
|
|
1732
|
+
}
|
|
1733
|
+
interface SplitRecurringEventRequest {
|
|
1535
1734
|
/**
|
|
1536
|
-
*
|
|
1537
|
-
* @
|
|
1735
|
+
* ID of the `MASTER` event to split.
|
|
1736
|
+
* @minLength 36
|
|
1737
|
+
* @maxLength 250
|
|
1538
1738
|
*/
|
|
1539
|
-
|
|
1739
|
+
recurringEventId: string | null;
|
|
1540
1740
|
/**
|
|
1541
|
-
*
|
|
1542
|
-
*
|
|
1741
|
+
* Local date and time at which the `MASTER` event is split in
|
|
1742
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1743
|
+
* `2025-03-11T09:00:00`.
|
|
1744
|
+
* Must be a future date that's after the `start` date of the next `INSTANCE` or
|
|
1745
|
+
* `EXCEPTION` event in the series. Additionally, there must be another
|
|
1746
|
+
* `INSTANCE` or `EXCEPTION` event following this next event, as the changes
|
|
1747
|
+
* wouldn't affect any event without a subsequent occurrence.
|
|
1748
|
+
* @format LOCAL_DATE_TIME
|
|
1543
1749
|
*/
|
|
1544
|
-
|
|
1750
|
+
splitLocalDate: string | null;
|
|
1751
|
+
/**
|
|
1752
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1753
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1754
|
+
* `America/New_York` or `UTC`.
|
|
1755
|
+
*
|
|
1756
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1757
|
+
*/
|
|
1758
|
+
timeZone?: string | null;
|
|
1545
1759
|
}
|
|
1546
|
-
|
|
1547
|
-
|
|
1548
|
-
|
|
1549
|
-
|
|
1760
|
+
interface SplitRecurringEventResponse {
|
|
1761
|
+
/** Original `MASTER` event that was shortened. */
|
|
1762
|
+
updatedRecurringEventEndingBeforeSplit?: Event;
|
|
1763
|
+
/** New `MASTER` event starting with the first event after the split date. */
|
|
1764
|
+
newRecurringEventStartingFromSplit?: Event;
|
|
1765
|
+
}
|
|
1766
|
+
interface CancelEventRequest {
|
|
1550
1767
|
/**
|
|
1551
|
-
*
|
|
1552
|
-
*
|
|
1768
|
+
* ID of the event to cancel.
|
|
1769
|
+
* @minLength 36
|
|
1770
|
+
* @maxLength 250
|
|
1553
1771
|
*/
|
|
1554
|
-
|
|
1555
|
-
/** Day of the week the period ends on. */
|
|
1556
|
-
closeDay?: DayOfWeekWithLiterals;
|
|
1772
|
+
eventId: string | null;
|
|
1557
1773
|
/**
|
|
1558
|
-
*
|
|
1559
|
-
*
|
|
1774
|
+
* Information about whether participants of the canceled event are notified and
|
|
1775
|
+
* the message they receive.
|
|
1776
|
+
*/
|
|
1777
|
+
participantNotification?: ParticipantNotification;
|
|
1778
|
+
/**
|
|
1779
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1780
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1781
|
+
* `America/New_York` or `UTC`.
|
|
1560
1782
|
*
|
|
1561
|
-
*
|
|
1783
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1562
1784
|
*/
|
|
1563
|
-
|
|
1785
|
+
timeZone?: string | null;
|
|
1564
1786
|
}
|
|
1565
|
-
|
|
1566
|
-
|
|
1567
|
-
|
|
1568
|
-
TUESDAY = "TUESDAY",
|
|
1569
|
-
WEDNESDAY = "WEDNESDAY",
|
|
1570
|
-
THURSDAY = "THURSDAY",
|
|
1571
|
-
FRIDAY = "FRIDAY",
|
|
1572
|
-
SATURDAY = "SATURDAY",
|
|
1573
|
-
SUNDAY = "SUNDAY"
|
|
1787
|
+
interface CancelEventResponse {
|
|
1788
|
+
/** Canceled event. */
|
|
1789
|
+
event?: Event;
|
|
1574
1790
|
}
|
|
1575
|
-
|
|
1576
|
-
type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
1577
|
-
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
1578
|
-
interface SpecialHourPeriod {
|
|
1579
|
-
/** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
1580
|
-
startDate?: string;
|
|
1581
|
-
/** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
1582
|
-
endDate?: string;
|
|
1791
|
+
interface BulkCancelEventRequest {
|
|
1583
1792
|
/**
|
|
1584
|
-
*
|
|
1793
|
+
* IDs of the events to cancel.
|
|
1794
|
+
* @minSize 1
|
|
1795
|
+
* @maxSize 50
|
|
1796
|
+
*/
|
|
1797
|
+
eventIds: string[];
|
|
1798
|
+
/**
|
|
1799
|
+
* Whether to return the canceled events.
|
|
1585
1800
|
*
|
|
1586
|
-
* Default: `
|
|
1801
|
+
* Default: `false`
|
|
1587
1802
|
*/
|
|
1588
|
-
|
|
1589
|
-
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
1590
|
-
comment?: string;
|
|
1591
|
-
}
|
|
1592
|
-
interface Multilingual {
|
|
1803
|
+
returnEntity?: boolean | null;
|
|
1593
1804
|
/**
|
|
1594
|
-
*
|
|
1595
|
-
*
|
|
1805
|
+
* Information about whether participants of the canceled events are notified and
|
|
1806
|
+
* the message they receive.
|
|
1596
1807
|
*/
|
|
1597
|
-
|
|
1598
|
-
/**
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
|
|
1602
|
-
|
|
1603
|
-
|
|
1604
|
-
|
|
1605
|
-
|
|
1606
|
-
/** Whether the supported language is the primary language for the site. */
|
|
1607
|
-
isPrimary?: boolean;
|
|
1608
|
-
/** Language icon. */
|
|
1609
|
-
countryCode?: string;
|
|
1610
|
-
/** How the language will be resolved. For internal use. */
|
|
1611
|
-
resolutionMethod?: ResolutionMethodWithLiterals;
|
|
1612
|
-
/** Whether the supported language is the primary language for site visitors. */
|
|
1613
|
-
isVisitorPrimary?: boolean | null;
|
|
1614
|
-
}
|
|
1615
|
-
declare enum ResolutionMethod {
|
|
1616
|
-
QUERY_PARAM = "QUERY_PARAM",
|
|
1617
|
-
SUBDOMAIN = "SUBDOMAIN",
|
|
1618
|
-
SUBDIRECTORY = "SUBDIRECTORY"
|
|
1619
|
-
}
|
|
1620
|
-
/** @enumType */
|
|
1621
|
-
type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
|
|
1622
|
-
interface ConsentPolicy {
|
|
1623
|
-
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
1624
|
-
essential?: boolean | null;
|
|
1625
|
-
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
1626
|
-
functional?: boolean | null;
|
|
1627
|
-
/** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
|
|
1628
|
-
analytics?: boolean | null;
|
|
1629
|
-
/** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
|
|
1630
|
-
advertising?: boolean | null;
|
|
1631
|
-
/** CCPA compliance flag. */
|
|
1632
|
-
dataToThirdParty?: boolean | null;
|
|
1633
|
-
}
|
|
1634
|
-
/** A single mapping from the MetaSite ID to a particular service. */
|
|
1635
|
-
interface Translation {
|
|
1636
|
-
/** The service type. */
|
|
1637
|
-
serviceType?: string;
|
|
1638
|
-
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
1639
|
-
appDefId?: string;
|
|
1640
|
-
/** The instance ID of the service. */
|
|
1641
|
-
instanceId?: string;
|
|
1642
|
-
}
|
|
1643
|
-
interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
1644
|
-
/** Properties were updated. */
|
|
1645
|
-
propertiesChange?: PropertiesChange;
|
|
1646
|
-
/** Default properties were created on site creation. */
|
|
1647
|
-
siteCreated?: SiteCreated;
|
|
1648
|
-
/** Properties were cloned on site cloning. */
|
|
1649
|
-
siteCloned?: SiteCloned;
|
|
1650
|
-
}
|
|
1651
|
-
/** @oneof */
|
|
1652
|
-
interface ChangeContextPayloadOneOf {
|
|
1653
|
-
/** Properties were updated. */
|
|
1654
|
-
propertiesChange?: PropertiesChange;
|
|
1655
|
-
/** Default properties were created on site creation. */
|
|
1656
|
-
siteCreated?: SiteCreated;
|
|
1657
|
-
/** Properties were cloned on site cloning. */
|
|
1658
|
-
siteCloned?: SiteCloned;
|
|
1659
|
-
}
|
|
1660
|
-
interface PropertiesChange {
|
|
1661
|
-
}
|
|
1662
|
-
interface SiteCreated {
|
|
1663
|
-
/** Origin template site id. */
|
|
1664
|
-
originTemplateId?: string | null;
|
|
1665
|
-
}
|
|
1666
|
-
interface SiteCloned {
|
|
1667
|
-
/** Origin site id. */
|
|
1668
|
-
originMetaSiteId?: string;
|
|
1808
|
+
participantNotification?: ParticipantNotification;
|
|
1809
|
+
/**
|
|
1810
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1811
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1812
|
+
* `America/New_York` or `UTC`.
|
|
1813
|
+
*
|
|
1814
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1815
|
+
*/
|
|
1816
|
+
timeZone?: string | null;
|
|
1669
1817
|
}
|
|
1670
|
-
interface
|
|
1818
|
+
interface BulkCancelEventResponse {
|
|
1819
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
1820
|
+
results?: BulkEventResult[];
|
|
1821
|
+
/** Total successes and failures. */
|
|
1822
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1671
1823
|
}
|
|
1672
1824
|
interface BaseEventMetadata {
|
|
1673
1825
|
/**
|
|
@@ -1729,6 +1881,94 @@ interface EventUpdatedEnvelope {
|
|
|
1729
1881
|
entity: Event;
|
|
1730
1882
|
metadata: EventMetadata;
|
|
1731
1883
|
}
|
|
1884
|
+
interface ListEventsByContactIdOptions {
|
|
1885
|
+
/**
|
|
1886
|
+
* Local start date and time from which events are returned in
|
|
1887
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1888
|
+
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
1889
|
+
*
|
|
1890
|
+
* Events that start before the `fromLocalDate` but end after it are included in
|
|
1891
|
+
* the results. Must be earlier than `toLocalDate`.
|
|
1892
|
+
* @format LOCAL_DATE_TIME
|
|
1893
|
+
*/
|
|
1894
|
+
fromLocalDate?: string | null;
|
|
1895
|
+
/**
|
|
1896
|
+
* Local end date and time up to which events are returned in
|
|
1897
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1898
|
+
* `2024-01-30T13:30:00`. Can't be more than a full year after
|
|
1899
|
+
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
1900
|
+
*
|
|
1901
|
+
* Events that start before `toLocalDate` but end after it are included in the
|
|
1902
|
+
* results. Must be later than `fromLocalDate`.
|
|
1903
|
+
* @format LOCAL_DATE_TIME
|
|
1904
|
+
*/
|
|
1905
|
+
toLocalDate?: string | null;
|
|
1906
|
+
/**
|
|
1907
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1908
|
+
* for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
|
|
1909
|
+
* `adjustedEnd`. For example, `America/New_York` or `UTC`.
|
|
1910
|
+
*
|
|
1911
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1912
|
+
*/
|
|
1913
|
+
timeZone?: string | null;
|
|
1914
|
+
/**
|
|
1915
|
+
* [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
|
|
1916
|
+
* to filter events by.
|
|
1917
|
+
* @format GUID
|
|
1918
|
+
*/
|
|
1919
|
+
appId?: string | null;
|
|
1920
|
+
/** Cursor to retrieve the next page of the results. */
|
|
1921
|
+
cursorPaging?: CommonCursorPaging;
|
|
1922
|
+
}
|
|
1923
|
+
interface ListEventsByMemberIdOptions {
|
|
1924
|
+
/**
|
|
1925
|
+
* Local start date and time from which events are returned in
|
|
1926
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1927
|
+
* `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
1928
|
+
*
|
|
1929
|
+
* Events that start before the `fromLocalDate` but end after it are included in
|
|
1930
|
+
* the results. Must be earlier than `toLocalDate`.
|
|
1931
|
+
* @format LOCAL_DATE_TIME
|
|
1932
|
+
*/
|
|
1933
|
+
fromLocalDate?: string | null;
|
|
1934
|
+
/**
|
|
1935
|
+
* Local end date and time up to which events are returned in
|
|
1936
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1937
|
+
* `2024-01-30T13:30:00`. Can't be more than a full year after
|
|
1938
|
+
* `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
1939
|
+
*
|
|
1940
|
+
* Events that start before `toLocalDate` but end after it are included in the
|
|
1941
|
+
* results. Must be later than `fromLocalDate`.
|
|
1942
|
+
* @format LOCAL_DATE_TIME
|
|
1943
|
+
*/
|
|
1944
|
+
toLocalDate?: string | null;
|
|
1945
|
+
/**
|
|
1946
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1947
|
+
* for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
|
|
1948
|
+
* `adjustedEnd`. For example, `America/New_York` or `UTC`.
|
|
1949
|
+
*
|
|
1950
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1951
|
+
*/
|
|
1952
|
+
timeZone?: string | null;
|
|
1953
|
+
/**
|
|
1954
|
+
* [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
|
|
1955
|
+
* to filter events by.
|
|
1956
|
+
* @format GUID
|
|
1957
|
+
*/
|
|
1958
|
+
appId?: string | null;
|
|
1959
|
+
/** Cursor to retrieve the next page of the results. */
|
|
1960
|
+
cursorPaging?: CommonCursorPaging;
|
|
1961
|
+
/**
|
|
1962
|
+
* IDs of the events to retrieve.
|
|
1963
|
+
* If you provide a list of IDs, all other filters are ignored.
|
|
1964
|
+
*
|
|
1965
|
+
* Max: 100 `eventId`s
|
|
1966
|
+
* @maxSize 100
|
|
1967
|
+
* @minLength 36
|
|
1968
|
+
* @maxLength 250
|
|
1969
|
+
*/
|
|
1970
|
+
eventIds?: string[];
|
|
1971
|
+
}
|
|
1732
1972
|
interface GetEventOptions {
|
|
1733
1973
|
/**
|
|
1734
1974
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
@@ -1832,7 +2072,7 @@ interface QueryEventsOptions {
|
|
|
1832
2072
|
fields?: RequestedFieldsWithLiterals[] | undefined;
|
|
1833
2073
|
}
|
|
1834
2074
|
interface QueryCursorResult {
|
|
1835
|
-
cursors:
|
|
2075
|
+
cursors: CommonCursors;
|
|
1836
2076
|
hasNext: () => boolean;
|
|
1837
2077
|
hasPrev: () => boolean;
|
|
1838
2078
|
length: number;
|
|
@@ -2246,4 +2486,4 @@ interface BulkCancelEventOptions {
|
|
|
2246
2486
|
timeZone?: string | null;
|
|
2247
2487
|
}
|
|
2248
2488
|
|
|
2249
|
-
export { type
|
|
2489
|
+
export { type Participants as $, Type as A, type BulkCreateEventOptions as B, type CreateEventOptions as C, Day as D, type Event as E, type FieldWithLiterals as F, type GetEventOptions as G, Field as H, IdentityType as I, PlacementType as J, DayOfWeek as K, type ListEventsByContactIdOptions as L, type MaskedEvent as M, ResolutionMethod as N, RequestedFields as O, ParticipantsStatus as P, type QueryEventsOptions as Q, type RestoreEventDefaultsOptions as R, type SplitRecurringEventOptions as S, Transparency as T, type UpdateEvent as U, SortOrder as V, WebhookIdentityType as W, type RecurrenceRule as X, type Location as Y, type ZonedDate as Z, type Resource as _, type ListEventsByContactIdResponse as a, type CreateEventRequest as a$, type Participant as a0, type ConferencingDetails as a1, type Permission as a2, type CommonIdentificationData as a3, type CommonIdentificationDataIdOneOf as a4, type ExtendedFields as a5, type RecurringEventSplit as a6, type EventCancelled as a7, type ParticipantNotification as a8, type EventUpdatedWithMetadata as a9, type DomainEvent as aA, type DomainEventBodyOneOf as aB, type EntityCreatedEvent as aC, type RestoreInfo as aD, type EntityUpdatedEvent as aE, type EntityDeletedEvent as aF, type ActionEvent as aG, type MessageEnvelope as aH, type IdentificationData as aI, type IdentificationDataIdOneOf as aJ, type UpdateScheduleWithFixedBusinessResourceIdRequest as aK, type UpdateScheduleWithFixedBusinessResourceIdResponse as aL, type UpdateEventsWithFixedBusinessResourceIdRequest as aM, type UpdateEventsWithFixedBusinessResourceIdResponse as aN, type GetEventRequest as aO, type GetEventResponse as aP, type ListEventsRequest as aQ, type QueryEventsRequest as aR, type CursorQuery as aS, type CursorQueryPagingMethodOneOf as aT, type Sorting as aU, type CursorPaging as aV, type QueryEventsResponse as aW, type CursorPagingMetadata as aX, type Cursors as aY, type ListRecurringEventInstancesHistoryRequest as aZ, type ListRecurringEventInstancesHistoryResponse as a_, type ListEventsByContactIdRequest as aa, type CommonCursorPaging as ab, type CommonCursorPagingMetadata as ac, type CommonCursors as ad, type ListEventsByMemberIdRequest as ae, type SitePropertiesNotification as af, type SitePropertiesEvent as ag, type Properties as ah, type Categories as ai, type Locale as aj, type Address as ak, type AddressHint as al, type GeoCoordinates as am, type BusinessSchedule as an, type TimePeriod as ao, type SpecialHourPeriod as ap, type Multilingual as aq, type SupportedLanguage as ar, type ConsentPolicy as as, type Translation as at, type ChangeContext as au, type ChangeContextPayloadOneOf as av, type PropertiesChange as aw, type SiteCreated as ax, type SiteCloned as ay, type Empty as az, type ListEventsByMemberIdOptions as b, type CreateEventResponse as b0, type BulkCreateEventRequest as b1, type BulkEventResult as b2, type ItemMetadata as b3, type ApplicationError as b4, type BulkActionMetadata as b5, type UpdateEventRequest as b6, type UpdateEventResponse as b7, type BulkUpdateEventRequest as b8, type UpdateEventParticipantsRequest as b9, type UpdateEventParticipantsResponse as ba, type RestoreEventDefaultsRequest as bb, type SplitRecurringEventRequest as bc, type CancelEventRequest as bd, type BulkCancelEventRequest as be, type BaseEventMetadata as bf, type EventMetadata as bg, type EventsQueryResult as bh, type ListEventsByMemberIdResponse as c, type ListEventsOptions as d, type ListEventsResponse as e, type EventsQueryBuilder as f, type BulkCreateEventResponse as g, type UpdateEventOptions as h, type BulkUpdateEventRequestMaskedEvent as i, type BulkUpdateEventOptions as j, type BulkUpdateEventResponse as k, type RestoreEventDefaultsResponse as l, type SplitRecurringEventResponse as m, type CancelEventOptions as n, type CancelEventResponse as o, type BulkCancelEventOptions as p, type BulkCancelEventResponse as q, type EventCancelledEnvelope as r, type EventCreatedEnvelope as s, type EventRecurringSplitEnvelope as t, type EventUpdatedEnvelope as u, Status as v, RecurrenceType as w, Frequency as x, LocationType as y, Role as z };
|