@wix/auto_sdk_online-programs_programs 1.0.22 → 1.0.24

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 (49) hide show
  1. package/build/cjs/index.d.ts +2 -2
  2. package/build/cjs/index.js +2 -0
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +2 -2
  5. package/build/cjs/index.typings.js +2 -0
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +10 -2
  8. package/build/cjs/meta.js +2 -0
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/{online-programs-v3-program-programs.universal-D4WCMJwS.d.ts → online-programs-v3-program-programs.universal-Dhl-xcJf.d.ts} +10 -2
  11. package/build/cjs/schemas.js +14 -14
  12. package/build/cjs/schemas.js.map +1 -1
  13. package/build/es/index.d.mts +2 -2
  14. package/build/es/index.mjs +2 -0
  15. package/build/es/index.mjs.map +1 -1
  16. package/build/es/index.typings.d.mts +2 -2
  17. package/build/es/index.typings.mjs +2 -0
  18. package/build/es/index.typings.mjs.map +1 -1
  19. package/build/es/meta.d.mts +10 -2
  20. package/build/es/meta.mjs +2 -0
  21. package/build/es/meta.mjs.map +1 -1
  22. package/build/es/{online-programs-v3-program-programs.universal-D4WCMJwS.d.mts → online-programs-v3-program-programs.universal-Dhl-xcJf.d.mts} +10 -2
  23. package/build/es/schemas.mjs +14 -14
  24. package/build/es/schemas.mjs.map +1 -1
  25. package/build/internal/cjs/index.d.ts +2 -2
  26. package/build/internal/cjs/index.js +2 -0
  27. package/build/internal/cjs/index.js.map +1 -1
  28. package/build/internal/cjs/index.typings.d.ts +2 -2
  29. package/build/internal/cjs/index.typings.js +2 -0
  30. package/build/internal/cjs/index.typings.js.map +1 -1
  31. package/build/internal/cjs/meta.d.ts +228 -3
  32. package/build/internal/cjs/meta.js +2 -0
  33. package/build/internal/cjs/meta.js.map +1 -1
  34. package/build/internal/cjs/{online-programs-v3-program-programs.universal-D4WCMJwS.d.ts → online-programs-v3-program-programs.universal-04Z8vH4Y.d.ts} +142 -3
  35. package/build/internal/cjs/schemas.js +14 -14
  36. package/build/internal/cjs/schemas.js.map +1 -1
  37. package/build/internal/es/index.d.mts +2 -2
  38. package/build/internal/es/index.mjs +2 -0
  39. package/build/internal/es/index.mjs.map +1 -1
  40. package/build/internal/es/index.typings.d.mts +2 -2
  41. package/build/internal/es/index.typings.mjs +2 -0
  42. package/build/internal/es/index.typings.mjs.map +1 -1
  43. package/build/internal/es/meta.d.mts +228 -3
  44. package/build/internal/es/meta.mjs +2 -0
  45. package/build/internal/es/meta.mjs.map +1 -1
  46. package/build/internal/es/{online-programs-v3-program-programs.universal-D4WCMJwS.d.mts → online-programs-v3-program-programs.universal-04Z8vH4Y.d.mts} +142 -3
  47. package/build/internal/es/schemas.mjs +14 -14
  48. package/build/internal/es/schemas.mjs.map +1 -1
  49. package/package.json +4 -4
@@ -1,4 +1,4 @@
1
- import { ax as CreateProgramRequest$1, ay as CreateProgramResponse$1, aI as DuplicateProgramRequest$1, D as DuplicateProgramResponse$1, aJ as GetProgramRequest$1, aK as GetProgramResponse$1, aL as UpdateProgramRequest$1, aM as UpdateProgramResponse$1, aS as DeleteProgramRequest$1, aT as DeleteProgramResponse$1, aU as QueryProgramsRequest$1, a_ as QueryProgramsResponse$1, b1 as SearchProgramsRequest$1, S as SearchProgramsResponse$1, bF as PublishProgramRequest$1, c as PublishProgramResponse$1, bG as EndProgramRequest$1, E as EndProgramResponse$1, bH as ArchiveProgramRequest$1, A as ArchiveProgramResponse$1, bI as BulkUpdateProgramsRequest$1, e as BulkUpdateProgramsResponse$1, bK as CountProgramsRequest$1, f as CountProgramsResponse$1, bL as ListSampleProgramsRequest$1, L as ListSampleProgramsResponse$1 } from './online-programs-v3-program-programs.universal-D4WCMJwS.js';
1
+ import { ax as CreateProgramRequest$1, ay as CreateProgramResponse$1, aI as DuplicateProgramRequest$1, D as DuplicateProgramResponse$1, aJ as GetProgramRequest$1, aK as GetProgramResponse$1, aL as UpdateProgramRequest$1, aM as UpdateProgramResponse$1, aS as DeleteProgramRequest$1, aT as DeleteProgramResponse$1, aU as QueryProgramsRequest$1, a_ as QueryProgramsResponse$1, b1 as SearchProgramsRequest$1, S as SearchProgramsResponse$1, bF as PublishProgramRequest$1, c as PublishProgramResponse$1, bG as EndProgramRequest$1, E as EndProgramResponse$1, bH as ArchiveProgramRequest$1, A as ArchiveProgramResponse$1, bI as BulkUpdateProgramsRequest$1, e as BulkUpdateProgramsResponse$1, bK as CountProgramsRequest$1, f as CountProgramsResponse$1, bL as ListSampleProgramsRequest$1, L as ListSampleProgramsResponse$1 } from './online-programs-v3-program-programs.universal-04Z8vH4Y.js';
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  /**
@@ -136,11 +136,29 @@ interface Image {
136
136
  width?: number;
137
137
  /** Image alt text. */
138
138
  altText?: string | null;
139
+ /**
140
+ * Image URL expiration date (when relevant).
141
+ * @internal
142
+ * @readonly
143
+ */
144
+ urlExpirationDate?: Date | null;
139
145
  /**
140
146
  * Image filename.
141
147
  * @readonly
142
148
  */
143
149
  filename?: string | null;
150
+ /**
151
+ * Image size in bytes.
152
+ * @internal
153
+ * @readonly
154
+ * @format DECIMAL_VALUE
155
+ */
156
+ sizeInBytes?: string | null;
157
+ /**
158
+ * Focal point of the image.
159
+ * @internal
160
+ */
161
+ focalPoint?: FocalPoint;
144
162
  }
145
163
  interface FocalPoint {
146
164
  /** X-coordinate of the focal point. */
@@ -155,6 +173,11 @@ interface FocalPoint {
155
173
  interface VideoV2 {
156
174
  /** WixMedia ID. */
157
175
  id?: string;
176
+ /**
177
+ * Original video URL.
178
+ * @internal
179
+ */
180
+ url?: string;
158
181
  /**
159
182
  * Available resolutions for the video, starting with the optimal resolution.
160
183
  * @readonly
@@ -166,6 +189,55 @@ interface VideoV2 {
166
189
  * @readonly
167
190
  */
168
191
  filename?: string | null;
192
+ /**
193
+ * Video posters.
194
+ * @internal
195
+ * @readonly
196
+ */
197
+ posters?: Image[];
198
+ /**
199
+ * Original video size in bytes.
200
+ * @internal
201
+ * @readonly
202
+ * @format DECIMAL_VALUE
203
+ */
204
+ sizeInBytes?: string | null;
205
+ /**
206
+ * Video URL expiration date (when relevant).
207
+ * @internal
208
+ * @readonly
209
+ */
210
+ urlExpirationDate?: Date | null;
211
+ /**
212
+ * Original video duration in milliseconds.
213
+ * @internal
214
+ * @readonly
215
+ */
216
+ durationInMilliseconds?: number | null;
217
+ /**
218
+ * A short title for the video. will be used for SEO purposes.
219
+ * @internal
220
+ * @maxLength 300
221
+ */
222
+ title?: string | null;
223
+ /**
224
+ * A long description for the video. will be used for SEO purposes.
225
+ * @internal
226
+ * @maxLength 2000
227
+ */
228
+ description?: string | null;
229
+ /**
230
+ * Original video height.
231
+ * @internal
232
+ * @readonly
233
+ */
234
+ height?: number | null;
235
+ /**
236
+ * Original video width.
237
+ * @internal
238
+ * @readonly
239
+ */
240
+ width?: number | null;
169
241
  }
170
242
  interface VideoResolution {
171
243
  /** Video URL. */
@@ -174,8 +246,68 @@ interface VideoResolution {
174
246
  height?: number;
175
247
  /** Video width. */
176
248
  width?: number;
249
+ /**
250
+ * Deprecated. Use the `posters` property in the parent entity instead.
251
+ * @internal
252
+ * @deprecated
253
+ */
254
+ poster?: Image;
177
255
  /** Video format for example, mp4, hls. */
178
256
  format?: string;
257
+ /**
258
+ * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
259
+ * @internal
260
+ * @deprecated
261
+ */
262
+ urlExpirationDate?: Date | null;
263
+ /**
264
+ * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
265
+ * @internal
266
+ * @format DECIMAL_VALUE
267
+ * @deprecated
268
+ */
269
+ sizeInBytes?: string | null;
270
+ /**
271
+ * Video quality. For example: 480p, 720p.
272
+ * @internal
273
+ */
274
+ quality?: string | null;
275
+ /**
276
+ * Video filename.
277
+ * @internal
278
+ */
279
+ filename?: string | null;
280
+ /**
281
+ * Video duration in seconds.
282
+ * @internal
283
+ * @readonly
284
+ * @deprecated Video duration in seconds.
285
+ * @replacedBy duration_in_milliseconds
286
+ * @targetRemovalDate 2024-08-01
287
+ */
288
+ durationInSeconds?: number | null;
289
+ /**
290
+ * Video duration in milliseconds.
291
+ * @internal
292
+ * @readonly
293
+ */
294
+ durationInMilliseconds?: number | null;
295
+ /**
296
+ * When true, this is a protected asset, and calling the URL will return a 403 error.
297
+ * In order to access private assets, make a request to:
298
+ * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
299
+ * @internal
300
+ * @readonly
301
+ */
302
+ private?: boolean | null;
303
+ /**
304
+ * Key to identify the video resolution's relationship to the original media in WixMedia.
305
+ * Can be used to request a download for the specific video resolution.
306
+ * For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
307
+ * @internal
308
+ * @readonly
309
+ */
310
+ assetKey?: string | null;
179
311
  }
180
312
  /** Program scheduling settings. */
181
313
  interface Timeline {
@@ -302,7 +434,15 @@ interface Tag {
302
434
  meta?: Record<string, any> | null;
303
435
  /** SEO tag inner content. For example, `<title> inner content </title>`. */
304
436
  children?: string;
305
- /** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
437
+ /**
438
+ * Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).
439
+ *
440
+ * Limitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read
441
+ * only from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor
442
+ * or Wix Studio pages, so custom tags saved on those pages are missing from the response entirely. For
443
+ * those pages `false` therefore does not mean "not a custom tag" — it means this API could not tell.
444
+ * Pass `seoData` explicitly to resolve against a known set of tags.
445
+ */
306
446
  custom?: boolean;
307
447
  /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
308
448
  disabled?: boolean;
@@ -817,6 +957,11 @@ interface GetProgramResponse {
817
957
  interface UpdateProgramRequest {
818
958
  /** Program fields to update. Include `id` and the latest `revision`. */
819
959
  program: Program;
960
+ /**
961
+ * The list of fields to update. For REST requests, this list is inferred from the request body.
962
+ * @internal
963
+ */
964
+ fieldMask?: string[];
820
965
  }
821
966
  interface UpdateProgramResponse {
822
967
  /** Updated program. */
@@ -893,6 +1038,20 @@ interface Sorting {
893
1038
  fieldName?: string;
894
1039
  /** Sort order. */
895
1040
  order?: SortOrderWithLiterals;
1041
+ /**
1042
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
1043
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
1044
+ *
1045
+ * If multiple filters are provided, they are combined with AND operator.
1046
+ *
1047
+ * Example:
1048
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
1049
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
1050
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
1051
+ * @internal
1052
+ * @maxSize 10
1053
+ */
1054
+ selectItemsBy?: Record<string, any>[] | null;
896
1055
  }
897
1056
  declare enum SortOrder {
898
1057
  ASC = "ASC",
@@ -937,6 +1096,13 @@ interface PagingMetadataV2 {
937
1096
  tooManyToCount?: boolean | null;
938
1097
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
939
1098
  cursors?: Cursors;
1099
+ /**
1100
+ * Indicates if there are more results after the current page.
1101
+ * If `true`, another page of results can be retrieved.
1102
+ * If `false`, this is the last page.
1103
+ * @internal
1104
+ */
1105
+ hasNext?: boolean | null;
940
1106
  }
941
1107
  interface Cursors {
942
1108
  /**
@@ -1089,7 +1255,17 @@ declare enum ScalarType {
1089
1255
  /** Minimum value. */
1090
1256
  MIN = "MIN",
1091
1257
  /** Maximum value. */
1092
- MAX = "MAX"
1258
+ MAX = "MAX",
1259
+ /**
1260
+ * Sum of values.
1261
+ * @internal
1262
+ */
1263
+ SUM = "SUM",
1264
+ /**
1265
+ * Average of values.
1266
+ * @internal
1267
+ */
1268
+ AVG = "AVG"
1093
1269
  }
1094
1270
  /** @enumType */
1095
1271
  type ScalarTypeWithLiterals = ScalarType | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
@@ -1275,6 +1451,13 @@ interface CursorPagingMetadata {
1275
1451
  * + `false`: This is the last page.
1276
1452
  */
1277
1453
  hasNext?: boolean | null;
1454
+ /**
1455
+ * Total number of items matching the filter.
1456
+ * Available only on the first page of *Search* results, not included in *Query* or *List* results.
1457
+ * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.
1458
+ * @internal
1459
+ */
1460
+ total?: number | null;
1278
1461
  }
1279
1462
  interface AggregationData {
1280
1463
  /**
@@ -1613,8 +1796,18 @@ interface DomainEventBodyOneOf {
1613
1796
  }
1614
1797
  interface EntityCreatedEvent {
1615
1798
  entityAsJson?: string;
1799
+ /**
1800
+ * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
1801
+ * @internal
1802
+ */
1803
+ triggeredByUndelete?: boolean | null;
1616
1804
  /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
1617
1805
  restoreInfo?: RestoreInfo;
1806
+ /**
1807
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
1808
+ * @internal
1809
+ */
1810
+ additionalMetadataAsJson?: string | null;
1618
1811
  }
1619
1812
  interface RestoreInfo {
1620
1813
  deletedDate?: Date | null;
@@ -1626,10 +1819,42 @@ interface EntityUpdatedEvent {
1626
1819
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1627
1820
  */
1628
1821
  currentEntityAsJson?: string;
1822
+ /**
1823
+ * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
1824
+ * wont populate it / have any reference to it in the API.
1825
+ * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
1826
+ * the developer should send only the new (current) entity.
1827
+ * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
1828
+ * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
1829
+ * @internal
1830
+ * @deprecated
1831
+ */
1832
+ previousEntityAsJson?: string | null;
1833
+ /**
1834
+ * Map of fully qualified field paths to their previous values for fields that changed.
1835
+ * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
1836
+ * @internal
1837
+ */
1838
+ modifiedFields?: Record<string, any>;
1839
+ /**
1840
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
1841
+ * @internal
1842
+ */
1843
+ additionalMetadataAsJson?: string | null;
1629
1844
  }
1630
1845
  interface EntityDeletedEvent {
1846
+ /**
1847
+ * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
1848
+ * @internal
1849
+ */
1850
+ movedToTrash?: boolean | null;
1631
1851
  /** Entity that was deleted. */
1632
1852
  deletedEntityAsJson?: string | null;
1853
+ /**
1854
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
1855
+ * @internal
1856
+ */
1857
+ additionalMetadataAsJson?: string | null;
1633
1858
  }
1634
1859
  interface ActionEvent {
1635
1860
  bodyAsJson?: string;
@@ -1020,6 +1020,8 @@ var ScalarType = /* @__PURE__ */ ((ScalarType2) => {
1020
1020
  ScalarType2["COUNT_DISTINCT"] = "COUNT_DISTINCT";
1021
1021
  ScalarType2["MIN"] = "MIN";
1022
1022
  ScalarType2["MAX"] = "MAX";
1023
+ ScalarType2["SUM"] = "SUM";
1024
+ ScalarType2["AVG"] = "AVG";
1023
1025
  return ScalarType2;
1024
1026
  })(ScalarType || {});
1025
1027
  var NestedAggregationType = /* @__PURE__ */ ((NestedAggregationType2) => {