@wix/auto_sdk_online-programs_sections 1.0.15 → 1.0.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.js +2 -4
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +1 -10
- package/build/cjs/index.typings.js +1 -3
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.js +22 -22
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.mjs +2 -4
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +1 -10
- package/build/es/index.typings.mjs +1 -3
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.mjs +22 -22
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.js +2 -4
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +103 -10
- package/build/internal/cjs/index.typings.js +1 -3
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +202 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.js +22 -22
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.mjs +2 -4
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +103 -10
- package/build/internal/es/index.typings.mjs +1 -3
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +202 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.mjs +22 -22
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +4 -4
|
@@ -111,8 +111,68 @@ interface VideoResolution {
|
|
|
111
111
|
height?: number;
|
|
112
112
|
/** Video width. */
|
|
113
113
|
width?: number;
|
|
114
|
+
/**
|
|
115
|
+
* Deprecated. Use the `posters` property in the parent entity instead.
|
|
116
|
+
* @internal
|
|
117
|
+
* @deprecated
|
|
118
|
+
*/
|
|
119
|
+
poster?: string;
|
|
114
120
|
/** Video format for example, mp4, hls. */
|
|
115
121
|
format?: string;
|
|
122
|
+
/**
|
|
123
|
+
* Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
|
|
124
|
+
* @internal
|
|
125
|
+
* @deprecated
|
|
126
|
+
*/
|
|
127
|
+
urlExpirationDate?: Date | null;
|
|
128
|
+
/**
|
|
129
|
+
* Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
|
|
130
|
+
* @internal
|
|
131
|
+
* @format DECIMAL_VALUE
|
|
132
|
+
* @deprecated
|
|
133
|
+
*/
|
|
134
|
+
sizeInBytes?: string | null;
|
|
135
|
+
/**
|
|
136
|
+
* Video quality. For example: 480p, 720p.
|
|
137
|
+
* @internal
|
|
138
|
+
*/
|
|
139
|
+
quality?: string | null;
|
|
140
|
+
/**
|
|
141
|
+
* Video filename.
|
|
142
|
+
* @internal
|
|
143
|
+
*/
|
|
144
|
+
filename?: string | null;
|
|
145
|
+
/**
|
|
146
|
+
* Video duration in seconds.
|
|
147
|
+
* @internal
|
|
148
|
+
* @readonly
|
|
149
|
+
* @deprecated Video duration in seconds.
|
|
150
|
+
* @replacedBy duration_in_milliseconds
|
|
151
|
+
* @targetRemovalDate 2024-08-01
|
|
152
|
+
*/
|
|
153
|
+
durationInSeconds?: number | null;
|
|
154
|
+
/**
|
|
155
|
+
* Video duration in milliseconds.
|
|
156
|
+
* @internal
|
|
157
|
+
* @readonly
|
|
158
|
+
*/
|
|
159
|
+
durationInMilliseconds?: number | null;
|
|
160
|
+
/**
|
|
161
|
+
* When true, this is a protected asset, and calling the URL will return a 403 error.
|
|
162
|
+
* In order to access private assets, make a request to:
|
|
163
|
+
* `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
|
|
164
|
+
* @internal
|
|
165
|
+
* @readonly
|
|
166
|
+
*/
|
|
167
|
+
private?: boolean | null;
|
|
168
|
+
/**
|
|
169
|
+
* Key to identify the video resolution's relationship to the original media in WixMedia.
|
|
170
|
+
* Can be used to request a download for the specific video resolution.
|
|
171
|
+
* For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
|
|
172
|
+
* @internal
|
|
173
|
+
* @readonly
|
|
174
|
+
*/
|
|
175
|
+
assetKey?: string | null;
|
|
116
176
|
}
|
|
117
177
|
declare enum State {
|
|
118
178
|
/** the section isn't ready to be shown to participants. */
|
|
@@ -421,6 +481,13 @@ interface GetSectionResponse {
|
|
|
421
481
|
interface UpdateSectionRequest {
|
|
422
482
|
/** Section to update. Include `section.id`, `section.revision`, and the fields to update. */
|
|
423
483
|
section?: Section;
|
|
484
|
+
/**
|
|
485
|
+
* Field mask that specifies which fields to update.
|
|
486
|
+
*
|
|
487
|
+
* Fields that aren't included in `fieldMask.paths` are ignored.
|
|
488
|
+
* @internal
|
|
489
|
+
*/
|
|
490
|
+
fieldMask?: string[];
|
|
424
491
|
/**
|
|
425
492
|
* Predefined sets of fields to return.
|
|
426
493
|
* @maxSize 1
|
|
@@ -511,6 +578,20 @@ interface Sorting {
|
|
|
511
578
|
fieldName?: string;
|
|
512
579
|
/** Sort order. */
|
|
513
580
|
order?: SortOrderWithLiterals;
|
|
581
|
+
/**
|
|
582
|
+
* When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
|
|
583
|
+
* a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
|
|
584
|
+
*
|
|
585
|
+
* If multiple filters are provided, they are combined with AND operator.
|
|
586
|
+
*
|
|
587
|
+
* Example:
|
|
588
|
+
* Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
|
|
589
|
+
* and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
|
|
590
|
+
* { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
|
|
591
|
+
* @internal
|
|
592
|
+
* @maxSize 10
|
|
593
|
+
*/
|
|
594
|
+
selectItemsBy?: Record<string, any>[] | null;
|
|
514
595
|
/**
|
|
515
596
|
* Origin point for geo-distance sorting on a GEO field
|
|
516
597
|
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
@@ -562,6 +643,13 @@ interface CursorPagingMetadata {
|
|
|
562
643
|
* + `false`: This is the last page.
|
|
563
644
|
*/
|
|
564
645
|
hasNext?: boolean | null;
|
|
646
|
+
/**
|
|
647
|
+
* Total number of items matching the filter.
|
|
648
|
+
* Available only on the first page of *Search* results, not included in *Query* or *List* results.
|
|
649
|
+
* If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.
|
|
650
|
+
* @internal
|
|
651
|
+
*/
|
|
652
|
+
total?: number | null;
|
|
565
653
|
}
|
|
566
654
|
interface Cursors {
|
|
567
655
|
/**
|
|
@@ -1142,11 +1230,6 @@ interface SectionsQueryBuilder {
|
|
|
1142
1230
|
* @documentationMaturity preview
|
|
1143
1231
|
*/
|
|
1144
1232
|
startsWith: (propertyName: '_id', value: string) => SectionsQueryBuilder;
|
|
1145
|
-
/** @param propertyName - Property whose value is compared with `values`.
|
|
1146
|
-
* @param values - List of values to compare against.
|
|
1147
|
-
* @documentationMaturity preview
|
|
1148
|
-
*/
|
|
1149
|
-
hasSome: (propertyName: '_id' | 'state' | 'trialSection' | 'delayInDays', value: any[]) => SectionsQueryBuilder;
|
|
1150
1233
|
/** @documentationMaturity preview */
|
|
1151
1234
|
in: (propertyName: '_id' | 'state' | 'trialSection' | 'delayInDays', value: any) => SectionsQueryBuilder;
|
|
1152
1235
|
/** @documentationMaturity preview */
|
|
@@ -1241,6 +1324,20 @@ type SectionQuery = {
|
|
|
1241
1324
|
*/
|
|
1242
1325
|
order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
|
|
1243
1326
|
/**
|
|
1327
|
+
When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
|
|
1328
|
+
a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
|
|
1329
|
+
|
|
1330
|
+
If multiple filters are provided, they are combined with AND operator.
|
|
1331
|
+
|
|
1332
|
+
Example:
|
|
1333
|
+
Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
|
|
1334
|
+
and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
|
|
1335
|
+
{ fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
|
|
1336
|
+
@internal: undefined,
|
|
1337
|
+
@maxSize: 10
|
|
1338
|
+
*/
|
|
1339
|
+
selectItemsBy?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['selectItemsBy'] | null;
|
|
1340
|
+
/**
|
|
1244
1341
|
Origin point for geo-distance sorting on a GEO field
|
|
1245
1342
|
results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
1246
1343
|
*/
|
|
@@ -1248,11 +1345,7 @@ type SectionQuery = {
|
|
|
1248
1345
|
}[];
|
|
1249
1346
|
};
|
|
1250
1347
|
declare const utils: {
|
|
1251
|
-
query:
|
|
1252
|
-
QueryBuilder: () => _wix_sdk_types.QueryBuilder<Section, SectionQuerySpec, SectionQuery>;
|
|
1253
|
-
Filter: _wix_sdk_types.FilterFactory<Section, SectionQuerySpec>;
|
|
1254
|
-
Sort: _wix_sdk_types.SortFactory<SectionQuerySpec>;
|
|
1255
|
-
};
|
|
1348
|
+
query: _wix_sdk_types.QueryHelpers<Section, SectionQuerySpec, SectionQuery>;
|
|
1256
1349
|
};
|
|
1257
1350
|
/**
|
|
1258
1351
|
* Retrieves the sections in a program.
|
|
@@ -1238,9 +1238,7 @@ async function typedQuerySections(query, options) {
|
|
|
1238
1238
|
}
|
|
1239
1239
|
}
|
|
1240
1240
|
var utils = {
|
|
1241
|
-
query:
|
|
1242
|
-
...createQueryUtils()
|
|
1243
|
-
}
|
|
1241
|
+
query: /* @__PURE__ */ createQueryUtils()
|
|
1244
1242
|
};
|
|
1245
1243
|
async function listSections2(programId, options) {
|
|
1246
1244
|
const { httpClient, sideEffects } = arguments[2];
|