@epilot/entity-client 3.1.0 → 3.1.1
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/openapi.d.ts +364 -24
- package/dist/openapi.json +165 -2
- 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
|
},
|
|
@@ -1547,6 +1590,18 @@
|
|
|
1547
1590
|
},
|
|
1548
1591
|
{
|
|
1549
1592
|
"$ref": "#/components/schemas/PartnerStatusAttribute"
|
|
1593
|
+
},
|
|
1594
|
+
{
|
|
1595
|
+
"$ref": "#/components/schemas/PriceComponentsAttribute"
|
|
1596
|
+
},
|
|
1597
|
+
{
|
|
1598
|
+
"$ref": "#/components/schemas/InvitationEmailAttribute"
|
|
1599
|
+
},
|
|
1600
|
+
{
|
|
1601
|
+
"$ref": "#/components/schemas/AutomationAttribute"
|
|
1602
|
+
},
|
|
1603
|
+
{
|
|
1604
|
+
"$ref": "#/components/schemas/InternalUserAttribute"
|
|
1550
1605
|
}
|
|
1551
1606
|
]
|
|
1552
1607
|
},
|
|
@@ -1816,6 +1871,10 @@
|
|
|
1816
1871
|
}
|
|
1817
1872
|
]
|
|
1818
1873
|
}
|
|
1874
|
+
},
|
|
1875
|
+
"allow_any": {
|
|
1876
|
+
"type": "boolean",
|
|
1877
|
+
"description": "Allow arbitrary input values in addition to provided options"
|
|
1819
1878
|
}
|
|
1820
1879
|
}
|
|
1821
1880
|
}
|
|
@@ -1877,6 +1936,10 @@
|
|
|
1877
1936
|
"currency"
|
|
1878
1937
|
]
|
|
1879
1938
|
},
|
|
1939
|
+
"currency_selector_only": {
|
|
1940
|
+
"type": "boolean",
|
|
1941
|
+
"default": false
|
|
1942
|
+
},
|
|
1880
1943
|
"currency": {
|
|
1881
1944
|
"description": "An array of currency configurations with a country code (ISO-4217)",
|
|
1882
1945
|
"type": "array",
|
|
@@ -2070,6 +2133,63 @@
|
|
|
2070
2133
|
}
|
|
2071
2134
|
]
|
|
2072
2135
|
},
|
|
2136
|
+
"InvitationEmailAttribute": {
|
|
2137
|
+
"allOf": [
|
|
2138
|
+
{
|
|
2139
|
+
"$ref": "#/components/schemas/BaseAttribute"
|
|
2140
|
+
},
|
|
2141
|
+
{
|
|
2142
|
+
"type": "object",
|
|
2143
|
+
"description": "Email address for send invitation",
|
|
2144
|
+
"properties": {
|
|
2145
|
+
"type": {
|
|
2146
|
+
"type": "string",
|
|
2147
|
+
"enum": [
|
|
2148
|
+
"invitation_email"
|
|
2149
|
+
]
|
|
2150
|
+
}
|
|
2151
|
+
}
|
|
2152
|
+
}
|
|
2153
|
+
]
|
|
2154
|
+
},
|
|
2155
|
+
"AutomationAttribute": {
|
|
2156
|
+
"allOf": [
|
|
2157
|
+
{
|
|
2158
|
+
"$ref": "#/components/schemas/BaseAttribute"
|
|
2159
|
+
},
|
|
2160
|
+
{
|
|
2161
|
+
"type": "object",
|
|
2162
|
+
"description": "Automation entity",
|
|
2163
|
+
"properties": {
|
|
2164
|
+
"type": {
|
|
2165
|
+
"type": "string",
|
|
2166
|
+
"enum": [
|
|
2167
|
+
"automation"
|
|
2168
|
+
]
|
|
2169
|
+
}
|
|
2170
|
+
}
|
|
2171
|
+
}
|
|
2172
|
+
]
|
|
2173
|
+
},
|
|
2174
|
+
"InternalUserAttribute": {
|
|
2175
|
+
"allOf": [
|
|
2176
|
+
{
|
|
2177
|
+
"$ref": "#/components/schemas/BaseAttribute"
|
|
2178
|
+
},
|
|
2179
|
+
{
|
|
2180
|
+
"type": "object",
|
|
2181
|
+
"description": "Epilot internal user info",
|
|
2182
|
+
"properties": {
|
|
2183
|
+
"type": {
|
|
2184
|
+
"type": "string",
|
|
2185
|
+
"enum": [
|
|
2186
|
+
"internal_user"
|
|
2187
|
+
]
|
|
2188
|
+
}
|
|
2189
|
+
}
|
|
2190
|
+
}
|
|
2191
|
+
]
|
|
2192
|
+
},
|
|
2073
2193
|
"RepeatableAttribute": {
|
|
2074
2194
|
"allOf": [
|
|
2075
2195
|
{
|
|
@@ -2100,7 +2220,8 @@
|
|
|
2100
2220
|
"email",
|
|
2101
2221
|
"address",
|
|
2102
2222
|
"relation",
|
|
2103
|
-
"payment"
|
|
2223
|
+
"payment",
|
|
2224
|
+
"price_component"
|
|
2104
2225
|
]
|
|
2105
2226
|
},
|
|
2106
2227
|
"enable_relation_picker": {
|
|
@@ -2235,6 +2356,25 @@
|
|
|
2235
2356
|
}
|
|
2236
2357
|
]
|
|
2237
2358
|
},
|
|
2359
|
+
"PriceComponentsAttribute": {
|
|
2360
|
+
"allOf": [
|
|
2361
|
+
{
|
|
2362
|
+
"$ref": "#/components/schemas/BaseAttribute"
|
|
2363
|
+
},
|
|
2364
|
+
{
|
|
2365
|
+
"type": "object",
|
|
2366
|
+
"description": "An attribute that holds a set of price components, used for dynamic pricing",
|
|
2367
|
+
"properties": {
|
|
2368
|
+
"type": {
|
|
2369
|
+
"type": "string",
|
|
2370
|
+
"enum": [
|
|
2371
|
+
"price_components"
|
|
2372
|
+
]
|
|
2373
|
+
}
|
|
2374
|
+
}
|
|
2375
|
+
}
|
|
2376
|
+
]
|
|
2377
|
+
},
|
|
2238
2378
|
"PartnerStatusAttribute": {
|
|
2239
2379
|
"allOf": [
|
|
2240
2380
|
{
|
|
@@ -2325,6 +2465,10 @@
|
|
|
2325
2465
|
"description": "name of the hook to use",
|
|
2326
2466
|
"example": "EntityDetailsV2:Tab"
|
|
2327
2467
|
},
|
|
2468
|
+
"render_condition": {
|
|
2469
|
+
"type": "string",
|
|
2470
|
+
"example": "composite_price = \"false\""
|
|
2471
|
+
},
|
|
2328
2472
|
"order": {
|
|
2329
2473
|
"type": "integer",
|
|
2330
2474
|
"description": "render order (ascending)",
|
|
@@ -3008,6 +3152,20 @@
|
|
|
3008
3152
|
}
|
|
3009
3153
|
}
|
|
3010
3154
|
]
|
|
3155
|
+
},
|
|
3156
|
+
"diff": {
|
|
3157
|
+
"type": "object",
|
|
3158
|
+
"properties": {
|
|
3159
|
+
"added": {
|
|
3160
|
+
"$ref": "#/components/schemas/Entity"
|
|
3161
|
+
},
|
|
3162
|
+
"updated": {
|
|
3163
|
+
"$ref": "#/components/schemas/Entity"
|
|
3164
|
+
},
|
|
3165
|
+
"deleted": {
|
|
3166
|
+
"$ref": "#/components/schemas/Entity"
|
|
3167
|
+
}
|
|
3168
|
+
}
|
|
3011
3169
|
}
|
|
3012
3170
|
},
|
|
3013
3171
|
"required": [
|
|
@@ -3675,5 +3833,10 @@
|
|
|
3675
3833
|
}
|
|
3676
3834
|
}
|
|
3677
3835
|
}
|
|
3678
|
-
}
|
|
3836
|
+
},
|
|
3837
|
+
"servers": [
|
|
3838
|
+
{
|
|
3839
|
+
"url": "https://entity.sls.epilot.io"
|
|
3840
|
+
}
|
|
3841
|
+
]
|
|
3679
3842
|
}
|
package/package.json
CHANGED
|
@@ -1,19 +1,36 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/entity-client",
|
|
3
|
-
"version": "3.1.
|
|
3
|
+
"version": "3.1.1",
|
|
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
|
},
|