@wix/auto_sdk_calendar_events 1.0.29 → 1.0.30
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-CLDnUCNu.d.mts → calendar-v3-event-events.universal-Cfq4Piiv.d.mts} +571 -811
- package/build/{calendar-v3-event-events.universal-CLDnUCNu.d.ts → calendar-v3-event-events.universal-Cfq4Piiv.d.ts} +571 -811
- package/build/index.d.mts +3 -39
- package/build/index.d.ts +3 -39
- package/build/index.js +11 -222
- package/build/index.js.map +1 -1
- package/build/index.mjs +11 -220
- package/build/index.mjs.map +1 -1
- package/build/internal/{calendar-v3-event-events.universal-CLDnUCNu.d.mts → calendar-v3-event-events.universal-Cfq4Piiv.d.mts} +571 -811
- package/build/internal/{calendar-v3-event-events.universal-CLDnUCNu.d.ts → calendar-v3-event-events.universal-Cfq4Piiv.d.ts} +571 -811
- package/build/internal/index.d.mts +3 -39
- package/build/internal/index.d.ts +3 -39
- package/build/internal/index.js +11 -222
- package/build/internal/index.js.map +1 -1
- package/build/internal/index.mjs +11 -220
- package/build/internal/index.mjs.map +1 -1
- package/build/internal/meta.d.mts +2 -160
- package/build/internal/meta.d.ts +2 -160
- package/build/internal/meta.js +0 -153
- package/build/internal/meta.js.map +1 -1
- package/build/internal/meta.mjs +0 -151
- package/build/internal/meta.mjs.map +1 -1
- package/build/meta.d.mts +2 -160
- package/build/meta.d.ts +2 -160
- package/build/meta.js +0 -153
- package/build/meta.js.map +1 -1
- package/build/meta.mjs +0 -151
- package/build/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -821,31 +821,111 @@ declare enum WebhookIdentityType {
|
|
|
821
821
|
}
|
|
822
822
|
/** @enumType */
|
|
823
823
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
824
|
-
interface
|
|
824
|
+
interface GetEventRequest {
|
|
825
825
|
/**
|
|
826
|
-
* ID of the
|
|
827
|
-
*
|
|
828
|
-
*
|
|
826
|
+
* ID of the event to retrieve.
|
|
827
|
+
*
|
|
828
|
+
* Min: 36 characters
|
|
829
|
+
* Max: 250 characters
|
|
830
|
+
* @minLength 36
|
|
831
|
+
* @maxLength 250
|
|
832
|
+
*/
|
|
833
|
+
eventId: string | null;
|
|
834
|
+
/**
|
|
835
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
836
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
837
|
+
* `America/New_York` or `UTC`.
|
|
838
|
+
*
|
|
839
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
840
|
+
*/
|
|
841
|
+
timeZone?: string | null;
|
|
842
|
+
/**
|
|
843
|
+
* Information about which fields containing personal data to return. Refer to the
|
|
844
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
845
|
+
* for more information.
|
|
846
|
+
*
|
|
847
|
+
* Supported values:
|
|
848
|
+
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
849
|
+
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
850
|
+
*
|
|
851
|
+
* Max: 1 field
|
|
852
|
+
* Default: No personal data is returned.
|
|
853
|
+
* @maxSize 1
|
|
854
|
+
*/
|
|
855
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
856
|
+
}
|
|
857
|
+
declare enum RequestedFields {
|
|
858
|
+
UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
|
|
859
|
+
/** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
|
|
860
|
+
PI_FIELDS = "PI_FIELDS",
|
|
861
|
+
/** Returns only fields containing your own personal data. */
|
|
862
|
+
OWN_PI_FIELDS = "OWN_PI_FIELDS"
|
|
863
|
+
}
|
|
864
|
+
/** @enumType */
|
|
865
|
+
type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELDS' | 'PI_FIELDS' | 'OWN_PI_FIELDS';
|
|
866
|
+
interface GetEventResponse {
|
|
867
|
+
/** Retrieved event. */
|
|
868
|
+
event?: Event;
|
|
869
|
+
}
|
|
870
|
+
interface ListEventsRequest {
|
|
871
|
+
/**
|
|
872
|
+
* IDs of the events to retrieve.
|
|
873
|
+
*
|
|
874
|
+
* Min: 1 event ID
|
|
875
|
+
* Min: 100 event IDs
|
|
876
|
+
* @minSize 1
|
|
877
|
+
* @maxSize 100
|
|
878
|
+
* @minLength 36
|
|
879
|
+
* @maxLength 250
|
|
880
|
+
*/
|
|
881
|
+
eventIds: string[];
|
|
882
|
+
/**
|
|
883
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
884
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
885
|
+
* `America/New_York` or `UTC`.
|
|
886
|
+
*
|
|
887
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
829
888
|
*/
|
|
830
|
-
|
|
889
|
+
timeZone?: string | null;
|
|
890
|
+
/**
|
|
891
|
+
* Information about which fields containing personal data to return. Refer to the
|
|
892
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
893
|
+
* for more information.
|
|
894
|
+
*
|
|
895
|
+
* Supported values:
|
|
896
|
+
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
897
|
+
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
898
|
+
*
|
|
899
|
+
* Max: 1 field
|
|
900
|
+
* Default: No personal data is returned.
|
|
901
|
+
* @maxSize 1
|
|
902
|
+
*/
|
|
903
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
904
|
+
}
|
|
905
|
+
interface ListEventsResponse {
|
|
906
|
+
/** Retrieved events matching the provided IDs. */
|
|
907
|
+
events?: Event[];
|
|
908
|
+
}
|
|
909
|
+
interface QueryEventsRequest {
|
|
831
910
|
/**
|
|
832
911
|
* Local start date and time from which events are returned in
|
|
833
912
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
834
|
-
* `2024-01-30T13:30:00`.
|
|
913
|
+
* `2024-01-30T13:30:00`.
|
|
835
914
|
*
|
|
836
915
|
* Events that start before the `fromLocalDate` but end after it are included in
|
|
837
|
-
* the results. Must be earlier than `toLocalDate
|
|
916
|
+
* the results. Must be earlier than `toLocalDate` unless the sort order is
|
|
917
|
+
* descending.
|
|
838
918
|
* @format LOCAL_DATE_TIME
|
|
839
919
|
*/
|
|
840
920
|
fromLocalDate?: string | null;
|
|
841
921
|
/**
|
|
842
922
|
* Local end date and time up to which events are returned in
|
|
843
923
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
844
|
-
* `2024-01-30T13:30:00`.
|
|
845
|
-
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
924
|
+
* `2024-01-30T13:30:00`.
|
|
846
925
|
*
|
|
847
926
|
* Events that start before `toLocalDate` but end after it are included in the
|
|
848
|
-
* results. Must be later than `fromLocalDate
|
|
927
|
+
* results. Must be later than `fromLocalDate` unless the sort order is
|
|
928
|
+
* descending.
|
|
849
929
|
* @format LOCAL_DATE_TIME
|
|
850
930
|
*/
|
|
851
931
|
toLocalDate?: string | null;
|
|
@@ -858,21 +938,88 @@ interface ListEventsByContactIdRequest {
|
|
|
858
938
|
*/
|
|
859
939
|
timeZone?: string | null;
|
|
860
940
|
/**
|
|
861
|
-
*
|
|
862
|
-
*
|
|
863
|
-
*
|
|
941
|
+
* Query containing filters and paging.
|
|
942
|
+
* Do not specify filters for start and end dates inside `query.filter`, instead
|
|
943
|
+
* specify `fromLocalDate` and `toLocalDate`.
|
|
864
944
|
*/
|
|
865
|
-
|
|
866
|
-
/**
|
|
867
|
-
|
|
945
|
+
query?: CursorQuery;
|
|
946
|
+
/**
|
|
947
|
+
* Filters events based on their `recurrenceType`.
|
|
948
|
+
*
|
|
949
|
+
* Max: 5 recurrence types can be specified.
|
|
950
|
+
* Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
|
|
951
|
+
* @maxSize 5
|
|
952
|
+
*/
|
|
953
|
+
recurrenceType?: RecurrenceTypeWithLiterals[];
|
|
954
|
+
/**
|
|
955
|
+
* Information about which fields containing personal data to return. Refer to the
|
|
956
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
957
|
+
* for more information.
|
|
958
|
+
*
|
|
959
|
+
* Supported values:
|
|
960
|
+
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
961
|
+
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
962
|
+
*
|
|
963
|
+
* Max: 1 field
|
|
964
|
+
* Default: No personal data is returned.
|
|
965
|
+
* @maxSize 1
|
|
966
|
+
*/
|
|
967
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
968
|
+
}
|
|
969
|
+
/** TODO Diverge */
|
|
970
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
971
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
972
|
+
cursorPaging?: CursorPaging;
|
|
973
|
+
/**
|
|
974
|
+
* Filter object.
|
|
975
|
+
* See API Query Language
|
|
976
|
+
* ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/api/rest/getting-started/api-query-language))
|
|
977
|
+
* for more information.
|
|
978
|
+
*
|
|
979
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
|
|
980
|
+
*
|
|
981
|
+
* Do not specify filters for start and end dates inside `query.filter`, instead
|
|
982
|
+
* specify `fromLocalDate` and `toLocalDate`. For a detailed list of supported
|
|
983
|
+
* filters, refer to the supported filters article
|
|
984
|
+
* ([REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/supported-filters-and-sorting)).
|
|
985
|
+
*/
|
|
986
|
+
filter?: Record<string, any> | null;
|
|
987
|
+
/**
|
|
988
|
+
* Whether to sort events by their start date in ascending order or by their end date in descending order.
|
|
989
|
+
* Default is start ascending.
|
|
990
|
+
* @maxSize 1
|
|
991
|
+
*/
|
|
992
|
+
sort?: Sorting[];
|
|
993
|
+
}
|
|
994
|
+
/** @oneof */
|
|
995
|
+
interface CursorQueryPagingMethodOneOf {
|
|
996
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
997
|
+
cursorPaging?: CursorPaging;
|
|
998
|
+
}
|
|
999
|
+
/** TODO Diverge */
|
|
1000
|
+
interface Sorting {
|
|
1001
|
+
/**
|
|
1002
|
+
* The field to sort by.
|
|
1003
|
+
* Either `start` or `end`.
|
|
1004
|
+
* Default is `start`.
|
|
1005
|
+
*/
|
|
1006
|
+
fieldName?: string;
|
|
1007
|
+
/** Sort order. */
|
|
1008
|
+
order?: SortOrderWithLiterals;
|
|
868
1009
|
}
|
|
1010
|
+
declare enum SortOrder {
|
|
1011
|
+
ASC = "ASC",
|
|
1012
|
+
DESC = "DESC"
|
|
1013
|
+
}
|
|
1014
|
+
/** @enumType */
|
|
1015
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
869
1016
|
/** TODO Diverge */
|
|
870
|
-
interface
|
|
1017
|
+
interface CursorPaging {
|
|
871
1018
|
/**
|
|
872
1019
|
* Number of events to return.
|
|
873
|
-
* Defaults to `50`. Maximum `
|
|
1020
|
+
* Defaults to `50`. Maximum `1000`.
|
|
874
1021
|
* @min 1
|
|
875
|
-
* @max
|
|
1022
|
+
* @max 1000
|
|
876
1023
|
*/
|
|
877
1024
|
limit?: number | null;
|
|
878
1025
|
/**
|
|
@@ -884,18 +1031,18 @@ interface CommonCursorPaging {
|
|
|
884
1031
|
*/
|
|
885
1032
|
cursor?: string | null;
|
|
886
1033
|
}
|
|
887
|
-
interface
|
|
888
|
-
/** Retrieved events. */
|
|
1034
|
+
interface QueryEventsResponse {
|
|
1035
|
+
/** Retrieved events matching the provided query. */
|
|
889
1036
|
events?: Event[];
|
|
890
1037
|
/** Paging metadata. */
|
|
891
|
-
pagingMetadata?:
|
|
1038
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
892
1039
|
}
|
|
893
1040
|
/** TODO Diverge */
|
|
894
|
-
interface
|
|
1041
|
+
interface CursorPagingMetadata {
|
|
895
1042
|
/** Number of items returned in the response. */
|
|
896
1043
|
count?: number | null;
|
|
897
1044
|
/** 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). */
|
|
898
|
-
cursors?:
|
|
1045
|
+
cursors?: Cursors;
|
|
899
1046
|
/**
|
|
900
1047
|
* Indicates if there are more results after the current page.
|
|
901
1048
|
* If `true`, another page of results can be retrieved.
|
|
@@ -903,658 +1050,71 @@ interface CommonCursorPagingMetadata {
|
|
|
903
1050
|
*/
|
|
904
1051
|
hasNext?: boolean | null;
|
|
905
1052
|
}
|
|
906
|
-
interface
|
|
1053
|
+
interface Cursors {
|
|
907
1054
|
/** Cursor pointing to next page in the list of results. */
|
|
908
1055
|
next?: string | null;
|
|
909
1056
|
}
|
|
910
|
-
interface
|
|
1057
|
+
interface ListRecurringEventInstancesHistoryRequest {
|
|
911
1058
|
/**
|
|
912
|
-
* ID of the
|
|
913
|
-
*
|
|
914
|
-
*
|
|
915
|
-
*
|
|
916
|
-
* [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
|
|
917
|
-
* to retrieve events for members who aren't the currently logged in member.
|
|
918
|
-
* @minLength 2
|
|
919
|
-
* @maxLength 36
|
|
1059
|
+
* The ID of the recurring event.
|
|
1060
|
+
* Required, unless `cursorPaging` is provided.
|
|
1061
|
+
* @minLength 64
|
|
1062
|
+
* @maxLength 64
|
|
920
1063
|
*/
|
|
921
|
-
|
|
1064
|
+
recurringEventId?: string | null;
|
|
922
1065
|
/**
|
|
923
|
-
*
|
|
924
|
-
*
|
|
925
|
-
* `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
926
|
-
*
|
|
927
|
-
* Events that start before the `fromLocalDate` but end after it are included in
|
|
928
|
-
* the results. Must be earlier than `toLocalDate`.
|
|
929
|
-
* @format LOCAL_DATE_TIME
|
|
1066
|
+
* The revision of the recurring event.
|
|
1067
|
+
* Required, unless `cursorPaging` is provided.
|
|
930
1068
|
*/
|
|
931
|
-
|
|
1069
|
+
revision?: string | null;
|
|
932
1070
|
/**
|
|
933
|
-
*
|
|
934
|
-
*
|
|
935
|
-
*
|
|
936
|
-
* `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
937
|
-
*
|
|
938
|
-
* Events that start before `toLocalDate` but end after it are included in the
|
|
939
|
-
* results. Must be later than `fromLocalDate`.
|
|
940
|
-
* @format LOCAL_DATE_TIME
|
|
1071
|
+
* Inclusive start date for which events are returned, in ISO-8601 format.
|
|
1072
|
+
* Events that begin at or after the `fromDate` are included in the results.
|
|
1073
|
+
* Required, unless `cursorPaging` is provided.
|
|
941
1074
|
*/
|
|
942
|
-
|
|
1075
|
+
fromDate?: Date | null;
|
|
1076
|
+
/**
|
|
1077
|
+
* Exclusive end date for which events are returned, in ISO-8601 format.
|
|
1078
|
+
* Events that begin before the `toDate` are included in the results.
|
|
1079
|
+
* Required, unless `cursorPaging` is provided.
|
|
1080
|
+
*/
|
|
1081
|
+
toDate?: Date | null;
|
|
1082
|
+
/** Optional cursor pointing to the next page of events. */
|
|
1083
|
+
cursorPaging?: CursorPaging;
|
|
1084
|
+
}
|
|
1085
|
+
interface ListRecurringEventInstancesHistoryResponse {
|
|
1086
|
+
/** The recurring event instances. */
|
|
1087
|
+
recurringEventInstances?: Event[];
|
|
1088
|
+
/** Paging metadata. */
|
|
1089
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
1090
|
+
}
|
|
1091
|
+
interface CreateEventRequest {
|
|
1092
|
+
/** Event to create. */
|
|
1093
|
+
event: Event;
|
|
943
1094
|
/**
|
|
944
1095
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
945
|
-
* for
|
|
946
|
-
* `
|
|
1096
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1097
|
+
* `America/New_York` or `UTC`.
|
|
947
1098
|
*
|
|
948
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/
|
|
1099
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
949
1100
|
*/
|
|
950
1101
|
timeZone?: string | null;
|
|
951
1102
|
/**
|
|
952
|
-
*
|
|
953
|
-
*
|
|
1103
|
+
* Idempotency key guaranteeing that you don't create the same event more
|
|
1104
|
+
* than once.
|
|
954
1105
|
* @format GUID
|
|
955
1106
|
*/
|
|
956
|
-
|
|
957
|
-
/** Cursor to retrieve the next page of the results. */
|
|
958
|
-
cursorPaging?: CommonCursorPaging;
|
|
959
|
-
/**
|
|
960
|
-
* IDs of the events to retrieve.
|
|
961
|
-
* If you provide a list of IDs, all other filters are ignored.
|
|
962
|
-
*
|
|
963
|
-
* Max: 100 `eventId`s
|
|
964
|
-
* @maxSize 100
|
|
965
|
-
* @minLength 36
|
|
966
|
-
* @maxLength 250
|
|
967
|
-
*/
|
|
968
|
-
eventIds?: string[];
|
|
1107
|
+
idempotencyKey?: string | null;
|
|
969
1108
|
}
|
|
970
|
-
interface
|
|
971
|
-
/**
|
|
972
|
-
|
|
973
|
-
/** Paging metadata. */
|
|
974
|
-
pagingMetadata?: CommonCursorPagingMetadata;
|
|
1109
|
+
interface CreateEventResponse {
|
|
1110
|
+
/** Created event. */
|
|
1111
|
+
event?: Event;
|
|
975
1112
|
}
|
|
976
|
-
|
|
977
|
-
interface SitePropertiesNotification {
|
|
978
|
-
/** The site ID for which this update notification applies. */
|
|
979
|
-
metasiteId?: string;
|
|
980
|
-
/** The actual update event. */
|
|
981
|
-
event?: SitePropertiesEvent;
|
|
1113
|
+
interface BulkCreateEventRequest {
|
|
982
1114
|
/**
|
|
983
|
-
*
|
|
984
|
-
* @
|
|
985
|
-
|
|
986
|
-
translations?: Translation[];
|
|
987
|
-
/** Context of the notification */
|
|
988
|
-
changeContext?: ChangeContext;
|
|
989
|
-
}
|
|
990
|
-
/** The actual update event for a particular notification. */
|
|
991
|
-
interface SitePropertiesEvent {
|
|
992
|
-
/** Version of the site's properties represented by this update. */
|
|
993
|
-
version?: number;
|
|
994
|
-
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
995
|
-
fields?: string[];
|
|
996
|
-
/** Updated properties. */
|
|
997
|
-
properties?: Properties;
|
|
998
|
-
}
|
|
999
|
-
interface Properties {
|
|
1000
|
-
/** Site categories. */
|
|
1001
|
-
categories?: Categories;
|
|
1002
|
-
/** Site locale. */
|
|
1003
|
-
locale?: Locale;
|
|
1004
|
-
/**
|
|
1005
|
-
* Site language.
|
|
1006
|
-
*
|
|
1007
|
-
* Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
1008
|
-
*/
|
|
1009
|
-
language?: string | null;
|
|
1010
|
-
/**
|
|
1011
|
-
* Site currency format used to bill customers.
|
|
1012
|
-
*
|
|
1013
|
-
* Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
1014
|
-
*/
|
|
1015
|
-
paymentCurrency?: string | null;
|
|
1016
|
-
/** Timezone in `America/New_York` format. */
|
|
1017
|
-
timeZone?: string | null;
|
|
1018
|
-
/** Email address. */
|
|
1019
|
-
email?: string | null;
|
|
1020
|
-
/** Phone number. */
|
|
1021
|
-
phone?: string | null;
|
|
1022
|
-
/** Fax number. */
|
|
1023
|
-
fax?: string | null;
|
|
1024
|
-
/** Address. */
|
|
1025
|
-
address?: Address;
|
|
1026
|
-
/** Site display name. */
|
|
1027
|
-
siteDisplayName?: string | null;
|
|
1028
|
-
/** Business name. */
|
|
1029
|
-
businessName?: string | null;
|
|
1030
|
-
/** Path to the site's logo in Wix Media (without Wix Media base URL). */
|
|
1031
|
-
logo?: string | null;
|
|
1032
|
-
/** Site description. */
|
|
1033
|
-
description?: string | null;
|
|
1034
|
-
/**
|
|
1035
|
-
* Business schedule. Regular and exceptional time periods when the business is open or the service is available.
|
|
1036
|
-
*
|
|
1037
|
-
* __Note:__ Not supported by Wix Bookings.
|
|
1038
|
-
*/
|
|
1039
|
-
businessSchedule?: BusinessSchedule;
|
|
1040
|
-
/** Supported languages of a site and the primary language. */
|
|
1041
|
-
multilingual?: Multilingual;
|
|
1042
|
-
/** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
|
|
1043
|
-
consentPolicy?: ConsentPolicy;
|
|
1044
|
-
/**
|
|
1045
|
-
* Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
|
|
1046
|
-
*
|
|
1047
|
-
* Site business type.
|
|
1048
|
-
*/
|
|
1049
|
-
businessConfig?: string | null;
|
|
1050
|
-
/** External site URL that uses Wix as its headless business solution. */
|
|
1051
|
-
externalSiteUrl?: string | null;
|
|
1052
|
-
/** Track clicks analytics. */
|
|
1053
|
-
trackClicksAnalytics?: boolean;
|
|
1054
|
-
}
|
|
1055
|
-
interface Categories {
|
|
1056
|
-
/** Primary site category. */
|
|
1057
|
-
primary?: string;
|
|
1058
|
-
/**
|
|
1059
|
-
* Secondary site category.
|
|
1060
|
-
* @maxSize 50
|
|
1061
|
-
*/
|
|
1062
|
-
secondary?: string[];
|
|
1063
|
-
/** Business Term Id */
|
|
1064
|
-
businessTermId?: string | null;
|
|
1065
|
-
}
|
|
1066
|
-
interface Locale {
|
|
1067
|
-
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1068
|
-
languageCode?: string;
|
|
1069
|
-
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
1070
|
-
country?: string;
|
|
1071
|
-
}
|
|
1072
|
-
interface Address {
|
|
1073
|
-
/** Street name. */
|
|
1074
|
-
street?: string;
|
|
1075
|
-
/** City name. */
|
|
1076
|
-
city?: string;
|
|
1077
|
-
/** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
|
|
1078
|
-
country?: string;
|
|
1079
|
-
/** State. */
|
|
1080
|
-
state?: string;
|
|
1081
|
-
/**
|
|
1082
|
-
* Zip or postal code.
|
|
1083
|
-
* @maxLength 20
|
|
1084
|
-
*/
|
|
1085
|
-
zip?: string;
|
|
1086
|
-
/** Extra information to be displayed in the address. */
|
|
1087
|
-
hint?: AddressHint;
|
|
1088
|
-
/** Whether this address represents a physical location. */
|
|
1089
|
-
isPhysical?: boolean;
|
|
1090
|
-
/** Google-formatted version of this address. */
|
|
1091
|
-
googleFormattedAddress?: string;
|
|
1092
|
-
/** Street number. */
|
|
1093
|
-
streetNumber?: string;
|
|
1094
|
-
/** Apartment number. */
|
|
1095
|
-
apartmentNumber?: string;
|
|
1096
|
-
/** Geographic coordinates of location. */
|
|
1097
|
-
coordinates?: GeoCoordinates;
|
|
1098
|
-
}
|
|
1099
|
-
/**
|
|
1100
|
-
* Extra information on displayed addresses.
|
|
1101
|
-
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
1102
|
-
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
1103
|
-
*/
|
|
1104
|
-
interface AddressHint {
|
|
1105
|
-
/** Extra text displayed next to, or instead of, the actual address. */
|
|
1106
|
-
text?: string;
|
|
1107
|
-
/** Where the extra text should be displayed. */
|
|
1108
|
-
placement?: PlacementTypeWithLiterals;
|
|
1109
|
-
}
|
|
1110
|
-
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
1111
|
-
declare enum PlacementType {
|
|
1112
|
-
BEFORE = "BEFORE",
|
|
1113
|
-
AFTER = "AFTER",
|
|
1114
|
-
REPLACE = "REPLACE"
|
|
1115
|
-
}
|
|
1116
|
-
/** @enumType */
|
|
1117
|
-
type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
|
|
1118
|
-
/** Geocoordinates for a particular address. */
|
|
1119
|
-
interface GeoCoordinates {
|
|
1120
|
-
/** Latitude of the location. Must be between -90 and 90. */
|
|
1121
|
-
latitude?: number;
|
|
1122
|
-
/** Longitude of the location. Must be between -180 and 180. */
|
|
1123
|
-
longitude?: number;
|
|
1124
|
-
}
|
|
1125
|
-
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
1126
|
-
interface BusinessSchedule {
|
|
1127
|
-
/**
|
|
1128
|
-
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
1129
|
-
* @maxSize 100
|
|
1130
|
-
*/
|
|
1131
|
-
periods?: TimePeriod[];
|
|
1132
|
-
/**
|
|
1133
|
-
* Exceptions to the business's regular hours. The business can be open or closed during the exception.
|
|
1134
|
-
* @maxSize 100
|
|
1135
|
-
*/
|
|
1136
|
-
specialHourPeriod?: SpecialHourPeriod[];
|
|
1137
|
-
}
|
|
1138
|
-
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
1139
|
-
interface TimePeriod {
|
|
1140
|
-
/** Day of the week the period starts on. */
|
|
1141
|
-
openDay?: DayOfWeekWithLiterals;
|
|
1142
|
-
/**
|
|
1143
|
-
* 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
|
|
1144
|
-
* midnight at the end of the specified day.
|
|
1145
|
-
*/
|
|
1146
|
-
openTime?: string;
|
|
1147
|
-
/** Day of the week the period ends on. */
|
|
1148
|
-
closeDay?: DayOfWeekWithLiterals;
|
|
1149
|
-
/**
|
|
1150
|
-
* 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
|
|
1151
|
-
* midnight at the end of the specified day.
|
|
1152
|
-
*
|
|
1153
|
-
* __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
|
|
1154
|
-
*/
|
|
1155
|
-
closeTime?: string;
|
|
1156
|
-
}
|
|
1157
|
-
/** Enumerates the days of the week. */
|
|
1158
|
-
declare enum DayOfWeek {
|
|
1159
|
-
MONDAY = "MONDAY",
|
|
1160
|
-
TUESDAY = "TUESDAY",
|
|
1161
|
-
WEDNESDAY = "WEDNESDAY",
|
|
1162
|
-
THURSDAY = "THURSDAY",
|
|
1163
|
-
FRIDAY = "FRIDAY",
|
|
1164
|
-
SATURDAY = "SATURDAY",
|
|
1165
|
-
SUNDAY = "SUNDAY"
|
|
1166
|
-
}
|
|
1167
|
-
/** @enumType */
|
|
1168
|
-
type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
1169
|
-
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
1170
|
-
interface SpecialHourPeriod {
|
|
1171
|
-
/** 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). */
|
|
1172
|
-
startDate?: string;
|
|
1173
|
-
/** 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). */
|
|
1174
|
-
endDate?: string;
|
|
1175
|
-
/**
|
|
1176
|
-
* Whether the business is closed (or the service is not available) during the exception.
|
|
1177
|
-
*
|
|
1178
|
-
* Default: `true`.
|
|
1179
|
-
*/
|
|
1180
|
-
isClosed?: boolean;
|
|
1181
|
-
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
1182
|
-
comment?: string;
|
|
1183
|
-
}
|
|
1184
|
-
interface Multilingual {
|
|
1185
|
-
/**
|
|
1186
|
-
* Supported languages list.
|
|
1187
|
-
* @maxSize 200
|
|
1188
|
-
*/
|
|
1189
|
-
supportedLanguages?: SupportedLanguage[];
|
|
1190
|
-
/** Whether to redirect to user language. */
|
|
1191
|
-
autoRedirect?: boolean;
|
|
1192
|
-
}
|
|
1193
|
-
interface SupportedLanguage {
|
|
1194
|
-
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1195
|
-
languageCode?: string;
|
|
1196
|
-
/** Locale. */
|
|
1197
|
-
locale?: Locale;
|
|
1198
|
-
/** Whether the supported language is the primary language for the site. */
|
|
1199
|
-
isPrimary?: boolean;
|
|
1200
|
-
/** Language icon. */
|
|
1201
|
-
countryCode?: string;
|
|
1202
|
-
/** How the language will be resolved. For internal use. */
|
|
1203
|
-
resolutionMethod?: ResolutionMethodWithLiterals;
|
|
1204
|
-
/** Whether the supported language is the primary language for site visitors. */
|
|
1205
|
-
isVisitorPrimary?: boolean | null;
|
|
1206
|
-
}
|
|
1207
|
-
declare enum ResolutionMethod {
|
|
1208
|
-
QUERY_PARAM = "QUERY_PARAM",
|
|
1209
|
-
SUBDOMAIN = "SUBDOMAIN",
|
|
1210
|
-
SUBDIRECTORY = "SUBDIRECTORY"
|
|
1211
|
-
}
|
|
1212
|
-
/** @enumType */
|
|
1213
|
-
type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
|
|
1214
|
-
interface ConsentPolicy {
|
|
1215
|
-
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
1216
|
-
essential?: boolean | null;
|
|
1217
|
-
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
1218
|
-
functional?: boolean | null;
|
|
1219
|
-
/** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
|
|
1220
|
-
analytics?: boolean | null;
|
|
1221
|
-
/** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
|
|
1222
|
-
advertising?: boolean | null;
|
|
1223
|
-
/** CCPA compliance flag. */
|
|
1224
|
-
dataToThirdParty?: boolean | null;
|
|
1225
|
-
}
|
|
1226
|
-
/** A single mapping from the MetaSite ID to a particular service. */
|
|
1227
|
-
interface Translation {
|
|
1228
|
-
/** The service type. */
|
|
1229
|
-
serviceType?: string;
|
|
1230
|
-
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
1231
|
-
appDefId?: string;
|
|
1232
|
-
/** The instance ID of the service. */
|
|
1233
|
-
instanceId?: string;
|
|
1234
|
-
}
|
|
1235
|
-
interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
1236
|
-
/** Properties were updated. */
|
|
1237
|
-
propertiesChange?: PropertiesChange;
|
|
1238
|
-
/** Default properties were created on site creation. */
|
|
1239
|
-
siteCreated?: SiteCreated;
|
|
1240
|
-
/** Properties were cloned on site cloning. */
|
|
1241
|
-
siteCloned?: SiteCloned;
|
|
1242
|
-
}
|
|
1243
|
-
/** @oneof */
|
|
1244
|
-
interface ChangeContextPayloadOneOf {
|
|
1245
|
-
/** Properties were updated. */
|
|
1246
|
-
propertiesChange?: PropertiesChange;
|
|
1247
|
-
/** Default properties were created on site creation. */
|
|
1248
|
-
siteCreated?: SiteCreated;
|
|
1249
|
-
/** Properties were cloned on site cloning. */
|
|
1250
|
-
siteCloned?: SiteCloned;
|
|
1251
|
-
}
|
|
1252
|
-
interface PropertiesChange {
|
|
1253
|
-
}
|
|
1254
|
-
interface SiteCreated {
|
|
1255
|
-
/** Origin template site id. */
|
|
1256
|
-
originTemplateId?: string | null;
|
|
1257
|
-
}
|
|
1258
|
-
interface SiteCloned {
|
|
1259
|
-
/** Origin site id. */
|
|
1260
|
-
originMetaSiteId?: string;
|
|
1261
|
-
}
|
|
1262
|
-
interface Empty {
|
|
1263
|
-
}
|
|
1264
|
-
interface GetEventRequest {
|
|
1265
|
-
/**
|
|
1266
|
-
* ID of the event to retrieve.
|
|
1267
|
-
*
|
|
1268
|
-
* Min: 36 characters
|
|
1269
|
-
* Max: 250 characters
|
|
1270
|
-
* @minLength 36
|
|
1271
|
-
* @maxLength 250
|
|
1272
|
-
*/
|
|
1273
|
-
eventId: string | null;
|
|
1274
|
-
/**
|
|
1275
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1276
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1277
|
-
* `America/New_York` or `UTC`.
|
|
1278
|
-
*
|
|
1279
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1280
|
-
*/
|
|
1281
|
-
timeZone?: string | null;
|
|
1282
|
-
/**
|
|
1283
|
-
* Information about which fields containing personal data to return. Refer to the
|
|
1284
|
-
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
1285
|
-
* for more information.
|
|
1286
|
-
*
|
|
1287
|
-
* Supported values:
|
|
1288
|
-
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
1289
|
-
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
1290
|
-
*
|
|
1291
|
-
* Max: 1 field
|
|
1292
|
-
* Default: No personal data is returned.
|
|
1293
|
-
* @maxSize 1
|
|
1294
|
-
*/
|
|
1295
|
-
fields?: RequestedFieldsWithLiterals[];
|
|
1296
|
-
}
|
|
1297
|
-
declare enum RequestedFields {
|
|
1298
|
-
UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
|
|
1299
|
-
/** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
|
|
1300
|
-
PI_FIELDS = "PI_FIELDS",
|
|
1301
|
-
/** Returns only fields containing your own personal data. */
|
|
1302
|
-
OWN_PI_FIELDS = "OWN_PI_FIELDS"
|
|
1303
|
-
}
|
|
1304
|
-
/** @enumType */
|
|
1305
|
-
type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELDS' | 'PI_FIELDS' | 'OWN_PI_FIELDS';
|
|
1306
|
-
interface GetEventResponse {
|
|
1307
|
-
/** Retrieved event. */
|
|
1308
|
-
event?: Event;
|
|
1309
|
-
}
|
|
1310
|
-
interface ListEventsRequest {
|
|
1311
|
-
/**
|
|
1312
|
-
* IDs of the events to retrieve.
|
|
1313
|
-
*
|
|
1314
|
-
* Min: 1 event ID
|
|
1315
|
-
* Min: 100 event IDs
|
|
1316
|
-
* @minSize 1
|
|
1317
|
-
* @maxSize 100
|
|
1318
|
-
* @minLength 36
|
|
1319
|
-
* @maxLength 250
|
|
1320
|
-
*/
|
|
1321
|
-
eventIds: string[];
|
|
1322
|
-
/**
|
|
1323
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1324
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1325
|
-
* `America/New_York` or `UTC`.
|
|
1326
|
-
*
|
|
1327
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1328
|
-
*/
|
|
1329
|
-
timeZone?: string | null;
|
|
1330
|
-
/**
|
|
1331
|
-
* Information about which fields containing personal data to return. Refer to the
|
|
1332
|
-
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
1333
|
-
* for more information.
|
|
1334
|
-
*
|
|
1335
|
-
* Supported values:
|
|
1336
|
-
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
1337
|
-
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
1338
|
-
*
|
|
1339
|
-
* Max: 1 field
|
|
1340
|
-
* Default: No personal data is returned.
|
|
1341
|
-
* @maxSize 1
|
|
1342
|
-
*/
|
|
1343
|
-
fields?: RequestedFieldsWithLiterals[];
|
|
1344
|
-
}
|
|
1345
|
-
interface ListEventsResponse {
|
|
1346
|
-
/** Retrieved events matching the provided IDs. */
|
|
1347
|
-
events?: Event[];
|
|
1348
|
-
}
|
|
1349
|
-
interface QueryEventsRequest {
|
|
1350
|
-
/**
|
|
1351
|
-
* Local start date and time from which events are returned in
|
|
1352
|
-
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1353
|
-
* `2024-01-30T13:30:00`.
|
|
1354
|
-
*
|
|
1355
|
-
* Events that start before the `fromLocalDate` but end after it are included in
|
|
1356
|
-
* the results. Must be earlier than `toLocalDate` unless the sort order is
|
|
1357
|
-
* descending.
|
|
1358
|
-
* @format LOCAL_DATE_TIME
|
|
1359
|
-
*/
|
|
1360
|
-
fromLocalDate?: string | null;
|
|
1361
|
-
/**
|
|
1362
|
-
* Local end date and time up to which events are returned in
|
|
1363
|
-
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1364
|
-
* `2024-01-30T13:30:00`.
|
|
1365
|
-
*
|
|
1366
|
-
* Events that start before `toLocalDate` but end after it are included in the
|
|
1367
|
-
* results. Must be later than `fromLocalDate` unless the sort order is
|
|
1368
|
-
* descending.
|
|
1369
|
-
* @format LOCAL_DATE_TIME
|
|
1370
|
-
*/
|
|
1371
|
-
toLocalDate?: string | null;
|
|
1372
|
-
/**
|
|
1373
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1374
|
-
* for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
|
|
1375
|
-
* `adjustedEnd`. For example, `America/New_York` or `UTC`.
|
|
1376
|
-
*
|
|
1377
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1378
|
-
*/
|
|
1379
|
-
timeZone?: string | null;
|
|
1380
|
-
/**
|
|
1381
|
-
* Query containing filters and paging.
|
|
1382
|
-
* Do not specify filters for start and end dates inside `query.filter`, instead
|
|
1383
|
-
* specify `fromLocalDate` and `toLocalDate`.
|
|
1384
|
-
*/
|
|
1385
|
-
query?: CursorQuery;
|
|
1386
|
-
/**
|
|
1387
|
-
* Filters events based on their `recurrenceType`.
|
|
1388
|
-
*
|
|
1389
|
-
* Max: 5 recurrence types can be specified.
|
|
1390
|
-
* Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
|
|
1391
|
-
* @maxSize 5
|
|
1392
|
-
*/
|
|
1393
|
-
recurrenceType?: RecurrenceTypeWithLiterals[];
|
|
1394
|
-
/**
|
|
1395
|
-
* Information about which fields containing personal data to return. Refer to the
|
|
1396
|
-
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
1397
|
-
* for more information.
|
|
1398
|
-
*
|
|
1399
|
-
* Supported values:
|
|
1400
|
-
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
1401
|
-
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
1402
|
-
*
|
|
1403
|
-
* Max: 1 field
|
|
1404
|
-
* Default: No personal data is returned.
|
|
1405
|
-
* @maxSize 1
|
|
1406
|
-
*/
|
|
1407
|
-
fields?: RequestedFieldsWithLiterals[];
|
|
1408
|
-
}
|
|
1409
|
-
/** TODO Diverge */
|
|
1410
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1411
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
1412
|
-
cursorPaging?: CursorPaging;
|
|
1413
|
-
/**
|
|
1414
|
-
* Filter object.
|
|
1415
|
-
* See API Query Language
|
|
1416
|
-
* ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/api/rest/getting-started/api-query-language))
|
|
1417
|
-
* for more information.
|
|
1418
|
-
*
|
|
1419
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
|
|
1420
|
-
*
|
|
1421
|
-
* Do not specify filters for start and end dates inside `query.filter`, instead
|
|
1422
|
-
* specify `fromLocalDate` and `toLocalDate`. For a detailed list of supported
|
|
1423
|
-
* filters, refer to the supported filters article
|
|
1424
|
-
* ([REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/supported-filters-and-sorting)).
|
|
1425
|
-
*/
|
|
1426
|
-
filter?: Record<string, any> | null;
|
|
1427
|
-
/**
|
|
1428
|
-
* Whether to sort events by their start date in ascending order or by their end date in descending order.
|
|
1429
|
-
* Default is start ascending.
|
|
1430
|
-
* @maxSize 1
|
|
1431
|
-
*/
|
|
1432
|
-
sort?: Sorting[];
|
|
1433
|
-
}
|
|
1434
|
-
/** @oneof */
|
|
1435
|
-
interface CursorQueryPagingMethodOneOf {
|
|
1436
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
1437
|
-
cursorPaging?: CursorPaging;
|
|
1438
|
-
}
|
|
1439
|
-
/** TODO Diverge */
|
|
1440
|
-
interface Sorting {
|
|
1441
|
-
/**
|
|
1442
|
-
* The field to sort by.
|
|
1443
|
-
* Either `start` or `end`.
|
|
1444
|
-
* Default is `start`.
|
|
1445
|
-
*/
|
|
1446
|
-
fieldName?: string;
|
|
1447
|
-
/** Sort order. */
|
|
1448
|
-
order?: SortOrderWithLiterals;
|
|
1449
|
-
}
|
|
1450
|
-
declare enum SortOrder {
|
|
1451
|
-
ASC = "ASC",
|
|
1452
|
-
DESC = "DESC"
|
|
1453
|
-
}
|
|
1454
|
-
/** @enumType */
|
|
1455
|
-
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1456
|
-
/** TODO Diverge */
|
|
1457
|
-
interface CursorPaging {
|
|
1458
|
-
/**
|
|
1459
|
-
* Number of events to return.
|
|
1460
|
-
* Defaults to `50`. Maximum `1000`.
|
|
1461
|
-
* @min 1
|
|
1462
|
-
* @max 1000
|
|
1463
|
-
*/
|
|
1464
|
-
limit?: number | null;
|
|
1465
|
-
/**
|
|
1466
|
-
* Pointer to the next or previous page in the list of results.
|
|
1467
|
-
*
|
|
1468
|
-
* You can get the relevant cursor token
|
|
1469
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
1470
|
-
* Not relevant for the first request.
|
|
1471
|
-
*/
|
|
1472
|
-
cursor?: string | null;
|
|
1473
|
-
}
|
|
1474
|
-
interface QueryEventsResponse {
|
|
1475
|
-
/** Retrieved events matching the provided query. */
|
|
1476
|
-
events?: Event[];
|
|
1477
|
-
/** Paging metadata. */
|
|
1478
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
1479
|
-
}
|
|
1480
|
-
/** TODO Diverge */
|
|
1481
|
-
interface CursorPagingMetadata {
|
|
1482
|
-
/** Number of items returned in the response. */
|
|
1483
|
-
count?: number | null;
|
|
1484
|
-
/** 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). */
|
|
1485
|
-
cursors?: Cursors;
|
|
1486
|
-
/**
|
|
1487
|
-
* Indicates if there are more results after the current page.
|
|
1488
|
-
* If `true`, another page of results can be retrieved.
|
|
1489
|
-
* If `false`, this is the last page.
|
|
1490
|
-
*/
|
|
1491
|
-
hasNext?: boolean | null;
|
|
1492
|
-
}
|
|
1493
|
-
interface Cursors {
|
|
1494
|
-
/** Cursor pointing to next page in the list of results. */
|
|
1495
|
-
next?: string | null;
|
|
1496
|
-
}
|
|
1497
|
-
interface ListRecurringEventInstancesHistoryRequest {
|
|
1498
|
-
/**
|
|
1499
|
-
* The ID of the recurring event.
|
|
1500
|
-
* Required, unless `cursorPaging` is provided.
|
|
1501
|
-
* @minLength 64
|
|
1502
|
-
* @maxLength 64
|
|
1503
|
-
*/
|
|
1504
|
-
recurringEventId?: string | null;
|
|
1505
|
-
/**
|
|
1506
|
-
* The revision of the recurring event.
|
|
1507
|
-
* Required, unless `cursorPaging` is provided.
|
|
1508
|
-
*/
|
|
1509
|
-
revision?: string | null;
|
|
1510
|
-
/**
|
|
1511
|
-
* Inclusive start date for which events are returned, in ISO-8601 format.
|
|
1512
|
-
* Events that begin at or after the `fromDate` are included in the results.
|
|
1513
|
-
* Required, unless `cursorPaging` is provided.
|
|
1514
|
-
*/
|
|
1515
|
-
fromDate?: Date | null;
|
|
1516
|
-
/**
|
|
1517
|
-
* Exclusive end date for which events are returned, in ISO-8601 format.
|
|
1518
|
-
* Events that begin before the `toDate` are included in the results.
|
|
1519
|
-
* Required, unless `cursorPaging` is provided.
|
|
1520
|
-
*/
|
|
1521
|
-
toDate?: Date | null;
|
|
1522
|
-
/** Optional cursor pointing to the next page of events. */
|
|
1523
|
-
cursorPaging?: CursorPaging;
|
|
1524
|
-
}
|
|
1525
|
-
interface ListRecurringEventInstancesHistoryResponse {
|
|
1526
|
-
/** The recurring event instances. */
|
|
1527
|
-
recurringEventInstances?: Event[];
|
|
1528
|
-
/** Paging metadata. */
|
|
1529
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
1530
|
-
}
|
|
1531
|
-
interface CreateEventRequest {
|
|
1532
|
-
/** Event to create. */
|
|
1533
|
-
event: Event;
|
|
1534
|
-
/**
|
|
1535
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1536
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1537
|
-
* `America/New_York` or `UTC`.
|
|
1538
|
-
*
|
|
1539
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1540
|
-
*/
|
|
1541
|
-
timeZone?: string | null;
|
|
1542
|
-
/**
|
|
1543
|
-
* Idempotency key guaranteeing that you don't create the same event more
|
|
1544
|
-
* than once.
|
|
1545
|
-
* @format GUID
|
|
1546
|
-
*/
|
|
1547
|
-
idempotencyKey?: string | null;
|
|
1548
|
-
}
|
|
1549
|
-
interface CreateEventResponse {
|
|
1550
|
-
/** Created event. */
|
|
1551
|
-
event?: Event;
|
|
1552
|
-
}
|
|
1553
|
-
interface BulkCreateEventRequest {
|
|
1554
|
-
/**
|
|
1555
|
-
* Events to create.
|
|
1556
|
-
* @minSize 1
|
|
1557
|
-
* @maxSize 50
|
|
1115
|
+
* Events to create.
|
|
1116
|
+
* @minSize 1
|
|
1117
|
+
* @maxSize 50
|
|
1558
1118
|
*/
|
|
1559
1119
|
events: MaskedEvent[];
|
|
1560
1120
|
/**
|
|
@@ -1738,88 +1298,376 @@ interface SplitRecurringEventRequest {
|
|
|
1738
1298
|
*/
|
|
1739
1299
|
recurringEventId: string | null;
|
|
1740
1300
|
/**
|
|
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
|
|
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 {
|
|
1535
|
+
/**
|
|
1536
|
+
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
1537
|
+
* @maxSize 100
|
|
1749
1538
|
*/
|
|
1750
|
-
|
|
1539
|
+
periods?: TimePeriod[];
|
|
1751
1540
|
/**
|
|
1752
|
-
*
|
|
1753
|
-
*
|
|
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).
|
|
1541
|
+
* Exceptions to the business's regular hours. The business can be open or closed during the exception.
|
|
1542
|
+
* @maxSize 100
|
|
1757
1543
|
*/
|
|
1758
|
-
|
|
1759
|
-
}
|
|
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;
|
|
1544
|
+
specialHourPeriod?: SpecialHourPeriod[];
|
|
1765
1545
|
}
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
|
|
1769
|
-
|
|
1770
|
-
* @maxLength 250
|
|
1771
|
-
*/
|
|
1772
|
-
eventId: string | null;
|
|
1546
|
+
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
1547
|
+
interface TimePeriod {
|
|
1548
|
+
/** Day of the week the period starts on. */
|
|
1549
|
+
openDay?: DayOfWeekWithLiterals;
|
|
1773
1550
|
/**
|
|
1774
|
-
*
|
|
1775
|
-
* the
|
|
1551
|
+
* 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
|
|
1552
|
+
* midnight at the end of the specified day.
|
|
1776
1553
|
*/
|
|
1777
|
-
|
|
1554
|
+
openTime?: string;
|
|
1555
|
+
/** Day of the week the period ends on. */
|
|
1556
|
+
closeDay?: DayOfWeekWithLiterals;
|
|
1778
1557
|
/**
|
|
1779
|
-
* Time
|
|
1780
|
-
*
|
|
1781
|
-
* `America/New_York` or `UTC`.
|
|
1558
|
+
* 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
|
|
1559
|
+
* midnight at the end of the specified day.
|
|
1782
1560
|
*
|
|
1783
|
-
*
|
|
1561
|
+
* __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
|
|
1784
1562
|
*/
|
|
1785
|
-
|
|
1563
|
+
closeTime?: string;
|
|
1786
1564
|
}
|
|
1787
|
-
|
|
1788
|
-
|
|
1789
|
-
|
|
1565
|
+
/** Enumerates the days of the week. */
|
|
1566
|
+
declare enum DayOfWeek {
|
|
1567
|
+
MONDAY = "MONDAY",
|
|
1568
|
+
TUESDAY = "TUESDAY",
|
|
1569
|
+
WEDNESDAY = "WEDNESDAY",
|
|
1570
|
+
THURSDAY = "THURSDAY",
|
|
1571
|
+
FRIDAY = "FRIDAY",
|
|
1572
|
+
SATURDAY = "SATURDAY",
|
|
1573
|
+
SUNDAY = "SUNDAY"
|
|
1790
1574
|
}
|
|
1791
|
-
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
|
-
|
|
1795
|
-
|
|
1796
|
-
|
|
1797
|
-
|
|
1575
|
+
/** @enumType */
|
|
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;
|
|
1798
1583
|
/**
|
|
1799
|
-
* Whether
|
|
1584
|
+
* Whether the business is closed (or the service is not available) during the exception.
|
|
1800
1585
|
*
|
|
1801
|
-
* Default: `
|
|
1802
|
-
*/
|
|
1803
|
-
returnEntity?: boolean | null;
|
|
1804
|
-
/**
|
|
1805
|
-
* Information about whether participants of the canceled events are notified and
|
|
1806
|
-
* the message they receive.
|
|
1586
|
+
* Default: `true`.
|
|
1807
1587
|
*/
|
|
1808
|
-
|
|
1588
|
+
isClosed?: boolean;
|
|
1589
|
+
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
1590
|
+
comment?: string;
|
|
1591
|
+
}
|
|
1592
|
+
interface Multilingual {
|
|
1809
1593
|
/**
|
|
1810
|
-
*
|
|
1811
|
-
*
|
|
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).
|
|
1594
|
+
* Supported languages list.
|
|
1595
|
+
* @maxSize 200
|
|
1815
1596
|
*/
|
|
1816
|
-
|
|
1597
|
+
supportedLanguages?: SupportedLanguage[];
|
|
1598
|
+
/** Whether to redirect to user language. */
|
|
1599
|
+
autoRedirect?: boolean;
|
|
1817
1600
|
}
|
|
1818
|
-
interface
|
|
1819
|
-
/**
|
|
1820
|
-
|
|
1821
|
-
/**
|
|
1822
|
-
|
|
1601
|
+
interface SupportedLanguage {
|
|
1602
|
+
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1603
|
+
languageCode?: string;
|
|
1604
|
+
/** Locale. */
|
|
1605
|
+
locale?: Locale;
|
|
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;
|
|
1669
|
+
}
|
|
1670
|
+
interface Empty {
|
|
1823
1671
|
}
|
|
1824
1672
|
interface BaseEventMetadata {
|
|
1825
1673
|
/**
|
|
@@ -1881,94 +1729,6 @@ interface EventUpdatedEnvelope {
|
|
|
1881
1729
|
entity: Event;
|
|
1882
1730
|
metadata: EventMetadata;
|
|
1883
1731
|
}
|
|
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
|
-
}
|
|
1972
1732
|
interface GetEventOptions {
|
|
1973
1733
|
/**
|
|
1974
1734
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
@@ -2072,7 +1832,7 @@ interface QueryEventsOptions {
|
|
|
2072
1832
|
fields?: RequestedFieldsWithLiterals[] | undefined;
|
|
2073
1833
|
}
|
|
2074
1834
|
interface QueryCursorResult {
|
|
2075
|
-
cursors:
|
|
1835
|
+
cursors: Cursors;
|
|
2076
1836
|
hasNext: () => boolean;
|
|
2077
1837
|
hasPrev: () => boolean;
|
|
2078
1838
|
length: number;
|
|
@@ -2486,4 +2246,4 @@ interface BulkCancelEventOptions {
|
|
|
2486
2246
|
timeZone?: string | null;
|
|
2487
2247
|
}
|
|
2488
2248
|
|
|
2489
|
-
export { type
|
|
2249
|
+
export { type CommonIdentificationData as $, PlacementType 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, DayOfWeek as H, IdentityType as I, ResolutionMethod as J, type RecurrenceRule as K, type ListEventsOptions as L, type MaskedEvent as M, type Location as N, type Resource as O, ParticipantsStatus as P, type QueryEventsOptions as Q, type RestoreEventDefaultsOptions as R, type SplitRecurringEventOptions as S, Transparency as T, type UpdateEvent as U, type Participants as V, WebhookIdentityType as W, type Participant as X, type ConferencingDetails as Y, type ZonedDate as Z, type Permission as _, type ListEventsResponse as a, type Translation as a$, type CommonIdentificationDataIdOneOf as a0, type ExtendedFields as a1, type RecurringEventSplit as a2, type EventCancelled as a3, type ParticipantNotification as a4, type EventUpdatedWithMetadata as a5, type UpdateScheduleWithFixedBusinessResourceIdRequest as a6, type UpdateScheduleWithFixedBusinessResourceIdResponse as a7, type UpdateEventsWithFixedBusinessResourceIdRequest as a8, type UpdateEventsWithFixedBusinessResourceIdResponse as a9, type BulkEventResult as aA, type ItemMetadata as aB, type ApplicationError as aC, type BulkActionMetadata as aD, type UpdateEventRequest as aE, type UpdateEventResponse as aF, type BulkUpdateEventRequest as aG, type UpdateEventParticipantsRequest as aH, type UpdateEventParticipantsResponse as aI, type RestoreEventDefaultsRequest as aJ, type SplitRecurringEventRequest as aK, type CancelEventRequest as aL, type BulkCancelEventRequest as aM, type SitePropertiesNotification as aN, type SitePropertiesEvent as aO, type Properties as aP, type Categories as aQ, type Locale as aR, type Address as aS, type AddressHint as aT, type GeoCoordinates as aU, type BusinessSchedule as aV, type TimePeriod as aW, type SpecialHourPeriod as aX, type Multilingual as aY, type SupportedLanguage as aZ, type ConsentPolicy as a_, 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 GetEventRequest as ak, type GetEventResponse as al, type ListEventsRequest as am, type QueryEventsRequest as an, type CursorQuery as ao, type CursorQueryPagingMethodOneOf as ap, type Sorting as aq, type CursorPaging as ar, type QueryEventsResponse as as, type CursorPagingMetadata as at, type Cursors as au, type ListRecurringEventInstancesHistoryRequest as av, type ListRecurringEventInstancesHistoryResponse as aw, type CreateEventRequest as ax, type CreateEventResponse as ay, type BulkCreateEventRequest as az, type EventsQueryBuilder as b, type ChangeContext as b0, type ChangeContextPayloadOneOf as b1, type PropertiesChange as b2, type SiteCreated as b3, type SiteCloned as b4, type Empty as b5, type BaseEventMetadata as b6, type EventMetadata as b7, type EventsQueryResult as b8, type BulkCreateEventResponse as c, type UpdateEventOptions as d, type BulkUpdateEventRequestMaskedEvent as e, type BulkUpdateEventOptions as f, type BulkUpdateEventResponse as g, type RestoreEventDefaultsResponse as h, type SplitRecurringEventResponse as i, type CancelEventOptions as j, type CancelEventResponse as k, type BulkCancelEventOptions as l, type BulkCancelEventResponse as m, type EventCancelledEnvelope as n, type EventCreatedEnvelope as o, type EventRecurringSplitEnvelope as p, type EventUpdatedEnvelope as q, Status as r, RecurrenceType as s, Frequency as t, LocationType as u, Role as v, Type as w, Field as x, RequestedFields as y, SortOrder as z };
|