@wix/auto_sdk_calendar_events 1.0.30 → 1.0.32
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 → cjs/calendar-v3-event-events.universal-CLDnUCNu.d.ts} +728 -488
- package/build/{internal → cjs}/index.d.ts +39 -3
- package/build/{internal → cjs}/index.js +222 -11
- package/build/cjs/index.js.map +1 -0
- package/build/{internal → cjs}/meta.d.ts +160 -2
- package/build/{meta.js → cjs/meta.js} +153 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/{calendar-v3-event-events.universal-Cfq4Piiv.d.ts → es/calendar-v3-event-events.universal-CLDnUCNu.d.mts} +728 -488
- package/build/{internal → es}/index.d.mts +39 -3
- package/build/{internal → es}/index.mjs +220 -11
- package/build/es/index.mjs.map +1 -0
- package/build/{internal → es}/meta.d.mts +160 -2
- package/build/{internal → es}/meta.mjs +151 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/es/package.json +3 -0
- package/build/internal/{calendar-v3-event-events.universal-Cfq4Piiv.d.mts → cjs/calendar-v3-event-events.universal-CLDnUCNu.d.ts} +728 -488
- package/build/{index.d.ts → internal/cjs/index.d.ts} +39 -3
- package/build/{index.js → internal/cjs/index.js} +222 -11
- package/build/internal/cjs/index.js.map +1 -0
- package/build/{meta.d.ts → internal/cjs/meta.d.ts} +160 -2
- package/build/internal/{meta.js → cjs/meta.js} +153 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/{calendar-v3-event-events.universal-Cfq4Piiv.d.ts → es/calendar-v3-event-events.universal-CLDnUCNu.d.mts} +728 -488
- package/build/{index.d.mts → internal/es/index.d.mts} +39 -3
- package/build/{index.mjs → internal/es/index.mjs} +220 -11
- package/build/internal/es/index.mjs.map +1 -0
- package/build/{meta.d.mts → internal/es/meta.d.mts} +160 -2
- package/build/{meta.mjs → internal/es/meta.mjs} +151 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +10 -10
- package/build/index.js.map +0 -1
- package/build/index.mjs.map +0 -1
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.js.map +0 -1
- package/build/meta.mjs.map +0 -1
|
@@ -821,111 +821,31 @@ declare enum WebhookIdentityType {
|
|
|
821
821
|
}
|
|
822
822
|
/** @enumType */
|
|
823
823
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
824
|
-
interface
|
|
825
|
-
/**
|
|
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).
|
|
888
|
-
*/
|
|
889
|
-
timeZone?: string | null;
|
|
824
|
+
interface ListEventsByContactIdRequest {
|
|
890
825
|
/**
|
|
891
|
-
*
|
|
892
|
-
*
|
|
893
|
-
*
|
|
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
|
|
826
|
+
* ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
|
|
827
|
+
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
828
|
+
* @format GUID
|
|
902
829
|
*/
|
|
903
|
-
|
|
904
|
-
}
|
|
905
|
-
interface ListEventsResponse {
|
|
906
|
-
/** Retrieved events matching the provided IDs. */
|
|
907
|
-
events?: Event[];
|
|
908
|
-
}
|
|
909
|
-
interface QueryEventsRequest {
|
|
830
|
+
contactId: string | null;
|
|
910
831
|
/**
|
|
911
832
|
* Local start date and time from which events are returned in
|
|
912
833
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
913
|
-
* `2024-01-30T13:30:00`.
|
|
834
|
+
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
914
835
|
*
|
|
915
836
|
* Events that start before the `fromLocalDate` but end after it are included in
|
|
916
|
-
* the results. Must be earlier than `toLocalDate
|
|
917
|
-
* descending.
|
|
837
|
+
* the results. Must be earlier than `toLocalDate`.
|
|
918
838
|
* @format LOCAL_DATE_TIME
|
|
919
839
|
*/
|
|
920
840
|
fromLocalDate?: string | null;
|
|
921
841
|
/**
|
|
922
842
|
* Local end date and time up to which events are returned in
|
|
923
843
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
924
|
-
* `2024-01-30T13:30:00`.
|
|
844
|
+
* `2024-01-30T13:30:00`. Can't be more than a full year after
|
|
845
|
+
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
925
846
|
*
|
|
926
847
|
* Events that start before `toLocalDate` but end after it are included in the
|
|
927
|
-
* results. Must be later than `fromLocalDate
|
|
928
|
-
* descending.
|
|
848
|
+
* results. Must be later than `fromLocalDate`.
|
|
929
849
|
* @format LOCAL_DATE_TIME
|
|
930
850
|
*/
|
|
931
851
|
toLocalDate?: string | null;
|
|
@@ -938,88 +858,21 @@ interface QueryEventsRequest {
|
|
|
938
858
|
*/
|
|
939
859
|
timeZone?: string | null;
|
|
940
860
|
/**
|
|
941
|
-
*
|
|
942
|
-
*
|
|
943
|
-
*
|
|
944
|
-
*/
|
|
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`.
|
|
861
|
+
* [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
|
|
862
|
+
* to filter events by.
|
|
863
|
+
* @format GUID
|
|
1005
864
|
*/
|
|
1006
|
-
|
|
1007
|
-
/**
|
|
1008
|
-
|
|
1009
|
-
}
|
|
1010
|
-
declare enum SortOrder {
|
|
1011
|
-
ASC = "ASC",
|
|
1012
|
-
DESC = "DESC"
|
|
865
|
+
appId?: string | null;
|
|
866
|
+
/** Cursor to retrieve the next page of the results. */
|
|
867
|
+
cursorPaging?: CommonCursorPaging;
|
|
1013
868
|
}
|
|
1014
|
-
/** @enumType */
|
|
1015
|
-
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1016
869
|
/** TODO Diverge */
|
|
1017
|
-
interface
|
|
870
|
+
interface CommonCursorPaging {
|
|
1018
871
|
/**
|
|
1019
872
|
* Number of events to return.
|
|
1020
|
-
* Defaults to `50`. Maximum `
|
|
873
|
+
* Defaults to `50`. Maximum `100`.
|
|
1021
874
|
* @min 1
|
|
1022
|
-
* @max
|
|
875
|
+
* @max 100
|
|
1023
876
|
*/
|
|
1024
877
|
limit?: number | null;
|
|
1025
878
|
/**
|
|
@@ -1031,18 +884,18 @@ interface CursorPaging {
|
|
|
1031
884
|
*/
|
|
1032
885
|
cursor?: string | null;
|
|
1033
886
|
}
|
|
1034
|
-
interface
|
|
1035
|
-
/** Retrieved events
|
|
887
|
+
interface ListEventsByContactIdResponse {
|
|
888
|
+
/** Retrieved events. */
|
|
1036
889
|
events?: Event[];
|
|
1037
890
|
/** Paging metadata. */
|
|
1038
|
-
pagingMetadata?:
|
|
891
|
+
pagingMetadata?: CommonCursorPagingMetadata;
|
|
1039
892
|
}
|
|
1040
893
|
/** TODO Diverge */
|
|
1041
|
-
interface
|
|
894
|
+
interface CommonCursorPagingMetadata {
|
|
1042
895
|
/** Number of items returned in the response. */
|
|
1043
896
|
count?: number | null;
|
|
1044
897
|
/** 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). */
|
|
1045
|
-
cursors?:
|
|
898
|
+
cursors?: CommonCursors;
|
|
1046
899
|
/**
|
|
1047
900
|
* Indicates if there are more results after the current page.
|
|
1048
901
|
* If `true`, another page of results can be retrieved.
|
|
@@ -1050,336 +903,75 @@ interface CursorPagingMetadata {
|
|
|
1050
903
|
*/
|
|
1051
904
|
hasNext?: boolean | null;
|
|
1052
905
|
}
|
|
1053
|
-
interface
|
|
906
|
+
interface CommonCursors {
|
|
1054
907
|
/** Cursor pointing to next page in the list of results. */
|
|
1055
908
|
next?: string | null;
|
|
1056
909
|
}
|
|
1057
|
-
interface
|
|
910
|
+
interface ListEventsByMemberIdRequest {
|
|
1058
911
|
/**
|
|
1059
|
-
*
|
|
1060
|
-
* Required, unless `cursorPaging
|
|
1061
|
-
*
|
|
1062
|
-
*
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
*
|
|
1067
|
-
* Required, unless `cursorPaging` is provided.
|
|
912
|
+
* ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
|
|
913
|
+
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
914
|
+
* Provide `me` to retrieve events for the currently logged-in member.
|
|
915
|
+
* You must have the `Read Calendars - Including PI`
|
|
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
|
|
1068
920
|
*/
|
|
1069
|
-
|
|
921
|
+
memberId: string | null;
|
|
1070
922
|
/**
|
|
1071
|
-
*
|
|
1072
|
-
*
|
|
1073
|
-
* Required
|
|
923
|
+
* Local start date and time from which events are returned in
|
|
924
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
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
|
|
1074
930
|
*/
|
|
1075
|
-
|
|
931
|
+
fromLocalDate?: string | null;
|
|
1076
932
|
/**
|
|
1077
|
-
*
|
|
1078
|
-
*
|
|
1079
|
-
*
|
|
933
|
+
* Local end date and time up to which events are returned in
|
|
934
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
935
|
+
* `2024-01-30T13:30:00`. Can't be more than a full year after
|
|
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
|
|
1080
941
|
*/
|
|
1081
|
-
|
|
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;
|
|
942
|
+
toLocalDate?: string | null;
|
|
1094
943
|
/**
|
|
1095
944
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1096
|
-
* for calculating `adjustedStart` and
|
|
1097
|
-
* `America/New_York` or `UTC`.
|
|
945
|
+
* for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
|
|
946
|
+
* `adjustedEnd`. For example, `America/New_York` or `UTC`.
|
|
1098
947
|
*
|
|
1099
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/
|
|
948
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1100
949
|
*/
|
|
1101
950
|
timeZone?: string | null;
|
|
1102
951
|
/**
|
|
1103
|
-
*
|
|
1104
|
-
*
|
|
952
|
+
* [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
|
|
953
|
+
* to filter events by.
|
|
1105
954
|
* @format GUID
|
|
1106
955
|
*/
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
/** Created event. */
|
|
1111
|
-
event?: Event;
|
|
1112
|
-
}
|
|
1113
|
-
interface BulkCreateEventRequest {
|
|
1114
|
-
/**
|
|
1115
|
-
* Events to create.
|
|
1116
|
-
* @minSize 1
|
|
1117
|
-
* @maxSize 50
|
|
1118
|
-
*/
|
|
1119
|
-
events: MaskedEvent[];
|
|
1120
|
-
/**
|
|
1121
|
-
* Whether to return created events.
|
|
1122
|
-
*
|
|
1123
|
-
* Default: `false`.
|
|
1124
|
-
*/
|
|
1125
|
-
returnEntity?: boolean | null;
|
|
956
|
+
appId?: string | null;
|
|
957
|
+
/** Cursor to retrieve the next page of the results. */
|
|
958
|
+
cursorPaging?: CommonCursorPaging;
|
|
1126
959
|
/**
|
|
1127
|
-
*
|
|
1128
|
-
*
|
|
1129
|
-
* `America/New_York` or `UTC`.
|
|
960
|
+
* IDs of the events to retrieve.
|
|
961
|
+
* If you provide a list of IDs, all other filters are ignored.
|
|
1130
962
|
*
|
|
1131
|
-
*
|
|
963
|
+
* Max: 100 `eventId`s
|
|
964
|
+
* @maxSize 100
|
|
965
|
+
* @minLength 36
|
|
966
|
+
* @maxLength 250
|
|
1132
967
|
*/
|
|
1133
|
-
|
|
968
|
+
eventIds?: string[];
|
|
1134
969
|
}
|
|
1135
|
-
interface
|
|
1136
|
-
/**
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
/** The result for each event, containing the event and whether the action was successful. */
|
|
1141
|
-
results?: BulkEventResult[];
|
|
1142
|
-
/** Total successes and failures. */
|
|
1143
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1144
|
-
}
|
|
1145
|
-
interface BulkEventResult {
|
|
1146
|
-
/** Whether the requested action was successful. */
|
|
1147
|
-
itemMetadata?: ItemMetadata;
|
|
1148
|
-
/** The event. */
|
|
1149
|
-
item?: Event;
|
|
1150
|
-
}
|
|
1151
|
-
interface ItemMetadata {
|
|
1152
|
-
/**
|
|
1153
|
-
* Event ID.
|
|
1154
|
-
* Should always be available, unless it's impossible (for example, when failing to create an event).
|
|
1155
|
-
*/
|
|
1156
|
-
_id?: string | null;
|
|
1157
|
-
/** Index of the item within the request array, for correlation between request and response items. */
|
|
1158
|
-
originalIndex?: number;
|
|
1159
|
-
/**
|
|
1160
|
-
* Whether the requested action was successful for this event.
|
|
1161
|
-
* When `false`, the `error` field is populated.
|
|
1162
|
-
*/
|
|
1163
|
-
success?: boolean;
|
|
1164
|
-
/** Details about the error in case of failure. */
|
|
1165
|
-
error?: ApplicationError;
|
|
1166
|
-
}
|
|
1167
|
-
interface ApplicationError {
|
|
1168
|
-
/** Error code. */
|
|
1169
|
-
code?: string;
|
|
1170
|
-
/** Description of the error. */
|
|
1171
|
-
description?: string;
|
|
1172
|
-
/** Data related to the error. */
|
|
1173
|
-
data?: Record<string, any> | null;
|
|
1174
|
-
}
|
|
1175
|
-
interface BulkActionMetadata {
|
|
1176
|
-
/** Number of events that were successfully processed. */
|
|
1177
|
-
totalSuccesses?: number;
|
|
1178
|
-
/** Number of events that couldn't be processed. */
|
|
1179
|
-
totalFailures?: number;
|
|
1180
|
-
}
|
|
1181
|
-
interface UpdateEventRequest {
|
|
1182
|
-
/** Event to update. */
|
|
1183
|
-
event: Event;
|
|
1184
|
-
/**
|
|
1185
|
-
* Information about whether participants of the updated event are notified and
|
|
1186
|
-
* the message they receive.
|
|
1187
|
-
*/
|
|
1188
|
-
participantNotification?: ParticipantNotification;
|
|
1189
|
-
/**
|
|
1190
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1191
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1192
|
-
* `America/New_York` or `UTC`.
|
|
1193
|
-
*
|
|
1194
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1195
|
-
*/
|
|
1196
|
-
timeZone?: string | null;
|
|
1197
|
-
}
|
|
1198
|
-
interface UpdateEventResponse {
|
|
1199
|
-
/** Updated event. */
|
|
1200
|
-
event?: Event;
|
|
1201
|
-
}
|
|
1202
|
-
interface BulkUpdateEventRequest {
|
|
1203
|
-
/**
|
|
1204
|
-
* Events to update.
|
|
1205
|
-
*
|
|
1206
|
-
* Min: 1 event
|
|
1207
|
-
* Max: 50 events
|
|
1208
|
-
* @minSize 1
|
|
1209
|
-
* @maxSize 50
|
|
1210
|
-
*/
|
|
1211
|
-
events: BulkUpdateEventRequestMaskedEvent[];
|
|
1212
|
-
/**
|
|
1213
|
-
* Whether to return the updated events.
|
|
1214
|
-
*
|
|
1215
|
-
* Default: `false`
|
|
1216
|
-
*/
|
|
1217
|
-
returnEntity?: boolean | null;
|
|
1218
|
-
/**
|
|
1219
|
-
* Information about whether participants of the updated event are notified and
|
|
1220
|
-
* the message they receive.
|
|
1221
|
-
*/
|
|
1222
|
-
participantNotification?: ParticipantNotification;
|
|
1223
|
-
/**
|
|
1224
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1225
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1226
|
-
* `America/New_York` or `UTC`.
|
|
1227
|
-
*
|
|
1228
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1229
|
-
*/
|
|
1230
|
-
timeZone?: string | null;
|
|
1231
|
-
}
|
|
1232
|
-
interface BulkUpdateEventRequestMaskedEvent {
|
|
1233
|
-
/** Event to update. */
|
|
1234
|
-
event?: Event;
|
|
1235
|
-
}
|
|
1236
|
-
interface BulkUpdateEventResponse {
|
|
1237
|
-
/** The result for each event, containing the event and whether the action was successful. */
|
|
1238
|
-
results?: BulkEventResult[];
|
|
1239
|
-
/** Total successes and failures. */
|
|
1240
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1241
|
-
}
|
|
1242
|
-
interface UpdateEventParticipantsRequest {
|
|
1243
|
-
/**
|
|
1244
|
-
* ID of the event to update.
|
|
1245
|
-
*
|
|
1246
|
-
* Min: 36 characters
|
|
1247
|
-
* Max: 250 characters
|
|
1248
|
-
* @minLength 36
|
|
1249
|
-
* @maxLength 250
|
|
1250
|
-
*/
|
|
1251
|
-
eventId?: string | null;
|
|
1252
|
-
/** The participants to update. */
|
|
1253
|
-
participants?: Participants;
|
|
1254
|
-
}
|
|
1255
|
-
interface UpdateEventParticipantsResponse {
|
|
1256
|
-
/** Updated event. */
|
|
1257
|
-
event?: Event;
|
|
1258
|
-
}
|
|
1259
|
-
interface RestoreEventDefaultsRequest {
|
|
1260
|
-
/**
|
|
1261
|
-
* ID of the event for which to restore default values.
|
|
1262
|
-
* @minLength 36
|
|
1263
|
-
* @maxLength 250
|
|
1264
|
-
*/
|
|
1265
|
-
eventId: string | null;
|
|
1266
|
-
/**
|
|
1267
|
-
* Fields for which to restore default values.
|
|
1268
|
-
*
|
|
1269
|
-
* `TIME` restores default values for `start` and `end`.
|
|
1270
|
-
*
|
|
1271
|
-
* Min: 1 field
|
|
1272
|
-
* @minSize 1
|
|
1273
|
-
*/
|
|
1274
|
-
fields: FieldWithLiterals[];
|
|
1275
|
-
/**
|
|
1276
|
-
* Information about whether participants of the updated event are notified and
|
|
1277
|
-
* the message they receive.
|
|
1278
|
-
*/
|
|
1279
|
-
participantNotification?: ParticipantNotification;
|
|
1280
|
-
/**
|
|
1281
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1282
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1283
|
-
* `America/New_York` or `UTC`.
|
|
1284
|
-
*
|
|
1285
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1286
|
-
*/
|
|
1287
|
-
timeZone?: string | null;
|
|
1288
|
-
}
|
|
1289
|
-
interface RestoreEventDefaultsResponse {
|
|
1290
|
-
/** Updated event. */
|
|
1291
|
-
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;
|
|
970
|
+
interface ListEventsByMemberIdResponse {
|
|
971
|
+
/** Retrieved events. */
|
|
972
|
+
events?: Event[];
|
|
973
|
+
/** Paging metadata. */
|
|
974
|
+
pagingMetadata?: CommonCursorPagingMetadata;
|
|
1383
975
|
}
|
|
1384
976
|
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
1385
977
|
interface SitePropertiesNotification {
|
|
@@ -1669,12 +1261,572 @@ interface SiteCloned {
|
|
|
1669
1261
|
}
|
|
1670
1262
|
interface Empty {
|
|
1671
1263
|
}
|
|
1672
|
-
interface
|
|
1673
|
-
/**
|
|
1674
|
-
*
|
|
1675
|
-
*
|
|
1676
|
-
|
|
1677
|
-
|
|
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
|
|
1558
|
+
*/
|
|
1559
|
+
events: MaskedEvent[];
|
|
1560
|
+
/**
|
|
1561
|
+
* Whether to return created events.
|
|
1562
|
+
*
|
|
1563
|
+
* Default: `false`.
|
|
1564
|
+
*/
|
|
1565
|
+
returnEntity?: boolean | null;
|
|
1566
|
+
/**
|
|
1567
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1568
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1569
|
+
* `America/New_York` or `UTC`.
|
|
1570
|
+
*
|
|
1571
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1572
|
+
*/
|
|
1573
|
+
timeZone?: string | null;
|
|
1574
|
+
}
|
|
1575
|
+
interface MaskedEvent {
|
|
1576
|
+
/** Event to create. */
|
|
1577
|
+
event?: Event;
|
|
1578
|
+
}
|
|
1579
|
+
interface BulkCreateEventResponse {
|
|
1580
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
1581
|
+
results?: BulkEventResult[];
|
|
1582
|
+
/** Total successes and failures. */
|
|
1583
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1584
|
+
}
|
|
1585
|
+
interface BulkEventResult {
|
|
1586
|
+
/** Whether the requested action was successful. */
|
|
1587
|
+
itemMetadata?: ItemMetadata;
|
|
1588
|
+
/** The event. */
|
|
1589
|
+
item?: Event;
|
|
1590
|
+
}
|
|
1591
|
+
interface ItemMetadata {
|
|
1592
|
+
/**
|
|
1593
|
+
* Event ID.
|
|
1594
|
+
* Should always be available, unless it's impossible (for example, when failing to create an event).
|
|
1595
|
+
*/
|
|
1596
|
+
_id?: string | null;
|
|
1597
|
+
/** Index of the item within the request array, for correlation between request and response items. */
|
|
1598
|
+
originalIndex?: number;
|
|
1599
|
+
/**
|
|
1600
|
+
* Whether the requested action was successful for this event.
|
|
1601
|
+
* When `false`, the `error` field is populated.
|
|
1602
|
+
*/
|
|
1603
|
+
success?: boolean;
|
|
1604
|
+
/** Details about the error in case of failure. */
|
|
1605
|
+
error?: ApplicationError;
|
|
1606
|
+
}
|
|
1607
|
+
interface ApplicationError {
|
|
1608
|
+
/** Error code. */
|
|
1609
|
+
code?: string;
|
|
1610
|
+
/** Description of the error. */
|
|
1611
|
+
description?: string;
|
|
1612
|
+
/** Data related to the error. */
|
|
1613
|
+
data?: Record<string, any> | null;
|
|
1614
|
+
}
|
|
1615
|
+
interface BulkActionMetadata {
|
|
1616
|
+
/** Number of events that were successfully processed. */
|
|
1617
|
+
totalSuccesses?: number;
|
|
1618
|
+
/** Number of events that couldn't be processed. */
|
|
1619
|
+
totalFailures?: number;
|
|
1620
|
+
}
|
|
1621
|
+
interface UpdateEventRequest {
|
|
1622
|
+
/** Event to update. */
|
|
1623
|
+
event: Event;
|
|
1624
|
+
/**
|
|
1625
|
+
* Information about whether participants of the updated event are notified and
|
|
1626
|
+
* the message they receive.
|
|
1627
|
+
*/
|
|
1628
|
+
participantNotification?: ParticipantNotification;
|
|
1629
|
+
/**
|
|
1630
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1631
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1632
|
+
* `America/New_York` or `UTC`.
|
|
1633
|
+
*
|
|
1634
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1635
|
+
*/
|
|
1636
|
+
timeZone?: string | null;
|
|
1637
|
+
}
|
|
1638
|
+
interface UpdateEventResponse {
|
|
1639
|
+
/** Updated event. */
|
|
1640
|
+
event?: Event;
|
|
1641
|
+
}
|
|
1642
|
+
interface BulkUpdateEventRequest {
|
|
1643
|
+
/**
|
|
1644
|
+
* Events to update.
|
|
1645
|
+
*
|
|
1646
|
+
* Min: 1 event
|
|
1647
|
+
* Max: 50 events
|
|
1648
|
+
* @minSize 1
|
|
1649
|
+
* @maxSize 50
|
|
1650
|
+
*/
|
|
1651
|
+
events: BulkUpdateEventRequestMaskedEvent[];
|
|
1652
|
+
/**
|
|
1653
|
+
* Whether to return the updated events.
|
|
1654
|
+
*
|
|
1655
|
+
* Default: `false`
|
|
1656
|
+
*/
|
|
1657
|
+
returnEntity?: boolean | null;
|
|
1658
|
+
/**
|
|
1659
|
+
* Information about whether participants of the updated event are notified and
|
|
1660
|
+
* the message they receive.
|
|
1661
|
+
*/
|
|
1662
|
+
participantNotification?: ParticipantNotification;
|
|
1663
|
+
/**
|
|
1664
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1665
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1666
|
+
* `America/New_York` or `UTC`.
|
|
1667
|
+
*
|
|
1668
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1669
|
+
*/
|
|
1670
|
+
timeZone?: string | null;
|
|
1671
|
+
}
|
|
1672
|
+
interface BulkUpdateEventRequestMaskedEvent {
|
|
1673
|
+
/** Event to update. */
|
|
1674
|
+
event?: Event;
|
|
1675
|
+
}
|
|
1676
|
+
interface BulkUpdateEventResponse {
|
|
1677
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
1678
|
+
results?: BulkEventResult[];
|
|
1679
|
+
/** Total successes and failures. */
|
|
1680
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1681
|
+
}
|
|
1682
|
+
interface UpdateEventParticipantsRequest {
|
|
1683
|
+
/**
|
|
1684
|
+
* ID of the event to update.
|
|
1685
|
+
*
|
|
1686
|
+
* Min: 36 characters
|
|
1687
|
+
* Max: 250 characters
|
|
1688
|
+
* @minLength 36
|
|
1689
|
+
* @maxLength 250
|
|
1690
|
+
*/
|
|
1691
|
+
eventId?: string | null;
|
|
1692
|
+
/** The participants to update. */
|
|
1693
|
+
participants?: Participants;
|
|
1694
|
+
}
|
|
1695
|
+
interface UpdateEventParticipantsResponse {
|
|
1696
|
+
/** Updated event. */
|
|
1697
|
+
event?: Event;
|
|
1698
|
+
}
|
|
1699
|
+
interface RestoreEventDefaultsRequest {
|
|
1700
|
+
/**
|
|
1701
|
+
* ID of the event for which to restore default values.
|
|
1702
|
+
* @minLength 36
|
|
1703
|
+
* @maxLength 250
|
|
1704
|
+
*/
|
|
1705
|
+
eventId: string | null;
|
|
1706
|
+
/**
|
|
1707
|
+
* Fields for which to restore default values.
|
|
1708
|
+
*
|
|
1709
|
+
* `TIME` restores default values for `start` and `end`.
|
|
1710
|
+
*
|
|
1711
|
+
* Min: 1 field
|
|
1712
|
+
* @minSize 1
|
|
1713
|
+
*/
|
|
1714
|
+
fields: FieldWithLiterals[];
|
|
1715
|
+
/**
|
|
1716
|
+
* Information about whether participants of the updated event are notified and
|
|
1717
|
+
* the message they receive.
|
|
1718
|
+
*/
|
|
1719
|
+
participantNotification?: ParticipantNotification;
|
|
1720
|
+
/**
|
|
1721
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1722
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1723
|
+
* `America/New_York` or `UTC`.
|
|
1724
|
+
*
|
|
1725
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1726
|
+
*/
|
|
1727
|
+
timeZone?: string | null;
|
|
1728
|
+
}
|
|
1729
|
+
interface RestoreEventDefaultsResponse {
|
|
1730
|
+
/** Updated event. */
|
|
1731
|
+
event?: Event;
|
|
1732
|
+
}
|
|
1733
|
+
interface SplitRecurringEventRequest {
|
|
1734
|
+
/**
|
|
1735
|
+
* ID of the `MASTER` event to split.
|
|
1736
|
+
* @minLength 36
|
|
1737
|
+
* @maxLength 250
|
|
1738
|
+
*/
|
|
1739
|
+
recurringEventId: string | null;
|
|
1740
|
+
/**
|
|
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
|
|
1749
|
+
*/
|
|
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;
|
|
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;
|
|
1765
|
+
}
|
|
1766
|
+
interface CancelEventRequest {
|
|
1767
|
+
/**
|
|
1768
|
+
* ID of the event to cancel.
|
|
1769
|
+
* @minLength 36
|
|
1770
|
+
* @maxLength 250
|
|
1771
|
+
*/
|
|
1772
|
+
eventId: string | null;
|
|
1773
|
+
/**
|
|
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`.
|
|
1782
|
+
*
|
|
1783
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1784
|
+
*/
|
|
1785
|
+
timeZone?: string | null;
|
|
1786
|
+
}
|
|
1787
|
+
interface CancelEventResponse {
|
|
1788
|
+
/** Canceled event. */
|
|
1789
|
+
event?: Event;
|
|
1790
|
+
}
|
|
1791
|
+
interface BulkCancelEventRequest {
|
|
1792
|
+
/**
|
|
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.
|
|
1800
|
+
*
|
|
1801
|
+
* Default: `false`
|
|
1802
|
+
*/
|
|
1803
|
+
returnEntity?: boolean | null;
|
|
1804
|
+
/**
|
|
1805
|
+
* Information about whether participants of the canceled events are notified and
|
|
1806
|
+
* the message they receive.
|
|
1807
|
+
*/
|
|
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;
|
|
1817
|
+
}
|
|
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;
|
|
1823
|
+
}
|
|
1824
|
+
interface BaseEventMetadata {
|
|
1825
|
+
/**
|
|
1826
|
+
* App instance ID.
|
|
1827
|
+
* @format GUID
|
|
1828
|
+
*/
|
|
1829
|
+
instanceId?: string | null;
|
|
1678
1830
|
/**
|
|
1679
1831
|
* Event type.
|
|
1680
1832
|
* @maxLength 150
|
|
@@ -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 GeoCoordinates as aA, type BusinessSchedule as aB, type TimePeriod as aC, type SpecialHourPeriod as aD, type Multilingual as aE, type SupportedLanguage as aF, type ConsentPolicy as aG, type Translation as aH, type ChangeContext as aI, type ChangeContextPayloadOneOf as aJ, type PropertiesChange as aK, type SiteCreated as aL, type SiteCloned as aM, type Empty 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 UpdateScheduleWithFixedBusinessResourceIdRequest as aa, type UpdateScheduleWithFixedBusinessResourceIdResponse as ab, type UpdateEventsWithFixedBusinessResourceIdRequest as ac, type UpdateEventsWithFixedBusinessResourceIdResponse as ad, type DomainEvent as ae, type DomainEventBodyOneOf as af, type EntityCreatedEvent as ag, type RestoreInfo as ah, type EntityUpdatedEvent as ai, type EntityDeletedEvent as aj, type ActionEvent as ak, type MessageEnvelope as al, type IdentificationData as am, type IdentificationDataIdOneOf as an, type ListEventsByContactIdRequest as ao, type CommonCursorPaging as ap, type CommonCursorPagingMetadata as aq, type CommonCursors as ar, type ListEventsByMemberIdRequest as as, type SitePropertiesNotification as at, type SitePropertiesEvent as au, type Properties as av, type Categories as aw, type Locale as ax, type Address as ay, type AddressHint 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 };
|