@wix/auto_sdk_portfolio_projects 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/portfolio-projects-v1-project-projects.types.d.ts +296 -72
- package/build/cjs/src/portfolio-projects-v1-project-projects.types.js.map +1 -1
- package/build/cjs/src/portfolio-projects-v1-project-projects.universal.d.ts +323 -79
- package/build/cjs/src/portfolio-projects-v1-project-projects.universal.js.map +1 -1
- package/build/es/src/portfolio-projects-v1-project-projects.types.d.ts +296 -72
- package/build/es/src/portfolio-projects-v1-project-projects.types.js.map +1 -1
- package/build/es/src/portfolio-projects-v1-project-projects.universal.d.ts +323 -79
- package/build/es/src/portfolio-projects-v1-project-projects.universal.js.map +1 -1
- package/build/internal/cjs/src/portfolio-projects-v1-project-projects.types.d.ts +296 -72
- package/build/internal/cjs/src/portfolio-projects-v1-project-projects.types.js.map +1 -1
- package/build/internal/cjs/src/portfolio-projects-v1-project-projects.universal.d.ts +323 -79
- package/build/internal/cjs/src/portfolio-projects-v1-project-projects.universal.js.map +1 -1
- package/build/internal/es/src/portfolio-projects-v1-project-projects.types.d.ts +296 -72
- package/build/internal/es/src/portfolio-projects-v1-project-projects.types.js.map +1 -1
- package/build/internal/es/src/portfolio-projects-v1-project-projects.universal.d.ts +323 -79
- package/build/internal/es/src/portfolio-projects-v1-project-projects.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -6,6 +6,7 @@ export interface Project extends ProjectCoverOneOf {
|
|
|
6
6
|
/**
|
|
7
7
|
* Project ID.
|
|
8
8
|
* @readonly
|
|
9
|
+
* @format GUID
|
|
9
10
|
*/
|
|
10
11
|
id?: string | null;
|
|
11
12
|
/**
|
|
@@ -13,13 +14,20 @@ export interface Project extends ProjectCoverOneOf {
|
|
|
13
14
|
* @readonly
|
|
14
15
|
*/
|
|
15
16
|
revision?: string | null;
|
|
16
|
-
/**
|
|
17
|
+
/**
|
|
18
|
+
* Project title.
|
|
19
|
+
* @maxLength 100
|
|
20
|
+
*/
|
|
17
21
|
title?: string | null;
|
|
18
22
|
/** Project description. */
|
|
19
23
|
description?: string | null;
|
|
20
24
|
/** Whether the project is hidden from the portfolio. Default: `false` */
|
|
21
25
|
hidden?: boolean | null;
|
|
22
|
-
/**
|
|
26
|
+
/**
|
|
27
|
+
* IDs of the collections that include the project.
|
|
28
|
+
* @format GUID
|
|
29
|
+
* @maxSize 1000
|
|
30
|
+
*/
|
|
23
31
|
collectionIds?: string[];
|
|
24
32
|
/** Project details. */
|
|
25
33
|
details?: ProjectDetail[];
|
|
@@ -36,7 +44,7 @@ export interface Project extends ProjectCoverOneOf {
|
|
|
36
44
|
*/
|
|
37
45
|
updatedDate?: Date | null;
|
|
38
46
|
/**
|
|
39
|
-
* Project page URL and
|
|
47
|
+
* Project page URL and relative path. Returned when `includePageUrl` is `true` in the request.
|
|
40
48
|
* @readonly
|
|
41
49
|
*/
|
|
42
50
|
url?: PageUrlV2;
|
|
@@ -90,6 +98,7 @@ export interface UnsharpMasking {
|
|
|
90
98
|
*
|
|
91
99
|
* Min: `0` <br />
|
|
92
100
|
* Max: `5`
|
|
101
|
+
* @max 5
|
|
93
102
|
*/
|
|
94
103
|
amount?: number | null;
|
|
95
104
|
/** Unsharp masking radius in pixels. Controls the sharpening width. */
|
|
@@ -99,6 +108,7 @@ export interface UnsharpMasking {
|
|
|
99
108
|
*
|
|
100
109
|
* Min: `0` <br />
|
|
101
110
|
* Max: `1`
|
|
111
|
+
* @max 1
|
|
102
112
|
*/
|
|
103
113
|
threshold?: number | null;
|
|
104
114
|
}
|
|
@@ -113,7 +123,10 @@ export interface VideoV2 {
|
|
|
113
123
|
id?: string;
|
|
114
124
|
/** Video URL. */
|
|
115
125
|
url?: string;
|
|
116
|
-
/**
|
|
126
|
+
/**
|
|
127
|
+
* Available resolutions for the video, starting with the optimal resolution.
|
|
128
|
+
* @maxSize 100
|
|
129
|
+
*/
|
|
117
130
|
resolutions?: VideoResolution[];
|
|
118
131
|
/** Video filename. */
|
|
119
132
|
filename?: string | null;
|
|
@@ -158,7 +171,10 @@ export interface ProjectDetailValueOneOf {
|
|
|
158
171
|
export interface DetailsLink {
|
|
159
172
|
/** Display text of the link. */
|
|
160
173
|
text?: string | null;
|
|
161
|
-
/**
|
|
174
|
+
/**
|
|
175
|
+
* Target URL of the link.
|
|
176
|
+
* @format WEB_URL
|
|
177
|
+
*/
|
|
162
178
|
url?: string | null;
|
|
163
179
|
/**
|
|
164
180
|
* Whether the link opens in a new tab or window. One of:
|
|
@@ -168,15 +184,31 @@ export interface DetailsLink {
|
|
|
168
184
|
target?: string | null;
|
|
169
185
|
}
|
|
170
186
|
export interface ProjectSource {
|
|
171
|
-
/**
|
|
187
|
+
/**
|
|
188
|
+
* App definition id
|
|
189
|
+
* @immutable
|
|
190
|
+
*/
|
|
172
191
|
appDefId?: string;
|
|
173
|
-
/**
|
|
192
|
+
/**
|
|
193
|
+
* External source id
|
|
194
|
+
* @immutable
|
|
195
|
+
*/
|
|
174
196
|
externalId?: string;
|
|
175
|
-
/**
|
|
197
|
+
/**
|
|
198
|
+
* Source name
|
|
199
|
+
* @maxLength 100
|
|
200
|
+
* @immutable
|
|
201
|
+
*/
|
|
176
202
|
sourceName?: string;
|
|
177
|
-
/**
|
|
203
|
+
/**
|
|
204
|
+
* Source description
|
|
205
|
+
* @immutable
|
|
206
|
+
*/
|
|
178
207
|
description?: string | null;
|
|
179
|
-
/**
|
|
208
|
+
/**
|
|
209
|
+
* link to external source
|
|
210
|
+
* @format WEB_URL
|
|
211
|
+
*/
|
|
180
212
|
link?: string | null;
|
|
181
213
|
/** Sync status */
|
|
182
214
|
syncStatus?: SyncStatus;
|
|
@@ -212,7 +244,10 @@ export interface Keyword {
|
|
|
212
244
|
term?: string;
|
|
213
245
|
/** Whether the keyword is the main focus keyword. */
|
|
214
246
|
isMain?: boolean;
|
|
215
|
-
/**
|
|
247
|
+
/**
|
|
248
|
+
* The source that added the keyword terms to the SEO settings.
|
|
249
|
+
* @maxLength 1000
|
|
250
|
+
*/
|
|
216
251
|
origin?: string | null;
|
|
217
252
|
}
|
|
218
253
|
export interface Tag {
|
|
@@ -245,7 +280,10 @@ export interface Settings {
|
|
|
245
280
|
* Default: `false` (Auto Redirect is enabled.)
|
|
246
281
|
*/
|
|
247
282
|
preventAutoRedirect?: boolean;
|
|
248
|
-
/**
|
|
283
|
+
/**
|
|
284
|
+
* User-selected keyword terms for a specific page.
|
|
285
|
+
* @maxSize 5
|
|
286
|
+
*/
|
|
249
287
|
keywords?: Keyword[];
|
|
250
288
|
}
|
|
251
289
|
export interface MenuSettingUpdatedEvent {
|
|
@@ -265,7 +303,10 @@ export interface GetProjectPageDataResponse {
|
|
|
265
303
|
nextProject?: ProjectSlug;
|
|
266
304
|
}
|
|
267
305
|
export interface ProjectSlug {
|
|
268
|
-
/**
|
|
306
|
+
/**
|
|
307
|
+
* Project id
|
|
308
|
+
* @format GUID
|
|
309
|
+
*/
|
|
269
310
|
projectId?: string;
|
|
270
311
|
/** Project slug */
|
|
271
312
|
slug?: string;
|
|
@@ -305,7 +346,10 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
305
346
|
studioAssigned?: StudioAssigned;
|
|
306
347
|
/** Emitted when Studio is detached. */
|
|
307
348
|
studioUnassigned?: StudioUnassigned;
|
|
308
|
-
/**
|
|
349
|
+
/**
|
|
350
|
+
* A meta site id.
|
|
351
|
+
* @format GUID
|
|
352
|
+
*/
|
|
309
353
|
metaSiteId?: string;
|
|
310
354
|
/** A meta site version. Monotonically increasing. */
|
|
311
355
|
version?: string;
|
|
@@ -314,6 +358,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
314
358
|
/**
|
|
315
359
|
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
316
360
|
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
361
|
+
* @maxSize 4000
|
|
317
362
|
*/
|
|
318
363
|
assets?: Asset[];
|
|
319
364
|
}
|
|
@@ -351,9 +396,15 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
351
396
|
studioUnassigned?: StudioUnassigned;
|
|
352
397
|
}
|
|
353
398
|
export interface Asset {
|
|
354
|
-
/**
|
|
399
|
+
/**
|
|
400
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
401
|
+
* @maxLength 36
|
|
402
|
+
*/
|
|
355
403
|
appDefId?: string;
|
|
356
|
-
/**
|
|
404
|
+
/**
|
|
405
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
406
|
+
* @maxLength 200
|
|
407
|
+
*/
|
|
357
408
|
instanceId?: string;
|
|
358
409
|
/** An application state. */
|
|
359
410
|
state?: State;
|
|
@@ -366,9 +417,15 @@ export declare enum State {
|
|
|
366
417
|
DEMO = "DEMO"
|
|
367
418
|
}
|
|
368
419
|
export interface SiteCreated {
|
|
369
|
-
/**
|
|
420
|
+
/**
|
|
421
|
+
* A template identifier (empty if not created from a template).
|
|
422
|
+
* @maxLength 36
|
|
423
|
+
*/
|
|
370
424
|
originTemplateId?: string;
|
|
371
|
-
/**
|
|
425
|
+
/**
|
|
426
|
+
* An account id of the owner.
|
|
427
|
+
* @format GUID
|
|
428
|
+
*/
|
|
372
429
|
ownerId?: string;
|
|
373
430
|
/** A context in which meta site was created. */
|
|
374
431
|
context?: SiteCreatedContext;
|
|
@@ -377,9 +434,13 @@ export interface SiteCreated {
|
|
|
377
434
|
*
|
|
378
435
|
* In case of a creation from a template it's a template id.
|
|
379
436
|
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
437
|
+
* @format GUID
|
|
380
438
|
*/
|
|
381
439
|
originMetaSiteId?: string | null;
|
|
382
|
-
/**
|
|
440
|
+
/**
|
|
441
|
+
* A meta site name (URL slug).
|
|
442
|
+
* @maxLength 20
|
|
443
|
+
*/
|
|
383
444
|
siteName?: string;
|
|
384
445
|
/** A namespace. */
|
|
385
446
|
namespace?: Namespace;
|
|
@@ -476,9 +537,15 @@ export declare enum Namespace {
|
|
|
476
537
|
}
|
|
477
538
|
/** Site transferred to another user. */
|
|
478
539
|
export interface SiteTransferred {
|
|
479
|
-
/**
|
|
540
|
+
/**
|
|
541
|
+
* A previous owner id (user that transfers meta site).
|
|
542
|
+
* @format GUID
|
|
543
|
+
*/
|
|
480
544
|
oldOwnerId?: string;
|
|
481
|
-
/**
|
|
545
|
+
/**
|
|
546
|
+
* A new owner id (user that accepts meta site).
|
|
547
|
+
* @format GUID
|
|
548
|
+
*/
|
|
482
549
|
newOwnerId?: string;
|
|
483
550
|
}
|
|
484
551
|
/** Soft deletion of the meta site. Could be restored. */
|
|
@@ -491,9 +558,15 @@ export interface DeleteContext {
|
|
|
491
558
|
dateDeleted?: Date | null;
|
|
492
559
|
/** A status. */
|
|
493
560
|
deleteStatus?: DeleteStatus;
|
|
494
|
-
/**
|
|
561
|
+
/**
|
|
562
|
+
* A reason (flow).
|
|
563
|
+
* @maxLength 255
|
|
564
|
+
*/
|
|
495
565
|
deleteOrigin?: string;
|
|
496
|
-
/**
|
|
566
|
+
/**
|
|
567
|
+
* A service that deleted it.
|
|
568
|
+
* @maxLength 255
|
|
569
|
+
*/
|
|
497
570
|
initiatorId?: string | null;
|
|
498
571
|
}
|
|
499
572
|
export declare enum DeleteStatus {
|
|
@@ -509,7 +582,11 @@ export interface SiteUndeleted {
|
|
|
509
582
|
export interface SitePublished {
|
|
510
583
|
}
|
|
511
584
|
export interface SiteUnpublished {
|
|
512
|
-
/**
|
|
585
|
+
/**
|
|
586
|
+
* A list of URLs previously associated with the meta site.
|
|
587
|
+
* @maxLength 4000
|
|
588
|
+
* @maxSize 10000
|
|
589
|
+
*/
|
|
513
590
|
urls?: string[];
|
|
514
591
|
}
|
|
515
592
|
export interface SiteMarkedAsTemplate {
|
|
@@ -532,30 +609,60 @@ export interface SiteMarkedAsWixSite {
|
|
|
532
609
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
533
610
|
*/
|
|
534
611
|
export interface ServiceProvisioned {
|
|
535
|
-
/**
|
|
612
|
+
/**
|
|
613
|
+
* Either UUID or EmbeddedServiceType.
|
|
614
|
+
* @maxLength 36
|
|
615
|
+
*/
|
|
536
616
|
appDefId?: string;
|
|
537
|
-
/**
|
|
617
|
+
/**
|
|
618
|
+
* Not only UUID. Something here could be something weird.
|
|
619
|
+
* @maxLength 36
|
|
620
|
+
*/
|
|
538
621
|
instanceId?: string;
|
|
539
|
-
/**
|
|
622
|
+
/**
|
|
623
|
+
* An instance id from which this instance is originated.
|
|
624
|
+
* @maxLength 36
|
|
625
|
+
*/
|
|
540
626
|
originInstanceId?: string;
|
|
541
|
-
/**
|
|
627
|
+
/**
|
|
628
|
+
* A version.
|
|
629
|
+
* @maxLength 500
|
|
630
|
+
*/
|
|
542
631
|
version?: string | null;
|
|
543
|
-
/**
|
|
632
|
+
/**
|
|
633
|
+
* The origin meta site id
|
|
634
|
+
* @format GUID
|
|
635
|
+
*/
|
|
544
636
|
originMetaSiteId?: string | null;
|
|
545
637
|
}
|
|
546
638
|
export interface ServiceRemoved {
|
|
547
|
-
/**
|
|
639
|
+
/**
|
|
640
|
+
* Either UUID or EmbeddedServiceType.
|
|
641
|
+
* @maxLength 36
|
|
642
|
+
*/
|
|
548
643
|
appDefId?: string;
|
|
549
|
-
/**
|
|
644
|
+
/**
|
|
645
|
+
* Not only UUID. Something here could be something weird.
|
|
646
|
+
* @maxLength 36
|
|
647
|
+
*/
|
|
550
648
|
instanceId?: string;
|
|
551
|
-
/**
|
|
649
|
+
/**
|
|
650
|
+
* A version.
|
|
651
|
+
* @maxLength 500
|
|
652
|
+
*/
|
|
552
653
|
version?: string | null;
|
|
553
654
|
}
|
|
554
655
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
555
656
|
export interface SiteRenamed {
|
|
556
|
-
/**
|
|
657
|
+
/**
|
|
658
|
+
* A new meta site name (URL slug).
|
|
659
|
+
* @maxLength 20
|
|
660
|
+
*/
|
|
557
661
|
newSiteName?: string;
|
|
558
|
-
/**
|
|
662
|
+
/**
|
|
663
|
+
* A previous meta site name (URL slug).
|
|
664
|
+
* @maxLength 255
|
|
665
|
+
*/
|
|
559
666
|
oldSiteName?: string;
|
|
560
667
|
}
|
|
561
668
|
/**
|
|
@@ -582,9 +689,15 @@ export interface StudioUnassigned {
|
|
|
582
689
|
export interface Empty {
|
|
583
690
|
}
|
|
584
691
|
export interface MessageEnvelope {
|
|
585
|
-
/**
|
|
692
|
+
/**
|
|
693
|
+
* App instance ID.
|
|
694
|
+
* @format GUID
|
|
695
|
+
*/
|
|
586
696
|
instanceId?: string | null;
|
|
587
|
-
/**
|
|
697
|
+
/**
|
|
698
|
+
* Event type.
|
|
699
|
+
* @maxLength 150
|
|
700
|
+
*/
|
|
588
701
|
eventType?: string;
|
|
589
702
|
/** The identification type and identity data. */
|
|
590
703
|
identity?: IdentificationData;
|
|
@@ -592,26 +705,50 @@ export interface MessageEnvelope {
|
|
|
592
705
|
data?: string;
|
|
593
706
|
}
|
|
594
707
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
595
|
-
/**
|
|
708
|
+
/**
|
|
709
|
+
* ID of a site visitor that has not logged in to the site.
|
|
710
|
+
* @format GUID
|
|
711
|
+
*/
|
|
596
712
|
anonymousVisitorId?: string;
|
|
597
|
-
/**
|
|
713
|
+
/**
|
|
714
|
+
* ID of a site visitor that has logged in to the site.
|
|
715
|
+
* @format GUID
|
|
716
|
+
*/
|
|
598
717
|
memberId?: string;
|
|
599
|
-
/**
|
|
718
|
+
/**
|
|
719
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
720
|
+
* @format GUID
|
|
721
|
+
*/
|
|
600
722
|
wixUserId?: string;
|
|
601
|
-
/**
|
|
723
|
+
/**
|
|
724
|
+
* ID of an app.
|
|
725
|
+
* @format GUID
|
|
726
|
+
*/
|
|
602
727
|
appId?: string;
|
|
603
728
|
/** @readonly */
|
|
604
729
|
identityType?: WebhookIdentityType;
|
|
605
730
|
}
|
|
606
731
|
/** @oneof */
|
|
607
732
|
export interface IdentificationDataIdOneOf {
|
|
608
|
-
/**
|
|
733
|
+
/**
|
|
734
|
+
* ID of a site visitor that has not logged in to the site.
|
|
735
|
+
* @format GUID
|
|
736
|
+
*/
|
|
609
737
|
anonymousVisitorId?: string;
|
|
610
|
-
/**
|
|
738
|
+
/**
|
|
739
|
+
* ID of a site visitor that has logged in to the site.
|
|
740
|
+
* @format GUID
|
|
741
|
+
*/
|
|
611
742
|
memberId?: string;
|
|
612
|
-
/**
|
|
743
|
+
/**
|
|
744
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
745
|
+
* @format GUID
|
|
746
|
+
*/
|
|
613
747
|
wixUserId?: string;
|
|
614
|
-
/**
|
|
748
|
+
/**
|
|
749
|
+
* ID of an app.
|
|
750
|
+
* @format GUID
|
|
751
|
+
*/
|
|
615
752
|
appId?: string;
|
|
616
753
|
}
|
|
617
754
|
export declare enum WebhookIdentityType {
|
|
@@ -622,9 +759,15 @@ export declare enum WebhookIdentityType {
|
|
|
622
759
|
APP = "APP"
|
|
623
760
|
}
|
|
624
761
|
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
625
|
-
/**
|
|
762
|
+
/**
|
|
763
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
764
|
+
* @format GUID
|
|
765
|
+
*/
|
|
626
766
|
metaSiteId?: string;
|
|
627
|
-
/**
|
|
767
|
+
/**
|
|
768
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
769
|
+
* @format GUID
|
|
770
|
+
*/
|
|
628
771
|
siteId?: string;
|
|
629
772
|
/** Invalidate by App */
|
|
630
773
|
app?: App;
|
|
@@ -634,7 +777,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
634
777
|
uri?: URI;
|
|
635
778
|
/** Invalidate by file (for media files such as PDFs) */
|
|
636
779
|
file?: File;
|
|
637
|
-
/**
|
|
780
|
+
/**
|
|
781
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
782
|
+
* @maxLength 256
|
|
783
|
+
*/
|
|
638
784
|
reason?: string | null;
|
|
639
785
|
/** Is local DS */
|
|
640
786
|
localDc?: boolean;
|
|
@@ -642,9 +788,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
642
788
|
}
|
|
643
789
|
/** @oneof */
|
|
644
790
|
export interface InvalidateCacheGetByOneOf {
|
|
645
|
-
/**
|
|
791
|
+
/**
|
|
792
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
793
|
+
* @format GUID
|
|
794
|
+
*/
|
|
646
795
|
metaSiteId?: string;
|
|
647
|
-
/**
|
|
796
|
+
/**
|
|
797
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
798
|
+
* @format GUID
|
|
799
|
+
*/
|
|
648
800
|
siteId?: string;
|
|
649
801
|
/** Invalidate by App */
|
|
650
802
|
app?: App;
|
|
@@ -656,37 +808,71 @@ export interface InvalidateCacheGetByOneOf {
|
|
|
656
808
|
file?: File;
|
|
657
809
|
}
|
|
658
810
|
export interface App {
|
|
659
|
-
/**
|
|
811
|
+
/**
|
|
812
|
+
* The AppDefId
|
|
813
|
+
* @minLength 1
|
|
814
|
+
*/
|
|
660
815
|
appDefId?: string;
|
|
661
|
-
/**
|
|
816
|
+
/**
|
|
817
|
+
* The instance Id
|
|
818
|
+
* @format GUID
|
|
819
|
+
*/
|
|
662
820
|
instanceId?: string;
|
|
663
821
|
}
|
|
664
822
|
export interface Page {
|
|
665
|
-
/**
|
|
823
|
+
/**
|
|
824
|
+
* the msid the page is on
|
|
825
|
+
* @format GUID
|
|
826
|
+
*/
|
|
666
827
|
metaSiteId?: string;
|
|
667
|
-
/**
|
|
828
|
+
/**
|
|
829
|
+
* Invalidate by Page ID
|
|
830
|
+
* @minLength 1
|
|
831
|
+
*/
|
|
668
832
|
pageId?: string;
|
|
669
833
|
}
|
|
670
834
|
export interface URI {
|
|
671
|
-
/**
|
|
835
|
+
/**
|
|
836
|
+
* the msid the URI is on
|
|
837
|
+
* @format GUID
|
|
838
|
+
*/
|
|
672
839
|
metaSiteId?: string;
|
|
673
|
-
/**
|
|
840
|
+
/**
|
|
841
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
842
|
+
* @minLength 1
|
|
843
|
+
*/
|
|
674
844
|
uriPath?: string;
|
|
675
845
|
}
|
|
676
846
|
export interface File {
|
|
677
|
-
/**
|
|
847
|
+
/**
|
|
848
|
+
* the msid the file is related to
|
|
849
|
+
* @format GUID
|
|
850
|
+
*/
|
|
678
851
|
metaSiteId?: string;
|
|
679
|
-
/**
|
|
852
|
+
/**
|
|
853
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
854
|
+
* @minLength 1
|
|
855
|
+
* @maxLength 256
|
|
856
|
+
*/
|
|
680
857
|
fileName?: string;
|
|
681
858
|
}
|
|
682
859
|
export interface SyncProjectWithCollectionMappings {
|
|
683
|
-
/**
|
|
860
|
+
/**
|
|
861
|
+
* Id of recently updated Project
|
|
862
|
+
* @format GUID
|
|
863
|
+
*/
|
|
684
864
|
projectId?: string;
|
|
685
|
-
/**
|
|
865
|
+
/**
|
|
866
|
+
* fields that were updated in the given project
|
|
867
|
+
* @maxSize 100
|
|
868
|
+
*/
|
|
686
869
|
fieldMaskPaths?: string[];
|
|
687
870
|
}
|
|
688
871
|
export interface DeletedProjectRestored {
|
|
689
|
-
/**
|
|
872
|
+
/**
|
|
873
|
+
* the id of the project that was restored
|
|
874
|
+
* @format GUID
|
|
875
|
+
*/
|
|
690
876
|
projectId?: string;
|
|
691
877
|
/** timestamp for when the project was originally deleted. */
|
|
692
878
|
deletionTimestamp?: Date | null;
|
|
@@ -700,7 +886,10 @@ export interface CreateProjectResponse {
|
|
|
700
886
|
project?: Project;
|
|
701
887
|
}
|
|
702
888
|
export interface GetProjectRequest {
|
|
703
|
-
/**
|
|
889
|
+
/**
|
|
890
|
+
* ID of the project to retrieve.
|
|
891
|
+
* @format GUID
|
|
892
|
+
*/
|
|
704
893
|
projectId: string;
|
|
705
894
|
/** Whether to include the project's relative path and full URL in the response. Default: `false` */
|
|
706
895
|
includePageUrl?: boolean | null;
|
|
@@ -716,13 +905,17 @@ export interface ListProjectsRequest {
|
|
|
716
905
|
includePageUrl?: boolean | null;
|
|
717
906
|
}
|
|
718
907
|
export interface CursorPaging {
|
|
719
|
-
/**
|
|
908
|
+
/**
|
|
909
|
+
* Maximum number of items to return in the results.
|
|
910
|
+
* @max 100
|
|
911
|
+
*/
|
|
720
912
|
limit?: number | null;
|
|
721
913
|
/**
|
|
722
914
|
* Pointer to the next or previous page in the list of results.
|
|
723
915
|
*
|
|
724
916
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
725
917
|
* Not relevant for the first request.
|
|
918
|
+
* @maxLength 16000
|
|
726
919
|
*/
|
|
727
920
|
cursor?: string | null;
|
|
728
921
|
}
|
|
@@ -745,9 +938,15 @@ export interface PagingMetadataV2 {
|
|
|
745
938
|
cursors?: Cursors;
|
|
746
939
|
}
|
|
747
940
|
export interface Cursors {
|
|
748
|
-
/**
|
|
941
|
+
/**
|
|
942
|
+
* Cursor string pointing to the next page in the list of results.
|
|
943
|
+
* @maxLength 16000
|
|
944
|
+
*/
|
|
749
945
|
next?: string | null;
|
|
750
|
-
/**
|
|
946
|
+
/**
|
|
947
|
+
* Cursor pointing to the previous page in the list of results.
|
|
948
|
+
* @maxLength 16000
|
|
949
|
+
*/
|
|
751
950
|
prev?: string | null;
|
|
752
951
|
}
|
|
753
952
|
export interface UpdateProjectRequest {
|
|
@@ -759,7 +958,10 @@ export interface UpdateProjectResponse {
|
|
|
759
958
|
project?: Project;
|
|
760
959
|
}
|
|
761
960
|
export interface BulkUpdateProjectsRequest {
|
|
762
|
-
/**
|
|
961
|
+
/**
|
|
962
|
+
* Projects to update.
|
|
963
|
+
* @maxSize 100
|
|
964
|
+
*/
|
|
763
965
|
projects?: MaskedProject[];
|
|
764
966
|
/** Whether to include the updated projects in the response. Set to `true` to receive the projects in the response. Default: `false` */
|
|
765
967
|
returnFullEntity?: boolean | null;
|
|
@@ -807,11 +1009,17 @@ export interface BulkActionMetadata {
|
|
|
807
1009
|
undetailedFailures?: number;
|
|
808
1010
|
}
|
|
809
1011
|
export interface DeleteProjectRequest {
|
|
810
|
-
/**
|
|
1012
|
+
/**
|
|
1013
|
+
* ID of the project to delete.
|
|
1014
|
+
* @format GUID
|
|
1015
|
+
*/
|
|
811
1016
|
projectId: string;
|
|
812
1017
|
}
|
|
813
1018
|
export interface DeleteProjectResponse {
|
|
814
|
-
/**
|
|
1019
|
+
/**
|
|
1020
|
+
* ID of the deleted project.
|
|
1021
|
+
* @format GUID
|
|
1022
|
+
*/
|
|
815
1023
|
projectId?: string;
|
|
816
1024
|
}
|
|
817
1025
|
export interface QueryProjectsRequest {
|
|
@@ -850,7 +1058,10 @@ export interface QueryV2PagingMethodOneOf {
|
|
|
850
1058
|
cursorPaging?: CursorPaging;
|
|
851
1059
|
}
|
|
852
1060
|
export interface Sorting {
|
|
853
|
-
/**
|
|
1061
|
+
/**
|
|
1062
|
+
* Name of the field to sort by.
|
|
1063
|
+
* @maxLength 512
|
|
1064
|
+
*/
|
|
854
1065
|
fieldName?: string;
|
|
855
1066
|
/** Sort order. */
|
|
856
1067
|
order?: SortOrder;
|
|
@@ -872,9 +1083,15 @@ export interface QueryProjectsResponse {
|
|
|
872
1083
|
metadata?: PagingMetadataV2;
|
|
873
1084
|
}
|
|
874
1085
|
export interface UpdateProjectOrderInCollectionRequest {
|
|
875
|
-
/**
|
|
1086
|
+
/**
|
|
1087
|
+
* ID of the project to update.
|
|
1088
|
+
* @format GUID
|
|
1089
|
+
*/
|
|
876
1090
|
projectId: string;
|
|
877
|
-
/**
|
|
1091
|
+
/**
|
|
1092
|
+
* Collection ID.
|
|
1093
|
+
* @format GUID
|
|
1094
|
+
*/
|
|
878
1095
|
collectionId: string;
|
|
879
1096
|
/** Index that determines the placement of a project within the collection. */
|
|
880
1097
|
sortOrder: number | null;
|
|
@@ -884,7 +1101,10 @@ export interface UpdateProjectOrderInCollectionResponse {
|
|
|
884
1101
|
projectInCollection?: ProjectsInCollections;
|
|
885
1102
|
}
|
|
886
1103
|
export interface ProjectsInCollections {
|
|
887
|
-
/**
|
|
1104
|
+
/**
|
|
1105
|
+
* Collection ID.
|
|
1106
|
+
* @format GUID
|
|
1107
|
+
*/
|
|
888
1108
|
collectionId?: string;
|
|
889
1109
|
/** Project object. */
|
|
890
1110
|
project?: Project;
|
|
@@ -897,6 +1117,7 @@ export interface ProjectsInCollections {
|
|
|
897
1117
|
/**
|
|
898
1118
|
* Project placement ID.
|
|
899
1119
|
* @readonly
|
|
1120
|
+
* @format GUID
|
|
900
1121
|
*/
|
|
901
1122
|
id?: string | null;
|
|
902
1123
|
}
|
|
@@ -913,7 +1134,10 @@ export interface QueryProjectWithCollectionInfoResponse {
|
|
|
913
1134
|
metadata?: PagingMetadataV2;
|
|
914
1135
|
}
|
|
915
1136
|
export interface RestoreProjectFromTrashBinRequest {
|
|
916
|
-
/**
|
|
1137
|
+
/**
|
|
1138
|
+
* id of deleted project to restore from trash bin.
|
|
1139
|
+
* @format GUID
|
|
1140
|
+
*/
|
|
917
1141
|
projectId?: string;
|
|
918
1142
|
}
|
|
919
1143
|
export interface RestoreProjectFromTrashBinResponse {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"portfolio-projects-v1-project-projects.types.js","sourceRoot":"","sources":["../../../src/portfolio-projects-v1-project-projects.types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"portfolio-projects-v1-project-projects.types.js","sourceRoot":"","sources":["../../../src/portfolio-projects-v1-project-projects.types.ts"],"names":[],"mappings":";;;AAqEA,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,oCAAuB,CAAA;IACvB,kCAAqB,CAAA;AACvB,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB;AAgKD,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;IACnB,uCAAyB,CAAA;AAC3B,CAAC,EAJW,UAAU,0BAAV,UAAU,QAIrB;AAwMD,IAAY,KAMX;AAND,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,4BAAmB,CAAA;IACnB,8BAAqB,CAAA;IACrB,4BAAmB,CAAA;IACnB,sBAAa,CAAA;AACf,CAAC,EANW,KAAK,qBAAL,KAAK,QAMhB;AAgCD,IAAY,kBAaX;AAbD,WAAY,kBAAkB;IAC5B,6EAA6E;IAC7E,qCAAe,CAAA;IACf,6CAA6C;IAC7C,qDAA+B,CAAA;IAC/B,wEAAwE;IACxE,+EAAyD,CAAA;IACzD,oCAAoC;IACpC,6CAAuB,CAAA;IACvB,wGAAwG;IACxG,6DAAuC,CAAA;IACvC,2DAA2D;IAC3D,qCAAe,CAAA;AACjB,CAAC,EAbW,kBAAkB,kCAAlB,kBAAkB,QAa7B;AAED,IAAY,SA2EX;AA3ED,WAAY,SAAS;IACnB,oDAAuC,CAAA;IACvC,qHAAqH;IACrH,wBAAW,CAAA;IACX,6KAA6K;IAC7K,oCAAuB,CAAA;IACvB,0KAA0K;IAC1K,8BAAiB,CAAA;IACjB,6RAA6R;IAC7R,4DAA+C,CAAA;IAC/C,wHAAwH;IACxH,8BAAiB,CAAA;IACjB,kJAAkJ;IAClJ,4BAAe,CAAA;IACf,2HAA2H;IAC3H,kDAAqC,CAAA;IACrC,iIAAiI;IACjI,kCAAqB,CAAA;IACrB,sJAAsJ;IACtJ,4BAAe,CAAA;IACf,wJAAwJ;IACxJ,wCAA2B,CAAA;IAC3B,0FAA0F;IAC1F,oDAAuC,CAAA;IACvC,0FAA0F;IAC1F,sDAAyC,CAAA;IACzC;;;;OAIG;IACH,sCAAyB,CAAA;IACzB;;;;OAIG;IACH,oDAAuC,CAAA;IACvC,oGAAoG;IACpG,gDAAmC,CAAA;IACnC,sDAAsD;IACtD,gDAAmC,CAAA;IACnC,2CAA2C;IAC3C,kCAAqB,CAAA;IACrB,uDAAuD;IACvD,kCAAqB,CAAA;IACrB;;;OAGG;IACH,sDAAyC,CAAA;IACzC,2EAA2E;IAC3E,0BAAa,CAAA;IACb;;;;OAIG;IACH,4CAA+B,CAAA;IAC/B,0EAA0E;IAC1E,8BAAiB,CAAA;IACjB;;;OAGG;IACH,0CAA6B,CAAA;IAC7B,2BAA2B;IAC3B,4BAAe,CAAA;IACf,gCAAgC;IAChC,0DAA6C,CAAA;IAC7C;;;OAGG;IACH,8DAAiD,CAAA;AACnD,CAAC,EA3EW,SAAS,yBAAT,SAAS,QA2EpB;AAuCD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,mCAAmB,CAAA;IACnB,+CAA+B,CAAA;AACjC,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AA2LD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAsVD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB"}
|