@wix/calendar 1.0.56 → 1.0.57

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.
@@ -231,8 +231,6 @@ declare enum Status$7 {
231
231
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
232
232
  /** Event is scheduled to happen or has happened. */
233
233
  CONFIRMED = "CONFIRMED",
234
- /** DEPRECATED! AND WILL BE REMOVED SOON */
235
- PENDING_CONFIRMATION = "PENDING_CONFIRMATION",
236
234
  /** Event has been canceled. */
237
235
  CANCELLED = "CANCELLED"
238
236
  }
@@ -570,144 +568,6 @@ interface ExtendedFields$5 {
570
568
  */
571
569
  namespaces?: Record<string, Record<string, any>>;
572
570
  }
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
- }
711
571
  interface GetEventRequest$1 {
712
572
  /**
713
573
  * ID of the event to retrieve.
@@ -1180,6 +1040,144 @@ interface BulkCancelEventResponse$1 {
1180
1040
  /** Total successes and failures. */
1181
1041
  bulkActionMetadata?: BulkActionMetadata$1;
1182
1042
  }
1043
+ interface ListEventsByContactIdRequest$1 {
1044
+ /**
1045
+ * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
1046
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
1047
+ */
1048
+ contactId: string | null;
1049
+ /**
1050
+ * Local start date and time from which events are returned in
1051
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1052
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
1053
+ *
1054
+ * Events that start before the `fromLocalDate` but end after it are included in
1055
+ * the results. Must be earlier than `toLocalDate`.
1056
+ */
1057
+ fromLocalDate?: string | null;
1058
+ /**
1059
+ * Local end date and time up to which events are returned in
1060
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1061
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
1062
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
1063
+ *
1064
+ * Events that start before `toLocalDate` but end after it are included in the
1065
+ * results. Must be later than `fromLocalDate`.
1066
+ */
1067
+ toLocalDate?: string | null;
1068
+ /**
1069
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1070
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1071
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1072
+ *
1073
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1074
+ */
1075
+ timeZone?: string | null;
1076
+ /**
1077
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
1078
+ * to filter events by.
1079
+ */
1080
+ appId?: string | null;
1081
+ /** Cursor to retrieve the next page of the results. */
1082
+ cursorPaging?: CommonCursorPaging$1;
1083
+ }
1084
+ /** TODO Diverge */
1085
+ interface CommonCursorPaging$1 {
1086
+ /**
1087
+ * Number of events to return.
1088
+ * Defaults to `50`. Maximum `100`.
1089
+ */
1090
+ limit?: number | null;
1091
+ /**
1092
+ * Pointer to the next or previous page in the list of results.
1093
+ *
1094
+ * You can get the relevant cursor token
1095
+ * from the `pagingMetadata` object in the previous call's response.
1096
+ * Not relevant for the first request.
1097
+ */
1098
+ cursor?: string | null;
1099
+ }
1100
+ interface ListEventsByContactIdResponse$1 {
1101
+ /** Retrieved events. */
1102
+ events?: Event$1[];
1103
+ /** Paging metadata. */
1104
+ pagingMetadata?: CommonCursorPagingMetadata$1;
1105
+ }
1106
+ /** TODO Diverge */
1107
+ interface CommonCursorPagingMetadata$1 {
1108
+ /** Number of items returned in the response. */
1109
+ count?: number | null;
1110
+ /** 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). */
1111
+ cursors?: CommonCursors$1;
1112
+ /**
1113
+ * Indicates if there are more results after the current page.
1114
+ * If `true`, another page of results can be retrieved.
1115
+ * If `false`, this is the last page.
1116
+ */
1117
+ hasNext?: boolean | null;
1118
+ }
1119
+ interface CommonCursors$1 {
1120
+ /** Cursor pointing to next page in the list of results. */
1121
+ next?: string | null;
1122
+ }
1123
+ interface ListEventsByMemberIdRequest$1 {
1124
+ /**
1125
+ * ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
1126
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
1127
+ * Provide `me` to retrieve events for the currently logged-in member.
1128
+ * You must have the `Read Calendars - Including PI`
1129
+ * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
1130
+ * to retrieve events for members who aren't the currently logged in member.
1131
+ */
1132
+ memberId: string | null;
1133
+ /**
1134
+ * Local start date and time from which events are returned in
1135
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1136
+ * `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
1137
+ *
1138
+ * Events that start before the `fromLocalDate` but end after it are included in
1139
+ * the results. Must be earlier than `toLocalDate`.
1140
+ */
1141
+ fromLocalDate?: string | null;
1142
+ /**
1143
+ * Local end date and time up to which events are returned in
1144
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1145
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
1146
+ * `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
1147
+ *
1148
+ * Events that start before `toLocalDate` but end after it are included in the
1149
+ * results. Must be later than `fromLocalDate`.
1150
+ */
1151
+ toLocalDate?: string | null;
1152
+ /**
1153
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1154
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1155
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1156
+ *
1157
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1158
+ */
1159
+ timeZone?: string | null;
1160
+ /**
1161
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
1162
+ * to filter events by.
1163
+ */
1164
+ appId?: string | null;
1165
+ /** Cursor to retrieve the next page of the results. */
1166
+ cursorPaging?: CommonCursorPaging$1;
1167
+ /**
1168
+ * IDs of the events to retrieve.
1169
+ * If you provide a list of IDs, all other filters are ignored.
1170
+ *
1171
+ * Max: 100 `eventId`s
1172
+ */
1173
+ eventIds?: string[];
1174
+ }
1175
+ interface ListEventsByMemberIdResponse$1 {
1176
+ /** Retrieved events. */
1177
+ events?: Event$1[];
1178
+ /** Paging metadata. */
1179
+ pagingMetadata?: CommonCursorPagingMetadata$1;
1180
+ }
1183
1181
  interface RecurrenceRuleNonNullableFields$1 {
1184
1182
  frequency: Frequency$1;
1185
1183
  days: Day$1[];
@@ -1217,12 +1215,6 @@ interface EventNonNullableFields$1 {
1217
1215
  inheritedFields: Field$1[];
1218
1216
  permissions: PermissionNonNullableFields$3[];
1219
1217
  }
1220
- interface ListEventsByContactIdResponseNonNullableFields$1 {
1221
- events: EventNonNullableFields$1[];
1222
- }
1223
- interface ListEventsByMemberIdResponseNonNullableFields$1 {
1224
- events: EventNonNullableFields$1[];
1225
- }
1226
1218
  interface GetEventResponseNonNullableFields$1 {
1227
1219
  event?: EventNonNullableFields$1;
1228
1220
  }
@@ -1277,6 +1269,12 @@ interface BulkCancelEventResponseNonNullableFields$1 {
1277
1269
  results: BulkEventResultNonNullableFields$1[];
1278
1270
  bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
1279
1271
  }
1272
+ interface ListEventsByContactIdResponseNonNullableFields$1 {
1273
+ events: EventNonNullableFields$1[];
1274
+ }
1275
+ interface ListEventsByMemberIdResponseNonNullableFields$1 {
1276
+ events: EventNonNullableFields$1[];
1277
+ }
1280
1278
 
1281
1279
  /**
1282
1280
  * An event is a scheduled entry on a calendar that includes details like timing,
@@ -1508,8 +1506,6 @@ declare enum Status$6 {
1508
1506
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
1509
1507
  /** Event is scheduled to happen or has happened. */
1510
1508
  CONFIRMED = "CONFIRMED",
1511
- /** DEPRECATED! AND WILL BE REMOVED SOON */
1512
- PENDING_CONFIRMATION = "PENDING_CONFIRMATION",
1513
1509
  /** Event has been canceled. */
1514
1510
  CANCELLED = "CANCELLED"
1515
1511
  }
@@ -1786,204 +1782,66 @@ declare enum Type$2 {
1786
1782
  declare enum Field {
1787
1783
  UNKNOWN_FIELD = "UNKNOWN_FIELD",
1788
1784
  /** `title` is inherited from the schedule or `MASTER` event. */
1789
- TITLE = "TITLE",
1790
- /** `timeZone` is inherited from the schedule or `MASTER` event. */
1791
- TIME_ZONE = "TIME_ZONE",
1792
- /** `start` and `end` are inherited from the `MASTER` event. */
1793
- TIME = "TIME",
1794
- /** `location` is inherited from the schedule or `MASTER` event. */
1795
- LOCATION = "LOCATION",
1796
- /** `resources` is inherited from the `MASTER` event. */
1797
- RESOURCES = "RESOURCES",
1798
- /** `capacity` is inherited from the schedule or `MASTER` event. */
1799
- CAPACITY = "CAPACITY",
1800
- /** `participants` is inherited from the `MASTER` event. */
1801
- PARTICIPANTS = "PARTICIPANTS",
1802
- /** `conferencingDetails` is inherited from the schedule or `MASTER` event. */
1803
- CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
1804
- }
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;
1919
- /**
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.
1923
- */
1924
- hasNext?: boolean | null;
1925
- }
1926
- interface CommonCursors {
1927
- /** Cursor pointing to next page in the list of results. */
1928
- next?: string | null;
1785
+ TITLE = "TITLE",
1786
+ /** `timeZone` is inherited from the schedule or `MASTER` event. */
1787
+ TIME_ZONE = "TIME_ZONE",
1788
+ /** `start` and `end` are inherited from the `MASTER` event. */
1789
+ TIME = "TIME",
1790
+ /** `location` is inherited from the schedule or `MASTER` event. */
1791
+ LOCATION = "LOCATION",
1792
+ /** `resources` is inherited from the `MASTER` event. */
1793
+ RESOURCES = "RESOURCES",
1794
+ /** `capacity` is inherited from the schedule or `MASTER` event. */
1795
+ CAPACITY = "CAPACITY",
1796
+ /** `participants` is inherited from the `MASTER` event. */
1797
+ PARTICIPANTS = "PARTICIPANTS",
1798
+ /** `conferencingDetails` is inherited from the schedule or `MASTER` event. */
1799
+ CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
1929
1800
  }
1930
- interface ListEventsByMemberIdRequest {
1931
- /**
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.
1938
- */
1939
- memberId: string | null;
1801
+ interface Permission$2 {
1940
1802
  /**
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`.
1803
+ * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
1804
+ * granted the permission.
1947
1805
  */
1948
- fromLocalDate?: string | null;
1806
+ identity?: CommonIdentificationData$2;
1949
1807
  /**
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.
1808
+ * Permission role.
1954
1809
  *
1955
- * Events that start before `toLocalDate` but end after it are included in the
1956
- * results. Must be later than `fromLocalDate`.
1810
+ * Supported values:
1811
+ * + `WRITER`: Full read and write access.
1812
+ * + `COMMENTER`: Full read access, write access limited to `event.notes`.
1957
1813
  */
1958
- toLocalDate?: string | null;
1814
+ role?: Role$2;
1815
+ }
1816
+ interface CommonIdentificationData$2 extends CommonIdentificationDataIdOneOf$2 {
1959
1817
  /**
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`.
1963
- *
1964
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1818
+ * ID of a Wix user. For example, the site owner or a
1819
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
1965
1820
  */
1966
- timeZone?: string | null;
1821
+ wixUserId?: string;
1822
+ }
1823
+ /** @oneof */
1824
+ interface CommonIdentificationDataIdOneOf$2 {
1967
1825
  /**
1968
- * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
1969
- * to filter events by.
1826
+ * ID of a Wix user. For example, the site owner or a
1827
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
1970
1828
  */
1971
- appId?: string | null;
1972
- /** Cursor to retrieve the next page of the results. */
1973
- cursorPaging?: CommonCursorPaging;
1829
+ wixUserId?: string;
1830
+ }
1831
+ declare enum IdentityType$2 {
1832
+ UNKNOWN = "UNKNOWN",
1833
+ WIX_USER = "WIX_USER"
1834
+ }
1835
+ interface ExtendedFields$4 {
1974
1836
  /**
1975
- * IDs of the events to retrieve.
1976
- * If you provide a list of IDs, all other filters are ignored.
1837
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
1838
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
1977
1839
  *
1978
- * Max: 100 `eventId`s
1840
+ * You can only access fields for which you have the appropriate permissions.
1841
+ *
1842
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
1979
1843
  */
1980
- eventIds?: string[];
1981
- }
1982
- interface ListEventsByMemberIdResponse {
1983
- /** Retrieved events. */
1984
- events?: Event[];
1985
- /** Paging metadata. */
1986
- pagingMetadata?: CommonCursorPagingMetadata;
1844
+ namespaces?: Record<string, Record<string, any>>;
1987
1845
  }
1988
1846
  interface GetEventRequest {
1989
1847
  /**
@@ -2457,6 +2315,144 @@ interface BulkCancelEventResponse {
2457
2315
  /** Total successes and failures. */
2458
2316
  bulkActionMetadata?: BulkActionMetadata;
2459
2317
  }
2318
+ interface ListEventsByContactIdRequest {
2319
+ /**
2320
+ * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
2321
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
2322
+ */
2323
+ contactId: string | null;
2324
+ /**
2325
+ * Local start date and time from which events are returned in
2326
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2327
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
2328
+ *
2329
+ * Events that start before the `fromLocalDate` but end after it are included in
2330
+ * the results. Must be earlier than `toLocalDate`.
2331
+ */
2332
+ fromLocalDate?: string | null;
2333
+ /**
2334
+ * Local end date and time up to which events are returned in
2335
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2336
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
2337
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
2338
+ *
2339
+ * Events that start before `toLocalDate` but end after it are included in the
2340
+ * results. Must be later than `fromLocalDate`.
2341
+ */
2342
+ toLocalDate?: string | null;
2343
+ /**
2344
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2345
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2346
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2347
+ *
2348
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2349
+ */
2350
+ timeZone?: string | null;
2351
+ /**
2352
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2353
+ * to filter events by.
2354
+ */
2355
+ appId?: string | null;
2356
+ /** Cursor to retrieve the next page of the results. */
2357
+ cursorPaging?: CommonCursorPaging;
2358
+ }
2359
+ /** TODO Diverge */
2360
+ interface CommonCursorPaging {
2361
+ /**
2362
+ * Number of events to return.
2363
+ * Defaults to `50`. Maximum `100`.
2364
+ */
2365
+ limit?: number | null;
2366
+ /**
2367
+ * Pointer to the next or previous page in the list of results.
2368
+ *
2369
+ * You can get the relevant cursor token
2370
+ * from the `pagingMetadata` object in the previous call's response.
2371
+ * Not relevant for the first request.
2372
+ */
2373
+ cursor?: string | null;
2374
+ }
2375
+ interface ListEventsByContactIdResponse {
2376
+ /** Retrieved events. */
2377
+ events?: Event[];
2378
+ /** Paging metadata. */
2379
+ pagingMetadata?: CommonCursorPagingMetadata;
2380
+ }
2381
+ /** TODO Diverge */
2382
+ interface CommonCursorPagingMetadata {
2383
+ /** Number of items returned in the response. */
2384
+ count?: number | null;
2385
+ /** 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). */
2386
+ cursors?: CommonCursors;
2387
+ /**
2388
+ * Indicates if there are more results after the current page.
2389
+ * If `true`, another page of results can be retrieved.
2390
+ * If `false`, this is the last page.
2391
+ */
2392
+ hasNext?: boolean | null;
2393
+ }
2394
+ interface CommonCursors {
2395
+ /** Cursor pointing to next page in the list of results. */
2396
+ next?: string | null;
2397
+ }
2398
+ interface ListEventsByMemberIdRequest {
2399
+ /**
2400
+ * ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
2401
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
2402
+ * Provide `me` to retrieve events for the currently logged-in member.
2403
+ * You must have the `Read Calendars - Including PI`
2404
+ * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
2405
+ * to retrieve events for members who aren't the currently logged in member.
2406
+ */
2407
+ memberId: string | null;
2408
+ /**
2409
+ * Local start date and time from which events are returned in
2410
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2411
+ * `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
2412
+ *
2413
+ * Events that start before the `fromLocalDate` but end after it are included in
2414
+ * the results. Must be earlier than `toLocalDate`.
2415
+ */
2416
+ fromLocalDate?: string | null;
2417
+ /**
2418
+ * Local end date and time up to which events are returned in
2419
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2420
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
2421
+ * `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
2422
+ *
2423
+ * Events that start before `toLocalDate` but end after it are included in the
2424
+ * results. Must be later than `fromLocalDate`.
2425
+ */
2426
+ toLocalDate?: string | null;
2427
+ /**
2428
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2429
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2430
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2431
+ *
2432
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2433
+ */
2434
+ timeZone?: string | null;
2435
+ /**
2436
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2437
+ * to filter events by.
2438
+ */
2439
+ appId?: string | null;
2440
+ /** Cursor to retrieve the next page of the results. */
2441
+ cursorPaging?: CommonCursorPaging;
2442
+ /**
2443
+ * IDs of the events to retrieve.
2444
+ * If you provide a list of IDs, all other filters are ignored.
2445
+ *
2446
+ * Max: 100 `eventId`s
2447
+ */
2448
+ eventIds?: string[];
2449
+ }
2450
+ interface ListEventsByMemberIdResponse {
2451
+ /** Retrieved events. */
2452
+ events?: Event[];
2453
+ /** Paging metadata. */
2454
+ pagingMetadata?: CommonCursorPagingMetadata;
2455
+ }
2460
2456
  interface RecurrenceRuleNonNullableFields {
2461
2457
  frequency: Frequency;
2462
2458
  days: Day[];
@@ -2494,12 +2490,6 @@ interface EventNonNullableFields {
2494
2490
  inheritedFields: Field[];
2495
2491
  permissions: PermissionNonNullableFields$2[];
2496
2492
  }
2497
- interface ListEventsByContactIdResponseNonNullableFields {
2498
- events: EventNonNullableFields[];
2499
- }
2500
- interface ListEventsByMemberIdResponseNonNullableFields {
2501
- events: EventNonNullableFields[];
2502
- }
2503
2493
  interface GetEventResponseNonNullableFields {
2504
2494
  event?: EventNonNullableFields;
2505
2495
  }
@@ -2554,6 +2544,12 @@ interface BulkCancelEventResponseNonNullableFields {
2554
2544
  results: BulkEventResultNonNullableFields[];
2555
2545
  bulkActionMetadata?: BulkActionMetadataNonNullableFields;
2556
2546
  }
2547
+ interface ListEventsByContactIdResponseNonNullableFields {
2548
+ events: EventNonNullableFields[];
2549
+ }
2550
+ interface ListEventsByMemberIdResponseNonNullableFields {
2551
+ events: EventNonNullableFields[];
2552
+ }
2557
2553
 
2558
2554
  type __PublicMethodMetaInfo$4<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
2559
2555
  getUrl: (context: any) => string;
@@ -2565,12 +2561,6 @@ type __PublicMethodMetaInfo$4<K = string, M = unknown, T = unknown, S = unknown,
2565
2561
  __responseType: Q;
2566
2562
  __originalResponseType: R;
2567
2563
  };
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>;
2574
2564
  declare function getEvent(): __PublicMethodMetaInfo$4<'GET', {
2575
2565
  eventId: string;
2576
2566
  }, GetEventRequest, GetEventRequest$1, GetEventResponse & GetEventResponseNonNullableFields, GetEventResponse$1 & GetEventResponseNonNullableFields$1>;
@@ -2592,6 +2582,12 @@ declare function cancelEvent(): __PublicMethodMetaInfo$4<'POST', {
2592
2582
  eventId: string;
2593
2583
  }, CancelEventRequest, CancelEventRequest$1, CancelEventResponse & CancelEventResponseNonNullableFields, CancelEventResponse$1 & CancelEventResponseNonNullableFields$1>;
2594
2584
  declare function bulkCancelEvent(): __PublicMethodMetaInfo$4<'POST', {}, BulkCancelEventRequest, BulkCancelEventRequest$1, BulkCancelEventResponse & BulkCancelEventResponseNonNullableFields, BulkCancelEventResponse$1 & BulkCancelEventResponseNonNullableFields$1>;
2585
+ declare function listEventsByContactId(): __PublicMethodMetaInfo$4<'GET', {
2586
+ contactId: string;
2587
+ }, ListEventsByContactIdRequest, ListEventsByContactIdRequest$1, ListEventsByContactIdResponse & ListEventsByContactIdResponseNonNullableFields, ListEventsByContactIdResponse$1 & ListEventsByContactIdResponseNonNullableFields$1>;
2588
+ declare function listEventsByMemberId(): __PublicMethodMetaInfo$4<'GET', {
2589
+ memberId: string;
2590
+ }, ListEventsByMemberIdRequest, ListEventsByMemberIdRequest$1, ListEventsByMemberIdResponse & ListEventsByMemberIdResponseNonNullableFields, ListEventsByMemberIdResponse$1 & ListEventsByMemberIdResponseNonNullableFields$1>;
2595
2591
 
2596
2592
  declare const meta$4_bulkCancelEvent: typeof bulkCancelEvent;
2597
2593
  declare const meta$4_bulkCreateEvent: typeof bulkCreateEvent;
@@ -2783,7 +2779,6 @@ interface Participant$1 {
2783
2779
  contactId?: string | null;
2784
2780
  }
2785
2781
  declare enum Status$5 {
2786
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
2787
2782
  /** The party's participation is confirmed. For example, the business owner has confirmed a [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings). */
2788
2783
  CONFIRMED = "CONFIRMED",
2789
2784
  /** The party's participation is awaiting confirmation. For example, the business owner still needs to approve the [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings). */
@@ -3015,7 +3010,6 @@ interface Participant {
3015
3010
  contactId?: string | null;
3016
3011
  }
3017
3012
  declare enum Status$4 {
3018
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
3019
3013
  /** The party's participation is confirmed. For example, the business owner has confirmed a [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings). */
3020
3014
  CONFIRMED = "CONFIRMED",
3021
3015
  /** The party's participation is awaiting confirmation. For example, the business owner still needs to approve the [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings). */