@epilot/entity-client 3.1.0 → 3.1.3-alpha.0
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/README.md +15 -33
- package/dist/definition.js +1 -1
- package/dist/index.js +5 -1
- package/dist/openapi.d.ts +442 -24
- package/dist/openapi.json +217 -2
- package/dist/schema-model.d.ts +1 -1
- package/package.json +24 -10
package/dist/openapi.json
CHANGED
|
@@ -410,6 +410,16 @@
|
|
|
410
410
|
"schema": {
|
|
411
411
|
"$ref": "#/components/schemas/ActivityId"
|
|
412
412
|
}
|
|
413
|
+
},
|
|
414
|
+
{
|
|
415
|
+
"in": "query",
|
|
416
|
+
"name": "dry_run",
|
|
417
|
+
"description": "Dry Run mode = return matched entities but don't update them.",
|
|
418
|
+
"required": false,
|
|
419
|
+
"schema": {
|
|
420
|
+
"type": "boolean",
|
|
421
|
+
"default": false
|
|
422
|
+
}
|
|
413
423
|
}
|
|
414
424
|
],
|
|
415
425
|
"requestBody": {
|
|
@@ -1330,6 +1340,16 @@
|
|
|
1330
1340
|
}
|
|
1331
1341
|
}
|
|
1332
1342
|
}
|
|
1343
|
+
},
|
|
1344
|
+
"sharing": {
|
|
1345
|
+
"type": "object",
|
|
1346
|
+
"properties": {
|
|
1347
|
+
"show_sharing_button": {
|
|
1348
|
+
"type": "boolean",
|
|
1349
|
+
"description": "Show the sharing button in entity detail view",
|
|
1350
|
+
"example": true
|
|
1351
|
+
}
|
|
1352
|
+
}
|
|
1333
1353
|
}
|
|
1334
1354
|
}
|
|
1335
1355
|
},
|
|
@@ -1354,11 +1374,20 @@
|
|
|
1354
1374
|
"expanded": {
|
|
1355
1375
|
"type": "boolean"
|
|
1356
1376
|
},
|
|
1377
|
+
"render_condition": {
|
|
1378
|
+
"type": "string",
|
|
1379
|
+
"example": "composite_price = \"false\""
|
|
1380
|
+
},
|
|
1357
1381
|
"order": {
|
|
1358
1382
|
"description": "Render order of the group",
|
|
1359
1383
|
"type": "integer",
|
|
1360
1384
|
"default": 0
|
|
1361
1385
|
},
|
|
1386
|
+
"feature_flag": {
|
|
1387
|
+
"type": "string",
|
|
1388
|
+
"example": "FF_MY_FEATURE_FLAG",
|
|
1389
|
+
"description": "This schema should only be active when the feature flag is enabled"
|
|
1390
|
+
},
|
|
1362
1391
|
"info_tooltip_title": {
|
|
1363
1392
|
"type": "object",
|
|
1364
1393
|
"properties": {
|
|
@@ -1481,6 +1510,20 @@
|
|
|
1481
1510
|
},
|
|
1482
1511
|
"updated_at": {
|
|
1483
1512
|
"type": "string"
|
|
1513
|
+
},
|
|
1514
|
+
"comment": {
|
|
1515
|
+
"type": "string"
|
|
1516
|
+
},
|
|
1517
|
+
"source": {
|
|
1518
|
+
"type": "object",
|
|
1519
|
+
"properties": {
|
|
1520
|
+
"id": {
|
|
1521
|
+
"type": "string"
|
|
1522
|
+
},
|
|
1523
|
+
"type": {
|
|
1524
|
+
"type": "string"
|
|
1525
|
+
}
|
|
1526
|
+
}
|
|
1484
1527
|
}
|
|
1485
1528
|
}
|
|
1486
1529
|
},
|
|
@@ -1509,6 +1552,9 @@
|
|
|
1509
1552
|
{
|
|
1510
1553
|
"$ref": "#/components/schemas/SelectAttribute"
|
|
1511
1554
|
},
|
|
1555
|
+
{
|
|
1556
|
+
"$ref": "#/components/schemas/StatusAttribute"
|
|
1557
|
+
},
|
|
1512
1558
|
{
|
|
1513
1559
|
"$ref": "#/components/schemas/RelationAttribute"
|
|
1514
1560
|
},
|
|
@@ -1547,6 +1593,18 @@
|
|
|
1547
1593
|
},
|
|
1548
1594
|
{
|
|
1549
1595
|
"$ref": "#/components/schemas/PartnerStatusAttribute"
|
|
1596
|
+
},
|
|
1597
|
+
{
|
|
1598
|
+
"$ref": "#/components/schemas/PriceComponentsAttribute"
|
|
1599
|
+
},
|
|
1600
|
+
{
|
|
1601
|
+
"$ref": "#/components/schemas/InvitationEmailAttribute"
|
|
1602
|
+
},
|
|
1603
|
+
{
|
|
1604
|
+
"$ref": "#/components/schemas/AutomationAttribute"
|
|
1605
|
+
},
|
|
1606
|
+
{
|
|
1607
|
+
"$ref": "#/components/schemas/InternalUserAttribute"
|
|
1550
1608
|
}
|
|
1551
1609
|
]
|
|
1552
1610
|
},
|
|
@@ -1816,6 +1874,59 @@
|
|
|
1816
1874
|
}
|
|
1817
1875
|
]
|
|
1818
1876
|
}
|
|
1877
|
+
},
|
|
1878
|
+
"allow_any": {
|
|
1879
|
+
"type": "boolean",
|
|
1880
|
+
"description": "Allow arbitrary input values in addition to provided options"
|
|
1881
|
+
}
|
|
1882
|
+
}
|
|
1883
|
+
}
|
|
1884
|
+
]
|
|
1885
|
+
},
|
|
1886
|
+
"StatusAttribute": {
|
|
1887
|
+
"allOf": [
|
|
1888
|
+
{
|
|
1889
|
+
"$ref": "#/components/schemas/BaseAttribute"
|
|
1890
|
+
},
|
|
1891
|
+
{
|
|
1892
|
+
"type": "object",
|
|
1893
|
+
"description": "Status select",
|
|
1894
|
+
"properties": {
|
|
1895
|
+
"type": {
|
|
1896
|
+
"type": "string",
|
|
1897
|
+
"enum": [
|
|
1898
|
+
"select",
|
|
1899
|
+
"radio"
|
|
1900
|
+
]
|
|
1901
|
+
},
|
|
1902
|
+
"options": {
|
|
1903
|
+
"type": "array",
|
|
1904
|
+
"items": {
|
|
1905
|
+
"anyOf": [
|
|
1906
|
+
{
|
|
1907
|
+
"type": "string",
|
|
1908
|
+
"nullable": true
|
|
1909
|
+
},
|
|
1910
|
+
{
|
|
1911
|
+
"type": "object",
|
|
1912
|
+
"properties": {
|
|
1913
|
+
"value": {
|
|
1914
|
+
"type": "string"
|
|
1915
|
+
},
|
|
1916
|
+
"title": {
|
|
1917
|
+
"type": "string"
|
|
1918
|
+
}
|
|
1919
|
+
},
|
|
1920
|
+
"required": [
|
|
1921
|
+
"value"
|
|
1922
|
+
]
|
|
1923
|
+
}
|
|
1924
|
+
]
|
|
1925
|
+
}
|
|
1926
|
+
},
|
|
1927
|
+
"allow_any": {
|
|
1928
|
+
"type": "boolean",
|
|
1929
|
+
"description": "Allow arbitrary input values in addition to provided options"
|
|
1819
1930
|
}
|
|
1820
1931
|
}
|
|
1821
1932
|
}
|
|
@@ -1877,6 +1988,10 @@
|
|
|
1877
1988
|
"currency"
|
|
1878
1989
|
]
|
|
1879
1990
|
},
|
|
1991
|
+
"currency_selector_only": {
|
|
1992
|
+
"type": "boolean",
|
|
1993
|
+
"default": false
|
|
1994
|
+
},
|
|
1880
1995
|
"currency": {
|
|
1881
1996
|
"description": "An array of currency configurations with a country code (ISO-4217)",
|
|
1882
1997
|
"type": "array",
|
|
@@ -2070,6 +2185,63 @@
|
|
|
2070
2185
|
}
|
|
2071
2186
|
]
|
|
2072
2187
|
},
|
|
2188
|
+
"InvitationEmailAttribute": {
|
|
2189
|
+
"allOf": [
|
|
2190
|
+
{
|
|
2191
|
+
"$ref": "#/components/schemas/BaseAttribute"
|
|
2192
|
+
},
|
|
2193
|
+
{
|
|
2194
|
+
"type": "object",
|
|
2195
|
+
"description": "Email address for send invitation",
|
|
2196
|
+
"properties": {
|
|
2197
|
+
"type": {
|
|
2198
|
+
"type": "string",
|
|
2199
|
+
"enum": [
|
|
2200
|
+
"invitation_email"
|
|
2201
|
+
]
|
|
2202
|
+
}
|
|
2203
|
+
}
|
|
2204
|
+
}
|
|
2205
|
+
]
|
|
2206
|
+
},
|
|
2207
|
+
"AutomationAttribute": {
|
|
2208
|
+
"allOf": [
|
|
2209
|
+
{
|
|
2210
|
+
"$ref": "#/components/schemas/BaseAttribute"
|
|
2211
|
+
},
|
|
2212
|
+
{
|
|
2213
|
+
"type": "object",
|
|
2214
|
+
"description": "Automation entity",
|
|
2215
|
+
"properties": {
|
|
2216
|
+
"type": {
|
|
2217
|
+
"type": "string",
|
|
2218
|
+
"enum": [
|
|
2219
|
+
"automation"
|
|
2220
|
+
]
|
|
2221
|
+
}
|
|
2222
|
+
}
|
|
2223
|
+
}
|
|
2224
|
+
]
|
|
2225
|
+
},
|
|
2226
|
+
"InternalUserAttribute": {
|
|
2227
|
+
"allOf": [
|
|
2228
|
+
{
|
|
2229
|
+
"$ref": "#/components/schemas/BaseAttribute"
|
|
2230
|
+
},
|
|
2231
|
+
{
|
|
2232
|
+
"type": "object",
|
|
2233
|
+
"description": "Epilot internal user info",
|
|
2234
|
+
"properties": {
|
|
2235
|
+
"type": {
|
|
2236
|
+
"type": "string",
|
|
2237
|
+
"enum": [
|
|
2238
|
+
"internal_user"
|
|
2239
|
+
]
|
|
2240
|
+
}
|
|
2241
|
+
}
|
|
2242
|
+
}
|
|
2243
|
+
]
|
|
2244
|
+
},
|
|
2073
2245
|
"RepeatableAttribute": {
|
|
2074
2246
|
"allOf": [
|
|
2075
2247
|
{
|
|
@@ -2100,7 +2272,8 @@
|
|
|
2100
2272
|
"email",
|
|
2101
2273
|
"address",
|
|
2102
2274
|
"relation",
|
|
2103
|
-
"payment"
|
|
2275
|
+
"payment",
|
|
2276
|
+
"price_component"
|
|
2104
2277
|
]
|
|
2105
2278
|
},
|
|
2106
2279
|
"enable_relation_picker": {
|
|
@@ -2235,6 +2408,25 @@
|
|
|
2235
2408
|
}
|
|
2236
2409
|
]
|
|
2237
2410
|
},
|
|
2411
|
+
"PriceComponentsAttribute": {
|
|
2412
|
+
"allOf": [
|
|
2413
|
+
{
|
|
2414
|
+
"$ref": "#/components/schemas/BaseAttribute"
|
|
2415
|
+
},
|
|
2416
|
+
{
|
|
2417
|
+
"type": "object",
|
|
2418
|
+
"description": "An attribute that holds a set of price components, used for dynamic pricing",
|
|
2419
|
+
"properties": {
|
|
2420
|
+
"type": {
|
|
2421
|
+
"type": "string",
|
|
2422
|
+
"enum": [
|
|
2423
|
+
"price_components"
|
|
2424
|
+
]
|
|
2425
|
+
}
|
|
2426
|
+
}
|
|
2427
|
+
}
|
|
2428
|
+
]
|
|
2429
|
+
},
|
|
2238
2430
|
"PartnerStatusAttribute": {
|
|
2239
2431
|
"allOf": [
|
|
2240
2432
|
{
|
|
@@ -2325,6 +2517,10 @@
|
|
|
2325
2517
|
"description": "name of the hook to use",
|
|
2326
2518
|
"example": "EntityDetailsV2:Tab"
|
|
2327
2519
|
},
|
|
2520
|
+
"render_condition": {
|
|
2521
|
+
"type": "string",
|
|
2522
|
+
"example": "composite_price = \"false\""
|
|
2523
|
+
},
|
|
2328
2524
|
"order": {
|
|
2329
2525
|
"type": "integer",
|
|
2330
2526
|
"description": "render order (ascending)",
|
|
@@ -3008,6 +3204,20 @@
|
|
|
3008
3204
|
}
|
|
3009
3205
|
}
|
|
3010
3206
|
]
|
|
3207
|
+
},
|
|
3208
|
+
"diff": {
|
|
3209
|
+
"type": "object",
|
|
3210
|
+
"properties": {
|
|
3211
|
+
"added": {
|
|
3212
|
+
"$ref": "#/components/schemas/Entity"
|
|
3213
|
+
},
|
|
3214
|
+
"updated": {
|
|
3215
|
+
"$ref": "#/components/schemas/Entity"
|
|
3216
|
+
},
|
|
3217
|
+
"deleted": {
|
|
3218
|
+
"$ref": "#/components/schemas/Entity"
|
|
3219
|
+
}
|
|
3220
|
+
}
|
|
3011
3221
|
}
|
|
3012
3222
|
},
|
|
3013
3223
|
"required": [
|
|
@@ -3675,5 +3885,10 @@
|
|
|
3675
3885
|
}
|
|
3676
3886
|
}
|
|
3677
3887
|
}
|
|
3678
|
-
}
|
|
3888
|
+
},
|
|
3889
|
+
"servers": [
|
|
3890
|
+
{
|
|
3891
|
+
"url": "https://entity.sls.epilot.io"
|
|
3892
|
+
}
|
|
3893
|
+
]
|
|
3679
3894
|
}
|
package/dist/schema-model.d.ts
CHANGED
|
@@ -7,5 +7,5 @@ export declare enum RelationAffinityMode {
|
|
|
7
7
|
WEAK = "weak",
|
|
8
8
|
STRONG = "strong"
|
|
9
9
|
}
|
|
10
|
-
export declare type Attribute = Components.Schemas.
|
|
10
|
+
export declare type Attribute = Components.Schemas.Attribute;
|
|
11
11
|
export declare type AttributeType = Attribute['type'];
|
package/package.json
CHANGED
|
@@ -1,19 +1,36 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/entity-client",
|
|
3
|
-
"version": "3.1.0",
|
|
3
|
+
"version": "3.1.3-alpha.0",
|
|
4
4
|
"description": "JavaScript client library for the epilot Core Entity API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
|
+
"author": "epilot GmbH",
|
|
8
|
+
"license": "MIT",
|
|
9
|
+
"repsitory": {
|
|
10
|
+
"type": "git",
|
|
11
|
+
"url": "git+https://github.com/epilot-dev/sdk-js.git",
|
|
12
|
+
"directory": "clients/entity-client"
|
|
13
|
+
},
|
|
14
|
+
"bugs": {
|
|
15
|
+
"url": "https://github.com/epilot-dev/sdk-js/issues"
|
|
16
|
+
},
|
|
17
|
+
"homepage": "https://github.com/epilot-dev/sdk-js/tree/main/clients/entity-client#readme",
|
|
18
|
+
"keywords": [
|
|
19
|
+
"epilot",
|
|
20
|
+
"sdk",
|
|
21
|
+
"entity"
|
|
22
|
+
],
|
|
7
23
|
"scripts": {
|
|
8
24
|
"test": "jest",
|
|
9
25
|
"typescript": "tsc",
|
|
10
26
|
"bundle-definition": "webpack",
|
|
11
|
-
"openapi": "
|
|
12
|
-
"typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen
|
|
13
|
-
"build": "
|
|
14
|
-
"
|
|
15
|
-
"prepublishOnly": "npm run build",
|
|
16
|
-
"release-alpha": "npm version prerelease --preid alpha"
|
|
27
|
+
"openapi": "../../scripts/update-openapi.sh https://docs.api.epilot.io/entity.yaml",
|
|
28
|
+
"typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen ./src/openapi.json >> src/openapi.d.ts",
|
|
29
|
+
"build": "tsc && npm run bundle-definition",
|
|
30
|
+
"build:watch": "npm run build && tsc -w",
|
|
31
|
+
"prepublishOnly": "npm run typegen && npm run build",
|
|
32
|
+
"release-alpha": "npm version prerelease --preid alpha",
|
|
33
|
+
"lint": "../../node_modules/eslint/bin/eslint.js src"
|
|
17
34
|
},
|
|
18
35
|
"files": [
|
|
19
36
|
"*.js",
|
|
@@ -28,9 +45,6 @@
|
|
|
28
45
|
"!src/**",
|
|
29
46
|
"!*.config.js"
|
|
30
47
|
],
|
|
31
|
-
"keywords": [],
|
|
32
|
-
"author": "epilot GmbH",
|
|
33
|
-
"license": "UNLICENSED",
|
|
34
48
|
"peerDependencies": {
|
|
35
49
|
"axios": "^0.25.0"
|
|
36
50
|
},
|