@epilot/entity-client 4.29.1 → 4.29.2
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/client.d.ts +0 -0
- package/dist/client.js +0 -0
- package/dist/definition.d.ts +0 -0
- package/dist/definition.js +1 -1
- package/dist/index.d.ts +0 -0
- package/dist/index.js +0 -0
- package/dist/openapi-runtime.json +190 -60
- package/dist/openapi.d.ts +413 -11
- package/dist/openapi.json +326 -4
- package/dist/schema-model.d.ts +0 -0
- package/dist/schema-model.js +0 -0
- package/package.json +3 -3
- package/LICENSE +0 -21
package/dist/openapi.d.ts
CHANGED
|
@@ -44,6 +44,7 @@ declare namespace Components {
|
|
|
44
44
|
* contact
|
|
45
45
|
*/
|
|
46
46
|
Schemas.EntitySlug[];
|
|
47
|
+
export type FillActivityQueryParam = boolean;
|
|
47
48
|
export type FromPageQueryParam = number;
|
|
48
49
|
export type HydrateEntitiesQueryParam = boolean;
|
|
49
50
|
export type IncludeReverseDeprecatedQueryParam = boolean;
|
|
@@ -57,6 +58,7 @@ declare namespace Components {
|
|
|
57
58
|
export type SavedViewIdPathParam = /* Generated uuid for a saved view */ Schemas.SavedViewId /* uuid */;
|
|
58
59
|
export type TaxonomyClassificationSlugPathParam = string;
|
|
59
60
|
export type TaxonomySlugPathParam = string;
|
|
61
|
+
export type TaxonomySlugQueryParam = string;
|
|
60
62
|
export type TaxonomySlugQueryParamOptional = string;
|
|
61
63
|
}
|
|
62
64
|
export interface PathParameters {
|
|
@@ -74,6 +76,7 @@ declare namespace Components {
|
|
|
74
76
|
ActivityIdPathParam?: Parameters.ActivityIdPathParam;
|
|
75
77
|
}
|
|
76
78
|
export interface QueryParameters {
|
|
79
|
+
TaxonomySlugQueryParam?: Parameters.TaxonomySlugQueryParam;
|
|
77
80
|
TaxonomySlugQueryParamOptional?: Parameters.TaxonomySlugQueryParamOptional;
|
|
78
81
|
AsyncOperationQueryParam?: Parameters.AsyncOperationQueryParam;
|
|
79
82
|
HydrateEntitiesQueryParam?: Parameters.HydrateEntitiesQueryParam;
|
|
@@ -85,6 +88,7 @@ declare namespace Components {
|
|
|
85
88
|
ExcludeSchemasQueryParam?: Parameters.ExcludeSchemasQueryParam;
|
|
86
89
|
EntityRelationsModeQueryParam?: Parameters.EntityRelationsModeQueryParam;
|
|
87
90
|
DryRunQueryParam?: Parameters.DryRunQueryParam;
|
|
91
|
+
FillActivityQueryParam?: Parameters.FillActivityQueryParam;
|
|
88
92
|
}
|
|
89
93
|
namespace Schemas {
|
|
90
94
|
export interface Activity {
|
|
@@ -117,6 +121,12 @@ declare namespace Components {
|
|
|
117
121
|
payload?: {
|
|
118
122
|
[name: string]: any;
|
|
119
123
|
};
|
|
124
|
+
/**
|
|
125
|
+
* Indicates whether the activity is in the pending state.
|
|
126
|
+
* Pending activities are not yet visible in the activity feed and events are not yet dispatched.
|
|
127
|
+
*
|
|
128
|
+
*/
|
|
129
|
+
pending?: boolean;
|
|
120
130
|
}
|
|
121
131
|
export interface ActivityCallerContext {
|
|
122
132
|
[name: string]: any;
|
|
@@ -212,6 +222,12 @@ declare namespace Components {
|
|
|
212
222
|
payload?: {
|
|
213
223
|
[name: string]: any;
|
|
214
224
|
};
|
|
225
|
+
/**
|
|
226
|
+
* Indicates whether the activity is in the pending state.
|
|
227
|
+
* Pending activities are not yet visible in the activity feed and events are not yet dispatched.
|
|
228
|
+
*
|
|
229
|
+
*/
|
|
230
|
+
pending?: boolean;
|
|
215
231
|
caller?: ActivityCallerContext;
|
|
216
232
|
/**
|
|
217
233
|
* Count of total operations attached to this activity
|
|
@@ -364,6 +380,12 @@ declare namespace Components {
|
|
|
364
380
|
* contact:97644baa-083f-4e49-9188-fcff2ecaad7d
|
|
365
381
|
*/
|
|
366
382
|
composite_id?: string;
|
|
383
|
+
/**
|
|
384
|
+
* Schema slug the attribute belongs to
|
|
385
|
+
* example:
|
|
386
|
+
* contact
|
|
387
|
+
*/
|
|
388
|
+
schema?: string;
|
|
367
389
|
} & (/* a readonly computed ID for the attribute including schema slug and the attribute ID */ /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute | /* Shared Partner Organisations */ PartnerOrganisationAttribute);
|
|
368
390
|
/**
|
|
369
391
|
* Automation entity
|
|
@@ -534,6 +556,12 @@ declare namespace Components {
|
|
|
534
556
|
payload?: {
|
|
535
557
|
[name: string]: any;
|
|
536
558
|
};
|
|
559
|
+
/**
|
|
560
|
+
* Indicates whether the activity is in the pending state.
|
|
561
|
+
* Pending activities are not yet visible in the activity feed and events are not yet dispatched.
|
|
562
|
+
*
|
|
563
|
+
*/
|
|
564
|
+
pending?: boolean;
|
|
537
565
|
caller?: ActivityCallerContext;
|
|
538
566
|
}
|
|
539
567
|
export interface BaseAttribute {
|
|
@@ -867,6 +895,12 @@ declare namespace Components {
|
|
|
867
895
|
* taxonomy-slug:classification-slug
|
|
868
896
|
*/
|
|
869
897
|
export type ClassificationId = string;
|
|
898
|
+
/**
|
|
899
|
+
* URL-friendly identifier for the classification
|
|
900
|
+
* example:
|
|
901
|
+
* wallbox-pv
|
|
902
|
+
*/
|
|
903
|
+
export type ClassificationSlug = string;
|
|
870
904
|
export interface ClassificationsUpdate {
|
|
871
905
|
create?: TaxonomyClassification[];
|
|
872
906
|
update?: TaxonomyClassification[];
|
|
@@ -1548,6 +1582,16 @@ declare namespace Components {
|
|
|
1548
1582
|
};
|
|
1549
1583
|
type?: "date" | "datetime";
|
|
1550
1584
|
}
|
|
1585
|
+
export interface ESClusterAssignment {
|
|
1586
|
+
/**
|
|
1587
|
+
* The organization for which the cluster assignment is returned
|
|
1588
|
+
*/
|
|
1589
|
+
orgId?: string;
|
|
1590
|
+
/**
|
|
1591
|
+
* Name of the elastic cluster the organization is assigned to
|
|
1592
|
+
*/
|
|
1593
|
+
cluster?: string;
|
|
1594
|
+
}
|
|
1551
1595
|
/**
|
|
1552
1596
|
* example:
|
|
1553
1597
|
* {
|
|
@@ -1882,6 +1926,12 @@ declare namespace Components {
|
|
|
1882
1926
|
* contact:97644baa-083f-4e49-9188-fcff2ecaad7d
|
|
1883
1927
|
*/
|
|
1884
1928
|
composite_id?: string;
|
|
1929
|
+
/**
|
|
1930
|
+
* Schema slug the capability belongs to
|
|
1931
|
+
* example:
|
|
1932
|
+
* contact
|
|
1933
|
+
*/
|
|
1934
|
+
schema?: string;
|
|
1885
1935
|
}
|
|
1886
1936
|
export interface EntityDefaultCreate {
|
|
1887
1937
|
view_type?: "default";
|
|
@@ -2043,10 +2093,9 @@ declare namespace Components {
|
|
|
2043
2093
|
*/
|
|
2044
2094
|
allow_targeting_all_schemas?: boolean;
|
|
2045
2095
|
/**
|
|
2046
|
-
*
|
|
2047
|
-
* _created_at:desc
|
|
2096
|
+
* You can pass one sort field or an array of sort fields. Each sort field can be a string
|
|
2048
2097
|
*/
|
|
2049
|
-
sort?: string;
|
|
2098
|
+
sort?: /* You can pass one sort field or an array of sort fields. Each sort field can be a string */ string | string[];
|
|
2050
2099
|
from?: number;
|
|
2051
2100
|
/**
|
|
2052
2101
|
* Max search size is 1000 with higher values defaulting to 1000
|
|
@@ -2532,7 +2581,7 @@ declare namespace Components {
|
|
|
2532
2581
|
* example:
|
|
2533
2582
|
* e18a532b-ae79-4d86-a6a5-e5dbfb579d14
|
|
2534
2583
|
*/
|
|
2535
|
-
id
|
|
2584
|
+
id?: string;
|
|
2536
2585
|
/**
|
|
2537
2586
|
* Render order of the group
|
|
2538
2587
|
*/
|
|
@@ -2589,7 +2638,7 @@ declare namespace Components {
|
|
|
2589
2638
|
* example:
|
|
2590
2639
|
* e18a532b-ae79-4d86-a6a5-e5dbfb579d14
|
|
2591
2640
|
*/
|
|
2592
|
-
id
|
|
2641
|
+
id?: string;
|
|
2593
2642
|
/**
|
|
2594
2643
|
* Render order of the group
|
|
2595
2644
|
*/
|
|
@@ -2637,6 +2686,12 @@ declare namespace Components {
|
|
|
2637
2686
|
* contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14
|
|
2638
2687
|
*/
|
|
2639
2688
|
composite_id?: string;
|
|
2689
|
+
/**
|
|
2690
|
+
* Schema slug the group belongs to
|
|
2691
|
+
* example:
|
|
2692
|
+
* contact
|
|
2693
|
+
*/
|
|
2694
|
+
schema?: string;
|
|
2640
2695
|
}
|
|
2641
2696
|
/**
|
|
2642
2697
|
* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.
|
|
@@ -2868,10 +2923,9 @@ declare namespace Components {
|
|
|
2868
2923
|
}
|
|
2869
2924
|
export interface EntitySearchOptions {
|
|
2870
2925
|
/**
|
|
2871
|
-
*
|
|
2872
|
-
* _created_at:desc
|
|
2926
|
+
* You can pass one sort field or an array of sort fields. Each sort field can be a string
|
|
2873
2927
|
*/
|
|
2874
|
-
sort?: string;
|
|
2928
|
+
sort?: /* You can pass one sort field or an array of sort fields. Each sort field can be a string */ string | string[];
|
|
2875
2929
|
from?: number;
|
|
2876
2930
|
/**
|
|
2877
2931
|
* Max search size is 1000 with higher values defaulting to 1000
|
|
@@ -2926,10 +2980,9 @@ declare namespace Components {
|
|
|
2926
2980
|
*/
|
|
2927
2981
|
include_scores?: boolean;
|
|
2928
2982
|
/**
|
|
2929
|
-
*
|
|
2930
|
-
* _created_at:desc
|
|
2983
|
+
* You can pass one sort field or an array of sort fields. Each sort field can be a string
|
|
2931
2984
|
*/
|
|
2932
|
-
sort?: string;
|
|
2985
|
+
sort?: /* You can pass one sort field or an array of sort fields. Each sort field can be a string */ string | string[];
|
|
2933
2986
|
from?: number;
|
|
2934
2987
|
/**
|
|
2935
2988
|
* Max search size is 1000 with higher values defaulting to 1000
|
|
@@ -3127,6 +3180,7 @@ declare namespace Components {
|
|
|
3127
3180
|
*/
|
|
3128
3181
|
message: string;
|
|
3129
3182
|
}
|
|
3183
|
+
export type EntityValidationResult = /* Validation result for a successful validation */ EntityValidationResultSuccess | /* Validation result for a failed validation */ EntityValidationResultError;
|
|
3130
3184
|
/**
|
|
3131
3185
|
* Validation result for a failed validation
|
|
3132
3186
|
*/
|
|
@@ -3320,6 +3374,22 @@ declare namespace Components {
|
|
|
3320
3374
|
enable_description?: boolean;
|
|
3321
3375
|
default_access_control?: "public-read" | "private";
|
|
3322
3376
|
}
|
|
3377
|
+
export interface GenerateEntityTableAIFiltersRequest {
|
|
3378
|
+
/**
|
|
3379
|
+
* The prompt to generate the filters
|
|
3380
|
+
* example:
|
|
3381
|
+
* Show me all contacts that are not customers
|
|
3382
|
+
*/
|
|
3383
|
+
prompt: string;
|
|
3384
|
+
/**
|
|
3385
|
+
* The main entity slug
|
|
3386
|
+
* example:
|
|
3387
|
+
* order
|
|
3388
|
+
*/
|
|
3389
|
+
main_entity_slug: string;
|
|
3390
|
+
filter_options: EntityTableFilterOption[];
|
|
3391
|
+
}
|
|
3392
|
+
export type GenerateEntityTableAIFiltersResponse = EntityTableFilterSearch[];
|
|
3323
3393
|
export interface GetRelatedEntitiesCount {
|
|
3324
3394
|
/**
|
|
3325
3395
|
* example:
|
|
@@ -3435,6 +3505,127 @@ declare namespace Components {
|
|
|
3435
3505
|
entity_id: EntityId /* uuid */;
|
|
3436
3506
|
}[];
|
|
3437
3507
|
}
|
|
3508
|
+
/**
|
|
3509
|
+
* Entity with relation data resolved into the attribute values
|
|
3510
|
+
* example:
|
|
3511
|
+
* {
|
|
3512
|
+
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
3513
|
+
* "_org": "123",
|
|
3514
|
+
* "_owners": [
|
|
3515
|
+
* {
|
|
3516
|
+
* "org_id": "123",
|
|
3517
|
+
* "user_id": "123"
|
|
3518
|
+
* }
|
|
3519
|
+
* ],
|
|
3520
|
+
* "_schema": "contact",
|
|
3521
|
+
* "_tags": [
|
|
3522
|
+
* "example",
|
|
3523
|
+
* "mock"
|
|
3524
|
+
* ],
|
|
3525
|
+
* "_created_at": "2021-02-09T12:41:43.662Z",
|
|
3526
|
+
* "_updated_at": "2021-02-09T12:41:43.662Z",
|
|
3527
|
+
* "_acl": {
|
|
3528
|
+
* "view": [
|
|
3529
|
+
* "org:456",
|
|
3530
|
+
* "org:789"
|
|
3531
|
+
* ],
|
|
3532
|
+
* "edit": [
|
|
3533
|
+
* "org:456"
|
|
3534
|
+
* ],
|
|
3535
|
+
* "delete": [
|
|
3536
|
+
* "org:456"
|
|
3537
|
+
* ]
|
|
3538
|
+
* },
|
|
3539
|
+
* "_relations": [
|
|
3540
|
+
* {
|
|
3541
|
+
* "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
|
|
3542
|
+
* }
|
|
3543
|
+
* ],
|
|
3544
|
+
* "status": "active",
|
|
3545
|
+
* "customer_number": "abc123",
|
|
3546
|
+
* "email": [
|
|
3547
|
+
* {
|
|
3548
|
+
* "label": "work",
|
|
3549
|
+
* "email": "user@example.com"
|
|
3550
|
+
* }
|
|
3551
|
+
* ],
|
|
3552
|
+
* "phone": [
|
|
3553
|
+
* {
|
|
3554
|
+
* "label": "work",
|
|
3555
|
+
* "phone": "+49123456789"
|
|
3556
|
+
* }
|
|
3557
|
+
* ],
|
|
3558
|
+
* "first_name": "First Name",
|
|
3559
|
+
* "middle_name": "Middle Name",
|
|
3560
|
+
* "last_name": "Last Name",
|
|
3561
|
+
* "date_of_birth": "2019-08-24",
|
|
3562
|
+
* "title": "Mr.",
|
|
3563
|
+
* "account": [
|
|
3564
|
+
* {
|
|
3565
|
+
* "status": "active",
|
|
3566
|
+
* "name": "Company name",
|
|
3567
|
+
* "company_email": [
|
|
3568
|
+
* {
|
|
3569
|
+
* "label": "Company email",
|
|
3570
|
+
* "email": "company@example.com"
|
|
3571
|
+
* }
|
|
3572
|
+
* ],
|
|
3573
|
+
* "company_phone": [
|
|
3574
|
+
* {
|
|
3575
|
+
* "label": "Support phone",
|
|
3576
|
+
* "phone": "+49123456789"
|
|
3577
|
+
* }
|
|
3578
|
+
* ],
|
|
3579
|
+
* "company_website": "https://example.com",
|
|
3580
|
+
* "tax_id": "DE123456789",
|
|
3581
|
+
* "tax_exemption": "2019-08-24",
|
|
3582
|
+
* "contacts": {
|
|
3583
|
+
* "$relation": [
|
|
3584
|
+
* {
|
|
3585
|
+
* "_tags": [
|
|
3586
|
+
* "CEO"
|
|
3587
|
+
* ],
|
|
3588
|
+
* "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
|
|
3589
|
+
* }
|
|
3590
|
+
* ]
|
|
3591
|
+
* }
|
|
3592
|
+
* }
|
|
3593
|
+
* ]
|
|
3594
|
+
* }
|
|
3595
|
+
*/
|
|
3596
|
+
export interface HydratedEntityItem {
|
|
3597
|
+
[name: string]: any;
|
|
3598
|
+
_id: EntityId /* uuid */;
|
|
3599
|
+
/**
|
|
3600
|
+
* Organization Id the entity belongs to
|
|
3601
|
+
*/
|
|
3602
|
+
_org: string;
|
|
3603
|
+
_owners?: /**
|
|
3604
|
+
* The user / organization owning this entity.
|
|
3605
|
+
*
|
|
3606
|
+
* Note: Owner implicitly has access to the entity regardless of ACLs.
|
|
3607
|
+
*
|
|
3608
|
+
*/
|
|
3609
|
+
EntityOwner[];
|
|
3610
|
+
_schema: /**
|
|
3611
|
+
* URL-friendly identifier for the entity schema
|
|
3612
|
+
* example:
|
|
3613
|
+
* contact
|
|
3614
|
+
*/
|
|
3615
|
+
EntitySlug;
|
|
3616
|
+
/**
|
|
3617
|
+
* Title of entity
|
|
3618
|
+
*/
|
|
3619
|
+
_title: string | null;
|
|
3620
|
+
_tags?: string[] | null;
|
|
3621
|
+
_created_at: string | null; // date-time
|
|
3622
|
+
_updated_at: string | null; // date-time
|
|
3623
|
+
_acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
|
|
3624
|
+
_purpose?: string[] | null;
|
|
3625
|
+
_relations: {
|
|
3626
|
+
entity_id: EntityId /* uuid */;
|
|
3627
|
+
}[];
|
|
3628
|
+
}
|
|
3438
3629
|
/**
|
|
3439
3630
|
* No UI representation
|
|
3440
3631
|
*/
|
|
@@ -6791,6 +6982,12 @@ declare namespace Components {
|
|
|
6791
6982
|
declare namespace Paths {
|
|
6792
6983
|
namespace AddRelations {
|
|
6793
6984
|
namespace Parameters {
|
|
6985
|
+
export type ActivityId = /**
|
|
6986
|
+
* See https://github.com/ulid/spec
|
|
6987
|
+
* example:
|
|
6988
|
+
* 01F130Q52Q6MWSNS8N2AVXV4JN
|
|
6989
|
+
*/
|
|
6990
|
+
Components.Schemas.ActivityId /* ulid */;
|
|
6794
6991
|
export type Async = boolean;
|
|
6795
6992
|
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
6796
6993
|
export type Slug = /**
|
|
@@ -6806,6 +7003,7 @@ declare namespace Paths {
|
|
|
6806
7003
|
}
|
|
6807
7004
|
export interface QueryParameters {
|
|
6808
7005
|
async?: Parameters.Async;
|
|
7006
|
+
activity_id?: Parameters.ActivityId;
|
|
6809
7007
|
}
|
|
6810
7008
|
export type RequestBody = Components.Schemas.RelationItem[];
|
|
6811
7009
|
namespace Responses {
|
|
@@ -6898,6 +7096,7 @@ declare namespace Paths {
|
|
|
6898
7096
|
*/
|
|
6899
7097
|
Components.Schemas.ActivityId /* ulid */;
|
|
6900
7098
|
export type Async = boolean;
|
|
7099
|
+
export type FillActivity = boolean;
|
|
6901
7100
|
export type Slug = /**
|
|
6902
7101
|
* URL-friendly identifier for the entity schema
|
|
6903
7102
|
* example:
|
|
@@ -6910,6 +7109,7 @@ declare namespace Paths {
|
|
|
6910
7109
|
}
|
|
6911
7110
|
export interface QueryParameters {
|
|
6912
7111
|
activity_id?: Parameters.ActivityId;
|
|
7112
|
+
fill_activity?: Parameters.FillActivity;
|
|
6913
7113
|
async?: Parameters.Async;
|
|
6914
7114
|
}
|
|
6915
7115
|
export type RequestBody = /**
|
|
@@ -6997,6 +7197,24 @@ declare namespace Paths {
|
|
|
6997
7197
|
export type $201 = /* A saved entity view */ Components.Schemas.SavedViewItem;
|
|
6998
7198
|
}
|
|
6999
7199
|
}
|
|
7200
|
+
namespace CreateSchemaAttribute {
|
|
7201
|
+
export type RequestBody = /* a readonly computed ID for the attribute including schema slug and the attribute ID */ Components.Schemas.AttributeWithCompositeID;
|
|
7202
|
+
namespace Responses {
|
|
7203
|
+
export type $201 = /* a readonly computed ID for the attribute including schema slug and the attribute ID */ Components.Schemas.AttributeWithCompositeID;
|
|
7204
|
+
}
|
|
7205
|
+
}
|
|
7206
|
+
namespace CreateSchemaCapability {
|
|
7207
|
+
export type RequestBody = /* a readonly computed ID for the entity capability including schema slug and the capability ID */ Components.Schemas.EntityCapabilityWithCompositeID;
|
|
7208
|
+
namespace Responses {
|
|
7209
|
+
export type $201 = /* a readonly computed ID for the entity capability including schema slug and the capability ID */ Components.Schemas.EntityCapabilityWithCompositeID;
|
|
7210
|
+
}
|
|
7211
|
+
}
|
|
7212
|
+
namespace CreateSchemaGroup {
|
|
7213
|
+
export type RequestBody = /* a readonly computed ID for the group including schema slug and the group ID */ Components.Schemas.EntitySchemaGroupWithCompositeID;
|
|
7214
|
+
namespace Responses {
|
|
7215
|
+
export type $201 = /* a readonly computed ID for the group including schema slug and the group ID */ Components.Schemas.EntitySchemaGroupWithCompositeID;
|
|
7216
|
+
}
|
|
7217
|
+
}
|
|
7000
7218
|
namespace CreateTaxonomy {
|
|
7001
7219
|
export type RequestBody = Components.Schemas.Taxonomy;
|
|
7002
7220
|
namespace Responses {
|
|
@@ -7224,6 +7442,60 @@ declare namespace Paths {
|
|
|
7224
7442
|
export type $200 = Components.Schemas.ActivityItem;
|
|
7225
7443
|
}
|
|
7226
7444
|
}
|
|
7445
|
+
namespace GetESPublicJwks {
|
|
7446
|
+
namespace Responses {
|
|
7447
|
+
export interface $200 {
|
|
7448
|
+
keys?: {
|
|
7449
|
+
/**
|
|
7450
|
+
* example:
|
|
7451
|
+
* RS256
|
|
7452
|
+
*/
|
|
7453
|
+
alg?: string;
|
|
7454
|
+
/**
|
|
7455
|
+
* example:
|
|
7456
|
+
* AQAB
|
|
7457
|
+
*/
|
|
7458
|
+
e?: string;
|
|
7459
|
+
/**
|
|
7460
|
+
* example:
|
|
7461
|
+
* tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=
|
|
7462
|
+
*/
|
|
7463
|
+
kid?: string;
|
|
7464
|
+
/**
|
|
7465
|
+
* example:
|
|
7466
|
+
* RSA
|
|
7467
|
+
*/
|
|
7468
|
+
kty?: string;
|
|
7469
|
+
/**
|
|
7470
|
+
* example:
|
|
7471
|
+
* h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ
|
|
7472
|
+
*/
|
|
7473
|
+
n?: string;
|
|
7474
|
+
/**
|
|
7475
|
+
* example:
|
|
7476
|
+
* sig
|
|
7477
|
+
*/
|
|
7478
|
+
use?: string;
|
|
7479
|
+
}[];
|
|
7480
|
+
}
|
|
7481
|
+
}
|
|
7482
|
+
}
|
|
7483
|
+
namespace GetESTokenOIDC {
|
|
7484
|
+
namespace Responses {
|
|
7485
|
+
export interface $200 {
|
|
7486
|
+
/**
|
|
7487
|
+
* example:
|
|
7488
|
+
* https://entity.dev.sls.epilot.io/v1/entity/public/idp
|
|
7489
|
+
*/
|
|
7490
|
+
issuer?: string; // uri
|
|
7491
|
+
/**
|
|
7492
|
+
* example:
|
|
7493
|
+
* https://entity.dev.sls.epilot.io/v1/entity/public/idp/.well-known/jwks.json
|
|
7494
|
+
*/
|
|
7495
|
+
jwks_uri?: string; // uri
|
|
7496
|
+
}
|
|
7497
|
+
}
|
|
7498
|
+
}
|
|
7227
7499
|
namespace GetEntity {
|
|
7228
7500
|
namespace Parameters {
|
|
7229
7501
|
export type Hydrate = boolean;
|
|
@@ -8246,6 +8518,7 @@ declare namespace Paths {
|
|
|
8246
8518
|
Components.Schemas.ActivityId /* ulid */;
|
|
8247
8519
|
export type Async = boolean;
|
|
8248
8520
|
export type DryRun = boolean;
|
|
8521
|
+
export type FillActivity = boolean;
|
|
8249
8522
|
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
8250
8523
|
export type Slug = /**
|
|
8251
8524
|
* URL-friendly identifier for the entity schema
|
|
@@ -8260,6 +8533,7 @@ declare namespace Paths {
|
|
|
8260
8533
|
}
|
|
8261
8534
|
export interface QueryParameters {
|
|
8262
8535
|
activity_id?: Parameters.ActivityId;
|
|
8536
|
+
fill_activity?: Parameters.FillActivity;
|
|
8263
8537
|
dry_run?: Parameters.DryRun;
|
|
8264
8538
|
async?: Parameters.Async;
|
|
8265
8539
|
}
|
|
@@ -8531,6 +8805,7 @@ declare namespace Paths {
|
|
|
8531
8805
|
*/
|
|
8532
8806
|
Components.Schemas.ActivityId /* ulid */;
|
|
8533
8807
|
export type Async = boolean;
|
|
8808
|
+
export type FillActivity = boolean;
|
|
8534
8809
|
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
8535
8810
|
export type Slug = /**
|
|
8536
8811
|
* URL-friendly identifier for the entity schema
|
|
@@ -8545,6 +8820,7 @@ declare namespace Paths {
|
|
|
8545
8820
|
}
|
|
8546
8821
|
export interface QueryParameters {
|
|
8547
8822
|
activity_id?: Parameters.ActivityId;
|
|
8823
|
+
fill_activity?: Parameters.FillActivity;
|
|
8548
8824
|
async?: Parameters.Async;
|
|
8549
8825
|
}
|
|
8550
8826
|
export type RequestBody = /**
|
|
@@ -8710,6 +8986,7 @@ declare namespace Paths {
|
|
|
8710
8986
|
Components.Schemas.ActivityId /* ulid */;
|
|
8711
8987
|
export type Async = boolean;
|
|
8712
8988
|
export type DryRun = boolean;
|
|
8989
|
+
export type FillActivity = boolean;
|
|
8713
8990
|
export type Slug = /**
|
|
8714
8991
|
* URL-friendly identifier for the entity schema
|
|
8715
8992
|
* example:
|
|
@@ -8723,6 +9000,7 @@ declare namespace Paths {
|
|
|
8723
9000
|
}
|
|
8724
9001
|
export interface QueryParameters {
|
|
8725
9002
|
activity_id?: Parameters.ActivityId;
|
|
9003
|
+
fill_activity?: Parameters.FillActivity;
|
|
8726
9004
|
dry_run?: Parameters.DryRun;
|
|
8727
9005
|
async?: Parameters.Async;
|
|
8728
9006
|
strict?: Parameters.Strict;
|
|
@@ -9677,6 +9955,16 @@ export interface OperationMethods {
|
|
|
9677
9955
|
data?: any,
|
|
9678
9956
|
config?: AxiosRequestConfig
|
|
9679
9957
|
): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$200>
|
|
9958
|
+
/**
|
|
9959
|
+
* createSchemaAttribute - createSchemaAttribute
|
|
9960
|
+
*
|
|
9961
|
+
* Create a schema attribute
|
|
9962
|
+
*/
|
|
9963
|
+
'createSchemaAttribute'(
|
|
9964
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
9965
|
+
data?: Paths.CreateSchemaAttribute.RequestBody,
|
|
9966
|
+
config?: AxiosRequestConfig
|
|
9967
|
+
): OperationResponse<Paths.CreateSchemaAttribute.Responses.$201>
|
|
9680
9968
|
/**
|
|
9681
9969
|
* getSchemaAttribute - getSchemaAttribute
|
|
9682
9970
|
*
|
|
@@ -9707,6 +9995,16 @@ export interface OperationMethods {
|
|
|
9707
9995
|
data?: any,
|
|
9708
9996
|
config?: AxiosRequestConfig
|
|
9709
9997
|
): OperationResponse<Paths.DeleteSchemaAttribute.Responses.$200>
|
|
9998
|
+
/**
|
|
9999
|
+
* createSchemaCapability - createSchemaCapability
|
|
10000
|
+
*
|
|
10001
|
+
* Create a schema capability
|
|
10002
|
+
*/
|
|
10003
|
+
'createSchemaCapability'(
|
|
10004
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
10005
|
+
data?: Paths.CreateSchemaCapability.RequestBody,
|
|
10006
|
+
config?: AxiosRequestConfig
|
|
10007
|
+
): OperationResponse<Paths.CreateSchemaCapability.Responses.$201>
|
|
9710
10008
|
/**
|
|
9711
10009
|
* getSchemaCapability - getSchemaCapability
|
|
9712
10010
|
*
|
|
@@ -9737,6 +10035,16 @@ export interface OperationMethods {
|
|
|
9737
10035
|
data?: any,
|
|
9738
10036
|
config?: AxiosRequestConfig
|
|
9739
10037
|
): OperationResponse<Paths.DeleteSchemaCapability.Responses.$200>
|
|
10038
|
+
/**
|
|
10039
|
+
* createSchemaGroup - createSchemaGroup
|
|
10040
|
+
*
|
|
10041
|
+
* Create a schema group
|
|
10042
|
+
*/
|
|
10043
|
+
'createSchemaGroup'(
|
|
10044
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
10045
|
+
data?: Paths.CreateSchemaGroup.RequestBody,
|
|
10046
|
+
config?: AxiosRequestConfig
|
|
10047
|
+
): OperationResponse<Paths.CreateSchemaGroup.Responses.$201>
|
|
9740
10048
|
/**
|
|
9741
10049
|
* getSchemaGroup - getSchemaGroup
|
|
9742
10050
|
*
|
|
@@ -9767,6 +10075,30 @@ export interface OperationMethods {
|
|
|
9767
10075
|
data?: any,
|
|
9768
10076
|
config?: AxiosRequestConfig
|
|
9769
10077
|
): OperationResponse<Paths.DeleteSchemaGroup.Responses.$200>
|
|
10078
|
+
/**
|
|
10079
|
+
* getESPublicJwks - getESPublicJwks
|
|
10080
|
+
*
|
|
10081
|
+
* Get jwks public key set to verify tokens generated by this API for Elasticsearch authentication
|
|
10082
|
+
*/
|
|
10083
|
+
'getESPublicJwks'(
|
|
10084
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
10085
|
+
data?: any,
|
|
10086
|
+
config?: AxiosRequestConfig
|
|
10087
|
+
): OperationResponse<Paths.GetESPublicJwks.Responses.$200>
|
|
10088
|
+
/**
|
|
10089
|
+
* getESTokenOIDC - getESTokenOIDC
|
|
10090
|
+
*
|
|
10091
|
+
* OpenID Connect configuration for Entity API serving as public identity provider
|
|
10092
|
+
*
|
|
10093
|
+
* Note: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to
|
|
10094
|
+
* automate the process of verifying JWT tokens.
|
|
10095
|
+
*
|
|
10096
|
+
*/
|
|
10097
|
+
'getESTokenOIDC'(
|
|
10098
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
10099
|
+
data?: any,
|
|
10100
|
+
config?: AxiosRequestConfig
|
|
10101
|
+
): OperationResponse<Paths.GetESTokenOIDC.Responses.$200>
|
|
9770
10102
|
}
|
|
9771
10103
|
|
|
9772
10104
|
export interface PathsDictionary {
|
|
@@ -10601,6 +10933,18 @@ export interface PathsDictionary {
|
|
|
10601
10933
|
config?: AxiosRequestConfig
|
|
10602
10934
|
): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$200>
|
|
10603
10935
|
}
|
|
10936
|
+
['/v1/entity/schemas/attributes']: {
|
|
10937
|
+
/**
|
|
10938
|
+
* createSchemaAttribute - createSchemaAttribute
|
|
10939
|
+
*
|
|
10940
|
+
* Create a schema attribute
|
|
10941
|
+
*/
|
|
10942
|
+
'post'(
|
|
10943
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
10944
|
+
data?: Paths.CreateSchemaAttribute.RequestBody,
|
|
10945
|
+
config?: AxiosRequestConfig
|
|
10946
|
+
): OperationResponse<Paths.CreateSchemaAttribute.Responses.$201>
|
|
10947
|
+
}
|
|
10604
10948
|
['/v1/entity/schemas/attributes/{composite_id}']: {
|
|
10605
10949
|
/**
|
|
10606
10950
|
* getSchemaAttribute - getSchemaAttribute
|
|
@@ -10633,6 +10977,18 @@ export interface PathsDictionary {
|
|
|
10633
10977
|
config?: AxiosRequestConfig
|
|
10634
10978
|
): OperationResponse<Paths.DeleteSchemaAttribute.Responses.$200>
|
|
10635
10979
|
}
|
|
10980
|
+
['/v1/entity/schemas/capabilities']: {
|
|
10981
|
+
/**
|
|
10982
|
+
* createSchemaCapability - createSchemaCapability
|
|
10983
|
+
*
|
|
10984
|
+
* Create a schema capability
|
|
10985
|
+
*/
|
|
10986
|
+
'post'(
|
|
10987
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
10988
|
+
data?: Paths.CreateSchemaCapability.RequestBody,
|
|
10989
|
+
config?: AxiosRequestConfig
|
|
10990
|
+
): OperationResponse<Paths.CreateSchemaCapability.Responses.$201>
|
|
10991
|
+
}
|
|
10636
10992
|
['/v1/entity/schemas/capabilities/{composite_id}']: {
|
|
10637
10993
|
/**
|
|
10638
10994
|
* getSchemaCapability - getSchemaCapability
|
|
@@ -10665,6 +11021,18 @@ export interface PathsDictionary {
|
|
|
10665
11021
|
config?: AxiosRequestConfig
|
|
10666
11022
|
): OperationResponse<Paths.DeleteSchemaCapability.Responses.$200>
|
|
10667
11023
|
}
|
|
11024
|
+
['/v1/entity/schemas/group']: {
|
|
11025
|
+
/**
|
|
11026
|
+
* createSchemaGroup - createSchemaGroup
|
|
11027
|
+
*
|
|
11028
|
+
* Create a schema group
|
|
11029
|
+
*/
|
|
11030
|
+
'post'(
|
|
11031
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
11032
|
+
data?: Paths.CreateSchemaGroup.RequestBody,
|
|
11033
|
+
config?: AxiosRequestConfig
|
|
11034
|
+
): OperationResponse<Paths.CreateSchemaGroup.Responses.$201>
|
|
11035
|
+
}
|
|
10668
11036
|
['/v1/entity/schemas/group/{composite_id}']: {
|
|
10669
11037
|
/**
|
|
10670
11038
|
* getSchemaGroup - getSchemaGroup
|
|
@@ -10697,6 +11065,34 @@ export interface PathsDictionary {
|
|
|
10697
11065
|
config?: AxiosRequestConfig
|
|
10698
11066
|
): OperationResponse<Paths.DeleteSchemaGroup.Responses.$200>
|
|
10699
11067
|
}
|
|
11068
|
+
['/v1/entity/public/idp/.well-known/jwks.json']: {
|
|
11069
|
+
/**
|
|
11070
|
+
* getESPublicJwks - getESPublicJwks
|
|
11071
|
+
*
|
|
11072
|
+
* Get jwks public key set to verify tokens generated by this API for Elasticsearch authentication
|
|
11073
|
+
*/
|
|
11074
|
+
'get'(
|
|
11075
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
11076
|
+
data?: any,
|
|
11077
|
+
config?: AxiosRequestConfig
|
|
11078
|
+
): OperationResponse<Paths.GetESPublicJwks.Responses.$200>
|
|
11079
|
+
}
|
|
11080
|
+
['/v1/entity/public/idp/.well-known/openid-configuration']: {
|
|
11081
|
+
/**
|
|
11082
|
+
* getESTokenOIDC - getESTokenOIDC
|
|
11083
|
+
*
|
|
11084
|
+
* OpenID Connect configuration for Entity API serving as public identity provider
|
|
11085
|
+
*
|
|
11086
|
+
* Note: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to
|
|
11087
|
+
* automate the process of verifying JWT tokens.
|
|
11088
|
+
*
|
|
11089
|
+
*/
|
|
11090
|
+
'get'(
|
|
11091
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
11092
|
+
data?: any,
|
|
11093
|
+
config?: AxiosRequestConfig
|
|
11094
|
+
): OperationResponse<Paths.GetESTokenOIDC.Responses.$200>
|
|
11095
|
+
}
|
|
10700
11096
|
}
|
|
10701
11097
|
|
|
10702
11098
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
@@ -10715,12 +11111,14 @@ export type BaseEntity = Components.Schemas.BaseEntity;
|
|
|
10715
11111
|
export type BlueprintEntityId = Components.Schemas.BlueprintEntityId;
|
|
10716
11112
|
export type BooleanAttribute = Components.Schemas.BooleanAttribute;
|
|
10717
11113
|
export type ClassificationId = Components.Schemas.ClassificationId;
|
|
11114
|
+
export type ClassificationSlug = Components.Schemas.ClassificationSlug;
|
|
10718
11115
|
export type ClassificationsUpdate = Components.Schemas.ClassificationsUpdate;
|
|
10719
11116
|
export type ComputedAttribute = Components.Schemas.ComputedAttribute;
|
|
10720
11117
|
export type ConsentAttribute = Components.Schemas.ConsentAttribute;
|
|
10721
11118
|
export type CountryAttribute = Components.Schemas.CountryAttribute;
|
|
10722
11119
|
export type CurrencyAttribute = Components.Schemas.CurrencyAttribute;
|
|
10723
11120
|
export type DateAttribute = Components.Schemas.DateAttribute;
|
|
11121
|
+
export type ESClusterAssignment = Components.Schemas.ESClusterAssignment;
|
|
10724
11122
|
export type Entity = Components.Schemas.Entity;
|
|
10725
11123
|
export type EntityAcl = Components.Schemas.EntityAcl;
|
|
10726
11124
|
export type EntityAction = Components.Schemas.EntityAction;
|
|
@@ -10746,16 +11144,20 @@ export type EntitySlug = Components.Schemas.EntitySlug;
|
|
|
10746
11144
|
export type EntityTableFilterOption = Components.Schemas.EntityTableFilterOption;
|
|
10747
11145
|
export type EntityTableFilterSearch = Components.Schemas.EntityTableFilterSearch;
|
|
10748
11146
|
export type EntityValidationError = Components.Schemas.EntityValidationError;
|
|
11147
|
+
export type EntityValidationResult = Components.Schemas.EntityValidationResult;
|
|
10749
11148
|
export type EntityValidationResultError = Components.Schemas.EntityValidationResultError;
|
|
10750
11149
|
export type EntityValidationResultSuccess = Components.Schemas.EntityValidationResultSuccess;
|
|
10751
11150
|
export type EntityViewDisabled = Components.Schemas.EntityViewDisabled;
|
|
10752
11151
|
export type ExportJobId = Components.Schemas.ExportJobId;
|
|
10753
11152
|
export type FieldsParam = Components.Schemas.FieldsParam;
|
|
10754
11153
|
export type FileAttribute = Components.Schemas.FileAttribute;
|
|
11154
|
+
export type GenerateEntityTableAIFiltersRequest = Components.Schemas.GenerateEntityTableAIFiltersRequest;
|
|
11155
|
+
export type GenerateEntityTableAIFiltersResponse = Components.Schemas.GenerateEntityTableAIFiltersResponse;
|
|
10755
11156
|
export type GetRelatedEntitiesCount = Components.Schemas.GetRelatedEntitiesCount;
|
|
10756
11157
|
export type GetRelationsResp = Components.Schemas.GetRelationsResp;
|
|
10757
11158
|
export type GetRelationsRespWithPagination = Components.Schemas.GetRelationsRespWithPagination;
|
|
10758
11159
|
export type HydratedEntity = Components.Schemas.HydratedEntity;
|
|
11160
|
+
export type HydratedEntityItem = Components.Schemas.HydratedEntityItem;
|
|
10759
11161
|
export type InternalAttribute = Components.Schemas.InternalAttribute;
|
|
10760
11162
|
export type InternalUserAttribute = Components.Schemas.InternalUserAttribute;
|
|
10761
11163
|
export type InvitationEmailAttribute = Components.Schemas.InvitationEmailAttribute;
|