@wix/portfolio 1.0.93 → 1.0.94
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 +7 -7
- package/type-bundles/context.bundle.d.ts +458 -408
- package/type-bundles/index.bundle.d.ts +458 -408
- package/type-bundles/meta.bundle.d.ts +346 -306
|
@@ -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;
|
|
@@ -615,46 +618,6 @@ interface AdminRemoveMenuItemsResponse {
|
|
|
615
618
|
/** number of items sucessfully deleted */
|
|
616
619
|
numItemsSuccessfullyDeleted?: number;
|
|
617
620
|
}
|
|
618
|
-
interface MessageEnvelope$5 {
|
|
619
|
-
/** App instance ID. */
|
|
620
|
-
instanceId?: string | null;
|
|
621
|
-
/** Event type. */
|
|
622
|
-
eventType?: string;
|
|
623
|
-
/** The identification type and identity data. */
|
|
624
|
-
identity?: IdentificationData$5;
|
|
625
|
-
/** Stringify payload. */
|
|
626
|
-
data?: string;
|
|
627
|
-
}
|
|
628
|
-
interface IdentificationData$5 extends IdentificationDataIdOneOf$5 {
|
|
629
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
630
|
-
anonymousVisitorId?: string;
|
|
631
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
632
|
-
memberId?: string;
|
|
633
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
634
|
-
wixUserId?: string;
|
|
635
|
-
/** ID of an app. */
|
|
636
|
-
appId?: string;
|
|
637
|
-
/** @readonly */
|
|
638
|
-
identityType?: WebhookIdentityType$5;
|
|
639
|
-
}
|
|
640
|
-
/** @oneof */
|
|
641
|
-
interface IdentificationDataIdOneOf$5 {
|
|
642
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
643
|
-
anonymousVisitorId?: string;
|
|
644
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
645
|
-
memberId?: string;
|
|
646
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
647
|
-
wixUserId?: string;
|
|
648
|
-
/** ID of an app. */
|
|
649
|
-
appId?: string;
|
|
650
|
-
}
|
|
651
|
-
declare enum WebhookIdentityType$5 {
|
|
652
|
-
UNKNOWN = "UNKNOWN",
|
|
653
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
654
|
-
MEMBER = "MEMBER",
|
|
655
|
-
WIX_USER = "WIX_USER",
|
|
656
|
-
APP = "APP"
|
|
657
|
-
}
|
|
658
621
|
interface InvalidateCache$2 extends InvalidateCacheGetByOneOf$2 {
|
|
659
622
|
/** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
|
|
660
623
|
metaSiteId?: string;
|
|
@@ -714,27 +677,27 @@ interface File$2 {
|
|
|
714
677
|
fileName?: string;
|
|
715
678
|
}
|
|
716
679
|
interface CreateCollectionRequest {
|
|
717
|
-
/** Collection to
|
|
680
|
+
/** Collection to create. */
|
|
718
681
|
collection: Collection;
|
|
719
682
|
}
|
|
720
683
|
interface CreateCollectionResponse {
|
|
721
|
-
/**
|
|
684
|
+
/** Created collection. */
|
|
722
685
|
collection?: Collection;
|
|
723
686
|
}
|
|
724
687
|
interface GetCollectionRequest {
|
|
725
|
-
/**
|
|
688
|
+
/** ID of the collection to retrieve. */
|
|
726
689
|
collectionId: string;
|
|
727
|
-
/**
|
|
690
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
728
691
|
includePageUrl?: boolean | null;
|
|
729
692
|
}
|
|
730
693
|
interface GetCollectionResponse {
|
|
731
|
-
/** The
|
|
694
|
+
/** The requested collection. */
|
|
732
695
|
collection?: Collection;
|
|
733
696
|
}
|
|
734
697
|
interface ListCollectionsRequest {
|
|
735
|
-
/** 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 ? */
|
|
736
699
|
paging?: CursorPaging$4;
|
|
737
|
-
/**
|
|
700
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
738
701
|
includePageUrl?: boolean | null;
|
|
739
702
|
}
|
|
740
703
|
interface CursorPaging$4 {
|
|
@@ -749,9 +712,9 @@ interface CursorPaging$4 {
|
|
|
749
712
|
cursor?: string | null;
|
|
750
713
|
}
|
|
751
714
|
interface ListCollectionsResponse {
|
|
752
|
-
/**
|
|
715
|
+
/** List of collections. */
|
|
753
716
|
collections?: Collection[];
|
|
754
|
-
/** Paging metadata */
|
|
717
|
+
/** Paging metadata. */
|
|
755
718
|
metadata?: PagingMetadataV2$4;
|
|
756
719
|
}
|
|
757
720
|
interface PagingMetadataV2$4 {
|
|
@@ -773,25 +736,25 @@ interface Cursors$4 {
|
|
|
773
736
|
prev?: string | null;
|
|
774
737
|
}
|
|
775
738
|
interface UpdateCollectionRequest {
|
|
776
|
-
/** Collection to
|
|
739
|
+
/** Collection to update. */
|
|
777
740
|
collection: Collection;
|
|
778
741
|
}
|
|
779
742
|
interface UpdateCollectionResponse {
|
|
780
|
-
/**
|
|
743
|
+
/** Updated collection. */
|
|
781
744
|
collection?: Collection;
|
|
782
745
|
}
|
|
783
746
|
interface DeleteCollectionRequest {
|
|
784
|
-
/**
|
|
747
|
+
/** ID of the collection to delete. */
|
|
785
748
|
collectionId: string;
|
|
786
749
|
}
|
|
787
750
|
interface DeleteCollectionResponse {
|
|
788
|
-
/**
|
|
751
|
+
/** ID of the deleted collection. */
|
|
789
752
|
collectionId?: string;
|
|
790
753
|
}
|
|
791
754
|
interface QueryCollectionsRequest {
|
|
792
|
-
/**
|
|
755
|
+
/** Query options. */
|
|
793
756
|
query: QueryV2$3;
|
|
794
|
-
/**
|
|
757
|
+
/** Whether to include the collection's page URL and relative path in the response. */
|
|
795
758
|
includePageUrl?: boolean | null;
|
|
796
759
|
}
|
|
797
760
|
interface QueryV2$3 extends QueryV2PagingMethodOneOf$3 {
|
|
@@ -840,11 +803,51 @@ interface Paging$3 {
|
|
|
840
803
|
offset?: number | null;
|
|
841
804
|
}
|
|
842
805
|
interface QueryCollectionsResponse {
|
|
843
|
-
/**
|
|
806
|
+
/** List of collections. */
|
|
844
807
|
collections?: Collection[];
|
|
845
|
-
/** Paging metadata */
|
|
808
|
+
/** Paging metadata. */
|
|
846
809
|
metadata?: PagingMetadataV2$4;
|
|
847
810
|
}
|
|
811
|
+
interface MessageEnvelope$5 {
|
|
812
|
+
/** App instance ID. */
|
|
813
|
+
instanceId?: string | null;
|
|
814
|
+
/** Event type. */
|
|
815
|
+
eventType?: string;
|
|
816
|
+
/** The identification type and identity data. */
|
|
817
|
+
identity?: IdentificationData$5;
|
|
818
|
+
/** Stringify payload. */
|
|
819
|
+
data?: string;
|
|
820
|
+
}
|
|
821
|
+
interface IdentificationData$5 extends IdentificationDataIdOneOf$5 {
|
|
822
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
823
|
+
anonymousVisitorId?: string;
|
|
824
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
825
|
+
memberId?: string;
|
|
826
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
827
|
+
wixUserId?: string;
|
|
828
|
+
/** ID of an app. */
|
|
829
|
+
appId?: string;
|
|
830
|
+
/** @readonly */
|
|
831
|
+
identityType?: WebhookIdentityType$5;
|
|
832
|
+
}
|
|
833
|
+
/** @oneof */
|
|
834
|
+
interface IdentificationDataIdOneOf$5 {
|
|
835
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
836
|
+
anonymousVisitorId?: string;
|
|
837
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
838
|
+
memberId?: string;
|
|
839
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
840
|
+
wixUserId?: string;
|
|
841
|
+
/** ID of an app. */
|
|
842
|
+
appId?: string;
|
|
843
|
+
}
|
|
844
|
+
declare enum WebhookIdentityType$5 {
|
|
845
|
+
UNKNOWN = "UNKNOWN",
|
|
846
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
847
|
+
MEMBER = "MEMBER",
|
|
848
|
+
WIX_USER = "WIX_USER",
|
|
849
|
+
APP = "APP"
|
|
850
|
+
}
|
|
848
851
|
interface PointNonNullableFields$3 {
|
|
849
852
|
x: number;
|
|
850
853
|
y: number;
|
|
@@ -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;
|
|
@@ -1226,35 +1243,34 @@ declare namespace context$5 {
|
|
|
1226
1243
|
|
|
1227
1244
|
interface PortfolioSettings {
|
|
1228
1245
|
/**
|
|
1229
|
-
*
|
|
1246
|
+
* Revision number. Increments by 1 each time the portfolio settings object is updated. To prevent conflicting changes, the existing revision must be passed when updating the portfolio settings object.
|
|
1230
1247
|
* @readonly
|
|
1231
1248
|
*/
|
|
1232
1249
|
revision?: string | null;
|
|
1233
|
-
/**
|
|
1250
|
+
/** Portfolio's project item settings. */
|
|
1234
1251
|
projectItemSettings?: ProjectItemSettings;
|
|
1235
|
-
/**
|
|
1252
|
+
/** Portfolio's media settings. */
|
|
1236
1253
|
mediaSettings?: MediaSettings;
|
|
1237
1254
|
/**
|
|
1238
|
-
*
|
|
1255
|
+
* Date and time the portfolio settings were created.
|
|
1239
1256
|
* @readonly
|
|
1240
1257
|
*/
|
|
1241
1258
|
_createdDate?: Date;
|
|
1242
1259
|
/**
|
|
1243
|
-
*
|
|
1260
|
+
* Date and time the portfolio settings were updated.
|
|
1244
1261
|
* @readonly
|
|
1245
1262
|
*/
|
|
1246
1263
|
_updatedDate?: Date;
|
|
1247
1264
|
}
|
|
1248
1265
|
interface ProjectItemSettings {
|
|
1249
|
-
/** The direction to add items */
|
|
1250
1266
|
addItemDirection?: AddItemDirection;
|
|
1251
|
-
/** The default item name */
|
|
1267
|
+
/** The default item name ? */
|
|
1252
1268
|
defaultItemName?: DefaultItemName;
|
|
1253
1269
|
}
|
|
1254
1270
|
declare enum AddItemDirection {
|
|
1255
|
-
/** Add items to the start of the gallery */
|
|
1271
|
+
/** Add new items to the start of the gallery. */
|
|
1256
1272
|
GALLERY_START = "GALLERY_START",
|
|
1257
|
-
/** Add items to the end of the gallery */
|
|
1273
|
+
/** Add new items to the end of the gallery. */
|
|
1258
1274
|
GALLERY_END = "GALLERY_END"
|
|
1259
1275
|
}
|
|
1260
1276
|
declare enum DefaultItemName {
|
|
@@ -1272,25 +1288,25 @@ interface SiteMenuSettings {
|
|
|
1272
1288
|
autoUpdateMenu?: boolean | null;
|
|
1273
1289
|
}
|
|
1274
1290
|
interface CreatePortfolioSettingsRequest {
|
|
1275
|
-
/** The portfolio settings to create */
|
|
1291
|
+
/** The portfolio settings to create. */
|
|
1276
1292
|
portfolioSettings: PortfolioSettings;
|
|
1277
1293
|
}
|
|
1278
1294
|
interface CreatePortfolioSettingsResponse {
|
|
1279
|
-
/**
|
|
1295
|
+
/** Newly created portfolio settings. */
|
|
1280
1296
|
portfolioSettings?: PortfolioSettings;
|
|
1281
1297
|
}
|
|
1282
1298
|
interface GetPortfolioSettingsRequest {
|
|
1283
1299
|
}
|
|
1284
1300
|
interface GetPortfolioSettingsResponse {
|
|
1285
|
-
/**
|
|
1301
|
+
/** Portfolio settings. */
|
|
1286
1302
|
portfolioSettings?: PortfolioSettings;
|
|
1287
1303
|
}
|
|
1288
1304
|
interface UpdatePortfolioSettingsRequest {
|
|
1289
|
-
/** The portfolio settings to update */
|
|
1305
|
+
/** The portfolio settings to update. */
|
|
1290
1306
|
portfolioSettings: PortfolioSettings;
|
|
1291
1307
|
}
|
|
1292
1308
|
interface UpdatePortfolioSettingsResponse {
|
|
1293
|
-
/**
|
|
1309
|
+
/** Updated portfolio settings. */
|
|
1294
1310
|
updatedPortfolioSettings?: PortfolioSettings;
|
|
1295
1311
|
}
|
|
1296
1312
|
interface DomainEvent$4 extends DomainEventBodyOneOf$4 {
|
|
@@ -1423,24 +1439,24 @@ interface UpdatePortfolioSettingsResponseNonNullableFields {
|
|
|
1423
1439
|
declare function createPortfolioSettings$1(httpClient: HttpClient): CreatePortfolioSettingsSignature;
|
|
1424
1440
|
interface CreatePortfolioSettingsSignature {
|
|
1425
1441
|
/**
|
|
1426
|
-
*
|
|
1427
|
-
* @param - The portfolio settings to create
|
|
1428
|
-
* @returns
|
|
1442
|
+
* Creates a site's portfolio settings.
|
|
1443
|
+
* @param - The portfolio settings to create.
|
|
1444
|
+
* @returns Newly created portfolio settings.
|
|
1429
1445
|
*/
|
|
1430
1446
|
(portfolioSettings: PortfolioSettings): Promise<PortfolioSettings & PortfolioSettingsNonNullableFields>;
|
|
1431
1447
|
}
|
|
1432
1448
|
declare function getPortfolioSettings$1(httpClient: HttpClient): GetPortfolioSettingsSignature;
|
|
1433
1449
|
interface GetPortfolioSettingsSignature {
|
|
1434
1450
|
/**
|
|
1435
|
-
*
|
|
1451
|
+
* Retrieves a site's portfolio settings.
|
|
1436
1452
|
*/
|
|
1437
1453
|
(): Promise<GetPortfolioSettingsResponse & GetPortfolioSettingsResponseNonNullableFields>;
|
|
1438
1454
|
}
|
|
1439
1455
|
declare function updatePortfolioSettings$1(httpClient: HttpClient): UpdatePortfolioSettingsSignature;
|
|
1440
1456
|
interface UpdatePortfolioSettingsSignature {
|
|
1441
1457
|
/**
|
|
1442
|
-
*
|
|
1443
|
-
* @param - The portfolio settings to update
|
|
1458
|
+
* Updates a site's portfolio settings.
|
|
1459
|
+
* @param - The portfolio settings to update.
|
|
1444
1460
|
*/
|
|
1445
1461
|
(portfolioSettings: PortfolioSettings): Promise<UpdatePortfolioSettingsResponse & UpdatePortfolioSettingsResponseNonNullableFields>;
|
|
1446
1462
|
}
|
|
@@ -1476,14 +1492,11 @@ declare namespace context$4 {
|
|
|
1476
1492
|
|
|
1477
1493
|
/** ProjectItem is the main entity of ProjectItemsService */
|
|
1478
1494
|
interface Item extends ItemMetadataOneOf {
|
|
1479
|
-
/** Information about the image. */
|
|
1495
|
+
/** Information about the Wix Media image. */
|
|
1480
1496
|
image?: Image$2;
|
|
1481
|
-
/** Information about the video. */
|
|
1497
|
+
/** Information about the Wix Media video. */
|
|
1482
1498
|
video?: Video$2;
|
|
1483
|
-
/**
|
|
1484
|
-
* Id of the Project the items are part of
|
|
1485
|
-
* Project must exist before adding items to it. You can create a project using the [ProjectService](https://dev.wix.com/docs/rest/business-solutions/portfolio/project)
|
|
1486
|
-
*/
|
|
1499
|
+
/** Project ID. */
|
|
1487
1500
|
projectId?: string | null;
|
|
1488
1501
|
/**
|
|
1489
1502
|
* Item ID.
|
|
@@ -1491,7 +1504,7 @@ interface Item extends ItemMetadataOneOf {
|
|
|
1491
1504
|
*/
|
|
1492
1505
|
_id?: string | null;
|
|
1493
1506
|
/**
|
|
1494
|
-
*
|
|
1507
|
+
* Sort order of the project item within the specified project. <br />
|
|
1495
1508
|
*
|
|
1496
1509
|
* Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
|
|
1497
1510
|
*/
|
|
@@ -1519,14 +1532,14 @@ interface Item extends ItemMetadataOneOf {
|
|
|
1519
1532
|
* @readonly
|
|
1520
1533
|
*/
|
|
1521
1534
|
_updatedDate?: Date;
|
|
1522
|
-
/**
|
|
1535
|
+
/** Project item link. */
|
|
1523
1536
|
link?: Link;
|
|
1524
1537
|
}
|
|
1525
1538
|
/** @oneof */
|
|
1526
1539
|
interface ItemMetadataOneOf {
|
|
1527
|
-
/** Information about the image. */
|
|
1540
|
+
/** Information about the Wix Media image. */
|
|
1528
1541
|
image?: Image$2;
|
|
1529
|
-
/** Information about the video. */
|
|
1542
|
+
/** Information about the Wix Media video. */
|
|
1530
1543
|
video?: Video$2;
|
|
1531
1544
|
}
|
|
1532
1545
|
declare enum Type {
|
|
@@ -1538,7 +1551,7 @@ declare enum Type {
|
|
|
1538
1551
|
VIDEO = "VIDEO"
|
|
1539
1552
|
}
|
|
1540
1553
|
interface Image$2 {
|
|
1541
|
-
/**
|
|
1554
|
+
/** Information about the Wix Media image. */
|
|
1542
1555
|
imageInfo?: string;
|
|
1543
1556
|
/** Focal point of the image. */
|
|
1544
1557
|
focalPoint?: Point$2;
|
|
@@ -1573,7 +1586,7 @@ interface UnsharpMasking$2 {
|
|
|
1573
1586
|
threshold?: number | null;
|
|
1574
1587
|
}
|
|
1575
1588
|
interface Video$2 {
|
|
1576
|
-
/**
|
|
1589
|
+
/** Information about the Wix Media video. */
|
|
1577
1590
|
videoInfo?: string;
|
|
1578
1591
|
/** Manually defined Video duration in milliseconds. */
|
|
1579
1592
|
durationInMillis?: number | null;
|
|
@@ -1622,116 +1635,6 @@ interface ProjectItemMediaToken {
|
|
|
1622
1635
|
/** Generated media token for project item */
|
|
1623
1636
|
mediaToken?: string;
|
|
1624
1637
|
}
|
|
1625
|
-
interface DomainEvent$3 extends DomainEventBodyOneOf$3 {
|
|
1626
|
-
createdEvent?: EntityCreatedEvent$3;
|
|
1627
|
-
updatedEvent?: EntityUpdatedEvent$3;
|
|
1628
|
-
deletedEvent?: EntityDeletedEvent$3;
|
|
1629
|
-
actionEvent?: ActionEvent$3;
|
|
1630
|
-
/**
|
|
1631
|
-
* Unique event ID.
|
|
1632
|
-
* Allows clients to ignore duplicate webhooks.
|
|
1633
|
-
*/
|
|
1634
|
-
_id?: string;
|
|
1635
|
-
/**
|
|
1636
|
-
* Assumes actions are also always typed to an entity_type
|
|
1637
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1638
|
-
*/
|
|
1639
|
-
entityFqdn?: string;
|
|
1640
|
-
/**
|
|
1641
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1642
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1643
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
1644
|
-
*/
|
|
1645
|
-
slug?: string;
|
|
1646
|
-
/** ID of the entity associated with the event. */
|
|
1647
|
-
entityId?: string;
|
|
1648
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1649
|
-
eventTime?: Date;
|
|
1650
|
-
/**
|
|
1651
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
1652
|
-
* (for example, GDPR).
|
|
1653
|
-
*/
|
|
1654
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
1655
|
-
/** If present, indicates the action that triggered the event. */
|
|
1656
|
-
originatedFrom?: string | null;
|
|
1657
|
-
/**
|
|
1658
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
1659
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1660
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1661
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1662
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1663
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1664
|
-
*/
|
|
1665
|
-
entityEventSequence?: string | null;
|
|
1666
|
-
}
|
|
1667
|
-
/** @oneof */
|
|
1668
|
-
interface DomainEventBodyOneOf$3 {
|
|
1669
|
-
createdEvent?: EntityCreatedEvent$3;
|
|
1670
|
-
updatedEvent?: EntityUpdatedEvent$3;
|
|
1671
|
-
deletedEvent?: EntityDeletedEvent$3;
|
|
1672
|
-
actionEvent?: ActionEvent$3;
|
|
1673
|
-
}
|
|
1674
|
-
interface EntityCreatedEvent$3 {
|
|
1675
|
-
entity?: string;
|
|
1676
|
-
}
|
|
1677
|
-
interface RestoreInfo$3 {
|
|
1678
|
-
deletedDate?: Date;
|
|
1679
|
-
}
|
|
1680
|
-
interface EntityUpdatedEvent$3 {
|
|
1681
|
-
/**
|
|
1682
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1683
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1684
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1685
|
-
*/
|
|
1686
|
-
currentEntity?: string;
|
|
1687
|
-
}
|
|
1688
|
-
interface EntityDeletedEvent$3 {
|
|
1689
|
-
/** Entity that was deleted */
|
|
1690
|
-
deletedEntity?: string | null;
|
|
1691
|
-
}
|
|
1692
|
-
interface ActionEvent$3 {
|
|
1693
|
-
body?: string;
|
|
1694
|
-
}
|
|
1695
|
-
interface MessageEnvelope$3 {
|
|
1696
|
-
/** App instance ID. */
|
|
1697
|
-
instanceId?: string | null;
|
|
1698
|
-
/** Event type. */
|
|
1699
|
-
eventType?: string;
|
|
1700
|
-
/** The identification type and identity data. */
|
|
1701
|
-
identity?: IdentificationData$3;
|
|
1702
|
-
/** Stringify payload. */
|
|
1703
|
-
data?: string;
|
|
1704
|
-
}
|
|
1705
|
-
interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {
|
|
1706
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
1707
|
-
anonymousVisitorId?: string;
|
|
1708
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
1709
|
-
memberId?: string;
|
|
1710
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1711
|
-
wixUserId?: string;
|
|
1712
|
-
/** ID of an app. */
|
|
1713
|
-
appId?: string;
|
|
1714
|
-
/** @readonly */
|
|
1715
|
-
identityType?: WebhookIdentityType$3;
|
|
1716
|
-
}
|
|
1717
|
-
/** @oneof */
|
|
1718
|
-
interface IdentificationDataIdOneOf$3 {
|
|
1719
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
1720
|
-
anonymousVisitorId?: string;
|
|
1721
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
1722
|
-
memberId?: string;
|
|
1723
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1724
|
-
wixUserId?: string;
|
|
1725
|
-
/** ID of an app. */
|
|
1726
|
-
appId?: string;
|
|
1727
|
-
}
|
|
1728
|
-
declare enum WebhookIdentityType$3 {
|
|
1729
|
-
UNKNOWN = "UNKNOWN",
|
|
1730
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1731
|
-
MEMBER = "MEMBER",
|
|
1732
|
-
WIX_USER = "WIX_USER",
|
|
1733
|
-
APP = "APP"
|
|
1734
|
-
}
|
|
1735
1638
|
interface InvalidateCache$1 extends InvalidateCacheGetByOneOf$1 {
|
|
1736
1639
|
/** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
|
|
1737
1640
|
metaSiteId?: string;
|
|
@@ -1791,28 +1694,29 @@ interface File$1 {
|
|
|
1791
1694
|
fileName?: string;
|
|
1792
1695
|
}
|
|
1793
1696
|
interface CreateProjectItemRequest {
|
|
1794
|
-
/**
|
|
1697
|
+
/** Project item to create. */
|
|
1795
1698
|
item: Item;
|
|
1796
1699
|
}
|
|
1797
1700
|
interface CreateProjectItemResponse {
|
|
1798
|
-
/**
|
|
1701
|
+
/** Newly created project item. */
|
|
1799
1702
|
item?: Item;
|
|
1800
1703
|
}
|
|
1801
1704
|
interface BulkCreateProjectItemsRequest {
|
|
1802
|
-
/** items to
|
|
1705
|
+
/** Project items to create. */
|
|
1803
1706
|
items: Item[];
|
|
1707
|
+
/** Whether to include the created project items in the response. Set to `true` to receive the project items in the response. */
|
|
1804
1708
|
returnFullEntity?: boolean | null;
|
|
1805
1709
|
}
|
|
1806
1710
|
interface BulkCreateProjectItemsResponse {
|
|
1807
|
-
/**
|
|
1711
|
+
/** Project items created by bulk action. */
|
|
1808
1712
|
results?: BulkCreateProjectItemResult[];
|
|
1809
|
-
/**
|
|
1713
|
+
/** Bulk action metadata. */
|
|
1810
1714
|
bulkActionMetadata?: BulkActionMetadata$1;
|
|
1811
1715
|
}
|
|
1812
1716
|
interface BulkCreateProjectItemResult {
|
|
1813
|
-
/**
|
|
1717
|
+
/** Information about successful action or error for failure. */
|
|
1814
1718
|
itemMetadata?: ItemMetadata$1;
|
|
1815
|
-
/**
|
|
1719
|
+
/** Newly created project item. */
|
|
1816
1720
|
item?: Item;
|
|
1817
1721
|
}
|
|
1818
1722
|
interface ItemMetadata$1 {
|
|
@@ -1842,17 +1746,17 @@ interface BulkActionMetadata$1 {
|
|
|
1842
1746
|
undetailedFailures?: number;
|
|
1843
1747
|
}
|
|
1844
1748
|
interface GetProjectItemRequest {
|
|
1845
|
-
/**
|
|
1749
|
+
/** Project item ID. */
|
|
1846
1750
|
itemId: string;
|
|
1847
1751
|
}
|
|
1848
1752
|
interface GetProjectItemResponse {
|
|
1849
|
-
/**
|
|
1753
|
+
/** Project item. */
|
|
1850
1754
|
item?: Item;
|
|
1851
1755
|
}
|
|
1852
1756
|
interface ListProjectItemsRequest {
|
|
1853
|
-
/**
|
|
1757
|
+
/** Project ID. */
|
|
1854
1758
|
projectId: string;
|
|
1855
|
-
/**
|
|
1759
|
+
/** Maximum number of items to return in the results. */
|
|
1856
1760
|
paging?: Paging$2;
|
|
1857
1761
|
}
|
|
1858
1762
|
interface Paging$2 {
|
|
@@ -1862,14 +1766,14 @@ interface Paging$2 {
|
|
|
1862
1766
|
offset?: number | null;
|
|
1863
1767
|
}
|
|
1864
1768
|
interface ListProjectItemsResponse {
|
|
1865
|
-
/**
|
|
1769
|
+
/** Project items. */
|
|
1866
1770
|
items?: Item[];
|
|
1867
1771
|
/**
|
|
1868
|
-
* Paging metadata
|
|
1772
|
+
* Paging metadata.
|
|
1869
1773
|
* @deprecated
|
|
1870
1774
|
*/
|
|
1871
1775
|
pagingMetadataV2?: PagingMetadataV2$3;
|
|
1872
|
-
/** Paging metadata */
|
|
1776
|
+
/** Paging metadata. */
|
|
1873
1777
|
metadata?: PagingMetadataV2$3;
|
|
1874
1778
|
}
|
|
1875
1779
|
interface PagingMetadataV2$3 {
|
|
@@ -1945,23 +1849,23 @@ interface CursorPaging$3 {
|
|
|
1945
1849
|
cursor?: string | null;
|
|
1946
1850
|
}
|
|
1947
1851
|
interface QueryProjectItemsResponse {
|
|
1948
|
-
/**
|
|
1852
|
+
/** Project items. */
|
|
1949
1853
|
items?: Item[];
|
|
1950
|
-
/** Paging metadata */
|
|
1854
|
+
/** Paging metadata. */
|
|
1951
1855
|
metadata?: PagingMetadataV2$3;
|
|
1952
1856
|
}
|
|
1953
1857
|
interface UpdateProjectItemRequest {
|
|
1954
|
-
/**
|
|
1858
|
+
/** The project item to update. */
|
|
1955
1859
|
item: Item;
|
|
1956
1860
|
}
|
|
1957
1861
|
interface UpdateProjectItemResponse {
|
|
1958
|
-
/** The updated
|
|
1862
|
+
/** The updated project item. */
|
|
1959
1863
|
item?: Item;
|
|
1960
1864
|
}
|
|
1961
1865
|
interface BulkUpdateProjectItemsRequest {
|
|
1962
1866
|
/** items to be updated. */
|
|
1963
1867
|
items?: MaskedItem[];
|
|
1964
|
-
/**
|
|
1868
|
+
/** Whether to include the updated project items in the response. Set to `true` to receive the project items in the response. */
|
|
1965
1869
|
returnFullEntity?: boolean | null;
|
|
1966
1870
|
}
|
|
1967
1871
|
interface MaskedItem {
|
|
@@ -1969,41 +1873,41 @@ interface MaskedItem {
|
|
|
1969
1873
|
item?: Item;
|
|
1970
1874
|
}
|
|
1971
1875
|
interface BulkUpdateProjectItemsResponse {
|
|
1972
|
-
/**
|
|
1876
|
+
/** Project items updated by bulk action. */
|
|
1973
1877
|
results?: BulkUpdateProjectItemResult[];
|
|
1974
|
-
/**
|
|
1878
|
+
/** Bulk action metadata. */
|
|
1975
1879
|
bulkActionMetadata?: BulkActionMetadata$1;
|
|
1976
1880
|
}
|
|
1977
1881
|
interface BulkUpdateProjectItemResult {
|
|
1978
|
-
/**
|
|
1882
|
+
/** Information about successful action or error for failure. */
|
|
1979
1883
|
itemMetadata?: ItemMetadata$1;
|
|
1980
|
-
/** Updated item */
|
|
1884
|
+
/** Updated project item. */
|
|
1981
1885
|
item?: Item;
|
|
1982
1886
|
}
|
|
1983
1887
|
interface DeleteProjectItemRequest {
|
|
1984
|
-
/**
|
|
1888
|
+
/** ID of the project item to delete. */
|
|
1985
1889
|
itemId: string;
|
|
1986
1890
|
}
|
|
1987
1891
|
interface DeleteProjectItemResponse {
|
|
1988
|
-
/**
|
|
1892
|
+
/** Project ID. */
|
|
1989
1893
|
projectId?: string;
|
|
1990
|
-
/**
|
|
1894
|
+
/** ID of the deleted project item. */
|
|
1991
1895
|
itemId?: string;
|
|
1992
1896
|
}
|
|
1993
1897
|
interface BulkDeleteProjectItemsRequest {
|
|
1994
|
-
/**
|
|
1898
|
+
/** Project item IDs. */
|
|
1995
1899
|
itemIds: string[];
|
|
1996
1900
|
}
|
|
1997
1901
|
interface BulkDeleteProjectItemsResponse {
|
|
1998
|
-
/**
|
|
1902
|
+
/** Project items deleted by bulk action. */
|
|
1999
1903
|
results?: BulkDeleteProjectItemResult[];
|
|
2000
|
-
/**
|
|
1904
|
+
/** Bulk action metadata. */
|
|
2001
1905
|
bulkActionMetadata?: BulkActionMetadata$1;
|
|
2002
1906
|
}
|
|
2003
1907
|
interface BulkDeleteProjectItemResult {
|
|
2004
|
-
/**
|
|
1908
|
+
/** Information about successful action or error for failure. */
|
|
2005
1909
|
itemMetadata?: ItemMetadata$1;
|
|
2006
|
-
/**
|
|
1910
|
+
/** Project item ID. */
|
|
2007
1911
|
itemId?: string;
|
|
2008
1912
|
}
|
|
2009
1913
|
interface CreateProjectGalleryRequest {
|
|
@@ -2016,6 +1920,76 @@ interface CreateProjectGalleryResponse {
|
|
|
2016
1920
|
/** Id of created gallery */
|
|
2017
1921
|
galleryId?: string;
|
|
2018
1922
|
}
|
|
1923
|
+
interface DomainEvent$3 extends DomainEventBodyOneOf$3 {
|
|
1924
|
+
createdEvent?: EntityCreatedEvent$3;
|
|
1925
|
+
updatedEvent?: EntityUpdatedEvent$3;
|
|
1926
|
+
deletedEvent?: EntityDeletedEvent$3;
|
|
1927
|
+
actionEvent?: ActionEvent$3;
|
|
1928
|
+
/**
|
|
1929
|
+
* Unique event ID.
|
|
1930
|
+
* Allows clients to ignore duplicate webhooks.
|
|
1931
|
+
*/
|
|
1932
|
+
_id?: string;
|
|
1933
|
+
/**
|
|
1934
|
+
* Assumes actions are also always typed to an entity_type
|
|
1935
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1936
|
+
*/
|
|
1937
|
+
entityFqdn?: string;
|
|
1938
|
+
/**
|
|
1939
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1940
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1941
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
1942
|
+
*/
|
|
1943
|
+
slug?: string;
|
|
1944
|
+
/** ID of the entity associated with the event. */
|
|
1945
|
+
entityId?: string;
|
|
1946
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1947
|
+
eventTime?: Date;
|
|
1948
|
+
/**
|
|
1949
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1950
|
+
* (for example, GDPR).
|
|
1951
|
+
*/
|
|
1952
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1953
|
+
/** If present, indicates the action that triggered the event. */
|
|
1954
|
+
originatedFrom?: string | null;
|
|
1955
|
+
/**
|
|
1956
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
1957
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1958
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1959
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1960
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1961
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1962
|
+
*/
|
|
1963
|
+
entityEventSequence?: string | null;
|
|
1964
|
+
}
|
|
1965
|
+
/** @oneof */
|
|
1966
|
+
interface DomainEventBodyOneOf$3 {
|
|
1967
|
+
createdEvent?: EntityCreatedEvent$3;
|
|
1968
|
+
updatedEvent?: EntityUpdatedEvent$3;
|
|
1969
|
+
deletedEvent?: EntityDeletedEvent$3;
|
|
1970
|
+
actionEvent?: ActionEvent$3;
|
|
1971
|
+
}
|
|
1972
|
+
interface EntityCreatedEvent$3 {
|
|
1973
|
+
entity?: string;
|
|
1974
|
+
}
|
|
1975
|
+
interface RestoreInfo$3 {
|
|
1976
|
+
deletedDate?: Date;
|
|
1977
|
+
}
|
|
1978
|
+
interface EntityUpdatedEvent$3 {
|
|
1979
|
+
/**
|
|
1980
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1981
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1982
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1983
|
+
*/
|
|
1984
|
+
currentEntity?: string;
|
|
1985
|
+
}
|
|
1986
|
+
interface EntityDeletedEvent$3 {
|
|
1987
|
+
/** Entity that was deleted */
|
|
1988
|
+
deletedEntity?: string | null;
|
|
1989
|
+
}
|
|
1990
|
+
interface ActionEvent$3 {
|
|
1991
|
+
body?: string;
|
|
1992
|
+
}
|
|
2019
1993
|
interface Empty$2 {
|
|
2020
1994
|
}
|
|
2021
1995
|
interface DeletedProjectRestored$1 {
|
|
@@ -2025,17 +1999,57 @@ interface DeletedProjectRestored$1 {
|
|
|
2025
1999
|
deletionTimestamp?: Date;
|
|
2026
2000
|
}
|
|
2027
2001
|
interface DuplicateProjectItemsRequest {
|
|
2028
|
-
/**
|
|
2002
|
+
/** ID of the project containing the items to duplicate. */
|
|
2029
2003
|
originProjectId: string;
|
|
2030
|
-
/**
|
|
2004
|
+
/** ID of the project where the duplicated items will be added. */
|
|
2031
2005
|
targetProjectId: string;
|
|
2032
2006
|
}
|
|
2033
2007
|
interface DuplicateProjectItemsResponse {
|
|
2034
|
-
/**
|
|
2008
|
+
/** Project ID where the duplicated items have been added. */
|
|
2035
2009
|
projectId?: string;
|
|
2036
|
-
/**
|
|
2010
|
+
/** Bulk action metadata. */
|
|
2037
2011
|
bulkActionMetadata?: BulkActionMetadata$1;
|
|
2038
2012
|
}
|
|
2013
|
+
interface MessageEnvelope$3 {
|
|
2014
|
+
/** App instance ID. */
|
|
2015
|
+
instanceId?: string | null;
|
|
2016
|
+
/** Event type. */
|
|
2017
|
+
eventType?: string;
|
|
2018
|
+
/** The identification type and identity data. */
|
|
2019
|
+
identity?: IdentificationData$3;
|
|
2020
|
+
/** Stringify payload. */
|
|
2021
|
+
data?: string;
|
|
2022
|
+
}
|
|
2023
|
+
interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {
|
|
2024
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
2025
|
+
anonymousVisitorId?: string;
|
|
2026
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
2027
|
+
memberId?: string;
|
|
2028
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
2029
|
+
wixUserId?: string;
|
|
2030
|
+
/** ID of an app. */
|
|
2031
|
+
appId?: string;
|
|
2032
|
+
/** @readonly */
|
|
2033
|
+
identityType?: WebhookIdentityType$3;
|
|
2034
|
+
}
|
|
2035
|
+
/** @oneof */
|
|
2036
|
+
interface IdentificationDataIdOneOf$3 {
|
|
2037
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
2038
|
+
anonymousVisitorId?: string;
|
|
2039
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
2040
|
+
memberId?: string;
|
|
2041
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
2042
|
+
wixUserId?: string;
|
|
2043
|
+
/** ID of an app. */
|
|
2044
|
+
appId?: string;
|
|
2045
|
+
}
|
|
2046
|
+
declare enum WebhookIdentityType$3 {
|
|
2047
|
+
UNKNOWN = "UNKNOWN",
|
|
2048
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2049
|
+
MEMBER = "MEMBER",
|
|
2050
|
+
WIX_USER = "WIX_USER",
|
|
2051
|
+
APP = "APP"
|
|
2052
|
+
}
|
|
2039
2053
|
interface PointNonNullableFields$2 {
|
|
2040
2054
|
x: number;
|
|
2041
2055
|
y: number;
|
|
@@ -2180,23 +2194,21 @@ interface ProjectItemDeletedEnvelope {
|
|
|
2180
2194
|
metadata: EventMetadata$2;
|
|
2181
2195
|
}
|
|
2182
2196
|
interface BulkCreateProjectItemsOptions {
|
|
2183
|
-
/** items to
|
|
2197
|
+
/** Project items to create. */
|
|
2184
2198
|
items: Item[];
|
|
2199
|
+
/** Whether to include the created project items in the response. Set to `true` to receive the project items in the response. */
|
|
2185
2200
|
returnFullEntity?: boolean | null;
|
|
2186
2201
|
}
|
|
2187
2202
|
interface ListProjectItemsOptions {
|
|
2188
|
-
/**
|
|
2203
|
+
/** Maximum number of items to return in the results. */
|
|
2189
2204
|
paging?: Paging$2;
|
|
2190
2205
|
}
|
|
2191
2206
|
interface UpdateProjectItem {
|
|
2192
|
-
/** Information about the image. */
|
|
2207
|
+
/** Information about the Wix Media image. */
|
|
2193
2208
|
image?: Image$2;
|
|
2194
|
-
/** Information about the video. */
|
|
2209
|
+
/** Information about the Wix Media video. */
|
|
2195
2210
|
video?: Video$2;
|
|
2196
|
-
/**
|
|
2197
|
-
* Id of the Project the items are part of
|
|
2198
|
-
* Project must exist before adding items to it. You can create a project using the [ProjectService](https://dev.wix.com/docs/rest/business-solutions/portfolio/project)
|
|
2199
|
-
*/
|
|
2211
|
+
/** Project ID. */
|
|
2200
2212
|
projectId?: string | null;
|
|
2201
2213
|
/**
|
|
2202
2214
|
* Item ID.
|
|
@@ -2204,7 +2216,7 @@ interface UpdateProjectItem {
|
|
|
2204
2216
|
*/
|
|
2205
2217
|
_id?: string | null;
|
|
2206
2218
|
/**
|
|
2207
|
-
*
|
|
2219
|
+
* Sort order of the project item within the specified project. <br />
|
|
2208
2220
|
*
|
|
2209
2221
|
* Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
|
|
2210
2222
|
*/
|
|
@@ -2232,93 +2244,101 @@ interface UpdateProjectItem {
|
|
|
2232
2244
|
* @readonly
|
|
2233
2245
|
*/
|
|
2234
2246
|
_updatedDate?: Date;
|
|
2235
|
-
/**
|
|
2247
|
+
/** Project item link. */
|
|
2236
2248
|
link?: Link;
|
|
2237
2249
|
}
|
|
2238
2250
|
interface BulkUpdateProjectItemsOptions {
|
|
2239
2251
|
/** items to be updated. */
|
|
2240
2252
|
items?: MaskedItem[];
|
|
2241
|
-
/**
|
|
2253
|
+
/** Whether to include the updated project items in the response. Set to `true` to receive the project items in the response. */
|
|
2242
2254
|
returnFullEntity?: boolean | null;
|
|
2243
2255
|
}
|
|
2244
2256
|
interface BulkDeleteProjectItemsOptions {
|
|
2245
|
-
/**
|
|
2257
|
+
/** Project item IDs. */
|
|
2246
2258
|
itemIds: string[];
|
|
2247
2259
|
}
|
|
2248
2260
|
interface DuplicateProjectItemsOptions {
|
|
2249
|
-
/**
|
|
2261
|
+
/** ID of the project where the duplicated items will be added. */
|
|
2250
2262
|
targetProjectId: string;
|
|
2251
2263
|
}
|
|
2252
2264
|
|
|
2253
2265
|
declare function createProjectItem$1(httpClient: HttpClient): CreateProjectItemSignature;
|
|
2254
2266
|
interface CreateProjectItemSignature {
|
|
2255
2267
|
/**
|
|
2256
|
-
* Creates a
|
|
2257
|
-
* @param -
|
|
2258
|
-
* @returns
|
|
2268
|
+
* Creates a project item.
|
|
2269
|
+
* @param - Project item to create.
|
|
2270
|
+
* @returns Newly created project item.
|
|
2259
2271
|
*/
|
|
2260
2272
|
(item: Item): Promise<Item & ItemNonNullableFields>;
|
|
2261
2273
|
}
|
|
2262
2274
|
declare function bulkCreateProjectItems$1(httpClient: HttpClient): BulkCreateProjectItemsSignature;
|
|
2263
2275
|
interface BulkCreateProjectItemsSignature {
|
|
2264
2276
|
/**
|
|
2265
|
-
*
|
|
2277
|
+
* Creates multiple project items.
|
|
2266
2278
|
*/
|
|
2267
2279
|
(options?: BulkCreateProjectItemsOptions | undefined): Promise<BulkCreateProjectItemsResponse & BulkCreateProjectItemsResponseNonNullableFields>;
|
|
2268
2280
|
}
|
|
2269
2281
|
declare function getProjectItem$1(httpClient: HttpClient): GetProjectItemSignature;
|
|
2270
2282
|
interface GetProjectItemSignature {
|
|
2271
2283
|
/**
|
|
2272
|
-
*
|
|
2273
|
-
* @param -
|
|
2274
|
-
* @returns
|
|
2284
|
+
* Retrieves a project item.
|
|
2285
|
+
* @param - Project item ID.
|
|
2286
|
+
* @returns Project item.
|
|
2275
2287
|
*/
|
|
2276
2288
|
(itemId: string): Promise<Item & ItemNonNullableFields>;
|
|
2277
2289
|
}
|
|
2278
2290
|
declare function listProjectItems$1(httpClient: HttpClient): ListProjectItemsSignature;
|
|
2279
2291
|
interface ListProjectItemsSignature {
|
|
2280
2292
|
/**
|
|
2281
|
-
*
|
|
2282
|
-
*
|
|
2293
|
+
* Retrieves a list of all project items in the specified project.
|
|
2294
|
+
*
|
|
2295
|
+
* limit and offset for ProjectItems - maximum limit is 200 per request, default is 50
|
|
2296
|
+
* @param - Project ID.
|
|
2283
2297
|
*/
|
|
2284
2298
|
(projectId: string, options?: ListProjectItemsOptions | undefined): Promise<ListProjectItemsResponse & ListProjectItemsResponseNonNullableFields>;
|
|
2285
2299
|
}
|
|
2286
2300
|
declare function updateProjectItem$1(httpClient: HttpClient): UpdateProjectItemSignature;
|
|
2287
2301
|
interface UpdateProjectItemSignature {
|
|
2288
2302
|
/**
|
|
2289
|
-
*
|
|
2303
|
+
* Updates a project item.
|
|
2290
2304
|
* @param - Item ID.
|
|
2291
|
-
* @returns The updated
|
|
2305
|
+
* @returns The updated project item.
|
|
2292
2306
|
*/
|
|
2293
2307
|
(_id: string | null, item: UpdateProjectItem): Promise<Item & ItemNonNullableFields>;
|
|
2294
2308
|
}
|
|
2295
2309
|
declare function bulkUpdateProjectItems$1(httpClient: HttpClient): BulkUpdateProjectItemsSignature;
|
|
2296
2310
|
interface BulkUpdateProjectItemsSignature {
|
|
2297
2311
|
/**
|
|
2298
|
-
*
|
|
2312
|
+
* Updates multiple project items.
|
|
2299
2313
|
*/
|
|
2300
2314
|
(options?: BulkUpdateProjectItemsOptions | undefined): Promise<BulkUpdateProjectItemsResponse & BulkUpdateProjectItemsResponseNonNullableFields>;
|
|
2301
2315
|
}
|
|
2302
2316
|
declare function deleteProjectItem$1(httpClient: HttpClient): DeleteProjectItemSignature;
|
|
2303
2317
|
interface DeleteProjectItemSignature {
|
|
2304
2318
|
/**
|
|
2305
|
-
*
|
|
2306
|
-
* @param -
|
|
2319
|
+
* Deletes a project item.
|
|
2320
|
+
* @param - ID of the project item to delete.
|
|
2307
2321
|
*/
|
|
2308
2322
|
(itemId: string): Promise<DeleteProjectItemResponse & DeleteProjectItemResponseNonNullableFields>;
|
|
2309
2323
|
}
|
|
2310
2324
|
declare function bulkDeleteProjectItems$1(httpClient: HttpClient): BulkDeleteProjectItemsSignature;
|
|
2311
2325
|
interface BulkDeleteProjectItemsSignature {
|
|
2312
2326
|
/**
|
|
2313
|
-
*
|
|
2327
|
+
* Deletes multiple project items.
|
|
2314
2328
|
*/
|
|
2315
2329
|
(options: BulkDeleteProjectItemsOptions): Promise<BulkDeleteProjectItemsResponse & BulkDeleteProjectItemsResponseNonNullableFields>;
|
|
2316
2330
|
}
|
|
2317
2331
|
declare function duplicateProjectItems$1(httpClient: HttpClient): DuplicateProjectItemsSignature;
|
|
2318
2332
|
interface DuplicateProjectItemsSignature {
|
|
2319
2333
|
/**
|
|
2320
|
-
*
|
|
2321
|
-
*
|
|
2334
|
+
* Duplicates project items from one project (the origin) to another project (the target).
|
|
2335
|
+
*
|
|
2336
|
+
* <blockquote class="important">
|
|
2337
|
+
* <strong>Important:</strong>
|
|
2338
|
+
*
|
|
2339
|
+
* Both the origin and target projects must exist before calling this method.
|
|
2340
|
+
* </blockquote>
|
|
2341
|
+
* @param - ID of the project containing the items to duplicate.
|
|
2322
2342
|
*/
|
|
2323
2343
|
(originProjectId: string, options: DuplicateProjectItemsOptions): Promise<DuplicateProjectItemsResponse & DuplicateProjectItemsResponseNonNullableFields>;
|
|
2324
2344
|
}
|
|
@@ -2441,59 +2461,60 @@ declare namespace context$3 {
|
|
|
2441
2461
|
export { type ActionEvent$3 as ActionEvent, type App$1 as App, type ApplicationError$1 as ApplicationError, type BaseEventMetadata$2 as BaseEventMetadata, type BulkActionMetadata$1 as BulkActionMetadata, type context$3_BulkCreateProjectItemResult as BulkCreateProjectItemResult, type context$3_BulkCreateProjectItemsOptions as BulkCreateProjectItemsOptions, type context$3_BulkCreateProjectItemsRequest as BulkCreateProjectItemsRequest, type context$3_BulkCreateProjectItemsResponse as BulkCreateProjectItemsResponse, type context$3_BulkCreateProjectItemsResponseNonNullableFields as BulkCreateProjectItemsResponseNonNullableFields, type context$3_BulkDeleteProjectItemResult as BulkDeleteProjectItemResult, type context$3_BulkDeleteProjectItemsOptions as BulkDeleteProjectItemsOptions, type context$3_BulkDeleteProjectItemsRequest as BulkDeleteProjectItemsRequest, type context$3_BulkDeleteProjectItemsResponse as BulkDeleteProjectItemsResponse, type context$3_BulkDeleteProjectItemsResponseNonNullableFields as BulkDeleteProjectItemsResponseNonNullableFields, type context$3_BulkUpdateProjectItemResult as BulkUpdateProjectItemResult, type context$3_BulkUpdateProjectItemsOptions as BulkUpdateProjectItemsOptions, type context$3_BulkUpdateProjectItemsRequest as BulkUpdateProjectItemsRequest, type context$3_BulkUpdateProjectItemsResponse as BulkUpdateProjectItemsResponse, type context$3_BulkUpdateProjectItemsResponseNonNullableFields as BulkUpdateProjectItemsResponseNonNullableFields, type context$3_CreateProjectGalleryRequest as CreateProjectGalleryRequest, type context$3_CreateProjectGalleryResponse as CreateProjectGalleryResponse, type context$3_CreateProjectItemRequest as CreateProjectItemRequest, type context$3_CreateProjectItemResponse as CreateProjectItemResponse, type context$3_CreateProjectItemResponseNonNullableFields as CreateProjectItemResponseNonNullableFields, type CursorPaging$3 as CursorPaging, type Cursors$3 as Cursors, type context$3_DeleteProjectItemRequest as DeleteProjectItemRequest, type context$3_DeleteProjectItemResponse as DeleteProjectItemResponse, type context$3_DeleteProjectItemResponseNonNullableFields as DeleteProjectItemResponseNonNullableFields, type DeletedProjectRestored$1 as DeletedProjectRestored, type DomainEvent$3 as DomainEvent, type DomainEventBodyOneOf$3 as DomainEventBodyOneOf, type context$3_DuplicateProjectItemsOptions as DuplicateProjectItemsOptions, type context$3_DuplicateProjectItemsRequest as DuplicateProjectItemsRequest, type context$3_DuplicateProjectItemsResponse as DuplicateProjectItemsResponse, type context$3_DuplicateProjectItemsResponseNonNullableFields as DuplicateProjectItemsResponseNonNullableFields, type Empty$2 as Empty, type EntityCreatedEvent$3 as EntityCreatedEvent, type EntityDeletedEvent$3 as EntityDeletedEvent, type EntityUpdatedEvent$3 as EntityUpdatedEvent, type EventMetadata$2 as EventMetadata, type File$1 as File, type context$3_GenerateTokenForProjectItemsRequest as GenerateTokenForProjectItemsRequest, type context$3_GenerateTokenForProjectItemsResponse as GenerateTokenForProjectItemsResponse, type context$3_GetProjectItemRequest as GetProjectItemRequest, type context$3_GetProjectItemResponse as GetProjectItemResponse, type context$3_GetProjectItemResponseNonNullableFields as GetProjectItemResponseNonNullableFields, type IdentificationData$3 as IdentificationData, type IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, type Image$2 as Image, ImageType$2 as ImageType, type InvalidateCache$1 as InvalidateCache, type InvalidateCacheGetByOneOf$1 as InvalidateCacheGetByOneOf, type context$3_Item as Item, type ItemMetadata$1 as ItemMetadata, type context$3_ItemMetadataOneOf as ItemMetadataOneOf, type context$3_ItemNonNullableFields as ItemNonNullableFields, type context$3_Link as Link, type context$3_ListProjectItemsOptions as ListProjectItemsOptions, type context$3_ListProjectItemsRequest as ListProjectItemsRequest, type context$3_ListProjectItemsResponse as ListProjectItemsResponse, type context$3_ListProjectItemsResponseNonNullableFields as ListProjectItemsResponseNonNullableFields, type context$3_MaskedItem as MaskedItem, type MessageEnvelope$3 as MessageEnvelope, type Page$1 as Page, type Paging$2 as Paging, type PagingMetadataV2$3 as PagingMetadataV2, type Point$2 as Point, type context$3_ProjectItemCreatedEnvelope as ProjectItemCreatedEnvelope, type context$3_ProjectItemDeletedEnvelope as ProjectItemDeletedEnvelope, type context$3_ProjectItemMediaToken as ProjectItemMediaToken, type context$3_ProjectItemUpdatedEnvelope as ProjectItemUpdatedEnvelope, type context$3_QueryProjectItemsRequest as QueryProjectItemsRequest, type context$3_QueryProjectItemsResponse as QueryProjectItemsResponse, type QueryV2$2 as QueryV2, type QueryV2PagingMethodOneOf$2 as QueryV2PagingMethodOneOf, type RestoreInfo$3 as RestoreInfo, SortOrder$2 as SortOrder, type Sorting$2 as Sorting, type context$3_Tags as Tags, context$3_Type as Type, type URI$1 as URI, type UnsharpMasking$2 as UnsharpMasking, type context$3_UpdateProjectItem as UpdateProjectItem, type context$3_UpdateProjectItemRequest as UpdateProjectItemRequest, type context$3_UpdateProjectItemResponse as UpdateProjectItemResponse, type context$3_UpdateProjectItemResponseNonNullableFields as UpdateProjectItemResponseNonNullableFields, type Video$2 as Video, type VideoResolution$2 as VideoResolution, WebhookIdentityType$3 as WebhookIdentityType, type context$3__publicOnProjectItemCreatedType as _publicOnProjectItemCreatedType, type context$3__publicOnProjectItemDeletedType as _publicOnProjectItemDeletedType, type context$3__publicOnProjectItemUpdatedType as _publicOnProjectItemUpdatedType, context$3_bulkCreateProjectItems as bulkCreateProjectItems, context$3_bulkDeleteProjectItems as bulkDeleteProjectItems, context$3_bulkUpdateProjectItems as bulkUpdateProjectItems, context$3_createProjectItem as createProjectItem, context$3_deleteProjectItem as deleteProjectItem, context$3_duplicateProjectItems as duplicateProjectItems, context$3_getProjectItem as getProjectItem, context$3_listProjectItems as listProjectItems, context$3_onProjectItemCreated as onProjectItemCreated, context$3_onProjectItemDeleted as onProjectItemDeleted, context$3_onProjectItemUpdated as onProjectItemUpdated, onProjectItemCreated$1 as publicOnProjectItemCreated, onProjectItemDeleted$1 as publicOnProjectItemDeleted, onProjectItemUpdated$1 as publicOnProjectItemUpdated, context$3_updateProjectItem as updateProjectItem };
|
|
2442
2462
|
}
|
|
2443
2463
|
|
|
2444
|
-
/** Project is the main entity of ProjectsService */
|
|
2445
2464
|
interface Project$1 extends ProjectCoverOneOf$1 {
|
|
2446
|
-
/**
|
|
2465
|
+
/** Project cover image. */
|
|
2447
2466
|
coverImage?: Image$1;
|
|
2448
|
-
/**
|
|
2467
|
+
/** Project cover video. */
|
|
2449
2468
|
coverVideo?: Video$1;
|
|
2450
2469
|
/**
|
|
2451
|
-
* Project ID
|
|
2470
|
+
* Project ID.
|
|
2452
2471
|
* @readonly
|
|
2453
2472
|
*/
|
|
2454
2473
|
_id?: string | null;
|
|
2455
2474
|
/**
|
|
2456
|
-
*
|
|
2475
|
+
* Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object.
|
|
2457
2476
|
* @readonly
|
|
2458
2477
|
*/
|
|
2459
2478
|
revision?: string | null;
|
|
2479
|
+
/** Project title. */
|
|
2460
2480
|
title?: string | null;
|
|
2481
|
+
/** Project description. */
|
|
2461
2482
|
description?: string | null;
|
|
2462
|
-
/**
|
|
2483
|
+
/** Whether the project is hidden from the portfolio. */
|
|
2463
2484
|
hidden?: boolean | null;
|
|
2464
|
-
/**
|
|
2485
|
+
/** IDs of the collections that include the project. */
|
|
2465
2486
|
collectionIds?: string[];
|
|
2466
|
-
/**
|
|
2487
|
+
/** Project details. */
|
|
2467
2488
|
details?: ProjectDetail$1[];
|
|
2468
|
-
/** Project
|
|
2489
|
+
/** Project slug. */
|
|
2469
2490
|
slug?: string | null;
|
|
2470
2491
|
/**
|
|
2471
|
-
*
|
|
2492
|
+
* Date and time the project was created.
|
|
2472
2493
|
* @readonly
|
|
2473
2494
|
*/
|
|
2474
2495
|
_createdDate?: Date;
|
|
2475
2496
|
/**
|
|
2476
|
-
*
|
|
2497
|
+
* Date and time the project was updated.
|
|
2477
2498
|
* @readonly
|
|
2478
2499
|
*/
|
|
2479
2500
|
_updatedDate?: Date;
|
|
2480
2501
|
/**
|
|
2481
|
-
*
|
|
2502
|
+
* Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
|
|
2482
2503
|
* @readonly
|
|
2483
2504
|
*/
|
|
2484
2505
|
url?: string;
|
|
2485
|
-
/** SEO data
|
|
2506
|
+
/** Project SEO data. */
|
|
2486
2507
|
seoData?: SeoSchema$1;
|
|
2487
2508
|
}
|
|
2488
2509
|
/** @oneof */
|
|
2489
2510
|
interface ProjectCoverOneOf$1 {
|
|
2490
|
-
/**
|
|
2511
|
+
/** Project cover image. */
|
|
2491
2512
|
coverImage?: Image$1;
|
|
2492
|
-
/**
|
|
2513
|
+
/** Project cover video. */
|
|
2493
2514
|
coverVideo?: Video$1;
|
|
2494
2515
|
}
|
|
2495
2516
|
interface Image$1 {
|
|
2496
|
-
/**
|
|
2517
|
+
/** Information about the Wix Media image. */
|
|
2497
2518
|
imageInfo?: string;
|
|
2498
2519
|
/** Focal point of the image. */
|
|
2499
2520
|
focalPoint?: Point$1;
|
|
@@ -2528,7 +2549,7 @@ interface UnsharpMasking$1 {
|
|
|
2528
2549
|
threshold?: number | null;
|
|
2529
2550
|
}
|
|
2530
2551
|
interface Video$1 {
|
|
2531
|
-
/**
|
|
2552
|
+
/** Information about the Wix Media video. */
|
|
2532
2553
|
videoInfo?: string;
|
|
2533
2554
|
/** Manually defined Video duration in milliseconds. */
|
|
2534
2555
|
durationInMillis?: number | null;
|
|
@@ -2547,21 +2568,30 @@ interface VideoResolution$1 {
|
|
|
2547
2568
|
/** Video filename. */
|
|
2548
2569
|
filename?: string | null;
|
|
2549
2570
|
}
|
|
2571
|
+
/**
|
|
2572
|
+
* Project label.
|
|
2573
|
+
* One of:
|
|
2574
|
+
* + `text`
|
|
2575
|
+
* + `link`
|
|
2576
|
+
*/
|
|
2550
2577
|
interface ProjectDetail$1 extends ProjectDetailValueOneOf$1 {
|
|
2578
|
+
/** Project label in plain text format. */
|
|
2551
2579
|
text?: string;
|
|
2552
|
-
/**
|
|
2580
|
+
/** Project label in link format. */
|
|
2553
2581
|
link?: DetailsLink$1;
|
|
2554
2582
|
label?: string;
|
|
2555
2583
|
}
|
|
2556
2584
|
/** @oneof */
|
|
2557
2585
|
interface ProjectDetailValueOneOf$1 {
|
|
2586
|
+
/** Project label in plain text format. */
|
|
2558
2587
|
text?: string;
|
|
2559
|
-
/**
|
|
2588
|
+
/** Project label in link format. */
|
|
2560
2589
|
link?: DetailsLink$1;
|
|
2561
2590
|
}
|
|
2562
2591
|
interface DetailsLink$1 {
|
|
2592
|
+
/** Display text of the link. */
|
|
2563
2593
|
text?: string | null;
|
|
2564
|
-
/**
|
|
2594
|
+
/** Target URL of the link. */
|
|
2565
2595
|
url?: string | null;
|
|
2566
2596
|
/**
|
|
2567
2597
|
* Whether the link opens in a new tab or window. One of:
|
|
@@ -3067,27 +3097,27 @@ interface DeletedProjectRestored {
|
|
|
3067
3097
|
deletionTimestamp?: Date;
|
|
3068
3098
|
}
|
|
3069
3099
|
interface CreateProjectRequest {
|
|
3070
|
-
/** Project to
|
|
3100
|
+
/** Project to create. */
|
|
3071
3101
|
project: Project$1;
|
|
3072
3102
|
}
|
|
3073
3103
|
interface CreateProjectResponse {
|
|
3074
|
-
/**
|
|
3104
|
+
/** Created project. */
|
|
3075
3105
|
project?: Project$1;
|
|
3076
3106
|
}
|
|
3077
3107
|
interface GetProjectRequest {
|
|
3078
|
-
/**
|
|
3108
|
+
/** ID of the project to retrieve. */
|
|
3079
3109
|
projectId: string;
|
|
3080
3110
|
/** Include page url */
|
|
3081
3111
|
includePageUrl?: boolean | null;
|
|
3082
3112
|
}
|
|
3083
3113
|
interface GetProjectResponse {
|
|
3084
|
-
/** The
|
|
3114
|
+
/** The requested project. */
|
|
3085
3115
|
project?: Project$1;
|
|
3086
3116
|
}
|
|
3087
3117
|
interface ListProjectsRequest {
|
|
3088
|
-
/** Projects limit per response is maximum 100, In the first request the cursor is None */
|
|
3118
|
+
/** Projects limit per response is maximum 100, In the first request the cursor is None ? */
|
|
3089
3119
|
paging?: CursorPaging$2;
|
|
3090
|
-
/** Include page url */
|
|
3120
|
+
/** Include page url ? */
|
|
3091
3121
|
includePageUrl?: boolean | null;
|
|
3092
3122
|
}
|
|
3093
3123
|
interface CursorPaging$2 {
|
|
@@ -3102,9 +3132,9 @@ interface CursorPaging$2 {
|
|
|
3102
3132
|
cursor?: string | null;
|
|
3103
3133
|
}
|
|
3104
3134
|
interface ListProjectsResponse {
|
|
3105
|
-
/**
|
|
3135
|
+
/** List of projects. */
|
|
3106
3136
|
projects?: Project$1[];
|
|
3107
|
-
/** Paging metadata */
|
|
3137
|
+
/** Paging metadata ? */
|
|
3108
3138
|
metadata?: PagingMetadataV2$2;
|
|
3109
3139
|
}
|
|
3110
3140
|
interface PagingMetadataV2$2 {
|
|
@@ -3126,33 +3156,33 @@ interface Cursors$2 {
|
|
|
3126
3156
|
prev?: string | null;
|
|
3127
3157
|
}
|
|
3128
3158
|
interface UpdateProjectRequest {
|
|
3129
|
-
/** Project to
|
|
3159
|
+
/** Project to update. */
|
|
3130
3160
|
project: Project$1;
|
|
3131
3161
|
}
|
|
3132
3162
|
interface UpdateProjectResponse {
|
|
3133
|
-
/**
|
|
3163
|
+
/** Updated project. */
|
|
3134
3164
|
project?: Project$1;
|
|
3135
3165
|
}
|
|
3136
3166
|
interface BulkUpdateProjectsRequest {
|
|
3137
|
-
/**
|
|
3167
|
+
/** Projects to update. */
|
|
3138
3168
|
projects?: MaskedProject[];
|
|
3139
|
-
/**
|
|
3169
|
+
/** Whether to include the updated projects in the response. Set to `true`` to receive the projects in the response. */
|
|
3140
3170
|
returnFullEntity?: boolean | null;
|
|
3141
3171
|
}
|
|
3142
3172
|
interface MaskedProject {
|
|
3143
|
-
/** Project to
|
|
3173
|
+
/** Project to update. */
|
|
3144
3174
|
project?: Project$1;
|
|
3145
3175
|
}
|
|
3146
3176
|
interface BulkUpdateProjectsResponse {
|
|
3147
|
-
/**
|
|
3177
|
+
/** Items created by bulk action. */
|
|
3148
3178
|
results?: BulkUpdateProjectsResult[];
|
|
3149
|
-
/**
|
|
3179
|
+
/** Bulk action metadata. */
|
|
3150
3180
|
bulkActionMetadata?: BulkActionMetadata;
|
|
3151
3181
|
}
|
|
3152
3182
|
interface BulkUpdateProjectsResult {
|
|
3153
|
-
/**
|
|
3183
|
+
/** Item metadata. */
|
|
3154
3184
|
itemMetadata?: ItemMetadata;
|
|
3155
|
-
/** Updated
|
|
3185
|
+
/** Updated project. */
|
|
3156
3186
|
project?: Project$1;
|
|
3157
3187
|
}
|
|
3158
3188
|
interface ItemMetadata {
|
|
@@ -3182,17 +3212,17 @@ interface BulkActionMetadata {
|
|
|
3182
3212
|
undetailedFailures?: number;
|
|
3183
3213
|
}
|
|
3184
3214
|
interface DeleteProjectRequest {
|
|
3185
|
-
/**
|
|
3215
|
+
/** ID of the project to delete. */
|
|
3186
3216
|
projectId: string;
|
|
3187
3217
|
}
|
|
3188
3218
|
interface DeleteProjectResponse {
|
|
3189
|
-
/**
|
|
3219
|
+
/** ID of the deleted project. */
|
|
3190
3220
|
projectId?: string;
|
|
3191
3221
|
}
|
|
3192
3222
|
interface QueryProjectsRequest {
|
|
3193
|
-
/**
|
|
3223
|
+
/** Query options. */
|
|
3194
3224
|
query: QueryV2$1;
|
|
3195
|
-
/** Include page url */
|
|
3225
|
+
/** Include page url ? */
|
|
3196
3226
|
includePageUrl?: boolean | null;
|
|
3197
3227
|
}
|
|
3198
3228
|
interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
|
|
@@ -3241,9 +3271,9 @@ interface Paging$1 {
|
|
|
3241
3271
|
offset?: number | null;
|
|
3242
3272
|
}
|
|
3243
3273
|
interface QueryProjectsResponse {
|
|
3244
|
-
/**
|
|
3274
|
+
/** List of projects. */
|
|
3245
3275
|
projects?: Project$1[];
|
|
3246
|
-
/** Paging metadata */
|
|
3276
|
+
/** Paging metadata ? */
|
|
3247
3277
|
metadata?: PagingMetadataV2$2;
|
|
3248
3278
|
}
|
|
3249
3279
|
interface UpdateProjectOrderInCollectionRequest$1 {
|
|
@@ -3534,62 +3564,64 @@ interface GetProjectOptions {
|
|
|
3534
3564
|
includePageUrl?: boolean | null;
|
|
3535
3565
|
}
|
|
3536
3566
|
interface ListProjectsOptions {
|
|
3537
|
-
/** Projects limit per response is maximum 100, In the first request the cursor is None */
|
|
3567
|
+
/** Projects limit per response is maximum 100, In the first request the cursor is None ? */
|
|
3538
3568
|
paging?: CursorPaging$2;
|
|
3539
|
-
/** Include page url */
|
|
3569
|
+
/** Include page url ? */
|
|
3540
3570
|
includePageUrl?: boolean | null;
|
|
3541
3571
|
}
|
|
3542
3572
|
interface UpdateProject {
|
|
3543
|
-
/**
|
|
3573
|
+
/** Project cover image. */
|
|
3544
3574
|
coverImage?: Image$1;
|
|
3545
|
-
/**
|
|
3575
|
+
/** Project cover video. */
|
|
3546
3576
|
coverVideo?: Video$1;
|
|
3547
3577
|
/**
|
|
3548
|
-
* Project ID
|
|
3578
|
+
* Project ID.
|
|
3549
3579
|
* @readonly
|
|
3550
3580
|
*/
|
|
3551
3581
|
_id?: string | null;
|
|
3552
3582
|
/**
|
|
3553
|
-
*
|
|
3583
|
+
* Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object.
|
|
3554
3584
|
* @readonly
|
|
3555
3585
|
*/
|
|
3556
3586
|
revision?: string | null;
|
|
3587
|
+
/** Project title. */
|
|
3557
3588
|
title?: string | null;
|
|
3589
|
+
/** Project description. */
|
|
3558
3590
|
description?: string | null;
|
|
3559
|
-
/**
|
|
3591
|
+
/** Whether the project is hidden from the portfolio. */
|
|
3560
3592
|
hidden?: boolean | null;
|
|
3561
|
-
/**
|
|
3593
|
+
/** IDs of the collections that include the project. */
|
|
3562
3594
|
collectionIds?: string[];
|
|
3563
|
-
/**
|
|
3595
|
+
/** Project details. */
|
|
3564
3596
|
details?: ProjectDetail$1[];
|
|
3565
|
-
/** Project
|
|
3597
|
+
/** Project slug. */
|
|
3566
3598
|
slug?: string | null;
|
|
3567
3599
|
/**
|
|
3568
|
-
*
|
|
3600
|
+
* Date and time the project was created.
|
|
3569
3601
|
* @readonly
|
|
3570
3602
|
*/
|
|
3571
3603
|
_createdDate?: Date;
|
|
3572
3604
|
/**
|
|
3573
|
-
*
|
|
3605
|
+
* Date and time the project was updated.
|
|
3574
3606
|
* @readonly
|
|
3575
3607
|
*/
|
|
3576
3608
|
_updatedDate?: Date;
|
|
3577
3609
|
/**
|
|
3578
|
-
*
|
|
3610
|
+
* Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
|
|
3579
3611
|
* @readonly
|
|
3580
3612
|
*/
|
|
3581
3613
|
url?: string;
|
|
3582
|
-
/** SEO data
|
|
3614
|
+
/** Project SEO data. */
|
|
3583
3615
|
seoData?: SeoSchema$1;
|
|
3584
3616
|
}
|
|
3585
3617
|
interface BulkUpdateProjectsOptions {
|
|
3586
|
-
/**
|
|
3618
|
+
/** Projects to update. */
|
|
3587
3619
|
projects?: MaskedProject[];
|
|
3588
|
-
/**
|
|
3620
|
+
/** Whether to include the updated projects in the response. Set to `true`` to receive the projects in the response. */
|
|
3589
3621
|
returnFullEntity?: boolean | null;
|
|
3590
3622
|
}
|
|
3591
3623
|
interface QueryProjectsOptions {
|
|
3592
|
-
/** Include page url */
|
|
3624
|
+
/** Include page url ? */
|
|
3593
3625
|
includePageUrl?: boolean | null | undefined;
|
|
3594
3626
|
}
|
|
3595
3627
|
interface QueryCursorResult$1 {
|
|
@@ -3695,57 +3727,61 @@ interface GetProjectPageDataSignature {
|
|
|
3695
3727
|
declare function createProject$1(httpClient: HttpClient): CreateProjectSignature;
|
|
3696
3728
|
interface CreateProjectSignature {
|
|
3697
3729
|
/**
|
|
3698
|
-
* Creates a
|
|
3699
|
-
* @param - Project to
|
|
3700
|
-
* @returns
|
|
3730
|
+
* Creates a project.
|
|
3731
|
+
* @param - Project to create.
|
|
3732
|
+
* @returns Created project.
|
|
3701
3733
|
*/
|
|
3702
3734
|
(project: Project$1): Promise<Project$1 & ProjectNonNullableFields$1>;
|
|
3703
3735
|
}
|
|
3704
3736
|
declare function getProject$1(httpClient: HttpClient): GetProjectSignature;
|
|
3705
3737
|
interface GetProjectSignature {
|
|
3706
3738
|
/**
|
|
3707
|
-
*
|
|
3708
|
-
* @param -
|
|
3709
|
-
* @returns The
|
|
3739
|
+
* Retrieves a project.
|
|
3740
|
+
* @param - ID of the project to retrieve.
|
|
3741
|
+
* @returns The requested project.
|
|
3710
3742
|
*/
|
|
3711
3743
|
(projectId: string, options?: GetProjectOptions | undefined): Promise<Project$1 & ProjectNonNullableFields$1>;
|
|
3712
3744
|
}
|
|
3713
3745
|
declare function listProjects$1(httpClient: HttpClient): ListProjectsSignature;
|
|
3714
3746
|
interface ListProjectsSignature {
|
|
3715
3747
|
/**
|
|
3716
|
-
*
|
|
3748
|
+
* Retrieves a list of all projects in a portfolio.
|
|
3717
3749
|
*/
|
|
3718
3750
|
(options?: ListProjectsOptions | undefined): Promise<ListProjectsResponse & ListProjectsResponseNonNullableFields>;
|
|
3719
3751
|
}
|
|
3720
3752
|
declare function updateProject$1(httpClient: HttpClient): UpdateProjectSignature;
|
|
3721
3753
|
interface UpdateProjectSignature {
|
|
3722
3754
|
/**
|
|
3723
|
-
*
|
|
3724
|
-
*
|
|
3725
|
-
* @
|
|
3726
|
-
* @returns The updated Project
|
|
3755
|
+
* Updates a project.
|
|
3756
|
+
* @param - Project ID.
|
|
3757
|
+
* @returns Updated project.
|
|
3727
3758
|
*/
|
|
3728
3759
|
(_id: string | null, project: UpdateProject): Promise<Project$1 & ProjectNonNullableFields$1>;
|
|
3729
3760
|
}
|
|
3730
3761
|
declare function bulkUpdateProjects$1(httpClient: HttpClient): BulkUpdateProjectsSignature;
|
|
3731
3762
|
interface BulkUpdateProjectsSignature {
|
|
3732
3763
|
/**
|
|
3733
|
-
*
|
|
3764
|
+
* Updates multiple projects.
|
|
3734
3765
|
*/
|
|
3735
3766
|
(options?: BulkUpdateProjectsOptions | undefined): Promise<BulkUpdateProjectsResponse & BulkUpdateProjectsResponseNonNullableFields>;
|
|
3736
3767
|
}
|
|
3737
3768
|
declare function deleteProject$1(httpClient: HttpClient): DeleteProjectSignature;
|
|
3738
3769
|
interface DeleteProjectSignature {
|
|
3739
3770
|
/**
|
|
3740
|
-
*
|
|
3741
|
-
* @param -
|
|
3771
|
+
* Deletes a project.
|
|
3772
|
+
* @param - ID of the project to delete.
|
|
3742
3773
|
*/
|
|
3743
3774
|
(projectId: string): Promise<DeleteProjectResponse & DeleteProjectResponseNonNullableFields>;
|
|
3744
3775
|
}
|
|
3745
3776
|
declare function queryProjects$1(httpClient: HttpClient): QueryProjectsSignature;
|
|
3746
3777
|
interface QueryProjectsSignature {
|
|
3747
3778
|
/**
|
|
3748
|
-
*
|
|
3779
|
+
* Retrieves a list of projects, given the provided paging, filtering, and sorting. Up to 100 projects can be returned per request.
|
|
3780
|
+
*
|
|
3781
|
+
* The default `sort` is `id` in `ASC`.
|
|
3782
|
+
*
|
|
3783
|
+
* For a detailed list of supported operations, see [Projects: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/sort-and-filter).
|
|
3784
|
+
* To learn how to query projects, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
|
|
3749
3785
|
*/
|
|
3750
3786
|
(options?: QueryProjectsOptions | undefined): ProjectsQueryBuilder;
|
|
3751
3787
|
}
|
|
@@ -3805,7 +3841,9 @@ declare const updateProjectOrderInCollection$2: MaybeContext<BuildRESTFunction<t
|
|
|
3805
3841
|
declare const queryProjectsWithCollectionInfo: MaybeContext<BuildRESTFunction<typeof queryProjectsWithCollectionInfo$1> & typeof queryProjectsWithCollectionInfo$1>;
|
|
3806
3842
|
|
|
3807
3843
|
type _publicOnProjectCreatedType = typeof onProjectCreated$1;
|
|
3808
|
-
/**
|
|
3844
|
+
/**
|
|
3845
|
+
* Triggered when a project is created.
|
|
3846
|
+
*/
|
|
3809
3847
|
declare const onProjectCreated: ReturnType<typeof createEventModule$1<_publicOnProjectCreatedType>>;
|
|
3810
3848
|
|
|
3811
3849
|
type _publicOnProjectUpdatedType = typeof onProjectUpdated$1;
|
|
@@ -3813,7 +3851,9 @@ type _publicOnProjectUpdatedType = typeof onProjectUpdated$1;
|
|
|
3813
3851
|
declare const onProjectUpdated: ReturnType<typeof createEventModule$1<_publicOnProjectUpdatedType>>;
|
|
3814
3852
|
|
|
3815
3853
|
type _publicOnProjectDeletedType = typeof onProjectDeleted$1;
|
|
3816
|
-
/**
|
|
3854
|
+
/**
|
|
3855
|
+
* Triggered when a project is deleted.
|
|
3856
|
+
*/
|
|
3817
3857
|
declare const onProjectDeleted: ReturnType<typeof createEventModule$1<_publicOnProjectDeletedType>>;
|
|
3818
3858
|
|
|
3819
3859
|
type context$2_App = App;
|
|
@@ -3901,59 +3941,60 @@ interface ProjectInCollection {
|
|
|
3901
3941
|
/** The sort order of the project in the given Collection */
|
|
3902
3942
|
sortOrder?: number | null;
|
|
3903
3943
|
}
|
|
3904
|
-
/** Project is the main entity of ProjectsService */
|
|
3905
3944
|
interface Project extends ProjectCoverOneOf {
|
|
3906
|
-
/**
|
|
3945
|
+
/** Project cover image. */
|
|
3907
3946
|
coverImage?: Image;
|
|
3908
|
-
/**
|
|
3947
|
+
/** Project cover video. */
|
|
3909
3948
|
coverVideo?: Video;
|
|
3910
3949
|
/**
|
|
3911
|
-
* Project ID
|
|
3950
|
+
* Project ID.
|
|
3912
3951
|
* @readonly
|
|
3913
3952
|
*/
|
|
3914
3953
|
_id?: string | null;
|
|
3915
3954
|
/**
|
|
3916
|
-
*
|
|
3955
|
+
* Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object.
|
|
3917
3956
|
* @readonly
|
|
3918
3957
|
*/
|
|
3919
3958
|
revision?: string | null;
|
|
3959
|
+
/** Project title. */
|
|
3920
3960
|
title?: string | null;
|
|
3961
|
+
/** Project description. */
|
|
3921
3962
|
description?: string | null;
|
|
3922
|
-
/**
|
|
3963
|
+
/** Whether the project is hidden from the portfolio. */
|
|
3923
3964
|
hidden?: boolean | null;
|
|
3924
|
-
/**
|
|
3965
|
+
/** IDs of the collections that include the project. */
|
|
3925
3966
|
collectionIds?: string[];
|
|
3926
|
-
/**
|
|
3967
|
+
/** Project details. */
|
|
3927
3968
|
details?: ProjectDetail[];
|
|
3928
|
-
/** Project
|
|
3969
|
+
/** Project slug. */
|
|
3929
3970
|
slug?: string | null;
|
|
3930
3971
|
/**
|
|
3931
|
-
*
|
|
3972
|
+
* Date and time the project was created.
|
|
3932
3973
|
* @readonly
|
|
3933
3974
|
*/
|
|
3934
3975
|
_createdDate?: Date;
|
|
3935
3976
|
/**
|
|
3936
|
-
*
|
|
3977
|
+
* Date and time the project was updated.
|
|
3937
3978
|
* @readonly
|
|
3938
3979
|
*/
|
|
3939
3980
|
_updatedDate?: Date;
|
|
3940
3981
|
/**
|
|
3941
|
-
*
|
|
3982
|
+
* Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
|
|
3942
3983
|
* @readonly
|
|
3943
3984
|
*/
|
|
3944
3985
|
url?: string;
|
|
3945
|
-
/** SEO data
|
|
3986
|
+
/** Project SEO data. */
|
|
3946
3987
|
seoData?: SeoSchema;
|
|
3947
3988
|
}
|
|
3948
3989
|
/** @oneof */
|
|
3949
3990
|
interface ProjectCoverOneOf {
|
|
3950
|
-
/**
|
|
3991
|
+
/** Project cover image. */
|
|
3951
3992
|
coverImage?: Image;
|
|
3952
|
-
/**
|
|
3993
|
+
/** Project cover video. */
|
|
3953
3994
|
coverVideo?: Video;
|
|
3954
3995
|
}
|
|
3955
3996
|
interface Image {
|
|
3956
|
-
/**
|
|
3997
|
+
/** Information about the Wix Media image. */
|
|
3957
3998
|
imageInfo?: string;
|
|
3958
3999
|
/** Focal point of the image. */
|
|
3959
4000
|
focalPoint?: Point;
|
|
@@ -3988,7 +4029,7 @@ interface UnsharpMasking {
|
|
|
3988
4029
|
threshold?: number | null;
|
|
3989
4030
|
}
|
|
3990
4031
|
interface Video {
|
|
3991
|
-
/**
|
|
4032
|
+
/** Information about the Wix Media video. */
|
|
3992
4033
|
videoInfo?: string;
|
|
3993
4034
|
/** Manually defined Video duration in milliseconds. */
|
|
3994
4035
|
durationInMillis?: number | null;
|
|
@@ -4007,21 +4048,30 @@ interface VideoResolution {
|
|
|
4007
4048
|
/** Video filename. */
|
|
4008
4049
|
filename?: string | null;
|
|
4009
4050
|
}
|
|
4051
|
+
/**
|
|
4052
|
+
* Project label.
|
|
4053
|
+
* One of:
|
|
4054
|
+
* + `text`
|
|
4055
|
+
* + `link`
|
|
4056
|
+
*/
|
|
4010
4057
|
interface ProjectDetail extends ProjectDetailValueOneOf {
|
|
4058
|
+
/** Project label in plain text format. */
|
|
4011
4059
|
text?: string;
|
|
4012
|
-
/**
|
|
4060
|
+
/** Project label in link format. */
|
|
4013
4061
|
link?: DetailsLink;
|
|
4014
4062
|
label?: string;
|
|
4015
4063
|
}
|
|
4016
4064
|
/** @oneof */
|
|
4017
4065
|
interface ProjectDetailValueOneOf {
|
|
4066
|
+
/** Project label in plain text format. */
|
|
4018
4067
|
text?: string;
|
|
4019
|
-
/**
|
|
4068
|
+
/** Project label in link format. */
|
|
4020
4069
|
link?: DetailsLink;
|
|
4021
4070
|
}
|
|
4022
4071
|
interface DetailsLink {
|
|
4072
|
+
/** Display text of the link. */
|
|
4023
4073
|
text?: string | null;
|
|
4024
|
-
/**
|
|
4074
|
+
/** Target URL of the link. */
|
|
4025
4075
|
url?: string | null;
|
|
4026
4076
|
/**
|
|
4027
4077
|
* Whether the link opens in a new tab or window. One of:
|