@epilot/entity-client 3.0.4 → 3.0.5

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.
Files changed (5) hide show
  1. package/dist/definition.js +1 -1
  2. package/dist/openapi.d.ts +55 -82
  3. package/dist/openapi.json +37 -7
  4. package/package.json +1 -1
  5. package/package-lock.json +0 -18779
package/dist/openapi.d.ts CHANGED
@@ -201,10 +201,7 @@ declare namespace Components {
201
201
  * Setting to `true` disables editing the attribute on the entity builder UI
202
202
  */
203
203
  entity_builder_disable_edit?: boolean;
204
- /**
205
- * Setting to `true` prevents the attribute from being modified / deleted
206
- */
207
- protected?: boolean;
204
+ deletable?: boolean;
208
205
  type?: "relation_address";
209
206
  has_primary?: boolean;
210
207
  }
@@ -279,10 +276,7 @@ declare namespace Components {
279
276
  * Setting to `true` disables editing the attribute on the entity builder UI
280
277
  */
281
278
  entity_builder_disable_edit?: boolean;
282
- /**
283
- * Setting to `true` prevents the attribute from being modified / deleted
284
- */
285
- protected?: boolean;
279
+ deletable?: boolean;
286
280
  }
287
281
  /**
288
282
  * example:
@@ -386,10 +380,7 @@ declare namespace Components {
386
380
  * Setting to `true` disables editing the attribute on the entity builder UI
387
381
  */
388
382
  entity_builder_disable_edit?: boolean;
389
- /**
390
- * Setting to `true` prevents the attribute from being modified / deleted
391
- */
392
- protected?: boolean;
383
+ deletable?: boolean;
393
384
  type?: "boolean";
394
385
  }
395
386
  /**
@@ -456,10 +447,7 @@ declare namespace Components {
456
447
  * Setting to `true` disables editing the attribute on the entity builder UI
457
448
  */
458
449
  entity_builder_disable_edit?: boolean;
459
- /**
460
- * Setting to `true` prevents the attribute from being modified / deleted
461
- */
462
- protected?: boolean;
450
+ deletable?: boolean;
463
451
  type?: "computed";
464
452
  }
465
453
  /**
@@ -526,10 +514,7 @@ declare namespace Components {
526
514
  * Setting to `true` disables editing the attribute on the entity builder UI
527
515
  */
528
516
  entity_builder_disable_edit?: boolean;
529
- /**
530
- * Setting to `true` prevents the attribute from being modified / deleted
531
- */
532
- protected?: boolean;
517
+ deletable?: boolean;
533
518
  type: "consent";
534
519
  topic: string;
535
520
  identifiers?: string[];
@@ -598,10 +583,7 @@ declare namespace Components {
598
583
  * Setting to `true` disables editing the attribute on the entity builder UI
599
584
  */
600
585
  entity_builder_disable_edit?: boolean;
601
- /**
602
- * Setting to `true` prevents the attribute from being modified / deleted
603
- */
604
- protected?: boolean;
586
+ deletable?: boolean;
605
587
  type?: "country";
606
588
  }
607
589
  /**
@@ -668,10 +650,7 @@ declare namespace Components {
668
650
  * Setting to `true` disables editing the attribute on the entity builder UI
669
651
  */
670
652
  entity_builder_disable_edit?: boolean;
671
- /**
672
- * Setting to `true` prevents the attribute from being modified / deleted
673
- */
674
- protected?: boolean;
653
+ deletable?: boolean;
675
654
  type: "currency";
676
655
  /**
677
656
  * An array of currency configurations with a country code (ISO-4217)
@@ -747,10 +726,7 @@ declare namespace Components {
747
726
  * Setting to `true` disables editing the attribute on the entity builder UI
748
727
  */
749
728
  entity_builder_disable_edit?: boolean;
750
- /**
751
- * Setting to `true` prevents the attribute from being modified / deleted
752
- */
753
- protected?: boolean;
729
+ deletable?: boolean;
754
730
  type?: "date" | "datetime";
755
731
  }
756
732
  export interface Entity {
@@ -1450,10 +1426,7 @@ declare namespace Components {
1450
1426
  * Setting to `true` disables editing the attribute on the entity builder UI
1451
1427
  */
1452
1428
  entity_builder_disable_edit?: boolean;
1453
- /**
1454
- * Setting to `true` prevents the attribute from being modified / deleted
1455
- */
1456
- protected?: boolean;
1429
+ deletable?: boolean;
1457
1430
  type: "image" | "file";
1458
1431
  multiple?: boolean;
1459
1432
  /**
@@ -1686,10 +1659,7 @@ declare namespace Components {
1686
1659
  * Setting to `true` disables editing the attribute on the entity builder UI
1687
1660
  */
1688
1661
  entity_builder_disable_edit?: boolean;
1689
- /**
1690
- * Setting to `true` prevents the attribute from being modified / deleted
1691
- */
1692
- protected?: boolean;
1662
+ deletable?: boolean;
1693
1663
  type?: "internal";
1694
1664
  }
1695
1665
  /**
@@ -1756,10 +1726,7 @@ declare namespace Components {
1756
1726
  * Setting to `true` disables editing the attribute on the entity builder UI
1757
1727
  */
1758
1728
  entity_builder_disable_edit?: boolean;
1759
- /**
1760
- * Setting to `true` prevents the attribute from being modified / deleted
1761
- */
1762
- protected?: boolean;
1729
+ deletable?: boolean;
1763
1730
  type?: "link";
1764
1731
  }
1765
1732
  /**
@@ -1826,10 +1793,7 @@ declare namespace Components {
1826
1793
  * Setting to `true` disables editing the attribute on the entity builder UI
1827
1794
  */
1828
1795
  entity_builder_disable_edit?: boolean;
1829
- /**
1830
- * Setting to `true` prevents the attribute from being modified / deleted
1831
- */
1832
- protected?: boolean;
1796
+ deletable?: boolean;
1833
1797
  type?: "number";
1834
1798
  format?: string;
1835
1799
  }
@@ -1897,10 +1861,7 @@ declare namespace Components {
1897
1861
  * Setting to `true` disables editing the attribute on the entity builder UI
1898
1862
  */
1899
1863
  entity_builder_disable_edit?: boolean;
1900
- /**
1901
- * Setting to `true` prevents the attribute from being modified / deleted
1902
- */
1903
- protected?: boolean;
1864
+ deletable?: boolean;
1904
1865
  type?: "ordered_list";
1905
1866
  }
1906
1867
  /**
@@ -1967,10 +1928,7 @@ declare namespace Components {
1967
1928
  * Setting to `true` disables editing the attribute on the entity builder UI
1968
1929
  */
1969
1930
  entity_builder_disable_edit?: boolean;
1970
- /**
1971
- * Setting to `true` prevents the attribute from being modified / deleted
1972
- */
1973
- protected?: boolean;
1931
+ deletable?: boolean;
1974
1932
  type?: "partner_status";
1975
1933
  }
1976
1934
  /**
@@ -2052,12 +2010,9 @@ declare namespace Components {
2052
2010
  * Setting to `true` disables editing the attribute on the entity builder UI
2053
2011
  */
2054
2012
  entity_builder_disable_edit?: boolean;
2055
- /**
2056
- * Setting to `true` prevents the attribute from being modified / deleted
2057
- */
2058
- protected?: boolean;
2013
+ deletable?: boolean;
2059
2014
  type?: "relation";
2060
- relation_type?: "has_many" | "has_one";
2015
+ relation_type?: "belongs_to" | "has_many";
2061
2016
  delete_mode?: "cascade";
2062
2017
  relation_affinity_mode?: "weak" | "strong";
2063
2018
  /**
@@ -2183,14 +2138,11 @@ declare namespace Components {
2183
2138
  * Setting to `true` disables editing the attribute on the entity builder UI
2184
2139
  */
2185
2140
  entity_builder_disable_edit?: boolean;
2186
- /**
2187
- * Setting to `true` prevents the attribute from being modified / deleted
2188
- */
2189
- protected?: boolean;
2141
+ deletable?: boolean;
2190
2142
  repeatable?: boolean;
2191
2143
  has_primary?: boolean;
2192
2144
  relation_affinity_mode?: "weak" | "strong";
2193
- type?: "string" | "phone" | "email" | "address" | "relation" | "payment";
2145
+ type?: "string" | "phone" | "email" | "address" | "relation";
2194
2146
  /**
2195
2147
  * when enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link.
2196
2148
  */
@@ -2284,10 +2236,7 @@ declare namespace Components {
2284
2236
  * Setting to `true` disables editing the attribute on the entity builder UI
2285
2237
  */
2286
2238
  entity_builder_disable_edit?: boolean;
2287
- /**
2288
- * Setting to `true` prevents the attribute from being modified / deleted
2289
- */
2290
- protected?: boolean;
2239
+ deletable?: boolean;
2291
2240
  type?: "select" | "radio";
2292
2241
  options?: ((string | null) | {
2293
2242
  value: string;
@@ -2371,10 +2320,7 @@ declare namespace Components {
2371
2320
  * Setting to `true` disables editing the attribute on the entity builder UI
2372
2321
  */
2373
2322
  entity_builder_disable_edit?: boolean;
2374
- /**
2375
- * Setting to `true` prevents the attribute from being modified / deleted
2376
- */
2377
- protected?: boolean;
2323
+ deletable?: boolean;
2378
2324
  type?: "tags";
2379
2325
  options?: string[];
2380
2326
  suggestions?: string[];
@@ -2443,10 +2389,7 @@ declare namespace Components {
2443
2389
  * Setting to `true` disables editing the attribute on the entity builder UI
2444
2390
  */
2445
2391
  entity_builder_disable_edit?: boolean;
2446
- /**
2447
- * Setting to `true` prevents the attribute from being modified / deleted
2448
- */
2449
- protected?: boolean;
2392
+ deletable?: boolean;
2450
2393
  type?: "string";
2451
2394
  multiline?: boolean;
2452
2395
  }
@@ -2514,10 +2457,7 @@ declare namespace Components {
2514
2457
  * Setting to `true` disables editing the attribute on the entity builder UI
2515
2458
  */
2516
2459
  entity_builder_disable_edit?: boolean;
2517
- /**
2518
- * Setting to `true` prevents the attribute from being modified / deleted
2519
- */
2520
- protected?: boolean;
2460
+ deletable?: boolean;
2521
2461
  type?: "relation_user";
2522
2462
  multiple?: boolean;
2523
2463
  }
@@ -2906,6 +2846,13 @@ declare namespace Paths {
2906
2846
  }
2907
2847
  }
2908
2848
  }
2849
+ namespace ListSchemaBlueprints {
2850
+ namespace Responses {
2851
+ export interface $200 {
2852
+ results?: /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem[];
2853
+ }
2854
+ }
2855
+ }
2909
2856
  namespace ListSchemas {
2910
2857
  namespace Responses {
2911
2858
  export interface $200 {
@@ -3078,12 +3025,24 @@ declare namespace Paths {
3078
3025
  export interface OperationMethods {
3079
3026
  /**
3080
3027
  * listSchemas - listSchemas
3028
+ *
3029
+ * List local versions of all available schemas
3081
3030
  */
3082
3031
  'listSchemas'(
3083
3032
  parameters?: Parameters<UnknownParamsObject> | null,
3084
3033
  data?: any,
3085
3034
  config?: AxiosRequestConfig
3086
3035
  ): OperationResponse<Paths.ListSchemas.Responses.$200>
3036
+ /**
3037
+ * listSchemaBlueprints - listSchemaBlueprints
3038
+ *
3039
+ * List canonical versions of all available schemas
3040
+ */
3041
+ 'listSchemaBlueprints'(
3042
+ parameters?: Parameters<UnknownParamsObject> | null,
3043
+ data?: any,
3044
+ config?: AxiosRequestConfig
3045
+ ): OperationResponse<Paths.ListSchemaBlueprints.Responses.$200>
3087
3046
  /**
3088
3047
  * getSchemaVersions - getSchemaVersions
3089
3048
  *
@@ -3434,6 +3393,8 @@ export interface PathsDictionary {
3434
3393
  ['/v1/entity/schemas']: {
3435
3394
  /**
3436
3395
  * listSchemas - listSchemas
3396
+ *
3397
+ * List local versions of all available schemas
3437
3398
  */
3438
3399
  'get'(
3439
3400
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -3441,6 +3402,18 @@ export interface PathsDictionary {
3441
3402
  config?: AxiosRequestConfig
3442
3403
  ): OperationResponse<Paths.ListSchemas.Responses.$200>
3443
3404
  }
3405
+ ['/v1/entity/schemas/blueprints']: {
3406
+ /**
3407
+ * listSchemaBlueprints - listSchemaBlueprints
3408
+ *
3409
+ * List canonical versions of all available schemas
3410
+ */
3411
+ 'get'(
3412
+ parameters?: Parameters<UnknownParamsObject> | null,
3413
+ data?: any,
3414
+ config?: AxiosRequestConfig
3415
+ ): OperationResponse<Paths.ListSchemaBlueprints.Responses.$200>
3416
+ }
3444
3417
  ['/v1/entity/schemas/{slug}/versions']: {
3445
3418
  /**
3446
3419
  * getSchemaVersions - getSchemaVersions
package/dist/openapi.json CHANGED
@@ -32,6 +32,37 @@
32
32
  "get": {
33
33
  "operationId": "listSchemas",
34
34
  "summary": "listSchemas",
35
+ "description": "List local versions of all available schemas",
36
+ "tags": [
37
+ "Schemas"
38
+ ],
39
+ "responses": {
40
+ "200": {
41
+ "description": "Success",
42
+ "content": {
43
+ "application/json": {
44
+ "schema": {
45
+ "type": "object",
46
+ "properties": {
47
+ "results": {
48
+ "type": "array",
49
+ "items": {
50
+ "$ref": "#/components/schemas/EntitySchemaItem"
51
+ }
52
+ }
53
+ }
54
+ }
55
+ }
56
+ }
57
+ }
58
+ }
59
+ }
60
+ },
61
+ "/v1/entity/schemas/blueprints": {
62
+ "get": {
63
+ "operationId": "listSchemaBlueprints",
64
+ "summary": "listSchemaBlueprints",
65
+ "description": "List canonical versions of all available schemas",
35
66
  "tags": [
36
67
  "Schemas"
37
68
  ],
@@ -1582,8 +1613,7 @@
1582
1613
  "type": "boolean",
1583
1614
  "default": false
1584
1615
  },
1585
- "protected": {
1586
- "description": "Setting to `true` prevents the attribute from being modified / deleted",
1616
+ "deletable": {
1587
1617
  "type": "boolean",
1588
1618
  "default": true
1589
1619
  }
@@ -1792,7 +1822,8 @@
1792
1822
  }
1793
1823
  },
1794
1824
  "required": [
1795
- "type"
1825
+ "type",
1826
+ "attachments"
1796
1827
  ]
1797
1828
  }
1798
1829
  ]
@@ -1889,8 +1920,8 @@
1889
1920
  "relation_type": {
1890
1921
  "type": "string",
1891
1922
  "enum": [
1892
- "has_many",
1893
- "has_one"
1923
+ "belongs_to",
1924
+ "has_many"
1894
1925
  ]
1895
1926
  },
1896
1927
  "delete_mode": {
@@ -2034,8 +2065,7 @@
2034
2065
  "phone",
2035
2066
  "email",
2036
2067
  "address",
2037
- "relation",
2038
- "payment"
2068
+ "relation"
2039
2069
  ]
2040
2070
  },
2041
2071
  "enable_relation_picker": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/entity-client",
3
- "version": "3.0.4",
3
+ "version": "3.0.5",
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",