@epilot/entity-client 4.9.3 → 4.10.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/index.js +5 -1
- package/dist/openapi.d.ts +1510 -21
- package/dist/openapi.json +123 -5
- package/dist/schema-model.d.ts +2 -2
- package/package.json +1 -1
package/dist/openapi.json
CHANGED
|
@@ -759,10 +759,10 @@
|
|
|
759
759
|
"schema": {
|
|
760
760
|
"$ref": "#/components/schemas/Entity"
|
|
761
761
|
},
|
|
762
|
-
"example": {}
|
|
763
|
-
"required": true
|
|
762
|
+
"example": {}
|
|
764
763
|
}
|
|
765
|
-
}
|
|
764
|
+
},
|
|
765
|
+
"required": true
|
|
766
766
|
},
|
|
767
767
|
"responses": {
|
|
768
768
|
"200": {
|
|
@@ -2621,6 +2621,29 @@
|
|
|
2621
2621
|
"description": "Setting to `true` prevents the attribute from being modified / deleted",
|
|
2622
2622
|
"type": "boolean",
|
|
2623
2623
|
"default": true
|
|
2624
|
+
},
|
|
2625
|
+
"info_helpers": {
|
|
2626
|
+
"description": "A set of configurations meant to document and assist the user in filling the attribute.",
|
|
2627
|
+
"type": "object",
|
|
2628
|
+
"properties": {
|
|
2629
|
+
"hint_text": {
|
|
2630
|
+
"type": "string",
|
|
2631
|
+
"description": "The text to be displayed in the attribute hint helper.\nWhen specified it overrides the `hint_text_key` configuration.\n"
|
|
2632
|
+
},
|
|
2633
|
+
"hint_text_key": {
|
|
2634
|
+
"type": "string",
|
|
2635
|
+
"description": "The key of the hint text to be displayed in the attribute hint helper.\nThe key should be a valid i18n key.\n"
|
|
2636
|
+
},
|
|
2637
|
+
"hint_custom_component": {
|
|
2638
|
+
"type": "string",
|
|
2639
|
+
"description": "The name of the custom component to be used as the hint helper.\nThe component should be registered in the `@epilot360/entity-ui` on the index of the components directory.\nWhen specified it overrides the `hint_text` or `hint_text_key` configuration.\n"
|
|
2640
|
+
},
|
|
2641
|
+
"hint_tooltip_placement": {
|
|
2642
|
+
"type": "string",
|
|
2643
|
+
"description": "The placement of the hint tooltip.\nThe value should be a valid `@mui/core` tooltip placement.\n",
|
|
2644
|
+
"example": "top"
|
|
2645
|
+
}
|
|
2646
|
+
}
|
|
2624
2647
|
}
|
|
2625
2648
|
},
|
|
2626
2649
|
"required": [
|
|
@@ -3953,6 +3976,12 @@
|
|
|
3953
3976
|
"type": "string",
|
|
3954
3977
|
"description": "Organization Id the entity belongs to"
|
|
3955
3978
|
},
|
|
3979
|
+
"_owners": {
|
|
3980
|
+
"type": "array",
|
|
3981
|
+
"items": {
|
|
3982
|
+
"$ref": "#/components/schemas/EntityOwner"
|
|
3983
|
+
}
|
|
3984
|
+
},
|
|
3956
3985
|
"_schema": {
|
|
3957
3986
|
"$ref": "#/components/schemas/EntitySlug"
|
|
3958
3987
|
},
|
|
@@ -3977,26 +4006,115 @@
|
|
|
3977
4006
|
"type": "string",
|
|
3978
4007
|
"format": "date-time",
|
|
3979
4008
|
"nullable": true
|
|
4009
|
+
},
|
|
4010
|
+
"_acl": {
|
|
4011
|
+
"$ref": "#/components/schemas/EntityAcl"
|
|
3980
4012
|
}
|
|
3981
4013
|
},
|
|
3982
4014
|
"example": {
|
|
3983
4015
|
"_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
3984
4016
|
"_org": "123",
|
|
4017
|
+
"_owners": [
|
|
4018
|
+
{
|
|
4019
|
+
"org_id": "123",
|
|
4020
|
+
"user_id": "123"
|
|
4021
|
+
}
|
|
4022
|
+
],
|
|
3985
4023
|
"_schema": "contact",
|
|
3986
4024
|
"_tags": [
|
|
3987
4025
|
"example",
|
|
3988
4026
|
"mock"
|
|
3989
4027
|
],
|
|
3990
4028
|
"_created_at": "2021-02-09T12:41:43.662Z",
|
|
3991
|
-
"_updated_at": "2021-02-09T12:41:43.662Z"
|
|
4029
|
+
"_updated_at": "2021-02-09T12:41:43.662Z",
|
|
4030
|
+
"_acl": {
|
|
4031
|
+
"view": [
|
|
4032
|
+
"org:456",
|
|
4033
|
+
"org:789"
|
|
4034
|
+
],
|
|
4035
|
+
"edit": [
|
|
4036
|
+
"org:456"
|
|
4037
|
+
],
|
|
4038
|
+
"delete": [
|
|
4039
|
+
"org:456"
|
|
4040
|
+
]
|
|
4041
|
+
}
|
|
3992
4042
|
}
|
|
3993
4043
|
},
|
|
4044
|
+
"EntityOwner": {
|
|
4045
|
+
"description": "The user / organization owning this entity.\n\nNote: Owner implicitly has access to the entity regardless of ACLs.\n",
|
|
4046
|
+
"type": "object",
|
|
4047
|
+
"properties": {
|
|
4048
|
+
"org_id": {
|
|
4049
|
+
"type": "string",
|
|
4050
|
+
"example": "123"
|
|
4051
|
+
},
|
|
4052
|
+
"user_id": {
|
|
4053
|
+
"type": "string",
|
|
4054
|
+
"example": "123"
|
|
4055
|
+
}
|
|
4056
|
+
},
|
|
4057
|
+
"required": [
|
|
4058
|
+
"org_id"
|
|
4059
|
+
]
|
|
4060
|
+
},
|
|
4061
|
+
"EntityAcl": {
|
|
4062
|
+
"description": "Access control list (ACL) for an entity. Defines sharing access to external orgs or users.",
|
|
4063
|
+
"type": "object",
|
|
4064
|
+
"properties": {
|
|
4065
|
+
"view": {
|
|
4066
|
+
"type": "array",
|
|
4067
|
+
"items": {
|
|
4068
|
+
"type": "string",
|
|
4069
|
+
"example": "org:456"
|
|
4070
|
+
}
|
|
4071
|
+
},
|
|
4072
|
+
"edit": {
|
|
4073
|
+
"type": "array",
|
|
4074
|
+
"items": {
|
|
4075
|
+
"type": "string",
|
|
4076
|
+
"example": "org:456"
|
|
4077
|
+
}
|
|
4078
|
+
},
|
|
4079
|
+
"delete": {
|
|
4080
|
+
"type": "array",
|
|
4081
|
+
"items": {
|
|
4082
|
+
"type": "string",
|
|
4083
|
+
"example": "org:456"
|
|
4084
|
+
}
|
|
4085
|
+
}
|
|
4086
|
+
},
|
|
4087
|
+
"additionalProperties": true
|
|
4088
|
+
},
|
|
3994
4089
|
"HydratedEntity": {
|
|
3995
4090
|
"type": "object",
|
|
3996
4091
|
"description": "Entity with relation data resolved into the attribute values",
|
|
3997
|
-
"properties": {
|
|
4092
|
+
"properties": {
|
|
4093
|
+
"_relations": {
|
|
4094
|
+
"type": "array",
|
|
4095
|
+
"items": {
|
|
4096
|
+
"type": "object",
|
|
4097
|
+
"properties": {
|
|
4098
|
+
"entity_id": {
|
|
4099
|
+
"$ref": "#/components/schemas/EntityId"
|
|
4100
|
+
}
|
|
4101
|
+
},
|
|
4102
|
+
"required": [
|
|
4103
|
+
"entity_id"
|
|
4104
|
+
]
|
|
4105
|
+
}
|
|
4106
|
+
}
|
|
4107
|
+
},
|
|
3998
4108
|
"additionalProperties": true,
|
|
4109
|
+
"required": [
|
|
4110
|
+
"_relations"
|
|
4111
|
+
],
|
|
3999
4112
|
"example": {
|
|
4113
|
+
"_relations": [
|
|
4114
|
+
{
|
|
4115
|
+
"entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
|
|
4116
|
+
}
|
|
4117
|
+
],
|
|
4000
4118
|
"status": "active",
|
|
4001
4119
|
"customer_number": "abc123",
|
|
4002
4120
|
"email": [
|
package/dist/schema-model.d.ts
CHANGED
|
@@ -7,5 +7,5 @@ export declare enum RelationAffinityMode {
|
|
|
7
7
|
WEAK = "weak",
|
|
8
8
|
STRONG = "strong"
|
|
9
9
|
}
|
|
10
|
-
export
|
|
11
|
-
export
|
|
10
|
+
export type Attribute = Components.Schemas.Attribute;
|
|
11
|
+
export type AttributeType = Attribute['type'];
|