@epilot/entity-client 3.0.4 → 3.0.7

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 +121 -42
  3. package/dist/openapi.json +93 -10
  4. package/package-lock.json +18777 -18777
  5. package/package.json +2 -2
package/dist/openapi.d.ts CHANGED
@@ -1023,6 +1023,16 @@ declare namespace Components {
1023
1023
  * Contacts
1024
1024
  */
1025
1025
  plural: string;
1026
+ /**
1027
+ * example:
1028
+ * false
1029
+ */
1030
+ published?: boolean;
1031
+ /**
1032
+ * example:
1033
+ * false
1034
+ */
1035
+ draft?: boolean;
1026
1036
  /**
1027
1037
  * example:
1028
1038
  * person
@@ -1150,6 +1160,13 @@ declare namespace Components {
1150
1160
  */
1151
1161
  export interface EntitySchemaItem {
1152
1162
  id?: /* Generated uuid for schema */ SchemaId /* uuid */;
1163
+ created_at?: string;
1164
+ updated_at?: string;
1165
+ comment?: string;
1166
+ source?: {
1167
+ id?: string;
1168
+ type?: string;
1169
+ };
1153
1170
  slug: /**
1154
1171
  * URL-friendly identifier for the entity schema
1155
1172
  * example:
@@ -1179,6 +1196,16 @@ declare namespace Components {
1179
1196
  * Contacts
1180
1197
  */
1181
1198
  plural: string;
1199
+ /**
1200
+ * example:
1201
+ * false
1202
+ */
1203
+ published?: boolean;
1204
+ /**
1205
+ * example:
1206
+ * false
1207
+ */
1208
+ draft?: boolean;
1182
1209
  /**
1183
1210
  * example:
1184
1211
  * person
@@ -2293,6 +2320,10 @@ declare namespace Components {
2293
2320
  value: string;
2294
2321
  title?: string;
2295
2322
  })[];
2323
+ /**
2324
+ * Allow arbitrary input values in addition to provided options
2325
+ */
2326
+ allow_any?: boolean;
2296
2327
  }
2297
2328
  /**
2298
2329
  * Summary Fields are displayed inside list view as a resume of the relation entity.
@@ -2660,6 +2691,27 @@ declare namespace Paths {
2660
2691
  Components.Schemas.EntityItem;
2661
2692
  }
2662
2693
  }
2694
+ namespace CreateNewSchemaVersion {
2695
+ namespace Parameters {
2696
+ export type Draft = boolean;
2697
+ export type Slug = /**
2698
+ * URL-friendly identifier for the entity schema
2699
+ * example:
2700
+ * contact
2701
+ */
2702
+ Components.Schemas.EntitySlug;
2703
+ }
2704
+ export interface PathParameters {
2705
+ slug: Parameters.Slug;
2706
+ }
2707
+ export interface QueryParameters {
2708
+ draft?: Parameters.Draft;
2709
+ }
2710
+ export type RequestBody = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchema;
2711
+ namespace Responses {
2712
+ export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
2713
+ }
2714
+ }
2663
2715
  namespace DeleteEntity {
2664
2716
  namespace Parameters {
2665
2717
  export type ActivityId = /**
@@ -2711,9 +2763,9 @@ declare namespace Paths {
2711
2763
  }
2712
2764
  }
2713
2765
  }
2714
- namespace DeleteSchema {
2766
+ namespace DeleteSchemaById {
2715
2767
  namespace Parameters {
2716
- export type Id = string;
2768
+ export type Id = /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
2717
2769
  export type Slug = /**
2718
2770
  * URL-friendly identifier for the entity schema
2719
2771
  * example:
@@ -2725,7 +2777,7 @@ declare namespace Paths {
2725
2777
  slug: Parameters.Slug;
2726
2778
  }
2727
2779
  export interface QueryParameters {
2728
- id?: Parameters.Id;
2780
+ id: Parameters.Id;
2729
2781
  }
2730
2782
  namespace Responses {
2731
2783
  export interface $204 {
@@ -2870,7 +2922,7 @@ declare namespace Paths {
2870
2922
  }
2871
2923
  namespace GetSchema {
2872
2924
  namespace Parameters {
2873
- export type Id = string;
2925
+ export type Id = /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
2874
2926
  export type Slug = /**
2875
2927
  * URL-friendly identifier for the entity schema
2876
2928
  * example:
@@ -2902,36 +2954,29 @@ declare namespace Paths {
2902
2954
  }
2903
2955
  namespace Responses {
2904
2956
  export interface $200 {
2905
- results?: /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem[];
2957
+ versions?: /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem[];
2958
+ drafts?: /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem[];
2906
2959
  }
2907
2960
  }
2908
2961
  }
2909
- namespace ListSchemas {
2962
+ namespace ListSchemaBlueprints {
2910
2963
  namespace Responses {
2911
2964
  export interface $200 {
2912
2965
  results?: /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem[];
2913
2966
  }
2914
2967
  }
2915
2968
  }
2916
- namespace PutSchema {
2969
+ namespace ListSchemas {
2917
2970
  namespace Parameters {
2918
- export type Draft = boolean;
2919
- export type Slug = /**
2920
- * URL-friendly identifier for the entity schema
2921
- * example:
2922
- * contact
2923
- */
2924
- Components.Schemas.EntitySlug;
2925
- }
2926
- export interface PathParameters {
2927
- slug: Parameters.Slug;
2971
+ export type Unpublished = boolean;
2928
2972
  }
2929
2973
  export interface QueryParameters {
2930
- draft?: Parameters.Draft;
2974
+ unpublished?: Parameters.Unpublished;
2931
2975
  }
2932
- export type RequestBody = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchema;
2933
2976
  namespace Responses {
2934
- export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
2977
+ export interface $200 {
2978
+ results?: /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem[];
2979
+ }
2935
2980
  }
2936
2981
  }
2937
2982
  namespace SearchEntities {
@@ -3078,16 +3123,28 @@ declare namespace Paths {
3078
3123
  export interface OperationMethods {
3079
3124
  /**
3080
3125
  * listSchemas - listSchemas
3126
+ *
3127
+ * Get the latest version of local schema
3081
3128
  */
3082
3129
  'listSchemas'(
3083
- parameters?: Parameters<UnknownParamsObject> | null,
3130
+ parameters?: Parameters<Paths.ListSchemas.QueryParameters> | null,
3084
3131
  data?: any,
3085
3132
  config?: AxiosRequestConfig
3086
3133
  ): OperationResponse<Paths.ListSchemas.Responses.$200>
3134
+ /**
3135
+ * listSchemaBlueprints - listSchemaBlueprints
3136
+ *
3137
+ * List canonical versions of all available schemas
3138
+ */
3139
+ 'listSchemaBlueprints'(
3140
+ parameters?: Parameters<UnknownParamsObject> | null,
3141
+ data?: any,
3142
+ config?: AxiosRequestConfig
3143
+ ): OperationResponse<Paths.ListSchemaBlueprints.Responses.$200>
3087
3144
  /**
3088
3145
  * getSchemaVersions - getSchemaVersions
3089
3146
  *
3090
- * Get all versions of this schema
3147
+ * Get all versions of this schema ordered by the latest versions including drafts.
3091
3148
  */
3092
3149
  'getSchemaVersions'(
3093
3150
  parameters?: Parameters<Paths.GetSchemaVersions.PathParameters> | null,
@@ -3096,6 +3153,8 @@ export interface OperationMethods {
3096
3153
  ): OperationResponse<Paths.GetSchemaVersions.Responses.$200>
3097
3154
  /**
3098
3155
  * getSchema - getSchema
3156
+ *
3157
+ * By default gets the latest version of the Schema and to get the specific version of schema pass the id.
3099
3158
  */
3100
3159
  'getSchema'(
3101
3160
  parameters?: Parameters<Paths.GetSchema.PathParameters & Paths.GetSchema.QueryParameters> | null,
@@ -3103,23 +3162,25 @@ export interface OperationMethods {
3103
3162
  config?: AxiosRequestConfig
3104
3163
  ): OperationResponse<Paths.GetSchema.Responses.$200>
3105
3164
  /**
3106
- * putSchema - putSchema
3165
+ * createNewSchemaVersion - createNewSchemaVersion
3107
3166
  *
3108
- * Create new version of the schema
3167
+ * Create new version of the schema and default draft is false.
3109
3168
  */
3110
- 'putSchema'(
3111
- parameters?: Parameters<Paths.PutSchema.PathParameters & Paths.PutSchema.QueryParameters> | null,
3112
- data?: Paths.PutSchema.RequestBody,
3169
+ 'createNewSchemaVersion'(
3170
+ parameters?: Parameters<Paths.CreateNewSchemaVersion.PathParameters & Paths.CreateNewSchemaVersion.QueryParameters> | null,
3171
+ data?: Paths.CreateNewSchemaVersion.RequestBody,
3113
3172
  config?: AxiosRequestConfig
3114
- ): OperationResponse<Paths.PutSchema.Responses.$200>
3173
+ ): OperationResponse<Paths.CreateNewSchemaVersion.Responses.$200>
3115
3174
  /**
3116
- * deleteSchema - deleteSchema
3175
+ * deleteSchemaById - deleteSchemaById
3176
+ *
3177
+ * Delete schema by Id
3117
3178
  */
3118
- 'deleteSchema'(
3119
- parameters?: Parameters<Paths.DeleteSchema.PathParameters & Paths.DeleteSchema.QueryParameters> | null,
3179
+ 'deleteSchemaById'(
3180
+ parameters?: Parameters<Paths.DeleteSchemaById.PathParameters & Paths.DeleteSchemaById.QueryParameters> | null,
3120
3181
  data?: any,
3121
3182
  config?: AxiosRequestConfig
3122
- ): OperationResponse<Paths.DeleteSchema.Responses.$204>
3183
+ ): OperationResponse<Paths.DeleteSchemaById.Responses.$204>
3123
3184
  /**
3124
3185
  * searchEntities - searchEntities
3125
3186
  *
@@ -3434,18 +3495,32 @@ export interface PathsDictionary {
3434
3495
  ['/v1/entity/schemas']: {
3435
3496
  /**
3436
3497
  * listSchemas - listSchemas
3498
+ *
3499
+ * Get the latest version of local schema
3437
3500
  */
3438
3501
  'get'(
3439
- parameters?: Parameters<UnknownParamsObject> | null,
3502
+ parameters?: Parameters<Paths.ListSchemas.QueryParameters> | null,
3440
3503
  data?: any,
3441
3504
  config?: AxiosRequestConfig
3442
3505
  ): OperationResponse<Paths.ListSchemas.Responses.$200>
3443
3506
  }
3507
+ ['/v1/entity/schemas/blueprints']: {
3508
+ /**
3509
+ * listSchemaBlueprints - listSchemaBlueprints
3510
+ *
3511
+ * List canonical versions of all available schemas
3512
+ */
3513
+ 'get'(
3514
+ parameters?: Parameters<UnknownParamsObject> | null,
3515
+ data?: any,
3516
+ config?: AxiosRequestConfig
3517
+ ): OperationResponse<Paths.ListSchemaBlueprints.Responses.$200>
3518
+ }
3444
3519
  ['/v1/entity/schemas/{slug}/versions']: {
3445
3520
  /**
3446
3521
  * getSchemaVersions - getSchemaVersions
3447
3522
  *
3448
- * Get all versions of this schema
3523
+ * Get all versions of this schema ordered by the latest versions including drafts.
3449
3524
  */
3450
3525
  'get'(
3451
3526
  parameters?: Parameters<Paths.GetSchemaVersions.PathParameters> | null,
@@ -3456,6 +3531,8 @@ export interface PathsDictionary {
3456
3531
  ['/v1/entity/schemas/{slug}']: {
3457
3532
  /**
3458
3533
  * getSchema - getSchema
3534
+ *
3535
+ * By default gets the latest version of the Schema and to get the specific version of schema pass the id.
3459
3536
  */
3460
3537
  'get'(
3461
3538
  parameters?: Parameters<Paths.GetSchema.PathParameters & Paths.GetSchema.QueryParameters> | null,
@@ -3463,23 +3540,25 @@ export interface PathsDictionary {
3463
3540
  config?: AxiosRequestConfig
3464
3541
  ): OperationResponse<Paths.GetSchema.Responses.$200>
3465
3542
  /**
3466
- * putSchema - putSchema
3543
+ * createNewSchemaVersion - createNewSchemaVersion
3467
3544
  *
3468
- * Create new version of the schema
3545
+ * Create new version of the schema and default draft is false.
3469
3546
  */
3470
3547
  'put'(
3471
- parameters?: Parameters<Paths.PutSchema.PathParameters & Paths.PutSchema.QueryParameters> | null,
3472
- data?: Paths.PutSchema.RequestBody,
3548
+ parameters?: Parameters<Paths.CreateNewSchemaVersion.PathParameters & Paths.CreateNewSchemaVersion.QueryParameters> | null,
3549
+ data?: Paths.CreateNewSchemaVersion.RequestBody,
3473
3550
  config?: AxiosRequestConfig
3474
- ): OperationResponse<Paths.PutSchema.Responses.$200>
3551
+ ): OperationResponse<Paths.CreateNewSchemaVersion.Responses.$200>
3475
3552
  /**
3476
- * deleteSchema - deleteSchema
3553
+ * deleteSchemaById - deleteSchemaById
3554
+ *
3555
+ * Delete schema by Id
3477
3556
  */
3478
3557
  'delete'(
3479
- parameters?: Parameters<Paths.DeleteSchema.PathParameters & Paths.DeleteSchema.QueryParameters> | null,
3558
+ parameters?: Parameters<Paths.DeleteSchemaById.PathParameters & Paths.DeleteSchemaById.QueryParameters> | null,
3480
3559
  data?: any,
3481
3560
  config?: AxiosRequestConfig
3482
- ): OperationResponse<Paths.DeleteSchema.Responses.$204>
3561
+ ): OperationResponse<Paths.DeleteSchemaById.Responses.$204>
3483
3562
  }
3484
3563
  ['/v1/entity:search']: {
3485
3564
  /**
package/dist/openapi.json CHANGED
@@ -32,6 +32,48 @@
32
32
  "get": {
33
33
  "operationId": "listSchemas",
34
34
  "summary": "listSchemas",
35
+ "description": "Get the latest version of local schema",
36
+ "parameters": [
37
+ {
38
+ "in": "query",
39
+ "name": "unpublished",
40
+ "description": "Includes the unpublished version of unpublished schema",
41
+ "schema": {
42
+ "type": "boolean",
43
+ "default": false
44
+ }
45
+ }
46
+ ],
47
+ "tags": [
48
+ "Schemas"
49
+ ],
50
+ "responses": {
51
+ "200": {
52
+ "description": "Success",
53
+ "content": {
54
+ "application/json": {
55
+ "schema": {
56
+ "type": "object",
57
+ "properties": {
58
+ "results": {
59
+ "type": "array",
60
+ "items": {
61
+ "$ref": "#/components/schemas/EntitySchemaItem"
62
+ }
63
+ }
64
+ }
65
+ }
66
+ }
67
+ }
68
+ }
69
+ }
70
+ }
71
+ },
72
+ "/v1/entity/schemas/blueprints": {
73
+ "get": {
74
+ "operationId": "listSchemaBlueprints",
75
+ "summary": "listSchemaBlueprints",
76
+ "description": "List canonical versions of all available schemas",
35
77
  "tags": [
36
78
  "Schemas"
37
79
  ],
@@ -61,7 +103,7 @@
61
103
  "get": {
62
104
  "operationId": "getSchemaVersions",
63
105
  "summary": "getSchemaVersions",
64
- "description": "Get all versions of this schema",
106
+ "description": "Get all versions of this schema ordered by the latest versions including drafts.",
65
107
  "tags": [
66
108
  "Schemas"
67
109
  ],
@@ -83,7 +125,13 @@
83
125
  "schema": {
84
126
  "type": "object",
85
127
  "properties": {
86
- "results": {
128
+ "versions": {
129
+ "type": "array",
130
+ "items": {
131
+ "$ref": "#/components/schemas/EntitySchemaItem"
132
+ }
133
+ },
134
+ "drafts": {
87
135
  "type": "array",
88
136
  "items": {
89
137
  "$ref": "#/components/schemas/EntitySchemaItem"
@@ -101,6 +149,7 @@
101
149
  "get": {
102
150
  "operationId": "getSchema",
103
151
  "summary": "getSchema",
152
+ "description": "By default gets the latest version of the Schema and to get the specific version of schema pass the id.",
104
153
  "tags": [
105
154
  "Schemas"
106
155
  ],
@@ -117,7 +166,7 @@
117
166
  "in": "query",
118
167
  "name": "id",
119
168
  "schema": {
120
- "type": "string"
169
+ "$ref": "#/components/schemas/SchemaId"
121
170
  }
122
171
  }
123
172
  ],
@@ -135,9 +184,9 @@
135
184
  }
136
185
  },
137
186
  "put": {
138
- "operationId": "putSchema",
139
- "summary": "putSchema",
140
- "description": "Create new version of the schema",
187
+ "operationId": "createNewSchemaVersion",
188
+ "summary": "createNewSchemaVersion",
189
+ "description": "Create new version of the schema and default draft is false.",
141
190
  "tags": [
142
191
  "Schemas"
143
192
  ],
@@ -182,8 +231,9 @@
182
231
  }
183
232
  },
184
233
  "delete": {
185
- "operationId": "deleteSchema",
186
- "summary": "deleteSchema",
234
+ "operationId": "deleteSchemaById",
235
+ "summary": "deleteSchemaById",
236
+ "description": "Delete schema by Id",
187
237
  "tags": [
188
238
  "Schemas"
189
239
  ],
@@ -199,8 +249,9 @@
199
249
  {
200
250
  "in": "query",
201
251
  "name": "id",
252
+ "required": true,
202
253
  "schema": {
203
- "type": "string"
254
+ "$ref": "#/components/schemas/SchemaId"
204
255
  }
205
256
  }
206
257
  ],
@@ -238,7 +289,7 @@
238
289
  }
239
290
  },
240
291
  "text/csv": {
241
- "schemas": {
292
+ "schema": {
242
293
  "type": "string"
243
294
  }
244
295
  }
@@ -1238,6 +1289,14 @@
1238
1289
  "type": "string",
1239
1290
  "example": "Contacts"
1240
1291
  },
1292
+ "published": {
1293
+ "type": "boolean",
1294
+ "example": false
1295
+ },
1296
+ "draft": {
1297
+ "type": "boolean",
1298
+ "example": false
1299
+ },
1241
1300
  "icon": {
1242
1301
  "type": "string",
1243
1302
  "example": "person"
@@ -1416,6 +1475,26 @@
1416
1475
  "properties": {
1417
1476
  "id": {
1418
1477
  "$ref": "#/components/schemas/SchemaId"
1478
+ },
1479
+ "created_at": {
1480
+ "type": "string"
1481
+ },
1482
+ "updated_at": {
1483
+ "type": "string"
1484
+ },
1485
+ "comment": {
1486
+ "type": "string"
1487
+ },
1488
+ "source": {
1489
+ "type": "object",
1490
+ "properties": {
1491
+ "id": {
1492
+ "type": "string"
1493
+ },
1494
+ "type": {
1495
+ "type": "string"
1496
+ }
1497
+ }
1419
1498
  }
1420
1499
  }
1421
1500
  },
@@ -1751,6 +1830,10 @@
1751
1830
  }
1752
1831
  ]
1753
1832
  }
1833
+ },
1834
+ "allow_any": {
1835
+ "type": "boolean",
1836
+ "description": "Allow arbitrary input values in addition to provided options"
1754
1837
  }
1755
1838
  }
1756
1839
  }