@wix/portfolio 1.0.113 → 1.0.114
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +4 -4
- package/type-bundles/context.bundle.d.ts +134 -129
- package/type-bundles/index.bundle.d.ts +134 -129
- package/type-bundles/meta.bundle.d.ts +12 -10
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/portfolio",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.114",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -22,9 +22,9 @@
|
|
|
22
22
|
],
|
|
23
23
|
"dependencies": {
|
|
24
24
|
"@wix/portfolio_collections": "1.0.36",
|
|
25
|
-
"@wix/portfolio_portfolio-settings": "1.0.
|
|
25
|
+
"@wix/portfolio_portfolio-settings": "1.0.23",
|
|
26
26
|
"@wix/portfolio_project-in-collections": "1.0.39",
|
|
27
|
-
"@wix/portfolio_project-items": "1.0.
|
|
27
|
+
"@wix/portfolio_project-items": "1.0.42",
|
|
28
28
|
"@wix/portfolio_projects": "1.0.53",
|
|
29
29
|
"@wix/portfolio_synced-project": "1.0.18"
|
|
30
30
|
},
|
|
@@ -51,5 +51,5 @@
|
|
|
51
51
|
"fqdn": ""
|
|
52
52
|
}
|
|
53
53
|
},
|
|
54
|
-
"falconPackageHash": "
|
|
54
|
+
"falconPackageHash": "7d9e41f4df2441573fe3c644cb178340614ebf24959adb7c4b2cd0cc"
|
|
55
55
|
}
|
|
@@ -1220,20 +1220,21 @@ interface PortfolioSettings {
|
|
|
1220
1220
|
_updatedDate?: Date | null;
|
|
1221
1221
|
}
|
|
1222
1222
|
interface ProjectItemSettings {
|
|
1223
|
+
/** The direction in which to add new project items to a gallery. Default: `GALLERY_START` */
|
|
1223
1224
|
addItemDirection?: AddItemDirection;
|
|
1224
|
-
/**
|
|
1225
|
+
/** Default title assigned to a project item if no title is provided. Default: `FILE_NAME` */
|
|
1225
1226
|
defaultItemName?: DefaultItemName;
|
|
1226
1227
|
}
|
|
1227
1228
|
declare enum AddItemDirection {
|
|
1228
|
-
/** Add new items to the start of the gallery. */
|
|
1229
|
+
/** Add new project items to the start of the gallery. */
|
|
1229
1230
|
GALLERY_START = "GALLERY_START",
|
|
1230
|
-
/** Add new items to the end of the gallery. */
|
|
1231
|
+
/** Add new project items to the end of the gallery. */
|
|
1231
1232
|
GALLERY_END = "GALLERY_END"
|
|
1232
1233
|
}
|
|
1233
1234
|
declare enum DefaultItemName {
|
|
1234
|
-
/**
|
|
1235
|
+
/** File name assigned as the title. */
|
|
1235
1236
|
FILE_NAME = "FILE_NAME",
|
|
1236
|
-
/**
|
|
1237
|
+
/** No title assigned. */
|
|
1237
1238
|
EMPTY = "EMPTY"
|
|
1238
1239
|
}
|
|
1239
1240
|
interface MediaSettings {
|
|
@@ -1397,6 +1398,10 @@ declare function createPortfolioSettings$1(httpClient: HttpClient): CreatePortfo
|
|
|
1397
1398
|
interface CreatePortfolioSettingsSignature {
|
|
1398
1399
|
/**
|
|
1399
1400
|
* Creates a site's portfolio settings.
|
|
1401
|
+
*
|
|
1402
|
+
* > **Note:**
|
|
1403
|
+
* >
|
|
1404
|
+
* > This method is intended for creating portfolio settings. If settings already exist, the request will return an error. To update existing settings, call [Update Portfolio Settings](https://dev.wix.com/docs/rest/business-solutions/portfolio/portfolio-settings/update-portfolio-settings).
|
|
1400
1405
|
* @param - The portfolio settings to create.
|
|
1401
1406
|
* @returns Newly created portfolio settings.
|
|
1402
1407
|
*/
|
|
@@ -1578,6 +1583,130 @@ interface Link {
|
|
|
1578
1583
|
*/
|
|
1579
1584
|
target?: string | null;
|
|
1580
1585
|
}
|
|
1586
|
+
interface GenerateTokenForProjectItemsRequest {
|
|
1587
|
+
/** Media ids of requested project items */
|
|
1588
|
+
mediaIds?: string[];
|
|
1589
|
+
}
|
|
1590
|
+
interface GenerateTokenForProjectItemsResponse {
|
|
1591
|
+
/** Generated media tokens for project items */
|
|
1592
|
+
mediaTokens?: ProjectItemMediaToken[];
|
|
1593
|
+
}
|
|
1594
|
+
interface ProjectItemMediaToken {
|
|
1595
|
+
/** Media id of project item */
|
|
1596
|
+
mediaId?: string;
|
|
1597
|
+
/** Generated media token for project item */
|
|
1598
|
+
mediaToken?: string;
|
|
1599
|
+
}
|
|
1600
|
+
interface DomainEvent$3 extends DomainEventBodyOneOf$3 {
|
|
1601
|
+
createdEvent?: EntityCreatedEvent$3;
|
|
1602
|
+
updatedEvent?: EntityUpdatedEvent$3;
|
|
1603
|
+
deletedEvent?: EntityDeletedEvent$3;
|
|
1604
|
+
actionEvent?: ActionEvent$3;
|
|
1605
|
+
/**
|
|
1606
|
+
* Unique event ID.
|
|
1607
|
+
* Allows clients to ignore duplicate webhooks.
|
|
1608
|
+
*/
|
|
1609
|
+
_id?: string;
|
|
1610
|
+
/**
|
|
1611
|
+
* Assumes actions are also always typed to an entity_type
|
|
1612
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1613
|
+
*/
|
|
1614
|
+
entityFqdn?: string;
|
|
1615
|
+
/**
|
|
1616
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1617
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1618
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
1619
|
+
*/
|
|
1620
|
+
slug?: string;
|
|
1621
|
+
/** ID of the entity associated with the event. */
|
|
1622
|
+
entityId?: string;
|
|
1623
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1624
|
+
eventTime?: Date | null;
|
|
1625
|
+
/**
|
|
1626
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1627
|
+
* (for example, GDPR).
|
|
1628
|
+
*/
|
|
1629
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1630
|
+
/** If present, indicates the action that triggered the event. */
|
|
1631
|
+
originatedFrom?: string | null;
|
|
1632
|
+
/**
|
|
1633
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
1634
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1635
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1636
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1637
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1638
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1639
|
+
*/
|
|
1640
|
+
entityEventSequence?: string | null;
|
|
1641
|
+
}
|
|
1642
|
+
/** @oneof */
|
|
1643
|
+
interface DomainEventBodyOneOf$3 {
|
|
1644
|
+
createdEvent?: EntityCreatedEvent$3;
|
|
1645
|
+
updatedEvent?: EntityUpdatedEvent$3;
|
|
1646
|
+
deletedEvent?: EntityDeletedEvent$3;
|
|
1647
|
+
actionEvent?: ActionEvent$3;
|
|
1648
|
+
}
|
|
1649
|
+
interface EntityCreatedEvent$3 {
|
|
1650
|
+
entity?: string;
|
|
1651
|
+
}
|
|
1652
|
+
interface RestoreInfo$3 {
|
|
1653
|
+
deletedDate?: Date | null;
|
|
1654
|
+
}
|
|
1655
|
+
interface EntityUpdatedEvent$3 {
|
|
1656
|
+
/**
|
|
1657
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1658
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1659
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1660
|
+
*/
|
|
1661
|
+
currentEntity?: string;
|
|
1662
|
+
}
|
|
1663
|
+
interface EntityDeletedEvent$3 {
|
|
1664
|
+
/** Entity that was deleted */
|
|
1665
|
+
deletedEntity?: string | null;
|
|
1666
|
+
}
|
|
1667
|
+
interface ActionEvent$3 {
|
|
1668
|
+
body?: string;
|
|
1669
|
+
}
|
|
1670
|
+
interface MessageEnvelope$3 {
|
|
1671
|
+
/** App instance ID. */
|
|
1672
|
+
instanceId?: string | null;
|
|
1673
|
+
/** Event type. */
|
|
1674
|
+
eventType?: string;
|
|
1675
|
+
/** The identification type and identity data. */
|
|
1676
|
+
identity?: IdentificationData$3;
|
|
1677
|
+
/** Stringify payload. */
|
|
1678
|
+
data?: string;
|
|
1679
|
+
}
|
|
1680
|
+
interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {
|
|
1681
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
1682
|
+
anonymousVisitorId?: string;
|
|
1683
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
1684
|
+
memberId?: string;
|
|
1685
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1686
|
+
wixUserId?: string;
|
|
1687
|
+
/** ID of an app. */
|
|
1688
|
+
appId?: string;
|
|
1689
|
+
/** @readonly */
|
|
1690
|
+
identityType?: WebhookIdentityType$3;
|
|
1691
|
+
}
|
|
1692
|
+
/** @oneof */
|
|
1693
|
+
interface IdentificationDataIdOneOf$3 {
|
|
1694
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
1695
|
+
anonymousVisitorId?: string;
|
|
1696
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
1697
|
+
memberId?: string;
|
|
1698
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1699
|
+
wixUserId?: string;
|
|
1700
|
+
/** ID of an app. */
|
|
1701
|
+
appId?: string;
|
|
1702
|
+
}
|
|
1703
|
+
declare enum WebhookIdentityType$3 {
|
|
1704
|
+
UNKNOWN = "UNKNOWN",
|
|
1705
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1706
|
+
MEMBER = "MEMBER",
|
|
1707
|
+
WIX_USER = "WIX_USER",
|
|
1708
|
+
APP = "APP"
|
|
1709
|
+
}
|
|
1581
1710
|
interface InvalidateCache$1 extends InvalidateCacheGetByOneOf$1 {
|
|
1582
1711
|
/** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
|
|
1583
1712
|
metaSiteId?: string;
|
|
@@ -1863,76 +1992,6 @@ interface CreateProjectGalleryResponse {
|
|
|
1863
1992
|
/** Id of created gallery */
|
|
1864
1993
|
galleryId?: string;
|
|
1865
1994
|
}
|
|
1866
|
-
interface DomainEvent$3 extends DomainEventBodyOneOf$3 {
|
|
1867
|
-
createdEvent?: EntityCreatedEvent$3;
|
|
1868
|
-
updatedEvent?: EntityUpdatedEvent$3;
|
|
1869
|
-
deletedEvent?: EntityDeletedEvent$3;
|
|
1870
|
-
actionEvent?: ActionEvent$3;
|
|
1871
|
-
/**
|
|
1872
|
-
* Unique event ID.
|
|
1873
|
-
* Allows clients to ignore duplicate webhooks.
|
|
1874
|
-
*/
|
|
1875
|
-
_id?: string;
|
|
1876
|
-
/**
|
|
1877
|
-
* Assumes actions are also always typed to an entity_type
|
|
1878
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1879
|
-
*/
|
|
1880
|
-
entityFqdn?: string;
|
|
1881
|
-
/**
|
|
1882
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1883
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1884
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
1885
|
-
*/
|
|
1886
|
-
slug?: string;
|
|
1887
|
-
/** ID of the entity associated with the event. */
|
|
1888
|
-
entityId?: string;
|
|
1889
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1890
|
-
eventTime?: Date | null;
|
|
1891
|
-
/**
|
|
1892
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
1893
|
-
* (for example, GDPR).
|
|
1894
|
-
*/
|
|
1895
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
1896
|
-
/** If present, indicates the action that triggered the event. */
|
|
1897
|
-
originatedFrom?: string | null;
|
|
1898
|
-
/**
|
|
1899
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
1900
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1901
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1902
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1903
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1904
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1905
|
-
*/
|
|
1906
|
-
entityEventSequence?: string | null;
|
|
1907
|
-
}
|
|
1908
|
-
/** @oneof */
|
|
1909
|
-
interface DomainEventBodyOneOf$3 {
|
|
1910
|
-
createdEvent?: EntityCreatedEvent$3;
|
|
1911
|
-
updatedEvent?: EntityUpdatedEvent$3;
|
|
1912
|
-
deletedEvent?: EntityDeletedEvent$3;
|
|
1913
|
-
actionEvent?: ActionEvent$3;
|
|
1914
|
-
}
|
|
1915
|
-
interface EntityCreatedEvent$3 {
|
|
1916
|
-
entity?: string;
|
|
1917
|
-
}
|
|
1918
|
-
interface RestoreInfo$3 {
|
|
1919
|
-
deletedDate?: Date | null;
|
|
1920
|
-
}
|
|
1921
|
-
interface EntityUpdatedEvent$3 {
|
|
1922
|
-
/**
|
|
1923
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1924
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1925
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1926
|
-
*/
|
|
1927
|
-
currentEntity?: string;
|
|
1928
|
-
}
|
|
1929
|
-
interface EntityDeletedEvent$3 {
|
|
1930
|
-
/** Entity that was deleted */
|
|
1931
|
-
deletedEntity?: string | null;
|
|
1932
|
-
}
|
|
1933
|
-
interface ActionEvent$3 {
|
|
1934
|
-
body?: string;
|
|
1935
|
-
}
|
|
1936
1995
|
interface Empty$2 {
|
|
1937
1996
|
}
|
|
1938
1997
|
interface DeletedProjectRestored$1 {
|
|
@@ -1953,60 +2012,6 @@ interface DuplicateProjectItemsResponse {
|
|
|
1953
2012
|
/** Bulk action metadata. */
|
|
1954
2013
|
bulkActionMetadata?: BulkActionMetadata$1;
|
|
1955
2014
|
}
|
|
1956
|
-
interface MessageEnvelope$3 {
|
|
1957
|
-
/** App instance ID. */
|
|
1958
|
-
instanceId?: string | null;
|
|
1959
|
-
/** Event type. */
|
|
1960
|
-
eventType?: string;
|
|
1961
|
-
/** The identification type and identity data. */
|
|
1962
|
-
identity?: IdentificationData$3;
|
|
1963
|
-
/** Stringify payload. */
|
|
1964
|
-
data?: string;
|
|
1965
|
-
}
|
|
1966
|
-
interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {
|
|
1967
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
1968
|
-
anonymousVisitorId?: string;
|
|
1969
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
1970
|
-
memberId?: string;
|
|
1971
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1972
|
-
wixUserId?: string;
|
|
1973
|
-
/** ID of an app. */
|
|
1974
|
-
appId?: string;
|
|
1975
|
-
/** @readonly */
|
|
1976
|
-
identityType?: WebhookIdentityType$3;
|
|
1977
|
-
}
|
|
1978
|
-
/** @oneof */
|
|
1979
|
-
interface IdentificationDataIdOneOf$3 {
|
|
1980
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
1981
|
-
anonymousVisitorId?: string;
|
|
1982
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
1983
|
-
memberId?: string;
|
|
1984
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1985
|
-
wixUserId?: string;
|
|
1986
|
-
/** ID of an app. */
|
|
1987
|
-
appId?: string;
|
|
1988
|
-
}
|
|
1989
|
-
declare enum WebhookIdentityType$3 {
|
|
1990
|
-
UNKNOWN = "UNKNOWN",
|
|
1991
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1992
|
-
MEMBER = "MEMBER",
|
|
1993
|
-
WIX_USER = "WIX_USER",
|
|
1994
|
-
APP = "APP"
|
|
1995
|
-
}
|
|
1996
|
-
interface GenerateTokenForProjectItemsRequest {
|
|
1997
|
-
/** Media ids of requested project items */
|
|
1998
|
-
mediaIds?: string[];
|
|
1999
|
-
}
|
|
2000
|
-
interface GenerateTokenForProjectItemsResponse {
|
|
2001
|
-
/** Generated media tokens for project items */
|
|
2002
|
-
mediaTokens?: ProjectItemMediaToken[];
|
|
2003
|
-
}
|
|
2004
|
-
interface ProjectItemMediaToken {
|
|
2005
|
-
/** Media id of project item */
|
|
2006
|
-
mediaId?: string;
|
|
2007
|
-
/** Generated media token for project item */
|
|
2008
|
-
mediaToken?: string;
|
|
2009
|
-
}
|
|
2010
2015
|
interface PointNonNullableFields$2 {
|
|
2011
2016
|
x: number;
|
|
2012
2017
|
y: number;
|
|
@@ -1220,20 +1220,21 @@ interface PortfolioSettings {
|
|
|
1220
1220
|
_updatedDate?: Date | null;
|
|
1221
1221
|
}
|
|
1222
1222
|
interface ProjectItemSettings {
|
|
1223
|
+
/** The direction in which to add new project items to a gallery. Default: `GALLERY_START` */
|
|
1223
1224
|
addItemDirection?: AddItemDirection;
|
|
1224
|
-
/**
|
|
1225
|
+
/** Default title assigned to a project item if no title is provided. Default: `FILE_NAME` */
|
|
1225
1226
|
defaultItemName?: DefaultItemName;
|
|
1226
1227
|
}
|
|
1227
1228
|
declare enum AddItemDirection {
|
|
1228
|
-
/** Add new items to the start of the gallery. */
|
|
1229
|
+
/** Add new project items to the start of the gallery. */
|
|
1229
1230
|
GALLERY_START = "GALLERY_START",
|
|
1230
|
-
/** Add new items to the end of the gallery. */
|
|
1231
|
+
/** Add new project items to the end of the gallery. */
|
|
1231
1232
|
GALLERY_END = "GALLERY_END"
|
|
1232
1233
|
}
|
|
1233
1234
|
declare enum DefaultItemName {
|
|
1234
|
-
/**
|
|
1235
|
+
/** File name assigned as the title. */
|
|
1235
1236
|
FILE_NAME = "FILE_NAME",
|
|
1236
|
-
/**
|
|
1237
|
+
/** No title assigned. */
|
|
1237
1238
|
EMPTY = "EMPTY"
|
|
1238
1239
|
}
|
|
1239
1240
|
interface MediaSettings {
|
|
@@ -1397,6 +1398,10 @@ declare function createPortfolioSettings$1(httpClient: HttpClient): CreatePortfo
|
|
|
1397
1398
|
interface CreatePortfolioSettingsSignature {
|
|
1398
1399
|
/**
|
|
1399
1400
|
* Creates a site's portfolio settings.
|
|
1401
|
+
*
|
|
1402
|
+
* > **Note:**
|
|
1403
|
+
* >
|
|
1404
|
+
* > This method is intended for creating portfolio settings. If settings already exist, the request will return an error. To update existing settings, call [Update Portfolio Settings](https://dev.wix.com/docs/rest/business-solutions/portfolio/portfolio-settings/update-portfolio-settings).
|
|
1400
1405
|
* @param - The portfolio settings to create.
|
|
1401
1406
|
* @returns Newly created portfolio settings.
|
|
1402
1407
|
*/
|
|
@@ -1578,6 +1583,130 @@ interface Link {
|
|
|
1578
1583
|
*/
|
|
1579
1584
|
target?: string | null;
|
|
1580
1585
|
}
|
|
1586
|
+
interface GenerateTokenForProjectItemsRequest {
|
|
1587
|
+
/** Media ids of requested project items */
|
|
1588
|
+
mediaIds?: string[];
|
|
1589
|
+
}
|
|
1590
|
+
interface GenerateTokenForProjectItemsResponse {
|
|
1591
|
+
/** Generated media tokens for project items */
|
|
1592
|
+
mediaTokens?: ProjectItemMediaToken[];
|
|
1593
|
+
}
|
|
1594
|
+
interface ProjectItemMediaToken {
|
|
1595
|
+
/** Media id of project item */
|
|
1596
|
+
mediaId?: string;
|
|
1597
|
+
/** Generated media token for project item */
|
|
1598
|
+
mediaToken?: string;
|
|
1599
|
+
}
|
|
1600
|
+
interface DomainEvent$3 extends DomainEventBodyOneOf$3 {
|
|
1601
|
+
createdEvent?: EntityCreatedEvent$3;
|
|
1602
|
+
updatedEvent?: EntityUpdatedEvent$3;
|
|
1603
|
+
deletedEvent?: EntityDeletedEvent$3;
|
|
1604
|
+
actionEvent?: ActionEvent$3;
|
|
1605
|
+
/**
|
|
1606
|
+
* Unique event ID.
|
|
1607
|
+
* Allows clients to ignore duplicate webhooks.
|
|
1608
|
+
*/
|
|
1609
|
+
_id?: string;
|
|
1610
|
+
/**
|
|
1611
|
+
* Assumes actions are also always typed to an entity_type
|
|
1612
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1613
|
+
*/
|
|
1614
|
+
entityFqdn?: string;
|
|
1615
|
+
/**
|
|
1616
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1617
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1618
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
1619
|
+
*/
|
|
1620
|
+
slug?: string;
|
|
1621
|
+
/** ID of the entity associated with the event. */
|
|
1622
|
+
entityId?: string;
|
|
1623
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1624
|
+
eventTime?: Date | null;
|
|
1625
|
+
/**
|
|
1626
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1627
|
+
* (for example, GDPR).
|
|
1628
|
+
*/
|
|
1629
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1630
|
+
/** If present, indicates the action that triggered the event. */
|
|
1631
|
+
originatedFrom?: string | null;
|
|
1632
|
+
/**
|
|
1633
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
1634
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1635
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1636
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1637
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1638
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1639
|
+
*/
|
|
1640
|
+
entityEventSequence?: string | null;
|
|
1641
|
+
}
|
|
1642
|
+
/** @oneof */
|
|
1643
|
+
interface DomainEventBodyOneOf$3 {
|
|
1644
|
+
createdEvent?: EntityCreatedEvent$3;
|
|
1645
|
+
updatedEvent?: EntityUpdatedEvent$3;
|
|
1646
|
+
deletedEvent?: EntityDeletedEvent$3;
|
|
1647
|
+
actionEvent?: ActionEvent$3;
|
|
1648
|
+
}
|
|
1649
|
+
interface EntityCreatedEvent$3 {
|
|
1650
|
+
entity?: string;
|
|
1651
|
+
}
|
|
1652
|
+
interface RestoreInfo$3 {
|
|
1653
|
+
deletedDate?: Date | null;
|
|
1654
|
+
}
|
|
1655
|
+
interface EntityUpdatedEvent$3 {
|
|
1656
|
+
/**
|
|
1657
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1658
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1659
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1660
|
+
*/
|
|
1661
|
+
currentEntity?: string;
|
|
1662
|
+
}
|
|
1663
|
+
interface EntityDeletedEvent$3 {
|
|
1664
|
+
/** Entity that was deleted */
|
|
1665
|
+
deletedEntity?: string | null;
|
|
1666
|
+
}
|
|
1667
|
+
interface ActionEvent$3 {
|
|
1668
|
+
body?: string;
|
|
1669
|
+
}
|
|
1670
|
+
interface MessageEnvelope$3 {
|
|
1671
|
+
/** App instance ID. */
|
|
1672
|
+
instanceId?: string | null;
|
|
1673
|
+
/** Event type. */
|
|
1674
|
+
eventType?: string;
|
|
1675
|
+
/** The identification type and identity data. */
|
|
1676
|
+
identity?: IdentificationData$3;
|
|
1677
|
+
/** Stringify payload. */
|
|
1678
|
+
data?: string;
|
|
1679
|
+
}
|
|
1680
|
+
interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {
|
|
1681
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
1682
|
+
anonymousVisitorId?: string;
|
|
1683
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
1684
|
+
memberId?: string;
|
|
1685
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1686
|
+
wixUserId?: string;
|
|
1687
|
+
/** ID of an app. */
|
|
1688
|
+
appId?: string;
|
|
1689
|
+
/** @readonly */
|
|
1690
|
+
identityType?: WebhookIdentityType$3;
|
|
1691
|
+
}
|
|
1692
|
+
/** @oneof */
|
|
1693
|
+
interface IdentificationDataIdOneOf$3 {
|
|
1694
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
1695
|
+
anonymousVisitorId?: string;
|
|
1696
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
1697
|
+
memberId?: string;
|
|
1698
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1699
|
+
wixUserId?: string;
|
|
1700
|
+
/** ID of an app. */
|
|
1701
|
+
appId?: string;
|
|
1702
|
+
}
|
|
1703
|
+
declare enum WebhookIdentityType$3 {
|
|
1704
|
+
UNKNOWN = "UNKNOWN",
|
|
1705
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1706
|
+
MEMBER = "MEMBER",
|
|
1707
|
+
WIX_USER = "WIX_USER",
|
|
1708
|
+
APP = "APP"
|
|
1709
|
+
}
|
|
1581
1710
|
interface InvalidateCache$1 extends InvalidateCacheGetByOneOf$1 {
|
|
1582
1711
|
/** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
|
|
1583
1712
|
metaSiteId?: string;
|
|
@@ -1863,76 +1992,6 @@ interface CreateProjectGalleryResponse {
|
|
|
1863
1992
|
/** Id of created gallery */
|
|
1864
1993
|
galleryId?: string;
|
|
1865
1994
|
}
|
|
1866
|
-
interface DomainEvent$3 extends DomainEventBodyOneOf$3 {
|
|
1867
|
-
createdEvent?: EntityCreatedEvent$3;
|
|
1868
|
-
updatedEvent?: EntityUpdatedEvent$3;
|
|
1869
|
-
deletedEvent?: EntityDeletedEvent$3;
|
|
1870
|
-
actionEvent?: ActionEvent$3;
|
|
1871
|
-
/**
|
|
1872
|
-
* Unique event ID.
|
|
1873
|
-
* Allows clients to ignore duplicate webhooks.
|
|
1874
|
-
*/
|
|
1875
|
-
_id?: string;
|
|
1876
|
-
/**
|
|
1877
|
-
* Assumes actions are also always typed to an entity_type
|
|
1878
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1879
|
-
*/
|
|
1880
|
-
entityFqdn?: string;
|
|
1881
|
-
/**
|
|
1882
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1883
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1884
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
1885
|
-
*/
|
|
1886
|
-
slug?: string;
|
|
1887
|
-
/** ID of the entity associated with the event. */
|
|
1888
|
-
entityId?: string;
|
|
1889
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1890
|
-
eventTime?: Date | null;
|
|
1891
|
-
/**
|
|
1892
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
1893
|
-
* (for example, GDPR).
|
|
1894
|
-
*/
|
|
1895
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
1896
|
-
/** If present, indicates the action that triggered the event. */
|
|
1897
|
-
originatedFrom?: string | null;
|
|
1898
|
-
/**
|
|
1899
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
1900
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1901
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1902
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1903
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1904
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1905
|
-
*/
|
|
1906
|
-
entityEventSequence?: string | null;
|
|
1907
|
-
}
|
|
1908
|
-
/** @oneof */
|
|
1909
|
-
interface DomainEventBodyOneOf$3 {
|
|
1910
|
-
createdEvent?: EntityCreatedEvent$3;
|
|
1911
|
-
updatedEvent?: EntityUpdatedEvent$3;
|
|
1912
|
-
deletedEvent?: EntityDeletedEvent$3;
|
|
1913
|
-
actionEvent?: ActionEvent$3;
|
|
1914
|
-
}
|
|
1915
|
-
interface EntityCreatedEvent$3 {
|
|
1916
|
-
entity?: string;
|
|
1917
|
-
}
|
|
1918
|
-
interface RestoreInfo$3 {
|
|
1919
|
-
deletedDate?: Date | null;
|
|
1920
|
-
}
|
|
1921
|
-
interface EntityUpdatedEvent$3 {
|
|
1922
|
-
/**
|
|
1923
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1924
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1925
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1926
|
-
*/
|
|
1927
|
-
currentEntity?: string;
|
|
1928
|
-
}
|
|
1929
|
-
interface EntityDeletedEvent$3 {
|
|
1930
|
-
/** Entity that was deleted */
|
|
1931
|
-
deletedEntity?: string | null;
|
|
1932
|
-
}
|
|
1933
|
-
interface ActionEvent$3 {
|
|
1934
|
-
body?: string;
|
|
1935
|
-
}
|
|
1936
1995
|
interface Empty$2 {
|
|
1937
1996
|
}
|
|
1938
1997
|
interface DeletedProjectRestored$1 {
|
|
@@ -1953,60 +2012,6 @@ interface DuplicateProjectItemsResponse {
|
|
|
1953
2012
|
/** Bulk action metadata. */
|
|
1954
2013
|
bulkActionMetadata?: BulkActionMetadata$1;
|
|
1955
2014
|
}
|
|
1956
|
-
interface MessageEnvelope$3 {
|
|
1957
|
-
/** App instance ID. */
|
|
1958
|
-
instanceId?: string | null;
|
|
1959
|
-
/** Event type. */
|
|
1960
|
-
eventType?: string;
|
|
1961
|
-
/** The identification type and identity data. */
|
|
1962
|
-
identity?: IdentificationData$3;
|
|
1963
|
-
/** Stringify payload. */
|
|
1964
|
-
data?: string;
|
|
1965
|
-
}
|
|
1966
|
-
interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {
|
|
1967
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
1968
|
-
anonymousVisitorId?: string;
|
|
1969
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
1970
|
-
memberId?: string;
|
|
1971
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1972
|
-
wixUserId?: string;
|
|
1973
|
-
/** ID of an app. */
|
|
1974
|
-
appId?: string;
|
|
1975
|
-
/** @readonly */
|
|
1976
|
-
identityType?: WebhookIdentityType$3;
|
|
1977
|
-
}
|
|
1978
|
-
/** @oneof */
|
|
1979
|
-
interface IdentificationDataIdOneOf$3 {
|
|
1980
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
1981
|
-
anonymousVisitorId?: string;
|
|
1982
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
1983
|
-
memberId?: string;
|
|
1984
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1985
|
-
wixUserId?: string;
|
|
1986
|
-
/** ID of an app. */
|
|
1987
|
-
appId?: string;
|
|
1988
|
-
}
|
|
1989
|
-
declare enum WebhookIdentityType$3 {
|
|
1990
|
-
UNKNOWN = "UNKNOWN",
|
|
1991
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1992
|
-
MEMBER = "MEMBER",
|
|
1993
|
-
WIX_USER = "WIX_USER",
|
|
1994
|
-
APP = "APP"
|
|
1995
|
-
}
|
|
1996
|
-
interface GenerateTokenForProjectItemsRequest {
|
|
1997
|
-
/** Media ids of requested project items */
|
|
1998
|
-
mediaIds?: string[];
|
|
1999
|
-
}
|
|
2000
|
-
interface GenerateTokenForProjectItemsResponse {
|
|
2001
|
-
/** Generated media tokens for project items */
|
|
2002
|
-
mediaTokens?: ProjectItemMediaToken[];
|
|
2003
|
-
}
|
|
2004
|
-
interface ProjectItemMediaToken {
|
|
2005
|
-
/** Media id of project item */
|
|
2006
|
-
mediaId?: string;
|
|
2007
|
-
/** Generated media token for project item */
|
|
2008
|
-
mediaToken?: string;
|
|
2009
|
-
}
|
|
2010
2015
|
interface PointNonNullableFields$2 {
|
|
2011
2016
|
x: number;
|
|
2012
2017
|
y: number;
|
|
@@ -675,20 +675,21 @@ interface PortfolioSettings$1 {
|
|
|
675
675
|
updatedDate?: Date | null;
|
|
676
676
|
}
|
|
677
677
|
interface ProjectItemSettings$1 {
|
|
678
|
+
/** The direction in which to add new project items to a gallery. Default: `GALLERY_START` */
|
|
678
679
|
addItemDirection?: AddItemDirection$1;
|
|
679
|
-
/**
|
|
680
|
+
/** Default title assigned to a project item if no title is provided. Default: `FILE_NAME` */
|
|
680
681
|
defaultItemName?: DefaultItemName$1;
|
|
681
682
|
}
|
|
682
683
|
declare enum AddItemDirection$1 {
|
|
683
|
-
/** Add new items to the start of the gallery. */
|
|
684
|
+
/** Add new project items to the start of the gallery. */
|
|
684
685
|
GALLERY_START = "GALLERY_START",
|
|
685
|
-
/** Add new items to the end of the gallery. */
|
|
686
|
+
/** Add new project items to the end of the gallery. */
|
|
686
687
|
GALLERY_END = "GALLERY_END"
|
|
687
688
|
}
|
|
688
689
|
declare enum DefaultItemName$1 {
|
|
689
|
-
/**
|
|
690
|
+
/** File name assigned as the title. */
|
|
690
691
|
FILE_NAME = "FILE_NAME",
|
|
691
|
-
/**
|
|
692
|
+
/** No title assigned. */
|
|
692
693
|
EMPTY = "EMPTY"
|
|
693
694
|
}
|
|
694
695
|
interface MediaSettings$1 {
|
|
@@ -756,20 +757,21 @@ interface PortfolioSettings {
|
|
|
756
757
|
_updatedDate?: Date | null;
|
|
757
758
|
}
|
|
758
759
|
interface ProjectItemSettings {
|
|
760
|
+
/** The direction in which to add new project items to a gallery. Default: `GALLERY_START` */
|
|
759
761
|
addItemDirection?: AddItemDirection;
|
|
760
|
-
/**
|
|
762
|
+
/** Default title assigned to a project item if no title is provided. Default: `FILE_NAME` */
|
|
761
763
|
defaultItemName?: DefaultItemName;
|
|
762
764
|
}
|
|
763
765
|
declare enum AddItemDirection {
|
|
764
|
-
/** Add new items to the start of the gallery. */
|
|
766
|
+
/** Add new project items to the start of the gallery. */
|
|
765
767
|
GALLERY_START = "GALLERY_START",
|
|
766
|
-
/** Add new items to the end of the gallery. */
|
|
768
|
+
/** Add new project items to the end of the gallery. */
|
|
767
769
|
GALLERY_END = "GALLERY_END"
|
|
768
770
|
}
|
|
769
771
|
declare enum DefaultItemName {
|
|
770
|
-
/**
|
|
772
|
+
/** File name assigned as the title. */
|
|
771
773
|
FILE_NAME = "FILE_NAME",
|
|
772
|
-
/**
|
|
774
|
+
/** No title assigned. */
|
|
773
775
|
EMPTY = "EMPTY"
|
|
774
776
|
}
|
|
775
777
|
interface MediaSettings {
|