@wix/auto_sdk_online-programs_programs 1.0.2 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +2 -2
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1257 -5
- package/build/cjs/meta.js +258 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/{online-programs-v3-program-programs.universal-D4bCXD7K.d.ts → online-programs-v3-program-programs.universal-CtphtOVt.d.ts} +2 -3
- package/build/es/index.d.mts +2 -2
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1257 -5
- package/build/es/meta.mjs +233 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/es/{online-programs-v3-program-programs.universal-D4bCXD7K.d.mts → online-programs-v3-program-programs.universal-CtphtOVt.d.mts} +2 -3
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +1257 -5
- package/build/internal/cjs/meta.js +258 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/{online-programs-v3-program-programs.universal-DOkVx-lj.d.ts → online-programs-v3-program-programs.universal-Z5T8pBvA.d.ts} +2 -3
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +1257 -5
- package/build/internal/es/meta.mjs +233 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/{online-programs-v3-program-programs.universal-DOkVx-lj.d.mts → online-programs-v3-program-programs.universal-Z5T8pBvA.d.mts} +2 -3
- package/package.json +3 -3
package/build/es/meta.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { av as CreateProgramRequest$1, aw as CreateProgramResponse$1, aG as DuplicateProgramRequest$1, D as DuplicateProgramResponse$1, aH as GetProgramRequest$1, aI as GetProgramResponse$1, aJ as UpdateProgramRequest$1, aK as UpdateProgramResponse$1, aQ as DeleteProgramRequest$1, aR as DeleteProgramResponse$1, aS as QueryProgramsRequest$1, aY as QueryProgramsResponse$1, a$ as SearchProgramsRequest$1, S as SearchProgramsResponse$1, bD as PublishProgramRequest$1, d as PublishProgramResponse$1, bE as EndProgramRequest$1, E as EndProgramResponse$1, bF as ArchiveProgramRequest$1, A as ArchiveProgramResponse$1, bG as BulkUpdateProgramsRequest$1, f as BulkUpdateProgramsResponse$1, bI as CountProgramsRequest$1, g as CountProgramsResponse$1, bJ as ListSampleProgramsRequest$1, L as ListSampleProgramsResponse$1 } from './online-programs-v3-program-programs.universal-
|
|
1
|
+
import { av as CreateProgramRequest$1, aw as CreateProgramResponse$1, aG as DuplicateProgramRequest$1, D as DuplicateProgramResponse$1, aH as GetProgramRequest$1, aI as GetProgramResponse$1, aJ as UpdateProgramRequest$1, aK as UpdateProgramResponse$1, aQ as DeleteProgramRequest$1, aR as DeleteProgramResponse$1, aS as QueryProgramsRequest$1, aY as QueryProgramsResponse$1, a$ as SearchProgramsRequest$1, S as SearchProgramsResponse$1, bD as PublishProgramRequest$1, d as PublishProgramResponse$1, bE as EndProgramRequest$1, E as EndProgramResponse$1, bF as ArchiveProgramRequest$1, A as ArchiveProgramResponse$1, bG as BulkUpdateProgramsRequest$1, f as BulkUpdateProgramsResponse$1, bI as CountProgramsRequest$1, g as CountProgramsResponse$1, bJ as ListSampleProgramsRequest$1, L as ListSampleProgramsResponse$1 } from './online-programs-v3-program-programs.universal-CtphtOVt.mjs';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface Program {
|
|
@@ -145,6 +145,16 @@ interface Image {
|
|
|
145
145
|
*/
|
|
146
146
|
filename?: string | null;
|
|
147
147
|
}
|
|
148
|
+
interface FocalPoint {
|
|
149
|
+
/** X-coordinate of the focal point. */
|
|
150
|
+
x?: number;
|
|
151
|
+
/** Y-coordinate of the focal point. */
|
|
152
|
+
y?: number;
|
|
153
|
+
/** crop by height */
|
|
154
|
+
height?: number | null;
|
|
155
|
+
/** crop by width */
|
|
156
|
+
width?: number | null;
|
|
157
|
+
}
|
|
148
158
|
interface VideoV2 {
|
|
149
159
|
/** WixMedia ID. */
|
|
150
160
|
id?: string;
|
|
@@ -227,9 +237,8 @@ interface Money {
|
|
|
227
237
|
}
|
|
228
238
|
interface Seo {
|
|
229
239
|
/**
|
|
230
|
-
*
|
|
231
|
-
*
|
|
232
|
-
* @maxLength 300
|
|
240
|
+
* program slug expression
|
|
241
|
+
* @format URL_SLUG
|
|
233
242
|
*/
|
|
234
243
|
slug?: string;
|
|
235
244
|
/** schema used by Seo team */
|
|
@@ -390,6 +399,277 @@ interface ContentSummary {
|
|
|
390
399
|
*/
|
|
391
400
|
sectionCount?: number;
|
|
392
401
|
}
|
|
402
|
+
interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
|
|
403
|
+
/** insert/update documents */
|
|
404
|
+
update?: DocumentUpdateOperation;
|
|
405
|
+
/** delete by document ids */
|
|
406
|
+
deleteByIds?: DeleteByIdsOperation;
|
|
407
|
+
/** delete documents matching filter */
|
|
408
|
+
deleteByFilter?: DeleteByFilterOperation;
|
|
409
|
+
/** update documents matching filter */
|
|
410
|
+
updateByFilter?: UpdateByFilterOperation;
|
|
411
|
+
/** update only existing documents */
|
|
412
|
+
updateExisting?: UpdateExistingOperation;
|
|
413
|
+
/**
|
|
414
|
+
* application which owns documents
|
|
415
|
+
* @minLength 2
|
|
416
|
+
*/
|
|
417
|
+
appDefId?: string | null;
|
|
418
|
+
/**
|
|
419
|
+
* type of the documents
|
|
420
|
+
* @minLength 2
|
|
421
|
+
*/
|
|
422
|
+
documentType?: string | null;
|
|
423
|
+
/**
|
|
424
|
+
* language of the documents
|
|
425
|
+
* @minLength 2
|
|
426
|
+
*/
|
|
427
|
+
language?: string | null;
|
|
428
|
+
/**
|
|
429
|
+
* site documents belong to
|
|
430
|
+
* @minLength 2
|
|
431
|
+
*/
|
|
432
|
+
msId?: string | null;
|
|
433
|
+
}
|
|
434
|
+
/** @oneof */
|
|
435
|
+
interface UpdateDocumentsEventOperationOneOf {
|
|
436
|
+
/** insert/update documents */
|
|
437
|
+
update?: DocumentUpdateOperation;
|
|
438
|
+
/** delete by document ids */
|
|
439
|
+
deleteByIds?: DeleteByIdsOperation;
|
|
440
|
+
/** delete documents matching filter */
|
|
441
|
+
deleteByFilter?: DeleteByFilterOperation;
|
|
442
|
+
/** update documents matching filter */
|
|
443
|
+
updateByFilter?: UpdateByFilterOperation;
|
|
444
|
+
/** update only existing documents */
|
|
445
|
+
updateExisting?: UpdateExistingOperation;
|
|
446
|
+
}
|
|
447
|
+
interface DocumentUpdateOperation {
|
|
448
|
+
/** documents to index or update */
|
|
449
|
+
documents?: IndexDocument[];
|
|
450
|
+
}
|
|
451
|
+
interface IndexDocument {
|
|
452
|
+
/** data bag with non-searchable fields (url, image) */
|
|
453
|
+
payload?: DocumentPayload;
|
|
454
|
+
/** what type of users should documents be visible to */
|
|
455
|
+
exposure?: EnumWithLiterals;
|
|
456
|
+
/** document with mandatory fields (id, title, description) and with fields specific to the type of the document */
|
|
457
|
+
document?: Record<string, any> | null;
|
|
458
|
+
/** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */
|
|
459
|
+
permittedMemberGroups?: string[];
|
|
460
|
+
/** if true SEO is disabled for this document */
|
|
461
|
+
seoHidden?: boolean | null;
|
|
462
|
+
/** if true the page is a lightbox popup */
|
|
463
|
+
isPopup?: boolean | null;
|
|
464
|
+
}
|
|
465
|
+
interface DocumentPayload {
|
|
466
|
+
/** url of the page representing the document */
|
|
467
|
+
url?: string | null;
|
|
468
|
+
/** image which represents the document */
|
|
469
|
+
documentImage?: DocumentImage;
|
|
470
|
+
}
|
|
471
|
+
interface DocumentImage {
|
|
472
|
+
/** the name of the image */
|
|
473
|
+
name?: string;
|
|
474
|
+
/** the width of the image */
|
|
475
|
+
width?: number;
|
|
476
|
+
/** the height of the image */
|
|
477
|
+
height?: number;
|
|
478
|
+
}
|
|
479
|
+
declare enum Enum {
|
|
480
|
+
/** Default value. Means that permission not set */
|
|
481
|
+
UNKNOWN = "UNKNOWN",
|
|
482
|
+
/** Protected exposure. Exposed to members and owners */
|
|
483
|
+
PROTECTED = "PROTECTED",
|
|
484
|
+
/** Private exposure. Exposed to owners */
|
|
485
|
+
PRIVATE = "PRIVATE",
|
|
486
|
+
/** Public exposure. Visible to everyone */
|
|
487
|
+
PUBLIC = "PUBLIC",
|
|
488
|
+
/** Used for partial updates, to state that exposure is not changing */
|
|
489
|
+
UNCHANGED = "UNCHANGED",
|
|
490
|
+
/** Protected to members of permitted groups and owners */
|
|
491
|
+
GROUP_PROTECTED = "GROUP_PROTECTED"
|
|
492
|
+
}
|
|
493
|
+
/** @enumType */
|
|
494
|
+
type EnumWithLiterals = Enum | 'UNKNOWN' | 'PROTECTED' | 'PRIVATE' | 'PUBLIC' | 'UNCHANGED' | 'GROUP_PROTECTED';
|
|
495
|
+
interface DeleteByIdsOperation {
|
|
496
|
+
/** ids of the documents to delete */
|
|
497
|
+
documentIds?: string[];
|
|
498
|
+
}
|
|
499
|
+
interface DeleteByFilterOperation {
|
|
500
|
+
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
501
|
+
filter?: Record<string, any> | null;
|
|
502
|
+
}
|
|
503
|
+
interface UpdateByFilterOperation {
|
|
504
|
+
/** documents matching this filter will be updated */
|
|
505
|
+
filter?: Record<string, any> | null;
|
|
506
|
+
/** partial document to apply */
|
|
507
|
+
document?: IndexDocument;
|
|
508
|
+
}
|
|
509
|
+
interface UpdateExistingOperation {
|
|
510
|
+
/** documents to update */
|
|
511
|
+
documents?: IndexDocument[];
|
|
512
|
+
}
|
|
513
|
+
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
514
|
+
/**
|
|
515
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
516
|
+
* @format GUID
|
|
517
|
+
*/
|
|
518
|
+
metaSiteId?: string;
|
|
519
|
+
/**
|
|
520
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
521
|
+
* @format GUID
|
|
522
|
+
*/
|
|
523
|
+
siteId?: string;
|
|
524
|
+
/** Invalidate by App */
|
|
525
|
+
app?: App;
|
|
526
|
+
/** Invalidate by page id */
|
|
527
|
+
page?: Page;
|
|
528
|
+
/** Invalidate by URI path */
|
|
529
|
+
uri?: URI;
|
|
530
|
+
/** Invalidate by file (for media files such as PDFs) */
|
|
531
|
+
file?: File;
|
|
532
|
+
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
533
|
+
customTag?: CustomTag;
|
|
534
|
+
/**
|
|
535
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
536
|
+
* @maxLength 256
|
|
537
|
+
*/
|
|
538
|
+
reason?: string | null;
|
|
539
|
+
/** Is local DS */
|
|
540
|
+
localDc?: boolean;
|
|
541
|
+
hardPurge?: boolean;
|
|
542
|
+
}
|
|
543
|
+
/** @oneof */
|
|
544
|
+
interface InvalidateCacheGetByOneOf {
|
|
545
|
+
/**
|
|
546
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
547
|
+
* @format GUID
|
|
548
|
+
*/
|
|
549
|
+
metaSiteId?: string;
|
|
550
|
+
/**
|
|
551
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
552
|
+
* @format GUID
|
|
553
|
+
*/
|
|
554
|
+
siteId?: string;
|
|
555
|
+
/** Invalidate by App */
|
|
556
|
+
app?: App;
|
|
557
|
+
/** Invalidate by page id */
|
|
558
|
+
page?: Page;
|
|
559
|
+
/** Invalidate by URI path */
|
|
560
|
+
uri?: URI;
|
|
561
|
+
/** Invalidate by file (for media files such as PDFs) */
|
|
562
|
+
file?: File;
|
|
563
|
+
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
564
|
+
customTag?: CustomTag;
|
|
565
|
+
}
|
|
566
|
+
interface App {
|
|
567
|
+
/**
|
|
568
|
+
* The AppDefId
|
|
569
|
+
* @minLength 1
|
|
570
|
+
*/
|
|
571
|
+
appDefId?: string;
|
|
572
|
+
/**
|
|
573
|
+
* The instance Id
|
|
574
|
+
* @format GUID
|
|
575
|
+
*/
|
|
576
|
+
instanceId?: string;
|
|
577
|
+
}
|
|
578
|
+
interface Page {
|
|
579
|
+
/**
|
|
580
|
+
* the msid the page is on
|
|
581
|
+
* @format GUID
|
|
582
|
+
*/
|
|
583
|
+
metaSiteId?: string;
|
|
584
|
+
/**
|
|
585
|
+
* Invalidate by Page ID
|
|
586
|
+
* @minLength 1
|
|
587
|
+
*/
|
|
588
|
+
pageId?: string;
|
|
589
|
+
}
|
|
590
|
+
interface URI {
|
|
591
|
+
/**
|
|
592
|
+
* the msid the URI is on
|
|
593
|
+
* @format GUID
|
|
594
|
+
*/
|
|
595
|
+
metaSiteId?: string;
|
|
596
|
+
/**
|
|
597
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
598
|
+
* @minLength 1
|
|
599
|
+
*/
|
|
600
|
+
uriPath?: string;
|
|
601
|
+
}
|
|
602
|
+
interface File {
|
|
603
|
+
/**
|
|
604
|
+
* the msid the file is related to
|
|
605
|
+
* @format GUID
|
|
606
|
+
*/
|
|
607
|
+
metaSiteId?: string;
|
|
608
|
+
/**
|
|
609
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
610
|
+
* @minLength 1
|
|
611
|
+
* @maxLength 256
|
|
612
|
+
*/
|
|
613
|
+
fileName?: string;
|
|
614
|
+
}
|
|
615
|
+
interface CustomTag {
|
|
616
|
+
/**
|
|
617
|
+
* the msid the tag is related to
|
|
618
|
+
* @format GUID
|
|
619
|
+
*/
|
|
620
|
+
metaSiteId?: string;
|
|
621
|
+
/**
|
|
622
|
+
* Tag to invalidate by
|
|
623
|
+
* @minLength 1
|
|
624
|
+
* @maxLength 256
|
|
625
|
+
*/
|
|
626
|
+
tag?: string;
|
|
627
|
+
}
|
|
628
|
+
/**
|
|
629
|
+
* Message for reindexing search data to a given search schema. Support both upsert and delete flows as well as
|
|
630
|
+
* performs context manipulation with adding tenant, provided in message to callscope.
|
|
631
|
+
*/
|
|
632
|
+
interface ReindexMessage extends ReindexMessageActionOneOf {
|
|
633
|
+
upsert?: Upsert;
|
|
634
|
+
delete?: Delete;
|
|
635
|
+
entityFqdn?: string;
|
|
636
|
+
tenantId?: string;
|
|
637
|
+
eventTime?: Date | null;
|
|
638
|
+
entityEventSequence?: string | null;
|
|
639
|
+
schema?: Schema;
|
|
640
|
+
}
|
|
641
|
+
/** @oneof */
|
|
642
|
+
interface ReindexMessageActionOneOf {
|
|
643
|
+
upsert?: Upsert;
|
|
644
|
+
delete?: Delete;
|
|
645
|
+
}
|
|
646
|
+
interface Upsert {
|
|
647
|
+
entityId?: string;
|
|
648
|
+
entityAsJson?: string;
|
|
649
|
+
}
|
|
650
|
+
interface Delete {
|
|
651
|
+
entityId?: string;
|
|
652
|
+
}
|
|
653
|
+
interface Schema {
|
|
654
|
+
label?: string;
|
|
655
|
+
clusterName?: string;
|
|
656
|
+
}
|
|
657
|
+
interface ProgramPublished {
|
|
658
|
+
}
|
|
659
|
+
interface ProgramEnded {
|
|
660
|
+
/** true if ended manually by owner */
|
|
661
|
+
endedByOwner?: boolean;
|
|
662
|
+
}
|
|
663
|
+
interface ProgramArchived {
|
|
664
|
+
}
|
|
665
|
+
interface ProgramDuplicated {
|
|
666
|
+
/** Newly created program */
|
|
667
|
+
program?: Program;
|
|
668
|
+
/** Program that was duplicated */
|
|
669
|
+
duplicatedFrom?: Program;
|
|
670
|
+
/** Indicates if the program was cloned from a template */
|
|
671
|
+
fromTemplate?: boolean;
|
|
672
|
+
}
|
|
393
673
|
interface CreateProgramRequest {
|
|
394
674
|
/** Program to be created. */
|
|
395
675
|
program: Program;
|
|
@@ -398,6 +678,44 @@ interface CreateProgramResponse {
|
|
|
398
678
|
/** The created Program. */
|
|
399
679
|
program?: Program;
|
|
400
680
|
}
|
|
681
|
+
interface BulkCreateProgramsMigrationRequest {
|
|
682
|
+
/**
|
|
683
|
+
* List of programs you want to create
|
|
684
|
+
* @minSize 1
|
|
685
|
+
* @maxSize 100
|
|
686
|
+
*/
|
|
687
|
+
programs?: ProgramMigration[];
|
|
688
|
+
}
|
|
689
|
+
interface ProgramMigration {
|
|
690
|
+
/** program to create */
|
|
691
|
+
program?: Program;
|
|
692
|
+
/**
|
|
693
|
+
* section ids in program
|
|
694
|
+
* @maxSize 5000
|
|
695
|
+
* @format GUID
|
|
696
|
+
*/
|
|
697
|
+
sectionIds?: string[];
|
|
698
|
+
/**
|
|
699
|
+
* step ids in program
|
|
700
|
+
* @maxSize 5000
|
|
701
|
+
* @format GUID
|
|
702
|
+
*/
|
|
703
|
+
stepIds?: string[];
|
|
704
|
+
}
|
|
705
|
+
interface BulkCreateProgramsMigrationResponse {
|
|
706
|
+
/** Results of bulk action. */
|
|
707
|
+
results?: BulkProgramResult[];
|
|
708
|
+
/** Metadata about whole bulk action. */
|
|
709
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
710
|
+
}
|
|
711
|
+
interface BulkProgramResult {
|
|
712
|
+
/** Metadata of item. */
|
|
713
|
+
itemMetadata?: ItemMetadata;
|
|
714
|
+
/** Item itself (empty if return_entity in request is false). */
|
|
715
|
+
item?: Program;
|
|
716
|
+
/** Action type of bulk action (INSERT OR UPDATE) for that endpoint. */
|
|
717
|
+
action?: BulkActionTypeWithLiterals;
|
|
718
|
+
}
|
|
401
719
|
interface ItemMetadata {
|
|
402
720
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
403
721
|
id?: string | null;
|
|
@@ -416,6 +734,18 @@ interface ApplicationError {
|
|
|
416
734
|
/** Data related to the error. */
|
|
417
735
|
data?: Record<string, any> | null;
|
|
418
736
|
}
|
|
737
|
+
declare enum BulkActionType {
|
|
738
|
+
/** UNKNOWN_ACTION_TYPE */
|
|
739
|
+
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
740
|
+
/** INSERT */
|
|
741
|
+
INSERT = "INSERT",
|
|
742
|
+
/** UPDATE */
|
|
743
|
+
UPDATE = "UPDATE",
|
|
744
|
+
/** DELETE */
|
|
745
|
+
DELETE = "DELETE"
|
|
746
|
+
}
|
|
747
|
+
/** @enumType */
|
|
748
|
+
type BulkActionTypeWithLiterals = BulkActionType | 'UNKNOWN_ACTION_TYPE' | 'INSERT' | 'UPDATE' | 'DELETE';
|
|
419
749
|
interface BulkActionMetadata {
|
|
420
750
|
/** Number of items that were successfully processed. */
|
|
421
751
|
totalSuccesses?: number;
|
|
@@ -424,6 +754,10 @@ interface BulkActionMetadata {
|
|
|
424
754
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
425
755
|
undetailedFailures?: number;
|
|
426
756
|
}
|
|
757
|
+
interface DeleteAllProgramsMigrationRequest {
|
|
758
|
+
}
|
|
759
|
+
interface DeleteAllProgramsMigrationResponse {
|
|
760
|
+
}
|
|
427
761
|
interface DuplicateProgramRequest {
|
|
428
762
|
/**
|
|
429
763
|
* Program to be duplicated from.
|
|
@@ -454,6 +788,18 @@ interface UpdateProgramResponse {
|
|
|
454
788
|
/** Updated Program. */
|
|
455
789
|
program?: Program;
|
|
456
790
|
}
|
|
791
|
+
interface WrongStateErrorDetails {
|
|
792
|
+
}
|
|
793
|
+
interface WrongStartDateErrorDetails {
|
|
794
|
+
}
|
|
795
|
+
interface WrongParticipantsNumberErrorDetails {
|
|
796
|
+
/** Participants that already joined the program */
|
|
797
|
+
activeParticipantsCount?: number;
|
|
798
|
+
}
|
|
799
|
+
interface DuplicatedSlugErrorDetails {
|
|
800
|
+
}
|
|
801
|
+
interface TimelineSwitchForbiddenErrorDetails {
|
|
802
|
+
}
|
|
457
803
|
interface DeleteProgramRequest {
|
|
458
804
|
/**
|
|
459
805
|
* Id of the Program to delete.
|
|
@@ -1193,6 +1539,912 @@ interface LabeledProgram {
|
|
|
1193
1539
|
*/
|
|
1194
1540
|
label?: string;
|
|
1195
1541
|
}
|
|
1542
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1543
|
+
createdEvent?: EntityCreatedEvent;
|
|
1544
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1545
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1546
|
+
actionEvent?: ActionEvent;
|
|
1547
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1548
|
+
id?: string;
|
|
1549
|
+
/**
|
|
1550
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1551
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1552
|
+
*/
|
|
1553
|
+
entityFqdn?: string;
|
|
1554
|
+
/**
|
|
1555
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1556
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1557
|
+
*/
|
|
1558
|
+
slug?: string;
|
|
1559
|
+
/** ID of the entity associated with the event. */
|
|
1560
|
+
entityId?: string;
|
|
1561
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1562
|
+
eventTime?: Date | null;
|
|
1563
|
+
/**
|
|
1564
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1565
|
+
* (for example, GDPR).
|
|
1566
|
+
*/
|
|
1567
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1568
|
+
/** If present, indicates the action that triggered the event. */
|
|
1569
|
+
originatedFrom?: string | null;
|
|
1570
|
+
/**
|
|
1571
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
1572
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
1573
|
+
*/
|
|
1574
|
+
entityEventSequence?: string | null;
|
|
1575
|
+
}
|
|
1576
|
+
/** @oneof */
|
|
1577
|
+
interface DomainEventBodyOneOf {
|
|
1578
|
+
createdEvent?: EntityCreatedEvent;
|
|
1579
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1580
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1581
|
+
actionEvent?: ActionEvent;
|
|
1582
|
+
}
|
|
1583
|
+
interface EntityCreatedEvent {
|
|
1584
|
+
entityAsJson?: string;
|
|
1585
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1586
|
+
restoreInfo?: RestoreInfo;
|
|
1587
|
+
}
|
|
1588
|
+
interface RestoreInfo {
|
|
1589
|
+
deletedDate?: Date | null;
|
|
1590
|
+
}
|
|
1591
|
+
interface EntityUpdatedEvent {
|
|
1592
|
+
/**
|
|
1593
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1594
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1595
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1596
|
+
*/
|
|
1597
|
+
currentEntityAsJson?: string;
|
|
1598
|
+
}
|
|
1599
|
+
interface EntityDeletedEvent {
|
|
1600
|
+
/** Entity that was deleted. */
|
|
1601
|
+
deletedEntityAsJson?: string | null;
|
|
1602
|
+
}
|
|
1603
|
+
interface ActionEvent {
|
|
1604
|
+
bodyAsJson?: string;
|
|
1605
|
+
}
|
|
1606
|
+
interface Empty {
|
|
1607
|
+
}
|
|
1608
|
+
interface ResolveProgramSlugRequest {
|
|
1609
|
+
/**
|
|
1610
|
+
* seo slug of online program.
|
|
1611
|
+
* @maxLength 1000
|
|
1612
|
+
*/
|
|
1613
|
+
slug?: string;
|
|
1614
|
+
}
|
|
1615
|
+
interface ResolveProgramSlugResponse {
|
|
1616
|
+
/** @format GUID */
|
|
1617
|
+
programId?: string;
|
|
1618
|
+
}
|
|
1619
|
+
interface MissingMetasiteIdErrorDetails {
|
|
1620
|
+
}
|
|
1621
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
1622
|
+
/** Emitted on a meta site creation. */
|
|
1623
|
+
siteCreated?: SiteCreated;
|
|
1624
|
+
/** Emitted on a meta site transfer completion. */
|
|
1625
|
+
siteTransferred?: SiteTransferred;
|
|
1626
|
+
/** Emitted on a meta site deletion. */
|
|
1627
|
+
siteDeleted?: SiteDeleted;
|
|
1628
|
+
/** Emitted on a meta site restoration. */
|
|
1629
|
+
siteUndeleted?: SiteUndeleted;
|
|
1630
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
1631
|
+
sitePublished?: SitePublished;
|
|
1632
|
+
/** Emitted on a meta site unpublish. */
|
|
1633
|
+
siteUnpublished?: SiteUnpublished;
|
|
1634
|
+
/** Emitted when meta site is marked as template. */
|
|
1635
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
1636
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
1637
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
1638
|
+
/** Emitted when an application is provisioned (installed). */
|
|
1639
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
1640
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
1641
|
+
serviceRemoved?: ServiceRemoved;
|
|
1642
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
1643
|
+
siteRenamedPayload?: SiteRenamed;
|
|
1644
|
+
/** Emitted when meta site was permanently deleted. */
|
|
1645
|
+
hardDeleted?: SiteHardDeleted;
|
|
1646
|
+
/** Emitted on a namespace change. */
|
|
1647
|
+
namespaceChanged?: NamespaceChanged;
|
|
1648
|
+
/** Emitted when Studio is attached. */
|
|
1649
|
+
studioAssigned?: StudioAssigned;
|
|
1650
|
+
/** Emitted when Studio is detached. */
|
|
1651
|
+
studioUnassigned?: StudioUnassigned;
|
|
1652
|
+
/**
|
|
1653
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
1654
|
+
* the actual URL.
|
|
1655
|
+
*
|
|
1656
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
1657
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
1658
|
+
*/
|
|
1659
|
+
urlChanged?: SiteUrlChanged;
|
|
1660
|
+
/** Site is marked as PurgedExternally */
|
|
1661
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
1662
|
+
/** Emitted when Odeditor is attached. */
|
|
1663
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
1664
|
+
/** Emitted when Odeditor is detached. */
|
|
1665
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
1666
|
+
/** Emitted when Picasso is attached. */
|
|
1667
|
+
picassoAssigned?: PicassoAssigned;
|
|
1668
|
+
/** Emitted when Picasso is detached. */
|
|
1669
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
1670
|
+
/**
|
|
1671
|
+
* A meta site id.
|
|
1672
|
+
* @format GUID
|
|
1673
|
+
*/
|
|
1674
|
+
metaSiteId?: string;
|
|
1675
|
+
/** A meta site version. Monotonically increasing. */
|
|
1676
|
+
version?: string;
|
|
1677
|
+
/** A timestamp of the event. */
|
|
1678
|
+
timestamp?: string;
|
|
1679
|
+
/**
|
|
1680
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
1681
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
1682
|
+
* @maxSize 4000
|
|
1683
|
+
*/
|
|
1684
|
+
assets?: Asset[];
|
|
1685
|
+
}
|
|
1686
|
+
/** @oneof */
|
|
1687
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
1688
|
+
/** Emitted on a meta site creation. */
|
|
1689
|
+
siteCreated?: SiteCreated;
|
|
1690
|
+
/** Emitted on a meta site transfer completion. */
|
|
1691
|
+
siteTransferred?: SiteTransferred;
|
|
1692
|
+
/** Emitted on a meta site deletion. */
|
|
1693
|
+
siteDeleted?: SiteDeleted;
|
|
1694
|
+
/** Emitted on a meta site restoration. */
|
|
1695
|
+
siteUndeleted?: SiteUndeleted;
|
|
1696
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
1697
|
+
sitePublished?: SitePublished;
|
|
1698
|
+
/** Emitted on a meta site unpublish. */
|
|
1699
|
+
siteUnpublished?: SiteUnpublished;
|
|
1700
|
+
/** Emitted when meta site is marked as template. */
|
|
1701
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
1702
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
1703
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
1704
|
+
/** Emitted when an application is provisioned (installed). */
|
|
1705
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
1706
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
1707
|
+
serviceRemoved?: ServiceRemoved;
|
|
1708
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
1709
|
+
siteRenamedPayload?: SiteRenamed;
|
|
1710
|
+
/** Emitted when meta site was permanently deleted. */
|
|
1711
|
+
hardDeleted?: SiteHardDeleted;
|
|
1712
|
+
/** Emitted on a namespace change. */
|
|
1713
|
+
namespaceChanged?: NamespaceChanged;
|
|
1714
|
+
/** Emitted when Studio is attached. */
|
|
1715
|
+
studioAssigned?: StudioAssigned;
|
|
1716
|
+
/** Emitted when Studio is detached. */
|
|
1717
|
+
studioUnassigned?: StudioUnassigned;
|
|
1718
|
+
/**
|
|
1719
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
1720
|
+
* the actual URL.
|
|
1721
|
+
*
|
|
1722
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
1723
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
1724
|
+
*/
|
|
1725
|
+
urlChanged?: SiteUrlChanged;
|
|
1726
|
+
/** Site is marked as PurgedExternally */
|
|
1727
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
1728
|
+
/** Emitted when Odeditor is attached. */
|
|
1729
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
1730
|
+
/** Emitted when Odeditor is detached. */
|
|
1731
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
1732
|
+
/** Emitted when Picasso is attached. */
|
|
1733
|
+
picassoAssigned?: PicassoAssigned;
|
|
1734
|
+
/** Emitted when Picasso is detached. */
|
|
1735
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
1736
|
+
}
|
|
1737
|
+
interface Asset {
|
|
1738
|
+
/**
|
|
1739
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
1740
|
+
* @maxLength 36
|
|
1741
|
+
*/
|
|
1742
|
+
appDefId?: string;
|
|
1743
|
+
/**
|
|
1744
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
1745
|
+
* @maxLength 200
|
|
1746
|
+
*/
|
|
1747
|
+
instanceId?: string;
|
|
1748
|
+
/** An application state. */
|
|
1749
|
+
state?: StateWithLiterals;
|
|
1750
|
+
}
|
|
1751
|
+
declare enum State {
|
|
1752
|
+
UNKNOWN = "UNKNOWN",
|
|
1753
|
+
ENABLED = "ENABLED",
|
|
1754
|
+
DISABLED = "DISABLED",
|
|
1755
|
+
PENDING = "PENDING",
|
|
1756
|
+
DEMO = "DEMO"
|
|
1757
|
+
}
|
|
1758
|
+
/** @enumType */
|
|
1759
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
1760
|
+
interface SiteCreated {
|
|
1761
|
+
/**
|
|
1762
|
+
* A template identifier (empty if not created from a template).
|
|
1763
|
+
* @maxLength 36
|
|
1764
|
+
*/
|
|
1765
|
+
originTemplateId?: string;
|
|
1766
|
+
/**
|
|
1767
|
+
* An account id of the owner.
|
|
1768
|
+
* @format GUID
|
|
1769
|
+
*/
|
|
1770
|
+
ownerId?: string;
|
|
1771
|
+
/** A context in which meta site was created. */
|
|
1772
|
+
context?: SiteCreatedContextWithLiterals;
|
|
1773
|
+
/**
|
|
1774
|
+
* A meta site id from which this site was created.
|
|
1775
|
+
*
|
|
1776
|
+
* In case of a creation from a template it's a template id.
|
|
1777
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
1778
|
+
* @format GUID
|
|
1779
|
+
*/
|
|
1780
|
+
originMetaSiteId?: string | null;
|
|
1781
|
+
/**
|
|
1782
|
+
* A meta site name (URL slug).
|
|
1783
|
+
* @maxLength 20
|
|
1784
|
+
*/
|
|
1785
|
+
siteName?: string;
|
|
1786
|
+
/** A namespace. */
|
|
1787
|
+
namespace?: NamespaceWithLiterals;
|
|
1788
|
+
}
|
|
1789
|
+
declare enum SiteCreatedContext {
|
|
1790
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
1791
|
+
OTHER = "OTHER",
|
|
1792
|
+
/** A meta site was created from template. */
|
|
1793
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
1794
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
1795
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
1796
|
+
/** A copy of existing meta site. */
|
|
1797
|
+
DUPLICATE = "DUPLICATE",
|
|
1798
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
1799
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
1800
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
1801
|
+
FLASH = "FLASH"
|
|
1802
|
+
}
|
|
1803
|
+
/** @enumType */
|
|
1804
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
1805
|
+
declare enum Namespace {
|
|
1806
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
1807
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
1808
|
+
WIX = "WIX",
|
|
1809
|
+
/** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1810
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
1811
|
+
/** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1812
|
+
ALBUMS = "ALBUMS",
|
|
1813
|
+
/** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1814
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
1815
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1816
|
+
HOTELS = "HOTELS",
|
|
1817
|
+
/** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1818
|
+
CLUBS = "CLUBS",
|
|
1819
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1820
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
1821
|
+
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1822
|
+
DEV_SITE = "DEV_SITE",
|
|
1823
|
+
/** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1824
|
+
LOGOS = "LOGOS",
|
|
1825
|
+
/** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1826
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
1827
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1828
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
1829
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1830
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
1831
|
+
/**
|
|
1832
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
1833
|
+
*
|
|
1834
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
1835
|
+
*/
|
|
1836
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
1837
|
+
/**
|
|
1838
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
1839
|
+
* Will be accessible from Site List and will not have a website app.
|
|
1840
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
1841
|
+
*/
|
|
1842
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
1843
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
1844
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
1845
|
+
/** It is to be used in the Business First efforts. */
|
|
1846
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
1847
|
+
/** Bookings business flow with no site. */
|
|
1848
|
+
ANYWHERE = "ANYWHERE",
|
|
1849
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
1850
|
+
HEADLESS = "HEADLESS",
|
|
1851
|
+
/**
|
|
1852
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
1853
|
+
* The site will be used for account level CSM feature for enterprise
|
|
1854
|
+
*/
|
|
1855
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
1856
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
1857
|
+
RISE = "RISE",
|
|
1858
|
+
/**
|
|
1859
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
1860
|
+
* There's a blank site behind the scene but it's blank).
|
|
1861
|
+
* The Mobile company will be the owner of this namespace.
|
|
1862
|
+
*/
|
|
1863
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
1864
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
1865
|
+
NOWNIA = "NOWNIA",
|
|
1866
|
+
/**
|
|
1867
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
1868
|
+
* The Partners company owns this namespace.
|
|
1869
|
+
*/
|
|
1870
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
1871
|
+
/** Codux Headless Sites */
|
|
1872
|
+
CODUX = "CODUX",
|
|
1873
|
+
/** Bobb - AI Design Creator. */
|
|
1874
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
1875
|
+
/**
|
|
1876
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
1877
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
1878
|
+
*/
|
|
1879
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
1880
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1881
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
1882
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1883
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
1884
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
1885
|
+
MIMIR = "MIMIR",
|
|
1886
|
+
/** Wix Twins platform. */
|
|
1887
|
+
TWINS = "TWINS",
|
|
1888
|
+
/** Wix Nano. */
|
|
1889
|
+
NANO = "NANO"
|
|
1890
|
+
}
|
|
1891
|
+
/** @enumType */
|
|
1892
|
+
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO';
|
|
1893
|
+
/** Site transferred to another user. */
|
|
1894
|
+
interface SiteTransferred {
|
|
1895
|
+
/**
|
|
1896
|
+
* A previous owner id (user that transfers meta site).
|
|
1897
|
+
* @format GUID
|
|
1898
|
+
*/
|
|
1899
|
+
oldOwnerId?: string;
|
|
1900
|
+
/**
|
|
1901
|
+
* A new owner id (user that accepts meta site).
|
|
1902
|
+
* @format GUID
|
|
1903
|
+
*/
|
|
1904
|
+
newOwnerId?: string;
|
|
1905
|
+
}
|
|
1906
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
1907
|
+
interface SiteDeleted {
|
|
1908
|
+
/** A deletion context. */
|
|
1909
|
+
deleteContext?: DeleteContext;
|
|
1910
|
+
}
|
|
1911
|
+
interface DeleteContext {
|
|
1912
|
+
/** When the meta site was deleted. */
|
|
1913
|
+
dateDeleted?: Date | null;
|
|
1914
|
+
/** A status. */
|
|
1915
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
1916
|
+
/**
|
|
1917
|
+
* A reason (flow).
|
|
1918
|
+
* @maxLength 255
|
|
1919
|
+
*/
|
|
1920
|
+
deleteOrigin?: string;
|
|
1921
|
+
/**
|
|
1922
|
+
* A service that deleted it.
|
|
1923
|
+
* @maxLength 255
|
|
1924
|
+
*/
|
|
1925
|
+
initiatorId?: string | null;
|
|
1926
|
+
}
|
|
1927
|
+
declare enum DeleteStatus {
|
|
1928
|
+
UNKNOWN = "UNKNOWN",
|
|
1929
|
+
TRASH = "TRASH",
|
|
1930
|
+
DELETED = "DELETED",
|
|
1931
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
1932
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
1933
|
+
}
|
|
1934
|
+
/** @enumType */
|
|
1935
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
1936
|
+
/** Restoration of the meta site. */
|
|
1937
|
+
interface SiteUndeleted {
|
|
1938
|
+
}
|
|
1939
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
1940
|
+
interface SitePublished {
|
|
1941
|
+
}
|
|
1942
|
+
interface SiteUnpublished {
|
|
1943
|
+
/**
|
|
1944
|
+
* A list of URLs previously associated with the meta site.
|
|
1945
|
+
* @maxLength 4000
|
|
1946
|
+
* @maxSize 10000
|
|
1947
|
+
*/
|
|
1948
|
+
urls?: string[];
|
|
1949
|
+
}
|
|
1950
|
+
interface SiteMarkedAsTemplate {
|
|
1951
|
+
}
|
|
1952
|
+
interface SiteMarkedAsWixSite {
|
|
1953
|
+
}
|
|
1954
|
+
/**
|
|
1955
|
+
* Represents a service provisioned a site.
|
|
1956
|
+
*
|
|
1957
|
+
* Note on `origin_instance_id`:
|
|
1958
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
1959
|
+
* This is because of the following scenario:
|
|
1960
|
+
*
|
|
1961
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
1962
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
1963
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
1964
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
1965
|
+
* your site remains consistent with what you initially received and does not include any
|
|
1966
|
+
* changes made to the original template afterward.
|
|
1967
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
1968
|
+
*/
|
|
1969
|
+
interface ServiceProvisioned {
|
|
1970
|
+
/**
|
|
1971
|
+
* Either UUID or EmbeddedServiceType.
|
|
1972
|
+
* @maxLength 36
|
|
1973
|
+
*/
|
|
1974
|
+
appDefId?: string;
|
|
1975
|
+
/**
|
|
1976
|
+
* Not only UUID. Something here could be something weird.
|
|
1977
|
+
* @maxLength 36
|
|
1978
|
+
*/
|
|
1979
|
+
instanceId?: string;
|
|
1980
|
+
/**
|
|
1981
|
+
* An instance id from which this instance is originated.
|
|
1982
|
+
* @maxLength 36
|
|
1983
|
+
*/
|
|
1984
|
+
originInstanceId?: string;
|
|
1985
|
+
/**
|
|
1986
|
+
* A version.
|
|
1987
|
+
* @maxLength 500
|
|
1988
|
+
*/
|
|
1989
|
+
version?: string | null;
|
|
1990
|
+
/**
|
|
1991
|
+
* The origin meta site id
|
|
1992
|
+
* @format GUID
|
|
1993
|
+
*/
|
|
1994
|
+
originMetaSiteId?: string | null;
|
|
1995
|
+
}
|
|
1996
|
+
interface ServiceRemoved {
|
|
1997
|
+
/**
|
|
1998
|
+
* Either UUID or EmbeddedServiceType.
|
|
1999
|
+
* @maxLength 36
|
|
2000
|
+
*/
|
|
2001
|
+
appDefId?: string;
|
|
2002
|
+
/**
|
|
2003
|
+
* Not only UUID. Something here could be something weird.
|
|
2004
|
+
* @maxLength 36
|
|
2005
|
+
*/
|
|
2006
|
+
instanceId?: string;
|
|
2007
|
+
/**
|
|
2008
|
+
* A version.
|
|
2009
|
+
* @maxLength 500
|
|
2010
|
+
*/
|
|
2011
|
+
version?: string | null;
|
|
2012
|
+
}
|
|
2013
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
2014
|
+
interface SiteRenamed {
|
|
2015
|
+
/**
|
|
2016
|
+
* A new meta site name (URL slug).
|
|
2017
|
+
* @maxLength 20
|
|
2018
|
+
*/
|
|
2019
|
+
newSiteName?: string;
|
|
2020
|
+
/**
|
|
2021
|
+
* A previous meta site name (URL slug).
|
|
2022
|
+
* @maxLength 255
|
|
2023
|
+
*/
|
|
2024
|
+
oldSiteName?: string;
|
|
2025
|
+
}
|
|
2026
|
+
/**
|
|
2027
|
+
* Hard deletion of the meta site.
|
|
2028
|
+
*
|
|
2029
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
2030
|
+
*/
|
|
2031
|
+
interface SiteHardDeleted {
|
|
2032
|
+
/** A deletion context. */
|
|
2033
|
+
deleteContext?: DeleteContext;
|
|
2034
|
+
}
|
|
2035
|
+
interface NamespaceChanged {
|
|
2036
|
+
/** A previous namespace. */
|
|
2037
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
2038
|
+
/** A new namespace. */
|
|
2039
|
+
newNamespace?: NamespaceWithLiterals;
|
|
2040
|
+
}
|
|
2041
|
+
/** Assigned Studio editor */
|
|
2042
|
+
interface StudioAssigned {
|
|
2043
|
+
}
|
|
2044
|
+
/** Unassigned Studio editor */
|
|
2045
|
+
interface StudioUnassigned {
|
|
2046
|
+
}
|
|
2047
|
+
/**
|
|
2048
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
2049
|
+
*
|
|
2050
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
2051
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
2052
|
+
*
|
|
2053
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
2054
|
+
*/
|
|
2055
|
+
interface SiteUrlChanged {
|
|
2056
|
+
}
|
|
2057
|
+
/**
|
|
2058
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
2059
|
+
* Consumed by other teams to remove relevant data.
|
|
2060
|
+
*/
|
|
2061
|
+
interface SitePurgedExternally {
|
|
2062
|
+
/**
|
|
2063
|
+
* @maxLength 2048
|
|
2064
|
+
* @maxSize 100
|
|
2065
|
+
* @deprecated
|
|
2066
|
+
* @targetRemovalDate 2025-04-15
|
|
2067
|
+
*/
|
|
2068
|
+
appDefId?: string[];
|
|
2069
|
+
}
|
|
2070
|
+
/** Assigned Odeditor */
|
|
2071
|
+
interface OdeditorAssigned {
|
|
2072
|
+
}
|
|
2073
|
+
/** Unassigned Odeditor */
|
|
2074
|
+
interface OdeditorUnassigned {
|
|
2075
|
+
}
|
|
2076
|
+
/** Assigned Picasso editor */
|
|
2077
|
+
interface PicassoAssigned {
|
|
2078
|
+
}
|
|
2079
|
+
/** Unassigned Picasso */
|
|
2080
|
+
interface PicassoUnassigned {
|
|
2081
|
+
}
|
|
2082
|
+
interface SearchIndexingNotification {
|
|
2083
|
+
/** new state of indexing for the site specified in ms_id */
|
|
2084
|
+
indexState?: SearchIndexingNotificationStateWithLiterals;
|
|
2085
|
+
/** type of the document the notification is targeted for. Applies to all types if not provided */
|
|
2086
|
+
documentType?: string | null;
|
|
2087
|
+
/** languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided */
|
|
2088
|
+
language?: string | null;
|
|
2089
|
+
/**
|
|
2090
|
+
* site for which notification is targeted
|
|
2091
|
+
* @minLength 2
|
|
2092
|
+
*/
|
|
2093
|
+
msId?: string | null;
|
|
2094
|
+
}
|
|
2095
|
+
declare enum SearchIndexingNotificationState {
|
|
2096
|
+
/** default state */
|
|
2097
|
+
Unknown = "Unknown",
|
|
2098
|
+
/** metasite does not require site search indexing */
|
|
2099
|
+
Off = "Off",
|
|
2100
|
+
/** metasite requires site search indexing */
|
|
2101
|
+
On = "On"
|
|
2102
|
+
}
|
|
2103
|
+
/** @enumType */
|
|
2104
|
+
type SearchIndexingNotificationStateWithLiterals = SearchIndexingNotificationState | 'Unknown' | 'Off' | 'On';
|
|
2105
|
+
/** Encapsulates all changes when site properties are updated */
|
|
2106
|
+
interface SitePropertiesUpdated {
|
|
2107
|
+
/** ID of the Wix site that has been updated. */
|
|
2108
|
+
metasiteId?: string;
|
|
2109
|
+
/** Update details. */
|
|
2110
|
+
event?: SitePropertiesEvent;
|
|
2111
|
+
}
|
|
2112
|
+
/** The actual update event for a particular notification. */
|
|
2113
|
+
interface SitePropertiesEvent {
|
|
2114
|
+
/** Version of the site's properties represented by this update. */
|
|
2115
|
+
version?: number;
|
|
2116
|
+
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
2117
|
+
fields?: string[];
|
|
2118
|
+
/** Updated properties. */
|
|
2119
|
+
properties?: Properties;
|
|
2120
|
+
}
|
|
2121
|
+
interface Properties {
|
|
2122
|
+
/** Site categories. */
|
|
2123
|
+
categories?: Categories;
|
|
2124
|
+
/** Site locale. */
|
|
2125
|
+
locale?: Locale;
|
|
2126
|
+
/**
|
|
2127
|
+
* Site language.
|
|
2128
|
+
*
|
|
2129
|
+
* Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
2130
|
+
*/
|
|
2131
|
+
language?: string | null;
|
|
2132
|
+
/**
|
|
2133
|
+
* Site currency format used to bill customers.
|
|
2134
|
+
*
|
|
2135
|
+
* Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
2136
|
+
*/
|
|
2137
|
+
paymentCurrency?: string | null;
|
|
2138
|
+
/** Timezone in `America/New_York` format. */
|
|
2139
|
+
timeZone?: string | null;
|
|
2140
|
+
/** Email address. */
|
|
2141
|
+
email?: string | null;
|
|
2142
|
+
/** Phone number. */
|
|
2143
|
+
phone?: string | null;
|
|
2144
|
+
/** Fax number. */
|
|
2145
|
+
fax?: string | null;
|
|
2146
|
+
/** Address. */
|
|
2147
|
+
address?: Address;
|
|
2148
|
+
/** Site display name. */
|
|
2149
|
+
siteDisplayName?: string | null;
|
|
2150
|
+
/** Business name. */
|
|
2151
|
+
businessName?: string | null;
|
|
2152
|
+
/** Path to the site's logo in Wix Media (without Wix Media base URL). */
|
|
2153
|
+
logo?: string | null;
|
|
2154
|
+
/** Site description. */
|
|
2155
|
+
description?: string | null;
|
|
2156
|
+
/**
|
|
2157
|
+
* Business schedule. Regular and exceptional time periods when the business is open or the service is available.
|
|
2158
|
+
*
|
|
2159
|
+
* __Note:__ Not supported by Wix Bookings.
|
|
2160
|
+
*/
|
|
2161
|
+
businessSchedule?: BusinessSchedule;
|
|
2162
|
+
/** Supported languages of a site and the primary language. */
|
|
2163
|
+
multilingual?: Multilingual;
|
|
2164
|
+
/** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
|
|
2165
|
+
consentPolicy?: ConsentPolicy;
|
|
2166
|
+
/**
|
|
2167
|
+
* Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
|
|
2168
|
+
*
|
|
2169
|
+
* Site business type.
|
|
2170
|
+
*/
|
|
2171
|
+
businessConfig?: string | null;
|
|
2172
|
+
/** External site URL that uses Wix as its headless business solution. */
|
|
2173
|
+
externalSiteUrl?: string | null;
|
|
2174
|
+
/** Track clicks analytics. */
|
|
2175
|
+
trackClicksAnalytics?: boolean;
|
|
2176
|
+
}
|
|
2177
|
+
interface Categories {
|
|
2178
|
+
/** Primary site category. */
|
|
2179
|
+
primary?: string;
|
|
2180
|
+
/**
|
|
2181
|
+
* Secondary site category.
|
|
2182
|
+
* @maxSize 50
|
|
2183
|
+
*/
|
|
2184
|
+
secondary?: string[];
|
|
2185
|
+
/** Business Term Id */
|
|
2186
|
+
businessTermId?: string | null;
|
|
2187
|
+
}
|
|
2188
|
+
interface Locale {
|
|
2189
|
+
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
2190
|
+
languageCode?: string;
|
|
2191
|
+
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
2192
|
+
country?: string;
|
|
2193
|
+
}
|
|
2194
|
+
interface Address {
|
|
2195
|
+
/** Street name. */
|
|
2196
|
+
street?: string;
|
|
2197
|
+
/** City name. */
|
|
2198
|
+
city?: string;
|
|
2199
|
+
/** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
|
|
2200
|
+
country?: string;
|
|
2201
|
+
/** State. */
|
|
2202
|
+
state?: string;
|
|
2203
|
+
/**
|
|
2204
|
+
* Zip or postal code.
|
|
2205
|
+
* @maxLength 20
|
|
2206
|
+
*/
|
|
2207
|
+
zip?: string;
|
|
2208
|
+
/** Extra information to be displayed in the address. */
|
|
2209
|
+
hint?: AddressHint;
|
|
2210
|
+
/** Whether this address represents a physical location. */
|
|
2211
|
+
isPhysical?: boolean;
|
|
2212
|
+
/** Google-formatted version of this address. */
|
|
2213
|
+
googleFormattedAddress?: string;
|
|
2214
|
+
/** Street number. */
|
|
2215
|
+
streetNumber?: string;
|
|
2216
|
+
/** Apartment number. */
|
|
2217
|
+
apartmentNumber?: string;
|
|
2218
|
+
/** Geographic coordinates of location. */
|
|
2219
|
+
coordinates?: GeoCoordinates;
|
|
2220
|
+
}
|
|
2221
|
+
/**
|
|
2222
|
+
* Extra information on displayed addresses.
|
|
2223
|
+
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
2224
|
+
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
2225
|
+
*/
|
|
2226
|
+
interface AddressHint {
|
|
2227
|
+
/** Extra text displayed next to, or instead of, the actual address. */
|
|
2228
|
+
text?: string;
|
|
2229
|
+
/** Where the extra text should be displayed. */
|
|
2230
|
+
placement?: PlacementTypeWithLiterals;
|
|
2231
|
+
}
|
|
2232
|
+
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
2233
|
+
declare enum PlacementType {
|
|
2234
|
+
BEFORE = "BEFORE",
|
|
2235
|
+
AFTER = "AFTER",
|
|
2236
|
+
REPLACE = "REPLACE"
|
|
2237
|
+
}
|
|
2238
|
+
/** @enumType */
|
|
2239
|
+
type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
|
|
2240
|
+
/** Geocoordinates for a particular address. */
|
|
2241
|
+
interface GeoCoordinates {
|
|
2242
|
+
/** Latitude of the location. Must be between -90 and 90. */
|
|
2243
|
+
latitude?: number;
|
|
2244
|
+
/** Longitude of the location. Must be between -180 and 180. */
|
|
2245
|
+
longitude?: number;
|
|
2246
|
+
}
|
|
2247
|
+
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
2248
|
+
interface BusinessSchedule {
|
|
2249
|
+
/**
|
|
2250
|
+
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
2251
|
+
* @maxSize 100
|
|
2252
|
+
*/
|
|
2253
|
+
periods?: TimePeriod[];
|
|
2254
|
+
/**
|
|
2255
|
+
* Exceptions to the business's regular hours. The business can be open or closed during the exception.
|
|
2256
|
+
* @maxSize 100
|
|
2257
|
+
*/
|
|
2258
|
+
specialHourPeriod?: SpecialHourPeriod[];
|
|
2259
|
+
}
|
|
2260
|
+
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
2261
|
+
interface TimePeriod {
|
|
2262
|
+
/** Day of the week the period starts on. */
|
|
2263
|
+
openDay?: DayOfWeekWithLiterals;
|
|
2264
|
+
/**
|
|
2265
|
+
* Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
2266
|
+
* midnight at the end of the specified day.
|
|
2267
|
+
*/
|
|
2268
|
+
openTime?: string;
|
|
2269
|
+
/** Day of the week the period ends on. */
|
|
2270
|
+
closeDay?: DayOfWeekWithLiterals;
|
|
2271
|
+
/**
|
|
2272
|
+
* Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
2273
|
+
* midnight at the end of the specified day.
|
|
2274
|
+
*
|
|
2275
|
+
* __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
|
|
2276
|
+
*/
|
|
2277
|
+
closeTime?: string;
|
|
2278
|
+
}
|
|
2279
|
+
/** Enumerates the days of the week. */
|
|
2280
|
+
declare enum DayOfWeek {
|
|
2281
|
+
MONDAY = "MONDAY",
|
|
2282
|
+
TUESDAY = "TUESDAY",
|
|
2283
|
+
WEDNESDAY = "WEDNESDAY",
|
|
2284
|
+
THURSDAY = "THURSDAY",
|
|
2285
|
+
FRIDAY = "FRIDAY",
|
|
2286
|
+
SATURDAY = "SATURDAY",
|
|
2287
|
+
SUNDAY = "SUNDAY"
|
|
2288
|
+
}
|
|
2289
|
+
/** @enumType */
|
|
2290
|
+
type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
2291
|
+
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
2292
|
+
interface SpecialHourPeriod {
|
|
2293
|
+
/** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
2294
|
+
startDate?: string;
|
|
2295
|
+
/** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
2296
|
+
endDate?: string;
|
|
2297
|
+
/**
|
|
2298
|
+
* Whether the business is closed (or the service is not available) during the exception.
|
|
2299
|
+
*
|
|
2300
|
+
* Default: `true`.
|
|
2301
|
+
*/
|
|
2302
|
+
isClosed?: boolean;
|
|
2303
|
+
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
2304
|
+
comment?: string;
|
|
2305
|
+
}
|
|
2306
|
+
interface Multilingual {
|
|
2307
|
+
/**
|
|
2308
|
+
* Supported languages list.
|
|
2309
|
+
* @maxSize 200
|
|
2310
|
+
*/
|
|
2311
|
+
supportedLanguages?: SupportedLanguage[];
|
|
2312
|
+
/** Whether to redirect to user language. */
|
|
2313
|
+
autoRedirect?: boolean;
|
|
2314
|
+
}
|
|
2315
|
+
interface SupportedLanguage {
|
|
2316
|
+
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
2317
|
+
languageCode?: string;
|
|
2318
|
+
/** Locale. */
|
|
2319
|
+
locale?: Locale;
|
|
2320
|
+
/** Whether the supported language is the primary language for the site. */
|
|
2321
|
+
isPrimary?: boolean;
|
|
2322
|
+
/** Language icon. */
|
|
2323
|
+
countryCode?: string;
|
|
2324
|
+
/** How the language will be resolved. For internal use. */
|
|
2325
|
+
resolutionMethod?: ResolutionMethodWithLiterals;
|
|
2326
|
+
/** Whether the supported language is the primary language for site visitors. */
|
|
2327
|
+
isVisitorPrimary?: boolean | null;
|
|
2328
|
+
}
|
|
2329
|
+
declare enum ResolutionMethod {
|
|
2330
|
+
QUERY_PARAM = "QUERY_PARAM",
|
|
2331
|
+
SUBDOMAIN = "SUBDOMAIN",
|
|
2332
|
+
SUBDIRECTORY = "SUBDIRECTORY"
|
|
2333
|
+
}
|
|
2334
|
+
/** @enumType */
|
|
2335
|
+
type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
|
|
2336
|
+
interface ConsentPolicy {
|
|
2337
|
+
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
2338
|
+
essential?: boolean | null;
|
|
2339
|
+
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
2340
|
+
functional?: boolean | null;
|
|
2341
|
+
/** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
|
|
2342
|
+
analytics?: boolean | null;
|
|
2343
|
+
/** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
|
|
2344
|
+
advertising?: boolean | null;
|
|
2345
|
+
/** CCPA compliance flag. */
|
|
2346
|
+
dataToThirdParty?: boolean | null;
|
|
2347
|
+
}
|
|
2348
|
+
interface MessageEnvelope {
|
|
2349
|
+
/**
|
|
2350
|
+
* App instance ID.
|
|
2351
|
+
* @format GUID
|
|
2352
|
+
*/
|
|
2353
|
+
instanceId?: string | null;
|
|
2354
|
+
/**
|
|
2355
|
+
* Event type.
|
|
2356
|
+
* @maxLength 150
|
|
2357
|
+
*/
|
|
2358
|
+
eventType?: string;
|
|
2359
|
+
/** The identification type and identity data. */
|
|
2360
|
+
identity?: IdentificationData;
|
|
2361
|
+
/** Stringify payload. */
|
|
2362
|
+
data?: string;
|
|
2363
|
+
}
|
|
2364
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2365
|
+
/**
|
|
2366
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2367
|
+
* @format GUID
|
|
2368
|
+
*/
|
|
2369
|
+
anonymousVisitorId?: string;
|
|
2370
|
+
/**
|
|
2371
|
+
* ID of a site visitor that has logged in to the site.
|
|
2372
|
+
* @format GUID
|
|
2373
|
+
*/
|
|
2374
|
+
memberId?: string;
|
|
2375
|
+
/**
|
|
2376
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2377
|
+
* @format GUID
|
|
2378
|
+
*/
|
|
2379
|
+
wixUserId?: string;
|
|
2380
|
+
/**
|
|
2381
|
+
* ID of an app.
|
|
2382
|
+
* @format GUID
|
|
2383
|
+
*/
|
|
2384
|
+
appId?: string;
|
|
2385
|
+
/** @readonly */
|
|
2386
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2387
|
+
}
|
|
2388
|
+
/** @oneof */
|
|
2389
|
+
interface IdentificationDataIdOneOf {
|
|
2390
|
+
/**
|
|
2391
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2392
|
+
* @format GUID
|
|
2393
|
+
*/
|
|
2394
|
+
anonymousVisitorId?: string;
|
|
2395
|
+
/**
|
|
2396
|
+
* ID of a site visitor that has logged in to the site.
|
|
2397
|
+
* @format GUID
|
|
2398
|
+
*/
|
|
2399
|
+
memberId?: string;
|
|
2400
|
+
/**
|
|
2401
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2402
|
+
* @format GUID
|
|
2403
|
+
*/
|
|
2404
|
+
wixUserId?: string;
|
|
2405
|
+
/**
|
|
2406
|
+
* ID of an app.
|
|
2407
|
+
* @format GUID
|
|
2408
|
+
*/
|
|
2409
|
+
appId?: string;
|
|
2410
|
+
}
|
|
2411
|
+
declare enum WebhookIdentityType {
|
|
2412
|
+
UNKNOWN = "UNKNOWN",
|
|
2413
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2414
|
+
MEMBER = "MEMBER",
|
|
2415
|
+
WIX_USER = "WIX_USER",
|
|
2416
|
+
APP = "APP"
|
|
2417
|
+
}
|
|
2418
|
+
/** @enumType */
|
|
2419
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2420
|
+
/** @docsIgnore */
|
|
2421
|
+
type UpdateProgramApplicationErrors = {
|
|
2422
|
+
code?: 'WRONG_STATE';
|
|
2423
|
+
description?: string;
|
|
2424
|
+
data?: WrongStateErrorDetails;
|
|
2425
|
+
} | {
|
|
2426
|
+
code?: 'WRONG_START_DATE';
|
|
2427
|
+
description?: string;
|
|
2428
|
+
data?: WrongStartDateErrorDetails;
|
|
2429
|
+
} | {
|
|
2430
|
+
code?: 'WRONG_PARTICIPANTS_NUMBER';
|
|
2431
|
+
description?: string;
|
|
2432
|
+
data?: WrongParticipantsNumberErrorDetails;
|
|
2433
|
+
} | {
|
|
2434
|
+
code?: 'DUPLICATED_SLUG';
|
|
2435
|
+
description?: string;
|
|
2436
|
+
data?: DuplicatedSlugErrorDetails;
|
|
2437
|
+
} | {
|
|
2438
|
+
code?: 'TIMELINE_SWITCH_FORBIDDEN';
|
|
2439
|
+
description?: string;
|
|
2440
|
+
data?: TimelineSwitchForbiddenErrorDetails;
|
|
2441
|
+
};
|
|
2442
|
+
/** @docsIgnore */
|
|
2443
|
+
type PublishProgramApplicationErrors = {
|
|
2444
|
+
code?: 'INVALID_START_DATE';
|
|
2445
|
+
description?: string;
|
|
2446
|
+
data?: Record<string, any>;
|
|
2447
|
+
};
|
|
1196
2448
|
|
|
1197
2449
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
1198
2450
|
getUrl: (context: any) => string;
|
|
@@ -1232,4 +2484,4 @@ declare function bulkUpdatePrograms(): __PublicMethodMetaInfo<'POST', {}, BulkUp
|
|
|
1232
2484
|
declare function countPrograms(): __PublicMethodMetaInfo<'POST', {}, CountProgramsRequest$1, CountProgramsRequest, CountProgramsResponse$1, CountProgramsResponse>;
|
|
1233
2485
|
declare function listSamplePrograms(): __PublicMethodMetaInfo<'GET', {}, ListSampleProgramsRequest$1, ListSampleProgramsRequest, ListSampleProgramsResponse$1, ListSampleProgramsResponse>;
|
|
1234
2486
|
|
|
1235
|
-
export { type __PublicMethodMetaInfo, archiveProgram, bulkUpdatePrograms, countPrograms, createProgram, deleteProgram, duplicateProgram, endProgram, getProgram, listSamplePrograms, publishProgram, queryPrograms, searchPrograms, updateProgram };
|
|
2487
|
+
export { AccessType as AccessTypeOriginal, type AccessTypeWithLiterals as AccessTypeWithLiteralsOriginal, type ActionEvent as ActionEventOriginal, type AddressHint as AddressHintOriginal, type Address as AddressOriginal, type AggregationData as AggregationDataOriginal, type AggregationKindOneOf as AggregationKindOneOfOriginal, type Aggregation as AggregationOriginal, type AggregationResults as AggregationResultsOriginal, type AggregationResultsResultOneOf as AggregationResultsResultOneOfOriginal, type AggregationResultsScalarResult as AggregationResultsScalarResultOriginal, AggregationType as AggregationTypeOriginal, type AggregationTypeWithLiterals as AggregationTypeWithLiteralsOriginal, type App as AppOriginal, type ApplicationError as ApplicationErrorOriginal, type ArchiveProgramRequest as ArchiveProgramRequestOriginal, type ArchiveProgramResponse as ArchiveProgramResponseOriginal, type Asset as AssetOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, BulkActionType as BulkActionTypeOriginal, type BulkActionTypeWithLiterals as BulkActionTypeWithLiteralsOriginal, type BulkCreateProgramsMigrationRequest as BulkCreateProgramsMigrationRequestOriginal, type BulkCreateProgramsMigrationResponse as BulkCreateProgramsMigrationResponseOriginal, type BulkProgramResult as BulkProgramResultOriginal, type BulkUpdateProgramResult as BulkUpdateProgramResultOriginal, type BulkUpdateProgramsRequest as BulkUpdateProgramsRequestOriginal, type BulkUpdateProgramsResponse as BulkUpdateProgramsResponseOriginal, type BusinessSchedule as BusinessScheduleOriginal, type Categories as CategoriesOriginal, type Certificate as CertificateOriginal, type ConsentPolicy as ConsentPolicyOriginal, type ContentSummary as ContentSummaryOriginal, type CountProgramsRequest as CountProgramsRequestOriginal, type CountProgramsResponse as CountProgramsResponseOriginal, type CreateProgramRequest as CreateProgramRequestOriginal, type CreateProgramResponse as CreateProgramResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomTag as CustomTagOriginal, type DateHistogramAggregation as DateHistogramAggregationOriginal, type DateHistogramResult as DateHistogramResultOriginal, type DateHistogramResults as DateHistogramResultsOriginal, DayOfWeek as DayOfWeekOriginal, type DayOfWeekWithLiterals as DayOfWeekWithLiteralsOriginal, type DeleteAllProgramsMigrationRequest as DeleteAllProgramsMigrationRequestOriginal, type DeleteAllProgramsMigrationResponse as DeleteAllProgramsMigrationResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteContext as DeleteContextOriginal, type Delete as DeleteOriginal, type DeleteProgramRequest as DeleteProgramRequestOriginal, type DeleteProgramResponse as DeleteProgramResponseOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DescriptionMediaOneOf as DescriptionMediaOneOfOriginal, type Description as DescriptionOriginal, type DocumentImage as DocumentImageOriginal, type DocumentPayload as DocumentPayloadOriginal, type DocumentUpdateOperation as DocumentUpdateOperationOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DuplicateProgramRequest as DuplicateProgramRequestOriginal, type DuplicateProgramResponse as DuplicateProgramResponseOriginal, type DuplicatedSlugErrorDetails as DuplicatedSlugErrorDetailsOriginal, type Empty as EmptyOriginal, type EndProgramRequest as EndProgramRequestOriginal, type EndProgramResponse as EndProgramResponseOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, Enum as EnumOriginal, type EnumWithLiterals as EnumWithLiteralsOriginal, type ExtendedFields as ExtendedFieldsOriginal, type File as FileOriginal, type FocalPoint as FocalPointOriginal, type GeoCoordinates as GeoCoordinatesOriginal, type GetProgramRequest as GetProgramRequestOriginal, type GetProgramResponse as GetProgramResponseOriginal, type GroupByAggregationKindOneOf as GroupByAggregationKindOneOfOriginal, type GroupByAggregation as GroupByAggregationOriginal, type GroupByValueResults as GroupByValueResultsOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type IncludeMissingValuesOptions as IncludeMissingValuesOptionsOriginal, type IndexDocument as IndexDocumentOriginal, Interval as IntervalOriginal, type IntervalWithLiterals as IntervalWithLiteralsOriginal, type InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOfOriginal, type InvalidateCache as InvalidateCacheOriginal, type ItemMetadata as ItemMetadataOriginal, type Keyword as KeywordOriginal, type LabeledProgram as LabeledProgramOriginal, type ListSampleProgramsRequest as ListSampleProgramsRequestOriginal, type ListSampleProgramsResponse as ListSampleProgramsResponseOriginal, type Locale as LocaleOriginal, type MaskedProgram as MaskedProgramOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type MissingMetasiteIdErrorDetails as MissingMetasiteIdErrorDetailsOriginal, MissingValues as MissingValuesOriginal, type MissingValuesWithLiterals as MissingValuesWithLiteralsOriginal, Mode as ModeOriginal, type ModeWithLiterals as ModeWithLiteralsOriginal, type Money as MoneyOriginal, type Multilingual as MultilingualOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOfOriginal, type NestedAggregationItem as NestedAggregationItemOriginal, type NestedAggregation as NestedAggregationOriginal, type NestedAggregationResults as NestedAggregationResultsOriginal, type NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOfOriginal, NestedAggregationType as NestedAggregationTypeOriginal, type NestedAggregationTypeWithLiterals as NestedAggregationTypeWithLiteralsOriginal, type NestedResultValue as NestedResultValueOriginal, type NestedResultValueResultOneOf as NestedResultValueResultOneOfOriginal, type NestedResults as NestedResultsOriginal, type NestedValueAggregationResult as NestedValueAggregationResultOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, type Page as PageOriginal, type PageUrl as PageUrlOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, PlacementType as PlacementTypeOriginal, type PlacementTypeWithLiterals as PlacementTypeWithLiteralsOriginal, type ProgramArchived as ProgramArchivedOriginal, type ProgramDuplicated as ProgramDuplicatedOriginal, type ProgramEnded as ProgramEndedOriginal, type ProgramMigration as ProgramMigrationOriginal, type Program as ProgramOriginal, type ProgramPublished as ProgramPublishedOriginal, type Properties as PropertiesOriginal, type PublishProgramApplicationErrors as PublishProgramApplicationErrorsOriginal, type PublishProgramRequest as PublishProgramRequestOriginal, type PublishProgramResponse as PublishProgramResponseOriginal, type QueryProgramsRequest as QueryProgramsRequestOriginal, type QueryProgramsResponse as QueryProgramsResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type RangeAggregation as RangeAggregationOriginal, type RangeAggregationResult as RangeAggregationResultOriginal, type RangeBucket as RangeBucketOriginal, type RangeResult as RangeResultOriginal, type RangeResults as RangeResultsOriginal, type ReindexMessageActionOneOf as ReindexMessageActionOneOfOriginal, type ReindexMessage as ReindexMessageOriginal, ResolutionMethod as ResolutionMethodOriginal, type ResolutionMethodWithLiterals as ResolutionMethodWithLiteralsOriginal, type ResolveProgramSlugRequest as ResolveProgramSlugRequestOriginal, type ResolveProgramSlugResponse as ResolveProgramSlugResponseOriginal, type RestoreInfo as RestoreInfoOriginal, RestrictionsAccessType as RestrictionsAccessTypeOriginal, type RestrictionsAccessTypeWithLiterals as RestrictionsAccessTypeWithLiteralsOriginal, type Restrictions as RestrictionsOriginal, type Results as ResultsOriginal, type Reward as RewardOriginal, type ScalarAggregation as ScalarAggregationOriginal, type ScalarResult as ScalarResultOriginal, ScalarType as ScalarTypeOriginal, type ScalarTypeWithLiterals as ScalarTypeWithLiteralsOriginal, type Schema as SchemaOriginal, type SearchDetails as SearchDetailsOriginal, type SearchIndexingNotification as SearchIndexingNotificationOriginal, SearchIndexingNotificationState as SearchIndexingNotificationStateOriginal, type SearchIndexingNotificationStateWithLiterals as SearchIndexingNotificationStateWithLiteralsOriginal, type SearchProgramsRequest as SearchProgramsRequestOriginal, type SearchProgramsResponse as SearchProgramsResponseOriginal, type Seo as SeoOriginal, type SeoSchema as SeoSchemaOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type Settings as SettingsOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePropertiesEvent as SitePropertiesEventOriginal, type SitePropertiesUpdated as SitePropertiesUpdatedOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortDirection as SortDirectionOriginal, type SortDirectionWithLiterals as SortDirectionWithLiteralsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, SortType as SortTypeOriginal, type SortTypeWithLiterals as SortTypeWithLiteralsOriginal, type Sorting as SortingOriginal, type SpecialHourPeriod as SpecialHourPeriodOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type SupportedLanguage as SupportedLanguageOriginal, type Tag as TagOriginal, type TimePeriod as TimePeriodOriginal, type Timeline as TimelineOriginal, type TimelineSwitchForbiddenErrorDetails as TimelineSwitchForbiddenErrorDetailsOriginal, Trigger as TriggerOriginal, type TriggerWithLiterals as TriggerWithLiteralsOriginal, type URI as URIOriginal, type UpdateByFilterOperation as UpdateByFilterOperationOriginal, type UpdateDocumentsEventOperationOneOf as UpdateDocumentsEventOperationOneOfOriginal, type UpdateDocumentsEvent as UpdateDocumentsEventOriginal, type UpdateExistingOperation as UpdateExistingOperationOriginal, type UpdateProgramApplicationErrors as UpdateProgramApplicationErrorsOriginal, type UpdateProgramRequest as UpdateProgramRequestOriginal, type UpdateProgramResponse as UpdateProgramResponseOriginal, type Upsert as UpsertOriginal, V3State as V3StateOriginal, type V3StateWithLiterals as V3StateWithLiteralsOriginal, type ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOfOriginal, type ValueAggregation as ValueAggregationOriginal, type ValueAggregationResult as ValueAggregationResultOriginal, type ValueResult as ValueResultOriginal, type ValueResults as ValueResultsOriginal, type VideoResolution as VideoResolutionOriginal, type VideoStepsSettings as VideoStepsSettingsOriginal, type VideoV2 as VideoV2Original, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WrongParticipantsNumberErrorDetails as WrongParticipantsNumberErrorDetailsOriginal, type WrongStartDateErrorDetails as WrongStartDateErrorDetailsOriginal, type WrongStateErrorDetails as WrongStateErrorDetailsOriginal, type __PublicMethodMetaInfo, archiveProgram, bulkUpdatePrograms, countPrograms, createProgram, deleteProgram, duplicateProgram, endProgram, getProgram, listSamplePrograms, publishProgram, queryPrograms, searchPrograms, updateProgram };
|