data-primals-engine 1.6.2 → 1.6.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -911
- package/client/package-lock.json +64 -50
- package/client/package.json +6 -0
- package/client/src/App.scss +29 -0
- package/client/src/Dashboard.jsx +1 -1
- package/client/src/WorkflowEditor.jsx +101 -0
- package/client/src/WorkflowEditor.scss +29 -4
- package/client/src/_variables.scss +3 -0
- package/doc/automation-workflows.md +102 -0
- package/doc/core-concepts.md +33 -0
- package/doc/custom-api-endpoints.md +40 -0
- package/doc/dashboards-kpis-charts.md +49 -0
- package/doc/data-management.md +120 -0
- package/doc/data-models.md +75 -0
- package/doc/index.md +14 -0
- package/doc/roles-permissions.md +43 -0
- package/doc/users.md +30 -0
- package/package.json +7 -5
- package/src/client.js +6 -4
- package/src/core.js +31 -12
- package/src/defaultModels +1628 -0
- package/src/defaultModels.js +14 -0
- package/src/filter.js +110 -42
- package/src/modules/data/data.history.js +5 -1
- package/src/modules/data/data.js +2 -1
- package/src/modules/data/data.operations.js +116 -72
- package/src/modules/data/data.relations.js +1 -1
- package/src/modules/mongodb.js +2 -1
- package/src/modules/swagger.js +25 -5
- package/src/modules/user.js +138 -76
- package/src/modules/workflow.js +187 -177
- package/src/providers.js +1 -1
- package/swagger-en.yml +2308 -472
- package/swagger-fr.yml +487 -3
- package/test/core.test.js +341 -0
- package/test/data.history.integration.test.js +140 -16
- package/test/data.integration.test.js +137 -2
- package/test/user.test.js +201 -280
- package/test/workflow.integration.test.js +8 -0
package/swagger-en.yml
CHANGED
|
@@ -4,6 +4,8 @@ info:
|
|
|
4
4
|
description: API for managing custom data, including account verification and generic CRUD operations.
|
|
5
5
|
version: 1.0.0
|
|
6
6
|
servers:
|
|
7
|
+
- url: http://localhost:7633
|
|
8
|
+
description: Local development server
|
|
7
9
|
- url: https://data.primals.net
|
|
8
10
|
description: Production server
|
|
9
11
|
security:
|
|
@@ -204,15 +206,15 @@ paths:
|
|
|
204
206
|
description: "Permission denied to modify this model."
|
|
205
207
|
'404':
|
|
206
208
|
description: "Model not found."
|
|
207
|
-
# --- Generic CRUD
|
|
209
|
+
# --- Generic CRUD endpoints ---
|
|
208
210
|
/api/data/search:
|
|
209
211
|
post:
|
|
210
212
|
tags:
|
|
211
213
|
- Data Management
|
|
212
214
|
consumes:
|
|
213
215
|
- application/json
|
|
214
|
-
summary: "Search
|
|
215
|
-
description: "
|
|
216
|
+
summary: "Search among data"
|
|
217
|
+
description: "Search across all data of the specified model."
|
|
216
218
|
security:
|
|
217
219
|
- BearerAuth: []
|
|
218
220
|
parameters:
|
|
@@ -234,10 +236,10 @@ paths:
|
|
|
234
236
|
schema:
|
|
235
237
|
type: object
|
|
236
238
|
example:
|
|
237
|
-
{ "$and": [ { "lang": { "$
|
|
239
|
+
{ "$and": [ { "lang": { "$eq": [ "$$this.code", "fr" ] } }, { "user": { "$exists": true } } ] }
|
|
238
240
|
- name: sort
|
|
239
241
|
in: query
|
|
240
|
-
description: "
|
|
242
|
+
description: "Sort parameter by field."
|
|
241
243
|
schema:
|
|
242
244
|
type: string
|
|
243
245
|
example: fieldName:ASC;fieldName2:DESC
|
|
@@ -431,7 +433,7 @@ paths:
|
|
|
431
433
|
schema:
|
|
432
434
|
type: object
|
|
433
435
|
example:
|
|
434
|
-
{ "$and": [ { "lang": { "$
|
|
436
|
+
{ "$and": [ { "lang": { "$eq": [ "$$this.code", "fr" ] } }, { "user": { "$exists": true } } ] }
|
|
435
437
|
- name: lang
|
|
436
438
|
in: query
|
|
437
439
|
description: "Language used for error messages."
|
|
@@ -450,7 +452,7 @@ components:
|
|
|
450
452
|
BearerAuth:
|
|
451
453
|
type: http
|
|
452
454
|
scheme: bearer
|
|
453
|
-
bearerFormat: JWT # Assuming JWT
|
|
455
|
+
bearerFormat: JWT # Assuming JWT token usage
|
|
454
456
|
schemas:
|
|
455
457
|
# --- Common Responses ---
|
|
456
458
|
ErrorResponse:
|
|
@@ -471,8 +473,8 @@ components:
|
|
|
471
473
|
message:
|
|
472
474
|
type: string
|
|
473
475
|
example: "Operation successful."
|
|
474
|
-
# --- Model Schemas
|
|
475
|
-
|
|
476
|
+
# --- Model Schemas ---
|
|
477
|
+
userPermission:
|
|
476
478
|
type: object
|
|
477
479
|
properties:
|
|
478
480
|
_id:
|
|
@@ -481,13 +483,13 @@ components:
|
|
|
481
483
|
readOnly: true
|
|
482
484
|
_user:
|
|
483
485
|
type: string
|
|
484
|
-
description: Identifier of the user
|
|
486
|
+
description: Identifier of the user who owns this document
|
|
485
487
|
readOnly: true
|
|
486
488
|
_model:
|
|
487
489
|
type: string
|
|
488
490
|
description: Name of the model this document belongs to
|
|
489
491
|
readOnly: true
|
|
490
|
-
default:
|
|
492
|
+
default: userPermission
|
|
491
493
|
_hash:
|
|
492
494
|
type: number
|
|
493
495
|
description: Document hash for integrity verification
|
|
@@ -496,15 +498,27 @@ components:
|
|
|
496
498
|
type: string
|
|
497
499
|
description: Name of the pack this document belongs to (if applicable)
|
|
498
500
|
readOnly: true
|
|
499
|
-
|
|
501
|
+
user:
|
|
500
502
|
type: string
|
|
501
|
-
description:
|
|
502
|
-
|
|
503
|
+
description: ID of a user document
|
|
504
|
+
permission:
|
|
503
505
|
type: string
|
|
504
|
-
description:
|
|
506
|
+
description: ID of a permission document
|
|
507
|
+
isGranted:
|
|
508
|
+
type: boolean
|
|
509
|
+
description: "True to grant permission, False to explicitly revoke it."
|
|
510
|
+
expiresAt:
|
|
511
|
+
type: string
|
|
512
|
+
format: date-time
|
|
513
|
+
description: "If set, the exception (grant or revocation) is temporary."
|
|
514
|
+
env:
|
|
515
|
+
type: string
|
|
516
|
+
description: ID of a env document
|
|
505
517
|
required:
|
|
506
|
-
-
|
|
507
|
-
|
|
518
|
+
- user
|
|
519
|
+
- permission
|
|
520
|
+
- isGranted
|
|
521
|
+
alert:
|
|
508
522
|
type: object
|
|
509
523
|
properties:
|
|
510
524
|
_id:
|
|
@@ -513,13 +527,13 @@ components:
|
|
|
513
527
|
readOnly: true
|
|
514
528
|
_user:
|
|
515
529
|
type: string
|
|
516
|
-
description: Identifier of the user
|
|
530
|
+
description: Identifier of the user who owns this document
|
|
517
531
|
readOnly: true
|
|
518
532
|
_model:
|
|
519
533
|
type: string
|
|
520
534
|
description: Name of the model this document belongs to
|
|
521
535
|
readOnly: true
|
|
522
|
-
default:
|
|
536
|
+
default: alert
|
|
523
537
|
_hash:
|
|
524
538
|
type: number
|
|
525
539
|
description: Document hash for integrity verification
|
|
@@ -531,14 +545,40 @@ components:
|
|
|
531
545
|
name:
|
|
532
546
|
type: string
|
|
533
547
|
description: ""
|
|
534
|
-
|
|
535
|
-
type:
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
548
|
+
targetModel:
|
|
549
|
+
type: string
|
|
550
|
+
description: ""
|
|
551
|
+
description:
|
|
552
|
+
type: string
|
|
553
|
+
description: ""
|
|
554
|
+
triggerCondition:
|
|
555
|
+
type: string
|
|
556
|
+
format: text
|
|
557
|
+
description: "The condition that, if met, will trigger the alert."
|
|
558
|
+
frequency:
|
|
559
|
+
type: string
|
|
560
|
+
description: "How often to check if the condition is met."
|
|
561
|
+
isActive:
|
|
562
|
+
type: boolean
|
|
563
|
+
default: true
|
|
564
|
+
description: ""
|
|
565
|
+
sendEmail:
|
|
566
|
+
type: boolean
|
|
567
|
+
default: false
|
|
568
|
+
description: "Check to also send email notification."
|
|
569
|
+
lastNotifiedAt:
|
|
570
|
+
type: string
|
|
571
|
+
format: date-time
|
|
572
|
+
description: "Timestamp of the last notification sent for this alert."
|
|
573
|
+
message:
|
|
574
|
+
type: string
|
|
575
|
+
description: "Custom message for email. If empty, a default message will be used. You can use variables {count}, {alert.name}...."
|
|
539
576
|
required:
|
|
540
577
|
- name
|
|
541
|
-
|
|
578
|
+
- targetModel
|
|
579
|
+
- triggerCondition
|
|
580
|
+
- frequency
|
|
581
|
+
env:
|
|
542
582
|
type: object
|
|
543
583
|
properties:
|
|
544
584
|
_id:
|
|
@@ -547,13 +587,13 @@ components:
|
|
|
547
587
|
readOnly: true
|
|
548
588
|
_user:
|
|
549
589
|
type: string
|
|
550
|
-
description: Identifier of the user
|
|
590
|
+
description: Identifier of the user who owns this document
|
|
551
591
|
readOnly: true
|
|
552
592
|
_model:
|
|
553
593
|
type: string
|
|
554
594
|
description: Name of the model this document belongs to
|
|
555
595
|
readOnly: true
|
|
556
|
-
default:
|
|
596
|
+
default: env
|
|
557
597
|
_hash:
|
|
558
598
|
type: number
|
|
559
599
|
description: Document hash for integrity verification
|
|
@@ -562,44 +602,15 @@ components:
|
|
|
562
602
|
type: string
|
|
563
603
|
description: Name of the pack this document belongs to (if applicable)
|
|
564
604
|
readOnly: true
|
|
565
|
-
|
|
566
|
-
type: string
|
|
567
|
-
description: ""
|
|
568
|
-
password:
|
|
605
|
+
name:
|
|
569
606
|
type: string
|
|
570
|
-
format: password
|
|
571
607
|
description: ""
|
|
572
|
-
|
|
608
|
+
value:
|
|
573
609
|
type: string
|
|
574
|
-
enum:
|
|
575
|
-
- male
|
|
576
|
-
- female
|
|
577
|
-
- other
|
|
578
|
-
- prefer_not_to_say
|
|
579
610
|
description: ""
|
|
580
|
-
contact:
|
|
581
|
-
type: string
|
|
582
|
-
description: ID of a contact document
|
|
583
|
-
roles:
|
|
584
|
-
type: array
|
|
585
|
-
items:
|
|
586
|
-
type: string
|
|
587
|
-
description: ID of a role document
|
|
588
|
-
lang:
|
|
589
|
-
type: string
|
|
590
|
-
description: ID of a lang document
|
|
591
|
-
profilePicture:
|
|
592
|
-
type: string
|
|
593
|
-
format: uuid
|
|
594
|
-
description: "Mime types: image/jpeg, image/png."
|
|
595
|
-
tokens:
|
|
596
|
-
type: array
|
|
597
|
-
items:
|
|
598
|
-
type: string
|
|
599
|
-
description: ID of a token document
|
|
600
611
|
required:
|
|
601
|
-
-
|
|
602
|
-
|
|
612
|
+
- name
|
|
613
|
+
kpi:
|
|
603
614
|
type: object
|
|
604
615
|
properties:
|
|
605
616
|
_id:
|
|
@@ -608,13 +619,13 @@ components:
|
|
|
608
619
|
readOnly: true
|
|
609
620
|
_user:
|
|
610
621
|
type: string
|
|
611
|
-
description: Identifier of the user
|
|
622
|
+
description: Identifier of the user who owns this document
|
|
612
623
|
readOnly: true
|
|
613
624
|
_model:
|
|
614
625
|
type: string
|
|
615
626
|
description: Name of the model this document belongs to
|
|
616
627
|
readOnly: true
|
|
617
|
-
default:
|
|
628
|
+
default: kpi
|
|
618
629
|
_hash:
|
|
619
630
|
type: number
|
|
620
631
|
description: Document hash for integrity verification
|
|
@@ -623,24 +634,59 @@ components:
|
|
|
623
634
|
type: string
|
|
624
635
|
description: Name of the pack this document belongs to (if applicable)
|
|
625
636
|
readOnly: true
|
|
626
|
-
|
|
637
|
+
name:
|
|
627
638
|
type: string
|
|
628
|
-
description:
|
|
629
|
-
|
|
639
|
+
description: "Display name of KPI (e.g., Total Revenue)"
|
|
640
|
+
description:
|
|
630
641
|
type: string
|
|
631
|
-
description:
|
|
632
|
-
|
|
642
|
+
description: "Additional information about the KPI"
|
|
643
|
+
targetModel:
|
|
644
|
+
type: string
|
|
645
|
+
description: "Name of the model on which to calculate the KPI (e.g., order)"
|
|
646
|
+
aggregationType:
|
|
647
|
+
type: string
|
|
648
|
+
enum:
|
|
649
|
+
- count
|
|
650
|
+
- sum
|
|
651
|
+
- avg
|
|
652
|
+
- min
|
|
653
|
+
- max
|
|
654
|
+
description: "Type of calculation to perform"
|
|
655
|
+
aggregationField:
|
|
656
|
+
type: string
|
|
657
|
+
description: "Name of the numeric field to apply aggregation to (e.g., totalAmount). Not required for 'count'."
|
|
658
|
+
matchFormula:
|
|
659
|
+
type: string
|
|
660
|
+
format: text
|
|
661
|
+
description: "JSON filter (MongoDB $match) to apply before aggregation (e.g., { \"status\": \"delivered\" })"
|
|
662
|
+
showTotal:
|
|
633
663
|
type: boolean
|
|
634
|
-
description: "
|
|
635
|
-
|
|
664
|
+
description: "Show total"
|
|
665
|
+
showPercentTotal:
|
|
666
|
+
type: boolean
|
|
667
|
+
description: "Show total in %"
|
|
668
|
+
totalMatchFormula:
|
|
636
669
|
type: string
|
|
637
|
-
format:
|
|
638
|
-
description: "
|
|
670
|
+
format: text
|
|
671
|
+
description: "Formula for total (% calculation)"
|
|
672
|
+
unit:
|
|
673
|
+
type: string
|
|
674
|
+
description: "Unit to display (e.g., €, $, users)"
|
|
675
|
+
icon:
|
|
676
|
+
type: string
|
|
677
|
+
description: "Icon name (e.g., FaUsers, FaShoppingCart)"
|
|
678
|
+
order:
|
|
679
|
+
type: number
|
|
680
|
+
description: "Display order on dashboard"
|
|
681
|
+
color:
|
|
682
|
+
type: string
|
|
683
|
+
format: color
|
|
684
|
+
description: "Color associated with KPI"
|
|
639
685
|
required:
|
|
640
|
-
-
|
|
641
|
-
-
|
|
642
|
-
-
|
|
643
|
-
|
|
686
|
+
- name
|
|
687
|
+
- targetModel
|
|
688
|
+
- aggregationType
|
|
689
|
+
imageGallery:
|
|
644
690
|
type: object
|
|
645
691
|
properties:
|
|
646
692
|
_id:
|
|
@@ -649,13 +695,13 @@ components:
|
|
|
649
695
|
readOnly: true
|
|
650
696
|
_user:
|
|
651
697
|
type: string
|
|
652
|
-
description: Identifier of the user
|
|
698
|
+
description: Identifier of the user who owns this document
|
|
653
699
|
readOnly: true
|
|
654
700
|
_model:
|
|
655
701
|
type: string
|
|
656
702
|
description: Name of the model this document belongs to
|
|
657
703
|
readOnly: true
|
|
658
|
-
default:
|
|
704
|
+
default: imageGallery
|
|
659
705
|
_hash:
|
|
660
706
|
type: number
|
|
661
707
|
description: Document hash for integrity verification
|
|
@@ -666,16 +712,28 @@ components:
|
|
|
666
712
|
readOnly: true
|
|
667
713
|
name:
|
|
668
714
|
type: string
|
|
669
|
-
description: ""
|
|
670
|
-
|
|
715
|
+
description: "The name or title of the image gallery."
|
|
716
|
+
images:
|
|
717
|
+
type: array
|
|
718
|
+
items:
|
|
719
|
+
type: string
|
|
720
|
+
format: uuid
|
|
721
|
+
description: "The image files in this gallery."
|
|
722
|
+
description:
|
|
671
723
|
type: string
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
724
|
+
description: "Gallery description (optional)."
|
|
725
|
+
tags:
|
|
726
|
+
type: array
|
|
727
|
+
items:
|
|
728
|
+
type: string
|
|
729
|
+
description: ID of a taxonomy document
|
|
730
|
+
createdAt:
|
|
675
731
|
type: string
|
|
676
732
|
format: date-time
|
|
677
|
-
description: ""
|
|
678
|
-
|
|
733
|
+
description: "Gallery creation date (usually managed by system)."
|
|
734
|
+
required:
|
|
735
|
+
- name
|
|
736
|
+
budget:
|
|
679
737
|
type: object
|
|
680
738
|
properties:
|
|
681
739
|
_id:
|
|
@@ -684,13 +742,13 @@ components:
|
|
|
684
742
|
readOnly: true
|
|
685
743
|
_user:
|
|
686
744
|
type: string
|
|
687
|
-
description: Identifier of the user
|
|
745
|
+
description: Identifier of the user who owns this document
|
|
688
746
|
readOnly: true
|
|
689
747
|
_model:
|
|
690
748
|
type: string
|
|
691
749
|
description: Name of the model this document belongs to
|
|
692
750
|
readOnly: true
|
|
693
|
-
default:
|
|
751
|
+
default: budget
|
|
694
752
|
_hash:
|
|
695
753
|
type: number
|
|
696
754
|
description: Document hash for integrity verification
|
|
@@ -699,20 +757,56 @@ components:
|
|
|
699
757
|
type: string
|
|
700
758
|
description: Name of the pack this document belongs to (if applicable)
|
|
701
759
|
readOnly: true
|
|
702
|
-
|
|
760
|
+
name:
|
|
703
761
|
type: string
|
|
704
|
-
description:
|
|
705
|
-
|
|
762
|
+
description: "Transaction name or description (e.g., Groceries, January Salary)."
|
|
763
|
+
amount:
|
|
764
|
+
type: number
|
|
765
|
+
description: "Transaction amount. Positive for income, negative for expense."
|
|
766
|
+
currency:
|
|
706
767
|
type: string
|
|
707
|
-
|
|
768
|
+
description: ID of a currency document
|
|
769
|
+
transactionDate:
|
|
770
|
+
type: string
|
|
771
|
+
format: date-time
|
|
772
|
+
description: "Date when the transaction occurred."
|
|
773
|
+
description:
|
|
774
|
+
type: string
|
|
775
|
+
description: "Additional notes or details about the transaction."
|
|
776
|
+
paymentMethod:
|
|
777
|
+
type: string
|
|
778
|
+
description: "Payment method used (e.g., Credit Card, Cash, Bank Transfer)."
|
|
779
|
+
category:
|
|
780
|
+
type: string
|
|
781
|
+
description: ID of a taxonomy document
|
|
782
|
+
isRecurring:
|
|
783
|
+
type: boolean
|
|
784
|
+
default: false
|
|
785
|
+
description: "Indicates if this transaction is recurring."
|
|
786
|
+
recurringFrequency:
|
|
787
|
+
type: string
|
|
788
|
+
enum:
|
|
789
|
+
- daily
|
|
790
|
+
- weekly
|
|
791
|
+
- monthly
|
|
792
|
+
- yearly
|
|
708
793
|
description: ""
|
|
709
|
-
|
|
794
|
+
recurringEndDate:
|
|
710
795
|
type: string
|
|
796
|
+
format: date
|
|
711
797
|
description: ""
|
|
798
|
+
attachments:
|
|
799
|
+
type: array
|
|
800
|
+
items:
|
|
801
|
+
type: string
|
|
802
|
+
format: uuid
|
|
803
|
+
description: "Attachments (receipts, invoices)."
|
|
712
804
|
required:
|
|
713
|
-
-
|
|
714
|
-
-
|
|
715
|
-
|
|
805
|
+
- name
|
|
806
|
+
- amount
|
|
807
|
+
- currency
|
|
808
|
+
- transactionDate
|
|
809
|
+
event:
|
|
716
810
|
type: object
|
|
717
811
|
properties:
|
|
718
812
|
_id:
|
|
@@ -721,13 +815,13 @@ components:
|
|
|
721
815
|
readOnly: true
|
|
722
816
|
_user:
|
|
723
817
|
type: string
|
|
724
|
-
description: Identifier of the user
|
|
818
|
+
description: Identifier of the user who owns this document
|
|
725
819
|
readOnly: true
|
|
726
820
|
_model:
|
|
727
821
|
type: string
|
|
728
822
|
description: Name of the model this document belongs to
|
|
729
823
|
readOnly: true
|
|
730
|
-
default:
|
|
824
|
+
default: event
|
|
731
825
|
_hash:
|
|
732
826
|
type: number
|
|
733
827
|
description: Document hash for integrity verification
|
|
@@ -736,15 +830,80 @@ components:
|
|
|
736
830
|
type: string
|
|
737
831
|
description: Name of the pack this document belongs to (if applicable)
|
|
738
832
|
readOnly: true
|
|
739
|
-
|
|
833
|
+
title:
|
|
740
834
|
type: string
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
code:
|
|
835
|
+
description: "The title of the event"
|
|
836
|
+
description:
|
|
744
837
|
type: string
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
838
|
+
description: "A detailed description of the event, including agenda, speakers, and other relevant information."
|
|
839
|
+
startDate:
|
|
840
|
+
type: string
|
|
841
|
+
format: date-time
|
|
842
|
+
description: "The starting date and time of the event"
|
|
843
|
+
endDate:
|
|
844
|
+
type: string
|
|
845
|
+
format: date-time
|
|
846
|
+
description: "The ending date and time of the event"
|
|
847
|
+
location:
|
|
848
|
+
type: string
|
|
849
|
+
description: ID of a location document
|
|
850
|
+
categories:
|
|
851
|
+
type: array
|
|
852
|
+
items:
|
|
853
|
+
type: string
|
|
854
|
+
description: ID of a taxonomy document
|
|
855
|
+
organizer:
|
|
856
|
+
type: string
|
|
857
|
+
description: ID of a contact document
|
|
858
|
+
isOnline:
|
|
859
|
+
type: boolean
|
|
860
|
+
default: false
|
|
861
|
+
description: "Whether the event is online or in-person."
|
|
862
|
+
eventUrl:
|
|
863
|
+
type: string
|
|
864
|
+
format: uri
|
|
865
|
+
description: "A link to the official event webpage or registration page."
|
|
866
|
+
imageUrl:
|
|
867
|
+
type: string
|
|
868
|
+
format: uuid
|
|
869
|
+
description: "URL of the event image or banner."
|
|
870
|
+
status:
|
|
871
|
+
type: string
|
|
872
|
+
enum:
|
|
873
|
+
- scheduled
|
|
874
|
+
- ongoing
|
|
875
|
+
- completed
|
|
876
|
+
- cancelled
|
|
877
|
+
- postponed
|
|
878
|
+
description: "The current status of the event."
|
|
879
|
+
capacity:
|
|
880
|
+
type: number
|
|
881
|
+
description: "The maximum number of attendees allowed for the event."
|
|
882
|
+
price:
|
|
883
|
+
type: number
|
|
884
|
+
description: "The price of admission, if applicable."
|
|
885
|
+
currency:
|
|
886
|
+
type: string
|
|
887
|
+
description: ID of a currency document
|
|
888
|
+
registrationDeadline:
|
|
889
|
+
type: string
|
|
890
|
+
format: date-time
|
|
891
|
+
description: "The date by which attendees must register for the event."
|
|
892
|
+
attendees:
|
|
893
|
+
type: array
|
|
894
|
+
items:
|
|
895
|
+
type: string
|
|
896
|
+
description: ID of a contact document
|
|
897
|
+
sponsors:
|
|
898
|
+
type: array
|
|
899
|
+
items:
|
|
900
|
+
type: string
|
|
901
|
+
description: ID of a contact document
|
|
902
|
+
required:
|
|
903
|
+
- title
|
|
904
|
+
- startDate
|
|
905
|
+
- endDate
|
|
906
|
+
endpoint:
|
|
748
907
|
type: object
|
|
749
908
|
properties:
|
|
750
909
|
_id:
|
|
@@ -753,13 +912,13 @@ components:
|
|
|
753
912
|
readOnly: true
|
|
754
913
|
_user:
|
|
755
914
|
type: string
|
|
756
|
-
description: Identifier of the user
|
|
915
|
+
description: Identifier of the user who owns this document
|
|
757
916
|
readOnly: true
|
|
758
917
|
_model:
|
|
759
918
|
type: string
|
|
760
919
|
description: Name of the model this document belongs to
|
|
761
920
|
readOnly: true
|
|
762
|
-
default:
|
|
921
|
+
default: endpoint
|
|
763
922
|
_hash:
|
|
764
923
|
type: number
|
|
765
924
|
description: Document hash for integrity verification
|
|
@@ -768,29 +927,40 @@ components:
|
|
|
768
927
|
type: string
|
|
769
928
|
description: Name of the pack this document belongs to (if applicable)
|
|
770
929
|
readOnly: true
|
|
771
|
-
|
|
930
|
+
isActive:
|
|
931
|
+
type: boolean
|
|
932
|
+
default: true
|
|
933
|
+
description: "If checked, the endpoint is active and can be called."
|
|
934
|
+
name:
|
|
772
935
|
type: string
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
code:
|
|
936
|
+
description: "A human-readable name to identify the endpoint."
|
|
937
|
+
path:
|
|
776
938
|
type: string
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
name:
|
|
939
|
+
description: "The URL path after /api/actions/ (e.g., 'send-welcome-email'). Do not include '/'."
|
|
940
|
+
method:
|
|
780
941
|
type: string
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
942
|
+
enum:
|
|
943
|
+
- GET
|
|
944
|
+
- POST
|
|
945
|
+
- PUT
|
|
946
|
+
- PATCH
|
|
947
|
+
- DELETE
|
|
948
|
+
description: "The HTTP method required to call this endpoint."
|
|
949
|
+
code:
|
|
950
|
+
type: string
|
|
951
|
+
format: text
|
|
952
|
+
description: "The script to execute. Must return a value or an object that will be the JSON response."
|
|
953
|
+
isPublic:
|
|
786
954
|
type: boolean
|
|
787
955
|
default: false
|
|
788
|
-
description: ""
|
|
956
|
+
description: "If checked, this endpoint will be accessible without authentication."
|
|
789
957
|
required:
|
|
790
|
-
-
|
|
791
|
-
- code
|
|
958
|
+
- isActive
|
|
792
959
|
- name
|
|
793
|
-
|
|
960
|
+
- path
|
|
961
|
+
- method
|
|
962
|
+
- code
|
|
963
|
+
permission:
|
|
794
964
|
type: object
|
|
795
965
|
properties:
|
|
796
966
|
_id:
|
|
@@ -799,13 +969,1557 @@ components:
|
|
|
799
969
|
readOnly: true
|
|
800
970
|
_user:
|
|
801
971
|
type: string
|
|
802
|
-
description: Identifier of the user
|
|
972
|
+
description: Identifier of the user who owns this document
|
|
803
973
|
readOnly: true
|
|
804
974
|
_model:
|
|
805
975
|
type: string
|
|
806
976
|
description: Name of the model this document belongs to
|
|
807
977
|
readOnly: true
|
|
808
|
-
default:
|
|
978
|
+
default: permission
|
|
979
|
+
_hash:
|
|
980
|
+
type: number
|
|
981
|
+
description: Document hash for integrity verification
|
|
982
|
+
readOnly: true
|
|
983
|
+
_pack:
|
|
984
|
+
type: string
|
|
985
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
986
|
+
readOnly: true
|
|
987
|
+
name:
|
|
988
|
+
type: string
|
|
989
|
+
description: ""
|
|
990
|
+
description:
|
|
991
|
+
type: string
|
|
992
|
+
description: ""
|
|
993
|
+
role:
|
|
994
|
+
type: object
|
|
995
|
+
properties:
|
|
996
|
+
_id:
|
|
997
|
+
type: string
|
|
998
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
999
|
+
readOnly: true
|
|
1000
|
+
_user:
|
|
1001
|
+
type: string
|
|
1002
|
+
description: Identifier of the user who owns this document
|
|
1003
|
+
readOnly: true
|
|
1004
|
+
_model:
|
|
1005
|
+
type: string
|
|
1006
|
+
description: Name of the model this document belongs to
|
|
1007
|
+
readOnly: true
|
|
1008
|
+
default: role
|
|
1009
|
+
_hash:
|
|
1010
|
+
type: number
|
|
1011
|
+
description: Document hash for integrity verification
|
|
1012
|
+
readOnly: true
|
|
1013
|
+
_pack:
|
|
1014
|
+
type: string
|
|
1015
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1016
|
+
readOnly: true
|
|
1017
|
+
name:
|
|
1018
|
+
type: string
|
|
1019
|
+
description: ""
|
|
1020
|
+
permissions:
|
|
1021
|
+
type: array
|
|
1022
|
+
items:
|
|
1023
|
+
type: string
|
|
1024
|
+
description: ID of a permission document
|
|
1025
|
+
required:
|
|
1026
|
+
- name
|
|
1027
|
+
user:
|
|
1028
|
+
type: object
|
|
1029
|
+
properties:
|
|
1030
|
+
_id:
|
|
1031
|
+
type: string
|
|
1032
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1033
|
+
readOnly: true
|
|
1034
|
+
_user:
|
|
1035
|
+
type: string
|
|
1036
|
+
description: Identifier of the user who owns this document
|
|
1037
|
+
readOnly: true
|
|
1038
|
+
_model:
|
|
1039
|
+
type: string
|
|
1040
|
+
description: Name of the model this document belongs to
|
|
1041
|
+
readOnly: true
|
|
1042
|
+
default: user
|
|
1043
|
+
_hash:
|
|
1044
|
+
type: number
|
|
1045
|
+
description: Document hash for integrity verification
|
|
1046
|
+
readOnly: true
|
|
1047
|
+
_pack:
|
|
1048
|
+
type: string
|
|
1049
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1050
|
+
readOnly: true
|
|
1051
|
+
username:
|
|
1052
|
+
type: string
|
|
1053
|
+
description: ""
|
|
1054
|
+
password:
|
|
1055
|
+
type: string
|
|
1056
|
+
format: password
|
|
1057
|
+
description: ""
|
|
1058
|
+
gender:
|
|
1059
|
+
type: string
|
|
1060
|
+
enum:
|
|
1061
|
+
- male
|
|
1062
|
+
- female
|
|
1063
|
+
- other
|
|
1064
|
+
- prefer_not_to_say
|
|
1065
|
+
description: ""
|
|
1066
|
+
contact:
|
|
1067
|
+
type: string
|
|
1068
|
+
description: ID of a contact document
|
|
1069
|
+
roles:
|
|
1070
|
+
type: array
|
|
1071
|
+
items:
|
|
1072
|
+
type: string
|
|
1073
|
+
description: ID of a role document
|
|
1074
|
+
lang:
|
|
1075
|
+
type: string
|
|
1076
|
+
description: ID of a lang document
|
|
1077
|
+
profilePicture:
|
|
1078
|
+
type: string
|
|
1079
|
+
format: uuid
|
|
1080
|
+
description: "Mime types: image/jpeg, image/png."
|
|
1081
|
+
tokens:
|
|
1082
|
+
type: array
|
|
1083
|
+
items:
|
|
1084
|
+
type: string
|
|
1085
|
+
description: ID of a token document
|
|
1086
|
+
required:
|
|
1087
|
+
- username
|
|
1088
|
+
token:
|
|
1089
|
+
type: object
|
|
1090
|
+
properties:
|
|
1091
|
+
_id:
|
|
1092
|
+
type: string
|
|
1093
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1094
|
+
readOnly: true
|
|
1095
|
+
_user:
|
|
1096
|
+
type: string
|
|
1097
|
+
description: Identifier of the user who owns this document
|
|
1098
|
+
readOnly: true
|
|
1099
|
+
_model:
|
|
1100
|
+
type: string
|
|
1101
|
+
description: Name of the model this document belongs to
|
|
1102
|
+
readOnly: true
|
|
1103
|
+
default: token
|
|
1104
|
+
_hash:
|
|
1105
|
+
type: number
|
|
1106
|
+
description: Document hash for integrity verification
|
|
1107
|
+
readOnly: true
|
|
1108
|
+
_pack:
|
|
1109
|
+
type: string
|
|
1110
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1111
|
+
readOnly: true
|
|
1112
|
+
name:
|
|
1113
|
+
type: string
|
|
1114
|
+
description: ""
|
|
1115
|
+
value:
|
|
1116
|
+
type: string
|
|
1117
|
+
format: password
|
|
1118
|
+
description: ""
|
|
1119
|
+
lastRefresh:
|
|
1120
|
+
type: string
|
|
1121
|
+
format: date-time
|
|
1122
|
+
description: ""
|
|
1123
|
+
translation:
|
|
1124
|
+
type: object
|
|
1125
|
+
properties:
|
|
1126
|
+
_id:
|
|
1127
|
+
type: string
|
|
1128
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1129
|
+
readOnly: true
|
|
1130
|
+
_user:
|
|
1131
|
+
type: string
|
|
1132
|
+
description: Identifier of the user who owns this document
|
|
1133
|
+
readOnly: true
|
|
1134
|
+
_model:
|
|
1135
|
+
type: string
|
|
1136
|
+
description: Name of the model this document belongs to
|
|
1137
|
+
readOnly: true
|
|
1138
|
+
default: translation
|
|
1139
|
+
_hash:
|
|
1140
|
+
type: number
|
|
1141
|
+
description: Document hash for integrity verification
|
|
1142
|
+
readOnly: true
|
|
1143
|
+
_pack:
|
|
1144
|
+
type: string
|
|
1145
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1146
|
+
readOnly: true
|
|
1147
|
+
lang:
|
|
1148
|
+
type: string
|
|
1149
|
+
description: ID of a lang document
|
|
1150
|
+
key:
|
|
1151
|
+
type: string
|
|
1152
|
+
maxLength: 200
|
|
1153
|
+
description: ""
|
|
1154
|
+
value:
|
|
1155
|
+
type: string
|
|
1156
|
+
description: ""
|
|
1157
|
+
required:
|
|
1158
|
+
- lang
|
|
1159
|
+
- key
|
|
1160
|
+
lang:
|
|
1161
|
+
type: object
|
|
1162
|
+
properties:
|
|
1163
|
+
_id:
|
|
1164
|
+
type: string
|
|
1165
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1166
|
+
readOnly: true
|
|
1167
|
+
_user:
|
|
1168
|
+
type: string
|
|
1169
|
+
description: Identifier of the user who owns this document
|
|
1170
|
+
readOnly: true
|
|
1171
|
+
_model:
|
|
1172
|
+
type: string
|
|
1173
|
+
description: Name of the model this document belongs to
|
|
1174
|
+
readOnly: true
|
|
1175
|
+
default: lang
|
|
1176
|
+
_hash:
|
|
1177
|
+
type: number
|
|
1178
|
+
description: Document hash for integrity verification
|
|
1179
|
+
readOnly: true
|
|
1180
|
+
_pack:
|
|
1181
|
+
type: string
|
|
1182
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1183
|
+
readOnly: true
|
|
1184
|
+
name:
|
|
1185
|
+
type: string
|
|
1186
|
+
maxLength: 200
|
|
1187
|
+
description: ""
|
|
1188
|
+
code:
|
|
1189
|
+
type: string
|
|
1190
|
+
maxLength: 5
|
|
1191
|
+
description: ""
|
|
1192
|
+
currency:
|
|
1193
|
+
type: object
|
|
1194
|
+
properties:
|
|
1195
|
+
_id:
|
|
1196
|
+
type: string
|
|
1197
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1198
|
+
readOnly: true
|
|
1199
|
+
_user:
|
|
1200
|
+
type: string
|
|
1201
|
+
description: Identifier of the user who owns this document
|
|
1202
|
+
readOnly: true
|
|
1203
|
+
_model:
|
|
1204
|
+
type: string
|
|
1205
|
+
description: Name of the model this document belongs to
|
|
1206
|
+
readOnly: true
|
|
1207
|
+
default: currency
|
|
1208
|
+
_hash:
|
|
1209
|
+
type: number
|
|
1210
|
+
description: Document hash for integrity verification
|
|
1211
|
+
readOnly: true
|
|
1212
|
+
_pack:
|
|
1213
|
+
type: string
|
|
1214
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1215
|
+
readOnly: true
|
|
1216
|
+
symbol:
|
|
1217
|
+
type: string
|
|
1218
|
+
maxLength: 5
|
|
1219
|
+
description: ""
|
|
1220
|
+
code:
|
|
1221
|
+
type: string
|
|
1222
|
+
maxLength: 3
|
|
1223
|
+
description: ""
|
|
1224
|
+
name:
|
|
1225
|
+
type: string
|
|
1226
|
+
description: ""
|
|
1227
|
+
exchangeRate:
|
|
1228
|
+
type: number
|
|
1229
|
+
description: ""
|
|
1230
|
+
default:
|
|
1231
|
+
type: boolean
|
|
1232
|
+
default: false
|
|
1233
|
+
description: ""
|
|
1234
|
+
required:
|
|
1235
|
+
- symbol
|
|
1236
|
+
- code
|
|
1237
|
+
- name
|
|
1238
|
+
channel:
|
|
1239
|
+
type: object
|
|
1240
|
+
properties:
|
|
1241
|
+
_id:
|
|
1242
|
+
type: string
|
|
1243
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1244
|
+
readOnly: true
|
|
1245
|
+
_user:
|
|
1246
|
+
type: string
|
|
1247
|
+
description: Identifier of the user who owns this document
|
|
1248
|
+
readOnly: true
|
|
1249
|
+
_model:
|
|
1250
|
+
type: string
|
|
1251
|
+
description: Name of the model this document belongs to
|
|
1252
|
+
readOnly: true
|
|
1253
|
+
default: channel
|
|
1254
|
+
_hash:
|
|
1255
|
+
type: number
|
|
1256
|
+
description: Document hash for integrity verification
|
|
1257
|
+
readOnly: true
|
|
1258
|
+
_pack:
|
|
1259
|
+
type: string
|
|
1260
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1261
|
+
readOnly: true
|
|
1262
|
+
name:
|
|
1263
|
+
type: string
|
|
1264
|
+
description: ""
|
|
1265
|
+
description:
|
|
1266
|
+
type: string
|
|
1267
|
+
description: ""
|
|
1268
|
+
type:
|
|
1269
|
+
type: string
|
|
1270
|
+
enum:
|
|
1271
|
+
- email
|
|
1272
|
+
- SMS
|
|
1273
|
+
- forum
|
|
1274
|
+
- messaging
|
|
1275
|
+
- push
|
|
1276
|
+
- in-app
|
|
1277
|
+
description: ""
|
|
1278
|
+
required:
|
|
1279
|
+
- name
|
|
1280
|
+
- type
|
|
1281
|
+
message:
|
|
1282
|
+
type: object
|
|
1283
|
+
properties:
|
|
1284
|
+
_id:
|
|
1285
|
+
type: string
|
|
1286
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1287
|
+
readOnly: true
|
|
1288
|
+
_user:
|
|
1289
|
+
type: string
|
|
1290
|
+
description: Identifier of the user who owns this document
|
|
1291
|
+
readOnly: true
|
|
1292
|
+
_model:
|
|
1293
|
+
type: string
|
|
1294
|
+
description: Name of the model this document belongs to
|
|
1295
|
+
readOnly: true
|
|
1296
|
+
default: message
|
|
1297
|
+
_hash:
|
|
1298
|
+
type: number
|
|
1299
|
+
description: Document hash for integrity verification
|
|
1300
|
+
readOnly: true
|
|
1301
|
+
_pack:
|
|
1302
|
+
type: string
|
|
1303
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1304
|
+
readOnly: true
|
|
1305
|
+
sender:
|
|
1306
|
+
type: string
|
|
1307
|
+
description: ID of a user document
|
|
1308
|
+
recipient:
|
|
1309
|
+
type: string
|
|
1310
|
+
description: ID of a user document
|
|
1311
|
+
lang:
|
|
1312
|
+
type: string
|
|
1313
|
+
description: ID of a lang document
|
|
1314
|
+
subject:
|
|
1315
|
+
type: string
|
|
1316
|
+
description: ""
|
|
1317
|
+
content:
|
|
1318
|
+
type: string
|
|
1319
|
+
description: ""
|
|
1320
|
+
channels:
|
|
1321
|
+
type: array
|
|
1322
|
+
items:
|
|
1323
|
+
type: string
|
|
1324
|
+
description: ID of a channel document
|
|
1325
|
+
status:
|
|
1326
|
+
type: string
|
|
1327
|
+
enum:
|
|
1328
|
+
- pending
|
|
1329
|
+
- sent
|
|
1330
|
+
- read
|
|
1331
|
+
- failed
|
|
1332
|
+
description: ""
|
|
1333
|
+
sentAt:
|
|
1334
|
+
type: string
|
|
1335
|
+
format: date-time
|
|
1336
|
+
description: ""
|
|
1337
|
+
readAt:
|
|
1338
|
+
type: string
|
|
1339
|
+
format: date-time
|
|
1340
|
+
description: ""
|
|
1341
|
+
type:
|
|
1342
|
+
type: string
|
|
1343
|
+
description: ""
|
|
1344
|
+
priority:
|
|
1345
|
+
type: string
|
|
1346
|
+
enum:
|
|
1347
|
+
- low
|
|
1348
|
+
- medium
|
|
1349
|
+
- high
|
|
1350
|
+
description: ""
|
|
1351
|
+
required:
|
|
1352
|
+
- content
|
|
1353
|
+
webpage:
|
|
1354
|
+
type: object
|
|
1355
|
+
properties:
|
|
1356
|
+
_id:
|
|
1357
|
+
type: string
|
|
1358
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1359
|
+
readOnly: true
|
|
1360
|
+
_user:
|
|
1361
|
+
type: string
|
|
1362
|
+
description: Identifier of the user who owns this document
|
|
1363
|
+
readOnly: true
|
|
1364
|
+
_model:
|
|
1365
|
+
type: string
|
|
1366
|
+
description: Name of the model this document belongs to
|
|
1367
|
+
readOnly: true
|
|
1368
|
+
default: webpage
|
|
1369
|
+
_hash:
|
|
1370
|
+
type: number
|
|
1371
|
+
description: Document hash for integrity verification
|
|
1372
|
+
readOnly: true
|
|
1373
|
+
_pack:
|
|
1374
|
+
type: string
|
|
1375
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1376
|
+
readOnly: true
|
|
1377
|
+
title:
|
|
1378
|
+
type: string
|
|
1379
|
+
description: ""
|
|
1380
|
+
path:
|
|
1381
|
+
type: string
|
|
1382
|
+
description: ""
|
|
1383
|
+
html:
|
|
1384
|
+
type: string
|
|
1385
|
+
description: ""
|
|
1386
|
+
published:
|
|
1387
|
+
type: boolean
|
|
1388
|
+
default: false
|
|
1389
|
+
description: ""
|
|
1390
|
+
inSitemap:
|
|
1391
|
+
type: boolean
|
|
1392
|
+
default: true
|
|
1393
|
+
description: ""
|
|
1394
|
+
description:
|
|
1395
|
+
type: string
|
|
1396
|
+
description: ""
|
|
1397
|
+
keywords:
|
|
1398
|
+
type: array
|
|
1399
|
+
items:
|
|
1400
|
+
type: string
|
|
1401
|
+
description: ID of a taxonomy document
|
|
1402
|
+
image:
|
|
1403
|
+
type: string
|
|
1404
|
+
format: uri
|
|
1405
|
+
description: ""
|
|
1406
|
+
category:
|
|
1407
|
+
type: string
|
|
1408
|
+
description: ID of a taxonomy document
|
|
1409
|
+
required:
|
|
1410
|
+
- title
|
|
1411
|
+
- path
|
|
1412
|
+
content:
|
|
1413
|
+
type: object
|
|
1414
|
+
properties:
|
|
1415
|
+
_id:
|
|
1416
|
+
type: string
|
|
1417
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1418
|
+
readOnly: true
|
|
1419
|
+
_user:
|
|
1420
|
+
type: string
|
|
1421
|
+
description: Identifier of the user who owns this document
|
|
1422
|
+
readOnly: true
|
|
1423
|
+
_model:
|
|
1424
|
+
type: string
|
|
1425
|
+
description: Name of the model this document belongs to
|
|
1426
|
+
readOnly: true
|
|
1427
|
+
default: content
|
|
1428
|
+
_hash:
|
|
1429
|
+
type: number
|
|
1430
|
+
description: Document hash for integrity verification
|
|
1431
|
+
readOnly: true
|
|
1432
|
+
_pack:
|
|
1433
|
+
type: string
|
|
1434
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1435
|
+
readOnly: true
|
|
1436
|
+
lang:
|
|
1437
|
+
type: string
|
|
1438
|
+
description: ID of a lang document
|
|
1439
|
+
title:
|
|
1440
|
+
type: string
|
|
1441
|
+
description: ""
|
|
1442
|
+
slug:
|
|
1443
|
+
type: string
|
|
1444
|
+
description: ""
|
|
1445
|
+
html:
|
|
1446
|
+
type: string
|
|
1447
|
+
description: ""
|
|
1448
|
+
image:
|
|
1449
|
+
type: string
|
|
1450
|
+
format: uuid
|
|
1451
|
+
description: "Mime types: image/jpeg, image/png, image/gif, image/webp."
|
|
1452
|
+
published:
|
|
1453
|
+
type: boolean
|
|
1454
|
+
description: ""
|
|
1455
|
+
publishedAt:
|
|
1456
|
+
type: string
|
|
1457
|
+
format: date-time
|
|
1458
|
+
description: ""
|
|
1459
|
+
author:
|
|
1460
|
+
type: string
|
|
1461
|
+
description: ID of a user document
|
|
1462
|
+
category:
|
|
1463
|
+
type: string
|
|
1464
|
+
description: ID of a taxonomy document
|
|
1465
|
+
keywords:
|
|
1466
|
+
type: array
|
|
1467
|
+
items:
|
|
1468
|
+
type: string
|
|
1469
|
+
description: ID of a taxonomy document
|
|
1470
|
+
order:
|
|
1471
|
+
type: number
|
|
1472
|
+
default: 0
|
|
1473
|
+
description: ""
|
|
1474
|
+
required:
|
|
1475
|
+
- title
|
|
1476
|
+
resource:
|
|
1477
|
+
type: object
|
|
1478
|
+
properties:
|
|
1479
|
+
_id:
|
|
1480
|
+
type: string
|
|
1481
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1482
|
+
readOnly: true
|
|
1483
|
+
_user:
|
|
1484
|
+
type: string
|
|
1485
|
+
description: Identifier of the user who owns this document
|
|
1486
|
+
readOnly: true
|
|
1487
|
+
_model:
|
|
1488
|
+
type: string
|
|
1489
|
+
description: Name of the model this document belongs to
|
|
1490
|
+
readOnly: true
|
|
1491
|
+
default: resource
|
|
1492
|
+
_hash:
|
|
1493
|
+
type: number
|
|
1494
|
+
description: Document hash for integrity verification
|
|
1495
|
+
readOnly: true
|
|
1496
|
+
_pack:
|
|
1497
|
+
type: string
|
|
1498
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1499
|
+
readOnly: true
|
|
1500
|
+
source:
|
|
1501
|
+
type: string
|
|
1502
|
+
format: uri
|
|
1503
|
+
description: ""
|
|
1504
|
+
file:
|
|
1505
|
+
type: string
|
|
1506
|
+
format: uuid
|
|
1507
|
+
description: ""
|
|
1508
|
+
taxonomy:
|
|
1509
|
+
type: object
|
|
1510
|
+
properties:
|
|
1511
|
+
_id:
|
|
1512
|
+
type: string
|
|
1513
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1514
|
+
readOnly: true
|
|
1515
|
+
_user:
|
|
1516
|
+
type: string
|
|
1517
|
+
description: Identifier of the user who owns this document
|
|
1518
|
+
readOnly: true
|
|
1519
|
+
_model:
|
|
1520
|
+
type: string
|
|
1521
|
+
description: Name of the model this document belongs to
|
|
1522
|
+
readOnly: true
|
|
1523
|
+
default: taxonomy
|
|
1524
|
+
_hash:
|
|
1525
|
+
type: number
|
|
1526
|
+
description: Document hash for integrity verification
|
|
1527
|
+
readOnly: true
|
|
1528
|
+
_pack:
|
|
1529
|
+
type: string
|
|
1530
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1531
|
+
readOnly: true
|
|
1532
|
+
name:
|
|
1533
|
+
type: string
|
|
1534
|
+
description: ""
|
|
1535
|
+
parent:
|
|
1536
|
+
type: string
|
|
1537
|
+
description: ID of a taxonomy document
|
|
1538
|
+
type:
|
|
1539
|
+
type: string
|
|
1540
|
+
enum:
|
|
1541
|
+
- keyword
|
|
1542
|
+
- category
|
|
1543
|
+
description: ""
|
|
1544
|
+
identifier:
|
|
1545
|
+
type: string
|
|
1546
|
+
description: ""
|
|
1547
|
+
order:
|
|
1548
|
+
type: number
|
|
1549
|
+
default: 0
|
|
1550
|
+
description: ""
|
|
1551
|
+
description:
|
|
1552
|
+
type: string
|
|
1553
|
+
description: ""
|
|
1554
|
+
required:
|
|
1555
|
+
- name
|
|
1556
|
+
contact:
|
|
1557
|
+
type: object
|
|
1558
|
+
properties:
|
|
1559
|
+
_id:
|
|
1560
|
+
type: string
|
|
1561
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1562
|
+
readOnly: true
|
|
1563
|
+
_user:
|
|
1564
|
+
type: string
|
|
1565
|
+
description: Identifier of the user who owns this document
|
|
1566
|
+
readOnly: true
|
|
1567
|
+
_model:
|
|
1568
|
+
type: string
|
|
1569
|
+
description: Name of the model this document belongs to
|
|
1570
|
+
readOnly: true
|
|
1571
|
+
default: contact
|
|
1572
|
+
_hash:
|
|
1573
|
+
type: number
|
|
1574
|
+
description: Document hash for integrity verification
|
|
1575
|
+
readOnly: true
|
|
1576
|
+
_pack:
|
|
1577
|
+
type: string
|
|
1578
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1579
|
+
readOnly: true
|
|
1580
|
+
legalName:
|
|
1581
|
+
type: string
|
|
1582
|
+
description: ""
|
|
1583
|
+
firstName:
|
|
1584
|
+
type: string
|
|
1585
|
+
description: ""
|
|
1586
|
+
lastName:
|
|
1587
|
+
type: string
|
|
1588
|
+
description: ""
|
|
1589
|
+
email:
|
|
1590
|
+
type: string
|
|
1591
|
+
format: email
|
|
1592
|
+
description: ""
|
|
1593
|
+
phone:
|
|
1594
|
+
type: string
|
|
1595
|
+
description: ""
|
|
1596
|
+
location:
|
|
1597
|
+
type: string
|
|
1598
|
+
description: ID of a location document
|
|
1599
|
+
location:
|
|
1600
|
+
type: object
|
|
1601
|
+
properties:
|
|
1602
|
+
_id:
|
|
1603
|
+
type: string
|
|
1604
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1605
|
+
readOnly: true
|
|
1606
|
+
_user:
|
|
1607
|
+
type: string
|
|
1608
|
+
description: Identifier of the user who owns this document
|
|
1609
|
+
readOnly: true
|
|
1610
|
+
_model:
|
|
1611
|
+
type: string
|
|
1612
|
+
description: Name of the model this document belongs to
|
|
1613
|
+
readOnly: true
|
|
1614
|
+
default: location
|
|
1615
|
+
_hash:
|
|
1616
|
+
type: number
|
|
1617
|
+
description: Document hash for integrity verification
|
|
1618
|
+
readOnly: true
|
|
1619
|
+
_pack:
|
|
1620
|
+
type: string
|
|
1621
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1622
|
+
readOnly: true
|
|
1623
|
+
address_1:
|
|
1624
|
+
type: string
|
|
1625
|
+
description: ""
|
|
1626
|
+
address_2:
|
|
1627
|
+
type: string
|
|
1628
|
+
description: ""
|
|
1629
|
+
address_3:
|
|
1630
|
+
type: string
|
|
1631
|
+
description: ""
|
|
1632
|
+
address_4:
|
|
1633
|
+
type: string
|
|
1634
|
+
description: ""
|
|
1635
|
+
city:
|
|
1636
|
+
type: string
|
|
1637
|
+
description: ""
|
|
1638
|
+
postalCode:
|
|
1639
|
+
type: string
|
|
1640
|
+
description: ""
|
|
1641
|
+
region:
|
|
1642
|
+
type: string
|
|
1643
|
+
description: ""
|
|
1644
|
+
country:
|
|
1645
|
+
type: string
|
|
1646
|
+
description: ""
|
|
1647
|
+
latitude:
|
|
1648
|
+
type: number
|
|
1649
|
+
description: "Unit: °"
|
|
1650
|
+
longitude:
|
|
1651
|
+
type: number
|
|
1652
|
+
description: "Unit: °"
|
|
1653
|
+
brand:
|
|
1654
|
+
type: object
|
|
1655
|
+
properties:
|
|
1656
|
+
_id:
|
|
1657
|
+
type: string
|
|
1658
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1659
|
+
readOnly: true
|
|
1660
|
+
_user:
|
|
1661
|
+
type: string
|
|
1662
|
+
description: Identifier of the user who owns this document
|
|
1663
|
+
readOnly: true
|
|
1664
|
+
_model:
|
|
1665
|
+
type: string
|
|
1666
|
+
description: Name of the model this document belongs to
|
|
1667
|
+
readOnly: true
|
|
1668
|
+
default: brand
|
|
1669
|
+
_hash:
|
|
1670
|
+
type: number
|
|
1671
|
+
description: Document hash for integrity verification
|
|
1672
|
+
readOnly: true
|
|
1673
|
+
_pack:
|
|
1674
|
+
type: string
|
|
1675
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1676
|
+
readOnly: true
|
|
1677
|
+
name:
|
|
1678
|
+
type: string
|
|
1679
|
+
description: ""
|
|
1680
|
+
logo:
|
|
1681
|
+
type: string
|
|
1682
|
+
format: uuid
|
|
1683
|
+
description: ""
|
|
1684
|
+
company:
|
|
1685
|
+
type: string
|
|
1686
|
+
description: ID of a contact document
|
|
1687
|
+
required:
|
|
1688
|
+
- name
|
|
1689
|
+
product:
|
|
1690
|
+
type: object
|
|
1691
|
+
properties:
|
|
1692
|
+
_id:
|
|
1693
|
+
type: string
|
|
1694
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1695
|
+
readOnly: true
|
|
1696
|
+
_user:
|
|
1697
|
+
type: string
|
|
1698
|
+
description: Identifier of the user who owns this document
|
|
1699
|
+
readOnly: true
|
|
1700
|
+
_model:
|
|
1701
|
+
type: string
|
|
1702
|
+
description: Name of the model this document belongs to
|
|
1703
|
+
readOnly: true
|
|
1704
|
+
default: product
|
|
1705
|
+
_hash:
|
|
1706
|
+
type: number
|
|
1707
|
+
description: Document hash for integrity verification
|
|
1708
|
+
readOnly: true
|
|
1709
|
+
_pack:
|
|
1710
|
+
type: string
|
|
1711
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1712
|
+
readOnly: true
|
|
1713
|
+
name:
|
|
1714
|
+
type: string
|
|
1715
|
+
description: ""
|
|
1716
|
+
description:
|
|
1717
|
+
type: string
|
|
1718
|
+
description: ""
|
|
1719
|
+
image:
|
|
1720
|
+
type: array
|
|
1721
|
+
items:
|
|
1722
|
+
type: string
|
|
1723
|
+
format: uuid
|
|
1724
|
+
description: "Mime types: image/jpeg, image/png, image/gif, image/webp."
|
|
1725
|
+
price:
|
|
1726
|
+
type: number
|
|
1727
|
+
description: ""
|
|
1728
|
+
currency:
|
|
1729
|
+
type: string
|
|
1730
|
+
description: ID of a currency document
|
|
1731
|
+
billingFrequency:
|
|
1732
|
+
type: string
|
|
1733
|
+
enum:
|
|
1734
|
+
- none
|
|
1735
|
+
- monthly
|
|
1736
|
+
- yearly
|
|
1737
|
+
description: ""
|
|
1738
|
+
brand:
|
|
1739
|
+
type: string
|
|
1740
|
+
description: ID of a brand document
|
|
1741
|
+
category:
|
|
1742
|
+
type: string
|
|
1743
|
+
description: ID of a taxonomy document
|
|
1744
|
+
required:
|
|
1745
|
+
- name
|
|
1746
|
+
- price
|
|
1747
|
+
- currency
|
|
1748
|
+
productVariant:
|
|
1749
|
+
type: object
|
|
1750
|
+
properties:
|
|
1751
|
+
_id:
|
|
1752
|
+
type: string
|
|
1753
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1754
|
+
readOnly: true
|
|
1755
|
+
_user:
|
|
1756
|
+
type: string
|
|
1757
|
+
description: Identifier of the user who owns this document
|
|
1758
|
+
readOnly: true
|
|
1759
|
+
_model:
|
|
1760
|
+
type: string
|
|
1761
|
+
description: Name of the model this document belongs to
|
|
1762
|
+
readOnly: true
|
|
1763
|
+
default: productVariant
|
|
1764
|
+
_hash:
|
|
1765
|
+
type: number
|
|
1766
|
+
description: Document hash for integrity verification
|
|
1767
|
+
readOnly: true
|
|
1768
|
+
_pack:
|
|
1769
|
+
type: string
|
|
1770
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1771
|
+
readOnly: true
|
|
1772
|
+
product:
|
|
1773
|
+
type: string
|
|
1774
|
+
description: ID of a product document
|
|
1775
|
+
size:
|
|
1776
|
+
type: string
|
|
1777
|
+
description: ""
|
|
1778
|
+
color:
|
|
1779
|
+
type: string
|
|
1780
|
+
description: ""
|
|
1781
|
+
sku:
|
|
1782
|
+
type: string
|
|
1783
|
+
description: ""
|
|
1784
|
+
price:
|
|
1785
|
+
type: number
|
|
1786
|
+
description: ""
|
|
1787
|
+
currency:
|
|
1788
|
+
type: string
|
|
1789
|
+
description: ID of a currency document
|
|
1790
|
+
stock:
|
|
1791
|
+
type: number
|
|
1792
|
+
default: 0
|
|
1793
|
+
description: ""
|
|
1794
|
+
description:
|
|
1795
|
+
type: string
|
|
1796
|
+
description: ""
|
|
1797
|
+
image:
|
|
1798
|
+
type: string
|
|
1799
|
+
format: uri
|
|
1800
|
+
description: ""
|
|
1801
|
+
required:
|
|
1802
|
+
- product
|
|
1803
|
+
- price
|
|
1804
|
+
- currency
|
|
1805
|
+
cart:
|
|
1806
|
+
type: object
|
|
1807
|
+
properties:
|
|
1808
|
+
_id:
|
|
1809
|
+
type: string
|
|
1810
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1811
|
+
readOnly: true
|
|
1812
|
+
_user:
|
|
1813
|
+
type: string
|
|
1814
|
+
description: Identifier of the user who owns this document
|
|
1815
|
+
readOnly: true
|
|
1816
|
+
_model:
|
|
1817
|
+
type: string
|
|
1818
|
+
description: Name of the model this document belongs to
|
|
1819
|
+
readOnly: true
|
|
1820
|
+
default: cart
|
|
1821
|
+
_hash:
|
|
1822
|
+
type: number
|
|
1823
|
+
description: Document hash for integrity verification
|
|
1824
|
+
readOnly: true
|
|
1825
|
+
_pack:
|
|
1826
|
+
type: string
|
|
1827
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1828
|
+
readOnly: true
|
|
1829
|
+
user:
|
|
1830
|
+
type: string
|
|
1831
|
+
description: ID of a user document
|
|
1832
|
+
items:
|
|
1833
|
+
type: array
|
|
1834
|
+
items:
|
|
1835
|
+
type: string
|
|
1836
|
+
description: ID of a cartItem document
|
|
1837
|
+
creationDate:
|
|
1838
|
+
type: string
|
|
1839
|
+
format: date-time
|
|
1840
|
+
description: ""
|
|
1841
|
+
lastUpdate:
|
|
1842
|
+
type: string
|
|
1843
|
+
format: date-time
|
|
1844
|
+
description: ""
|
|
1845
|
+
active:
|
|
1846
|
+
type: boolean
|
|
1847
|
+
default: true
|
|
1848
|
+
description: ""
|
|
1849
|
+
required:
|
|
1850
|
+
- user
|
|
1851
|
+
- creationDate
|
|
1852
|
+
- lastUpdate
|
|
1853
|
+
cartItem:
|
|
1854
|
+
type: object
|
|
1855
|
+
properties:
|
|
1856
|
+
_id:
|
|
1857
|
+
type: string
|
|
1858
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1859
|
+
readOnly: true
|
|
1860
|
+
_user:
|
|
1861
|
+
type: string
|
|
1862
|
+
description: Identifier of the user who owns this document
|
|
1863
|
+
readOnly: true
|
|
1864
|
+
_model:
|
|
1865
|
+
type: string
|
|
1866
|
+
description: Name of the model this document belongs to
|
|
1867
|
+
readOnly: true
|
|
1868
|
+
default: cartItem
|
|
1869
|
+
_hash:
|
|
1870
|
+
type: number
|
|
1871
|
+
description: Document hash for integrity verification
|
|
1872
|
+
readOnly: true
|
|
1873
|
+
_pack:
|
|
1874
|
+
type: string
|
|
1875
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1876
|
+
readOnly: true
|
|
1877
|
+
product:
|
|
1878
|
+
type: string
|
|
1879
|
+
description: ID of a product document
|
|
1880
|
+
quantity:
|
|
1881
|
+
type: number
|
|
1882
|
+
minimum: 1
|
|
1883
|
+
description: ""
|
|
1884
|
+
variant:
|
|
1885
|
+
type: string
|
|
1886
|
+
description: ID of a productVariant document
|
|
1887
|
+
required:
|
|
1888
|
+
- product
|
|
1889
|
+
- quantity
|
|
1890
|
+
discount:
|
|
1891
|
+
type: object
|
|
1892
|
+
properties:
|
|
1893
|
+
_id:
|
|
1894
|
+
type: string
|
|
1895
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1896
|
+
readOnly: true
|
|
1897
|
+
_user:
|
|
1898
|
+
type: string
|
|
1899
|
+
description: Identifier of the user who owns this document
|
|
1900
|
+
readOnly: true
|
|
1901
|
+
_model:
|
|
1902
|
+
type: string
|
|
1903
|
+
description: Name of the model this document belongs to
|
|
1904
|
+
readOnly: true
|
|
1905
|
+
default: discount
|
|
1906
|
+
_hash:
|
|
1907
|
+
type: number
|
|
1908
|
+
description: Document hash for integrity verification
|
|
1909
|
+
readOnly: true
|
|
1910
|
+
_pack:
|
|
1911
|
+
type: string
|
|
1912
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1913
|
+
readOnly: true
|
|
1914
|
+
code:
|
|
1915
|
+
type: string
|
|
1916
|
+
description: ""
|
|
1917
|
+
productSelection:
|
|
1918
|
+
type: array
|
|
1919
|
+
items:
|
|
1920
|
+
type: string
|
|
1921
|
+
description: ID of a product document
|
|
1922
|
+
description:
|
|
1923
|
+
type: string
|
|
1924
|
+
description: ""
|
|
1925
|
+
percentAmount:
|
|
1926
|
+
type: number
|
|
1927
|
+
minimum: 0
|
|
1928
|
+
default: null
|
|
1929
|
+
description: ""
|
|
1930
|
+
fixedAmount:
|
|
1931
|
+
type: number
|
|
1932
|
+
minimum: 0
|
|
1933
|
+
default: null
|
|
1934
|
+
description: ""
|
|
1935
|
+
minAmount:
|
|
1936
|
+
type: number
|
|
1937
|
+
minimum: 0
|
|
1938
|
+
default: null
|
|
1939
|
+
description: "Unit: €"
|
|
1940
|
+
minProductQuantity:
|
|
1941
|
+
type: number
|
|
1942
|
+
minimum: 0
|
|
1943
|
+
description: ""
|
|
1944
|
+
freeProductQuantity:
|
|
1945
|
+
type: number
|
|
1946
|
+
minimum: 0
|
|
1947
|
+
default: null
|
|
1948
|
+
description: ""
|
|
1949
|
+
startDate:
|
|
1950
|
+
type: string
|
|
1951
|
+
format: date-time
|
|
1952
|
+
description: ""
|
|
1953
|
+
endDate:
|
|
1954
|
+
type: string
|
|
1955
|
+
format: date-time
|
|
1956
|
+
description: ""
|
|
1957
|
+
required:
|
|
1958
|
+
- code
|
|
1959
|
+
order:
|
|
1960
|
+
type: object
|
|
1961
|
+
properties:
|
|
1962
|
+
_id:
|
|
1963
|
+
type: string
|
|
1964
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
1965
|
+
readOnly: true
|
|
1966
|
+
_user:
|
|
1967
|
+
type: string
|
|
1968
|
+
description: Identifier of the user who owns this document
|
|
1969
|
+
readOnly: true
|
|
1970
|
+
_model:
|
|
1971
|
+
type: string
|
|
1972
|
+
description: Name of the model this document belongs to
|
|
1973
|
+
readOnly: true
|
|
1974
|
+
default: order
|
|
1975
|
+
_hash:
|
|
1976
|
+
type: number
|
|
1977
|
+
description: Document hash for integrity verification
|
|
1978
|
+
readOnly: true
|
|
1979
|
+
_pack:
|
|
1980
|
+
type: string
|
|
1981
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
1982
|
+
readOnly: true
|
|
1983
|
+
orderId:
|
|
1984
|
+
type: string
|
|
1985
|
+
description: ""
|
|
1986
|
+
orderDate:
|
|
1987
|
+
type: string
|
|
1988
|
+
format: date-time
|
|
1989
|
+
description: ""
|
|
1990
|
+
status:
|
|
1991
|
+
type: string
|
|
1992
|
+
enum:
|
|
1993
|
+
- pending
|
|
1994
|
+
- processing
|
|
1995
|
+
- shipped
|
|
1996
|
+
- delivered
|
|
1997
|
+
- cancelled
|
|
1998
|
+
description: ""
|
|
1999
|
+
products:
|
|
2000
|
+
type: array
|
|
2001
|
+
items:
|
|
2002
|
+
type: string
|
|
2003
|
+
description: ID of a product document
|
|
2004
|
+
customer:
|
|
2005
|
+
type: string
|
|
2006
|
+
description: ID of a user document
|
|
2007
|
+
totalAmount:
|
|
2008
|
+
type: number
|
|
2009
|
+
description: ""
|
|
2010
|
+
currency:
|
|
2011
|
+
type: string
|
|
2012
|
+
description: ID of a currency document
|
|
2013
|
+
paymentMethod:
|
|
2014
|
+
type: string
|
|
2015
|
+
description: ""
|
|
2016
|
+
shippingAddress:
|
|
2017
|
+
type: string
|
|
2018
|
+
description: ID of a location document
|
|
2019
|
+
billingAddress:
|
|
2020
|
+
type: string
|
|
2021
|
+
description: ID of a location document
|
|
2022
|
+
shippedDate:
|
|
2023
|
+
type: string
|
|
2024
|
+
format: date-time
|
|
2025
|
+
description: ""
|
|
2026
|
+
deliveryDate:
|
|
2027
|
+
type: string
|
|
2028
|
+
format: date-time
|
|
2029
|
+
description: ""
|
|
2030
|
+
discount:
|
|
2031
|
+
type: string
|
|
2032
|
+
description: ID of a discount document
|
|
2033
|
+
required:
|
|
2034
|
+
- orderId
|
|
2035
|
+
- products
|
|
2036
|
+
- totalAmount
|
|
2037
|
+
invoice:
|
|
2038
|
+
type: object
|
|
2039
|
+
properties:
|
|
2040
|
+
_id:
|
|
2041
|
+
type: string
|
|
2042
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
2043
|
+
readOnly: true
|
|
2044
|
+
_user:
|
|
2045
|
+
type: string
|
|
2046
|
+
description: Identifier of the user who owns this document
|
|
2047
|
+
readOnly: true
|
|
2048
|
+
_model:
|
|
2049
|
+
type: string
|
|
2050
|
+
description: Name of the model this document belongs to
|
|
2051
|
+
readOnly: true
|
|
2052
|
+
default: invoice
|
|
2053
|
+
_hash:
|
|
2054
|
+
type: number
|
|
2055
|
+
description: Document hash for integrity verification
|
|
2056
|
+
readOnly: true
|
|
2057
|
+
_pack:
|
|
2058
|
+
type: string
|
|
2059
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
2060
|
+
readOnly: true
|
|
2061
|
+
order:
|
|
2062
|
+
type: string
|
|
2063
|
+
description: ID of a order document
|
|
2064
|
+
invoiceId:
|
|
2065
|
+
type: string
|
|
2066
|
+
description: ""
|
|
2067
|
+
invoiceDate:
|
|
2068
|
+
type: string
|
|
2069
|
+
format: date-time
|
|
2070
|
+
description: ""
|
|
2071
|
+
dueDate:
|
|
2072
|
+
type: string
|
|
2073
|
+
format: date-time
|
|
2074
|
+
description: ""
|
|
2075
|
+
status:
|
|
2076
|
+
type: string
|
|
2077
|
+
enum:
|
|
2078
|
+
- paid
|
|
2079
|
+
- unpaid
|
|
2080
|
+
- partially_paid
|
|
2081
|
+
- cancelled
|
|
2082
|
+
description: ""
|
|
2083
|
+
required:
|
|
2084
|
+
- order
|
|
2085
|
+
- invoiceId
|
|
2086
|
+
- invoiceDate
|
|
2087
|
+
userSubscription:
|
|
2088
|
+
type: object
|
|
2089
|
+
properties:
|
|
2090
|
+
_id:
|
|
2091
|
+
type: string
|
|
2092
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
2093
|
+
readOnly: true
|
|
2094
|
+
_user:
|
|
2095
|
+
type: string
|
|
2096
|
+
description: Identifier of the user who owns this document
|
|
2097
|
+
readOnly: true
|
|
2098
|
+
_model:
|
|
2099
|
+
type: string
|
|
2100
|
+
description: Name of the model this document belongs to
|
|
2101
|
+
readOnly: true
|
|
2102
|
+
default: userSubscription
|
|
2103
|
+
_hash:
|
|
2104
|
+
type: number
|
|
2105
|
+
description: Document hash for integrity verification
|
|
2106
|
+
readOnly: true
|
|
2107
|
+
_pack:
|
|
2108
|
+
type: string
|
|
2109
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
2110
|
+
readOnly: true
|
|
2111
|
+
user:
|
|
2112
|
+
type: string
|
|
2113
|
+
description: ID of a user document
|
|
2114
|
+
product:
|
|
2115
|
+
type: string
|
|
2116
|
+
description: ID of a product document
|
|
2117
|
+
startDate:
|
|
2118
|
+
type: string
|
|
2119
|
+
format: date-time
|
|
2120
|
+
description: ""
|
|
2121
|
+
endDate:
|
|
2122
|
+
type: string
|
|
2123
|
+
format: date-time
|
|
2124
|
+
description: ""
|
|
2125
|
+
price:
|
|
2126
|
+
type: number
|
|
2127
|
+
description: ""
|
|
2128
|
+
currency:
|
|
2129
|
+
type: string
|
|
2130
|
+
description: ID of a currency document
|
|
2131
|
+
paymentMethod:
|
|
2132
|
+
type: string
|
|
2133
|
+
enum:
|
|
2134
|
+
- credit_card
|
|
2135
|
+
- SEPA_direct_debit
|
|
2136
|
+
description: ""
|
|
2137
|
+
status:
|
|
2138
|
+
type: string
|
|
2139
|
+
enum:
|
|
2140
|
+
- active
|
|
2141
|
+
- inactive
|
|
2142
|
+
- cancelled
|
|
2143
|
+
- expired
|
|
2144
|
+
- pending
|
|
2145
|
+
description: ""
|
|
2146
|
+
billingCycleAnchor:
|
|
2147
|
+
type: string
|
|
2148
|
+
format: date-time
|
|
2149
|
+
description: ""
|
|
2150
|
+
nextBillingDate:
|
|
2151
|
+
type: string
|
|
2152
|
+
format: date-time
|
|
2153
|
+
description: ""
|
|
2154
|
+
lastBillingDate:
|
|
2155
|
+
type: string
|
|
2156
|
+
format: date-time
|
|
2157
|
+
description: ""
|
|
2158
|
+
cancelReason:
|
|
2159
|
+
type: string
|
|
2160
|
+
description: ""
|
|
2161
|
+
autoRenew:
|
|
2162
|
+
type: boolean
|
|
2163
|
+
default: false
|
|
2164
|
+
description: ""
|
|
2165
|
+
required:
|
|
2166
|
+
- user
|
|
2167
|
+
- product
|
|
2168
|
+
- startDate
|
|
2169
|
+
- price
|
|
2170
|
+
- currency
|
|
2171
|
+
stock:
|
|
2172
|
+
type: object
|
|
2173
|
+
properties:
|
|
2174
|
+
_id:
|
|
2175
|
+
type: string
|
|
2176
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
2177
|
+
readOnly: true
|
|
2178
|
+
_user:
|
|
2179
|
+
type: string
|
|
2180
|
+
description: Identifier of the user who owns this document
|
|
2181
|
+
readOnly: true
|
|
2182
|
+
_model:
|
|
2183
|
+
type: string
|
|
2184
|
+
description: Name of the model this document belongs to
|
|
2185
|
+
readOnly: true
|
|
2186
|
+
default: stock
|
|
2187
|
+
_hash:
|
|
2188
|
+
type: number
|
|
2189
|
+
description: Document hash for integrity verification
|
|
2190
|
+
readOnly: true
|
|
2191
|
+
_pack:
|
|
2192
|
+
type: string
|
|
2193
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
2194
|
+
readOnly: true
|
|
2195
|
+
product:
|
|
2196
|
+
type: string
|
|
2197
|
+
description: ID of a product document
|
|
2198
|
+
variant:
|
|
2199
|
+
type: string
|
|
2200
|
+
description: ID of a productVariant document
|
|
2201
|
+
warehouse:
|
|
2202
|
+
type: string
|
|
2203
|
+
description: ID of a warehouse document
|
|
2204
|
+
available:
|
|
2205
|
+
type: number
|
|
2206
|
+
default: 0
|
|
2207
|
+
description: ""
|
|
2208
|
+
reserved:
|
|
2209
|
+
type: number
|
|
2210
|
+
default: 0
|
|
2211
|
+
description: ""
|
|
2212
|
+
required:
|
|
2213
|
+
- product
|
|
2214
|
+
- warehouse
|
|
2215
|
+
stockAlert:
|
|
2216
|
+
type: object
|
|
2217
|
+
properties:
|
|
2218
|
+
_id:
|
|
2219
|
+
type: string
|
|
2220
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
2221
|
+
readOnly: true
|
|
2222
|
+
_user:
|
|
2223
|
+
type: string
|
|
2224
|
+
description: Identifier of the user who owns this document
|
|
2225
|
+
readOnly: true
|
|
2226
|
+
_model:
|
|
2227
|
+
type: string
|
|
2228
|
+
description: Name of the model this document belongs to
|
|
2229
|
+
readOnly: true
|
|
2230
|
+
default: stockAlert
|
|
2231
|
+
_hash:
|
|
2232
|
+
type: number
|
|
2233
|
+
description: Document hash for integrity verification
|
|
2234
|
+
readOnly: true
|
|
2235
|
+
_pack:
|
|
2236
|
+
type: string
|
|
2237
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
2238
|
+
readOnly: true
|
|
2239
|
+
user:
|
|
2240
|
+
type: string
|
|
2241
|
+
description: ID of a user document
|
|
2242
|
+
stock:
|
|
2243
|
+
type: string
|
|
2244
|
+
description: ID of a stock document
|
|
2245
|
+
threshold:
|
|
2246
|
+
type: number
|
|
2247
|
+
minimum: 0
|
|
2248
|
+
description: ""
|
|
2249
|
+
required:
|
|
2250
|
+
- user
|
|
2251
|
+
- stock
|
|
2252
|
+
- threshold
|
|
2253
|
+
shipment:
|
|
2254
|
+
type: object
|
|
2255
|
+
properties:
|
|
2256
|
+
_id:
|
|
2257
|
+
type: string
|
|
2258
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
2259
|
+
readOnly: true
|
|
2260
|
+
_user:
|
|
2261
|
+
type: string
|
|
2262
|
+
description: Identifier of the user who owns this document
|
|
2263
|
+
readOnly: true
|
|
2264
|
+
_model:
|
|
2265
|
+
type: string
|
|
2266
|
+
description: Name of the model this document belongs to
|
|
2267
|
+
readOnly: true
|
|
2268
|
+
default: shipment
|
|
2269
|
+
_hash:
|
|
2270
|
+
type: number
|
|
2271
|
+
description: Document hash for integrity verification
|
|
2272
|
+
readOnly: true
|
|
2273
|
+
_pack:
|
|
2274
|
+
type: string
|
|
2275
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
2276
|
+
readOnly: true
|
|
2277
|
+
order:
|
|
2278
|
+
type: string
|
|
2279
|
+
description: ID of a order document
|
|
2280
|
+
trackingNumber:
|
|
2281
|
+
type: string
|
|
2282
|
+
description: ""
|
|
2283
|
+
carrier:
|
|
2284
|
+
type: string
|
|
2285
|
+
description: ""
|
|
2286
|
+
status:
|
|
2287
|
+
type: string
|
|
2288
|
+
enum:
|
|
2289
|
+
- pending
|
|
2290
|
+
- in_transit
|
|
2291
|
+
- delivered
|
|
2292
|
+
- issue
|
|
2293
|
+
description: ""
|
|
2294
|
+
estimatedDeliveryDate:
|
|
2295
|
+
type: string
|
|
2296
|
+
format: date-time
|
|
2297
|
+
description: ""
|
|
2298
|
+
actualDeliveryDate:
|
|
2299
|
+
type: string
|
|
2300
|
+
format: date-time
|
|
2301
|
+
description: ""
|
|
2302
|
+
required:
|
|
2303
|
+
- order
|
|
2304
|
+
warehouse:
|
|
2305
|
+
type: object
|
|
2306
|
+
properties:
|
|
2307
|
+
_id:
|
|
2308
|
+
type: string
|
|
2309
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
2310
|
+
readOnly: true
|
|
2311
|
+
_user:
|
|
2312
|
+
type: string
|
|
2313
|
+
description: Identifier of the user who owns this document
|
|
2314
|
+
readOnly: true
|
|
2315
|
+
_model:
|
|
2316
|
+
type: string
|
|
2317
|
+
description: Name of the model this document belongs to
|
|
2318
|
+
readOnly: true
|
|
2319
|
+
default: warehouse
|
|
2320
|
+
_hash:
|
|
2321
|
+
type: number
|
|
2322
|
+
description: Document hash for integrity verification
|
|
2323
|
+
readOnly: true
|
|
2324
|
+
_pack:
|
|
2325
|
+
type: string
|
|
2326
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
2327
|
+
readOnly: true
|
|
2328
|
+
name:
|
|
2329
|
+
type: string
|
|
2330
|
+
description: ""
|
|
2331
|
+
location:
|
|
2332
|
+
type: string
|
|
2333
|
+
description: ID of a location document
|
|
2334
|
+
capacity:
|
|
2335
|
+
type: number
|
|
2336
|
+
description: ""
|
|
2337
|
+
required:
|
|
2338
|
+
- name
|
|
2339
|
+
return:
|
|
2340
|
+
type: object
|
|
2341
|
+
properties:
|
|
2342
|
+
_id:
|
|
2343
|
+
type: string
|
|
2344
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
2345
|
+
readOnly: true
|
|
2346
|
+
_user:
|
|
2347
|
+
type: string
|
|
2348
|
+
description: Identifier of the user who owns this document
|
|
2349
|
+
readOnly: true
|
|
2350
|
+
_model:
|
|
2351
|
+
type: string
|
|
2352
|
+
description: Name of the model this document belongs to
|
|
2353
|
+
readOnly: true
|
|
2354
|
+
default: return
|
|
2355
|
+
_hash:
|
|
2356
|
+
type: number
|
|
2357
|
+
description: Document hash for integrity verification
|
|
2358
|
+
readOnly: true
|
|
2359
|
+
_pack:
|
|
2360
|
+
type: string
|
|
2361
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
2362
|
+
readOnly: true
|
|
2363
|
+
user:
|
|
2364
|
+
type: string
|
|
2365
|
+
description: ID of a user document
|
|
2366
|
+
reason:
|
|
2367
|
+
type: string
|
|
2368
|
+
maxLength: 2048
|
|
2369
|
+
description: ""
|
|
2370
|
+
channel:
|
|
2371
|
+
type: string
|
|
2372
|
+
description: ID of a channel document
|
|
2373
|
+
status:
|
|
2374
|
+
type: string
|
|
2375
|
+
enum:
|
|
2376
|
+
- pending
|
|
2377
|
+
- approved
|
|
2378
|
+
- refunded
|
|
2379
|
+
- refused
|
|
2380
|
+
description: ""
|
|
2381
|
+
amount:
|
|
2382
|
+
type: number
|
|
2383
|
+
minimum: 0
|
|
2384
|
+
description: ""
|
|
2385
|
+
currency:
|
|
2386
|
+
type: string
|
|
2387
|
+
description: ID of a currency document
|
|
2388
|
+
refundDate:
|
|
2389
|
+
type: string
|
|
2390
|
+
format: date-time
|
|
2391
|
+
description: ""
|
|
2392
|
+
required:
|
|
2393
|
+
- reason
|
|
2394
|
+
returnItem:
|
|
2395
|
+
type: object
|
|
2396
|
+
properties:
|
|
2397
|
+
_id:
|
|
2398
|
+
type: string
|
|
2399
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
2400
|
+
readOnly: true
|
|
2401
|
+
_user:
|
|
2402
|
+
type: string
|
|
2403
|
+
description: Identifier of the user who owns this document
|
|
2404
|
+
readOnly: true
|
|
2405
|
+
_model:
|
|
2406
|
+
type: string
|
|
2407
|
+
description: Name of the model this document belongs to
|
|
2408
|
+
readOnly: true
|
|
2409
|
+
default: returnItem
|
|
2410
|
+
_hash:
|
|
2411
|
+
type: number
|
|
2412
|
+
description: Document hash for integrity verification
|
|
2413
|
+
readOnly: true
|
|
2414
|
+
_pack:
|
|
2415
|
+
type: string
|
|
2416
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
2417
|
+
readOnly: true
|
|
2418
|
+
return:
|
|
2419
|
+
type: string
|
|
2420
|
+
description: ID of a return document
|
|
2421
|
+
product:
|
|
2422
|
+
type: string
|
|
2423
|
+
description: ID of a product document
|
|
2424
|
+
variant:
|
|
2425
|
+
type: string
|
|
2426
|
+
description: ID of a productVariant document
|
|
2427
|
+
quantity:
|
|
2428
|
+
type: number
|
|
2429
|
+
minimum: 1
|
|
2430
|
+
description: ""
|
|
2431
|
+
condition:
|
|
2432
|
+
type: string
|
|
2433
|
+
enum:
|
|
2434
|
+
- new
|
|
2435
|
+
- very_good_condition
|
|
2436
|
+
- good_condition
|
|
2437
|
+
- damaged
|
|
2438
|
+
- unusable
|
|
2439
|
+
description: ""
|
|
2440
|
+
required:
|
|
2441
|
+
- return
|
|
2442
|
+
- product
|
|
2443
|
+
- quantity
|
|
2444
|
+
ticket:
|
|
2445
|
+
type: object
|
|
2446
|
+
properties:
|
|
2447
|
+
_id:
|
|
2448
|
+
type: string
|
|
2449
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
2450
|
+
readOnly: true
|
|
2451
|
+
_user:
|
|
2452
|
+
type: string
|
|
2453
|
+
description: Identifier of the user who owns this document
|
|
2454
|
+
readOnly: true
|
|
2455
|
+
_model:
|
|
2456
|
+
type: string
|
|
2457
|
+
description: Name of the model this document belongs to
|
|
2458
|
+
readOnly: true
|
|
2459
|
+
default: ticket
|
|
2460
|
+
_hash:
|
|
2461
|
+
type: number
|
|
2462
|
+
description: Document hash for integrity verification
|
|
2463
|
+
readOnly: true
|
|
2464
|
+
_pack:
|
|
2465
|
+
type: string
|
|
2466
|
+
description: "Name of the pack this document belongs to"
|
|
2467
|
+
order:
|
|
2468
|
+
type: string
|
|
2469
|
+
description: ID of a order document
|
|
2470
|
+
channel:
|
|
2471
|
+
type: string
|
|
2472
|
+
description: ID of a channel document
|
|
2473
|
+
parent:
|
|
2474
|
+
type: string
|
|
2475
|
+
description: ID of a ticket document
|
|
2476
|
+
subject:
|
|
2477
|
+
type: string
|
|
2478
|
+
description: ""
|
|
2479
|
+
message:
|
|
2480
|
+
type: string
|
|
2481
|
+
description: ""
|
|
2482
|
+
status:
|
|
2483
|
+
type: string
|
|
2484
|
+
enum:
|
|
2485
|
+
- open
|
|
2486
|
+
- in_progress
|
|
2487
|
+
- closed
|
|
2488
|
+
priority:
|
|
2489
|
+
type: string
|
|
2490
|
+
enum:
|
|
2491
|
+
- low
|
|
2492
|
+
- medium
|
|
2493
|
+
- high
|
|
2494
|
+
description: ""
|
|
2495
|
+
assignedTo:
|
|
2496
|
+
type: string
|
|
2497
|
+
description: ID of a user document
|
|
2498
|
+
createdAt:
|
|
2499
|
+
type: string
|
|
2500
|
+
format: date-time
|
|
2501
|
+
description: ""
|
|
2502
|
+
required:
|
|
2503
|
+
- user
|
|
2504
|
+
- subject
|
|
2505
|
+
- message
|
|
2506
|
+
- createdAt
|
|
2507
|
+
campaign:
|
|
2508
|
+
type: object
|
|
2509
|
+
properties:
|
|
2510
|
+
_id:
|
|
2511
|
+
type: string
|
|
2512
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
2513
|
+
readOnly: true
|
|
2514
|
+
_user:
|
|
2515
|
+
type: string
|
|
2516
|
+
description: Identifier of the user who owns this document
|
|
2517
|
+
readOnly: true
|
|
2518
|
+
_model:
|
|
2519
|
+
type: string
|
|
2520
|
+
description: Name of the model this document belongs to
|
|
2521
|
+
readOnly: true
|
|
2522
|
+
default: campaign
|
|
809
2523
|
_hash:
|
|
810
2524
|
type: number
|
|
811
2525
|
description: Document hash for integrity verification
|
|
@@ -820,20 +2534,36 @@ components:
|
|
|
820
2534
|
description:
|
|
821
2535
|
type: string
|
|
822
2536
|
description: ""
|
|
2537
|
+
startDate:
|
|
2538
|
+
type: string
|
|
2539
|
+
format: date-time
|
|
2540
|
+
description: ""
|
|
2541
|
+
endDate:
|
|
2542
|
+
type: string
|
|
2543
|
+
format: date-time
|
|
2544
|
+
description: ""
|
|
823
2545
|
type:
|
|
824
2546
|
type: string
|
|
825
2547
|
enum:
|
|
826
2548
|
- email
|
|
827
2549
|
- SMS
|
|
828
|
-
-
|
|
829
|
-
-
|
|
830
|
-
|
|
831
|
-
|
|
2550
|
+
- advertising
|
|
2551
|
+
- promotion
|
|
2552
|
+
description: ""
|
|
2553
|
+
status:
|
|
2554
|
+
type: string
|
|
2555
|
+
enum:
|
|
2556
|
+
- planned
|
|
2557
|
+
- in_progress
|
|
2558
|
+
- completed
|
|
2559
|
+
- cancelled
|
|
2560
|
+
description: ""
|
|
2561
|
+
budget:
|
|
2562
|
+
type: number
|
|
832
2563
|
description: ""
|
|
833
2564
|
required:
|
|
834
2565
|
- name
|
|
835
|
-
|
|
836
|
-
env:
|
|
2566
|
+
review:
|
|
837
2567
|
type: object
|
|
838
2568
|
properties:
|
|
839
2569
|
_id:
|
|
@@ -842,13 +2572,13 @@ components:
|
|
|
842
2572
|
readOnly: true
|
|
843
2573
|
_user:
|
|
844
2574
|
type: string
|
|
845
|
-
description: Identifier of the user
|
|
2575
|
+
description: Identifier of the user who owns this document
|
|
846
2576
|
readOnly: true
|
|
847
2577
|
_model:
|
|
848
2578
|
type: string
|
|
849
2579
|
description: Name of the model this document belongs to
|
|
850
2580
|
readOnly: true
|
|
851
|
-
default:
|
|
2581
|
+
default: review
|
|
852
2582
|
_hash:
|
|
853
2583
|
type: number
|
|
854
2584
|
description: Document hash for integrity verification
|
|
@@ -857,16 +2587,30 @@ components:
|
|
|
857
2587
|
type: string
|
|
858
2588
|
description: Name of the pack this document belongs to (if applicable)
|
|
859
2589
|
readOnly: true
|
|
860
|
-
|
|
2590
|
+
user:
|
|
861
2591
|
type: string
|
|
2592
|
+
description: ID of a user document
|
|
2593
|
+
product:
|
|
2594
|
+
type: string
|
|
2595
|
+
description: ID of a product document
|
|
2596
|
+
productVariant:
|
|
2597
|
+
type: string
|
|
2598
|
+
description: ID of a productVariant document
|
|
2599
|
+
comment:
|
|
2600
|
+
type: string
|
|
2601
|
+
maxLength: 2048
|
|
862
2602
|
description: ""
|
|
863
|
-
|
|
2603
|
+
score:
|
|
2604
|
+
type: number
|
|
2605
|
+
description: ""
|
|
2606
|
+
publishedAt:
|
|
864
2607
|
type: string
|
|
2608
|
+
format: date-time
|
|
865
2609
|
description: ""
|
|
866
2610
|
required:
|
|
867
|
-
-
|
|
868
|
-
-
|
|
869
|
-
|
|
2611
|
+
- comment
|
|
2612
|
+
- publishedAt
|
|
2613
|
+
device:
|
|
870
2614
|
type: object
|
|
871
2615
|
properties:
|
|
872
2616
|
_id:
|
|
@@ -875,13 +2619,13 @@ components:
|
|
|
875
2619
|
readOnly: true
|
|
876
2620
|
_user:
|
|
877
2621
|
type: string
|
|
878
|
-
description: Identifier of the user
|
|
2622
|
+
description: Identifier of the user who owns this document
|
|
879
2623
|
readOnly: true
|
|
880
2624
|
_model:
|
|
881
2625
|
type: string
|
|
882
2626
|
description: Name of the model this document belongs to
|
|
883
2627
|
readOnly: true
|
|
884
|
-
default:
|
|
2628
|
+
default: device
|
|
885
2629
|
_hash:
|
|
886
2630
|
type: number
|
|
887
2631
|
description: Document hash for integrity verification
|
|
@@ -890,55 +2634,61 @@ components:
|
|
|
890
2634
|
type: string
|
|
891
2635
|
description: Name of the pack this document belongs to (if applicable)
|
|
892
2636
|
readOnly: true
|
|
893
|
-
|
|
2637
|
+
location:
|
|
894
2638
|
type: string
|
|
895
|
-
description: ID of a
|
|
896
|
-
|
|
2639
|
+
description: ID of a location document
|
|
2640
|
+
lastLocationUpdate:
|
|
897
2641
|
type: string
|
|
898
|
-
|
|
899
|
-
|
|
2642
|
+
format: date-time
|
|
2643
|
+
description: ""
|
|
2644
|
+
accountingExercise:
|
|
2645
|
+
type: object
|
|
2646
|
+
properties:
|
|
2647
|
+
_id:
|
|
900
2648
|
type: string
|
|
901
|
-
description:
|
|
902
|
-
|
|
2649
|
+
description: Unique document identifier (MongoDB ObjectId)
|
|
2650
|
+
readOnly: true
|
|
2651
|
+
_user:
|
|
903
2652
|
type: string
|
|
904
|
-
description:
|
|
905
|
-
|
|
2653
|
+
description: Identifier of the user who owns this document
|
|
2654
|
+
readOnly: true
|
|
2655
|
+
_model:
|
|
906
2656
|
type: string
|
|
907
|
-
description:
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
2657
|
+
description: Name of the model this document belongs to
|
|
2658
|
+
readOnly: true
|
|
2659
|
+
default: accountingExercise
|
|
2660
|
+
_hash:
|
|
2661
|
+
type: number
|
|
2662
|
+
description: Document hash for integrity verification
|
|
2663
|
+
readOnly: true
|
|
2664
|
+
_pack:
|
|
914
2665
|
type: string
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
- read
|
|
919
|
-
- failed
|
|
920
|
-
description: ""
|
|
921
|
-
sentAt:
|
|
2666
|
+
description: Name of the pack this document belongs to (if applicable)
|
|
2667
|
+
readOnly: true
|
|
2668
|
+
name:
|
|
922
2669
|
type: string
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
readAt:
|
|
2670
|
+
description: Accounting exercise title
|
|
2671
|
+
companyContact:
|
|
926
2672
|
type: string
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
type:
|
|
2673
|
+
description: ID of a contact document. Company designation
|
|
2674
|
+
companyIdentifier:
|
|
930
2675
|
type: string
|
|
931
|
-
description:
|
|
932
|
-
|
|
2676
|
+
description: Company SIRET
|
|
2677
|
+
startDate:
|
|
933
2678
|
type: string
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
2679
|
+
format: date
|
|
2680
|
+
description: Exercise start date
|
|
2681
|
+
endDate:
|
|
2682
|
+
type: string
|
|
2683
|
+
format: date
|
|
2684
|
+
description: Exercise closing date
|
|
939
2685
|
required:
|
|
940
|
-
-
|
|
941
|
-
|
|
2686
|
+
- name
|
|
2687
|
+
- companyContact
|
|
2688
|
+
- companyIdentifier
|
|
2689
|
+
- startDate
|
|
2690
|
+
- endDate
|
|
2691
|
+
accountingLineItem:
|
|
942
2692
|
type: object
|
|
943
2693
|
properties:
|
|
944
2694
|
_id:
|
|
@@ -947,13 +2697,13 @@ components:
|
|
|
947
2697
|
readOnly: true
|
|
948
2698
|
_user:
|
|
949
2699
|
type: string
|
|
950
|
-
description: Identifier of the user
|
|
2700
|
+
description: Identifier of the user who owns this document
|
|
951
2701
|
readOnly: true
|
|
952
2702
|
_model:
|
|
953
2703
|
type: string
|
|
954
2704
|
description: Name of the model this document belongs to
|
|
955
2705
|
readOnly: true
|
|
956
|
-
default:
|
|
2706
|
+
default: accountingLineItem
|
|
957
2707
|
_hash:
|
|
958
2708
|
type: number
|
|
959
2709
|
description: Document hash for integrity verification
|
|
@@ -962,42 +2712,60 @@ components:
|
|
|
962
2712
|
type: string
|
|
963
2713
|
description: Name of the pack this document belongs to (if applicable)
|
|
964
2714
|
readOnly: true
|
|
965
|
-
|
|
2715
|
+
accountingExercise:
|
|
966
2716
|
type: string
|
|
967
|
-
description:
|
|
968
|
-
|
|
969
|
-
type: string
|
|
970
|
-
description: "The name of the model to target."
|
|
971
|
-
description:
|
|
2717
|
+
description: ID of a accountingExercise document
|
|
2718
|
+
code:
|
|
972
2719
|
type: string
|
|
973
|
-
description: ""
|
|
974
|
-
|
|
2720
|
+
description: "Unique line code (e.g., 'AA', 'FB', 'HA')"
|
|
2721
|
+
label:
|
|
975
2722
|
type: string
|
|
976
|
-
description: "
|
|
977
|
-
|
|
2723
|
+
description: "Line label (e.g., 'Establishment expenses')"
|
|
2724
|
+
documentType:
|
|
978
2725
|
type: string
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
2726
|
+
enum:
|
|
2727
|
+
- balance_sheet_asset
|
|
2728
|
+
- balance_sheet_liability
|
|
2729
|
+
- income_statement
|
|
2730
|
+
- fixed_assets
|
|
2731
|
+
- depreciation
|
|
2732
|
+
- provisions
|
|
2733
|
+
- receivables_debts
|
|
2734
|
+
- deficits
|
|
2735
|
+
- capital_gains_losses
|
|
2736
|
+
- workforce_value_added
|
|
2737
|
+
- share_capital
|
|
2738
|
+
- subsidiaries_participations
|
|
2739
|
+
- fiscal_result
|
|
2740
|
+
description: ""
|
|
2741
|
+
section:
|
|
2742
|
+
type: string
|
|
2743
|
+
description: "Main section (e.g., 'FIXED ASSETS')"
|
|
2744
|
+
subSection:
|
|
2745
|
+
type: string
|
|
2746
|
+
description: "Sub-section (e.g., 'INTANGIBLE ASSETS')"
|
|
2747
|
+
order:
|
|
2748
|
+
type: number
|
|
2749
|
+
description: Display order in section/sub-section
|
|
2750
|
+
calculationFormula:
|
|
989
2751
|
type: string
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
2752
|
+
description: Calculation formula (if applicable)
|
|
2753
|
+
values:
|
|
2754
|
+
type: array
|
|
2755
|
+
items:
|
|
2756
|
+
type: number
|
|
2757
|
+
description: Accounting line values
|
|
2758
|
+
notes:
|
|
993
2759
|
type: string
|
|
994
|
-
description: "
|
|
2760
|
+
description: "Notes or references (e.g., '(1)', '(3)')"
|
|
995
2761
|
required:
|
|
996
|
-
-
|
|
997
|
-
-
|
|
998
|
-
-
|
|
999
|
-
-
|
|
1000
|
-
|
|
2762
|
+
- accountingExercise
|
|
2763
|
+
- code
|
|
2764
|
+
- label
|
|
2765
|
+
- documentType
|
|
2766
|
+
- section
|
|
2767
|
+
- values
|
|
2768
|
+
accountingEntry:
|
|
1001
2769
|
type: object
|
|
1002
2770
|
properties:
|
|
1003
2771
|
_id:
|
|
@@ -1006,13 +2774,13 @@ components:
|
|
|
1006
2774
|
readOnly: true
|
|
1007
2775
|
_user:
|
|
1008
2776
|
type: string
|
|
1009
|
-
description: Identifier of the user
|
|
2777
|
+
description: Identifier of the user who owns this document
|
|
1010
2778
|
readOnly: true
|
|
1011
2779
|
_model:
|
|
1012
2780
|
type: string
|
|
1013
2781
|
description: Name of the model this document belongs to
|
|
1014
2782
|
readOnly: true
|
|
1015
|
-
default:
|
|
2783
|
+
default: accountingEntry
|
|
1016
2784
|
_hash:
|
|
1017
2785
|
type: number
|
|
1018
2786
|
description: Document hash for integrity verification
|
|
@@ -1021,42 +2789,61 @@ components:
|
|
|
1021
2789
|
type: string
|
|
1022
2790
|
description: Name of the pack this document belongs to (if applicable)
|
|
1023
2791
|
readOnly: true
|
|
1024
|
-
|
|
2792
|
+
exercise:
|
|
2793
|
+
type: string
|
|
2794
|
+
description: ID of a accountingExercise document
|
|
2795
|
+
label:
|
|
1025
2796
|
type: string
|
|
2797
|
+
maxLength: 255
|
|
1026
2798
|
description: ""
|
|
1027
|
-
|
|
2799
|
+
entryDate:
|
|
1028
2800
|
type: string
|
|
2801
|
+
format: date
|
|
1029
2802
|
description: ""
|
|
1030
|
-
|
|
2803
|
+
amount:
|
|
2804
|
+
type: number
|
|
2805
|
+
default: 0
|
|
2806
|
+
description: ""
|
|
2807
|
+
currency:
|
|
1031
2808
|
type: string
|
|
2809
|
+
description: ID of a currency document
|
|
2810
|
+
referenceNumber:
|
|
2811
|
+
type: string
|
|
2812
|
+
maxLength: 100
|
|
1032
2813
|
description: ""
|
|
1033
|
-
|
|
1034
|
-
type:
|
|
1035
|
-
default: false
|
|
2814
|
+
notes:
|
|
2815
|
+
type: string
|
|
1036
2816
|
description: ""
|
|
1037
|
-
|
|
1038
|
-
type:
|
|
1039
|
-
|
|
2817
|
+
status:
|
|
2818
|
+
type: string
|
|
2819
|
+
enum:
|
|
2820
|
+
- draft
|
|
2821
|
+
- validated
|
|
2822
|
+
- cancelled
|
|
2823
|
+
default: draft
|
|
1040
2824
|
description: ""
|
|
1041
|
-
|
|
2825
|
+
createdBy:
|
|
2826
|
+
type: string
|
|
2827
|
+
description: ID of a user document
|
|
2828
|
+
validatedBy:
|
|
2829
|
+
type: string
|
|
2830
|
+
description: ID of a user document
|
|
2831
|
+
validationDate:
|
|
1042
2832
|
type: string
|
|
2833
|
+
format: date-time
|
|
1043
2834
|
description: ""
|
|
1044
|
-
|
|
2835
|
+
attachments:
|
|
1045
2836
|
type: array
|
|
1046
2837
|
items:
|
|
1047
2838
|
type: string
|
|
1048
|
-
|
|
1049
|
-
image:
|
|
1050
|
-
type: string
|
|
1051
|
-
format: uri
|
|
2839
|
+
format: uuid
|
|
1052
2840
|
description: ""
|
|
1053
|
-
category:
|
|
1054
|
-
type: string
|
|
1055
|
-
description: ID of a taxonomy document
|
|
1056
2841
|
required:
|
|
1057
|
-
-
|
|
1058
|
-
-
|
|
1059
|
-
|
|
2842
|
+
- exercise
|
|
2843
|
+
- label
|
|
2844
|
+
- entryDate
|
|
2845
|
+
- currency
|
|
2846
|
+
employee:
|
|
1060
2847
|
type: object
|
|
1061
2848
|
properties:
|
|
1062
2849
|
_id:
|
|
@@ -1065,13 +2852,13 @@ components:
|
|
|
1065
2852
|
readOnly: true
|
|
1066
2853
|
_user:
|
|
1067
2854
|
type: string
|
|
1068
|
-
description: Identifier of the user
|
|
2855
|
+
description: Identifier of the user who owns this document
|
|
1069
2856
|
readOnly: true
|
|
1070
2857
|
_model:
|
|
1071
2858
|
type: string
|
|
1072
2859
|
description: Name of the model this document belongs to
|
|
1073
2860
|
readOnly: true
|
|
1074
|
-
default:
|
|
2861
|
+
default: employee
|
|
1075
2862
|
_hash:
|
|
1076
2863
|
type: number
|
|
1077
2864
|
description: Document hash for integrity verification
|
|
@@ -1080,127 +2867,119 @@ components:
|
|
|
1080
2867
|
type: string
|
|
1081
2868
|
description: Name of the pack this document belongs to (if applicable)
|
|
1082
2869
|
readOnly: true
|
|
1083
|
-
|
|
2870
|
+
employeeId:
|
|
1084
2871
|
type: string
|
|
1085
|
-
description:
|
|
1086
|
-
|
|
2872
|
+
description: ""
|
|
2873
|
+
personalInfo:
|
|
2874
|
+
type: string
|
|
2875
|
+
description: ID of a user document
|
|
2876
|
+
jobTitle:
|
|
1087
2877
|
type: string
|
|
1088
2878
|
description: ""
|
|
1089
|
-
|
|
2879
|
+
department:
|
|
1090
2880
|
type: string
|
|
1091
2881
|
description: ""
|
|
1092
|
-
|
|
2882
|
+
manager:
|
|
1093
2883
|
type: string
|
|
2884
|
+
description: ID of a employee document
|
|
2885
|
+
workLocation:
|
|
2886
|
+
type: string
|
|
2887
|
+
description: ID of a location document
|
|
2888
|
+
employmentType:
|
|
2889
|
+
type: string
|
|
2890
|
+
enum:
|
|
2891
|
+
- full_time
|
|
2892
|
+
- part_time
|
|
2893
|
+
- contractor
|
|
2894
|
+
- intern
|
|
2895
|
+
- temporary
|
|
1094
2896
|
description: ""
|
|
1095
|
-
|
|
2897
|
+
emergencyContact:
|
|
1096
2898
|
type: string
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
|
|
2899
|
+
description: ID of a contact document
|
|
2900
|
+
homeAddress:
|
|
2901
|
+
type: string
|
|
2902
|
+
description: ID of a location document
|
|
2903
|
+
dateOfBirth:
|
|
2904
|
+
type: string
|
|
2905
|
+
format: date
|
|
1101
2906
|
description: ""
|
|
1102
|
-
|
|
2907
|
+
nationality:
|
|
1103
2908
|
type: string
|
|
1104
|
-
format: date-time
|
|
1105
2909
|
description: ""
|
|
1106
|
-
|
|
2910
|
+
nationalId:
|
|
1107
2911
|
type: string
|
|
1108
|
-
description:
|
|
1109
|
-
|
|
2912
|
+
description: ""
|
|
2913
|
+
socialSecurityNumber:
|
|
1110
2914
|
type: string
|
|
1111
|
-
description: ID of a taxonomy document
|
|
1112
|
-
keywords:
|
|
1113
|
-
type: array
|
|
1114
|
-
items:
|
|
1115
|
-
type: string
|
|
1116
|
-
description: ID of a taxonomy document
|
|
1117
|
-
order:
|
|
1118
|
-
type: number
|
|
1119
|
-
default: 0
|
|
1120
2915
|
description: ""
|
|
1121
|
-
|
|
1122
|
-
- title
|
|
1123
|
-
resource:
|
|
1124
|
-
type: object
|
|
1125
|
-
properties:
|
|
1126
|
-
_id:
|
|
2916
|
+
taxId:
|
|
1127
2917
|
type: string
|
|
1128
|
-
description:
|
|
1129
|
-
|
|
1130
|
-
|
|
2918
|
+
description: ""
|
|
2919
|
+
startDate:
|
|
2920
|
+
type: string
|
|
2921
|
+
format: date
|
|
2922
|
+
description: ""
|
|
2923
|
+
endDate:
|
|
1131
2924
|
type: string
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
2925
|
+
format: date
|
|
2926
|
+
description: ""
|
|
2927
|
+
contractType:
|
|
1135
2928
|
type: string
|
|
1136
|
-
description:
|
|
1137
|
-
|
|
1138
|
-
default: resource
|
|
1139
|
-
_hash:
|
|
2929
|
+
description: ""
|
|
2930
|
+
salary:
|
|
1140
2931
|
type: number
|
|
1141
|
-
description:
|
|
1142
|
-
|
|
1143
|
-
_pack:
|
|
2932
|
+
description: ""
|
|
2933
|
+
salaryCurrency:
|
|
1144
2934
|
type: string
|
|
1145
|
-
description:
|
|
1146
|
-
|
|
1147
|
-
source:
|
|
2935
|
+
description: ID of a currency document
|
|
2936
|
+
payFrequency:
|
|
1148
2937
|
type: string
|
|
1149
|
-
|
|
2938
|
+
enum:
|
|
2939
|
+
- weekly
|
|
2940
|
+
- bi_weekly
|
|
2941
|
+
- monthly
|
|
1150
2942
|
description: ""
|
|
1151
|
-
|
|
2943
|
+
bankAccountNumber:
|
|
1152
2944
|
type: string
|
|
1153
|
-
format: uuid
|
|
1154
2945
|
description: ""
|
|
1155
|
-
|
|
1156
|
-
type: object
|
|
1157
|
-
properties:
|
|
1158
|
-
_id:
|
|
1159
|
-
type: string
|
|
1160
|
-
description: Unique document identifier (MongoDB ObjectId)
|
|
1161
|
-
readOnly: true
|
|
1162
|
-
_user:
|
|
2946
|
+
bankName:
|
|
1163
2947
|
type: string
|
|
1164
|
-
description:
|
|
1165
|
-
|
|
1166
|
-
_model:
|
|
2948
|
+
description: ""
|
|
2949
|
+
iban:
|
|
1167
2950
|
type: string
|
|
1168
|
-
description:
|
|
1169
|
-
|
|
1170
|
-
default: taxonomy
|
|
1171
|
-
_hash:
|
|
1172
|
-
type: number
|
|
1173
|
-
description: Document hash for integrity verification
|
|
1174
|
-
readOnly: true
|
|
1175
|
-
_pack:
|
|
2951
|
+
description: ""
|
|
2952
|
+
swiftBic:
|
|
1176
2953
|
type: string
|
|
1177
|
-
description:
|
|
1178
|
-
|
|
1179
|
-
name:
|
|
2954
|
+
description: ""
|
|
2955
|
+
workPermitNumber:
|
|
1180
2956
|
type: string
|
|
1181
2957
|
description: ""
|
|
1182
|
-
|
|
2958
|
+
workPermitExpiry:
|
|
1183
2959
|
type: string
|
|
1184
|
-
|
|
1185
|
-
|
|
2960
|
+
format: date
|
|
2961
|
+
description: ""
|
|
2962
|
+
visaType:
|
|
1186
2963
|
type: string
|
|
1187
|
-
enum:
|
|
1188
|
-
- keyword
|
|
1189
|
-
- category
|
|
1190
2964
|
description: ""
|
|
1191
|
-
|
|
2965
|
+
visaExpiry:
|
|
1192
2966
|
type: string
|
|
2967
|
+
format: date
|
|
1193
2968
|
description: ""
|
|
1194
|
-
|
|
1195
|
-
type:
|
|
1196
|
-
|
|
2969
|
+
skills:
|
|
2970
|
+
type: array
|
|
2971
|
+
items:
|
|
2972
|
+
type: string
|
|
1197
2973
|
description: ""
|
|
1198
|
-
|
|
2974
|
+
notes:
|
|
1199
2975
|
type: string
|
|
1200
2976
|
description: ""
|
|
1201
2977
|
required:
|
|
1202
|
-
-
|
|
1203
|
-
|
|
2978
|
+
- employeeId
|
|
2979
|
+
- personalInfo
|
|
2980
|
+
- jobTitle
|
|
2981
|
+
- startDate
|
|
2982
|
+
workflow:
|
|
1204
2983
|
type: object
|
|
1205
2984
|
properties:
|
|
1206
2985
|
_id:
|
|
@@ -1209,13 +2988,13 @@ components:
|
|
|
1209
2988
|
readOnly: true
|
|
1210
2989
|
_user:
|
|
1211
2990
|
type: string
|
|
1212
|
-
description: Identifier of the user
|
|
2991
|
+
description: Identifier of the user who owns this document
|
|
1213
2992
|
readOnly: true
|
|
1214
2993
|
_model:
|
|
1215
2994
|
type: string
|
|
1216
2995
|
description: Name of the model this document belongs to
|
|
1217
2996
|
readOnly: true
|
|
1218
|
-
default:
|
|
2997
|
+
default: workflow
|
|
1219
2998
|
_hash:
|
|
1220
2999
|
type: number
|
|
1221
3000
|
description: Document hash for integrity verification
|
|
@@ -1224,26 +3003,18 @@ components:
|
|
|
1224
3003
|
type: string
|
|
1225
3004
|
description: Name of the pack this document belongs to (if applicable)
|
|
1226
3005
|
readOnly: true
|
|
1227
|
-
|
|
1228
|
-
type: string
|
|
1229
|
-
description: ""
|
|
1230
|
-
firstName:
|
|
1231
|
-
type: string
|
|
1232
|
-
description: ""
|
|
1233
|
-
lastName:
|
|
1234
|
-
type: string
|
|
1235
|
-
description: ""
|
|
1236
|
-
email:
|
|
3006
|
+
name:
|
|
1237
3007
|
type: string
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
phone:
|
|
3008
|
+
description: "Unique name for the workflow (e.g., 'Order Validation', 'Low Stock Notification')."
|
|
3009
|
+
description:
|
|
1241
3010
|
type: string
|
|
1242
|
-
description: ""
|
|
1243
|
-
|
|
3011
|
+
description: "Detailed explanation of the workflow's purpose."
|
|
3012
|
+
startStep:
|
|
1244
3013
|
type: string
|
|
1245
|
-
description: ID of a
|
|
1246
|
-
|
|
3014
|
+
description: "ID of a workflowStep document. The first step to execute when the workflow starts."
|
|
3015
|
+
required:
|
|
3016
|
+
- name
|
|
3017
|
+
workflowTrigger:
|
|
1247
3018
|
type: object
|
|
1248
3019
|
properties:
|
|
1249
3020
|
_id:
|
|
@@ -1252,13 +3023,13 @@ components:
|
|
|
1252
3023
|
readOnly: true
|
|
1253
3024
|
_user:
|
|
1254
3025
|
type: string
|
|
1255
|
-
description: Identifier of the user
|
|
3026
|
+
description: Identifier of the user who owns this document
|
|
1256
3027
|
readOnly: true
|
|
1257
3028
|
_model:
|
|
1258
3029
|
type: string
|
|
1259
3030
|
description: Name of the model this document belongs to
|
|
1260
3031
|
readOnly: true
|
|
1261
|
-
default:
|
|
3032
|
+
default: workflowTrigger
|
|
1262
3033
|
_hash:
|
|
1263
3034
|
type: number
|
|
1264
3035
|
description: Document hash for integrity verification
|
|
@@ -1267,37 +3038,52 @@ components:
|
|
|
1267
3038
|
type: string
|
|
1268
3039
|
description: Name of the pack this document belongs to (if applicable)
|
|
1269
3040
|
readOnly: true
|
|
1270
|
-
|
|
3041
|
+
workflow:
|
|
1271
3042
|
type: string
|
|
1272
|
-
description: ""
|
|
1273
|
-
|
|
3043
|
+
description: "ID of a workflow document. The workflow this step belongs to."
|
|
3044
|
+
name:
|
|
1274
3045
|
type: string
|
|
1275
|
-
description: ""
|
|
1276
|
-
|
|
3046
|
+
description: "Descriptive name for the trigger (e.g., 'New Order Created', 'Stock < 5', 'Monday 9 AM Report')."
|
|
3047
|
+
type:
|
|
1277
3048
|
type: string
|
|
3049
|
+
enum:
|
|
3050
|
+
- manual
|
|
3051
|
+
- scheduled
|
|
1278
3052
|
description: ""
|
|
1279
|
-
|
|
3053
|
+
onEvent:
|
|
1280
3054
|
type: string
|
|
3055
|
+
enum:
|
|
3056
|
+
- DataAdded
|
|
3057
|
+
- DataEdited
|
|
3058
|
+
- DataDeleted
|
|
3059
|
+
- ModelAdded
|
|
3060
|
+
- ModelEdited
|
|
3061
|
+
- ModelDeleted
|
|
1281
3062
|
description: ""
|
|
1282
|
-
|
|
3063
|
+
targetModel:
|
|
1283
3064
|
type: string
|
|
1284
|
-
description:
|
|
1285
|
-
|
|
3065
|
+
description: Name of the target model
|
|
3066
|
+
dataFilter:
|
|
1286
3067
|
type: string
|
|
1287
|
-
|
|
1288
|
-
|
|
3068
|
+
format: text
|
|
3069
|
+
description: "Optional conditions checked before executing the step's action."
|
|
3070
|
+
env:
|
|
1289
3071
|
type: string
|
|
3072
|
+
format: text
|
|
3073
|
+
default: '{}'
|
|
3074
|
+
description: "Environment variables (JSON key/value pairs)"
|
|
3075
|
+
isActive:
|
|
3076
|
+
type: boolean
|
|
1290
3077
|
description: ""
|
|
1291
|
-
|
|
3078
|
+
cronExpression:
|
|
1292
3079
|
type: string
|
|
1293
|
-
description: ""
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
brand:
|
|
3080
|
+
description: "Cron expression for scheduling (e.g., '0 9 * * 1' for Monday 9 AM) (used by Scheduled type)."
|
|
3081
|
+
required:
|
|
3082
|
+
- workflow
|
|
3083
|
+
- name
|
|
3084
|
+
- type
|
|
3085
|
+
- onEvent
|
|
3086
|
+
workflowStep:
|
|
1301
3087
|
type: object
|
|
1302
3088
|
properties:
|
|
1303
3089
|
_id:
|
|
@@ -1306,13 +3092,13 @@ components:
|
|
|
1306
3092
|
readOnly: true
|
|
1307
3093
|
_user:
|
|
1308
3094
|
type: string
|
|
1309
|
-
description: Identifier of the user
|
|
3095
|
+
description: Identifier of the user who owns this document
|
|
1310
3096
|
readOnly: true
|
|
1311
3097
|
_model:
|
|
1312
3098
|
type: string
|
|
1313
3099
|
description: Name of the model this document belongs to
|
|
1314
3100
|
readOnly: true
|
|
1315
|
-
default:
|
|
3101
|
+
default: workflowStep
|
|
1316
3102
|
_hash:
|
|
1317
3103
|
type: number
|
|
1318
3104
|
description: Document hash for integrity verification
|
|
@@ -1321,19 +3107,36 @@ components:
|
|
|
1321
3107
|
type: string
|
|
1322
3108
|
description: Name of the pack this document belongs to (if applicable)
|
|
1323
3109
|
readOnly: true
|
|
3110
|
+
workflow:
|
|
3111
|
+
type: string
|
|
3112
|
+
description: "ID of a workflow document. The workflow this step belongs to."
|
|
1324
3113
|
name:
|
|
1325
3114
|
type: string
|
|
1326
|
-
description: ""
|
|
1327
|
-
|
|
3115
|
+
description: "Optional descriptive name for the step (e.g., 'Check Inventory', 'Send Confirmation Email')."
|
|
3116
|
+
conditions:
|
|
1328
3117
|
type: string
|
|
1329
|
-
format:
|
|
1330
|
-
description: ""
|
|
1331
|
-
|
|
3118
|
+
format: text
|
|
3119
|
+
description: "Optional conditions checked before executing the step's action."
|
|
3120
|
+
actions:
|
|
3121
|
+
type: array
|
|
3122
|
+
items:
|
|
3123
|
+
type: string
|
|
3124
|
+
description: ID of a workflowAction document
|
|
3125
|
+
description: "The main actions performed by this step."
|
|
3126
|
+
onSuccessStep:
|
|
1332
3127
|
type: string
|
|
1333
|
-
description: ID of a
|
|
3128
|
+
description: "ID of a workflowStep document. Optional: The next step if this step's action succeeds."
|
|
3129
|
+
onFailureStep:
|
|
3130
|
+
type: string
|
|
3131
|
+
description: "ID of a workflowStep document. Optional: The next step if conditions fail or the action fails."
|
|
3132
|
+
isTerminal:
|
|
3133
|
+
type: boolean
|
|
3134
|
+
default: false
|
|
3135
|
+
description: "Indicates if this step marks the end of a workflow path."
|
|
1334
3136
|
required:
|
|
1335
|
-
-
|
|
1336
|
-
|
|
3137
|
+
- workflow
|
|
3138
|
+
- actions
|
|
3139
|
+
workflowAction:
|
|
1337
3140
|
type: object
|
|
1338
3141
|
properties:
|
|
1339
3142
|
_id:
|
|
@@ -1342,13 +3145,13 @@ components:
|
|
|
1342
3145
|
readOnly: true
|
|
1343
3146
|
_user:
|
|
1344
3147
|
type: string
|
|
1345
|
-
description: Identifier of the user
|
|
3148
|
+
description: Identifier of the user who owns this document
|
|
1346
3149
|
readOnly: true
|
|
1347
3150
|
_model:
|
|
1348
3151
|
type: string
|
|
1349
3152
|
description: Name of the model this document belongs to
|
|
1350
3153
|
readOnly: true
|
|
1351
|
-
default:
|
|
3154
|
+
default: workflowAction
|
|
1352
3155
|
_hash:
|
|
1353
3156
|
type: number
|
|
1354
3157
|
description: Document hash for integrity verification
|
|
@@ -1359,40 +3162,77 @@ components:
|
|
|
1359
3162
|
readOnly: true
|
|
1360
3163
|
name:
|
|
1361
3164
|
type: string
|
|
1362
|
-
description: ""
|
|
1363
|
-
|
|
3165
|
+
description: "Name of the action (e.g., 'Update Order Status', 'Send Email', 'Call Payment API')."
|
|
3166
|
+
type:
|
|
1364
3167
|
type: string
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
|
|
1373
|
-
|
|
1374
|
-
description: ""
|
|
1375
|
-
currency:
|
|
3168
|
+
enum:
|
|
3169
|
+
- UpdateData
|
|
3170
|
+
- CreateData
|
|
3171
|
+
- DeleteData
|
|
3172
|
+
- ExecuteScript
|
|
3173
|
+
- CallWebhook
|
|
3174
|
+
- Wait
|
|
3175
|
+
description: "The type of operation to perform."
|
|
3176
|
+
targetModel:
|
|
1376
3177
|
type: string
|
|
1377
|
-
description:
|
|
1378
|
-
|
|
3178
|
+
description: Name of the target model. Model to target
|
|
3179
|
+
targetSelector:
|
|
1379
3180
|
type: string
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
- yearly
|
|
1384
|
-
description: ""
|
|
1385
|
-
brand:
|
|
3181
|
+
format: text
|
|
3182
|
+
description: "Expression to filter to the target document(s)."
|
|
3183
|
+
fieldsToUpdate:
|
|
1386
3184
|
type: string
|
|
1387
|
-
|
|
1388
|
-
|
|
3185
|
+
format: text
|
|
3186
|
+
default: '{}'
|
|
3187
|
+
description: "Key-value pairs of fields to update (e.g., { status: 'Validé', lastUpdated: '{now}' })"
|
|
3188
|
+
dataToCreate:
|
|
1389
3189
|
type: string
|
|
1390
|
-
|
|
3190
|
+
format: text
|
|
3191
|
+
default: '{}'
|
|
3192
|
+
description: "Object template for the new document to create"
|
|
3193
|
+
script:
|
|
3194
|
+
type: string
|
|
3195
|
+
description: "The script to execute."
|
|
3196
|
+
url:
|
|
3197
|
+
type: string
|
|
3198
|
+
description: "The URL to call."
|
|
3199
|
+
method:
|
|
3200
|
+
type: string
|
|
3201
|
+
enum:
|
|
3202
|
+
- GET
|
|
3203
|
+
- POST
|
|
3204
|
+
- PUT
|
|
3205
|
+
- PATCH
|
|
3206
|
+
- DELETE
|
|
3207
|
+
default: POST
|
|
3208
|
+
description: "HTTP method."
|
|
3209
|
+
headers:
|
|
3210
|
+
type: string
|
|
3211
|
+
format: text
|
|
3212
|
+
default: '{}'
|
|
3213
|
+
description: "HTTP headers as key-value pairs."
|
|
3214
|
+
body:
|
|
3215
|
+
type: string
|
|
3216
|
+
format: text
|
|
3217
|
+
default: '{}'
|
|
3218
|
+
description: "Request body, can include variables."
|
|
3219
|
+
duration:
|
|
3220
|
+
type: number
|
|
3221
|
+
description: "Duration to wait."
|
|
3222
|
+
durationUnit:
|
|
3223
|
+
type: string
|
|
3224
|
+
enum:
|
|
3225
|
+
- milliseconds
|
|
3226
|
+
- seconds
|
|
3227
|
+
- minutes
|
|
3228
|
+
- hours
|
|
3229
|
+
- days
|
|
3230
|
+
default: seconds
|
|
3231
|
+
description: "Unit for the duration."
|
|
1391
3232
|
required:
|
|
1392
3233
|
- name
|
|
1393
|
-
-
|
|
1394
|
-
|
|
1395
|
-
productVariant:
|
|
3234
|
+
- type
|
|
3235
|
+
workflowRun:
|
|
1396
3236
|
type: object
|
|
1397
3237
|
properties:
|
|
1398
3238
|
_id:
|
|
@@ -1401,13 +3241,13 @@ components:
|
|
|
1401
3241
|
readOnly: true
|
|
1402
3242
|
_user:
|
|
1403
3243
|
type: string
|
|
1404
|
-
description: Identifier of the user
|
|
3244
|
+
description: Identifier of the user who owns this document
|
|
1405
3245
|
readOnly: true
|
|
1406
3246
|
_model:
|
|
1407
3247
|
type: string
|
|
1408
3248
|
description: Name of the model this document belongs to
|
|
1409
3249
|
readOnly: true
|
|
1410
|
-
default:
|
|
3250
|
+
default: workflowRun
|
|
1411
3251
|
_hash:
|
|
1412
3252
|
type: number
|
|
1413
3253
|
description: Document hash for integrity verification
|
|
@@ -1416,40 +3256,51 @@ components:
|
|
|
1416
3256
|
type: string
|
|
1417
3257
|
description: Name of the pack this document belongs to (if applicable)
|
|
1418
3258
|
readOnly: true
|
|
1419
|
-
|
|
3259
|
+
workflow:
|
|
1420
3260
|
type: string
|
|
1421
|
-
description: ID of a
|
|
1422
|
-
|
|
3261
|
+
description: "ID of a workflow document. The workflow definition that was executed."
|
|
3262
|
+
contextData:
|
|
1423
3263
|
type: string
|
|
1424
|
-
|
|
1425
|
-
|
|
3264
|
+
format: text
|
|
3265
|
+
default: '{}'
|
|
3266
|
+
description: "Snapshot of the data or event that triggered this run."
|
|
3267
|
+
status:
|
|
1426
3268
|
type: string
|
|
3269
|
+
enum:
|
|
3270
|
+
- pending
|
|
3271
|
+
- running
|
|
3272
|
+
- completed
|
|
3273
|
+
- failed
|
|
3274
|
+
- waiting
|
|
3275
|
+
- cancelled
|
|
3276
|
+
default: pending
|
|
3277
|
+
description: "The current status of the workflow execution."
|
|
3278
|
+
stepExecutionsCount:
|
|
3279
|
+
type: object
|
|
1427
3280
|
description: ""
|
|
1428
|
-
|
|
3281
|
+
currentStep:
|
|
1429
3282
|
type: string
|
|
1430
|
-
description: ""
|
|
1431
|
-
|
|
1432
|
-
type: number
|
|
1433
|
-
description: ""
|
|
1434
|
-
currency:
|
|
3283
|
+
description: "ID of a workflowStep document. The step currently being executed or waited on."
|
|
3284
|
+
owner:
|
|
1435
3285
|
type: string
|
|
1436
|
-
description: ID of a
|
|
1437
|
-
|
|
1438
|
-
type: number
|
|
1439
|
-
default: 0
|
|
1440
|
-
description: ""
|
|
1441
|
-
description:
|
|
3286
|
+
description: ID of a user document
|
|
3287
|
+
startedAt:
|
|
1442
3288
|
type: string
|
|
1443
|
-
|
|
1444
|
-
|
|
3289
|
+
format: date-time
|
|
3290
|
+
description: "Timestamp when the workflow run began."
|
|
3291
|
+
completedAt:
|
|
1445
3292
|
type: string
|
|
1446
|
-
format:
|
|
1447
|
-
description: ""
|
|
3293
|
+
format: date-time
|
|
3294
|
+
description: "Timestamp when the workflow run finished (successfully or failed)."
|
|
3295
|
+
error:
|
|
3296
|
+
type: string
|
|
3297
|
+
maxLength: 4096
|
|
3298
|
+
description: "Error message if the workflow run failed."
|
|
1448
3299
|
required:
|
|
1449
|
-
-
|
|
1450
|
-
-
|
|
1451
|
-
-
|
|
1452
|
-
|
|
3300
|
+
- workflow
|
|
3301
|
+
- status
|
|
3302
|
+
- startedAt
|
|
3303
|
+
dashboard:
|
|
1453
3304
|
type: object
|
|
1454
3305
|
properties:
|
|
1455
3306
|
_id:
|
|
@@ -1458,13 +3309,13 @@ components:
|
|
|
1458
3309
|
readOnly: true
|
|
1459
3310
|
_user:
|
|
1460
3311
|
type: string
|
|
1461
|
-
description: Identifier of the user
|
|
3312
|
+
description: Identifier of the user who owns this document
|
|
1462
3313
|
readOnly: true
|
|
1463
3314
|
_model:
|
|
1464
3315
|
type: string
|
|
1465
3316
|
description: Name of the model this document belongs to
|
|
1466
3317
|
readOnly: true
|
|
1467
|
-
default:
|
|
3318
|
+
default: dashboard
|
|
1468
3319
|
_hash:
|
|
1469
3320
|
type: number
|
|
1470
3321
|
description: Document hash for integrity verification
|
|
@@ -1473,31 +3324,30 @@ components:
|
|
|
1473
3324
|
type: string
|
|
1474
3325
|
description: Name of the pack this document belongs to (if applicable)
|
|
1475
3326
|
readOnly: true
|
|
1476
|
-
|
|
3327
|
+
name:
|
|
1477
3328
|
type: string
|
|
1478
|
-
description:
|
|
1479
|
-
|
|
1480
|
-
type: array
|
|
1481
|
-
items:
|
|
1482
|
-
type: string
|
|
1483
|
-
description: ID of a cartItem document
|
|
1484
|
-
creationDate:
|
|
3329
|
+
description: Customizable display name of the dashboard.
|
|
3330
|
+
description:
|
|
1485
3331
|
type: string
|
|
1486
|
-
|
|
1487
|
-
|
|
1488
|
-
lastUpdate:
|
|
3332
|
+
description: Optional description to provide more context to the dashboard.
|
|
3333
|
+
layout:
|
|
1489
3334
|
type: string
|
|
1490
|
-
format:
|
|
1491
|
-
|
|
1492
|
-
|
|
3335
|
+
format: text
|
|
3336
|
+
default: '{ "type": "columns", "columns": [] }'
|
|
3337
|
+
description: 'JSON structure describing KPI organization. Example: { "type": "columns", "columns": [ ["kpi_id_1"], ["kpi_id_2", "kpi_id_3"] ] }.'
|
|
3338
|
+
settings:
|
|
3339
|
+
type: string
|
|
3340
|
+
format: text
|
|
3341
|
+
default: '{ "defaultTimeRange": "last_7_days", "refreshInterval": null }'
|
|
3342
|
+
description: 'JSON settings for the dashboard, such as default time range (''defaultTimeRange'') or refresh interval in seconds (''refreshInterval'').'
|
|
3343
|
+
isDefault:
|
|
1493
3344
|
type: boolean
|
|
1494
|
-
default:
|
|
1495
|
-
description: ""
|
|
3345
|
+
default: false
|
|
3346
|
+
description: "If 'true', this dashboard is displayed by default for the user."
|
|
1496
3347
|
required:
|
|
1497
|
-
-
|
|
1498
|
-
-
|
|
1499
|
-
|
|
1500
|
-
cartItem:
|
|
3348
|
+
- name
|
|
3349
|
+
- layout
|
|
3350
|
+
request:
|
|
1501
3351
|
type: object
|
|
1502
3352
|
properties:
|
|
1503
3353
|
_id:
|
|
@@ -1506,13 +3356,13 @@ components:
|
|
|
1506
3356
|
readOnly: true
|
|
1507
3357
|
_user:
|
|
1508
3358
|
type: string
|
|
1509
|
-
description: Identifier of the user
|
|
3359
|
+
description: Identifier of the user who owns this document
|
|
1510
3360
|
readOnly: true
|
|
1511
3361
|
_model:
|
|
1512
3362
|
type: string
|
|
1513
3363
|
description: Name of the model this document belongs to
|
|
1514
3364
|
readOnly: true
|
|
1515
|
-
default:
|
|
3365
|
+
default: request
|
|
1516
3366
|
_hash:
|
|
1517
3367
|
type: number
|
|
1518
3368
|
description: Document hash for integrity verification
|
|
@@ -1521,30 +3371,16 @@ components:
|
|
|
1521
3371
|
type: string
|
|
1522
3372
|
description: Name of the pack this document belongs to (if applicable)
|
|
1523
3373
|
readOnly: true
|
|
1524
|
-
|
|
1525
|
-
type: string
|
|
1526
|
-
description: ID of a product document
|
|
1527
|
-
quantity:
|
|
1528
|
-
type: number
|
|
1529
|
-
minimum: 1
|
|
1530
|
-
description: ""
|
|
1531
|
-
variant:
|
|
1532
|
-
type: string
|
|
1533
|
-
description: ID of a productVariant document
|
|
1534
|
-
required:
|
|
1535
|
-
- product
|
|
1536
|
-
- quantity
|
|
1537
|
-
discount:
|
|
1538
|
-
type: object
|
|
1539
|
-
properties:
|
|
1540
|
-
_id:
|
|
1541
|
-
type: string
|
|
1542
|
-
description: Unique document identifier (MongoDB ObjectId)
|
|
1543
|
-
readOnly: true
|
|
1544
|
-
_user:
|
|
3374
|
+
timestamp:
|
|
1545
3375
|
type: string
|
|
1546
|
-
|
|
1547
|
-
|
|
1548
|
-
|
|
3376
|
+
format: date-time
|
|
3377
|
+
description: Exact date and time when the request was received.
|
|
3378
|
+
method:
|
|
1549
3379
|
type: string
|
|
1550
|
-
|
|
3380
|
+
enum:
|
|
3381
|
+
- GET
|
|
3382
|
+
- POST
|
|
3383
|
+
- PUT
|
|
3384
|
+
- DELETE
|
|
3385
|
+
- PATCH
|
|
3386
|
+
- OPTIONS
|