@wix/auto_sdk_online-programs_sections 1.0.25 → 1.0.27
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.d.ts +3 -3
- package/build/cjs/index.js +43 -399
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +6 -43
- package/build/cjs/index.typings.js +43 -399
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +3 -71
- package/build/cjs/meta.js +22 -241
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +3 -3
- package/build/es/index.mjs +43 -399
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +6 -43
- package/build/es/index.typings.mjs +43 -399
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +3 -71
- package/build/es/meta.mjs +22 -241
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +3 -3
- package/build/internal/cjs/index.typings.d.ts +6 -134
- package/build/internal/cjs/meta.d.ts +3 -234
- package/build/internal/es/index.d.mts +3 -3
- package/build/internal/es/index.typings.d.mts +6 -134
- package/build/internal/es/meta.d.mts +3 -234
- package/package.json +2 -2
|
@@ -35,7 +35,7 @@ interface Section {
|
|
|
35
35
|
* @immutable
|
|
36
36
|
*/
|
|
37
37
|
programId?: string;
|
|
38
|
-
/** Section title
|
|
38
|
+
/** Section title. */
|
|
39
39
|
description?: Description;
|
|
40
40
|
/**
|
|
41
41
|
* @internal
|
|
@@ -58,123 +58,9 @@ interface Section {
|
|
|
58
58
|
/** Custom field data for the section. */
|
|
59
59
|
extendedFields?: ExtendedFields;
|
|
60
60
|
}
|
|
61
|
-
interface Description
|
|
62
|
-
/**
|
|
63
|
-
* @internal
|
|
64
|
-
* @deprecated
|
|
65
|
-
* @targetRemovalDate 2025-05-10
|
|
66
|
-
*/
|
|
67
|
-
image?: string;
|
|
68
|
-
/**
|
|
69
|
-
* @internal
|
|
70
|
-
* @deprecated
|
|
71
|
-
* @targetRemovalDate 2025-05-10
|
|
72
|
-
*/
|
|
73
|
-
video?: string;
|
|
61
|
+
interface Description {
|
|
74
62
|
/** @maxLength 500 */
|
|
75
63
|
title?: string;
|
|
76
|
-
/**
|
|
77
|
-
* @internal
|
|
78
|
-
* @maxLength 10000000
|
|
79
|
-
* @deprecated
|
|
80
|
-
* @targetRemovalDate 2026-06-25
|
|
81
|
-
*/
|
|
82
|
-
details?: string | null;
|
|
83
|
-
}
|
|
84
|
-
/** @oneof */
|
|
85
|
-
interface DescriptionMediaOneOf {
|
|
86
|
-
/**
|
|
87
|
-
* @internal
|
|
88
|
-
* @deprecated
|
|
89
|
-
* @targetRemovalDate 2025-05-10
|
|
90
|
-
*/
|
|
91
|
-
image?: string;
|
|
92
|
-
/**
|
|
93
|
-
* @internal
|
|
94
|
-
* @deprecated
|
|
95
|
-
* @targetRemovalDate 2025-05-10
|
|
96
|
-
*/
|
|
97
|
-
video?: string;
|
|
98
|
-
}
|
|
99
|
-
interface FocalPoint {
|
|
100
|
-
/** X-coordinate of the focal point. */
|
|
101
|
-
x?: number;
|
|
102
|
-
/** Y-coordinate of the focal point. */
|
|
103
|
-
y?: number;
|
|
104
|
-
/** crop by height */
|
|
105
|
-
height?: number | null;
|
|
106
|
-
/** crop by width */
|
|
107
|
-
width?: number | null;
|
|
108
|
-
}
|
|
109
|
-
interface VideoResolution {
|
|
110
|
-
/** Video URL. */
|
|
111
|
-
url?: string;
|
|
112
|
-
/** Video height. */
|
|
113
|
-
height?: number;
|
|
114
|
-
/** Video width. */
|
|
115
|
-
width?: number;
|
|
116
|
-
/**
|
|
117
|
-
* Deprecated. Use the `posters` property in the parent entity instead.
|
|
118
|
-
* @internal
|
|
119
|
-
* @deprecated
|
|
120
|
-
*/
|
|
121
|
-
poster?: string;
|
|
122
|
-
/** Video format for example, mp4, hls. */
|
|
123
|
-
format?: string;
|
|
124
|
-
/**
|
|
125
|
-
* Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
|
|
126
|
-
* @internal
|
|
127
|
-
* @deprecated
|
|
128
|
-
*/
|
|
129
|
-
urlExpirationDate?: Date | null;
|
|
130
|
-
/**
|
|
131
|
-
* Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
|
|
132
|
-
* @internal
|
|
133
|
-
* @format DECIMAL_VALUE
|
|
134
|
-
* @deprecated
|
|
135
|
-
*/
|
|
136
|
-
sizeInBytes?: string | null;
|
|
137
|
-
/**
|
|
138
|
-
* Video quality. For example: 480p, 720p.
|
|
139
|
-
* @internal
|
|
140
|
-
*/
|
|
141
|
-
quality?: string | null;
|
|
142
|
-
/**
|
|
143
|
-
* Video filename.
|
|
144
|
-
* @internal
|
|
145
|
-
*/
|
|
146
|
-
filename?: string | null;
|
|
147
|
-
/**
|
|
148
|
-
* Video duration in seconds.
|
|
149
|
-
* @internal
|
|
150
|
-
* @readonly
|
|
151
|
-
* @deprecated Video duration in seconds.
|
|
152
|
-
* @replacedBy duration_in_milliseconds
|
|
153
|
-
* @targetRemovalDate 2024-08-01
|
|
154
|
-
*/
|
|
155
|
-
durationInSeconds?: number | null;
|
|
156
|
-
/**
|
|
157
|
-
* Video duration in milliseconds.
|
|
158
|
-
* @internal
|
|
159
|
-
* @readonly
|
|
160
|
-
*/
|
|
161
|
-
durationInMilliseconds?: number | null;
|
|
162
|
-
/**
|
|
163
|
-
* When true, this is a protected asset, and calling the URL will return a 403 error.
|
|
164
|
-
* In order to access private assets, make a request to:
|
|
165
|
-
* `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
|
|
166
|
-
* @internal
|
|
167
|
-
* @readonly
|
|
168
|
-
*/
|
|
169
|
-
private?: boolean | null;
|
|
170
|
-
/**
|
|
171
|
-
* Key to identify the video resolution's relationship to the original media in WixMedia.
|
|
172
|
-
* Can be used to request a download for the specific video resolution.
|
|
173
|
-
* For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
|
|
174
|
-
* @internal
|
|
175
|
-
* @readonly
|
|
176
|
-
*/
|
|
177
|
-
assetKey?: string | null;
|
|
178
64
|
}
|
|
179
65
|
declare enum State {
|
|
180
66
|
/** Retained for backward compatibility. Doesn't affect whether the section is served. */
|
|
@@ -532,13 +418,6 @@ interface QuerySectionsRequest {
|
|
|
532
418
|
query?: CursorQuery;
|
|
533
419
|
/** Compatibility option for existing integrations. Current section responses return the section title. */
|
|
534
420
|
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
535
|
-
/**
|
|
536
|
-
* Deprecated. Program ID used to scope the query. Use `query.filter` instead.
|
|
537
|
-
* @deprecated
|
|
538
|
-
* @replacedBy wix.common.CursorQuery
|
|
539
|
-
* @targetRemovalDate 2026-06-30
|
|
540
|
-
*/
|
|
541
|
-
programId?: string;
|
|
542
421
|
/**
|
|
543
422
|
* Predefined sets of fields to return.
|
|
544
423
|
* @maxSize 1
|
|
@@ -969,7 +848,7 @@ interface AccountInfo {
|
|
|
969
848
|
/**
|
|
970
849
|
* Creates a section.
|
|
971
850
|
*
|
|
972
|
-
* The section is added to the program identified by `section.program_id`. Provide that program ID in the request. Set `section.description.title` for the section title.
|
|
851
|
+
* The section is added to the program identified by `section.program_id`. Provide that program ID in the request. Set `section.description.title` for the section title. The stored ordering value is assigned automatically.
|
|
973
852
|
*
|
|
974
853
|
* To create multiple sections in a single API call, call [Bulk Create Sections](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/bulk-create-sections).
|
|
975
854
|
* @param section - Section to create. Must include `section.program_id`.
|
|
@@ -993,7 +872,7 @@ interface CreateSectionOptions {
|
|
|
993
872
|
/**
|
|
994
873
|
* Creates up to 100 sections in a single API call.
|
|
995
874
|
*
|
|
996
|
-
* All sections in the request must include `program_id` and belong to the same program. Set `description.title` for each section title.
|
|
875
|
+
* All sections in the request must include `program_id` and belong to the same program. Set `description.title` for each section title. The stored ordering values are assigned automatically.
|
|
997
876
|
*
|
|
998
877
|
* To create a single section, call [Create Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/create-section).
|
|
999
878
|
* @param sections - List of sections to create. Each section must include `program_id`, and all sections must belong to the same program.
|
|
@@ -1083,7 +962,7 @@ interface UpdateSectionOptions {
|
|
|
1083
962
|
* @immutable
|
|
1084
963
|
*/
|
|
1085
964
|
programId?: string;
|
|
1086
|
-
/** Section title
|
|
965
|
+
/** Section title. */
|
|
1087
966
|
description?: Description;
|
|
1088
967
|
/**
|
|
1089
968
|
* @internal
|
|
@@ -1149,13 +1028,6 @@ declare function querySections(options?: QuerySectionsOptions): SectionsQueryBui
|
|
|
1149
1028
|
interface QuerySectionsOptions {
|
|
1150
1029
|
/** Compatibility option for existing integrations. Current section responses return the section title. */
|
|
1151
1030
|
descriptionFieldSet?: DescriptionFieldSetWithLiterals | undefined;
|
|
1152
|
-
/**
|
|
1153
|
-
* Deprecated. Program ID used to scope the query. Use `query.filter` instead.
|
|
1154
|
-
* @deprecated
|
|
1155
|
-
* @replacedBy wix.common.CursorQuery
|
|
1156
|
-
* @targetRemovalDate 2026-06-30
|
|
1157
|
-
*/
|
|
1158
|
-
programId?: string | undefined;
|
|
1159
1031
|
/**
|
|
1160
1032
|
* Predefined sets of fields to return.
|
|
1161
1033
|
* @maxSize 1
|
|
@@ -1405,4 +1277,4 @@ interface MoveSectionOptions {
|
|
|
1405
1277
|
fields?: RequestedFieldsWithLiterals[];
|
|
1406
1278
|
}
|
|
1407
1279
|
|
|
1408
|
-
export { type AccountInfo, type ActionEvent, type AddressLocation, type ApplicationError, type BulkActionMetadata, BulkActionType, type BulkActionTypeWithLiterals, type BulkCloneSectionRequest, type BulkCloneSectionResponse, type BulkCreateSectionMigrationRequest, type BulkCreateSectionMigrationResponse, type BulkCreateSectionRequest, type BulkCreateSectionResponse, type BulkCreateSectionsOptions, type BulkCreateSectionsRequest, type BulkCreateSectionsResponse, type BulkSectionResult, type CloneSectionOptions, type CloneSectionRequest, type CloneSectionResponse, type CommonQueryWithEntityContext, type CreateSectionOptions, type CreateSectionRequest, type CreateSectionResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteAllProgramSectionsRequest, type DeleteAllProgramSectionsResponse, type DeleteByFilterOperation, type DeleteByIdsOperation, type DeleteSectionRequest, type DeleteSectionResponse, type Description, DescriptionFieldSet, type DescriptionFieldSetWithLiterals, type
|
|
1280
|
+
export { type AccountInfo, type ActionEvent, type AddressLocation, type ApplicationError, type BulkActionMetadata, BulkActionType, type BulkActionTypeWithLiterals, type BulkCloneSectionRequest, type BulkCloneSectionResponse, type BulkCreateSectionMigrationRequest, type BulkCreateSectionMigrationResponse, type BulkCreateSectionRequest, type BulkCreateSectionResponse, type BulkCreateSectionsOptions, type BulkCreateSectionsRequest, type BulkCreateSectionsResponse, type BulkSectionResult, type CloneSectionOptions, type CloneSectionRequest, type CloneSectionResponse, type CommonQueryWithEntityContext, type CreateSectionOptions, type CreateSectionRequest, type CreateSectionResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteAllProgramSectionsRequest, type DeleteAllProgramSectionsResponse, type DeleteByFilterOperation, type DeleteByIdsOperation, type DeleteSectionRequest, type DeleteSectionResponse, type Description, DescriptionFieldSet, type DescriptionFieldSetWithLiterals, type DocumentImage, type DocumentPayload, type DocumentUpdateOperation, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type ExtendedFields, type GetSectionOptions, type GetSectionRequest, type GetSectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type IndexDocument, type ItemMetadata, type ListSectionsOptions, type ListSectionsRequest, type ListSectionsResponse, type MessageEnvelope, type MoveSectionOptions, type MoveSectionRequest, type MoveSectionResponse, type PublishSectionRequest, type PublishSectionResponse, type QuerySectionsOptions, type QuerySectionsRequest, type QuerySectionsResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type RestoreSectionFromTrashRequest, type RestoreSectionFromTrashResponse, type SearchIndexingNotification, SearchIndexingNotificationState, type SearchIndexingNotificationStateWithLiterals, type Section, type SectionCloned, type SectionDeleted, type SectionMoved, type SectionPublished, type SectionQuery, type SectionQuerySpec, type SectionUpdated, type SectionsQueryBuilder, type SectionsQueryResult, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type UpdateByFilterOperation, type UpdateDocumentsEvent, type UpdateDocumentsEventOperationOneOf, type UpdateExistingOperation, type UpdateSectionOptions, type UpdateSectionRequest, type UpdateSectionResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, querySections, typedQuerySections, updateSection, utils };
|
|
@@ -35,7 +35,7 @@ interface Section {
|
|
|
35
35
|
* @immutable
|
|
36
36
|
*/
|
|
37
37
|
programId?: string;
|
|
38
|
-
/** Section title
|
|
38
|
+
/** Section title. */
|
|
39
39
|
description?: Description;
|
|
40
40
|
/**
|
|
41
41
|
* @internal
|
|
@@ -58,233 +58,9 @@ interface Section {
|
|
|
58
58
|
/** Custom field data for the section. */
|
|
59
59
|
extendedFields?: ExtendedFields;
|
|
60
60
|
}
|
|
61
|
-
interface Description
|
|
62
|
-
/**
|
|
63
|
-
* @internal
|
|
64
|
-
* @deprecated
|
|
65
|
-
* @targetRemovalDate 2025-05-10
|
|
66
|
-
*/
|
|
67
|
-
image?: Image;
|
|
68
|
-
/**
|
|
69
|
-
* @internal
|
|
70
|
-
* @deprecated
|
|
71
|
-
* @targetRemovalDate 2025-05-10
|
|
72
|
-
*/
|
|
73
|
-
video?: VideoV2;
|
|
61
|
+
interface Description {
|
|
74
62
|
/** @maxLength 500 */
|
|
75
63
|
title?: string;
|
|
76
|
-
/**
|
|
77
|
-
* @internal
|
|
78
|
-
* @maxLength 10000000
|
|
79
|
-
* @deprecated
|
|
80
|
-
* @targetRemovalDate 2026-06-25
|
|
81
|
-
*/
|
|
82
|
-
details?: string | null;
|
|
83
|
-
}
|
|
84
|
-
/** @oneof */
|
|
85
|
-
interface DescriptionMediaOneOf {
|
|
86
|
-
/**
|
|
87
|
-
* @internal
|
|
88
|
-
* @deprecated
|
|
89
|
-
* @targetRemovalDate 2025-05-10
|
|
90
|
-
*/
|
|
91
|
-
image?: Image;
|
|
92
|
-
/**
|
|
93
|
-
* @internal
|
|
94
|
-
* @deprecated
|
|
95
|
-
* @targetRemovalDate 2025-05-10
|
|
96
|
-
*/
|
|
97
|
-
video?: VideoV2;
|
|
98
|
-
}
|
|
99
|
-
interface Image {
|
|
100
|
-
/** WixMedia image ID. */
|
|
101
|
-
id?: string;
|
|
102
|
-
/** Image URL. */
|
|
103
|
-
url?: string;
|
|
104
|
-
/**
|
|
105
|
-
* Original image height.
|
|
106
|
-
* @readonly
|
|
107
|
-
*/
|
|
108
|
-
height?: number;
|
|
109
|
-
/**
|
|
110
|
-
* Original image width.
|
|
111
|
-
* @readonly
|
|
112
|
-
*/
|
|
113
|
-
width?: number;
|
|
114
|
-
/** Image alt text. */
|
|
115
|
-
altText?: string | null;
|
|
116
|
-
/**
|
|
117
|
-
* Image URL expiration date (when relevant).
|
|
118
|
-
* @internal
|
|
119
|
-
* @readonly
|
|
120
|
-
*/
|
|
121
|
-
urlExpirationDate?: Date | null;
|
|
122
|
-
/**
|
|
123
|
-
* Image filename.
|
|
124
|
-
* @readonly
|
|
125
|
-
*/
|
|
126
|
-
filename?: string | null;
|
|
127
|
-
/**
|
|
128
|
-
* Image size in bytes.
|
|
129
|
-
* @internal
|
|
130
|
-
* @readonly
|
|
131
|
-
* @format DECIMAL_VALUE
|
|
132
|
-
*/
|
|
133
|
-
sizeInBytes?: string | null;
|
|
134
|
-
/**
|
|
135
|
-
* Focal point of the image.
|
|
136
|
-
* @internal
|
|
137
|
-
*/
|
|
138
|
-
focalPoint?: FocalPoint;
|
|
139
|
-
}
|
|
140
|
-
interface FocalPoint {
|
|
141
|
-
/** X-coordinate of the focal point. */
|
|
142
|
-
x?: number;
|
|
143
|
-
/** Y-coordinate of the focal point. */
|
|
144
|
-
y?: number;
|
|
145
|
-
/** crop by height */
|
|
146
|
-
height?: number | null;
|
|
147
|
-
/** crop by width */
|
|
148
|
-
width?: number | null;
|
|
149
|
-
}
|
|
150
|
-
interface VideoV2 {
|
|
151
|
-
/** WixMedia ID. */
|
|
152
|
-
id?: string;
|
|
153
|
-
/**
|
|
154
|
-
* Original video URL.
|
|
155
|
-
* @internal
|
|
156
|
-
*/
|
|
157
|
-
url?: string;
|
|
158
|
-
/**
|
|
159
|
-
* Available resolutions for the video, starting with the optimal resolution.
|
|
160
|
-
* @readonly
|
|
161
|
-
* @maxSize 100
|
|
162
|
-
*/
|
|
163
|
-
resolutions?: VideoResolution[];
|
|
164
|
-
/**
|
|
165
|
-
* Video filename.
|
|
166
|
-
* @readonly
|
|
167
|
-
*/
|
|
168
|
-
filename?: string | null;
|
|
169
|
-
/**
|
|
170
|
-
* Video posters.
|
|
171
|
-
* @internal
|
|
172
|
-
* @readonly
|
|
173
|
-
*/
|
|
174
|
-
posters?: Image[];
|
|
175
|
-
/**
|
|
176
|
-
* Original video size in bytes.
|
|
177
|
-
* @internal
|
|
178
|
-
* @readonly
|
|
179
|
-
* @format DECIMAL_VALUE
|
|
180
|
-
*/
|
|
181
|
-
sizeInBytes?: string | null;
|
|
182
|
-
/**
|
|
183
|
-
* Video URL expiration date (when relevant).
|
|
184
|
-
* @internal
|
|
185
|
-
* @readonly
|
|
186
|
-
*/
|
|
187
|
-
urlExpirationDate?: Date | null;
|
|
188
|
-
/**
|
|
189
|
-
* Original video duration in milliseconds.
|
|
190
|
-
* @internal
|
|
191
|
-
* @readonly
|
|
192
|
-
*/
|
|
193
|
-
durationInMilliseconds?: number | null;
|
|
194
|
-
/**
|
|
195
|
-
* A short title for the video. will be used for SEO purposes.
|
|
196
|
-
* @internal
|
|
197
|
-
* @maxLength 300
|
|
198
|
-
*/
|
|
199
|
-
title?: string | null;
|
|
200
|
-
/**
|
|
201
|
-
* A long description for the video. will be used for SEO purposes.
|
|
202
|
-
* @internal
|
|
203
|
-
* @maxLength 2000
|
|
204
|
-
*/
|
|
205
|
-
description?: string | null;
|
|
206
|
-
/**
|
|
207
|
-
* Original video height.
|
|
208
|
-
* @internal
|
|
209
|
-
* @readonly
|
|
210
|
-
*/
|
|
211
|
-
height?: number | null;
|
|
212
|
-
/**
|
|
213
|
-
* Original video width.
|
|
214
|
-
* @internal
|
|
215
|
-
* @readonly
|
|
216
|
-
*/
|
|
217
|
-
width?: number | null;
|
|
218
|
-
}
|
|
219
|
-
interface VideoResolution {
|
|
220
|
-
/** Video URL. */
|
|
221
|
-
url?: string;
|
|
222
|
-
/** Video height. */
|
|
223
|
-
height?: number;
|
|
224
|
-
/** Video width. */
|
|
225
|
-
width?: number;
|
|
226
|
-
/**
|
|
227
|
-
* Deprecated. Use the `posters` property in the parent entity instead.
|
|
228
|
-
* @internal
|
|
229
|
-
* @deprecated
|
|
230
|
-
*/
|
|
231
|
-
poster?: Image;
|
|
232
|
-
/** Video format for example, mp4, hls. */
|
|
233
|
-
format?: string;
|
|
234
|
-
/**
|
|
235
|
-
* Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
|
|
236
|
-
* @internal
|
|
237
|
-
* @deprecated
|
|
238
|
-
*/
|
|
239
|
-
urlExpirationDate?: Date | null;
|
|
240
|
-
/**
|
|
241
|
-
* Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
|
|
242
|
-
* @internal
|
|
243
|
-
* @format DECIMAL_VALUE
|
|
244
|
-
* @deprecated
|
|
245
|
-
*/
|
|
246
|
-
sizeInBytes?: string | null;
|
|
247
|
-
/**
|
|
248
|
-
* Video quality. For example: 480p, 720p.
|
|
249
|
-
* @internal
|
|
250
|
-
*/
|
|
251
|
-
quality?: string | null;
|
|
252
|
-
/**
|
|
253
|
-
* Video filename.
|
|
254
|
-
* @internal
|
|
255
|
-
*/
|
|
256
|
-
filename?: string | null;
|
|
257
|
-
/**
|
|
258
|
-
* Video duration in seconds.
|
|
259
|
-
* @internal
|
|
260
|
-
* @readonly
|
|
261
|
-
* @deprecated Video duration in seconds.
|
|
262
|
-
* @replacedBy duration_in_milliseconds
|
|
263
|
-
* @targetRemovalDate 2024-08-01
|
|
264
|
-
*/
|
|
265
|
-
durationInSeconds?: number | null;
|
|
266
|
-
/**
|
|
267
|
-
* Video duration in milliseconds.
|
|
268
|
-
* @internal
|
|
269
|
-
* @readonly
|
|
270
|
-
*/
|
|
271
|
-
durationInMilliseconds?: number | null;
|
|
272
|
-
/**
|
|
273
|
-
* When true, this is a protected asset, and calling the URL will return a 403 error.
|
|
274
|
-
* In order to access private assets, make a request to:
|
|
275
|
-
* `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
|
|
276
|
-
* @internal
|
|
277
|
-
* @readonly
|
|
278
|
-
*/
|
|
279
|
-
private?: boolean | null;
|
|
280
|
-
/**
|
|
281
|
-
* Key to identify the video resolution's relationship to the original media in WixMedia.
|
|
282
|
-
* Can be used to request a download for the specific video resolution.
|
|
283
|
-
* For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
|
|
284
|
-
* @internal
|
|
285
|
-
* @readonly
|
|
286
|
-
*/
|
|
287
|
-
assetKey?: string | null;
|
|
288
64
|
}
|
|
289
65
|
declare enum State {
|
|
290
66
|
/** Retained for backward compatibility. Doesn't affect whether the section is served. */
|
|
@@ -642,13 +418,6 @@ interface QuerySectionsRequest {
|
|
|
642
418
|
query?: CursorQuery;
|
|
643
419
|
/** Compatibility option for existing integrations. Current section responses return the section title. */
|
|
644
420
|
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
645
|
-
/**
|
|
646
|
-
* Deprecated. Program ID used to scope the query. Use `query.filter` instead.
|
|
647
|
-
* @deprecated
|
|
648
|
-
* @replacedBy wix.common.CursorQuery
|
|
649
|
-
* @targetRemovalDate 2026-06-30
|
|
650
|
-
*/
|
|
651
|
-
programId?: string;
|
|
652
421
|
/**
|
|
653
422
|
* Predefined sets of fields to return.
|
|
654
423
|
* @maxSize 1
|
|
@@ -1149,4 +918,4 @@ declare function cloneSection(): __PublicMethodMetaInfo<'POST', {
|
|
|
1149
918
|
}, CloneSectionRequest$1, CloneSectionRequest, CloneSectionResponse$1, CloneSectionResponse>;
|
|
1150
919
|
declare function moveSection(): __PublicMethodMetaInfo<'PATCH', {}, MoveSectionRequest$1, MoveSectionRequest, MoveSectionResponse$1, MoveSectionResponse>;
|
|
1151
920
|
|
|
1152
|
-
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressLocation as AddressLocationOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, BulkActionType as BulkActionTypeOriginal, type BulkActionTypeWithLiterals as BulkActionTypeWithLiteralsOriginal, type BulkCloneSectionRequest as BulkCloneSectionRequestOriginal, type BulkCloneSectionResponse as BulkCloneSectionResponseOriginal, type BulkCreateSectionMigrationRequest as BulkCreateSectionMigrationRequestOriginal, type BulkCreateSectionMigrationResponse as BulkCreateSectionMigrationResponseOriginal, type BulkCreateSectionRequest as BulkCreateSectionRequestOriginal, type BulkCreateSectionResponse as BulkCreateSectionResponseOriginal, type BulkCreateSectionsRequest as BulkCreateSectionsRequestOriginal, type BulkCreateSectionsResponse as BulkCreateSectionsResponseOriginal, type BulkSectionResult as BulkSectionResultOriginal, type CloneSectionRequest as CloneSectionRequestOriginal, type CloneSectionResponse as CloneSectionResponseOriginal, type CreateSectionRequest as CreateSectionRequestOriginal, type CreateSectionResponse as CreateSectionResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DeleteAllProgramSectionsRequest as DeleteAllProgramSectionsRequestOriginal, type DeleteAllProgramSectionsResponse as DeleteAllProgramSectionsResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteSectionRequest as DeleteSectionRequestOriginal, type DeleteSectionResponse as DeleteSectionResponseOriginal, DescriptionFieldSet as DescriptionFieldSetOriginal, type DescriptionFieldSetWithLiterals as DescriptionFieldSetWithLiteralsOriginal, type
|
|
921
|
+
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressLocation as AddressLocationOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, BulkActionType as BulkActionTypeOriginal, type BulkActionTypeWithLiterals as BulkActionTypeWithLiteralsOriginal, type BulkCloneSectionRequest as BulkCloneSectionRequestOriginal, type BulkCloneSectionResponse as BulkCloneSectionResponseOriginal, type BulkCreateSectionMigrationRequest as BulkCreateSectionMigrationRequestOriginal, type BulkCreateSectionMigrationResponse as BulkCreateSectionMigrationResponseOriginal, type BulkCreateSectionRequest as BulkCreateSectionRequestOriginal, type BulkCreateSectionResponse as BulkCreateSectionResponseOriginal, type BulkCreateSectionsRequest as BulkCreateSectionsRequestOriginal, type BulkCreateSectionsResponse as BulkCreateSectionsResponseOriginal, type BulkSectionResult as BulkSectionResultOriginal, type CloneSectionRequest as CloneSectionRequestOriginal, type CloneSectionResponse as CloneSectionResponseOriginal, type CreateSectionRequest as CreateSectionRequestOriginal, type CreateSectionResponse as CreateSectionResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DeleteAllProgramSectionsRequest as DeleteAllProgramSectionsRequestOriginal, type DeleteAllProgramSectionsResponse as DeleteAllProgramSectionsResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteSectionRequest as DeleteSectionRequestOriginal, type DeleteSectionResponse as DeleteSectionResponseOriginal, DescriptionFieldSet as DescriptionFieldSetOriginal, type DescriptionFieldSetWithLiterals as DescriptionFieldSetWithLiteralsOriginal, type Description as DescriptionOriginal, type DocumentImage as DocumentImageOriginal, type DocumentPayload as DocumentPayloadOriginal, type DocumentUpdateOperation as DocumentUpdateOperationOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, Enum as EnumOriginal, type EnumWithLiterals as EnumWithLiteralsOriginal, type ExtendedFields as ExtendedFieldsOriginal, type GetSectionRequest as GetSectionRequestOriginal, type GetSectionResponse as GetSectionResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type IndexDocument as IndexDocumentOriginal, type ItemMetadata as ItemMetadataOriginal, type ListSectionsRequest as ListSectionsRequestOriginal, type ListSectionsResponse as ListSectionsResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MoveSectionRequest as MoveSectionRequestOriginal, type MoveSectionResponse as MoveSectionResponseOriginal, type PublishSectionRequest as PublishSectionRequestOriginal, type PublishSectionResponse as PublishSectionResponseOriginal, type QuerySectionsRequest as QuerySectionsRequestOriginal, type QuerySectionsResponse as QuerySectionsResponseOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type RestoreSectionFromTrashRequest as RestoreSectionFromTrashRequestOriginal, type RestoreSectionFromTrashResponse as RestoreSectionFromTrashResponseOriginal, type SearchIndexingNotification as SearchIndexingNotificationOriginal, SearchIndexingNotificationState as SearchIndexingNotificationStateOriginal, type SearchIndexingNotificationStateWithLiterals as SearchIndexingNotificationStateWithLiteralsOriginal, type SectionCloned as SectionClonedOriginal, type SectionDeleted as SectionDeletedOriginal, type SectionMoved as SectionMovedOriginal, type Section as SectionOriginal, type SectionPublished as SectionPublishedOriginal, type SectionUpdated as SectionUpdatedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type UpdateByFilterOperation as UpdateByFilterOperationOriginal, type UpdateDocumentsEventOperationOneOf as UpdateDocumentsEventOperationOneOfOriginal, type UpdateDocumentsEvent as UpdateDocumentsEventOriginal, type UpdateExistingOperation as UpdateExistingOperationOriginal, type UpdateSectionRequest as UpdateSectionRequestOriginal, type UpdateSectionResponse as UpdateSectionResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCreateSections, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, querySections, updateSection };
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
2
|
import { Section, CreateSectionOptions, BulkCreateSectionsOptions, BulkCreateSectionsResponse, GetSectionOptions, UpdateSectionOptions, ListSectionsOptions, ListSectionsResponse, CloneSectionOptions, CloneSectionResponse, MoveSectionOptions, MoveSectionResponse, SectionQuery, QuerySectionsOptions, typedQuerySections, SectionsQueryBuilder } from './index.typings.mjs';
|
|
3
|
-
export { AccountInfo, ActionEvent, AddressLocation, ApplicationError, BulkActionMetadata, BulkActionType, BulkActionTypeWithLiterals, BulkCloneSectionRequest, BulkCloneSectionResponse, BulkCreateSectionMigrationRequest, BulkCreateSectionMigrationResponse, BulkCreateSectionRequest, BulkCreateSectionResponse, BulkCreateSectionsRequest, BulkSectionResult, CloneSectionRequest, CommonQueryWithEntityContext, CreateSectionRequest, CreateSectionResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteAllProgramSectionsRequest, DeleteAllProgramSectionsResponse, DeleteByFilterOperation, DeleteByIdsOperation, DeleteSectionRequest, DeleteSectionResponse, Description, DescriptionFieldSet, DescriptionFieldSetWithLiterals,
|
|
3
|
+
export { AccountInfo, ActionEvent, AddressLocation, ApplicationError, BulkActionMetadata, BulkActionType, BulkActionTypeWithLiterals, BulkCloneSectionRequest, BulkCloneSectionResponse, BulkCreateSectionMigrationRequest, BulkCreateSectionMigrationResponse, BulkCreateSectionRequest, BulkCreateSectionResponse, BulkCreateSectionsRequest, BulkSectionResult, CloneSectionRequest, CommonQueryWithEntityContext, CreateSectionRequest, CreateSectionResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteAllProgramSectionsRequest, DeleteAllProgramSectionsResponse, DeleteByFilterOperation, DeleteByIdsOperation, DeleteSectionRequest, DeleteSectionResponse, Description, DescriptionFieldSet, DescriptionFieldSetWithLiterals, DocumentImage, DocumentPayload, DocumentUpdateOperation, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Enum, EnumWithLiterals, ExtendedFields, GetSectionRequest, GetSectionResponse, IdentificationData, IdentificationDataIdOneOf, IndexDocument, ItemMetadata, ListSectionsRequest, MessageEnvelope, MoveSectionRequest, PublishSectionRequest, PublishSectionResponse, QuerySectionsRequest, QuerySectionsResponse, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, RestoreSectionFromTrashRequest, RestoreSectionFromTrashResponse, SearchIndexingNotification, SearchIndexingNotificationState, SearchIndexingNotificationStateWithLiterals, SectionCloned, SectionDeleted, SectionMoved, SectionPublished, SectionQuerySpec, SectionUpdated, SectionsQueryResult, SortOrder, SortOrderWithLiterals, Sorting, State, StateWithLiterals, UpdateByFilterOperation, UpdateDocumentsEvent, UpdateDocumentsEventOperationOneOf, UpdateExistingOperation, UpdateSectionRequest, UpdateSectionResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.mjs';
|
|
4
4
|
|
|
5
5
|
declare function createSection$1(httpClient: HttpClient): CreateSectionSignature;
|
|
6
6
|
interface CreateSectionSignature {
|
|
7
7
|
/**
|
|
8
8
|
* Creates a section.
|
|
9
9
|
*
|
|
10
|
-
* The section is added to the program identified by `section.program_id`. Provide that program ID in the request. Set `section.description.title` for the section title.
|
|
10
|
+
* The section is added to the program identified by `section.program_id`. Provide that program ID in the request. Set `section.description.title` for the section title. The stored ordering value is assigned automatically.
|
|
11
11
|
*
|
|
12
12
|
* To create multiple sections in a single API call, call [Bulk Create Sections](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/bulk-create-sections).
|
|
13
13
|
* @param - Section to create. Must include `section.program_id`.
|
|
@@ -20,7 +20,7 @@ interface BulkCreateSectionsSignature {
|
|
|
20
20
|
/**
|
|
21
21
|
* Creates up to 100 sections in a single API call.
|
|
22
22
|
*
|
|
23
|
-
* All sections in the request must include `program_id` and belong to the same program. Set `description.title` for each section title.
|
|
23
|
+
* All sections in the request must include `program_id` and belong to the same program. Set `description.title` for each section title. The stored ordering values are assigned automatically.
|
|
24
24
|
*
|
|
25
25
|
* To create a single section, call [Create Section](https://dev.wix.com/docs/api-reference/business-management/online-programs/sections/create-section).
|
|
26
26
|
* @param - List of sections to create. Each section must include `program_id`, and all sections must belong to the same program.
|