@wix/calendar 1.0.50 → 1.0.52

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.
@@ -570,6 +570,144 @@ interface ExtendedFields$5 {
570
570
  */
571
571
  namespaces?: Record<string, Record<string, any>>;
572
572
  }
573
+ interface ListEventsByContactIdRequest$1 {
574
+ /**
575
+ * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
576
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
577
+ */
578
+ contactId: string | null;
579
+ /**
580
+ * Local start date and time from which events are returned in
581
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
582
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
583
+ *
584
+ * Events that start before the `fromLocalDate` but end after it are included in
585
+ * the results. Must be earlier than `toLocalDate`.
586
+ */
587
+ fromLocalDate?: string | null;
588
+ /**
589
+ * Local end date and time up to which events are returned in
590
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
591
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
592
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
593
+ *
594
+ * Events that start before `toLocalDate` but end after it are included in the
595
+ * results. Must be later than `fromLocalDate`.
596
+ */
597
+ toLocalDate?: string | null;
598
+ /**
599
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
600
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
601
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
602
+ *
603
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
604
+ */
605
+ timeZone?: string | null;
606
+ /**
607
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
608
+ * to filter events by.
609
+ */
610
+ appId?: string | null;
611
+ /** Cursor to retrieve the next page of the results. */
612
+ cursorPaging?: CommonCursorPaging$1;
613
+ }
614
+ /** TODO Diverge */
615
+ interface CommonCursorPaging$1 {
616
+ /**
617
+ * Number of events to return.
618
+ * Defaults to `50`. Maximum `100`.
619
+ */
620
+ limit?: number | null;
621
+ /**
622
+ * Pointer to the next or previous page in the list of results.
623
+ *
624
+ * You can get the relevant cursor token
625
+ * from the `pagingMetadata` object in the previous call's response.
626
+ * Not relevant for the first request.
627
+ */
628
+ cursor?: string | null;
629
+ }
630
+ interface ListEventsByContactIdResponse$1 {
631
+ /** Retrieved events. */
632
+ events?: Event$1[];
633
+ /** Paging metadata. */
634
+ pagingMetadata?: CommonCursorPagingMetadata$1;
635
+ }
636
+ /** TODO Diverge */
637
+ interface CommonCursorPagingMetadata$1 {
638
+ /** Number of items returned in the response. */
639
+ count?: number | null;
640
+ /** 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). */
641
+ cursors?: CommonCursors$1;
642
+ /**
643
+ * Indicates if there are more results after the current page.
644
+ * If `true`, another page of results can be retrieved.
645
+ * If `false`, this is the last page.
646
+ */
647
+ hasNext?: boolean | null;
648
+ }
649
+ interface CommonCursors$1 {
650
+ /** Cursor pointing to next page in the list of results. */
651
+ next?: string | null;
652
+ }
653
+ interface ListEventsByMemberIdRequest$1 {
654
+ /**
655
+ * ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
656
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
657
+ * Provide `me` to retrieve events for the currently logged-in member.
658
+ * You must have the `Read Calendars - Including PI`
659
+ * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
660
+ * to retrieve events for members who aren't the currently logged in member.
661
+ */
662
+ memberId: string | null;
663
+ /**
664
+ * Local start date and time from which events are returned in
665
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
666
+ * `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
667
+ *
668
+ * Events that start before the `fromLocalDate` but end after it are included in
669
+ * the results. Must be earlier than `toLocalDate`.
670
+ */
671
+ fromLocalDate?: string | null;
672
+ /**
673
+ * Local end date and time up to which events are returned in
674
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
675
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
676
+ * `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
677
+ *
678
+ * Events that start before `toLocalDate` but end after it are included in the
679
+ * results. Must be later than `fromLocalDate`.
680
+ */
681
+ toLocalDate?: string | null;
682
+ /**
683
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
684
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
685
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
686
+ *
687
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
688
+ */
689
+ timeZone?: string | null;
690
+ /**
691
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
692
+ * to filter events by.
693
+ */
694
+ appId?: string | null;
695
+ /** Cursor to retrieve the next page of the results. */
696
+ cursorPaging?: CommonCursorPaging$1;
697
+ /**
698
+ * IDs of the events to retrieve.
699
+ * If you provide a list of IDs, all other filters are ignored.
700
+ *
701
+ * Max: 100 `eventId`s
702
+ */
703
+ eventIds?: string[];
704
+ }
705
+ interface ListEventsByMemberIdResponse$1 {
706
+ /** Retrieved events. */
707
+ events?: Event$1[];
708
+ /** Paging metadata. */
709
+ pagingMetadata?: CommonCursorPagingMetadata$1;
710
+ }
573
711
  interface GetEventRequest$1 {
574
712
  /**
575
713
  * ID of the event to retrieve.
@@ -1042,144 +1180,6 @@ interface BulkCancelEventResponse$1 {
1042
1180
  /** Total successes and failures. */
1043
1181
  bulkActionMetadata?: BulkActionMetadata$1;
1044
1182
  }
1045
- interface ListEventsByContactIdRequest$1 {
1046
- /**
1047
- * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
1048
- * to retrieve events for. Required, unless you provide `cursorPaging`.
1049
- */
1050
- contactId: string | null;
1051
- /**
1052
- * Local start date and time from which events are returned in
1053
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1054
- * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
1055
- *
1056
- * Events that start before the `fromLocalDate` but end after it are included in
1057
- * the results. Must be earlier than `toLocalDate`.
1058
- */
1059
- fromLocalDate?: string | null;
1060
- /**
1061
- * Local end date and time up to which events are returned in
1062
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1063
- * `2024-01-30T13:30:00`. Can't be more than a full year after
1064
- * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
1065
- *
1066
- * Events that start before `toLocalDate` but end after it are included in the
1067
- * results. Must be later than `fromLocalDate`.
1068
- */
1069
- toLocalDate?: string | null;
1070
- /**
1071
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1072
- * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1073
- * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1074
- *
1075
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1076
- */
1077
- timeZone?: string | null;
1078
- /**
1079
- * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
1080
- * to filter events by.
1081
- */
1082
- appId?: string | null;
1083
- /** Cursor to retrieve the next page of the results. */
1084
- cursorPaging?: CommonCursorPaging$1;
1085
- }
1086
- /** TODO Diverge */
1087
- interface CommonCursorPaging$1 {
1088
- /**
1089
- * Number of events to return.
1090
- * Defaults to `50`. Maximum `100`.
1091
- */
1092
- limit?: number | null;
1093
- /**
1094
- * Pointer to the next or previous page in the list of results.
1095
- *
1096
- * You can get the relevant cursor token
1097
- * from the `pagingMetadata` object in the previous call's response.
1098
- * Not relevant for the first request.
1099
- */
1100
- cursor?: string | null;
1101
- }
1102
- interface ListEventsByContactIdResponse$1 {
1103
- /** Retrieved events. */
1104
- events?: Event$1[];
1105
- /** Paging metadata. */
1106
- pagingMetadata?: CommonCursorPagingMetadata$1;
1107
- }
1108
- /** TODO Diverge */
1109
- interface CommonCursorPagingMetadata$1 {
1110
- /** Number of items returned in the response. */
1111
- count?: number | null;
1112
- /** 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). */
1113
- cursors?: CommonCursors$1;
1114
- /**
1115
- * Indicates if there are more results after the current page.
1116
- * If `true`, another page of results can be retrieved.
1117
- * If `false`, this is the last page.
1118
- */
1119
- hasNext?: boolean | null;
1120
- }
1121
- interface CommonCursors$1 {
1122
- /** Cursor pointing to next page in the list of results. */
1123
- next?: string | null;
1124
- }
1125
- interface ListEventsByMemberIdRequest$1 {
1126
- /**
1127
- * ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
1128
- * to retrieve events for. Required, unless you provide `cursorPaging`.
1129
- * Provide `me` to retrieve events for the currently logged-in member.
1130
- * You must have the `Read Calendars - Including PI`
1131
- * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
1132
- * to retrieve events for members who aren't the currently logged in member.
1133
- */
1134
- memberId: string | null;
1135
- /**
1136
- * Local start date and time from which events are returned in
1137
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1138
- * `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
1139
- *
1140
- * Events that start before the `fromLocalDate` but end after it are included in
1141
- * the results. Must be earlier than `toLocalDate`.
1142
- */
1143
- fromLocalDate?: string | null;
1144
- /**
1145
- * Local end date and time up to which events are returned in
1146
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1147
- * `2024-01-30T13:30:00`. Can't be more than a full year after
1148
- * `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
1149
- *
1150
- * Events that start before `toLocalDate` but end after it are included in the
1151
- * results. Must be later than `fromLocalDate`.
1152
- */
1153
- toLocalDate?: string | null;
1154
- /**
1155
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1156
- * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1157
- * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1158
- *
1159
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1160
- */
1161
- timeZone?: string | null;
1162
- /**
1163
- * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
1164
- * to filter events by.
1165
- */
1166
- appId?: string | null;
1167
- /** Cursor to retrieve the next page of the results. */
1168
- cursorPaging?: CommonCursorPaging$1;
1169
- /**
1170
- * IDs of the events to retrieve.
1171
- * If you provide a list of IDs, all other filters are ignored.
1172
- *
1173
- * Max: 100 `eventId`s
1174
- */
1175
- eventIds?: string[];
1176
- }
1177
- interface ListEventsByMemberIdResponse$1 {
1178
- /** Retrieved events. */
1179
- events?: Event$1[];
1180
- /** Paging metadata. */
1181
- pagingMetadata?: CommonCursorPagingMetadata$1;
1182
- }
1183
1183
  interface RecurrenceRuleNonNullableFields$1 {
1184
1184
  frequency: Frequency$1;
1185
1185
  days: Day$1[];
@@ -1217,6 +1217,12 @@ interface EventNonNullableFields$1 {
1217
1217
  inheritedFields: Field$1[];
1218
1218
  permissions: PermissionNonNullableFields$3[];
1219
1219
  }
1220
+ interface ListEventsByContactIdResponseNonNullableFields$1 {
1221
+ events: EventNonNullableFields$1[];
1222
+ }
1223
+ interface ListEventsByMemberIdResponseNonNullableFields$1 {
1224
+ events: EventNonNullableFields$1[];
1225
+ }
1220
1226
  interface GetEventResponseNonNullableFields$1 {
1221
1227
  event?: EventNonNullableFields$1;
1222
1228
  }
@@ -1271,12 +1277,6 @@ interface BulkCancelEventResponseNonNullableFields$1 {
1271
1277
  results: BulkEventResultNonNullableFields$1[];
1272
1278
  bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
1273
1279
  }
1274
- interface ListEventsByContactIdResponseNonNullableFields$1 {
1275
- events: EventNonNullableFields$1[];
1276
- }
1277
- interface ListEventsByMemberIdResponseNonNullableFields$1 {
1278
- events: EventNonNullableFields$1[];
1279
- }
1280
1280
 
1281
1281
  /**
1282
1282
  * An event is a scheduled entry on a calendar that includes details like timing,
@@ -1802,50 +1802,188 @@ declare enum Field {
1802
1802
  /** `conferencingDetails` is inherited from the schedule or `MASTER` event. */
1803
1803
  CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
1804
1804
  }
1805
- interface Permission$2 {
1805
+ interface Permission$2 {
1806
+ /**
1807
+ * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
1808
+ * granted the permission.
1809
+ */
1810
+ identity?: CommonIdentificationData$2;
1811
+ /**
1812
+ * Permission role.
1813
+ *
1814
+ * Supported values:
1815
+ * + `WRITER`: Full read and write access.
1816
+ * + `COMMENTER`: Full read access, write access limited to `event.notes`.
1817
+ */
1818
+ role?: Role$2;
1819
+ }
1820
+ interface CommonIdentificationData$2 extends CommonIdentificationDataIdOneOf$2 {
1821
+ /**
1822
+ * ID of a Wix user. For example, the site owner or a
1823
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
1824
+ */
1825
+ wixUserId?: string;
1826
+ }
1827
+ /** @oneof */
1828
+ interface CommonIdentificationDataIdOneOf$2 {
1829
+ /**
1830
+ * ID of a Wix user. For example, the site owner or a
1831
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
1832
+ */
1833
+ wixUserId?: string;
1834
+ }
1835
+ declare enum IdentityType$2 {
1836
+ UNKNOWN = "UNKNOWN",
1837
+ WIX_USER = "WIX_USER"
1838
+ }
1839
+ interface ExtendedFields$4 {
1840
+ /**
1841
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
1842
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
1843
+ *
1844
+ * You can only access fields for which you have the appropriate permissions.
1845
+ *
1846
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
1847
+ */
1848
+ namespaces?: Record<string, Record<string, any>>;
1849
+ }
1850
+ interface ListEventsByContactIdRequest {
1851
+ /**
1852
+ * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
1853
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
1854
+ */
1855
+ contactId: string | null;
1856
+ /**
1857
+ * Local start date and time from which events are returned in
1858
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1859
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
1860
+ *
1861
+ * Events that start before the `fromLocalDate` but end after it are included in
1862
+ * the results. Must be earlier than `toLocalDate`.
1863
+ */
1864
+ fromLocalDate?: string | null;
1865
+ /**
1866
+ * Local end date and time up to which events are returned in
1867
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1868
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
1869
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
1870
+ *
1871
+ * Events that start before `toLocalDate` but end after it are included in the
1872
+ * results. Must be later than `fromLocalDate`.
1873
+ */
1874
+ toLocalDate?: string | null;
1875
+ /**
1876
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1877
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1878
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1879
+ *
1880
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1881
+ */
1882
+ timeZone?: string | null;
1883
+ /**
1884
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
1885
+ * to filter events by.
1886
+ */
1887
+ appId?: string | null;
1888
+ /** Cursor to retrieve the next page of the results. */
1889
+ cursorPaging?: CommonCursorPaging;
1890
+ }
1891
+ /** TODO Diverge */
1892
+ interface CommonCursorPaging {
1893
+ /**
1894
+ * Number of events to return.
1895
+ * Defaults to `50`. Maximum `100`.
1896
+ */
1897
+ limit?: number | null;
1898
+ /**
1899
+ * Pointer to the next or previous page in the list of results.
1900
+ *
1901
+ * You can get the relevant cursor token
1902
+ * from the `pagingMetadata` object in the previous call's response.
1903
+ * Not relevant for the first request.
1904
+ */
1905
+ cursor?: string | null;
1906
+ }
1907
+ interface ListEventsByContactIdResponse {
1908
+ /** Retrieved events. */
1909
+ events?: Event[];
1910
+ /** Paging metadata. */
1911
+ pagingMetadata?: CommonCursorPagingMetadata;
1912
+ }
1913
+ /** TODO Diverge */
1914
+ interface CommonCursorPagingMetadata {
1915
+ /** Number of items returned in the response. */
1916
+ count?: number | null;
1917
+ /** 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). */
1918
+ cursors?: CommonCursors;
1806
1919
  /**
1807
- * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
1808
- * granted the permission.
1920
+ * Indicates if there are more results after the current page.
1921
+ * If `true`, another page of results can be retrieved.
1922
+ * If `false`, this is the last page.
1809
1923
  */
1810
- identity?: CommonIdentificationData$2;
1924
+ hasNext?: boolean | null;
1925
+ }
1926
+ interface CommonCursors {
1927
+ /** Cursor pointing to next page in the list of results. */
1928
+ next?: string | null;
1929
+ }
1930
+ interface ListEventsByMemberIdRequest {
1811
1931
  /**
1812
- * Permission role.
1813
- *
1814
- * Supported values:
1815
- * + `WRITER`: Full read and write access.
1816
- * + `COMMENTER`: Full read access, write access limited to `event.notes`.
1932
+ * ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
1933
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
1934
+ * Provide `me` to retrieve events for the currently logged-in member.
1935
+ * You must have the `Read Calendars - Including PI`
1936
+ * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
1937
+ * to retrieve events for members who aren't the currently logged in member.
1817
1938
  */
1818
- role?: Role$2;
1819
- }
1820
- interface CommonIdentificationData$2 extends CommonIdentificationDataIdOneOf$2 {
1939
+ memberId: string | null;
1821
1940
  /**
1822
- * ID of a Wix user. For example, the site owner or a
1823
- * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
1941
+ * Local start date and time from which events are returned in
1942
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1943
+ * `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
1944
+ *
1945
+ * Events that start before the `fromLocalDate` but end after it are included in
1946
+ * the results. Must be earlier than `toLocalDate`.
1824
1947
  */
1825
- wixUserId?: string;
1826
- }
1827
- /** @oneof */
1828
- interface CommonIdentificationDataIdOneOf$2 {
1948
+ fromLocalDate?: string | null;
1829
1949
  /**
1830
- * ID of a Wix user. For example, the site owner or a
1831
- * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
1950
+ * Local end date and time up to which events are returned in
1951
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1952
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
1953
+ * `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
1954
+ *
1955
+ * Events that start before `toLocalDate` but end after it are included in the
1956
+ * results. Must be later than `fromLocalDate`.
1832
1957
  */
1833
- wixUserId?: string;
1834
- }
1835
- declare enum IdentityType$2 {
1836
- UNKNOWN = "UNKNOWN",
1837
- WIX_USER = "WIX_USER"
1838
- }
1839
- interface ExtendedFields$4 {
1958
+ toLocalDate?: string | null;
1840
1959
  /**
1841
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
1842
- * The value of each key is structured according to the schema defined when the extended fields were configured.
1960
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1961
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1962
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1843
1963
  *
1844
- * You can only access fields for which you have the appropriate permissions.
1964
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1965
+ */
1966
+ timeZone?: string | null;
1967
+ /**
1968
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
1969
+ * to filter events by.
1970
+ */
1971
+ appId?: string | null;
1972
+ /** Cursor to retrieve the next page of the results. */
1973
+ cursorPaging?: CommonCursorPaging;
1974
+ /**
1975
+ * IDs of the events to retrieve.
1976
+ * If you provide a list of IDs, all other filters are ignored.
1845
1977
  *
1846
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
1978
+ * Max: 100 `eventId`s
1847
1979
  */
1848
- namespaces?: Record<string, Record<string, any>>;
1980
+ eventIds?: string[];
1981
+ }
1982
+ interface ListEventsByMemberIdResponse {
1983
+ /** Retrieved events. */
1984
+ events?: Event[];
1985
+ /** Paging metadata. */
1986
+ pagingMetadata?: CommonCursorPagingMetadata;
1849
1987
  }
1850
1988
  interface GetEventRequest {
1851
1989
  /**
@@ -2319,144 +2457,6 @@ interface BulkCancelEventResponse {
2319
2457
  /** Total successes and failures. */
2320
2458
  bulkActionMetadata?: BulkActionMetadata;
2321
2459
  }
2322
- interface ListEventsByContactIdRequest {
2323
- /**
2324
- * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
2325
- * to retrieve events for. Required, unless you provide `cursorPaging`.
2326
- */
2327
- contactId: string | null;
2328
- /**
2329
- * Local start date and time from which events are returned in
2330
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2331
- * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
2332
- *
2333
- * Events that start before the `fromLocalDate` but end after it are included in
2334
- * the results. Must be earlier than `toLocalDate`.
2335
- */
2336
- fromLocalDate?: string | null;
2337
- /**
2338
- * Local end date and time up to which events are returned in
2339
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2340
- * `2024-01-30T13:30:00`. Can't be more than a full year after
2341
- * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
2342
- *
2343
- * Events that start before `toLocalDate` but end after it are included in the
2344
- * results. Must be later than `fromLocalDate`.
2345
- */
2346
- toLocalDate?: string | null;
2347
- /**
2348
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2349
- * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2350
- * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2351
- *
2352
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2353
- */
2354
- timeZone?: string | null;
2355
- /**
2356
- * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2357
- * to filter events by.
2358
- */
2359
- appId?: string | null;
2360
- /** Cursor to retrieve the next page of the results. */
2361
- cursorPaging?: CommonCursorPaging;
2362
- }
2363
- /** TODO Diverge */
2364
- interface CommonCursorPaging {
2365
- /**
2366
- * Number of events to return.
2367
- * Defaults to `50`. Maximum `100`.
2368
- */
2369
- limit?: number | null;
2370
- /**
2371
- * Pointer to the next or previous page in the list of results.
2372
- *
2373
- * You can get the relevant cursor token
2374
- * from the `pagingMetadata` object in the previous call's response.
2375
- * Not relevant for the first request.
2376
- */
2377
- cursor?: string | null;
2378
- }
2379
- interface ListEventsByContactIdResponse {
2380
- /** Retrieved events. */
2381
- events?: Event[];
2382
- /** Paging metadata. */
2383
- pagingMetadata?: CommonCursorPagingMetadata;
2384
- }
2385
- /** TODO Diverge */
2386
- interface CommonCursorPagingMetadata {
2387
- /** Number of items returned in the response. */
2388
- count?: number | null;
2389
- /** 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). */
2390
- cursors?: CommonCursors;
2391
- /**
2392
- * Indicates if there are more results after the current page.
2393
- * If `true`, another page of results can be retrieved.
2394
- * If `false`, this is the last page.
2395
- */
2396
- hasNext?: boolean | null;
2397
- }
2398
- interface CommonCursors {
2399
- /** Cursor pointing to next page in the list of results. */
2400
- next?: string | null;
2401
- }
2402
- interface ListEventsByMemberIdRequest {
2403
- /**
2404
- * ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
2405
- * to retrieve events for. Required, unless you provide `cursorPaging`.
2406
- * Provide `me` to retrieve events for the currently logged-in member.
2407
- * You must have the `Read Calendars - Including PI`
2408
- * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
2409
- * to retrieve events for members who aren't the currently logged in member.
2410
- */
2411
- memberId: string | null;
2412
- /**
2413
- * Local start date and time from which events are returned in
2414
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2415
- * `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
2416
- *
2417
- * Events that start before the `fromLocalDate` but end after it are included in
2418
- * the results. Must be earlier than `toLocalDate`.
2419
- */
2420
- fromLocalDate?: string | null;
2421
- /**
2422
- * Local end date and time up to which events are returned in
2423
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2424
- * `2024-01-30T13:30:00`. Can't be more than a full year after
2425
- * `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
2426
- *
2427
- * Events that start before `toLocalDate` but end after it are included in the
2428
- * results. Must be later than `fromLocalDate`.
2429
- */
2430
- toLocalDate?: string | null;
2431
- /**
2432
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2433
- * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2434
- * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2435
- *
2436
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2437
- */
2438
- timeZone?: string | null;
2439
- /**
2440
- * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2441
- * to filter events by.
2442
- */
2443
- appId?: string | null;
2444
- /** Cursor to retrieve the next page of the results. */
2445
- cursorPaging?: CommonCursorPaging;
2446
- /**
2447
- * IDs of the events to retrieve.
2448
- * If you provide a list of IDs, all other filters are ignored.
2449
- *
2450
- * Max: 100 `eventId`s
2451
- */
2452
- eventIds?: string[];
2453
- }
2454
- interface ListEventsByMemberIdResponse {
2455
- /** Retrieved events. */
2456
- events?: Event[];
2457
- /** Paging metadata. */
2458
- pagingMetadata?: CommonCursorPagingMetadata;
2459
- }
2460
2460
  interface RecurrenceRuleNonNullableFields {
2461
2461
  frequency: Frequency;
2462
2462
  days: Day[];
@@ -2494,6 +2494,12 @@ interface EventNonNullableFields {
2494
2494
  inheritedFields: Field[];
2495
2495
  permissions: PermissionNonNullableFields$2[];
2496
2496
  }
2497
+ interface ListEventsByContactIdResponseNonNullableFields {
2498
+ events: EventNonNullableFields[];
2499
+ }
2500
+ interface ListEventsByMemberIdResponseNonNullableFields {
2501
+ events: EventNonNullableFields[];
2502
+ }
2497
2503
  interface GetEventResponseNonNullableFields {
2498
2504
  event?: EventNonNullableFields;
2499
2505
  }
@@ -2548,12 +2554,6 @@ interface BulkCancelEventResponseNonNullableFields {
2548
2554
  results: BulkEventResultNonNullableFields[];
2549
2555
  bulkActionMetadata?: BulkActionMetadataNonNullableFields;
2550
2556
  }
2551
- interface ListEventsByContactIdResponseNonNullableFields {
2552
- events: EventNonNullableFields[];
2553
- }
2554
- interface ListEventsByMemberIdResponseNonNullableFields {
2555
- events: EventNonNullableFields[];
2556
- }
2557
2557
 
2558
2558
  type __PublicMethodMetaInfo$4<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
2559
2559
  getUrl: (context: any) => string;
@@ -2565,6 +2565,12 @@ type __PublicMethodMetaInfo$4<K = string, M = unknown, T = unknown, S = unknown,
2565
2565
  __responseType: Q;
2566
2566
  __originalResponseType: R;
2567
2567
  };
2568
+ declare function listEventsByContactId(): __PublicMethodMetaInfo$4<'GET', {
2569
+ contactId: string;
2570
+ }, ListEventsByContactIdRequest, ListEventsByContactIdRequest$1, ListEventsByContactIdResponse & ListEventsByContactIdResponseNonNullableFields, ListEventsByContactIdResponse$1 & ListEventsByContactIdResponseNonNullableFields$1>;
2571
+ declare function listEventsByMemberId(): __PublicMethodMetaInfo$4<'GET', {
2572
+ memberId: string;
2573
+ }, ListEventsByMemberIdRequest, ListEventsByMemberIdRequest$1, ListEventsByMemberIdResponse & ListEventsByMemberIdResponseNonNullableFields, ListEventsByMemberIdResponse$1 & ListEventsByMemberIdResponseNonNullableFields$1>;
2568
2574
  declare function getEvent(): __PublicMethodMetaInfo$4<'GET', {
2569
2575
  eventId: string;
2570
2576
  }, GetEventRequest, GetEventRequest$1, GetEventResponse & GetEventResponseNonNullableFields, GetEventResponse$1 & GetEventResponseNonNullableFields$1>;
@@ -2586,12 +2592,6 @@ declare function cancelEvent(): __PublicMethodMetaInfo$4<'POST', {
2586
2592
  eventId: string;
2587
2593
  }, CancelEventRequest, CancelEventRequest$1, CancelEventResponse & CancelEventResponseNonNullableFields, CancelEventResponse$1 & CancelEventResponseNonNullableFields$1>;
2588
2594
  declare function bulkCancelEvent(): __PublicMethodMetaInfo$4<'POST', {}, BulkCancelEventRequest, BulkCancelEventRequest$1, BulkCancelEventResponse & BulkCancelEventResponseNonNullableFields, BulkCancelEventResponse$1 & BulkCancelEventResponseNonNullableFields$1>;
2589
- declare function listEventsByContactId(): __PublicMethodMetaInfo$4<'GET', {
2590
- contactId: string;
2591
- }, ListEventsByContactIdRequest, ListEventsByContactIdRequest$1, ListEventsByContactIdResponse & ListEventsByContactIdResponseNonNullableFields, ListEventsByContactIdResponse$1 & ListEventsByContactIdResponseNonNullableFields$1>;
2592
- declare function listEventsByMemberId(): __PublicMethodMetaInfo$4<'GET', {
2593
- memberId: string;
2594
- }, ListEventsByMemberIdRequest, ListEventsByMemberIdRequest$1, ListEventsByMemberIdResponse & ListEventsByMemberIdResponseNonNullableFields, ListEventsByMemberIdResponse$1 & ListEventsByMemberIdResponseNonNullableFields$1>;
2595
2595
 
2596
2596
  declare const meta$4_bulkCancelEvent: typeof bulkCancelEvent;
2597
2597
  declare const meta$4_bulkCreateEvent: typeof bulkCreateEvent;