@wix/portfolio 1.0.95 → 1.0.96
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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/portfolio",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.96",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -18,11 +18,11 @@
|
|
|
18
18
|
"type-bundles"
|
|
19
19
|
],
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@wix/portfolio_collections": "1.0.
|
|
21
|
+
"@wix/portfolio_collections": "1.0.30",
|
|
22
22
|
"@wix/portfolio_portfolio-settings": "1.0.16",
|
|
23
|
-
"@wix/portfolio_project-in-collections": "1.0.
|
|
24
|
-
"@wix/portfolio_project-items": "1.0.
|
|
25
|
-
"@wix/portfolio_projects": "1.0.
|
|
23
|
+
"@wix/portfolio_project-in-collections": "1.0.29",
|
|
24
|
+
"@wix/portfolio_project-items": "1.0.34",
|
|
25
|
+
"@wix/portfolio_projects": "1.0.41",
|
|
26
26
|
"@wix/portfolio_synced-project": "1.0.13"
|
|
27
27
|
},
|
|
28
28
|
"devDependencies": {
|
|
@@ -48,5 +48,5 @@
|
|
|
48
48
|
"fqdn": ""
|
|
49
49
|
}
|
|
50
50
|
},
|
|
51
|
-
"falconPackageHash": "
|
|
51
|
+
"falconPackageHash": "a145c3b1dd2847bd2422200d6841c4f70c996fc229fce00fffac91c8"
|
|
52
52
|
}
|
|
@@ -408,50 +408,53 @@ type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
|
|
|
408
408
|
host: Host;
|
|
409
409
|
} ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
|
|
410
410
|
|
|
411
|
-
/** Collection is the main entity of CollectionsService */
|
|
412
411
|
interface Collection {
|
|
413
412
|
/**
|
|
414
|
-
* Collection ID
|
|
413
|
+
* Collection ID.
|
|
415
414
|
* @readonly
|
|
416
415
|
*/
|
|
417
416
|
_id?: string | null;
|
|
418
417
|
/**
|
|
419
|
-
*
|
|
418
|
+
* Revision number, which increments by 1 each time the collection is updated. To prevent conflicting changes, the existing revision must be passed when updating the collection object.
|
|
420
419
|
* @readonly
|
|
421
420
|
*/
|
|
422
421
|
revision?: string | null;
|
|
423
|
-
/**
|
|
422
|
+
/** Collection title. */
|
|
424
423
|
title?: string | null;
|
|
425
|
-
/**
|
|
424
|
+
/** Collection description. */
|
|
426
425
|
description?: string | null;
|
|
427
|
-
/**
|
|
426
|
+
/** Collection slug. */
|
|
428
427
|
slug?: string | null;
|
|
429
|
-
/** Collection
|
|
428
|
+
/** Collection cover image. */
|
|
430
429
|
coverImage?: Image$3;
|
|
431
|
-
/**
|
|
430
|
+
/** Whether the collection is hidden from the portfolio. */
|
|
432
431
|
hidden?: boolean | null;
|
|
433
|
-
/**
|
|
432
|
+
/**
|
|
433
|
+
* Index that determines which position a media item is displayed in the gallery. <br />
|
|
434
|
+
*
|
|
435
|
+
* Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
|
|
436
|
+
*/
|
|
434
437
|
sortOrder?: number | null;
|
|
435
438
|
/**
|
|
436
|
-
*
|
|
439
|
+
* Date and time the collection was created.
|
|
437
440
|
* @readonly
|
|
438
441
|
*/
|
|
439
442
|
_createdDate?: Date;
|
|
440
443
|
/**
|
|
441
|
-
*
|
|
444
|
+
* Date and time the collection was updated.
|
|
442
445
|
* @readonly
|
|
443
446
|
*/
|
|
444
447
|
_updatedDate?: Date;
|
|
445
448
|
/**
|
|
446
|
-
*
|
|
449
|
+
* Collection's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
|
|
447
450
|
* @readonly
|
|
448
451
|
*/
|
|
449
452
|
url?: string;
|
|
450
|
-
/** SEO data
|
|
453
|
+
/** Collection SEO data. */
|
|
451
454
|
seoData?: SeoSchema$2;
|
|
452
455
|
}
|
|
453
456
|
interface Image$3 {
|
|
454
|
-
/**
|
|
457
|
+
/** Information about the Wix Media image. */
|
|
455
458
|
imageInfo?: string;
|
|
456
459
|
/** Focal point of the image. */
|
|
457
460
|
focalPoint?: Point$3;
|
|
@@ -674,27 +677,27 @@ interface File$2 {
|
|
|
674
677
|
fileName?: string;
|
|
675
678
|
}
|
|
676
679
|
interface CreateCollectionRequest {
|
|
677
|
-
/** Collection to
|
|
680
|
+
/** Collection to create. */
|
|
678
681
|
collection: Collection;
|
|
679
682
|
}
|
|
680
683
|
interface CreateCollectionResponse {
|
|
681
|
-
/**
|
|
684
|
+
/** Created collection. */
|
|
682
685
|
collection?: Collection;
|
|
683
686
|
}
|
|
684
687
|
interface GetCollectionRequest {
|
|
685
|
-
/**
|
|
688
|
+
/** ID of the collection to retrieve. */
|
|
686
689
|
collectionId: string;
|
|
687
|
-
/**
|
|
690
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
688
691
|
includePageUrl?: boolean | null;
|
|
689
692
|
}
|
|
690
693
|
interface GetCollectionResponse {
|
|
691
|
-
/** The
|
|
694
|
+
/** The requested collection. */
|
|
692
695
|
collection?: Collection;
|
|
693
696
|
}
|
|
694
697
|
interface ListCollectionsRequest {
|
|
695
|
-
/** Maximum limit per response is 100, in first request cursor is None */
|
|
698
|
+
/** Maximum limit per response is 100, in first request cursor is None ? */
|
|
696
699
|
paging?: CursorPaging$4;
|
|
697
|
-
/**
|
|
700
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
698
701
|
includePageUrl?: boolean | null;
|
|
699
702
|
}
|
|
700
703
|
interface CursorPaging$4 {
|
|
@@ -709,9 +712,9 @@ interface CursorPaging$4 {
|
|
|
709
712
|
cursor?: string | null;
|
|
710
713
|
}
|
|
711
714
|
interface ListCollectionsResponse {
|
|
712
|
-
/**
|
|
715
|
+
/** List of collections. */
|
|
713
716
|
collections?: Collection[];
|
|
714
|
-
/** Paging metadata */
|
|
717
|
+
/** Paging metadata. */
|
|
715
718
|
metadata?: PagingMetadataV2$4;
|
|
716
719
|
}
|
|
717
720
|
interface PagingMetadataV2$4 {
|
|
@@ -733,25 +736,25 @@ interface Cursors$4 {
|
|
|
733
736
|
prev?: string | null;
|
|
734
737
|
}
|
|
735
738
|
interface UpdateCollectionRequest {
|
|
736
|
-
/** Collection to
|
|
739
|
+
/** Collection to update. */
|
|
737
740
|
collection: Collection;
|
|
738
741
|
}
|
|
739
742
|
interface UpdateCollectionResponse {
|
|
740
|
-
/**
|
|
743
|
+
/** Updated collection. */
|
|
741
744
|
collection?: Collection;
|
|
742
745
|
}
|
|
743
746
|
interface DeleteCollectionRequest {
|
|
744
|
-
/**
|
|
747
|
+
/** ID of the collection to delete. */
|
|
745
748
|
collectionId: string;
|
|
746
749
|
}
|
|
747
750
|
interface DeleteCollectionResponse {
|
|
748
|
-
/**
|
|
751
|
+
/** ID of the deleted collection. */
|
|
749
752
|
collectionId?: string;
|
|
750
753
|
}
|
|
751
754
|
interface QueryCollectionsRequest {
|
|
752
|
-
/**
|
|
755
|
+
/** Query options. */
|
|
753
756
|
query: QueryV2$3;
|
|
754
|
-
/**
|
|
757
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
755
758
|
includePageUrl?: boolean | null;
|
|
756
759
|
}
|
|
757
760
|
interface QueryV2$3 extends QueryV2PagingMethodOneOf$3 {
|
|
@@ -800,9 +803,9 @@ interface Paging$3 {
|
|
|
800
803
|
offset?: number | null;
|
|
801
804
|
}
|
|
802
805
|
interface QueryCollectionsResponse {
|
|
803
|
-
/**
|
|
806
|
+
/** List of collections. */
|
|
804
807
|
collections?: Collection[];
|
|
805
|
-
/** Paging metadata */
|
|
808
|
+
/** Paging metadata. */
|
|
806
809
|
metadata?: PagingMetadataV2$4;
|
|
807
810
|
}
|
|
808
811
|
interface MessageEnvelope$5 {
|
|
@@ -953,58 +956,62 @@ interface CollectionDeletedEnvelope {
|
|
|
953
956
|
metadata: EventMetadata$3;
|
|
954
957
|
}
|
|
955
958
|
interface GetCollectionOptions {
|
|
956
|
-
/**
|
|
959
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
957
960
|
includePageUrl?: boolean | null;
|
|
958
961
|
}
|
|
959
962
|
interface ListCollectionsOptions {
|
|
960
|
-
/** Maximum limit per response is 100, in first request cursor is None */
|
|
963
|
+
/** Maximum limit per response is 100, in first request cursor is None ? */
|
|
961
964
|
paging?: CursorPaging$4;
|
|
962
|
-
/**
|
|
965
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
963
966
|
includePageUrl?: boolean | null;
|
|
964
967
|
}
|
|
965
968
|
interface UpdateCollection {
|
|
966
969
|
/**
|
|
967
|
-
* Collection ID
|
|
970
|
+
* Collection ID.
|
|
968
971
|
* @readonly
|
|
969
972
|
*/
|
|
970
973
|
_id?: string | null;
|
|
971
974
|
/**
|
|
972
|
-
*
|
|
975
|
+
* Revision number, which increments by 1 each time the collection is updated. To prevent conflicting changes, the existing revision must be passed when updating the collection object.
|
|
973
976
|
* @readonly
|
|
974
977
|
*/
|
|
975
978
|
revision?: string | null;
|
|
976
|
-
/**
|
|
979
|
+
/** Collection title. */
|
|
977
980
|
title?: string | null;
|
|
978
|
-
/**
|
|
981
|
+
/** Collection description. */
|
|
979
982
|
description?: string | null;
|
|
980
|
-
/**
|
|
983
|
+
/** Collection slug. */
|
|
981
984
|
slug?: string | null;
|
|
982
|
-
/** Collection
|
|
985
|
+
/** Collection cover image. */
|
|
983
986
|
coverImage?: Image$3;
|
|
984
|
-
/**
|
|
987
|
+
/** Whether the collection is hidden from the portfolio. */
|
|
985
988
|
hidden?: boolean | null;
|
|
986
|
-
/**
|
|
989
|
+
/**
|
|
990
|
+
* Index that determines which position a media item is displayed in the gallery. <br />
|
|
991
|
+
*
|
|
992
|
+
* Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
|
|
993
|
+
*/
|
|
987
994
|
sortOrder?: number | null;
|
|
988
995
|
/**
|
|
989
|
-
*
|
|
996
|
+
* Date and time the collection was created.
|
|
990
997
|
* @readonly
|
|
991
998
|
*/
|
|
992
999
|
_createdDate?: Date;
|
|
993
1000
|
/**
|
|
994
|
-
*
|
|
1001
|
+
* Date and time the collection was updated.
|
|
995
1002
|
* @readonly
|
|
996
1003
|
*/
|
|
997
1004
|
_updatedDate?: Date;
|
|
998
1005
|
/**
|
|
999
|
-
*
|
|
1006
|
+
* Collection's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
|
|
1000
1007
|
* @readonly
|
|
1001
1008
|
*/
|
|
1002
1009
|
url?: string;
|
|
1003
|
-
/** SEO data
|
|
1010
|
+
/** Collection SEO data. */
|
|
1004
1011
|
seoData?: SeoSchema$2;
|
|
1005
1012
|
}
|
|
1006
1013
|
interface QueryCollectionsOptions {
|
|
1007
|
-
/**
|
|
1014
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
1008
1015
|
includePageUrl?: boolean | null | undefined;
|
|
1009
1016
|
}
|
|
1010
1017
|
interface QueryCursorResult$2 {
|
|
@@ -1088,50 +1095,54 @@ interface CollectionsQueryBuilder {
|
|
|
1088
1095
|
declare function createCollection$1(httpClient: HttpClient): CreateCollectionSignature;
|
|
1089
1096
|
interface CreateCollectionSignature {
|
|
1090
1097
|
/**
|
|
1091
|
-
* Creates a
|
|
1092
|
-
* @param - Collection to
|
|
1093
|
-
* @returns
|
|
1098
|
+
* Creates a collection.
|
|
1099
|
+
* @param - Collection to create.
|
|
1100
|
+
* @returns Created collection.
|
|
1094
1101
|
*/
|
|
1095
1102
|
(collection: Collection): Promise<Collection & CollectionNonNullableFields>;
|
|
1096
1103
|
}
|
|
1097
1104
|
declare function getCollection$1(httpClient: HttpClient): GetCollectionSignature;
|
|
1098
1105
|
interface GetCollectionSignature {
|
|
1099
1106
|
/**
|
|
1100
|
-
*
|
|
1101
|
-
* @param -
|
|
1102
|
-
* @returns The
|
|
1107
|
+
* Retrieves a collection.
|
|
1108
|
+
* @param - ID of the collection to retrieve.
|
|
1109
|
+
* @returns The requested collection.
|
|
1103
1110
|
*/
|
|
1104
1111
|
(collectionId: string, options?: GetCollectionOptions | undefined): Promise<Collection & CollectionNonNullableFields>;
|
|
1105
1112
|
}
|
|
1106
1113
|
declare function listCollections$1(httpClient: HttpClient): ListCollectionsSignature;
|
|
1107
1114
|
interface ListCollectionsSignature {
|
|
1108
1115
|
/**
|
|
1109
|
-
*
|
|
1116
|
+
* Retrieves a list all collections in a portfolio.
|
|
1110
1117
|
*/
|
|
1111
1118
|
(options?: ListCollectionsOptions | undefined): Promise<ListCollectionsResponse & ListCollectionsResponseNonNullableFields>;
|
|
1112
1119
|
}
|
|
1113
1120
|
declare function updateCollection$1(httpClient: HttpClient): UpdateCollectionSignature;
|
|
1114
1121
|
interface UpdateCollectionSignature {
|
|
1115
1122
|
/**
|
|
1116
|
-
*
|
|
1117
|
-
*
|
|
1118
|
-
* @
|
|
1119
|
-
* @returns The updated Collection
|
|
1123
|
+
* Updates a collection.
|
|
1124
|
+
* @param - Collection ID.
|
|
1125
|
+
* @returns Updated collection.
|
|
1120
1126
|
*/
|
|
1121
1127
|
(_id: string | null, collection: UpdateCollection): Promise<Collection & CollectionNonNullableFields>;
|
|
1122
1128
|
}
|
|
1123
1129
|
declare function deleteCollection$1(httpClient: HttpClient): DeleteCollectionSignature;
|
|
1124
1130
|
interface DeleteCollectionSignature {
|
|
1125
1131
|
/**
|
|
1126
|
-
*
|
|
1127
|
-
* @param -
|
|
1132
|
+
* Deletes a collection.
|
|
1133
|
+
* @param - ID of the collection to delete.
|
|
1128
1134
|
*/
|
|
1129
1135
|
(collectionId: string): Promise<DeleteCollectionResponse & DeleteCollectionResponseNonNullableFields>;
|
|
1130
1136
|
}
|
|
1131
1137
|
declare function queryCollections$1(httpClient: HttpClient): QueryCollectionsSignature;
|
|
1132
1138
|
interface QueryCollectionsSignature {
|
|
1133
1139
|
/**
|
|
1134
|
-
*
|
|
1140
|
+
* Retrieves a list of collections, given the provided paging, filtering, and sorting. Up to 100 collections can be returned per request.
|
|
1141
|
+
*
|
|
1142
|
+
* The default `sort` is `id` in `ASC`.
|
|
1143
|
+
*
|
|
1144
|
+
* For a detailed list of supported operations, see [Collections: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/portfolio/collections/sort-and-filter).
|
|
1145
|
+
* To learn how to query collections, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
|
|
1135
1146
|
*/
|
|
1136
1147
|
(options?: QueryCollectionsOptions | undefined): CollectionsQueryBuilder;
|
|
1137
1148
|
}
|
|
@@ -1167,15 +1178,21 @@ declare const deleteCollection: MaybeContext<BuildRESTFunction<typeof deleteColl
|
|
|
1167
1178
|
declare const queryCollections: MaybeContext<BuildRESTFunction<typeof queryCollections$1> & typeof queryCollections$1>;
|
|
1168
1179
|
|
|
1169
1180
|
type _publicOnCollectionCreatedType = typeof onCollectionCreated$1;
|
|
1170
|
-
/**
|
|
1181
|
+
/**
|
|
1182
|
+
* Triggered when a collection is created.
|
|
1183
|
+
*/
|
|
1171
1184
|
declare const onCollectionCreated: ReturnType<typeof createEventModule$3<_publicOnCollectionCreatedType>>;
|
|
1172
1185
|
|
|
1173
1186
|
type _publicOnCollectionUpdatedType = typeof onCollectionUpdated$1;
|
|
1174
|
-
/**
|
|
1187
|
+
/**
|
|
1188
|
+
* Triggered when a collection is updated.
|
|
1189
|
+
*/
|
|
1175
1190
|
declare const onCollectionUpdated: ReturnType<typeof createEventModule$3<_publicOnCollectionUpdatedType>>;
|
|
1176
1191
|
|
|
1177
1192
|
type _publicOnCollectionDeletedType = typeof onCollectionDeleted$1;
|
|
1178
|
-
/**
|
|
1193
|
+
/**
|
|
1194
|
+
* Triggered when a collection is deleted.
|
|
1195
|
+
*/
|
|
1179
1196
|
declare const onCollectionDeleted: ReturnType<typeof createEventModule$3<_publicOnCollectionDeletedType>>;
|
|
1180
1197
|
|
|
1181
1198
|
type context$5_AdminRemoveMenuItemsResponse = AdminRemoveMenuItemsResponse;
|
|
@@ -1534,7 +1551,7 @@ declare enum Type {
|
|
|
1534
1551
|
VIDEO = "VIDEO"
|
|
1535
1552
|
}
|
|
1536
1553
|
interface Image$2 {
|
|
1537
|
-
/**
|
|
1554
|
+
/** Information about the Wix Media image. */
|
|
1538
1555
|
imageInfo?: string;
|
|
1539
1556
|
/** Focal point of the image. */
|
|
1540
1557
|
focalPoint?: Point$2;
|
|
@@ -1569,7 +1586,7 @@ interface UnsharpMasking$2 {
|
|
|
1569
1586
|
threshold?: number | null;
|
|
1570
1587
|
}
|
|
1571
1588
|
interface Video$2 {
|
|
1572
|
-
/**
|
|
1589
|
+
/** Information about the Wix Media video. */
|
|
1573
1590
|
videoInfo?: string;
|
|
1574
1591
|
/** Manually defined Video duration in milliseconds. */
|
|
1575
1592
|
durationInMillis?: number | null;
|
|
@@ -2496,7 +2513,7 @@ interface ProjectCoverOneOf$1 {
|
|
|
2496
2513
|
coverVideo?: Video$1;
|
|
2497
2514
|
}
|
|
2498
2515
|
interface Image$1 {
|
|
2499
|
-
/**
|
|
2516
|
+
/** Information about the Wix Media image. */
|
|
2500
2517
|
imageInfo?: string;
|
|
2501
2518
|
/** Focal point of the image. */
|
|
2502
2519
|
focalPoint?: Point$1;
|
|
@@ -2531,7 +2548,7 @@ interface UnsharpMasking$1 {
|
|
|
2531
2548
|
threshold?: number | null;
|
|
2532
2549
|
}
|
|
2533
2550
|
interface Video$1 {
|
|
2534
|
-
/**
|
|
2551
|
+
/** Information about the Wix Media video. */
|
|
2535
2552
|
videoInfo?: string;
|
|
2536
2553
|
/** Manually defined Video duration in milliseconds. */
|
|
2537
2554
|
durationInMillis?: number | null;
|
|
@@ -3956,7 +3973,7 @@ interface ProjectCoverOneOf {
|
|
|
3956
3973
|
coverVideo?: Video;
|
|
3957
3974
|
}
|
|
3958
3975
|
interface Image {
|
|
3959
|
-
/**
|
|
3976
|
+
/** Information about the Wix Media image. */
|
|
3960
3977
|
imageInfo?: string;
|
|
3961
3978
|
/** Focal point of the image. */
|
|
3962
3979
|
focalPoint?: Point;
|
|
@@ -3991,7 +4008,7 @@ interface UnsharpMasking {
|
|
|
3991
4008
|
threshold?: number | null;
|
|
3992
4009
|
}
|
|
3993
4010
|
interface Video {
|
|
3994
|
-
/**
|
|
4011
|
+
/** Information about the Wix Media video. */
|
|
3995
4012
|
videoInfo?: string;
|
|
3996
4013
|
/** Manually defined Video duration in milliseconds. */
|
|
3997
4014
|
durationInMillis?: number | null;
|
|
@@ -408,50 +408,53 @@ type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
|
|
|
408
408
|
host: Host;
|
|
409
409
|
} ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
|
|
410
410
|
|
|
411
|
-
/** Collection is the main entity of CollectionsService */
|
|
412
411
|
interface Collection {
|
|
413
412
|
/**
|
|
414
|
-
* Collection ID
|
|
413
|
+
* Collection ID.
|
|
415
414
|
* @readonly
|
|
416
415
|
*/
|
|
417
416
|
_id?: string | null;
|
|
418
417
|
/**
|
|
419
|
-
*
|
|
418
|
+
* Revision number, which increments by 1 each time the collection is updated. To prevent conflicting changes, the existing revision must be passed when updating the collection object.
|
|
420
419
|
* @readonly
|
|
421
420
|
*/
|
|
422
421
|
revision?: string | null;
|
|
423
|
-
/**
|
|
422
|
+
/** Collection title. */
|
|
424
423
|
title?: string | null;
|
|
425
|
-
/**
|
|
424
|
+
/** Collection description. */
|
|
426
425
|
description?: string | null;
|
|
427
|
-
/**
|
|
426
|
+
/** Collection slug. */
|
|
428
427
|
slug?: string | null;
|
|
429
|
-
/** Collection
|
|
428
|
+
/** Collection cover image. */
|
|
430
429
|
coverImage?: Image$3;
|
|
431
|
-
/**
|
|
430
|
+
/** Whether the collection is hidden from the portfolio. */
|
|
432
431
|
hidden?: boolean | null;
|
|
433
|
-
/**
|
|
432
|
+
/**
|
|
433
|
+
* Index that determines which position a media item is displayed in the gallery. <br />
|
|
434
|
+
*
|
|
435
|
+
* Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
|
|
436
|
+
*/
|
|
434
437
|
sortOrder?: number | null;
|
|
435
438
|
/**
|
|
436
|
-
*
|
|
439
|
+
* Date and time the collection was created.
|
|
437
440
|
* @readonly
|
|
438
441
|
*/
|
|
439
442
|
_createdDate?: Date;
|
|
440
443
|
/**
|
|
441
|
-
*
|
|
444
|
+
* Date and time the collection was updated.
|
|
442
445
|
* @readonly
|
|
443
446
|
*/
|
|
444
447
|
_updatedDate?: Date;
|
|
445
448
|
/**
|
|
446
|
-
*
|
|
449
|
+
* Collection's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
|
|
447
450
|
* @readonly
|
|
448
451
|
*/
|
|
449
452
|
url?: string;
|
|
450
|
-
/** SEO data
|
|
453
|
+
/** Collection SEO data. */
|
|
451
454
|
seoData?: SeoSchema$2;
|
|
452
455
|
}
|
|
453
456
|
interface Image$3 {
|
|
454
|
-
/**
|
|
457
|
+
/** Information about the Wix Media image. */
|
|
455
458
|
imageInfo?: string;
|
|
456
459
|
/** Focal point of the image. */
|
|
457
460
|
focalPoint?: Point$3;
|
|
@@ -674,27 +677,27 @@ interface File$2 {
|
|
|
674
677
|
fileName?: string;
|
|
675
678
|
}
|
|
676
679
|
interface CreateCollectionRequest {
|
|
677
|
-
/** Collection to
|
|
680
|
+
/** Collection to create. */
|
|
678
681
|
collection: Collection;
|
|
679
682
|
}
|
|
680
683
|
interface CreateCollectionResponse {
|
|
681
|
-
/**
|
|
684
|
+
/** Created collection. */
|
|
682
685
|
collection?: Collection;
|
|
683
686
|
}
|
|
684
687
|
interface GetCollectionRequest {
|
|
685
|
-
/**
|
|
688
|
+
/** ID of the collection to retrieve. */
|
|
686
689
|
collectionId: string;
|
|
687
|
-
/**
|
|
690
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
688
691
|
includePageUrl?: boolean | null;
|
|
689
692
|
}
|
|
690
693
|
interface GetCollectionResponse {
|
|
691
|
-
/** The
|
|
694
|
+
/** The requested collection. */
|
|
692
695
|
collection?: Collection;
|
|
693
696
|
}
|
|
694
697
|
interface ListCollectionsRequest {
|
|
695
|
-
/** Maximum limit per response is 100, in first request cursor is None */
|
|
698
|
+
/** Maximum limit per response is 100, in first request cursor is None ? */
|
|
696
699
|
paging?: CursorPaging$4;
|
|
697
|
-
/**
|
|
700
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
698
701
|
includePageUrl?: boolean | null;
|
|
699
702
|
}
|
|
700
703
|
interface CursorPaging$4 {
|
|
@@ -709,9 +712,9 @@ interface CursorPaging$4 {
|
|
|
709
712
|
cursor?: string | null;
|
|
710
713
|
}
|
|
711
714
|
interface ListCollectionsResponse {
|
|
712
|
-
/**
|
|
715
|
+
/** List of collections. */
|
|
713
716
|
collections?: Collection[];
|
|
714
|
-
/** Paging metadata */
|
|
717
|
+
/** Paging metadata. */
|
|
715
718
|
metadata?: PagingMetadataV2$4;
|
|
716
719
|
}
|
|
717
720
|
interface PagingMetadataV2$4 {
|
|
@@ -733,25 +736,25 @@ interface Cursors$4 {
|
|
|
733
736
|
prev?: string | null;
|
|
734
737
|
}
|
|
735
738
|
interface UpdateCollectionRequest {
|
|
736
|
-
/** Collection to
|
|
739
|
+
/** Collection to update. */
|
|
737
740
|
collection: Collection;
|
|
738
741
|
}
|
|
739
742
|
interface UpdateCollectionResponse {
|
|
740
|
-
/**
|
|
743
|
+
/** Updated collection. */
|
|
741
744
|
collection?: Collection;
|
|
742
745
|
}
|
|
743
746
|
interface DeleteCollectionRequest {
|
|
744
|
-
/**
|
|
747
|
+
/** ID of the collection to delete. */
|
|
745
748
|
collectionId: string;
|
|
746
749
|
}
|
|
747
750
|
interface DeleteCollectionResponse {
|
|
748
|
-
/**
|
|
751
|
+
/** ID of the deleted collection. */
|
|
749
752
|
collectionId?: string;
|
|
750
753
|
}
|
|
751
754
|
interface QueryCollectionsRequest {
|
|
752
|
-
/**
|
|
755
|
+
/** Query options. */
|
|
753
756
|
query: QueryV2$3;
|
|
754
|
-
/**
|
|
757
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
755
758
|
includePageUrl?: boolean | null;
|
|
756
759
|
}
|
|
757
760
|
interface QueryV2$3 extends QueryV2PagingMethodOneOf$3 {
|
|
@@ -800,9 +803,9 @@ interface Paging$3 {
|
|
|
800
803
|
offset?: number | null;
|
|
801
804
|
}
|
|
802
805
|
interface QueryCollectionsResponse {
|
|
803
|
-
/**
|
|
806
|
+
/** List of collections. */
|
|
804
807
|
collections?: Collection[];
|
|
805
|
-
/** Paging metadata */
|
|
808
|
+
/** Paging metadata. */
|
|
806
809
|
metadata?: PagingMetadataV2$4;
|
|
807
810
|
}
|
|
808
811
|
interface MessageEnvelope$5 {
|
|
@@ -953,58 +956,62 @@ interface CollectionDeletedEnvelope {
|
|
|
953
956
|
metadata: EventMetadata$3;
|
|
954
957
|
}
|
|
955
958
|
interface GetCollectionOptions {
|
|
956
|
-
/**
|
|
959
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
957
960
|
includePageUrl?: boolean | null;
|
|
958
961
|
}
|
|
959
962
|
interface ListCollectionsOptions {
|
|
960
|
-
/** Maximum limit per response is 100, in first request cursor is None */
|
|
963
|
+
/** Maximum limit per response is 100, in first request cursor is None ? */
|
|
961
964
|
paging?: CursorPaging$4;
|
|
962
|
-
/**
|
|
965
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
963
966
|
includePageUrl?: boolean | null;
|
|
964
967
|
}
|
|
965
968
|
interface UpdateCollection {
|
|
966
969
|
/**
|
|
967
|
-
* Collection ID
|
|
970
|
+
* Collection ID.
|
|
968
971
|
* @readonly
|
|
969
972
|
*/
|
|
970
973
|
_id?: string | null;
|
|
971
974
|
/**
|
|
972
|
-
*
|
|
975
|
+
* Revision number, which increments by 1 each time the collection is updated. To prevent conflicting changes, the existing revision must be passed when updating the collection object.
|
|
973
976
|
* @readonly
|
|
974
977
|
*/
|
|
975
978
|
revision?: string | null;
|
|
976
|
-
/**
|
|
979
|
+
/** Collection title. */
|
|
977
980
|
title?: string | null;
|
|
978
|
-
/**
|
|
981
|
+
/** Collection description. */
|
|
979
982
|
description?: string | null;
|
|
980
|
-
/**
|
|
983
|
+
/** Collection slug. */
|
|
981
984
|
slug?: string | null;
|
|
982
|
-
/** Collection
|
|
985
|
+
/** Collection cover image. */
|
|
983
986
|
coverImage?: Image$3;
|
|
984
|
-
/**
|
|
987
|
+
/** Whether the collection is hidden from the portfolio. */
|
|
985
988
|
hidden?: boolean | null;
|
|
986
|
-
/**
|
|
989
|
+
/**
|
|
990
|
+
* Index that determines which position a media item is displayed in the gallery. <br />
|
|
991
|
+
*
|
|
992
|
+
* Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
|
|
993
|
+
*/
|
|
987
994
|
sortOrder?: number | null;
|
|
988
995
|
/**
|
|
989
|
-
*
|
|
996
|
+
* Date and time the collection was created.
|
|
990
997
|
* @readonly
|
|
991
998
|
*/
|
|
992
999
|
_createdDate?: Date;
|
|
993
1000
|
/**
|
|
994
|
-
*
|
|
1001
|
+
* Date and time the collection was updated.
|
|
995
1002
|
* @readonly
|
|
996
1003
|
*/
|
|
997
1004
|
_updatedDate?: Date;
|
|
998
1005
|
/**
|
|
999
|
-
*
|
|
1006
|
+
* Collection's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
|
|
1000
1007
|
* @readonly
|
|
1001
1008
|
*/
|
|
1002
1009
|
url?: string;
|
|
1003
|
-
/** SEO data
|
|
1010
|
+
/** Collection SEO data. */
|
|
1004
1011
|
seoData?: SeoSchema$2;
|
|
1005
1012
|
}
|
|
1006
1013
|
interface QueryCollectionsOptions {
|
|
1007
|
-
/**
|
|
1014
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
1008
1015
|
includePageUrl?: boolean | null | undefined;
|
|
1009
1016
|
}
|
|
1010
1017
|
interface QueryCursorResult$2 {
|
|
@@ -1088,50 +1095,54 @@ interface CollectionsQueryBuilder {
|
|
|
1088
1095
|
declare function createCollection$1(httpClient: HttpClient): CreateCollectionSignature;
|
|
1089
1096
|
interface CreateCollectionSignature {
|
|
1090
1097
|
/**
|
|
1091
|
-
* Creates a
|
|
1092
|
-
* @param - Collection to
|
|
1093
|
-
* @returns
|
|
1098
|
+
* Creates a collection.
|
|
1099
|
+
* @param - Collection to create.
|
|
1100
|
+
* @returns Created collection.
|
|
1094
1101
|
*/
|
|
1095
1102
|
(collection: Collection): Promise<Collection & CollectionNonNullableFields>;
|
|
1096
1103
|
}
|
|
1097
1104
|
declare function getCollection$1(httpClient: HttpClient): GetCollectionSignature;
|
|
1098
1105
|
interface GetCollectionSignature {
|
|
1099
1106
|
/**
|
|
1100
|
-
*
|
|
1101
|
-
* @param -
|
|
1102
|
-
* @returns The
|
|
1107
|
+
* Retrieves a collection.
|
|
1108
|
+
* @param - ID of the collection to retrieve.
|
|
1109
|
+
* @returns The requested collection.
|
|
1103
1110
|
*/
|
|
1104
1111
|
(collectionId: string, options?: GetCollectionOptions | undefined): Promise<Collection & CollectionNonNullableFields>;
|
|
1105
1112
|
}
|
|
1106
1113
|
declare function listCollections$1(httpClient: HttpClient): ListCollectionsSignature;
|
|
1107
1114
|
interface ListCollectionsSignature {
|
|
1108
1115
|
/**
|
|
1109
|
-
*
|
|
1116
|
+
* Retrieves a list all collections in a portfolio.
|
|
1110
1117
|
*/
|
|
1111
1118
|
(options?: ListCollectionsOptions | undefined): Promise<ListCollectionsResponse & ListCollectionsResponseNonNullableFields>;
|
|
1112
1119
|
}
|
|
1113
1120
|
declare function updateCollection$1(httpClient: HttpClient): UpdateCollectionSignature;
|
|
1114
1121
|
interface UpdateCollectionSignature {
|
|
1115
1122
|
/**
|
|
1116
|
-
*
|
|
1117
|
-
*
|
|
1118
|
-
* @
|
|
1119
|
-
* @returns The updated Collection
|
|
1123
|
+
* Updates a collection.
|
|
1124
|
+
* @param - Collection ID.
|
|
1125
|
+
* @returns Updated collection.
|
|
1120
1126
|
*/
|
|
1121
1127
|
(_id: string | null, collection: UpdateCollection): Promise<Collection & CollectionNonNullableFields>;
|
|
1122
1128
|
}
|
|
1123
1129
|
declare function deleteCollection$1(httpClient: HttpClient): DeleteCollectionSignature;
|
|
1124
1130
|
interface DeleteCollectionSignature {
|
|
1125
1131
|
/**
|
|
1126
|
-
*
|
|
1127
|
-
* @param -
|
|
1132
|
+
* Deletes a collection.
|
|
1133
|
+
* @param - ID of the collection to delete.
|
|
1128
1134
|
*/
|
|
1129
1135
|
(collectionId: string): Promise<DeleteCollectionResponse & DeleteCollectionResponseNonNullableFields>;
|
|
1130
1136
|
}
|
|
1131
1137
|
declare function queryCollections$1(httpClient: HttpClient): QueryCollectionsSignature;
|
|
1132
1138
|
interface QueryCollectionsSignature {
|
|
1133
1139
|
/**
|
|
1134
|
-
*
|
|
1140
|
+
* Retrieves a list of collections, given the provided paging, filtering, and sorting. Up to 100 collections can be returned per request.
|
|
1141
|
+
*
|
|
1142
|
+
* The default `sort` is `id` in `ASC`.
|
|
1143
|
+
*
|
|
1144
|
+
* For a detailed list of supported operations, see [Collections: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/portfolio/collections/sort-and-filter).
|
|
1145
|
+
* To learn how to query collections, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
|
|
1135
1146
|
*/
|
|
1136
1147
|
(options?: QueryCollectionsOptions | undefined): CollectionsQueryBuilder;
|
|
1137
1148
|
}
|
|
@@ -1167,15 +1178,21 @@ declare const deleteCollection: MaybeContext<BuildRESTFunction<typeof deleteColl
|
|
|
1167
1178
|
declare const queryCollections: MaybeContext<BuildRESTFunction<typeof queryCollections$1> & typeof queryCollections$1>;
|
|
1168
1179
|
|
|
1169
1180
|
type _publicOnCollectionCreatedType = typeof onCollectionCreated$1;
|
|
1170
|
-
/**
|
|
1181
|
+
/**
|
|
1182
|
+
* Triggered when a collection is created.
|
|
1183
|
+
*/
|
|
1171
1184
|
declare const onCollectionCreated: ReturnType<typeof createEventModule$3<_publicOnCollectionCreatedType>>;
|
|
1172
1185
|
|
|
1173
1186
|
type _publicOnCollectionUpdatedType = typeof onCollectionUpdated$1;
|
|
1174
|
-
/**
|
|
1187
|
+
/**
|
|
1188
|
+
* Triggered when a collection is updated.
|
|
1189
|
+
*/
|
|
1175
1190
|
declare const onCollectionUpdated: ReturnType<typeof createEventModule$3<_publicOnCollectionUpdatedType>>;
|
|
1176
1191
|
|
|
1177
1192
|
type _publicOnCollectionDeletedType = typeof onCollectionDeleted$1;
|
|
1178
|
-
/**
|
|
1193
|
+
/**
|
|
1194
|
+
* Triggered when a collection is deleted.
|
|
1195
|
+
*/
|
|
1179
1196
|
declare const onCollectionDeleted: ReturnType<typeof createEventModule$3<_publicOnCollectionDeletedType>>;
|
|
1180
1197
|
|
|
1181
1198
|
type index_d$5_AdminRemoveMenuItemsResponse = AdminRemoveMenuItemsResponse;
|
|
@@ -1534,7 +1551,7 @@ declare enum Type {
|
|
|
1534
1551
|
VIDEO = "VIDEO"
|
|
1535
1552
|
}
|
|
1536
1553
|
interface Image$2 {
|
|
1537
|
-
/**
|
|
1554
|
+
/** Information about the Wix Media image. */
|
|
1538
1555
|
imageInfo?: string;
|
|
1539
1556
|
/** Focal point of the image. */
|
|
1540
1557
|
focalPoint?: Point$2;
|
|
@@ -1569,7 +1586,7 @@ interface UnsharpMasking$2 {
|
|
|
1569
1586
|
threshold?: number | null;
|
|
1570
1587
|
}
|
|
1571
1588
|
interface Video$2 {
|
|
1572
|
-
/**
|
|
1589
|
+
/** Information about the Wix Media video. */
|
|
1573
1590
|
videoInfo?: string;
|
|
1574
1591
|
/** Manually defined Video duration in milliseconds. */
|
|
1575
1592
|
durationInMillis?: number | null;
|
|
@@ -2496,7 +2513,7 @@ interface ProjectCoverOneOf$1 {
|
|
|
2496
2513
|
coverVideo?: Video$1;
|
|
2497
2514
|
}
|
|
2498
2515
|
interface Image$1 {
|
|
2499
|
-
/**
|
|
2516
|
+
/** Information about the Wix Media image. */
|
|
2500
2517
|
imageInfo?: string;
|
|
2501
2518
|
/** Focal point of the image. */
|
|
2502
2519
|
focalPoint?: Point$1;
|
|
@@ -2531,7 +2548,7 @@ interface UnsharpMasking$1 {
|
|
|
2531
2548
|
threshold?: number | null;
|
|
2532
2549
|
}
|
|
2533
2550
|
interface Video$1 {
|
|
2534
|
-
/**
|
|
2551
|
+
/** Information about the Wix Media video. */
|
|
2535
2552
|
videoInfo?: string;
|
|
2536
2553
|
/** Manually defined Video duration in milliseconds. */
|
|
2537
2554
|
durationInMillis?: number | null;
|
|
@@ -3956,7 +3973,7 @@ interface ProjectCoverOneOf {
|
|
|
3956
3973
|
coverVideo?: Video;
|
|
3957
3974
|
}
|
|
3958
3975
|
interface Image {
|
|
3959
|
-
/**
|
|
3976
|
+
/** Information about the Wix Media image. */
|
|
3960
3977
|
imageInfo?: string;
|
|
3961
3978
|
/** Focal point of the image. */
|
|
3962
3979
|
focalPoint?: Point;
|
|
@@ -3991,7 +4008,7 @@ interface UnsharpMasking {
|
|
|
3991
4008
|
threshold?: number | null;
|
|
3992
4009
|
}
|
|
3993
4010
|
interface Video {
|
|
3994
|
-
/**
|
|
4011
|
+
/** Information about the Wix Media video. */
|
|
3995
4012
|
videoInfo?: string;
|
|
3996
4013
|
/** Manually defined Video duration in milliseconds. */
|
|
3997
4014
|
durationInMillis?: number | null;
|
|
@@ -1,47 +1,50 @@
|
|
|
1
|
-
/** Collection is the main entity of CollectionsService */
|
|
2
1
|
interface Collection$1 {
|
|
3
2
|
/**
|
|
4
|
-
* Collection ID
|
|
3
|
+
* Collection ID.
|
|
5
4
|
* @readonly
|
|
6
5
|
*/
|
|
7
6
|
id?: string | null;
|
|
8
7
|
/**
|
|
9
|
-
*
|
|
8
|
+
* Revision number, which increments by 1 each time the collection is updated. To prevent conflicting changes, the existing revision must be passed when updating the collection object.
|
|
10
9
|
* @readonly
|
|
11
10
|
*/
|
|
12
11
|
revision?: string | null;
|
|
13
|
-
/**
|
|
12
|
+
/** Collection title. */
|
|
14
13
|
title?: string | null;
|
|
15
|
-
/**
|
|
14
|
+
/** Collection description. */
|
|
16
15
|
description?: string | null;
|
|
17
|
-
/**
|
|
16
|
+
/** Collection slug. */
|
|
18
17
|
slug?: string | null;
|
|
19
|
-
/** Collection
|
|
18
|
+
/** Collection cover image. */
|
|
20
19
|
coverImage?: Image$7;
|
|
21
|
-
/**
|
|
20
|
+
/** Whether the collection is hidden from the portfolio. */
|
|
22
21
|
hidden?: boolean | null;
|
|
23
|
-
/**
|
|
22
|
+
/**
|
|
23
|
+
* Index that determines which position a media item is displayed in the gallery. <br />
|
|
24
|
+
*
|
|
25
|
+
* Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
|
|
26
|
+
*/
|
|
24
27
|
sortOrder?: number | null;
|
|
25
28
|
/**
|
|
26
|
-
*
|
|
29
|
+
* Date and time the collection was created.
|
|
27
30
|
* @readonly
|
|
28
31
|
*/
|
|
29
32
|
createdDate?: Date;
|
|
30
33
|
/**
|
|
31
|
-
*
|
|
34
|
+
* Date and time the collection was updated.
|
|
32
35
|
* @readonly
|
|
33
36
|
*/
|
|
34
37
|
updatedDate?: Date;
|
|
35
38
|
/**
|
|
36
|
-
*
|
|
39
|
+
* Collection's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
|
|
37
40
|
* @readonly
|
|
38
41
|
*/
|
|
39
42
|
url?: PageUrlV2$2;
|
|
40
|
-
/** SEO data
|
|
43
|
+
/** Collection SEO data. */
|
|
41
44
|
seoData?: SeoSchema$5;
|
|
42
45
|
}
|
|
43
46
|
interface Image$7 {
|
|
44
|
-
/**
|
|
47
|
+
/** Information about the Wix Media image. */
|
|
45
48
|
imageInfo?: CommonImage$3;
|
|
46
49
|
/** Focal point of the image. */
|
|
47
50
|
focalPoint?: Point$7;
|
|
@@ -133,27 +136,27 @@ interface Settings$5 {
|
|
|
133
136
|
keywords?: Keyword$5[];
|
|
134
137
|
}
|
|
135
138
|
interface CreateCollectionRequest$1 {
|
|
136
|
-
/** Collection to
|
|
139
|
+
/** Collection to create. */
|
|
137
140
|
collection: Collection$1;
|
|
138
141
|
}
|
|
139
142
|
interface CreateCollectionResponse$1 {
|
|
140
|
-
/**
|
|
143
|
+
/** Created collection. */
|
|
141
144
|
collection?: Collection$1;
|
|
142
145
|
}
|
|
143
146
|
interface GetCollectionRequest$1 {
|
|
144
|
-
/**
|
|
147
|
+
/** ID of the collection to retrieve. */
|
|
145
148
|
collectionId: string;
|
|
146
|
-
/**
|
|
149
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
147
150
|
includePageUrl?: boolean | null;
|
|
148
151
|
}
|
|
149
152
|
interface GetCollectionResponse$1 {
|
|
150
|
-
/** The
|
|
153
|
+
/** The requested collection. */
|
|
151
154
|
collection?: Collection$1;
|
|
152
155
|
}
|
|
153
156
|
interface ListCollectionsRequest$1 {
|
|
154
|
-
/** Maximum limit per response is 100, in first request cursor is None */
|
|
157
|
+
/** Maximum limit per response is 100, in first request cursor is None ? */
|
|
155
158
|
paging?: CursorPaging$7;
|
|
156
|
-
/**
|
|
159
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
157
160
|
includePageUrl?: boolean | null;
|
|
158
161
|
}
|
|
159
162
|
interface CursorPaging$7 {
|
|
@@ -168,9 +171,9 @@ interface CursorPaging$7 {
|
|
|
168
171
|
cursor?: string | null;
|
|
169
172
|
}
|
|
170
173
|
interface ListCollectionsResponse$1 {
|
|
171
|
-
/**
|
|
174
|
+
/** List of collections. */
|
|
172
175
|
collections?: Collection$1[];
|
|
173
|
-
/** Paging metadata */
|
|
176
|
+
/** Paging metadata. */
|
|
174
177
|
metadata?: PagingMetadataV2$9;
|
|
175
178
|
}
|
|
176
179
|
interface PagingMetadataV2$9 {
|
|
@@ -192,25 +195,25 @@ interface Cursors$9 {
|
|
|
192
195
|
prev?: string | null;
|
|
193
196
|
}
|
|
194
197
|
interface UpdateCollectionRequest$1 {
|
|
195
|
-
/** Collection to
|
|
198
|
+
/** Collection to update. */
|
|
196
199
|
collection: Collection$1;
|
|
197
200
|
}
|
|
198
201
|
interface UpdateCollectionResponse$1 {
|
|
199
|
-
/**
|
|
202
|
+
/** Updated collection. */
|
|
200
203
|
collection?: Collection$1;
|
|
201
204
|
}
|
|
202
205
|
interface DeleteCollectionRequest$1 {
|
|
203
|
-
/**
|
|
206
|
+
/** ID of the collection to delete. */
|
|
204
207
|
collectionId: string;
|
|
205
208
|
}
|
|
206
209
|
interface DeleteCollectionResponse$1 {
|
|
207
|
-
/**
|
|
210
|
+
/** ID of the deleted collection. */
|
|
208
211
|
collectionId?: string;
|
|
209
212
|
}
|
|
210
213
|
interface QueryCollectionsRequest$1 {
|
|
211
|
-
/**
|
|
214
|
+
/** Query options. */
|
|
212
215
|
query: QueryV2$5;
|
|
213
|
-
/**
|
|
216
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
214
217
|
includePageUrl?: boolean | null;
|
|
215
218
|
}
|
|
216
219
|
interface QueryV2$5 extends QueryV2PagingMethodOneOf$5 {
|
|
@@ -259,9 +262,9 @@ interface Paging$7 {
|
|
|
259
262
|
offset?: number | null;
|
|
260
263
|
}
|
|
261
264
|
interface QueryCollectionsResponse$1 {
|
|
262
|
-
/**
|
|
265
|
+
/** List of collections. */
|
|
263
266
|
collections?: Collection$1[];
|
|
264
|
-
/** Paging metadata */
|
|
267
|
+
/** Paging metadata. */
|
|
265
268
|
metadata?: PagingMetadataV2$9;
|
|
266
269
|
}
|
|
267
270
|
interface CommonImageNonNullableFields$3 {
|
|
@@ -324,50 +327,53 @@ interface QueryCollectionsResponseNonNullableFields$1 {
|
|
|
324
327
|
collections: CollectionNonNullableFields$1[];
|
|
325
328
|
}
|
|
326
329
|
|
|
327
|
-
/** Collection is the main entity of CollectionsService */
|
|
328
330
|
interface Collection {
|
|
329
331
|
/**
|
|
330
|
-
* Collection ID
|
|
332
|
+
* Collection ID.
|
|
331
333
|
* @readonly
|
|
332
334
|
*/
|
|
333
335
|
_id?: string | null;
|
|
334
336
|
/**
|
|
335
|
-
*
|
|
337
|
+
* Revision number, which increments by 1 each time the collection is updated. To prevent conflicting changes, the existing revision must be passed when updating the collection object.
|
|
336
338
|
* @readonly
|
|
337
339
|
*/
|
|
338
340
|
revision?: string | null;
|
|
339
|
-
/**
|
|
341
|
+
/** Collection title. */
|
|
340
342
|
title?: string | null;
|
|
341
|
-
/**
|
|
343
|
+
/** Collection description. */
|
|
342
344
|
description?: string | null;
|
|
343
|
-
/**
|
|
345
|
+
/** Collection slug. */
|
|
344
346
|
slug?: string | null;
|
|
345
|
-
/** Collection
|
|
347
|
+
/** Collection cover image. */
|
|
346
348
|
coverImage?: Image$6;
|
|
347
|
-
/**
|
|
349
|
+
/** Whether the collection is hidden from the portfolio. */
|
|
348
350
|
hidden?: boolean | null;
|
|
349
|
-
/**
|
|
351
|
+
/**
|
|
352
|
+
* Index that determines which position a media item is displayed in the gallery. <br />
|
|
353
|
+
*
|
|
354
|
+
* Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
|
|
355
|
+
*/
|
|
350
356
|
sortOrder?: number | null;
|
|
351
357
|
/**
|
|
352
|
-
*
|
|
358
|
+
* Date and time the collection was created.
|
|
353
359
|
* @readonly
|
|
354
360
|
*/
|
|
355
361
|
_createdDate?: Date;
|
|
356
362
|
/**
|
|
357
|
-
*
|
|
363
|
+
* Date and time the collection was updated.
|
|
358
364
|
* @readonly
|
|
359
365
|
*/
|
|
360
366
|
_updatedDate?: Date;
|
|
361
367
|
/**
|
|
362
|
-
*
|
|
368
|
+
* Collection's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
|
|
363
369
|
* @readonly
|
|
364
370
|
*/
|
|
365
371
|
url?: string;
|
|
366
|
-
/** SEO data
|
|
372
|
+
/** Collection SEO data. */
|
|
367
373
|
seoData?: SeoSchema$4;
|
|
368
374
|
}
|
|
369
375
|
interface Image$6 {
|
|
370
|
-
/**
|
|
376
|
+
/** Information about the Wix Media image. */
|
|
371
377
|
imageInfo?: string;
|
|
372
378
|
/** Focal point of the image. */
|
|
373
379
|
focalPoint?: Point$6;
|
|
@@ -436,27 +442,27 @@ interface Settings$4 {
|
|
|
436
442
|
keywords?: Keyword$4[];
|
|
437
443
|
}
|
|
438
444
|
interface CreateCollectionRequest {
|
|
439
|
-
/** Collection to
|
|
445
|
+
/** Collection to create. */
|
|
440
446
|
collection: Collection;
|
|
441
447
|
}
|
|
442
448
|
interface CreateCollectionResponse {
|
|
443
|
-
/**
|
|
449
|
+
/** Created collection. */
|
|
444
450
|
collection?: Collection;
|
|
445
451
|
}
|
|
446
452
|
interface GetCollectionRequest {
|
|
447
|
-
/**
|
|
453
|
+
/** ID of the collection to retrieve. */
|
|
448
454
|
collectionId: string;
|
|
449
|
-
/**
|
|
455
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
450
456
|
includePageUrl?: boolean | null;
|
|
451
457
|
}
|
|
452
458
|
interface GetCollectionResponse {
|
|
453
|
-
/** The
|
|
459
|
+
/** The requested collection. */
|
|
454
460
|
collection?: Collection;
|
|
455
461
|
}
|
|
456
462
|
interface ListCollectionsRequest {
|
|
457
|
-
/** Maximum limit per response is 100, in first request cursor is None */
|
|
463
|
+
/** Maximum limit per response is 100, in first request cursor is None ? */
|
|
458
464
|
paging?: CursorPaging$6;
|
|
459
|
-
/**
|
|
465
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
460
466
|
includePageUrl?: boolean | null;
|
|
461
467
|
}
|
|
462
468
|
interface CursorPaging$6 {
|
|
@@ -471,9 +477,9 @@ interface CursorPaging$6 {
|
|
|
471
477
|
cursor?: string | null;
|
|
472
478
|
}
|
|
473
479
|
interface ListCollectionsResponse {
|
|
474
|
-
/**
|
|
480
|
+
/** List of collections. */
|
|
475
481
|
collections?: Collection[];
|
|
476
|
-
/** Paging metadata */
|
|
482
|
+
/** Paging metadata. */
|
|
477
483
|
metadata?: PagingMetadataV2$8;
|
|
478
484
|
}
|
|
479
485
|
interface PagingMetadataV2$8 {
|
|
@@ -495,25 +501,25 @@ interface Cursors$8 {
|
|
|
495
501
|
prev?: string | null;
|
|
496
502
|
}
|
|
497
503
|
interface UpdateCollectionRequest {
|
|
498
|
-
/** Collection to
|
|
504
|
+
/** Collection to update. */
|
|
499
505
|
collection: Collection;
|
|
500
506
|
}
|
|
501
507
|
interface UpdateCollectionResponse {
|
|
502
|
-
/**
|
|
508
|
+
/** Updated collection. */
|
|
503
509
|
collection?: Collection;
|
|
504
510
|
}
|
|
505
511
|
interface DeleteCollectionRequest {
|
|
506
|
-
/**
|
|
512
|
+
/** ID of the collection to delete. */
|
|
507
513
|
collectionId: string;
|
|
508
514
|
}
|
|
509
515
|
interface DeleteCollectionResponse {
|
|
510
|
-
/**
|
|
516
|
+
/** ID of the deleted collection. */
|
|
511
517
|
collectionId?: string;
|
|
512
518
|
}
|
|
513
519
|
interface QueryCollectionsRequest {
|
|
514
|
-
/**
|
|
520
|
+
/** Query options. */
|
|
515
521
|
query: QueryV2$4;
|
|
516
|
-
/**
|
|
522
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
517
523
|
includePageUrl?: boolean | null;
|
|
518
524
|
}
|
|
519
525
|
interface QueryV2$4 extends QueryV2PagingMethodOneOf$4 {
|
|
@@ -562,9 +568,9 @@ interface Paging$6 {
|
|
|
562
568
|
offset?: number | null;
|
|
563
569
|
}
|
|
564
570
|
interface QueryCollectionsResponse {
|
|
565
|
-
/**
|
|
571
|
+
/** List of collections. */
|
|
566
572
|
collections?: Collection[];
|
|
567
|
-
/** Paging metadata */
|
|
573
|
+
/** Paging metadata. */
|
|
568
574
|
metadata?: PagingMetadataV2$8;
|
|
569
575
|
}
|
|
570
576
|
interface PointNonNullableFields$6 {
|
|
@@ -895,7 +901,7 @@ declare enum Type$1 {
|
|
|
895
901
|
VIDEO = "VIDEO"
|
|
896
902
|
}
|
|
897
903
|
interface Image$5 {
|
|
898
|
-
/**
|
|
904
|
+
/** Information about the Wix Media image. */
|
|
899
905
|
imageInfo?: CommonImage$2;
|
|
900
906
|
/** Focal point of the image. */
|
|
901
907
|
focalPoint?: Point$5;
|
|
@@ -929,7 +935,7 @@ interface Point$5 {
|
|
|
929
935
|
y?: number;
|
|
930
936
|
}
|
|
931
937
|
interface Video$5 {
|
|
932
|
-
/**
|
|
938
|
+
/** Information about the Wix Media video. */
|
|
933
939
|
videoInfo?: VideoV2$2;
|
|
934
940
|
/** Manually defined Video duration in milliseconds. */
|
|
935
941
|
durationInMillis?: number | null;
|
|
@@ -1308,7 +1314,7 @@ declare enum Type {
|
|
|
1308
1314
|
VIDEO = "VIDEO"
|
|
1309
1315
|
}
|
|
1310
1316
|
interface Image$4 {
|
|
1311
|
-
/**
|
|
1317
|
+
/** Information about the Wix Media image. */
|
|
1312
1318
|
imageInfo?: string;
|
|
1313
1319
|
/** Focal point of the image. */
|
|
1314
1320
|
focalPoint?: Point$4;
|
|
@@ -1325,7 +1331,7 @@ interface Point$4 {
|
|
|
1325
1331
|
y?: number;
|
|
1326
1332
|
}
|
|
1327
1333
|
interface Video$4 {
|
|
1328
|
-
/**
|
|
1334
|
+
/** Information about the Wix Media video. */
|
|
1329
1335
|
videoInfo?: string;
|
|
1330
1336
|
/** Manually defined Video duration in milliseconds. */
|
|
1331
1337
|
durationInMillis?: number | null;
|
|
@@ -1691,7 +1697,7 @@ interface ProjectCoverOneOf$3 {
|
|
|
1691
1697
|
coverVideo?: Video$3;
|
|
1692
1698
|
}
|
|
1693
1699
|
interface Image$3 {
|
|
1694
|
-
/**
|
|
1700
|
+
/** Information about the Wix Media image. */
|
|
1695
1701
|
imageInfo?: CommonImage$1;
|
|
1696
1702
|
/** Focal point of the image. */
|
|
1697
1703
|
focalPoint?: Point$3;
|
|
@@ -1725,7 +1731,7 @@ interface Point$3 {
|
|
|
1725
1731
|
y?: number;
|
|
1726
1732
|
}
|
|
1727
1733
|
interface Video$3 {
|
|
1728
|
-
/**
|
|
1734
|
+
/** Information about the Wix Media video. */
|
|
1729
1735
|
videoInfo?: VideoV2$1;
|
|
1730
1736
|
/** Manually defined Video duration in milliseconds. */
|
|
1731
1737
|
durationInMillis?: number | null;
|
|
@@ -2259,7 +2265,7 @@ interface ProjectCoverOneOf$2 {
|
|
|
2259
2265
|
coverVideo?: Video$2;
|
|
2260
2266
|
}
|
|
2261
2267
|
interface Image$2 {
|
|
2262
|
-
/**
|
|
2268
|
+
/** Information about the Wix Media image. */
|
|
2263
2269
|
imageInfo?: string;
|
|
2264
2270
|
/** Focal point of the image. */
|
|
2265
2271
|
focalPoint?: Point$2;
|
|
@@ -2276,7 +2282,7 @@ interface Point$2 {
|
|
|
2276
2282
|
y?: number;
|
|
2277
2283
|
}
|
|
2278
2284
|
interface Video$2 {
|
|
2279
|
-
/**
|
|
2285
|
+
/** Information about the Wix Media video. */
|
|
2280
2286
|
videoInfo?: string;
|
|
2281
2287
|
/** Manually defined Video duration in milliseconds. */
|
|
2282
2288
|
durationInMillis?: number | null;
|
|
@@ -2810,7 +2816,7 @@ interface ProjectCoverOneOf$1 {
|
|
|
2810
2816
|
coverVideo?: Video$1;
|
|
2811
2817
|
}
|
|
2812
2818
|
interface Image$1 {
|
|
2813
|
-
/**
|
|
2819
|
+
/** Information about the Wix Media image. */
|
|
2814
2820
|
imageInfo?: CommonImage;
|
|
2815
2821
|
/** Focal point of the image. */
|
|
2816
2822
|
focalPoint?: Point$1;
|
|
@@ -2844,7 +2850,7 @@ interface Point$1 {
|
|
|
2844
2850
|
y?: number;
|
|
2845
2851
|
}
|
|
2846
2852
|
interface Video$1 {
|
|
2847
|
-
/**
|
|
2853
|
+
/** Information about the Wix Media video. */
|
|
2848
2854
|
videoInfo?: VideoV2;
|
|
2849
2855
|
/** Manually defined Video duration in milliseconds. */
|
|
2850
2856
|
durationInMillis?: number | null;
|
|
@@ -3203,7 +3209,7 @@ interface ProjectCoverOneOf {
|
|
|
3203
3209
|
coverVideo?: Video;
|
|
3204
3210
|
}
|
|
3205
3211
|
interface Image {
|
|
3206
|
-
/**
|
|
3212
|
+
/** Information about the Wix Media image. */
|
|
3207
3213
|
imageInfo?: string;
|
|
3208
3214
|
/** Focal point of the image. */
|
|
3209
3215
|
focalPoint?: Point;
|
|
@@ -3220,7 +3226,7 @@ interface Point {
|
|
|
3220
3226
|
y?: number;
|
|
3221
3227
|
}
|
|
3222
3228
|
interface Video {
|
|
3223
|
-
/**
|
|
3229
|
+
/** Information about the Wix Media video. */
|
|
3224
3230
|
videoInfo?: string;
|
|
3225
3231
|
/** Manually defined Video duration in milliseconds. */
|
|
3226
3232
|
durationInMillis?: number | null;
|