@wix/auto_sdk_sites_sites 1.0.13 → 1.0.14

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.
Files changed (134) hide show
  1. package/build/index.d.mts +27 -0
  2. package/build/index.d.ts +27 -0
  3. package/build/index.js +320 -0
  4. package/build/index.js.map +1 -0
  5. package/build/index.mjs +292 -0
  6. package/build/index.mjs.map +1 -0
  7. package/build/internal/index.d.mts +27 -0
  8. package/build/internal/index.d.ts +27 -0
  9. package/build/internal/index.js +320 -0
  10. package/build/internal/index.js.map +1 -0
  11. package/build/internal/index.mjs +292 -0
  12. package/build/internal/index.mjs.map +1 -0
  13. package/build/{es/src/site-list-v2-site-sites.types.d.ts → internal/meta.d.mts} +34 -17
  14. package/build/internal/{cjs/src/site-list-v2-site-sites.types.d.ts → meta.d.ts} +34 -17
  15. package/build/internal/meta.js +227 -0
  16. package/build/internal/meta.js.map +1 -0
  17. package/build/internal/meta.mjs +199 -0
  18. package/build/internal/meta.mjs.map +1 -0
  19. package/build/internal/site-list-v2-site-sites.universal-DMSHEe0v.d.mts +274 -0
  20. package/build/internal/site-list-v2-site-sites.universal-DMSHEe0v.d.ts +274 -0
  21. package/build/{internal/es/src/site-list-v2-site-sites.types.d.ts → meta.d.mts} +34 -17
  22. package/build/{cjs/src/site-list-v2-site-sites.types.d.ts → meta.d.ts} +34 -17
  23. package/build/meta.js +227 -0
  24. package/build/meta.js.map +1 -0
  25. package/build/meta.mjs +199 -0
  26. package/build/meta.mjs.map +1 -0
  27. package/build/site-list-v2-site-sites.universal-DMSHEe0v.d.mts +274 -0
  28. package/build/site-list-v2-site-sites.universal-DMSHEe0v.d.ts +274 -0
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/site-list-v2-site-sites.context.d.ts +0 -6
  40. package/build/cjs/src/site-list-v2-site-sites.context.js +0 -12
  41. package/build/cjs/src/site-list-v2-site-sites.context.js.map +0 -1
  42. package/build/cjs/src/site-list-v2-site-sites.http.d.ts +0 -13
  43. package/build/cjs/src/site-list-v2-site-sites.http.js +0 -171
  44. package/build/cjs/src/site-list-v2-site-sites.http.js.map +0 -1
  45. package/build/cjs/src/site-list-v2-site-sites.meta.d.ts +0 -14
  46. package/build/cjs/src/site-list-v2-site-sites.meta.js +0 -66
  47. package/build/cjs/src/site-list-v2-site-sites.meta.js.map +0 -1
  48. package/build/cjs/src/site-list-v2-site-sites.public.d.ts +0 -24
  49. package/build/cjs/src/site-list-v2-site-sites.public.js +0 -22
  50. package/build/cjs/src/site-list-v2-site-sites.public.js.map +0 -1
  51. package/build/cjs/src/site-list-v2-site-sites.types.js +0 -102
  52. package/build/cjs/src/site-list-v2-site-sites.types.js.map +0 -1
  53. package/build/cjs/src/site-list-v2-site-sites.universal.d.ts +0 -295
  54. package/build/cjs/src/site-list-v2-site-sites.universal.js +0 -192
  55. package/build/cjs/src/site-list-v2-site-sites.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/site-list-v2-site-sites.context.d.ts +0 -6
  67. package/build/es/src/site-list-v2-site-sites.context.js +0 -6
  68. package/build/es/src/site-list-v2-site-sites.context.js.map +0 -1
  69. package/build/es/src/site-list-v2-site-sites.http.d.ts +0 -13
  70. package/build/es/src/site-list-v2-site-sites.http.js +0 -166
  71. package/build/es/src/site-list-v2-site-sites.http.js.map +0 -1
  72. package/build/es/src/site-list-v2-site-sites.meta.d.ts +0 -14
  73. package/build/es/src/site-list-v2-site-sites.meta.js +0 -38
  74. package/build/es/src/site-list-v2-site-sites.meta.js.map +0 -1
  75. package/build/es/src/site-list-v2-site-sites.public.d.ts +0 -24
  76. package/build/es/src/site-list-v2-site-sites.public.js +0 -14
  77. package/build/es/src/site-list-v2-site-sites.public.js.map +0 -1
  78. package/build/es/src/site-list-v2-site-sites.types.js +0 -99
  79. package/build/es/src/site-list-v2-site-sites.types.js.map +0 -1
  80. package/build/es/src/site-list-v2-site-sites.universal.d.ts +0 -295
  81. package/build/es/src/site-list-v2-site-sites.universal.js +0 -164
  82. package/build/es/src/site-list-v2-site-sites.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/site-list-v2-site-sites.context.d.ts +0 -6
  93. package/build/internal/cjs/src/site-list-v2-site-sites.context.js +0 -12
  94. package/build/internal/cjs/src/site-list-v2-site-sites.context.js.map +0 -1
  95. package/build/internal/cjs/src/site-list-v2-site-sites.http.d.ts +0 -13
  96. package/build/internal/cjs/src/site-list-v2-site-sites.http.js +0 -171
  97. package/build/internal/cjs/src/site-list-v2-site-sites.http.js.map +0 -1
  98. package/build/internal/cjs/src/site-list-v2-site-sites.meta.d.ts +0 -14
  99. package/build/internal/cjs/src/site-list-v2-site-sites.meta.js +0 -66
  100. package/build/internal/cjs/src/site-list-v2-site-sites.meta.js.map +0 -1
  101. package/build/internal/cjs/src/site-list-v2-site-sites.public.d.ts +0 -24
  102. package/build/internal/cjs/src/site-list-v2-site-sites.public.js +0 -22
  103. package/build/internal/cjs/src/site-list-v2-site-sites.public.js.map +0 -1
  104. package/build/internal/cjs/src/site-list-v2-site-sites.types.js +0 -102
  105. package/build/internal/cjs/src/site-list-v2-site-sites.types.js.map +0 -1
  106. package/build/internal/cjs/src/site-list-v2-site-sites.universal.d.ts +0 -295
  107. package/build/internal/cjs/src/site-list-v2-site-sites.universal.js +0 -192
  108. package/build/internal/cjs/src/site-list-v2-site-sites.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/site-list-v2-site-sites.context.d.ts +0 -6
  119. package/build/internal/es/src/site-list-v2-site-sites.context.js +0 -6
  120. package/build/internal/es/src/site-list-v2-site-sites.context.js.map +0 -1
  121. package/build/internal/es/src/site-list-v2-site-sites.http.d.ts +0 -13
  122. package/build/internal/es/src/site-list-v2-site-sites.http.js +0 -166
  123. package/build/internal/es/src/site-list-v2-site-sites.http.js.map +0 -1
  124. package/build/internal/es/src/site-list-v2-site-sites.meta.d.ts +0 -14
  125. package/build/internal/es/src/site-list-v2-site-sites.meta.js +0 -38
  126. package/build/internal/es/src/site-list-v2-site-sites.meta.js.map +0 -1
  127. package/build/internal/es/src/site-list-v2-site-sites.public.d.ts +0 -24
  128. package/build/internal/es/src/site-list-v2-site-sites.public.js +0 -14
  129. package/build/internal/es/src/site-list-v2-site-sites.public.js.map +0 -1
  130. package/build/internal/es/src/site-list-v2-site-sites.types.js +0 -99
  131. package/build/internal/es/src/site-list-v2-site-sites.types.js.map +0 -1
  132. package/build/internal/es/src/site-list-v2-site-sites.universal.d.ts +0 -295
  133. package/build/internal/es/src/site-list-v2-site-sites.universal.js +0 -164
  134. package/build/internal/es/src/site-list-v2-site-sites.universal.js.map +0 -1
@@ -0,0 +1,274 @@
1
+ interface Site {
2
+ /**
3
+ * Site ID.
4
+ * @format GUID
5
+ */
6
+ _id?: string;
7
+ /**
8
+ * HTML app ID for the site.
9
+ * @format GUID
10
+ */
11
+ htmlAppId?: string | null;
12
+ /** Site name. Used in the site's URL. */
13
+ name?: string;
14
+ /** Site display name. Used for display purposes, such as in the browser's tab name. */
15
+ displayName?: string;
16
+ /** Site creation date. */
17
+ _createdDate?: Date | null;
18
+ /** Site updated date. */
19
+ _updatedDate?: Date | null;
20
+ /** Site trashed date. */
21
+ trashedDate?: Date | null;
22
+ /** Whether the site is published. */
23
+ published?: boolean;
24
+ /** Whether the site has a Wix Premium (paid) plan. */
25
+ premium?: boolean;
26
+ /** Live site URL. */
27
+ viewUrl?: string;
28
+ /** Editor site URL. */
29
+ editUrl?: string;
30
+ /** Site thumbnail. */
31
+ thumbnail?: string;
32
+ /**
33
+ * Site owner's account ID.
34
+ * @format GUID
35
+ */
36
+ ownerAccountId?: string;
37
+ /**
38
+ * Site contributors' account IDs.
39
+ * @format GUID
40
+ * @minSize 1
41
+ * @maxSize 1000
42
+ */
43
+ contributorAccountIds?: string[];
44
+ /** Site's Wix editor type. */
45
+ editorType?: EditorTypeWithLiterals;
46
+ /** Whether Wix has blocked this site due to legal issues. */
47
+ blocked?: boolean;
48
+ /**
49
+ * Folder ID that contains this site. Empty if site is at root level.
50
+ * @format GUID
51
+ */
52
+ folderId?: string | null;
53
+ /** Namespace of the site, for internal use. */
54
+ namespace?: NamespaceWithLiterals;
55
+ /** Whether the site has a connected domain. */
56
+ domainConnected?: boolean;
57
+ }
58
+ declare enum EditorType {
59
+ UNKNOWN = "UNKNOWN",
60
+ EDITOR = "EDITOR",
61
+ ADI = "ADI",
62
+ EDITORX = "EDITORX",
63
+ STUDIO = "STUDIO",
64
+ ODEDITOR = "ODEDITOR",
65
+ PICASSO = "PICASSO"
66
+ }
67
+ /** @enumType */
68
+ type EditorTypeWithLiterals = EditorType | 'UNKNOWN' | 'EDITOR' | 'ADI' | 'EDITORX' | 'STUDIO' | 'ODEDITOR' | 'PICASSO';
69
+ declare enum Namespace {
70
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
71
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
72
+ WIX = "WIX",
73
+ /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
74
+ SHOUT_OUT = "SHOUT_OUT",
75
+ /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
76
+ ALBUMS = "ALBUMS",
77
+ /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
78
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
79
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
80
+ HOTELS = "HOTELS",
81
+ /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
82
+ CLUBS = "CLUBS",
83
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
84
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
85
+ /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
86
+ DEV_SITE = "DEV_SITE",
87
+ /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
88
+ LOGOS = "LOGOS",
89
+ /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
90
+ VIDEO_MAKER = "VIDEO_MAKER",
91
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
92
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
93
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
94
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
95
+ /**
96
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
97
+ *
98
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
99
+ */
100
+ HTML_DRAFT = "HTML_DRAFT",
101
+ /**
102
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
103
+ * Will be accessible from Site List and will not have a website app.
104
+ * Once the user attaches a site, the site will become a regular wixsite.
105
+ */
106
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
107
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
108
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
109
+ /** It is to be used in the Business First efforts. */
110
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
111
+ /** Bookings business flow with no site. */
112
+ ANYWHERE = "ANYWHERE",
113
+ /** Namespace for Headless Backoffice with no editor */
114
+ HEADLESS = "HEADLESS",
115
+ /**
116
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
117
+ * The site will be used for account level CSM feature for enterprise
118
+ */
119
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
120
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
121
+ RISE = "RISE",
122
+ /**
123
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
124
+ * There's a blank site behind the scene but it's blank).
125
+ * The Mobile company will be the owner of this namespace.
126
+ */
127
+ BRANDED_FIRST = "BRANDED_FIRST",
128
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
129
+ NOWNIA = "NOWNIA",
130
+ /**
131
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
132
+ * The Partners company owns this namespace.
133
+ */
134
+ UGC_TEMPLATE = "UGC_TEMPLATE",
135
+ /** Codux Headless Sites */
136
+ CODUX = "CODUX",
137
+ /** Bobb - AI Design Creator. */
138
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
139
+ /**
140
+ * Shared Blog Site is a unique single site across Enterprise account,
141
+ * This site will hold all Blog posts related to the Marketing product.
142
+ */
143
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
144
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
145
+ STANDALONE_FORMS = "STANDALONE_FORMS",
146
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
147
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
148
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
149
+ MIMIR = "MIMIR"
150
+ }
151
+ /** @enumType */
152
+ type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
153
+ interface QuerySitesRequest {
154
+ /**
155
+ * Filter and sorting with the following format:
156
+ * `"filter" : { "displayName": "my-site" }`
157
+ */
158
+ query?: QueryV2;
159
+ }
160
+ interface QueryV2 extends QueryV2PagingMethodOneOf {
161
+ /**
162
+ * Paging options to limit and offset the number of items.
163
+ * wix.common.Paging paging = 3;
164
+ * Cursor token pointing to a page of results. Used in all calls following the first request.
165
+ */
166
+ cursorPaging?: CursorPaging;
167
+ /**
168
+ * Filter object with the following format:
169
+ * `"filter" : {
170
+ * "displayName": "my-site",
171
+ * "namespace":{"$in":["value1", "value2"]},
172
+ * "folderId": {"$exists": false}
173
+ * }`
174
+ * Example of operators: `$in`, `$hasSome`, `$hasAll`, `$exists`
175
+ */
176
+ filter?: Record<string, any> | null;
177
+ /**
178
+ * Sort object with the following format:
179
+ * `[{"fieldName":"displayName","order":"ASC"},{"fieldName":"createdDate","order":"DESC"}]`
180
+ * @maxSize 4
181
+ */
182
+ sort?: Sorting[];
183
+ }
184
+ /** @oneof */
185
+ interface QueryV2PagingMethodOneOf {
186
+ /**
187
+ * Paging options to limit and offset the number of items.
188
+ * wix.common.Paging paging = 3;
189
+ * Cursor token pointing to a page of results. Used in all calls following the first request.
190
+ */
191
+ cursorPaging?: CursorPaging;
192
+ }
193
+ interface Sorting {
194
+ /**
195
+ * Name of the field to sort by.
196
+ * @maxLength 512
197
+ */
198
+ fieldName?: string;
199
+ /** Sort order. */
200
+ order?: SortOrderWithLiterals;
201
+ }
202
+ declare enum SortOrder {
203
+ ASC = "ASC",
204
+ DESC = "DESC"
205
+ }
206
+ /** @enumType */
207
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
208
+ interface CursorPaging {
209
+ /**
210
+ * Maximum number of items to return in the results.
211
+ * @max 100
212
+ */
213
+ limit?: number | null;
214
+ /**
215
+ * Pointer to the next or previous page in the list of results.
216
+ *
217
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
218
+ * Not relevant for the first request.
219
+ * @maxLength 16000
220
+ */
221
+ cursor?: string | null;
222
+ }
223
+ interface QuerySitesResponse {
224
+ /** List of retrieved sites. */
225
+ sites?: Site[];
226
+ /**
227
+ * Paging information.
228
+ * @deprecated
229
+ */
230
+ cursorPaging?: CursorPaging;
231
+ /** Meta data about the returned sites */
232
+ metadata?: PagingMetadataV2;
233
+ }
234
+ interface PagingMetadataV2 {
235
+ /** Number of items returned in the response. */
236
+ count?: number | null;
237
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
238
+ cursors?: Cursors;
239
+ }
240
+ interface Cursors {
241
+ /** Cursor pointing to next page in the list of results. */
242
+ next?: string | null;
243
+ }
244
+ interface CountSitesRequest {
245
+ /**
246
+ * Filter object. See [Filter and Sort](https://dev.wix.com/api/rest/account-level-apis/sites/filter-&-sort) documentation.
247
+ * Note: the `premium` and `appIds` filters are not supported in this endpoint.
248
+ */
249
+ filter?: Record<string, any> | null;
250
+ }
251
+ interface CountSitesResponse {
252
+ /**
253
+ * Number of sites retrieved basd on the filter.
254
+ * Free Wix accounts are limited to max 1,000 sites.
255
+ * Premium accounts can have an unlimited number of sites.
256
+ */
257
+ count?: number;
258
+ }
259
+ interface QuerySitesOptions {
260
+ /**
261
+ * Filter and sorting with the following format:
262
+ * `"filter" : { "displayName": "my-site" }`
263
+ */
264
+ query?: QueryV2;
265
+ }
266
+ interface CountSitesOptions {
267
+ /**
268
+ * Filter object. See [Filter and Sort](https://dev.wix.com/api/rest/account-level-apis/sites/filter-&-sort) documentation.
269
+ * Note: the `premium` and `appIds` filters are not supported in this endpoint.
270
+ */
271
+ filter?: Record<string, any> | null;
272
+ }
273
+
274
+ export { type CountSitesOptions as C, EditorType as E, Namespace as N, type PagingMetadataV2 as P, type QuerySitesOptions as Q, SortOrder as S, type QuerySitesResponse as a, type CountSitesResponse as b, type Site as c, type QuerySitesRequest as d, type QueryV2 as e, type QueryV2PagingMethodOneOf as f, type Sorting as g, type CursorPaging as h, type Cursors as i, type CountSitesRequest as j };
@@ -0,0 +1,274 @@
1
+ interface Site {
2
+ /**
3
+ * Site ID.
4
+ * @format GUID
5
+ */
6
+ _id?: string;
7
+ /**
8
+ * HTML app ID for the site.
9
+ * @format GUID
10
+ */
11
+ htmlAppId?: string | null;
12
+ /** Site name. Used in the site's URL. */
13
+ name?: string;
14
+ /** Site display name. Used for display purposes, such as in the browser's tab name. */
15
+ displayName?: string;
16
+ /** Site creation date. */
17
+ _createdDate?: Date | null;
18
+ /** Site updated date. */
19
+ _updatedDate?: Date | null;
20
+ /** Site trashed date. */
21
+ trashedDate?: Date | null;
22
+ /** Whether the site is published. */
23
+ published?: boolean;
24
+ /** Whether the site has a Wix Premium (paid) plan. */
25
+ premium?: boolean;
26
+ /** Live site URL. */
27
+ viewUrl?: string;
28
+ /** Editor site URL. */
29
+ editUrl?: string;
30
+ /** Site thumbnail. */
31
+ thumbnail?: string;
32
+ /**
33
+ * Site owner's account ID.
34
+ * @format GUID
35
+ */
36
+ ownerAccountId?: string;
37
+ /**
38
+ * Site contributors' account IDs.
39
+ * @format GUID
40
+ * @minSize 1
41
+ * @maxSize 1000
42
+ */
43
+ contributorAccountIds?: string[];
44
+ /** Site's Wix editor type. */
45
+ editorType?: EditorTypeWithLiterals;
46
+ /** Whether Wix has blocked this site due to legal issues. */
47
+ blocked?: boolean;
48
+ /**
49
+ * Folder ID that contains this site. Empty if site is at root level.
50
+ * @format GUID
51
+ */
52
+ folderId?: string | null;
53
+ /** Namespace of the site, for internal use. */
54
+ namespace?: NamespaceWithLiterals;
55
+ /** Whether the site has a connected domain. */
56
+ domainConnected?: boolean;
57
+ }
58
+ declare enum EditorType {
59
+ UNKNOWN = "UNKNOWN",
60
+ EDITOR = "EDITOR",
61
+ ADI = "ADI",
62
+ EDITORX = "EDITORX",
63
+ STUDIO = "STUDIO",
64
+ ODEDITOR = "ODEDITOR",
65
+ PICASSO = "PICASSO"
66
+ }
67
+ /** @enumType */
68
+ type EditorTypeWithLiterals = EditorType | 'UNKNOWN' | 'EDITOR' | 'ADI' | 'EDITORX' | 'STUDIO' | 'ODEDITOR' | 'PICASSO';
69
+ declare enum Namespace {
70
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
71
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
72
+ WIX = "WIX",
73
+ /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
74
+ SHOUT_OUT = "SHOUT_OUT",
75
+ /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
76
+ ALBUMS = "ALBUMS",
77
+ /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
78
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
79
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
80
+ HOTELS = "HOTELS",
81
+ /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
82
+ CLUBS = "CLUBS",
83
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
84
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
85
+ /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
86
+ DEV_SITE = "DEV_SITE",
87
+ /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
88
+ LOGOS = "LOGOS",
89
+ /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
90
+ VIDEO_MAKER = "VIDEO_MAKER",
91
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
92
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
93
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
94
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
95
+ /**
96
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
97
+ *
98
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
99
+ */
100
+ HTML_DRAFT = "HTML_DRAFT",
101
+ /**
102
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
103
+ * Will be accessible from Site List and will not have a website app.
104
+ * Once the user attaches a site, the site will become a regular wixsite.
105
+ */
106
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
107
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
108
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
109
+ /** It is to be used in the Business First efforts. */
110
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
111
+ /** Bookings business flow with no site. */
112
+ ANYWHERE = "ANYWHERE",
113
+ /** Namespace for Headless Backoffice with no editor */
114
+ HEADLESS = "HEADLESS",
115
+ /**
116
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
117
+ * The site will be used for account level CSM feature for enterprise
118
+ */
119
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
120
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
121
+ RISE = "RISE",
122
+ /**
123
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
124
+ * There's a blank site behind the scene but it's blank).
125
+ * The Mobile company will be the owner of this namespace.
126
+ */
127
+ BRANDED_FIRST = "BRANDED_FIRST",
128
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
129
+ NOWNIA = "NOWNIA",
130
+ /**
131
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
132
+ * The Partners company owns this namespace.
133
+ */
134
+ UGC_TEMPLATE = "UGC_TEMPLATE",
135
+ /** Codux Headless Sites */
136
+ CODUX = "CODUX",
137
+ /** Bobb - AI Design Creator. */
138
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
139
+ /**
140
+ * Shared Blog Site is a unique single site across Enterprise account,
141
+ * This site will hold all Blog posts related to the Marketing product.
142
+ */
143
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
144
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
145
+ STANDALONE_FORMS = "STANDALONE_FORMS",
146
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
147
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
148
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
149
+ MIMIR = "MIMIR"
150
+ }
151
+ /** @enumType */
152
+ type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
153
+ interface QuerySitesRequest {
154
+ /**
155
+ * Filter and sorting with the following format:
156
+ * `"filter" : { "displayName": "my-site" }`
157
+ */
158
+ query?: QueryV2;
159
+ }
160
+ interface QueryV2 extends QueryV2PagingMethodOneOf {
161
+ /**
162
+ * Paging options to limit and offset the number of items.
163
+ * wix.common.Paging paging = 3;
164
+ * Cursor token pointing to a page of results. Used in all calls following the first request.
165
+ */
166
+ cursorPaging?: CursorPaging;
167
+ /**
168
+ * Filter object with the following format:
169
+ * `"filter" : {
170
+ * "displayName": "my-site",
171
+ * "namespace":{"$in":["value1", "value2"]},
172
+ * "folderId": {"$exists": false}
173
+ * }`
174
+ * Example of operators: `$in`, `$hasSome`, `$hasAll`, `$exists`
175
+ */
176
+ filter?: Record<string, any> | null;
177
+ /**
178
+ * Sort object with the following format:
179
+ * `[{"fieldName":"displayName","order":"ASC"},{"fieldName":"createdDate","order":"DESC"}]`
180
+ * @maxSize 4
181
+ */
182
+ sort?: Sorting[];
183
+ }
184
+ /** @oneof */
185
+ interface QueryV2PagingMethodOneOf {
186
+ /**
187
+ * Paging options to limit and offset the number of items.
188
+ * wix.common.Paging paging = 3;
189
+ * Cursor token pointing to a page of results. Used in all calls following the first request.
190
+ */
191
+ cursorPaging?: CursorPaging;
192
+ }
193
+ interface Sorting {
194
+ /**
195
+ * Name of the field to sort by.
196
+ * @maxLength 512
197
+ */
198
+ fieldName?: string;
199
+ /** Sort order. */
200
+ order?: SortOrderWithLiterals;
201
+ }
202
+ declare enum SortOrder {
203
+ ASC = "ASC",
204
+ DESC = "DESC"
205
+ }
206
+ /** @enumType */
207
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
208
+ interface CursorPaging {
209
+ /**
210
+ * Maximum number of items to return in the results.
211
+ * @max 100
212
+ */
213
+ limit?: number | null;
214
+ /**
215
+ * Pointer to the next or previous page in the list of results.
216
+ *
217
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
218
+ * Not relevant for the first request.
219
+ * @maxLength 16000
220
+ */
221
+ cursor?: string | null;
222
+ }
223
+ interface QuerySitesResponse {
224
+ /** List of retrieved sites. */
225
+ sites?: Site[];
226
+ /**
227
+ * Paging information.
228
+ * @deprecated
229
+ */
230
+ cursorPaging?: CursorPaging;
231
+ /** Meta data about the returned sites */
232
+ metadata?: PagingMetadataV2;
233
+ }
234
+ interface PagingMetadataV2 {
235
+ /** Number of items returned in the response. */
236
+ count?: number | null;
237
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
238
+ cursors?: Cursors;
239
+ }
240
+ interface Cursors {
241
+ /** Cursor pointing to next page in the list of results. */
242
+ next?: string | null;
243
+ }
244
+ interface CountSitesRequest {
245
+ /**
246
+ * Filter object. See [Filter and Sort](https://dev.wix.com/api/rest/account-level-apis/sites/filter-&-sort) documentation.
247
+ * Note: the `premium` and `appIds` filters are not supported in this endpoint.
248
+ */
249
+ filter?: Record<string, any> | null;
250
+ }
251
+ interface CountSitesResponse {
252
+ /**
253
+ * Number of sites retrieved basd on the filter.
254
+ * Free Wix accounts are limited to max 1,000 sites.
255
+ * Premium accounts can have an unlimited number of sites.
256
+ */
257
+ count?: number;
258
+ }
259
+ interface QuerySitesOptions {
260
+ /**
261
+ * Filter and sorting with the following format:
262
+ * `"filter" : { "displayName": "my-site" }`
263
+ */
264
+ query?: QueryV2;
265
+ }
266
+ interface CountSitesOptions {
267
+ /**
268
+ * Filter object. See [Filter and Sort](https://dev.wix.com/api/rest/account-level-apis/sites/filter-&-sort) documentation.
269
+ * Note: the `premium` and `appIds` filters are not supported in this endpoint.
270
+ */
271
+ filter?: Record<string, any> | null;
272
+ }
273
+
274
+ export { type CountSitesOptions as C, EditorType as E, Namespace as N, type PagingMetadataV2 as P, type QuerySitesOptions as Q, SortOrder as S, type QuerySitesResponse as a, type CountSitesResponse as b, type Site as c, type QuerySitesRequest as d, type QueryV2 as e, type QueryV2PagingMethodOneOf as f, type Sorting as g, type CursorPaging as h, type Cursors as i, type CountSitesRequest as j };
package/package.json CHANGED
@@ -1,25 +1,25 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_sites_sites",
3
- "version": "1.0.13",
3
+ "version": "1.0.14",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
7
7
  },
8
8
  "keywords": [],
9
9
  "sideEffects": false,
10
- "main": "./build/cjs/index.js",
11
- "types": "./build/es/index.d.ts",
10
+ "main": "/build/index.js",
11
+ "types": "./build/index.d.mts",
12
12
  "exports": {
13
13
  ".": {
14
- "import": "./build/es/index.js",
15
- "require": "./build/cjs/index.js",
16
- "types": "./build/es/index.d.ts"
14
+ "import": "./build/index.mjs",
15
+ "require": "./build/index.js",
16
+ "types": "./build/index.d.mts"
17
17
  },
18
18
  "./package.json": "./package.json",
19
19
  "./meta": {
20
- "import": "./build/es/meta.js",
21
- "require": "./build/cjs/meta.js",
22
- "types": "./build/es/meta.d.ts"
20
+ "import": "./build/meta.mjs",
21
+ "require": "./build/meta.js",
22
+ "types": "./build/meta.d.mts"
23
23
  }
24
24
  },
25
25
  "files": [
@@ -32,10 +32,11 @@
32
32
  "@wix/sdk-types": "^1.13.28"
33
33
  },
34
34
  "devDependencies": {
35
+ "tsup": "^8.4.0",
35
36
  "typescript": "^5.3.2"
36
37
  },
37
38
  "scripts": {
38
- "build": "tsc -b tsconfig.json tsconfig.esm.json tsconfig.internal.json tsconfig.internal.esm.json",
39
+ "build": "tsup",
39
40
  "test": ":"
40
41
  },
41
42
  "wix": {
@@ -48,5 +49,5 @@
48
49
  "fqdn": "wix.site_list.v2.site"
49
50
  }
50
51
  },
51
- "falconPackageHash": "c8ff41c8ba929c802cbeb5fdb83857dad393cf9d5caf53e6422e22cf"
52
+ "falconPackageHash": "f49fa91e737bd3469945bf208dacf7c5cd101c9317b78c9d4023a8f9"
52
53
  }
@@ -1 +0,0 @@
1
- export * from './src/site-list-v2-site-sites.context.js';
@@ -1,18 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./src/site-list-v2-site-sites.context.js"), exports);
18
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2EAAyD"}
@@ -1 +0,0 @@
1
- export * from './src/site-list-v2-site-sites.universal.js';
@@ -1,18 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./src/site-list-v2-site-sites.universal.js"), exports);
18
- //# sourceMappingURL=index.typings.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.typings.js","sourceRoot":"","sources":["../../index.typings.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6EAA2D"}
@@ -1 +0,0 @@
1
- export * from './src/site-list-v2-site-sites.meta.js';