@epilot/entity-client 3.0.11 → 3.0.12

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 (22) hide show
  1. package/README.md +15 -34
  2. package/dist/definition.js +1 -1
  3. package/dist/index.d.ts +2 -0
  4. package/dist/index.js +4 -5
  5. package/dist/openapi.d.ts +93 -23
  6. package/dist/openapi.json +28 -1
  7. package/package.json +23 -9
  8. package/.gitignore +0 -3
  9. package/dist/client.js.map +0 -1
  10. package/dist/definition.js.map +0 -1
  11. package/dist/index.js.map +0 -1
  12. package/dist/schema-model.js.map +0 -1
  13. package/jest.config.ts +0 -13
  14. package/package-lock.json +0 -18779
  15. package/src/client.test.ts +0 -19
  16. package/src/client.ts +0 -21
  17. package/src/definition.ts +0 -5
  18. package/src/index.ts +0 -4
  19. package/src/openapi.d.ts +0 -3944
  20. package/src/openapi.json +0 -3739
  21. package/src/schema-model.ts +0 -30
  22. package/webpack.config.js +0 -28
package/src/openapi.json DELETED
@@ -1,3739 +0,0 @@
1
- {
2
- "openapi": "3.0.2",
3
- "info": {
4
- "title": "Entity API",
5
- "version": "1.0.0",
6
- "description": "Flexible data layer for epilot Entities.\n\nUse this API configure and access your business objects like Contacts, Opportunities and Products.\n\n[Feature Documentation](https://docs.epilot.io/docs/entities/flexible-entities)\n"
7
- },
8
- "tags": [
9
- {
10
- "name": "Schemas",
11
- "description": "Model Entities"
12
- },
13
- {
14
- "name": "Entities",
15
- "description": "CRUD Access for Entities"
16
- },
17
- {
18
- "name": "Activity",
19
- "description": "Entity Events"
20
- }
21
- ],
22
- "security": [
23
- {
24
- "EpilotAuth": []
25
- },
26
- {
27
- "EpilotOrg": []
28
- }
29
- ],
30
- "paths": {
31
- "/v1/entity/schemas": {
32
- "get": {
33
- "operationId": "listSchemas",
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",
77
- "tags": [
78
- "Schemas"
79
- ],
80
- "responses": {
81
- "200": {
82
- "description": "Success",
83
- "content": {
84
- "application/json": {
85
- "schema": {
86
- "type": "object",
87
- "properties": {
88
- "results": {
89
- "type": "array",
90
- "items": {
91
- "$ref": "#/components/schemas/EntitySchemaItem"
92
- }
93
- }
94
- }
95
- }
96
- }
97
- }
98
- }
99
- }
100
- }
101
- },
102
- "/v1/entity/schemas/{slug}/versions": {
103
- "get": {
104
- "operationId": "getSchemaVersions",
105
- "summary": "getSchemaVersions",
106
- "description": "Get all versions of this schema ordered by the latest versions including drafts.",
107
- "tags": [
108
- "Schemas"
109
- ],
110
- "parameters": [
111
- {
112
- "in": "path",
113
- "name": "slug",
114
- "required": true,
115
- "schema": {
116
- "$ref": "#/components/schemas/EntitySlug"
117
- }
118
- }
119
- ],
120
- "responses": {
121
- "200": {
122
- "description": "Success",
123
- "content": {
124
- "application/json": {
125
- "schema": {
126
- "type": "object",
127
- "properties": {
128
- "versions": {
129
- "type": "array",
130
- "items": {
131
- "$ref": "#/components/schemas/EntitySchemaItem"
132
- }
133
- },
134
- "drafts": {
135
- "type": "array",
136
- "items": {
137
- "$ref": "#/components/schemas/EntitySchemaItem"
138
- }
139
- }
140
- }
141
- }
142
- }
143
- }
144
- }
145
- }
146
- }
147
- },
148
- "/v1/entity/schemas/{slug}": {
149
- "get": {
150
- "operationId": "getSchema",
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.",
153
- "tags": [
154
- "Schemas"
155
- ],
156
- "parameters": [
157
- {
158
- "in": "path",
159
- "name": "slug",
160
- "required": true,
161
- "schema": {
162
- "$ref": "#/components/schemas/EntitySlug"
163
- }
164
- },
165
- {
166
- "in": "query",
167
- "name": "id",
168
- "schema": {
169
- "$ref": "#/components/schemas/SchemaId"
170
- }
171
- }
172
- ],
173
- "responses": {
174
- "200": {
175
- "description": "Success",
176
- "content": {
177
- "application/json": {
178
- "schema": {
179
- "$ref": "#/components/schemas/EntitySchemaItem"
180
- }
181
- }
182
- }
183
- }
184
- }
185
- },
186
- "put": {
187
- "operationId": "createNewSchemaVersion",
188
- "summary": "createNewSchemaVersion",
189
- "description": "Create new version of the schema and default draft is false.",
190
- "tags": [
191
- "Schemas"
192
- ],
193
- "parameters": [
194
- {
195
- "in": "path",
196
- "name": "slug",
197
- "required": true,
198
- "schema": {
199
- "$ref": "#/components/schemas/EntitySlug"
200
- }
201
- },
202
- {
203
- "in": "query",
204
- "name": "draft",
205
- "schema": {
206
- "default": false,
207
- "type": "boolean"
208
- }
209
- }
210
- ],
211
- "requestBody": {
212
- "content": {
213
- "application/json": {
214
- "schema": {
215
- "$ref": "#/components/schemas/EntitySchema"
216
- }
217
- }
218
- }
219
- },
220
- "responses": {
221
- "200": {
222
- "description": "Success",
223
- "content": {
224
- "application/json": {
225
- "schema": {
226
- "$ref": "#/components/schemas/EntitySchemaItem"
227
- }
228
- }
229
- }
230
- }
231
- }
232
- },
233
- "delete": {
234
- "operationId": "deleteSchemaById",
235
- "summary": "deleteSchemaById",
236
- "description": "Delete schema by Id",
237
- "tags": [
238
- "Schemas"
239
- ],
240
- "parameters": [
241
- {
242
- "in": "path",
243
- "name": "slug",
244
- "required": true,
245
- "schema": {
246
- "$ref": "#/components/schemas/EntitySlug"
247
- }
248
- },
249
- {
250
- "in": "query",
251
- "name": "id",
252
- "required": true,
253
- "schema": {
254
- "$ref": "#/components/schemas/SchemaId"
255
- }
256
- }
257
- ],
258
- "responses": {
259
- "204": {
260
- "description": "Success"
261
- }
262
- }
263
- }
264
- },
265
- "/v1/entity:search": {
266
- "post": {
267
- "operationId": "searchEntities",
268
- "summary": "searchEntities",
269
- "description": "Search for entities. Supports ordering and pagination. Lucene query syntax supported for complex querying.\n\nPassing comma-separated `x-epilot-org-id` is supported for cross-org entity search.\n\n## Relations\n\nWhen `hydrate=true`, relation attributes are replaced in-place with nested entity values.\n\nExample:\n```json\n{\n \"_id\": \"123\",\n \"name\": \"parent\",\n \"_tags\": [\"parent\"],\n \"contacts\": {\n \"$relation\": [\n { \"entity_id\": \"456\", \"_tags\": [\"primary\"] },\n { \"entity_id\": \"789\", \"_tags\": [\"secondary\"] },\n ]\n }\n}\n```\n\nBecomes:\n```json\n{\n \"_id\": \"123\",\n \"name\": \"parent\",\n \"_tags\": [\"parent\"],\n \"contacts\": [\n {\n \"$relation\": { \"entity_id\": \"456\", \"_tags\": [\"primary\"] },\n \"_id\": \"456\",\n \"name\": \"child 1\",\n \"_tags\": [\"child\"]\n },\n {\n \"$relation\": { \"entity_id\": \"789\", \"_tags\": [\"secondary\"] },\n \"_id\": \"789\",\n \"name\": \"child 2\",\n \"_tags\": [\"child\"]\n }\n ]\n}\n```\n",
270
- "tags": [
271
- "Entities"
272
- ],
273
- "requestBody": {
274
- "content": {
275
- "application/json": {
276
- "schema": {
277
- "$ref": "#/components/schemas/EntitySearchParams"
278
- }
279
- }
280
- }
281
- },
282
- "responses": {
283
- "200": {
284
- "description": "Success",
285
- "content": {
286
- "application/json": {
287
- "schema": {
288
- "$ref": "#/components/schemas/EntitySearchResults"
289
- }
290
- },
291
- "text/csv": {
292
- "schema": {
293
- "type": "string"
294
- }
295
- }
296
- }
297
- }
298
- }
299
- }
300
- },
301
- "/v1/entity/{slug}": {
302
- "post": {
303
- "operationId": "createEntity",
304
- "summary": "createEntity",
305
- "description": "Creates a new entity using a key.\n\n## Activity\n\nIf no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityCreated`\n\n## Relations\n\nTo create a relation, store a property object that defines a `$relation` array.\n\nExample:\n\n```json\n{\n \"contacts\": {\n \"$relation\": [\n { \"entity_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\" }\n ]\n }\n}\n```\n\nThe items in `$relation` support two properties:\n- `entity_id` - The ID of the entity to link\n- `_tags` - Tags or labels for the relation (optional)\n",
306
- "tags": [
307
- "Entities"
308
- ],
309
- "parameters": [
310
- {
311
- "in": "path",
312
- "name": "slug",
313
- "description": "Entity Schema",
314
- "required": true,
315
- "schema": {
316
- "$ref": "#/components/schemas/EntitySlug"
317
- }
318
- },
319
- {
320
- "in": "query",
321
- "name": "activity_id",
322
- "description": "Activity to include in event feed",
323
- "required": false,
324
- "schema": {
325
- "$ref": "#/components/schemas/ActivityId"
326
- }
327
- }
328
- ],
329
- "requestBody": {
330
- "content": {
331
- "application/json": {
332
- "schema": {
333
- "$ref": "#/components/schemas/Entity"
334
- },
335
- "examples": {
336
- "contact": {
337
- "$ref": "#/components/examples/ContactEntity"
338
- },
339
- "account": {
340
- "$ref": "#/components/examples/AccountEntity"
341
- },
342
- "product": {
343
- "$ref": "#/components/examples/ProductEntity"
344
- },
345
- "price": {
346
- "$ref": "#/components/examples/PriceEntity"
347
- },
348
- "tax": {
349
- "$ref": "#/components/examples/TaxEntity"
350
- },
351
- "order": {
352
- "$ref": "#/components/examples/OrderEntity"
353
- },
354
- "opportunity": {
355
- "$ref": "#/components/examples/OpportunityEntity"
356
- },
357
- "email template": {
358
- "$ref": "#/components/examples/EmailTemplateEntity"
359
- },
360
- "file": {
361
- "$ref": "#/components/examples/FileEntity"
362
- },
363
- "workflow step": {
364
- "$ref": "#/components/examples/WorkflowStepEntity"
365
- },
366
- "submission": {
367
- "$ref": "#/components/examples/SubmissionEntity"
368
- }
369
- }
370
- }
371
- }
372
- },
373
- "responses": {
374
- "201": {
375
- "description": "Success",
376
- "content": {
377
- "application/json": {
378
- "schema": {
379
- "$ref": "#/components/schemas/EntityItem"
380
- }
381
- }
382
- }
383
- }
384
- }
385
- }
386
- },
387
- "/v1/entity/{slug}:upsert": {
388
- "patch": {
389
- "operationId": "upsertEntity",
390
- "summary": "upsertEntity",
391
- "description": "Create or update an entity using `unique_key`\n\n- If no entities are matched, a new entity is created.\n- If exactly one entity is matched, a `PATCH`-style update is applied to the existing entity.\n- If more than one entity is matched a `409` Error is returned\n\n## Activity\n\nIf no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityCreated` or `EntityUpdated`\n",
392
- "tags": [
393
- "Entities"
394
- ],
395
- "parameters": [
396
- {
397
- "in": "path",
398
- "name": "slug",
399
- "description": "Entity Schema",
400
- "required": true,
401
- "schema": {
402
- "$ref": "#/components/schemas/EntitySlug"
403
- }
404
- },
405
- {
406
- "in": "query",
407
- "name": "activity_id",
408
- "description": "Activity to include in event feed",
409
- "required": false,
410
- "schema": {
411
- "$ref": "#/components/schemas/ActivityId"
412
- }
413
- }
414
- ],
415
- "requestBody": {
416
- "content": {
417
- "application/json": {
418
- "schema": {
419
- "type": "object",
420
- "properties": {
421
- "unique_key": {
422
- "type": "array",
423
- "items": {
424
- "type": "string",
425
- "example": "email.0.email"
426
- },
427
- "example": [
428
- "_id"
429
- ]
430
- },
431
- "entity": {
432
- "$ref": "#/components/schemas/Entity"
433
- }
434
- },
435
- "required": [
436
- "unique_key",
437
- "entity"
438
- ]
439
- }
440
- }
441
- }
442
- },
443
- "responses": {
444
- "200": {
445
- "description": "Entity was updated",
446
- "content": {
447
- "application/json": {
448
- "schema": {
449
- "$ref": "#/components/schemas/EntityItem"
450
- }
451
- }
452
- }
453
- },
454
- "201": {
455
- "description": "Entity was created",
456
- "content": {
457
- "application/json": {
458
- "schema": {
459
- "$ref": "#/components/schemas/EntityItem"
460
- }
461
- }
462
- }
463
- },
464
- "409": {
465
- "description": "Conflict: multiple entities were matched with `unique_key`"
466
- }
467
- }
468
- }
469
- },
470
- "/v1/entity/{slug}/{id}": {
471
- "get": {
472
- "operationId": "getEntity",
473
- "summary": "getEntity",
474
- "description": "Gets Entity and relations by id.\n\n## Relations\n\nWhen `hydrate=true`, relation attributes are replaced in-place with nested entity values.\n\nExample:\n```json\n{\n \"_id\": \"123\",\n \"name\": \"parent\",\n \"_tags\": [\"parent\"],\n \"contacts\": {\n \"$relation\": [\n { \"entity_id\": \"456\", \"_tags\": [\"primary\"] },\n { \"entity_id\": \"789\", \"_tags\": [\"secondary\"] },\n ]\n }\n}\n```\n\nBecomes:\n```json\n{\n \"_id\": \"123\",\n \"name\": \"parent\",\n \"_tags\": [\"parent\"],\n \"contacts\": [\n {\n \"$relation\": { \"entity_id\": \"456\", \"_tags\": [\"primary\"] },\n \"_id\": \"456\",\n \"name\": \"child 1\",\n \"_tags\": [\"child\"]\n },\n {\n \"$relation\": { \"entity_id\": \"789\", \"_tags\": [\"secondary\"] },\n \"_id\": \"789\",\n \"name\": \"child 2\",\n \"_tags\": [\"child\"]\n }\n ]\n}\n```\n",
475
- "tags": [
476
- "Entities"
477
- ],
478
- "parameters": [
479
- {
480
- "in": "path",
481
- "name": "slug",
482
- "description": "Entity Type",
483
- "required": true,
484
- "schema": {
485
- "$ref": "#/components/schemas/EntitySlug"
486
- }
487
- },
488
- {
489
- "in": "path",
490
- "name": "id",
491
- "description": "Entity id",
492
- "required": true,
493
- "schema": {
494
- "$ref": "#/components/schemas/EntityId"
495
- }
496
- },
497
- {
498
- "in": "query",
499
- "name": "hydrate",
500
- "description": "When true, enables entity hydration to resolve nested $relation references in-place.",
501
- "schema": {
502
- "default": false,
503
- "type": "boolean"
504
- }
505
- }
506
- ],
507
- "responses": {
508
- "200": {
509
- "description": "Success",
510
- "content": {
511
- "application/json": {
512
- "schema": {
513
- "type": "object",
514
- "properties": {
515
- "entity": {
516
- "$ref": "#/components/schemas/EntityItem"
517
- },
518
- "relations": {
519
- "type": "array",
520
- "items": {
521
- "$ref": "#/components/schemas/EntityItem"
522
- }
523
- }
524
- }
525
- }
526
- }
527
- }
528
- }
529
- }
530
- },
531
- "put": {
532
- "operationId": "updateEntity",
533
- "summary": "updateEntity",
534
- "description": "Updates an Entity\n\n## Activity\n\nIf no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityUpdated`\n\n## Relations\n\nTo create a relation, store a property that defines a `$relation` array.\n\nExample:\n\n```json\n{\n \"contacts\": {\n \"$relation\": [\n { \"entity_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\" }\n ]\n }\n}\n```\n\nThe items in `$relation` support two properties:\n- `entity_id` - The ID of the entity to link\n- `_tags` - Tags or labels for the relation (optional)\n",
535
- "tags": [
536
- "Entities"
537
- ],
538
- "parameters": [
539
- {
540
- "in": "path",
541
- "name": "slug",
542
- "description": "Entity Type",
543
- "required": true,
544
- "schema": {
545
- "$ref": "#/components/schemas/EntitySlug"
546
- }
547
- },
548
- {
549
- "in": "path",
550
- "name": "id",
551
- "description": "Entity id",
552
- "required": true,
553
- "schema": {
554
- "$ref": "#/components/schemas/EntityId"
555
- }
556
- },
557
- {
558
- "in": "query",
559
- "name": "activity_id",
560
- "description": "Activity to include in event feed",
561
- "required": false,
562
- "schema": {
563
- "$ref": "#/components/schemas/ActivityId"
564
- }
565
- }
566
- ],
567
- "requestBody": {
568
- "content": {
569
- "application/json": {
570
- "schema": {
571
- "$ref": "#/components/schemas/Entity"
572
- },
573
- "example": {}
574
- }
575
- }
576
- },
577
- "responses": {
578
- "200": {
579
- "description": "Success",
580
- "content": {
581
- "application/json": {
582
- "schema": {
583
- "$ref": "#/components/schemas/EntityItem"
584
- }
585
- }
586
- }
587
- }
588
- }
589
- },
590
- "delete": {
591
- "operationId": "deleteEntity",
592
- "summary": "deleteEntity",
593
- "description": "Deletes an Entity\n\n## Activity\n\nIf no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityDeleted`\n",
594
- "tags": [
595
- "Entities"
596
- ],
597
- "parameters": [
598
- {
599
- "in": "path",
600
- "name": "slug",
601
- "description": "Entity Type",
602
- "required": true,
603
- "schema": {
604
- "$ref": "#/components/schemas/EntitySlug"
605
- }
606
- },
607
- {
608
- "in": "path",
609
- "name": "id",
610
- "required": true,
611
- "schema": {
612
- "$ref": "#/components/schemas/EntityId"
613
- }
614
- },
615
- {
616
- "in": "query",
617
- "name": "activity_id",
618
- "description": "Activity to include in event feed",
619
- "required": false,
620
- "schema": {
621
- "$ref": "#/components/schemas/ActivityId"
622
- }
623
- }
624
- ],
625
- "responses": {
626
- "200": {
627
- "description": "Success"
628
- }
629
- }
630
- }
631
- },
632
- "/v1/entity:autocomplete": {
633
- "get": {
634
- "operationId": "autocomplete",
635
- "summary": "autocomplete",
636
- "description": "Autocomplete entity attributes\n",
637
- "tags": [
638
- "Entities"
639
- ],
640
- "parameters": [
641
- {
642
- "name": "input",
643
- "in": "query",
644
- "description": "Input to autocomplete",
645
- "schema": {
646
- "type": "string"
647
- }
648
- },
649
- {
650
- "name": "attribute",
651
- "in": "query",
652
- "description": "Autocomplete attribute",
653
- "schema": {
654
- "type": "string",
655
- "example": "_tags"
656
- },
657
- "required": true
658
- },
659
- {
660
- "name": "slug",
661
- "in": "query",
662
- "description": "Limit results to entity schema",
663
- "schema": {
664
- "$ref": "#/components/schemas/EntitySlug"
665
- }
666
- },
667
- {
668
- "name": "size",
669
- "in": "query",
670
- "description": "Maximum number of results to return",
671
- "schema": {
672
- "type": "integer",
673
- "default": 10,
674
- "minimum": 1,
675
- "maximum": 250
676
- }
677
- }
678
- ],
679
- "responses": {
680
- "200": {
681
- "description": "Success",
682
- "content": {
683
- "application/json": {
684
- "schema": {
685
- "type": "object",
686
- "properties": {
687
- "hits": {
688
- "type": "number",
689
- "example": 1
690
- },
691
- "results": {
692
- "type": "array",
693
- "items": {
694
- "anyOf": [
695
- {
696
- "type": "string"
697
- },
698
- {
699
- "type": "boolean"
700
- },
701
- {
702
- "type": "object",
703
- "additionalProperties": true
704
- }
705
- ]
706
- },
707
- "example": [
708
- "value"
709
- ]
710
- }
711
- }
712
- }
713
- }
714
- }
715
- }
716
- }
717
- }
718
- },
719
- "/v1/entity/activity": {
720
- "post": {
721
- "operationId": "createActivity",
722
- "summary": "createActivity",
723
- "description": "Create an activity that can be displayed in activity feeds.\n\n- All activites are published as events on the event bus\n- Entity mutations are always part of an activity\n",
724
- "tags": [
725
- "Activity"
726
- ],
727
- "parameters": [
728
- {
729
- "in": "query",
730
- "name": "entities",
731
- "description": "Comma-separated list of entities which the activity primarily concerns",
732
- "style": "form",
733
- "explode": false,
734
- "schema": {
735
- "type": "array",
736
- "items": {
737
- "$ref": "#/components/schemas/EntityId"
738
- }
739
- }
740
- }
741
- ],
742
- "requestBody": {
743
- "content": {
744
- "application/json": {
745
- "schema": {
746
- "$ref": "#/components/schemas/Activity"
747
- }
748
- }
749
- }
750
- },
751
- "responses": {
752
- "200": {
753
- "description": "Success",
754
- "content": {
755
- "application/json": {
756
- "schema": {
757
- "$ref": "#/components/schemas/ActivityItem"
758
- }
759
- }
760
- }
761
- }
762
- }
763
- }
764
- },
765
- "/v1/entity/activity/{id}": {
766
- "get": {
767
- "operationId": "getActivity",
768
- "summary": "getActivity",
769
- "description": "Get activity by id",
770
- "tags": [
771
- "Activity"
772
- ],
773
- "parameters": [
774
- {
775
- "in": "path",
776
- "name": "id",
777
- "description": "Activity Id",
778
- "required": true,
779
- "schema": {
780
- "$ref": "#/components/schemas/ActivityId"
781
- }
782
- }
783
- ],
784
- "responses": {
785
- "200": {
786
- "description": "Success",
787
- "content": {
788
- "application/json": {
789
- "schema": {
790
- "$ref": "#/components/schemas/ActivityItem"
791
- }
792
- }
793
- }
794
- }
795
- }
796
- }
797
- },
798
- "/v1/entity/activity/{id}:attach": {
799
- "post": {
800
- "operationId": "attachActivity",
801
- "summary": "attachActivity",
802
- "description": "Attach existing activity to entity activity feeds",
803
- "tags": [
804
- "Activity"
805
- ],
806
- "parameters": [
807
- {
808
- "in": "path",
809
- "name": "id",
810
- "description": "Activity Id",
811
- "required": true,
812
- "schema": {
813
- "$ref": "#/components/schemas/ActivityId"
814
- }
815
- },
816
- {
817
- "in": "query",
818
- "name": "entities",
819
- "description": "Comma-separated list of entities which the activity primarily concerns",
820
- "style": "form",
821
- "explode": false,
822
- "schema": {
823
- "type": "array",
824
- "items": {
825
- "$ref": "#/components/schemas/EntityId"
826
- }
827
- }
828
- }
829
- ],
830
- "responses": {
831
- "200": {
832
- "description": "Success",
833
- "content": {
834
- "application/json": {
835
- "schema": {
836
- "$ref": "#/components/schemas/ActivityItem"
837
- }
838
- }
839
- }
840
- }
841
- }
842
- }
843
- },
844
- "/v1/entity/{slug}/{id}/activity": {
845
- "get": {
846
- "operationId": "getEntityActivityFeed",
847
- "summary": "getEntityActivityFeed",
848
- "description": "Get activity feed for an entity\n",
849
- "tags": [
850
- "Activity"
851
- ],
852
- "parameters": [
853
- {
854
- "in": "path",
855
- "name": "slug",
856
- "description": "Entity Type",
857
- "required": true,
858
- "schema": {
859
- "$ref": "#/components/schemas/EntitySlug"
860
- }
861
- },
862
- {
863
- "in": "path",
864
- "name": "id",
865
- "description": "Entity id",
866
- "required": true,
867
- "schema": {
868
- "$ref": "#/components/schemas/EntityId"
869
- }
870
- },
871
- {
872
- "in": "query",
873
- "name": "after",
874
- "description": "Get activities after this timestamp",
875
- "schema": {
876
- "type": "string",
877
- "format": "date-time"
878
- }
879
- },
880
- {
881
- "in": "query",
882
- "name": "before",
883
- "description": "get activities before this timestamp",
884
- "schema": {
885
- "type": "string",
886
- "format": "date-time"
887
- }
888
- },
889
- {
890
- "in": "query",
891
- "name": "from",
892
- "description": "start from page",
893
- "schema": {
894
- "type": "integer",
895
- "minimum": 0,
896
- "default": 0
897
- }
898
- },
899
- {
900
- "in": "query",
901
- "name": "size",
902
- "description": "max number of results to return",
903
- "schema": {
904
- "type": "integer",
905
- "minimum": 1,
906
- "default": 25
907
- }
908
- },
909
- {
910
- "in": "query",
911
- "name": "type",
912
- "description": "Activity type",
913
- "schema": {
914
- "type": "string",
915
- "example": "SyncActivity"
916
- }
917
- }
918
- ],
919
- "responses": {
920
- "200": {
921
- "description": "Success",
922
- "content": {
923
- "application/json": {
924
- "schema": {
925
- "type": "object",
926
- "properties": {
927
- "total": {
928
- "type": "integer",
929
- "example": 1
930
- },
931
- "results": {
932
- "type": "array",
933
- "items": {
934
- "$ref": "#/components/schemas/ActivityItem"
935
- }
936
- }
937
- }
938
- }
939
- }
940
- }
941
- }
942
- }
943
- }
944
- },
945
- "/v1/entity/{slug}/{id}/relations": {
946
- "get": {
947
- "operationId": "getRelations",
948
- "summary": "getRelations",
949
- "description": "It loads 1st level relations for the mentioned entity. You can control whether entire related entity is loaded or not via hydrate param.",
950
- "tags": [
951
- "Relations"
952
- ],
953
- "parameters": [
954
- {
955
- "in": "path",
956
- "name": "slug",
957
- "description": "Entity Type",
958
- "required": true,
959
- "schema": {
960
- "$ref": "#/components/schemas/EntitySlug"
961
- }
962
- },
963
- {
964
- "in": "path",
965
- "name": "id",
966
- "description": "Entity id",
967
- "required": true,
968
- "schema": {
969
- "$ref": "#/components/schemas/EntityId"
970
- }
971
- },
972
- {
973
- "in": "query",
974
- "name": "hydrate",
975
- "description": "When true, expand relation items with full blown entities.",
976
- "schema": {
977
- "default": false,
978
- "type": "boolean"
979
- }
980
- }
981
- ],
982
- "responses": {
983
- "200": {
984
- "description": "Success",
985
- "content": {
986
- "application/json": {
987
- "schema": {
988
- "$ref": "#/components/schemas/GetRelationsResp"
989
- },
990
- "example": [
991
- {
992
- "attribute": "contacts",
993
- "entity_id": "ed27830b-984c-4bca-9b87-2849bb5789ca",
994
- "_tags": [
995
- "primary",
996
- "billing"
997
- ]
998
- },
999
- {
1000
- "attribute": "contacts",
1001
- "entity_id": "fadfc950-6e43-4e38-bae0-ffcf4b8b90e1"
1002
- },
1003
- {
1004
- "_id": "9924c4de-d3ed-4752-821d-fc0b9bd57c1b",
1005
- "order_number": "a34234jd",
1006
- "customer_email": "johndoe@epilot.cloud",
1007
- "billing_first_name": "john",
1008
- "billing_last_name": "doe",
1009
- "billing_company_name": "ePilot Gmbh",
1010
- "billing_vat": "234823948,",
1011
- "billing_email": "johndoe@nowhere.com",
1012
- "billing_phone": "1234234545,",
1013
- "billing_address": "wallstreet, 1",
1014
- "billing_contact": "villy or zilly",
1015
- "$relation": {
1016
- "attribute": "orders",
1017
- "entity_id": "9924c4de-d3ed-4752-821d-fc0b9bd57c1b",
1018
- "_tags": [
1019
- "solar_panel",
1020
- "one_time"
1021
- ]
1022
- }
1023
- }
1024
- ]
1025
- }
1026
- }
1027
- }
1028
- }
1029
- },
1030
- "post": {
1031
- "operationId": "addRelations",
1032
- "summary": "addRelations",
1033
- "description": "It relates one or more entities to some parent entity, by providing meaning for relations via attribute field.",
1034
- "tags": [
1035
- "Relations"
1036
- ],
1037
- "parameters": [
1038
- {
1039
- "in": "path",
1040
- "name": "slug",
1041
- "description": "Entity Type",
1042
- "required": true,
1043
- "schema": {
1044
- "$ref": "#/components/schemas/EntitySlug"
1045
- }
1046
- },
1047
- {
1048
- "in": "path",
1049
- "name": "id",
1050
- "description": "Entity id",
1051
- "required": true,
1052
- "schema": {
1053
- "$ref": "#/components/schemas/EntityId"
1054
- }
1055
- }
1056
- ],
1057
- "requestBody": {
1058
- "content": {
1059
- "application/json": {
1060
- "schema": {
1061
- "type": "array",
1062
- "items": {
1063
- "$ref": "#/components/schemas/RelationItem"
1064
- }
1065
- },
1066
- "example": [
1067
- {
1068
- "attribute": "contacts",
1069
- "entity_id": "e8878f62-2d3d-4c86-bfe7-01a4180ff048",
1070
- "_tags": [
1071
- "billing"
1072
- ]
1073
- },
1074
- {
1075
- "attribute": "contacts",
1076
- "entity_id": "ee8a2af9-fb36-4981-b848-4e65275851af"
1077
- },
1078
- {
1079
- "attribute": "opportunities",
1080
- "entity_id": "30990430-a53d-41a2-83db-2de072dc4dd4"
1081
- }
1082
- ]
1083
- }
1084
- }
1085
- },
1086
- "responses": {
1087
- "200": {
1088
- "description": "Success",
1089
- "content": {
1090
- "application/json": {
1091
- "schema": {
1092
- "$ref": "#/components/schemas/RelationItem"
1093
- }
1094
- }
1095
- }
1096
- }
1097
- }
1098
- }
1099
- },
1100
- "/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}": {
1101
- "put": {
1102
- "operationId": "updateRelation",
1103
- "summary": "updateRelation",
1104
- "description": "It updates a relation between two entities.",
1105
- "tags": [
1106
- "Relations"
1107
- ],
1108
- "parameters": [
1109
- {
1110
- "in": "path",
1111
- "name": "slug",
1112
- "description": "Entity Type",
1113
- "required": true,
1114
- "schema": {
1115
- "$ref": "#/components/schemas/EntitySlug"
1116
- }
1117
- },
1118
- {
1119
- "in": "path",
1120
- "name": "id",
1121
- "description": "Entity id",
1122
- "required": true,
1123
- "schema": {
1124
- "$ref": "#/components/schemas/EntityId"
1125
- }
1126
- },
1127
- {
1128
- "in": "path",
1129
- "name": "attribute",
1130
- "description": "The attribute that express meaning",
1131
- "required": true,
1132
- "schema": {
1133
- "type": "string"
1134
- }
1135
- },
1136
- {
1137
- "in": "path",
1138
- "name": "entity_id",
1139
- "description": "The attribute that express meaning",
1140
- "required": true,
1141
- "schema": {
1142
- "type": "string"
1143
- }
1144
- }
1145
- ],
1146
- "requestBody": {
1147
- "content": {
1148
- "application/json": {
1149
- "schema": {
1150
- "type": "object",
1151
- "properties": {
1152
- "_tags": {
1153
- "type": "array",
1154
- "items": {
1155
- "type": "string"
1156
- }
1157
- }
1158
- }
1159
- },
1160
- "example": {
1161
- "_tags": [
1162
- "billing",
1163
- "prepaid"
1164
- ]
1165
- }
1166
- }
1167
- }
1168
- },
1169
- "responses": {
1170
- "200": {
1171
- "description": "Success",
1172
- "content": {
1173
- "application/json": {
1174
- "schema": {
1175
- "$ref": "#/components/schemas/RelationItem"
1176
- }
1177
- }
1178
- }
1179
- }
1180
- }
1181
- },
1182
- "delete": {
1183
- "operationId": "deleteRelation",
1184
- "summary": "deleteRelation",
1185
- "description": "It deletes a relation between one entity and the other.",
1186
- "tags": [
1187
- "Relations"
1188
- ],
1189
- "parameters": [
1190
- {
1191
- "in": "path",
1192
- "name": "slug",
1193
- "description": "Entity Type",
1194
- "required": true,
1195
- "schema": {
1196
- "$ref": "#/components/schemas/EntitySlug"
1197
- }
1198
- },
1199
- {
1200
- "in": "path",
1201
- "name": "id",
1202
- "description": "Entity id",
1203
- "required": true,
1204
- "schema": {
1205
- "$ref": "#/components/schemas/EntityId"
1206
- }
1207
- },
1208
- {
1209
- "in": "path",
1210
- "name": "attribute",
1211
- "description": "The attribute that express meaning",
1212
- "required": true,
1213
- "schema": {
1214
- "type": "string"
1215
- }
1216
- },
1217
- {
1218
- "in": "path",
1219
- "name": "entity_id",
1220
- "description": "The attribute that express meaning",
1221
- "required": true,
1222
- "schema": {
1223
- "type": "string"
1224
- }
1225
- }
1226
- ],
1227
- "responses": {
1228
- "204": {
1229
- "description": "Relation deleted with success."
1230
- }
1231
- }
1232
- }
1233
- }
1234
- },
1235
- "components": {
1236
- "securitySchemes": {
1237
- "EpilotAuth": {
1238
- "type": "http",
1239
- "scheme": "bearer",
1240
- "description": "Authorization header with epilot OAuth2 bearer token",
1241
- "bearerFormat": "JWT"
1242
- },
1243
- "EpilotOrg": {
1244
- "description": "Overrides the target organization to allow shared tenantaccess",
1245
- "name": "x-epilot-org-id",
1246
- "in": "header",
1247
- "type": "apiKey"
1248
- }
1249
- },
1250
- "schemas": {
1251
- "SchemaId": {
1252
- "description": "Generated uuid for schema",
1253
- "type": "string",
1254
- "format": "uuid"
1255
- },
1256
- "EntitySchema": {
1257
- "description": "The \"type\" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.",
1258
- "type": "object",
1259
- "properties": {
1260
- "slug": {
1261
- "$ref": "#/components/schemas/EntitySlug"
1262
- },
1263
- "version": {
1264
- "type": "integer",
1265
- "minimum": 1
1266
- },
1267
- "blueprint": {
1268
- "$ref": "#/components/schemas/BlueprintEntityId"
1269
- },
1270
- "feature_flag": {
1271
- "type": "string",
1272
- "example": "FF_MY_FEATURE_FLAG",
1273
- "description": "This schema should only be active when the feature flag is enabled"
1274
- },
1275
- "enable_setting": {
1276
- "description": "This schema should only be active when one of the organization settings is enabled",
1277
- "type": "array",
1278
- "items": {
1279
- "type": "string",
1280
- "example": "ecommerce_preview"
1281
- }
1282
- },
1283
- "name": {
1284
- "description": "User-friendly identifier for the entity schema",
1285
- "type": "string",
1286
- "example": "Contact"
1287
- },
1288
- "plural": {
1289
- "type": "string",
1290
- "example": "Contacts"
1291
- },
1292
- "published": {
1293
- "type": "boolean",
1294
- "example": false
1295
- },
1296
- "draft": {
1297
- "type": "boolean",
1298
- "example": false
1299
- },
1300
- "icon": {
1301
- "type": "string",
1302
- "example": "person"
1303
- },
1304
- "title_template": {
1305
- "type": "string",
1306
- "description": "Template for rendering the title field. Uses handlebars",
1307
- "example": "{{first_name}} {{last_name}}"
1308
- },
1309
- "ui_config": {
1310
- "type": "object",
1311
- "properties": {
1312
- "table_view": {
1313
- "$ref": "#/components/schemas/EntityViewConfig"
1314
- },
1315
- "create_view": {
1316
- "$ref": "#/components/schemas/EntityViewConfig"
1317
- },
1318
- "edit_view": {
1319
- "$ref": "#/components/schemas/EntityViewConfig"
1320
- },
1321
- "list_item": {
1322
- "type": "object",
1323
- "properties": {
1324
- "summary_attributes": {
1325
- "type": "array",
1326
- "items": {
1327
- "type": "string",
1328
- "description": "List of attributes to show in list item",
1329
- "example": "email"
1330
- }
1331
- }
1332
- }
1333
- },
1334
- "sharing": {
1335
- "type": "object",
1336
- "properties": {
1337
- "show_sharing_button": {
1338
- "type": "boolean",
1339
- "description": "Show the sharing button in entity detail view",
1340
- "example": true
1341
- }
1342
- }
1343
- }
1344
- }
1345
- },
1346
- "capabilities": {
1347
- "type": "array",
1348
- "items": {
1349
- "$ref": "#/components/schemas/EntityCapability"
1350
- }
1351
- },
1352
- "group_settings": {
1353
- "type": "array",
1354
- "description": "A dictionary of Group Titles and associated settings if present.",
1355
- "items": {
1356
- "type": "object",
1357
- "properties": {
1358
- "label": {
1359
- "type": "string"
1360
- },
1361
- "id": {
1362
- "type": "string"
1363
- },
1364
- "expanded": {
1365
- "type": "boolean"
1366
- },
1367
- "render_condition": {
1368
- "type": "string",
1369
- "example": "composite_price = \"false\""
1370
- },
1371
- "order": {
1372
- "description": "Render order of the group",
1373
- "type": "integer",
1374
- "default": 0
1375
- },
1376
- "feature_flag": {
1377
- "type": "string",
1378
- "example": "FF_MY_FEATURE_FLAG",
1379
- "description": "This schema should only be active when the feature flag is enabled"
1380
- },
1381
- "info_tooltip_title": {
1382
- "type": "object",
1383
- "properties": {
1384
- "key": {
1385
- "type": "string"
1386
- },
1387
- "default": {
1388
- "type": "string"
1389
- }
1390
- }
1391
- }
1392
- },
1393
- "required": [
1394
- "label",
1395
- "id"
1396
- ]
1397
- },
1398
- "example": {
1399
- "Order Info": {
1400
- "expanded": true
1401
- },
1402
- "Contact Details": {
1403
- "expanded": false,
1404
- "info_tooltip_title": {
1405
- "key": "partner.partner_information_group_tooltip",
1406
- "default": "These informations are provided by the partner company and cannot be edited."
1407
- }
1408
- }
1409
- }
1410
- },
1411
- "layout_settings": {
1412
- "type": "object",
1413
- "description": "Custom grid definitions for the layout",
1414
- "additionalProperties": {
1415
- "type": "object",
1416
- "properties": {
1417
- "grid_gap": {
1418
- "type": "string"
1419
- },
1420
- "grid_template_columns": {
1421
- "type": "string"
1422
- }
1423
- }
1424
- }
1425
- },
1426
- "dialog_config": {
1427
- "type": "object",
1428
- "additionalProperties": true
1429
- },
1430
- "attributes": {
1431
- "description": "An ordered list of attributes the entity contains",
1432
- "type": "array",
1433
- "items": {
1434
- "$ref": "#/components/schemas/Attribute"
1435
- },
1436
- "example": [
1437
- {
1438
- "name": "email",
1439
- "type": "email",
1440
- "label": "Email",
1441
- "required": true
1442
- },
1443
- {
1444
- "name": "first_name",
1445
- "type": "string",
1446
- "label": "First Name"
1447
- },
1448
- {
1449
- "name": "last_name",
1450
- "type": "string",
1451
- "label": "Last Name"
1452
- },
1453
- {
1454
- "name": "birthdate",
1455
- "type": "date",
1456
- "label": "Birthdate"
1457
- },
1458
- {
1459
- "name": "salutation",
1460
- "type": "select",
1461
- "label": "Salutation",
1462
- "options": [
1463
- "Mr.",
1464
- "Ms. / Mrs.",
1465
- "Other"
1466
- ]
1467
- },
1468
- {
1469
- "name": "marketing_permission",
1470
- "type": "boolean",
1471
- "label": "Marketing permission"
1472
- },
1473
- {
1474
- "name": "image",
1475
- "type": "file",
1476
- "label": "Image"
1477
- }
1478
- ]
1479
- },
1480
- "explicit_search_mappings": {
1481
- "$ref": "#/components/schemas/SearchMappings"
1482
- }
1483
- },
1484
- "required": [
1485
- "slug",
1486
- "name",
1487
- "plural"
1488
- ]
1489
- },
1490
- "EntitySchemaItem": {
1491
- "allOf": [
1492
- {
1493
- "type": "object",
1494
- "properties": {
1495
- "id": {
1496
- "$ref": "#/components/schemas/SchemaId"
1497
- },
1498
- "created_at": {
1499
- "type": "string"
1500
- },
1501
- "updated_at": {
1502
- "type": "string"
1503
- },
1504
- "comment": {
1505
- "type": "string"
1506
- },
1507
- "source": {
1508
- "type": "object",
1509
- "properties": {
1510
- "id": {
1511
- "type": "string"
1512
- },
1513
- "type": {
1514
- "type": "string"
1515
- }
1516
- }
1517
- }
1518
- }
1519
- },
1520
- {
1521
- "$ref": "#/components/schemas/EntitySchema"
1522
- }
1523
- ]
1524
- },
1525
- "Attribute": {
1526
- "anyOf": [
1527
- {
1528
- "$ref": "#/components/schemas/TextAttribute"
1529
- },
1530
- {
1531
- "$ref": "#/components/schemas/LinkAttribute"
1532
- },
1533
- {
1534
- "$ref": "#/components/schemas/DateAttribute"
1535
- },
1536
- {
1537
- "$ref": "#/components/schemas/CountryAttribute"
1538
- },
1539
- {
1540
- "$ref": "#/components/schemas/BooleanAttribute"
1541
- },
1542
- {
1543
- "$ref": "#/components/schemas/SelectAttribute"
1544
- },
1545
- {
1546
- "$ref": "#/components/schemas/RelationAttribute"
1547
- },
1548
- {
1549
- "$ref": "#/components/schemas/UserRelationAttribute"
1550
- },
1551
- {
1552
- "$ref": "#/components/schemas/AddressRelationAttribute"
1553
- },
1554
- {
1555
- "$ref": "#/components/schemas/CurrencyAttribute"
1556
- },
1557
- {
1558
- "$ref": "#/components/schemas/RepeatableAttribute"
1559
- },
1560
- {
1561
- "$ref": "#/components/schemas/TagsAttribute"
1562
- },
1563
- {
1564
- "$ref": "#/components/schemas/NumberAttribute"
1565
- },
1566
- {
1567
- "$ref": "#/components/schemas/ConsentAttribute"
1568
- },
1569
- {
1570
- "$ref": "#/components/schemas/InternalAttribute"
1571
- },
1572
- {
1573
- "$ref": "#/components/schemas/OrderedListAttribute"
1574
- },
1575
- {
1576
- "$ref": "#/components/schemas/FileAttribute"
1577
- },
1578
- {
1579
- "$ref": "#/components/schemas/ComputedAttribute"
1580
- },
1581
- {
1582
- "$ref": "#/components/schemas/PartnerStatusAttribute"
1583
- }
1584
- ]
1585
- },
1586
- "BaseAttribute": {
1587
- "type": "object",
1588
- "properties": {
1589
- "name": {
1590
- "type": "string"
1591
- },
1592
- "label": {
1593
- "type": "string"
1594
- },
1595
- "placeholder": {
1596
- "type": "string"
1597
- },
1598
- "hidden": {
1599
- "description": "Do not render attribute in entity views",
1600
- "type": "boolean",
1601
- "default": false
1602
- },
1603
- "show_in_table": {
1604
- "description": "Render as a column in table views. When defined, overrides `hidden`",
1605
- "type": "boolean"
1606
- },
1607
- "required": {
1608
- "type": "boolean",
1609
- "default": false
1610
- },
1611
- "readonly": {
1612
- "type": "boolean",
1613
- "default": false
1614
- },
1615
- "deprecated": {
1616
- "type": "boolean",
1617
- "default": false
1618
- },
1619
- "default_value": {
1620
- "oneOf": [
1621
- {
1622
- "type": "string"
1623
- },
1624
- {
1625
- "type": "object",
1626
- "additionalProperties": true
1627
- },
1628
- {
1629
- "type": "integer"
1630
- },
1631
- {
1632
- "type": "number"
1633
- },
1634
- {
1635
- "type": "boolean"
1636
- },
1637
- {
1638
- "type": "array"
1639
- }
1640
- ]
1641
- },
1642
- "group": {
1643
- "type": "string"
1644
- },
1645
- "layout": {
1646
- "type": "string"
1647
- },
1648
- "hide_label": {
1649
- "type": "boolean",
1650
- "description": "When set to true, will hide the label of the field."
1651
- },
1652
- "icon": {
1653
- "type": "string",
1654
- "description": "Code name of the icon to used to represent this attribute.\nThe value must be a valid @epilot/base-elements Icon name\n"
1655
- },
1656
- "render_condition": {
1657
- "type": "string",
1658
- "description": "Defines the conditional rendering expression for showing this field.\nWhen a valid expression is parsed, their evaluation defines the visibility of this attribute.\nNote: Empty or invalid expression have no effect on the field visibility.\n"
1659
- },
1660
- "constraints": {
1661
- "type": "object",
1662
- "description": "A set of constraints applicable to the attribute.\nThese constraints should and will be enforced by the attribute renderer.\n",
1663
- "example": {
1664
- "disablePast": true
1665
- }
1666
- },
1667
- "feature_flag": {
1668
- "type": "string",
1669
- "example": "FF_MY_FEATURE_FLAG",
1670
- "description": "This attribute should only be active when the feature flag is enabled"
1671
- },
1672
- "value_formatter": {
1673
- "type": "string"
1674
- },
1675
- "preview_value_formatter": {
1676
- "type": "string"
1677
- },
1678
- "entity_builder_disable_edit": {
1679
- "description": "Setting to `true` disables editing the attribute on the entity builder UI",
1680
- "type": "boolean",
1681
- "default": false
1682
- },
1683
- "protected": {
1684
- "description": "Setting to `true` prevents the attribute from being modified / deleted",
1685
- "type": "boolean",
1686
- "default": true
1687
- }
1688
- },
1689
- "required": [
1690
- "name",
1691
- "label"
1692
- ]
1693
- },
1694
- "TextAttribute": {
1695
- "allOf": [
1696
- {
1697
- "$ref": "#/components/schemas/BaseAttribute"
1698
- },
1699
- {
1700
- "type": "object",
1701
- "description": "Textarea or text input",
1702
- "properties": {
1703
- "type": {
1704
- "type": "string",
1705
- "enum": [
1706
- "string"
1707
- ]
1708
- },
1709
- "multiline": {
1710
- "type": "boolean"
1711
- }
1712
- }
1713
- }
1714
- ]
1715
- },
1716
- "LinkAttribute": {
1717
- "allOf": [
1718
- {
1719
- "$ref": "#/components/schemas/BaseAttribute"
1720
- },
1721
- {
1722
- "type": "object",
1723
- "description": "Link with title and href",
1724
- "properties": {
1725
- "type": {
1726
- "type": "string",
1727
- "enum": [
1728
- "link"
1729
- ]
1730
- }
1731
- }
1732
- }
1733
- ]
1734
- },
1735
- "InternalAttribute": {
1736
- "allOf": [
1737
- {
1738
- "$ref": "#/components/schemas/BaseAttribute"
1739
- },
1740
- {
1741
- "type": "object",
1742
- "description": "No UI representation",
1743
- "properties": {
1744
- "type": {
1745
- "type": "string",
1746
- "enum": [
1747
- "internal"
1748
- ]
1749
- }
1750
- }
1751
- }
1752
- ]
1753
- },
1754
- "BooleanAttribute": {
1755
- "allOf": [
1756
- {
1757
- "$ref": "#/components/schemas/BaseAttribute"
1758
- },
1759
- {
1760
- "type": "object",
1761
- "description": "Yes / No Toggle",
1762
- "properties": {
1763
- "type": {
1764
- "type": "string",
1765
- "enum": [
1766
- "boolean"
1767
- ]
1768
- }
1769
- }
1770
- }
1771
- ]
1772
- },
1773
- "DateAttribute": {
1774
- "allOf": [
1775
- {
1776
- "$ref": "#/components/schemas/BaseAttribute"
1777
- },
1778
- {
1779
- "type": "object",
1780
- "description": "Date or Datetime picker",
1781
- "properties": {
1782
- "type": {
1783
- "type": "string",
1784
- "enum": [
1785
- "date",
1786
- "datetime"
1787
- ]
1788
- }
1789
- }
1790
- }
1791
- ]
1792
- },
1793
- "CountryAttribute": {
1794
- "allOf": [
1795
- {
1796
- "$ref": "#/components/schemas/BaseAttribute"
1797
- },
1798
- {
1799
- "type": "object",
1800
- "description": "Country picker",
1801
- "properties": {
1802
- "type": {
1803
- "type": "string",
1804
- "enum": [
1805
- "country"
1806
- ]
1807
- }
1808
- }
1809
- }
1810
- ]
1811
- },
1812
- "SelectAttribute": {
1813
- "allOf": [
1814
- {
1815
- "$ref": "#/components/schemas/BaseAttribute"
1816
- },
1817
- {
1818
- "type": "object",
1819
- "description": "Dropdown select",
1820
- "properties": {
1821
- "type": {
1822
- "type": "string",
1823
- "enum": [
1824
- "select",
1825
- "radio"
1826
- ]
1827
- },
1828
- "options": {
1829
- "type": "array",
1830
- "items": {
1831
- "anyOf": [
1832
- {
1833
- "type": "string",
1834
- "nullable": true
1835
- },
1836
- {
1837
- "type": "object",
1838
- "properties": {
1839
- "value": {
1840
- "type": "string"
1841
- },
1842
- "title": {
1843
- "type": "string"
1844
- }
1845
- },
1846
- "required": [
1847
- "value"
1848
- ]
1849
- }
1850
- ]
1851
- }
1852
- },
1853
- "allow_any": {
1854
- "type": "boolean",
1855
- "description": "Allow arbitrary input values in addition to provided options"
1856
- }
1857
- }
1858
- }
1859
- ]
1860
- },
1861
- "FileAttribute": {
1862
- "allOf": [
1863
- {
1864
- "$ref": "#/components/schemas/BaseAttribute"
1865
- },
1866
- {
1867
- "type": "object",
1868
- "description": "File or Image Attachment",
1869
- "properties": {
1870
- "type": {
1871
- "type": "string",
1872
- "enum": [
1873
- "image",
1874
- "file"
1875
- ]
1876
- },
1877
- "multiple": {
1878
- "type": "boolean"
1879
- },
1880
- "allowed_types": {
1881
- "description": "List of unique content type specifiers (mime-types / extension)",
1882
- "type": "array",
1883
- "items": {
1884
- "type": "string",
1885
- "example": "image/*"
1886
- }
1887
- },
1888
- "default_access_control": {
1889
- "type": "string",
1890
- "enum": [
1891
- "public-read",
1892
- "private"
1893
- ]
1894
- }
1895
- },
1896
- "required": [
1897
- "type"
1898
- ]
1899
- }
1900
- ]
1901
- },
1902
- "CurrencyAttribute": {
1903
- "allOf": [
1904
- {
1905
- "$ref": "#/components/schemas/BaseAttribute"
1906
- },
1907
- {
1908
- "type": "object",
1909
- "description": "Currency input",
1910
- "properties": {
1911
- "type": {
1912
- "type": "string",
1913
- "enum": [
1914
- "currency"
1915
- ]
1916
- },
1917
- "currency_selector_only": {
1918
- "type": "boolean",
1919
- "default": false
1920
- },
1921
- "currency": {
1922
- "description": "An array of currency configurations with a country code (ISO-4217)",
1923
- "type": "array",
1924
- "items": {
1925
- "anyOf": [
1926
- {
1927
- "type": "object",
1928
- "description": "A currency configuration",
1929
- "properties": {
1930
- "code": {
1931
- "type": "string"
1932
- },
1933
- "description": {
1934
- "type": "string"
1935
- },
1936
- "symbol": {
1937
- "type": "string"
1938
- },
1939
- "flag": {
1940
- "type": "string"
1941
- }
1942
- },
1943
- "required": [
1944
- "code",
1945
- "description",
1946
- "symbol"
1947
- ],
1948
- "example": {
1949
- "code": "EUR",
1950
- "description": "Euro",
1951
- "symbol": "€",
1952
- "flag": "🇪🇺"
1953
- }
1954
- }
1955
- ]
1956
- }
1957
- }
1958
- },
1959
- "required": [
1960
- "type",
1961
- "currency"
1962
- ]
1963
- }
1964
- ]
1965
- },
1966
- "SummaryField": {
1967
- "type": "object",
1968
- "description": "Summary Fields are displayed inside list view as a resume of the relation entity.",
1969
- "properties": {
1970
- "field": {
1971
- "type": "string",
1972
- "description": "The field from the entity attributes to display"
1973
- },
1974
- "display_as": {
1975
- "type": "string",
1976
- "description": "An hint on how to display the summary field"
1977
- }
1978
- }
1979
- },
1980
- "RelationAttribute": {
1981
- "allOf": [
1982
- {
1983
- "$ref": "#/components/schemas/BaseAttribute"
1984
- },
1985
- {
1986
- "type": "object",
1987
- "description": "Entity Relationship",
1988
- "properties": {
1989
- "type": {
1990
- "type": "string",
1991
- "enum": [
1992
- "relation"
1993
- ]
1994
- },
1995
- "relation_type": {
1996
- "type": "string",
1997
- "enum": [
1998
- "has_many",
1999
- "has_one"
2000
- ]
2001
- },
2002
- "delete_mode": {
2003
- "type": "string",
2004
- "enum": [
2005
- "cascade"
2006
- ]
2007
- },
2008
- "relation_affinity_mode": {
2009
- "type": "string",
2010
- "enum": [
2011
- "weak",
2012
- "strong"
2013
- ]
2014
- },
2015
- "enable_relation_picker": {
2016
- "type": "boolean",
2017
- "default": true,
2018
- "description": "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."
2019
- },
2020
- "edit_mode": {
2021
- "type": "string",
2022
- "enum": [
2023
- "list-view"
2024
- ]
2025
- },
2026
- "drawer_size": {
2027
- "type": "string",
2028
- "enum": [
2029
- "small",
2030
- "medium",
2031
- "large"
2032
- ]
2033
- },
2034
- "icon": {
2035
- "type": "string"
2036
- },
2037
- "summary_fields": {
2038
- "type": "array",
2039
- "items": {
2040
- "anyOf": [
2041
- {
2042
- "type": "string",
2043
- "description": "The field name from the entity attributes to display"
2044
- },
2045
- {
2046
- "$ref": "#/components/schemas/SummaryField"
2047
- }
2048
- ]
2049
- }
2050
- },
2051
- "has_primary": {
2052
- "type": "boolean"
2053
- },
2054
- "allowedSchemas": {
2055
- "type": "array",
2056
- "items": {
2057
- "$ref": "#/components/schemas/EntitySlug"
2058
- }
2059
- },
2060
- "enable_relation_tags": {
2061
- "type": "boolean",
2062
- "default": true,
2063
- "description": "when enable_relation_tags is set to true the user will be able to set tags(labels) in each relation item"
2064
- }
2065
- }
2066
- }
2067
- ]
2068
- },
2069
- "UserRelationAttribute": {
2070
- "allOf": [
2071
- {
2072
- "$ref": "#/components/schemas/BaseAttribute"
2073
- },
2074
- {
2075
- "type": "object",
2076
- "description": "User Relationship",
2077
- "properties": {
2078
- "type": {
2079
- "type": "string",
2080
- "enum": [
2081
- "relation_user"
2082
- ]
2083
- },
2084
- "multiple": {
2085
- "type": "boolean",
2086
- "default": false
2087
- }
2088
- }
2089
- }
2090
- ]
2091
- },
2092
- "AddressRelationAttribute": {
2093
- "allOf": [
2094
- {
2095
- "$ref": "#/components/schemas/BaseAttribute"
2096
- },
2097
- {
2098
- "type": "object",
2099
- "description": "Reference to an address attribute of another entity",
2100
- "properties": {
2101
- "type": {
2102
- "type": "string",
2103
- "enum": [
2104
- "relation_address"
2105
- ]
2106
- },
2107
- "has_primary": {
2108
- "type": "boolean"
2109
- }
2110
- }
2111
- }
2112
- ]
2113
- },
2114
- "RepeatableAttribute": {
2115
- "allOf": [
2116
- {
2117
- "$ref": "#/components/schemas/BaseAttribute"
2118
- },
2119
- {
2120
- "type": "object",
2121
- "description": "Repeatable (add N number of fields)",
2122
- "properties": {
2123
- "repeatable": {
2124
- "type": "boolean"
2125
- },
2126
- "has_primary": {
2127
- "type": "boolean"
2128
- },
2129
- "relation_affinity_mode": {
2130
- "type": "string",
2131
- "enum": [
2132
- "weak",
2133
- "strong"
2134
- ]
2135
- },
2136
- "type": {
2137
- "type": "string",
2138
- "enum": [
2139
- "string",
2140
- "phone",
2141
- "email",
2142
- "address",
2143
- "relation",
2144
- "payment",
2145
- "price_component"
2146
- ]
2147
- },
2148
- "enable_relation_picker": {
2149
- "type": "boolean",
2150
- "default": true,
2151
- "description": "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."
2152
- }
2153
- }
2154
- }
2155
- ]
2156
- },
2157
- "TagsAttribute": {
2158
- "allOf": [
2159
- {
2160
- "$ref": "#/components/schemas/BaseAttribute"
2161
- },
2162
- {
2163
- "type": "object",
2164
- "description": "Tags",
2165
- "properties": {
2166
- "type": {
2167
- "type": "string",
2168
- "enum": [
2169
- "tags"
2170
- ]
2171
- },
2172
- "options": {
2173
- "type": "array",
2174
- "items": {
2175
- "type": "string"
2176
- }
2177
- },
2178
- "suggestions": {
2179
- "type": "array",
2180
- "items": {
2181
- "type": "string"
2182
- }
2183
- }
2184
- }
2185
- }
2186
- ]
2187
- },
2188
- "NumberAttribute": {
2189
- "allOf": [
2190
- {
2191
- "$ref": "#/components/schemas/BaseAttribute"
2192
- },
2193
- {
2194
- "type": "object",
2195
- "description": "Numeric input",
2196
- "properties": {
2197
- "type": {
2198
- "type": "string",
2199
- "enum": [
2200
- "number"
2201
- ]
2202
- },
2203
- "format": {
2204
- "type": "string"
2205
- }
2206
- }
2207
- }
2208
- ]
2209
- },
2210
- "ConsentAttribute": {
2211
- "allOf": [
2212
- {
2213
- "$ref": "#/components/schemas/BaseAttribute"
2214
- },
2215
- {
2216
- "type": "object",
2217
- "description": "Consent Management",
2218
- "properties": {
2219
- "type": {
2220
- "type": "string",
2221
- "enum": [
2222
- "consent"
2223
- ]
2224
- },
2225
- "topic": {
2226
- "type": "string"
2227
- },
2228
- "identifiers": {
2229
- "type": "array",
2230
- "items": {
2231
- "type": "string"
2232
- }
2233
- }
2234
- },
2235
- "required": [
2236
- "type",
2237
- "topic"
2238
- ]
2239
- }
2240
- ]
2241
- },
2242
- "OrderedListAttribute": {
2243
- "allOf": [
2244
- {
2245
- "$ref": "#/components/schemas/BaseAttribute"
2246
- },
2247
- {
2248
- "type": "object",
2249
- "description": "Type of attribute to render N number of ordered fields",
2250
- "properties": {
2251
- "type": {
2252
- "type": "string",
2253
- "enum": [
2254
- "ordered_list"
2255
- ]
2256
- }
2257
- }
2258
- }
2259
- ]
2260
- },
2261
- "ComputedAttribute": {
2262
- "allOf": [
2263
- {
2264
- "$ref": "#/components/schemas/BaseAttribute"
2265
- },
2266
- {
2267
- "type": "object",
2268
- "description": "An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes)",
2269
- "properties": {
2270
- "type": {
2271
- "type": "string",
2272
- "enum": [
2273
- "computed"
2274
- ]
2275
- }
2276
- }
2277
- }
2278
- ]
2279
- },
2280
- "PartnerStatusAttribute": {
2281
- "allOf": [
2282
- {
2283
- "$ref": "#/components/schemas/BaseAttribute"
2284
- },
2285
- {
2286
- "type": "object",
2287
- "description": "Partner Status",
2288
- "properties": {
2289
- "type": {
2290
- "type": "string",
2291
- "enum": [
2292
- "partner_status"
2293
- ]
2294
- }
2295
- }
2296
- }
2297
- ]
2298
- },
2299
- "Attachment": {
2300
- "type": "object",
2301
- "deprecated": true,
2302
- "properties": {
2303
- "key": {
2304
- "type": "string"
2305
- },
2306
- "mime": {
2307
- "type": "string"
2308
- },
2309
- "name": {
2310
- "type": "string"
2311
- },
2312
- "size": {
2313
- "type": "number"
2314
- },
2315
- "image_url": {
2316
- "type": "string"
2317
- },
2318
- "download_url": {
2319
- "type": "string"
2320
- },
2321
- "alt_text": {
2322
- "type": "string"
2323
- }
2324
- },
2325
- "required": [
2326
- "key",
2327
- "mime",
2328
- "name",
2329
- "size",
2330
- "image_url",
2331
- "download_url"
2332
- ]
2333
- },
2334
- "EntitySlug": {
2335
- "description": "URL-friendly identifier for the entity schema",
2336
- "type": "string",
2337
- "example": "contact"
2338
- },
2339
- "EntityCapability": {
2340
- "description": "Capabilities the Entity has. Turn features on/off for entities.",
2341
- "type": "object",
2342
- "properties": {
2343
- "name": {
2344
- "type": "string",
2345
- "description": "Unique name for the capability",
2346
- "example": "customer_messaging"
2347
- },
2348
- "title": {
2349
- "type": "string",
2350
- "description": "Human readable title of the capability",
2351
- "example": "Messaging"
2352
- },
2353
- "attributes": {
2354
- "type": "array",
2355
- "items": {
2356
- "$ref": "#/components/schemas/Attribute"
2357
- }
2358
- },
2359
- "ui_hooks": {
2360
- "type": "array",
2361
- "items": {
2362
- "type": "object",
2363
- "additionalProperties": true,
2364
- "properties": {
2365
- "hook": {
2366
- "type": "string",
2367
- "description": "name of the hook to use",
2368
- "example": "EntityDetailsV2:Tab"
2369
- },
2370
- "render_condition": {
2371
- "type": "string",
2372
- "example": "composite_price = \"false\""
2373
- },
2374
- "order": {
2375
- "type": "integer",
2376
- "description": "render order (ascending)",
2377
- "example": 10
2378
- },
2379
- "title": {
2380
- "type": "string",
2381
- "example": "Notes"
2382
- },
2383
- "group_expanded": {
2384
- "type": "boolean",
2385
- "description": "Sets the group expand/collapse default state"
2386
- },
2387
- "import": {
2388
- "type": "string",
2389
- "description": "package to be imported",
2390
- "example": "@epilot360/notes"
2391
- },
2392
- "component": {
2393
- "type": "string",
2394
- "description": "the component to be dynamically loaded",
2395
- "example": "PricingItems"
2396
- },
2397
- "route": {
2398
- "type": "string",
2399
- "description": "route for specified capability",
2400
- "example": "notes"
2401
- },
2402
- "icon": {
2403
- "type": "string",
2404
- "description": "Preview icon name(As in Base elements) for the capability",
2405
- "example": "email"
2406
- },
2407
- "disabled": {
2408
- "type": "boolean",
2409
- "description": "Whether capability should be disabled"
2410
- },
2411
- "header": {
2412
- "type": "boolean",
2413
- "description": "Specific to Activity pilot"
2414
- },
2415
- "requiredPermission": {
2416
- "type": "object",
2417
- "description": "Require a permission to display UI hook",
2418
- "properties": {
2419
- "action": {
2420
- "type": "string",
2421
- "example": "note:view"
2422
- },
2423
- "resource": {
2424
- "type": "string",
2425
- "example": 123
2426
- }
2427
- },
2428
- "required": [
2429
- "action"
2430
- ]
2431
- }
2432
- },
2433
- "required": [
2434
- "hook"
2435
- ]
2436
- }
2437
- },
2438
- "feature_flag": {
2439
- "type": "string",
2440
- "example": "FF_MY_FEATURE_FLAG",
2441
- "description": "This capability should only be active when the feature flag is enabled"
2442
- },
2443
- "legacy": {
2444
- "type": "boolean",
2445
- "description": "Only show capability for legacy tenants (ivy)"
2446
- }
2447
- },
2448
- "required": [
2449
- "name"
2450
- ]
2451
- },
2452
- "EntityViewConfig": {
2453
- "anyOf": [
2454
- {
2455
- "$ref": "#/components/schemas/EntityDefaultCreate"
2456
- },
2457
- {
2458
- "$ref": "#/components/schemas/EntityDefaultEdit"
2459
- },
2460
- {
2461
- "$ref": "#/components/schemas/EntityDefaultOverview"
2462
- },
2463
- {
2464
- "$ref": "#/components/schemas/RedirectEntityView"
2465
- },
2466
- {
2467
- "$ref": "#/components/schemas/EntityParcelView"
2468
- },
2469
- {
2470
- "$ref": "#/components/schemas/EntityViewDisabled"
2471
- }
2472
- ]
2473
- },
2474
- "EntityViewDisabled": {
2475
- "type": "object",
2476
- "properties": {
2477
- "view_type": {
2478
- "type": "string",
2479
- "enum": [
2480
- "disabled"
2481
- ]
2482
- }
2483
- }
2484
- },
2485
- "EntityDefaultOverview": {
2486
- "type": "object",
2487
- "properties": {
2488
- "view_type": {
2489
- "type": "string",
2490
- "enum": [
2491
- "default"
2492
- ]
2493
- },
2494
- "dropdown_items": {
2495
- "type": "array",
2496
- "items": {
2497
- "allOf": [
2498
- {
2499
- "type": "object",
2500
- "properties": {
2501
- "feature_flag": {
2502
- "type": "string",
2503
- "example": "FF_MY_FEATURE_FLAG",
2504
- "description": "This dropdown item should only be active when the feature flag is enabled"
2505
- },
2506
- "legacy": {
2507
- "type": "boolean",
2508
- "description": "Only show item for legacy tenants (ivy)"
2509
- }
2510
- }
2511
- },
2512
- {
2513
- "oneOf": [
2514
- {
2515
- "type": "object",
2516
- "properties": {
2517
- "type": {
2518
- "type": "string",
2519
- "enum": [
2520
- "entity"
2521
- ]
2522
- },
2523
- "entity": {
2524
- "$ref": "#/components/schemas/EntitySlug"
2525
- }
2526
- }
2527
- },
2528
- {
2529
- "type": "object",
2530
- "properties": {
2531
- "type": {
2532
- "type": "string",
2533
- "enum": [
2534
- "link"
2535
- ]
2536
- },
2537
- "title": {
2538
- "type": "string",
2539
- "example": "Opportunities"
2540
- },
2541
- "uri": {
2542
- "type": "string",
2543
- "format": "uri"
2544
- }
2545
- }
2546
- }
2547
- ]
2548
- }
2549
- ]
2550
- }
2551
- },
2552
- "row_actions": {
2553
- "type": "array",
2554
- "items": {
2555
- "type": "string"
2556
- }
2557
- },
2558
- "classic_view": {
2559
- "type": "string",
2560
- "format": "uri"
2561
- }
2562
- }
2563
- },
2564
- "EntityDefaultCreate": {
2565
- "type": "object",
2566
- "properties": {
2567
- "view_type": {
2568
- "type": "string",
2569
- "enum": [
2570
- "default"
2571
- ]
2572
- }
2573
- }
2574
- },
2575
- "EntityDefaultEdit": {
2576
- "type": "object",
2577
- "properties": {
2578
- "view_type": {
2579
- "type": "string",
2580
- "enum": [
2581
- "default"
2582
- ]
2583
- }
2584
- }
2585
- },
2586
- "RedirectEntityView": {
2587
- "type": "object",
2588
- "properties": {
2589
- "view_type": {
2590
- "type": "string",
2591
- "enum": [
2592
- "redirect"
2593
- ]
2594
- },
2595
- "route": {
2596
- "type": "string",
2597
- "example": "/app/pricing-hub/product/:entityId"
2598
- }
2599
- },
2600
- "example": {
2601
- "type": "redirect",
2602
- "route": "/app/pricing-hub/product/:entityId"
2603
- }
2604
- },
2605
- "EntityParcelView": {
2606
- "type": "object",
2607
- "properties": {
2608
- "view_type": {
2609
- "type": "string",
2610
- "enum": [
2611
- "parcel"
2612
- ]
2613
- },
2614
- "import": {
2615
- "type": "string",
2616
- "example": "@epilot360/pricing-hub-app"
2617
- }
2618
- },
2619
- "example": {
2620
- "type": "redirect",
2621
- "route": "/app/pricing-hub/product/:entityId"
2622
- }
2623
- },
2624
- "EntityId": {
2625
- "type": "string",
2626
- "format": "uuid"
2627
- },
2628
- "BaseEntity": {
2629
- "type": "object",
2630
- "properties": {
2631
- "_id": {
2632
- "$ref": "#/components/schemas/EntityId"
2633
- },
2634
- "_title": {
2635
- "type": "string",
2636
- "description": "Title of entity"
2637
- },
2638
- "_org": {
2639
- "type": "string",
2640
- "description": "Organization Id the entity belongs to"
2641
- },
2642
- "_schema": {
2643
- "$ref": "#/components/schemas/EntitySlug"
2644
- },
2645
- "_tags": {
2646
- "type": "array",
2647
- "items": {
2648
- "type": "string"
2649
- }
2650
- },
2651
- "_created_at": {
2652
- "type": "string",
2653
- "format": "date-time"
2654
- },
2655
- "_updated_at": {
2656
- "type": "string",
2657
- "format": "date-time"
2658
- }
2659
- },
2660
- "required": [
2661
- "_id",
2662
- "_title",
2663
- "_org",
2664
- "_schema",
2665
- "_created_at",
2666
- "_updated_at"
2667
- ],
2668
- "example": {
2669
- "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2670
- "_org": "123",
2671
- "_schema": "contact",
2672
- "_tags": [
2673
- "example",
2674
- "mock"
2675
- ],
2676
- "_created_at": "2021-02-09T12:41:43.662Z",
2677
- "_updated_at": "2021-02-09T12:41:43.662Z"
2678
- }
2679
- },
2680
- "Entity": {
2681
- "type": "object",
2682
- "properties": {},
2683
- "additionalProperties": true
2684
- },
2685
- "HydratedEntity": {
2686
- "type": "object",
2687
- "description": "Entity with relation data resolved into the attribute values",
2688
- "properties": {},
2689
- "additionalProperties": true,
2690
- "example": {
2691
- "status": "active",
2692
- "customer_number": "abc123",
2693
- "email": [
2694
- {
2695
- "label": "work",
2696
- "email": "user@example.com"
2697
- }
2698
- ],
2699
- "phone": [
2700
- {
2701
- "label": "work",
2702
- "phone": "+49123456789"
2703
- }
2704
- ],
2705
- "first_name": "First Name",
2706
- "middle_name": "Middle Name",
2707
- "last_name": "Last Name",
2708
- "date_of_birth": "2019-08-24",
2709
- "title": "Mr.",
2710
- "account": [
2711
- {
2712
- "status": "active",
2713
- "name": "Company name",
2714
- "company_email": [
2715
- {
2716
- "label": "Company email",
2717
- "email": "company@example.com"
2718
- }
2719
- ],
2720
- "company_phone": [
2721
- {
2722
- "label": "Support phone",
2723
- "phone": "+49123456789"
2724
- }
2725
- ],
2726
- "company_website": "https://example.com",
2727
- "tax_id": "DE123456789",
2728
- "tax_exemption": "2019-08-24",
2729
- "contacts": {
2730
- "$relation": [
2731
- {
2732
- "_tags": [
2733
- "CEO"
2734
- ],
2735
- "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2736
- }
2737
- ]
2738
- }
2739
- }
2740
- ]
2741
- }
2742
- },
2743
- "EntityItem": {
2744
- "allOf": [
2745
- {
2746
- "$ref": "#/components/schemas/BaseEntity"
2747
- },
2748
- {
2749
- "$ref": "#/components/schemas/Entity"
2750
- }
2751
- ]
2752
- },
2753
- "HydratedEntityItem": {
2754
- "allOf": [
2755
- {
2756
- "$ref": "#/components/schemas/BaseEntity"
2757
- },
2758
- {
2759
- "$ref": "#/components/schemas/HydratedEntity"
2760
- }
2761
- ]
2762
- },
2763
- "GetRelationsResp": {
2764
- "type": "array",
2765
- "items": {
2766
- "anyOf": [
2767
- {
2768
- "$ref": "#/components/schemas/RelationItem"
2769
- },
2770
- {
2771
- "$ref": "#/components/schemas/RelationEntity"
2772
- }
2773
- ]
2774
- }
2775
- },
2776
- "RelationEntity": {
2777
- "allOf": [
2778
- {
2779
- "$ref": "#/components/schemas/BaseEntity"
2780
- },
2781
- {
2782
- "type": "object",
2783
- "properties": {
2784
- "$relation": {
2785
- "$ref": "#/components/schemas/RelationItem"
2786
- }
2787
- }
2788
- }
2789
- ]
2790
- },
2791
- "RelationItem": {
2792
- "type": "object",
2793
- "properties": {
2794
- "entity_id": {
2795
- "$ref": "#/components/schemas/EntityId"
2796
- },
2797
- "attribute": {
2798
- "type": "string"
2799
- },
2800
- "_tags": {
2801
- "type": "array",
2802
- "items": {
2803
- "type": "string"
2804
- }
2805
- }
2806
- },
2807
- "required": [
2808
- "entity_id",
2809
- "attribute"
2810
- ]
2811
- },
2812
- "EntitySearchParams": {
2813
- "type": "object",
2814
- "properties": {
2815
- "q": {
2816
- "description": "Lucene queries supported with ElasticSearch",
2817
- "type": "string",
2818
- "example": "_schema:contact AND status:active"
2819
- },
2820
- "sort": {
2821
- "type": "string",
2822
- "example": "_created_at:desc"
2823
- },
2824
- "from": {
2825
- "type": "integer",
2826
- "minimum": 0,
2827
- "default": 0
2828
- },
2829
- "size": {
2830
- "type": "integer",
2831
- "minimum": 1,
2832
- "default": 10
2833
- },
2834
- "hydrate": {
2835
- "type": "boolean",
2836
- "description": "When true, enables entity hydration to resolve nested $relation references in-place.",
2837
- "default": false
2838
- },
2839
- "fields": {
2840
- "type": "array",
2841
- "description": "List of entity fields to include in search results",
2842
- "items": {
2843
- "type": "string"
2844
- },
2845
- "example": [
2846
- "_id",
2847
- "_title",
2848
- "first_name"
2849
- ]
2850
- },
2851
- "csv": {
2852
- "type": "boolean",
2853
- "description": "When true, returns the results as a CSV file",
2854
- "default": false
2855
- },
2856
- "schema": {
2857
- "type": "string",
2858
- "description": "Entity schema",
2859
- "example": "contact"
2860
- }
2861
- },
2862
- "required": [
2863
- "q"
2864
- ]
2865
- },
2866
- "EntitySearchResults": {
2867
- "type": "object",
2868
- "properties": {
2869
- "hits": {
2870
- "type": "number",
2871
- "example": 1
2872
- },
2873
- "results": {
2874
- "type": "array",
2875
- "items": {
2876
- "$ref": "#/components/schemas/EntityItem"
2877
- }
2878
- }
2879
- }
2880
- },
2881
- "SearchMappings": {
2882
- "description": "Advanced: explicit Elasticsearch index mapping definitions for entity data\n",
2883
- "example": {
2884
- "image": {
2885
- "type": "keyword",
2886
- "index": false
2887
- }
2888
- },
2889
- "type": "object",
2890
- "additionalProperties": {
2891
- "type": "object",
2892
- "properties": {
2893
- "index": {
2894
- "type": "boolean",
2895
- "default": true
2896
- },
2897
- "type": {
2898
- "type": "string",
2899
- "enum": [
2900
- "keyword",
2901
- "text",
2902
- "boolean",
2903
- "integer",
2904
- "long",
2905
- "float",
2906
- "date",
2907
- "flattened",
2908
- "nested"
2909
- ]
2910
- },
2911
- "fields": {
2912
- "additionalProperties": true
2913
- }
2914
- }
2915
- }
2916
- },
2917
- "ActivityId": {
2918
- "type": "string",
2919
- "format": "ulid",
2920
- "description": "See https://github.com/ulid/spec",
2921
- "example": "01F130Q52Q6MWSNS8N2AVXV4JN"
2922
- },
2923
- "ActivityCallerContext": {
2924
- "type": "object",
2925
- "additionalProperties": true,
2926
- "properties": {
2927
- "EpilotAuth": {
2928
- "type": "object",
2929
- "properties": {
2930
- "token": {
2931
- "type": "object",
2932
- "properties": {
2933
- "sub": {
2934
- "type": "string",
2935
- "example": "476e9b48-42f4-4234-a2b0-4668b34626ce"
2936
- },
2937
- "email": {
2938
- "type": "string",
2939
- "example": "example@epilot.cloud"
2940
- },
2941
- "cognito:username": {
2942
- "type": "string",
2943
- "example": "example@epilot.cloud"
2944
- },
2945
- "custom:ivy_user_id": {
2946
- "type": "string",
2947
- "example": "10006129"
2948
- }
2949
- },
2950
- "example": {
2951
- "sub": "476e9b48-42f4-4234-a2b0-4668b34626ce",
2952
- "cognito:groups": [
2953
- "Administrator"
2954
- ],
2955
- "cognito:preferred_role": "arn:aws:iam::912468240823:role/base-administrator-role",
2956
- "iss": "https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D",
2957
- "custom:ivy_org_id": "739224",
2958
- "cognito:username": "n.ahmad@epilot.cloud",
2959
- "custom:ivy_user_id": "10006129",
2960
- "cognito:roles": [
2961
- "arn:aws:iam::912468240823:role/base-administrator-role"
2962
- ],
2963
- "aud": "6e0jbdnger7nmoktaaflarue1l",
2964
- "event_id": "cd5f5583-d90c-4db5-8e99-5f5dd29a4d75",
2965
- "token_use": "id",
2966
- "auth_time": 1614333023,
2967
- "exp": 1614336623,
2968
- "iat": 1614333023,
2969
- "email": "n.ahmad@epilot.cloud"
2970
- }
2971
- }
2972
- }
2973
- }
2974
- }
2975
- },
2976
- "Activity": {
2977
- "type": "object",
2978
- "properties": {
2979
- "type": {
2980
- "type": "string",
2981
- "example": "MyCustomActivity"
2982
- },
2983
- "title": {
2984
- "type": "string",
2985
- "description": "Title for activity. Supports handlebars syntax.",
2986
- "example": "My custom activity"
2987
- },
2988
- "message": {
2989
- "type": "string",
2990
- "description": "Message for activity. Supports handlebars syntax.",
2991
- "example": "{{caller}} did something with {{entity payload.entity.id}}."
2992
- },
2993
- "payload": {
2994
- "type": "object",
2995
- "properties": {},
2996
- "additionalProperties": true,
2997
- "example": {
2998
- "entity": {
2999
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3000
- "schema": "contact"
3001
- }
3002
- }
3003
- }
3004
- },
3005
- "required": [
3006
- "type",
3007
- "title",
3008
- "message"
3009
- ]
3010
- },
3011
- "EntityOperation": {
3012
- "type": "object",
3013
- "properties": {
3014
- "entity": {
3015
- "$ref": "#/components/schemas/EntityId"
3016
- },
3017
- "org": {
3018
- "type": "string",
3019
- "example": "123"
3020
- },
3021
- "operation": {
3022
- "type": "string",
3023
- "enum": [
3024
- "createEntity",
3025
- "updateEntity",
3026
- "deleteEntity"
3027
- ]
3028
- },
3029
- "params": {
3030
- "type": "object",
3031
- "properties": {
3032
- "id": {
3033
- "$ref": "#/components/schemas/EntityId"
3034
- },
3035
- "slug": {
3036
- "$ref": "#/components/schemas/EntitySlug"
3037
- }
3038
- },
3039
- "example": {
3040
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3041
- "slug": "contact"
3042
- }
3043
- },
3044
- "payload": {
3045
- "allOf": [
3046
- {
3047
- "$ref": "#/components/schemas/Entity"
3048
- },
3049
- {
3050
- "example": {
3051
- "_schema": "contact",
3052
- "_org": "123",
3053
- "status": "Inactive"
3054
- }
3055
- }
3056
- ]
3057
- },
3058
- "diff": {
3059
- "type": "object",
3060
- "properties": {
3061
- "added": {
3062
- "$ref": "#/components/schemas/Entity"
3063
- },
3064
- "updated": {
3065
- "$ref": "#/components/schemas/Entity"
3066
- },
3067
- "deleted": {
3068
- "$ref": "#/components/schemas/Entity"
3069
- }
3070
- }
3071
- }
3072
- },
3073
- "required": [
3074
- "entity",
3075
- "org",
3076
- "operation"
3077
- ]
3078
- },
3079
- "ActivityItem": {
3080
- "allOf": [
3081
- {
3082
- "type": "object",
3083
- "properties": {
3084
- "_id": {
3085
- "$ref": "#/components/schemas/ActivityId"
3086
- },
3087
- "timestamp": {
3088
- "type": "string",
3089
- "format": "date-time"
3090
- }
3091
- }
3092
- },
3093
- {
3094
- "$ref": "#/components/schemas/Activity"
3095
- },
3096
- {
3097
- "type": "object",
3098
- "properties": {
3099
- "caller": {
3100
- "$ref": "#/components/schemas/ActivityCallerContext"
3101
- }
3102
- }
3103
- },
3104
- {
3105
- "type": "object",
3106
- "properties": {
3107
- "operations": {
3108
- "type": "array",
3109
- "items": {
3110
- "$ref": "#/components/schemas/EntityOperation"
3111
- }
3112
- }
3113
- }
3114
- }
3115
- ]
3116
- },
3117
- "BlueprintEntityId": {
3118
- "description": "Reference to blueprint",
3119
- "type": "string",
3120
- "format": "uuid"
3121
- }
3122
- },
3123
- "examples": {
3124
- "TaxEntity": {
3125
- "description": "Example of a Tax Rate entity",
3126
- "value": {
3127
- "active": true,
3128
- "type": "VAT",
3129
- "region": "Germany",
3130
- "region_label": "All Regions",
3131
- "rate": 19,
3132
- "behavior": "Exclusive",
3133
- "description": "MwSt. 19%"
3134
- }
3135
- },
3136
- "ContactEntity": {
3137
- "description": "Example of a contact entity",
3138
- "value": {
3139
- "status": "Active",
3140
- "customer_number": "abc123",
3141
- "first_name": "First",
3142
- "middle_name": "Middle",
3143
- "last_name": "Last",
3144
- "title": "Herr Prof. Dr.",
3145
- "email": [
3146
- {
3147
- "email": "user@example.com",
3148
- "_tags": [
3149
- "work"
3150
- ]
3151
- }
3152
- ],
3153
- "phone": [
3154
- {
3155
- "phone": "+49123456789",
3156
- "_tags": [
3157
- "personal",
3158
- "mobile"
3159
- ]
3160
- }
3161
- ],
3162
- "address": [
3163
- {
3164
- "country": "Germany",
3165
- "city": "Koln",
3166
- "postal_code": 81475,
3167
- "street": "Melatengürtel",
3168
- "street_number": 71,
3169
- "additional_info": "5. Etage",
3170
- "_tags": [
3171
- "billing",
3172
- "delivery"
3173
- ]
3174
- }
3175
- ],
3176
- "birthdate": "2019-08-24",
3177
- "account": {
3178
- "$relation": [
3179
- {
3180
- "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3181
- "_tags": [
3182
- "company"
3183
- ]
3184
- }
3185
- ]
3186
- },
3187
- "consent_email_marketing": {
3188
- "status": "OPTED_IN",
3189
- "events": [
3190
- {
3191
- "type": "OPT_IN",
3192
- "organization_id": "123",
3193
- "created_at": "2021-07-05T09:12:29.352Z",
3194
- "topic": "EMAIL_MARKETING",
3195
- "identifier": "user@example.com",
3196
- "source": "https://consent.sls.epilot.io/optin?token=abc123",
3197
- "meta": {
3198
- "ip_address": "1.1.1.1",
3199
- "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36"
3200
- }
3201
- },
3202
- {
3203
- "type": "DOUBLE_OPT_IN_REQUEST",
3204
- "organization_id": "123",
3205
- "created_at": "2021-07-05T08:12:29.352Z",
3206
- "topic": "EMAIL_MARKETING",
3207
- "identifier": "user@example.com",
3208
- "source": "consent-api",
3209
- "meta": {
3210
- "token": "abc123"
3211
- }
3212
- },
3213
- {
3214
- "type": "OPT_IN",
3215
- "organization_id": "123",
3216
- "created_at": "2021-07-04T09:12:29.352Z",
3217
- "topic": "EMAIL_MARKETING",
3218
- "identifier": "user@example.com",
3219
- "source": "https://frontend.epilot.cloud",
3220
- "meta": {
3221
- "ip_address": "1.1.1.1",
3222
- "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36"
3223
- }
3224
- }
3225
- ]
3226
- }
3227
- }
3228
- },
3229
- "AccountEntity": {
3230
- "description": "Example of an account entity",
3231
- "value": {
3232
- "status": "Active",
3233
- "name": "Example Company",
3234
- "tax_id": "DE123456789",
3235
- "email": [
3236
- {
3237
- "email": "user@example.com",
3238
- "_tags": [
3239
- "work"
3240
- ]
3241
- }
3242
- ],
3243
- "phone": [
3244
- {
3245
- "phone": "+49123456789",
3246
- "_tags": [
3247
- "personal",
3248
- "mobile"
3249
- ]
3250
- }
3251
- ],
3252
- "address": [
3253
- {
3254
- "country": "Germany",
3255
- "city": "Koln",
3256
- "postal_code": 81475,
3257
- "street": "Melatengürtel",
3258
- "street_number": 71,
3259
- "additional_info": "5. Etage",
3260
- "_tags": [
3261
- "billing",
3262
- "delivery"
3263
- ]
3264
- }
3265
- ],
3266
- "website": "http://company.com",
3267
- "tax_exemption": "2021-02-23T09:08:57.320Z",
3268
- "registry_court": "Amtsgericht Köln",
3269
- "registry_number": "HRB 95505",
3270
- "company_size": "50-99",
3271
- "industry": [
3272
- "ecommerce",
3273
- "tech"
3274
- ],
3275
- "annual_revenue": "5000000",
3276
- "contact": {
3277
- "$relation": [
3278
- {
3279
- "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3280
- "_tags": [
3281
- "CEO"
3282
- ]
3283
- }
3284
- ]
3285
- }
3286
- }
3287
- },
3288
- "ProductEntity": {
3289
- "description": "Example of a product entity",
3290
- "value": {
3291
- "code": "SunrockSolar375",
3292
- "type": "Product",
3293
- "name": "Sunrock Solar Panel",
3294
- "description": "Sunrock Solar Panel, provide high capacity power generation even at night.",
3295
- "shippable": "true,",
3296
- "_files": {
3297
- "type": "file",
3298
- "attachments": [
3299
- {
3300
- "key": "f001-32123-asdasd-23213",
3301
- "mime": "application/pdf",
3302
- "name": "wallbox-premium.pdf",
3303
- "size": 6933430,
3304
- "image_url": "https://s3-bucket.epilot.cloud/uid/f001-32123-asdasd-23213",
3305
- "download_url": "https://s3-bucket.epilot.cloud/uid/f001-32123-asdasd-23213"
3306
- }
3307
- ]
3308
- },
3309
- "_images": {
3310
- "type": "image",
3311
- "attachments": [
3312
- {
3313
- "key": "i001-32123-asdasd-23213",
3314
- "mime": "application/pdf",
3315
- "name": "wallbox-premium.pdf",
3316
- "size": 6933430,
3317
- "image_url": "https://s3-bucket.epilot.cloud/uid/f001-32123-asdasd-23213",
3318
- "download_url": "https://s3-bucket.epilot.cloud/uid/f001-32123-asdasd-23213"
3319
- }
3320
- ]
3321
- },
3322
- "prices": {
3323
- "$relation": [
3324
- {
3325
- "entity_id": "a38cca03-18a2-4e9c-8516-0918d81e7830",
3326
- "_tags": [
3327
- "price"
3328
- ]
3329
- },
3330
- {
3331
- "entity_id": "3d10c912-c419-42d7-9270-02b7d05294e5",
3332
- "_tags": [
3333
- "price"
3334
- ]
3335
- }
3336
- ]
3337
- }
3338
- }
3339
- },
3340
- "PriceEntity": {
3341
- "description": "Example of a price entity",
3342
- "value": {
3343
- "code": "MODEL_375KW_PREMIUM",
3344
- "type": "One Time",
3345
- "description": "Solar Panel 375 kWp Premium",
3346
- "billing_scheme": "per_unit",
3347
- "unit_amount": "€ 28500",
3348
- "tiers_mode": "Standard"
3349
- }
3350
- },
3351
- "OrderEntity": {
3352
- "description": "Example of a Order entity",
3353
- "value": {
3354
- "amount_subtotal": 23045,
3355
- "amount_total": 27424,
3356
- "billing_address": [
3357
- {
3358
- "additional_info": "",
3359
- "city": "City",
3360
- "country": "DE",
3361
- "postal_code": "123",
3362
- "street": "Street 1",
3363
- "street_number": "2",
3364
- "_tags": []
3365
- }
3366
- ],
3367
- "billing_company_name": "Epilot",
3368
- "billing_contact": {
3369
- "$relation": [
3370
- {
3371
- "entity_id": "0691f503-5a3c-4e9e-b036-ffb21ea1d284",
3372
- "relationText": "Daniel Test",
3373
- "_schema": "contact",
3374
- "_tags": []
3375
- }
3376
- ]
3377
- },
3378
- "billing_email": "x@email.xyz",
3379
- "billing_first_name": "Paulo",
3380
- "billing_last_name": "Henriques",
3381
- "billing_phone": "00351912611099",
3382
- "billing_vat": "123456789",
3383
- "currency": "EUR",
3384
- "delivery_address": [
3385
- {
3386
- "additional_info": "",
3387
- "city": "City",
3388
- "country": "DE",
3389
- "postal_code": "123",
3390
- "street": "Street 1",
3391
- "street_number": "2",
3392
- "_tags": []
3393
- }
3394
- ],
3395
- "footer_notes": "Footer",
3396
- "line_items": [
3397
- {
3398
- "amount_subtotal": 23045,
3399
- "amount_total": 27424,
3400
- "currency": "EUR",
3401
- "description": "Basic Model - No Wifi",
3402
- "price_id": "efe9ff76-865c-4287-8de9-422cfc741ff9",
3403
- "product_id": "beefa9f1-29a8-448e-94d5-ebf1963428f8",
3404
- "quantity": 1,
3405
- "taxes": [
3406
- {
3407
- "amount": 4379,
3408
- "rate": "standard"
3409
- }
3410
- ],
3411
- "unit_amount": 23045,
3412
- "_price": {
3413
- "active": false,
3414
- "billing_duration_amount": "2",
3415
- "billing_duration_unit": "years",
3416
- "billing_period": "monthly",
3417
- "description": "Basic Model - No Wifi",
3418
- "notice_time_amount": "1",
3419
- "notice_time_unit": "months",
3420
- "price_display_in_journeys": "show_price",
3421
- "renewal_duration_amount": "1",
3422
- "renewal_duration_unit": "years",
3423
- "sales_tax": "standard",
3424
- "tax_behavior": "exclusive",
3425
- "termination_time_amount": "1",
3426
- "termination_time_unit": "months",
3427
- "type": "recurring",
3428
- "unit_amount": 23045,
3429
- "unit_amount_currency": "EUR",
3430
- "unit_amount_decimal": "230.4524",
3431
- "_created_at": "2021-12-15T12:34:59.579Z",
3432
- "_id": "efe9ff76-865c-4287-8de9-422cfc741ff9",
3433
- "_org": "739224",
3434
- "_schema": "price",
3435
- "_tags": [
3436
- "basic-model",
3437
- "wifi"
3438
- ],
3439
- "_title": "Basic Model - No Wifi",
3440
- "_updated_at": "2021-12-31T13:07:51.392Z"
3441
- },
3442
- "_product": {
3443
- "active": true,
3444
- "code": "PWB",
3445
- "feature": [
3446
- {
3447
- "_tags": [],
3448
- "feature": "Pure Energon Fueled"
3449
- },
3450
- {
3451
- "_tags": [],
3452
- "feature": "Mobile App Available"
3453
- }
3454
- ],
3455
- "name": "Pinho Walls in a Box",
3456
- "price_options": {
3457
- "$relation": [
3458
- {
3459
- "entity_id": "efe9ff76-865c-4287-8de9-422cfc741ff9"
3460
- }
3461
- ]
3462
- },
3463
- "type": "product",
3464
- "_created_at": "2021-12-15T12:35:08.438Z",
3465
- "_id": "beefa9f1-29a8-448e-94d5-ebf1963428f8",
3466
- "_org": "739224",
3467
- "_schema": "product",
3468
- "_tags": [
3469
- "energon",
3470
- "eco-friendly",
3471
- "wallbox"
3472
- ],
3473
- "_title": "Pinho Walls in a Box",
3474
- "_updated_at": "2022-01-03T17:14:41.042Z"
3475
- }
3476
- }
3477
- ],
3478
- "memo": "Memo",
3479
- "status": "Paid",
3480
- "total_details": {
3481
- "amount_tax": 4379,
3482
- "breakdown": {
3483
- "recurrences": [
3484
- {
3485
- "amount_subtotal": 23045,
3486
- "amount_tax": 4379,
3487
- "amount_total": 27424,
3488
- "billing_period": "monthly",
3489
- "type": "recurring"
3490
- }
3491
- ],
3492
- "taxes": [
3493
- {
3494
- "amount": 4379,
3495
- "rate": "standard"
3496
- }
3497
- ]
3498
- }
3499
- }
3500
- }
3501
- },
3502
- "OpportunityEntity": {
3503
- "description": "Example of an Opportunity entity",
3504
- "value": {
3505
- "amount_subtotal": 23045,
3506
- "amount_total": 27424,
3507
- "assignees": {
3508
- "$relation": [
3509
- {
3510
- "entity_id": "66a1a6a3-38ee-4ffe-b68d-ee90e3bb1a77",
3511
- "relationText": "Claudius Iohannis",
3512
- "_schema": "contact",
3513
- "_tags": []
3514
- }
3515
- ]
3516
- },
3517
- "billing_address": [
3518
- {
3519
- "additional_info": "",
3520
- "city": "City",
3521
- "country": "DE",
3522
- "postal_code": "123",
3523
- "street": "Street 1",
3524
- "street_number": "2",
3525
- "_tags": []
3526
- }
3527
- ],
3528
- "billing_company_name": "Epilot",
3529
- "billing_contact": {
3530
- "$relation": [
3531
- {
3532
- "entity_id": "0691f503-5a3c-4e9e-b036-ffb21ea1d284",
3533
- "relationText": "Daniel Test",
3534
- "_schema": "contact",
3535
- "_tags": []
3536
- }
3537
- ]
3538
- },
3539
- "billing_email": "customer@email.xyz",
3540
- "billing_first_name": "Customer First Name",
3541
- "billing_last_name": "Customer Last Name",
3542
- "billing_phone": "00351912611098",
3543
- "billing_vat": "123456789",
3544
- "currency": "EUR",
3545
- "delivery_address": [
3546
- {
3547
- "additional_info": "",
3548
- "city": "City",
3549
- "country": "DE",
3550
- "postal_code": "123",
3551
- "street": "Street 1",
3552
- "street_number": "2",
3553
- "_tags": []
3554
- }
3555
- ],
3556
- "line_items": [
3557
- {
3558
- "amount_subtotal": 23045,
3559
- "amount_total": 27424,
3560
- "currency": "EUR",
3561
- "description": "Basic Model - No Wifi",
3562
- "price_id": "efe9ff76-865c-4287-8de9-422cfc741ff9",
3563
- "product_id": "beefa9f1-29a8-448e-94d5-ebf1963428f8",
3564
- "quantity": 1,
3565
- "taxes": [
3566
- {
3567
- "amount": 4379,
3568
- "rate": "standard"
3569
- }
3570
- ],
3571
- "unit_amount": 23045,
3572
- "_price": {
3573
- "active": false,
3574
- "billing_duration_amount": "2",
3575
- "billing_duration_unit": "years",
3576
- "billing_period": "monthly",
3577
- "description": "Basic Model - No Wifi",
3578
- "notice_time_amount": "1",
3579
- "notice_time_unit": "months",
3580
- "price_display_in_journeys": "show_price",
3581
- "renewal_duration_amount": "1",
3582
- "renewal_duration_unit": "years",
3583
- "sales_tax": "standard",
3584
- "tax_behavior": "exclusive",
3585
- "termination_time_amount": "1",
3586
- "termination_time_unit": "months",
3587
- "type": "recurring",
3588
- "unit_amount": 23045,
3589
- "unit_amount_currency": "EUR",
3590
- "unit_amount_decimal": "230.4524",
3591
- "_created_at": "2021-12-15T12:34:59.579Z",
3592
- "_id": "efe9ff76-865c-4287-8de9-422cfc741ff9",
3593
- "_org": "739224",
3594
- "_schema": "price",
3595
- "_tags": [
3596
- "basic-model",
3597
- "wifi"
3598
- ],
3599
- "_title": "Basic Model - No Wifi",
3600
- "_updated_at": "2021-12-31T13:07:51.392Z"
3601
- },
3602
- "_product": {
3603
- "active": true,
3604
- "code": "PWB",
3605
- "feature": [
3606
- {
3607
- "_tags": [],
3608
- "feature": "Pure Energon Fueled"
3609
- },
3610
- {
3611
- "_tags": [],
3612
- "feature": "Mobile App Available"
3613
- }
3614
- ],
3615
- "name": "Pinho Walls in a Box",
3616
- "price_options": {
3617
- "$relation": [
3618
- {
3619
- "entity_id": "efe9ff76-865c-4287-8de9-422cfc741ff9"
3620
- }
3621
- ]
3622
- },
3623
- "type": "product",
3624
- "_created_at": "2021-12-15T12:35:08.438Z",
3625
- "_id": "beefa9f1-29a8-448e-94d5-ebf1963428f8",
3626
- "_org": "739224",
3627
- "_schema": "product",
3628
- "_tags": [
3629
- "energon",
3630
- "eco-friendly",
3631
- "wallbox"
3632
- ],
3633
- "_title": "Pinho Walls in a Box",
3634
- "_updated_at": "2022-01-03T17:14:41.042Z"
3635
- }
3636
- }
3637
- ],
3638
- "opportunity_number": "20220105-768854819",
3639
- "participants": {
3640
- "$relation": [
3641
- {
3642
- "entity_id": "9bbfdaa9-22b2-4100-a256-67600202e3f4",
3643
- "relationText": "Alex Marques",
3644
- "_schema": "contact",
3645
- "_tags": []
3646
- }
3647
- ]
3648
- },
3649
- "status": "Lead",
3650
- "total_details": {
3651
- "amount_tax": 4379,
3652
- "breakdown": {
3653
- "recurrences": [
3654
- {
3655
- "amount_subtotal": 23045,
3656
- "amount_tax": 4379,
3657
- "amount_total": 27424,
3658
- "billing_period": "monthly",
3659
- "type": "recurring"
3660
- }
3661
- ],
3662
- "taxes": [
3663
- {
3664
- "amount": 4379,
3665
- "rate": "standard"
3666
- }
3667
- ]
3668
- }
3669
- }
3670
- }
3671
- },
3672
- "EmailTemplateEntity": {
3673
- "description": "Example of an email template entity",
3674
- "value": {
3675
- "attachments": [],
3676
- "body": "<p fr-original-style=\"caret-color: rgb(65, 65, 65); color: rgb(65, 65, 65); font-family: sans-serif;\" id=\"isPasted\" style=\"caret-color: rgb(65, 65, 65); color: rgb(65, 65, 65); font-family: sans-serif; box-sizing: inherit; border-color: rgba(229, 231, 235, var(--tw-border-opacity));\"><span fr-original-style=\"font-weight: 700;\" style=\"font-weight: 700; box-sizing: inherit; border-color: rgba(229, 231, 235, var(--tw-border-opacity));\">Variablen - Kontakt</span></p>",
3677
- "brand_id": 7066103,
3678
- "from": {
3679
- "name": "Name",
3680
- "email": "admin@email.xyz"
3681
- },
3682
- "name": "PH Test",
3683
- "subject": "Example Subject",
3684
- "system_template": false,
3685
- "to": [
3686
- {
3687
- "id": "1",
3688
- "name": "Contact Name",
3689
- "email": "Contact email"
3690
- }
3691
- ],
3692
- "_tags": [
3693
- "Bestellung"
3694
- ]
3695
- }
3696
- },
3697
- "FileEntity": {
3698
- "description": "Example of a file template entity",
3699
- "value": {
3700
- "access_control": "private",
3701
- "filename": "solar_panel_ph.jpeg",
3702
- "s3ref": {
3703
- "bucket": "epilot-staging-user-content",
3704
- "key": "728/temp/6d450fd1-2d63-435f-b598-c605dfb89cbc/solar_panel_ph.jpeg"
3705
- }
3706
- }
3707
- },
3708
- "WorkflowStepEntity": {
3709
- "description": "Example of a workflow step template entity",
3710
- "value": {
3711
- "name": "Name",
3712
- "assigned_to\"": [
3713
- "10000563"
3714
- ],
3715
- "status": "Unassigned",
3716
- "order": 123,
3717
- "tags": [
3718
- "tag1"
3719
- ]
3720
- }
3721
- },
3722
- "SubmissionEntity": {
3723
- "description": "Example of a submission step template entity",
3724
- "value": {
3725
- "mapped_entities": {
3726
- "$relation": [
3727
- {
3728
- "entity_id": "4ffb071c-2821-4505-86d0-09b801ffd97a",
3729
- "relationText": "4ffb071c-2821-4505-86d0-09b801ffd97a",
3730
- "_schema": "price",
3731
- "_tags": []
3732
- }
3733
- ]
3734
- }
3735
- }
3736
- }
3737
- }
3738
- }
3739
- }