@epilot/entity-client 6.7.0 → 6.8.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/openapi-runtime.json +0 -75
- package/dist/openapi.d.ts +217 -369
- package/dist/openapi.json +38 -304
- package/package.json +1 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -23,7 +23,6 @@ declare namespace Components {
|
|
|
23
23
|
*/
|
|
24
24
|
Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
|
|
25
25
|
export type AsyncOperationQueryParam = boolean;
|
|
26
|
-
export type CollectionIdPathParam = string; // uuid
|
|
27
26
|
export type DryRunQueryParam = boolean;
|
|
28
27
|
export type EntityIdPathParam = Schemas.EntityId /* uuid */;
|
|
29
28
|
export type EntityRelationsModeQueryParam = "direct" | "reverse" | "both";
|
|
@@ -32,19 +31,19 @@ declare namespace Components {
|
|
|
32
31
|
* example:
|
|
33
32
|
* contact
|
|
34
33
|
*/
|
|
35
|
-
Schemas.EntitySlug
|
|
34
|
+
Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
36
35
|
/**
|
|
37
36
|
* URL-friendly identifier for the entity schema
|
|
38
37
|
* example:
|
|
39
38
|
* price
|
|
40
39
|
*/
|
|
41
|
-
export type EntitySlugPathPriceParam = string;
|
|
40
|
+
export type EntitySlugPathPriceParam = string; // ^[a-zA-Z0-9_-]+$
|
|
42
41
|
export type ExcludeSchemasQueryParam = /**
|
|
43
42
|
* URL-friendly identifier for the entity schema
|
|
44
43
|
* example:
|
|
45
44
|
* contact
|
|
46
45
|
*/
|
|
47
|
-
Schemas.EntitySlug[];
|
|
46
|
+
Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
|
|
48
47
|
export type FillActivityQueryParam = boolean;
|
|
49
48
|
export type FromPageQueryParam = number;
|
|
50
49
|
export type HydrateEntitiesQueryParam = boolean;
|
|
@@ -55,7 +54,7 @@ declare namespace Components {
|
|
|
55
54
|
* example:
|
|
56
55
|
* contact
|
|
57
56
|
*/
|
|
58
|
-
Schemas.EntitySlug[];
|
|
57
|
+
Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
|
|
59
58
|
export type SavedViewIdPathParam = /* Generated uuid for a saved view */ Schemas.SavedViewId /* uuid */;
|
|
60
59
|
export type TaxonomyClassificationSlugPathParam = string;
|
|
61
60
|
export type TaxonomySlugPathParam = string;
|
|
@@ -71,12 +70,11 @@ declare namespace Components {
|
|
|
71
70
|
* example:
|
|
72
71
|
* price
|
|
73
72
|
*/
|
|
74
|
-
Parameters.EntitySlugPathPriceParam
|
|
73
|
+
Parameters.EntitySlugPathPriceParam /* ^[a-zA-Z0-9_-]+$ */;
|
|
75
74
|
TaxonomySlugPathParam?: Parameters.TaxonomySlugPathParam;
|
|
76
75
|
TaxonomyClassificationSlugPathParam?: Parameters.TaxonomyClassificationSlugPathParam;
|
|
77
76
|
SavedViewIdPathParam?: Parameters.SavedViewIdPathParam;
|
|
78
77
|
ActivityIdPathParam?: Parameters.ActivityIdPathParam;
|
|
79
|
-
CollectionIdPathParam?: Parameters.CollectionIdPathParam /* uuid */;
|
|
80
78
|
}
|
|
81
79
|
export interface QueryParameters {
|
|
82
80
|
TaxonomySlugQueryParam?: Parameters.TaxonomySlugQueryParam;
|
|
@@ -617,7 +615,7 @@ declare namespace Components {
|
|
|
617
615
|
*/
|
|
618
616
|
DefaultAddressFields;
|
|
619
617
|
}
|
|
620
|
-
export type Attribute = /* 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 | /* Address attribute */ AddressAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Tags */ TagsAttribute | /* Message emil address */ MessageEmailAddressAttribute | /* 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 | /* Phone number */ PhoneAttribute | /* Email address */ EmailAttribute | /* Payment method */ PaymentAttribute | /* Price component */ PriceComponentAttribute;
|
|
618
|
+
export type Attribute = /* 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 | /* Address attribute */ AddressAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Tags */ TagsAttribute | /* Message emil address */ MessageEmailAddressAttribute | /* 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 | /* Portal access configuration */ PortalAccessAttribute | /* Phone number */ PhoneAttribute | /* Email address */ EmailAttribute | /* Payment method */ PaymentAttribute | /* Price component */ PriceComponentAttribute;
|
|
621
619
|
/**
|
|
622
620
|
* a readonly computed ID for the attribute including schema slug and the attribute ID
|
|
623
621
|
*/
|
|
@@ -633,7 +631,7 @@ declare namespace Components {
|
|
|
633
631
|
* contact
|
|
634
632
|
*/
|
|
635
633
|
schema?: string;
|
|
636
|
-
} & (/* 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 | /* Address attribute */ AddressAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Tags */ TagsAttribute | /* Message emil address */ MessageEmailAddressAttribute | /* 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 | /* Phone number */ PhoneAttribute | /* Email address */ EmailAttribute | /* Payment method */ PaymentAttribute | /* Price component */ PriceComponentAttribute);
|
|
634
|
+
} & (/* 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 | /* Address attribute */ AddressAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Tags */ TagsAttribute | /* Message emil address */ MessageEmailAddressAttribute | /* 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 | /* Portal access configuration */ PortalAccessAttribute | /* Phone number */ PhoneAttribute | /* Email address */ EmailAttribute | /* Payment method */ PaymentAttribute | /* Price component */ PriceComponentAttribute);
|
|
637
635
|
/**
|
|
638
636
|
* Automation entity
|
|
639
637
|
*/
|
|
@@ -1011,7 +1009,7 @@ declare namespace Components {
|
|
|
1011
1009
|
* example:
|
|
1012
1010
|
* contact
|
|
1013
1011
|
*/
|
|
1014
|
-
EntitySlug
|
|
1012
|
+
EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
1015
1013
|
/**
|
|
1016
1014
|
* Title of entity
|
|
1017
1015
|
*/
|
|
@@ -2166,7 +2164,7 @@ declare namespace Components {
|
|
|
2166
2164
|
* example:
|
|
2167
2165
|
* contact
|
|
2168
2166
|
*/
|
|
2169
|
-
EntitySlug
|
|
2167
|
+
EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
2170
2168
|
/**
|
|
2171
2169
|
* Title of entity
|
|
2172
2170
|
*/
|
|
@@ -2633,7 +2631,7 @@ declare namespace Components {
|
|
|
2633
2631
|
* example:
|
|
2634
2632
|
* contact
|
|
2635
2633
|
*/
|
|
2636
|
-
EntitySlug
|
|
2634
|
+
EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
2637
2635
|
/**
|
|
2638
2636
|
* Title of entity
|
|
2639
2637
|
*/
|
|
@@ -2658,6 +2656,12 @@ declare namespace Components {
|
|
|
2658
2656
|
_manifest?: string /* uuid */[] | null;
|
|
2659
2657
|
}
|
|
2660
2658
|
export interface EntityListParams {
|
|
2659
|
+
/**
|
|
2660
|
+
* Lucene [queries supported with ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax)
|
|
2661
|
+
* example:
|
|
2662
|
+
* status:active
|
|
2663
|
+
*/
|
|
2664
|
+
q?: string;
|
|
2661
2665
|
filter: /**
|
|
2662
2666
|
* A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
|
|
2663
2667
|
* example:
|
|
@@ -2741,6 +2745,10 @@ declare namespace Components {
|
|
|
2741
2745
|
*
|
|
2742
2746
|
*/
|
|
2743
2747
|
EntitySearchIncludeDeletedParam;
|
|
2748
|
+
/**
|
|
2749
|
+
* Adds a `_score` number field to results that can be used to rank by match score
|
|
2750
|
+
*/
|
|
2751
|
+
include_scores?: boolean;
|
|
2744
2752
|
highlight?: any;
|
|
2745
2753
|
/**
|
|
2746
2754
|
* A TTL (in seconds) that specifies how long the context should be maintained.
|
|
@@ -2795,7 +2803,7 @@ declare namespace Components {
|
|
|
2795
2803
|
* example:
|
|
2796
2804
|
* contact
|
|
2797
2805
|
*/
|
|
2798
|
-
EntitySlug
|
|
2806
|
+
EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
2799
2807
|
};
|
|
2800
2808
|
/**
|
|
2801
2809
|
* example:
|
|
@@ -2852,7 +2860,7 @@ declare namespace Components {
|
|
|
2852
2860
|
* example:
|
|
2853
2861
|
* contact
|
|
2854
2862
|
*/
|
|
2855
|
-
EntitySlug
|
|
2863
|
+
EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
2856
2864
|
/**
|
|
2857
2865
|
* Title of entity
|
|
2858
2866
|
*/
|
|
@@ -3014,7 +3022,7 @@ declare namespace Components {
|
|
|
3014
3022
|
* example:
|
|
3015
3023
|
* contact
|
|
3016
3024
|
*/
|
|
3017
|
-
EntitySlug
|
|
3025
|
+
EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
3018
3026
|
version?: number;
|
|
3019
3027
|
blueprint?: /* Reference to blueprint */ BlueprintEntityId /* uuid */;
|
|
3020
3028
|
/**
|
|
@@ -3394,7 +3402,7 @@ declare namespace Components {
|
|
|
3394
3402
|
* example:
|
|
3395
3403
|
* contact
|
|
3396
3404
|
*/
|
|
3397
|
-
EntitySlug
|
|
3405
|
+
EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
3398
3406
|
version?: number;
|
|
3399
3407
|
blueprint?: /* Reference to blueprint */ BlueprintEntityId /* uuid */;
|
|
3400
3408
|
/**
|
|
@@ -3698,6 +3706,10 @@ declare namespace Components {
|
|
|
3698
3706
|
*
|
|
3699
3707
|
*/
|
|
3700
3708
|
EntitySearchIncludeDeletedParam;
|
|
3709
|
+
/**
|
|
3710
|
+
* Adds a `_score` number field to results that can be used to rank by match score
|
|
3711
|
+
*/
|
|
3712
|
+
include_scores?: boolean;
|
|
3701
3713
|
/**
|
|
3702
3714
|
* A TTL (in seconds) that specifies how long the context should be maintained.
|
|
3703
3715
|
* Defaults to 30 seconds; configurable up to 60 seconds to prevent abuse.
|
|
@@ -3918,7 +3930,7 @@ declare namespace Components {
|
|
|
3918
3930
|
* example:
|
|
3919
3931
|
* contact
|
|
3920
3932
|
*/
|
|
3921
|
-
export type EntitySlug = string;
|
|
3933
|
+
export type EntitySlug = string; // ^[a-zA-Z0-9_-]+$
|
|
3922
3934
|
export interface EntityTableFilterOption {
|
|
3923
3935
|
/**
|
|
3924
3936
|
* The type of filter option
|
|
@@ -4281,95 +4293,6 @@ declare namespace Components {
|
|
|
4281
4293
|
enable_description?: boolean;
|
|
4282
4294
|
default_access_control?: "public-read" | "private";
|
|
4283
4295
|
}
|
|
4284
|
-
export interface FileCollectionAttributes {
|
|
4285
|
-
/**
|
|
4286
|
-
* Name of the file collection
|
|
4287
|
-
*/
|
|
4288
|
-
name?: string;
|
|
4289
|
-
/**
|
|
4290
|
-
* Whether the collection is starred
|
|
4291
|
-
*/
|
|
4292
|
-
starred?: boolean;
|
|
4293
|
-
/**
|
|
4294
|
-
* Array of file IDs in this collection
|
|
4295
|
-
*/
|
|
4296
|
-
files?: string /* uuid */[];
|
|
4297
|
-
}
|
|
4298
|
-
/**
|
|
4299
|
-
* Request body for creating a file collection
|
|
4300
|
-
*/
|
|
4301
|
-
export interface FileCollectionCreateRequest {
|
|
4302
|
-
/**
|
|
4303
|
-
* Name of the file collection
|
|
4304
|
-
*/
|
|
4305
|
-
name: string;
|
|
4306
|
-
/**
|
|
4307
|
-
* Whether the collection is starred
|
|
4308
|
-
*/
|
|
4309
|
-
starred: boolean;
|
|
4310
|
-
/**
|
|
4311
|
-
* Array of file IDs in this collection
|
|
4312
|
-
*/
|
|
4313
|
-
files: string /* uuid */[];
|
|
4314
|
-
}
|
|
4315
|
-
/**
|
|
4316
|
-
* Generated uuid for a file collection
|
|
4317
|
-
*/
|
|
4318
|
-
export type FileCollectionId = string; // uuid
|
|
4319
|
-
/**
|
|
4320
|
-
* A file collection with identifiers and timestamps
|
|
4321
|
-
*/
|
|
4322
|
-
export interface FileCollectionItem {
|
|
4323
|
-
id: /* Generated uuid for a file collection */ FileCollectionId /* uuid */;
|
|
4324
|
-
/**
|
|
4325
|
-
* Organization ID
|
|
4326
|
-
* example:
|
|
4327
|
-
* 123
|
|
4328
|
-
*/
|
|
4329
|
-
orgId: string;
|
|
4330
|
-
entityId: EntityId /* uuid */;
|
|
4331
|
-
/**
|
|
4332
|
-
* Logical type for this item (e.g. "collection")
|
|
4333
|
-
* example:
|
|
4334
|
-
* collection
|
|
4335
|
-
*/
|
|
4336
|
-
type: string;
|
|
4337
|
-
/**
|
|
4338
|
-
* example:
|
|
4339
|
-
* MyCollectionOfImportantFiles
|
|
4340
|
-
*/
|
|
4341
|
-
name: string;
|
|
4342
|
-
entity_id: EntityId /* uuid */;
|
|
4343
|
-
/**
|
|
4344
|
-
* example:
|
|
4345
|
-
* false
|
|
4346
|
-
*/
|
|
4347
|
-
starred: boolean;
|
|
4348
|
-
/**
|
|
4349
|
-
* Array of file IDs in this collection
|
|
4350
|
-
* example:
|
|
4351
|
-
* [
|
|
4352
|
-
* "123e4567-e89b-12d3-a456-426614174000"
|
|
4353
|
-
* ]
|
|
4354
|
-
*/
|
|
4355
|
-
files: string /* uuid */[];
|
|
4356
|
-
/**
|
|
4357
|
-
* User ID who created the collection
|
|
4358
|
-
* example:
|
|
4359
|
-
* 17622
|
|
4360
|
-
*/
|
|
4361
|
-
created_by: string;
|
|
4362
|
-
/**
|
|
4363
|
-
* example:
|
|
4364
|
-
* 2025-08-20T12:01:00Z
|
|
4365
|
-
*/
|
|
4366
|
-
created_at: string; // date-time
|
|
4367
|
-
/**
|
|
4368
|
-
* example:
|
|
4369
|
-
* 2025-08-20T12:01:00Z
|
|
4370
|
-
*/
|
|
4371
|
-
updated_at: string; // date-time
|
|
4372
|
-
}
|
|
4373
4296
|
export interface GenerateEntityTableAIFiltersRequest {
|
|
4374
4297
|
/**
|
|
4375
4298
|
* The prompt to generate the filters
|
|
@@ -4680,7 +4603,7 @@ declare namespace Components {
|
|
|
4680
4603
|
* example:
|
|
4681
4604
|
* contact
|
|
4682
4605
|
*/
|
|
4683
|
-
EntitySlug
|
|
4606
|
+
EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
4684
4607
|
/**
|
|
4685
4608
|
* Title of entity
|
|
4686
4609
|
*/
|
|
@@ -6580,6 +6503,147 @@ declare namespace Components {
|
|
|
6580
6503
|
has_primary?: boolean;
|
|
6581
6504
|
type: "phone";
|
|
6582
6505
|
}
|
|
6506
|
+
/**
|
|
6507
|
+
* Portal access configuration
|
|
6508
|
+
*/
|
|
6509
|
+
export interface PortalAccessAttribute {
|
|
6510
|
+
/**
|
|
6511
|
+
* ID for the entity attribute
|
|
6512
|
+
* example:
|
|
6513
|
+
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
6514
|
+
*/
|
|
6515
|
+
id?: string;
|
|
6516
|
+
name: string;
|
|
6517
|
+
label: string;
|
|
6518
|
+
placeholder?: string;
|
|
6519
|
+
/**
|
|
6520
|
+
* Do not render attribute in entity views
|
|
6521
|
+
*/
|
|
6522
|
+
hidden?: boolean;
|
|
6523
|
+
/**
|
|
6524
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
6525
|
+
*/
|
|
6526
|
+
show_in_table?: boolean;
|
|
6527
|
+
/**
|
|
6528
|
+
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
6529
|
+
*/
|
|
6530
|
+
sortable?: boolean;
|
|
6531
|
+
required?: boolean;
|
|
6532
|
+
readonly?: boolean;
|
|
6533
|
+
deprecated?: boolean;
|
|
6534
|
+
default_value?: any;
|
|
6535
|
+
/**
|
|
6536
|
+
* Which group the attribute should appear in. Accepts group ID or group name
|
|
6537
|
+
*/
|
|
6538
|
+
group?: string;
|
|
6539
|
+
/**
|
|
6540
|
+
* Attribute sort order (ascending) in group
|
|
6541
|
+
* example:
|
|
6542
|
+
* 0
|
|
6543
|
+
*/
|
|
6544
|
+
order?: number;
|
|
6545
|
+
/**
|
|
6546
|
+
* example:
|
|
6547
|
+
* full_width
|
|
6548
|
+
*/
|
|
6549
|
+
layout?: string;
|
|
6550
|
+
/**
|
|
6551
|
+
* When set to true, will hide the label of the field.
|
|
6552
|
+
*/
|
|
6553
|
+
hide_label?: boolean;
|
|
6554
|
+
/**
|
|
6555
|
+
* Code name of the icon to used to represent this attribute.
|
|
6556
|
+
* The value must be a valid @epilot/base-elements Icon name
|
|
6557
|
+
*
|
|
6558
|
+
*/
|
|
6559
|
+
icon?: string;
|
|
6560
|
+
/**
|
|
6561
|
+
* Defines the conditional rendering expression for showing this field.
|
|
6562
|
+
* When a valid expression is parsed, their evaluation defines the visibility of this attribute.
|
|
6563
|
+
* Note: Empty or invalid expression have no effect on the field visibility.
|
|
6564
|
+
*
|
|
6565
|
+
*/
|
|
6566
|
+
render_condition?: string;
|
|
6567
|
+
_purpose?: /**
|
|
6568
|
+
* example:
|
|
6569
|
+
* taxonomy-slug:classification-slug
|
|
6570
|
+
*/
|
|
6571
|
+
ClassificationId[];
|
|
6572
|
+
/**
|
|
6573
|
+
* Manifest ID used to create/update the schema attribute
|
|
6574
|
+
*/
|
|
6575
|
+
_manifest?: string /* uuid */[] | null;
|
|
6576
|
+
/**
|
|
6577
|
+
* A set of constraints applicable to the attribute.
|
|
6578
|
+
* These constraints should and will be enforced by the attribute renderer.
|
|
6579
|
+
*
|
|
6580
|
+
* example:
|
|
6581
|
+
* {
|
|
6582
|
+
* "disablePast": true
|
|
6583
|
+
* }
|
|
6584
|
+
*/
|
|
6585
|
+
constraints?: {
|
|
6586
|
+
[key: string]: any;
|
|
6587
|
+
};
|
|
6588
|
+
/**
|
|
6589
|
+
* This attribute should only be active when the feature flag is enabled
|
|
6590
|
+
* example:
|
|
6591
|
+
* FF_MY_FEATURE_FLAG
|
|
6592
|
+
*/
|
|
6593
|
+
feature_flag?: string;
|
|
6594
|
+
/**
|
|
6595
|
+
* This attribute should only be active when one of the provided settings have the correct value
|
|
6596
|
+
*/
|
|
6597
|
+
settings_flag?: SettingFlag[];
|
|
6598
|
+
value_formatter?: string;
|
|
6599
|
+
preview_value_formatter?: string;
|
|
6600
|
+
/**
|
|
6601
|
+
* Setting to `true` disables editing the attribute on the entity builder UI
|
|
6602
|
+
*/
|
|
6603
|
+
entity_builder_disable_edit?: boolean;
|
|
6604
|
+
/**
|
|
6605
|
+
* Setting to `true` prevents the attribute from being modified / deleted
|
|
6606
|
+
*/
|
|
6607
|
+
protected?: boolean;
|
|
6608
|
+
/**
|
|
6609
|
+
* A set of configurations meant to document and assist the user in filling the attribute.
|
|
6610
|
+
*/
|
|
6611
|
+
info_helpers?: {
|
|
6612
|
+
/**
|
|
6613
|
+
* The text to be displayed in the attribute hint helper.
|
|
6614
|
+
* When specified it overrides the `hint_text_key` configuration.
|
|
6615
|
+
*
|
|
6616
|
+
*/
|
|
6617
|
+
hint_text?: string;
|
|
6618
|
+
/**
|
|
6619
|
+
* The key of the hint text to be displayed in the attribute hint helper.
|
|
6620
|
+
* The key should be a valid i18n key.
|
|
6621
|
+
*
|
|
6622
|
+
*/
|
|
6623
|
+
hint_text_key?: string;
|
|
6624
|
+
/**
|
|
6625
|
+
* The name of the custom component to be used as the hint helper.
|
|
6626
|
+
* The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
|
|
6627
|
+
* When specified it overrides the `hint_text` or `hint_text_key` configuration.
|
|
6628
|
+
*
|
|
6629
|
+
*/
|
|
6630
|
+
hint_custom_component?: string;
|
|
6631
|
+
/**
|
|
6632
|
+
* The placement of the hint tooltip.
|
|
6633
|
+
* The value should be a valid `@mui/core` tooltip placement.
|
|
6634
|
+
*
|
|
6635
|
+
* example:
|
|
6636
|
+
* top
|
|
6637
|
+
*/
|
|
6638
|
+
hint_tooltip_placement?: string;
|
|
6639
|
+
};
|
|
6640
|
+
/**
|
|
6641
|
+
* The attribute is a repeatable
|
|
6642
|
+
*/
|
|
6643
|
+
repeatable?: boolean;
|
|
6644
|
+
has_primary?: boolean;
|
|
6645
|
+
type: "portal_access";
|
|
6646
|
+
}
|
|
6583
6647
|
/**
|
|
6584
6648
|
* Price component
|
|
6585
6649
|
*/
|
|
@@ -7116,7 +7180,7 @@ declare namespace Components {
|
|
|
7116
7180
|
* example:
|
|
7117
7181
|
* contact
|
|
7118
7182
|
*/
|
|
7119
|
-
EntitySlug[];
|
|
7183
|
+
EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
|
|
7120
7184
|
/**
|
|
7121
7185
|
* When enable_relation_tags is set to true the user will be able to set tags(labels) in each relation item.
|
|
7122
7186
|
*/
|
|
@@ -7184,7 +7248,7 @@ declare namespace Components {
|
|
|
7184
7248
|
* example:
|
|
7185
7249
|
* contact
|
|
7186
7250
|
*/
|
|
7187
|
-
EntitySlug
|
|
7251
|
+
EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
7188
7252
|
/**
|
|
7189
7253
|
* Title of entity
|
|
7190
7254
|
*/
|
|
@@ -7374,7 +7438,7 @@ declare namespace Components {
|
|
|
7374
7438
|
* example:
|
|
7375
7439
|
* contact
|
|
7376
7440
|
*/
|
|
7377
|
-
EntitySlug[];
|
|
7441
|
+
EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
|
|
7378
7442
|
/**
|
|
7379
7443
|
* User-friendly identifier for the saved view
|
|
7380
7444
|
* example:
|
|
@@ -7451,7 +7515,7 @@ declare namespace Components {
|
|
|
7451
7515
|
* example:
|
|
7452
7516
|
* contact
|
|
7453
7517
|
*/
|
|
7454
|
-
EntitySlug[];
|
|
7518
|
+
EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
|
|
7455
7519
|
/**
|
|
7456
7520
|
* User-friendly identifier for the saved view
|
|
7457
7521
|
* example:
|
|
@@ -7521,7 +7585,7 @@ declare namespace Components {
|
|
|
7521
7585
|
* example:
|
|
7522
7586
|
* contact
|
|
7523
7587
|
*/
|
|
7524
|
-
EntitySlug[];
|
|
7588
|
+
EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
|
|
7525
7589
|
/**
|
|
7526
7590
|
* User-friendly identifier for the saved view
|
|
7527
7591
|
* example:
|
|
@@ -8947,7 +9011,7 @@ declare namespace Paths {
|
|
|
8947
9011
|
* example:
|
|
8948
9012
|
* contact
|
|
8949
9013
|
*/
|
|
8950
|
-
Components.Schemas.EntitySlug
|
|
9014
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
8951
9015
|
}
|
|
8952
9016
|
export interface PathParameters {
|
|
8953
9017
|
slug: Parameters.Slug;
|
|
@@ -9023,7 +9087,7 @@ declare namespace Paths {
|
|
|
9023
9087
|
* example:
|
|
9024
9088
|
* contact
|
|
9025
9089
|
*/
|
|
9026
|
-
Components.Schemas.EntitySlug
|
|
9090
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
9027
9091
|
}
|
|
9028
9092
|
export interface QueryParameters {
|
|
9029
9093
|
input?: Parameters.Input;
|
|
@@ -9223,7 +9287,7 @@ declare namespace Paths {
|
|
|
9223
9287
|
* example:
|
|
9224
9288
|
* contact
|
|
9225
9289
|
*/
|
|
9226
|
-
Components.Schemas.EntitySlug
|
|
9290
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
9227
9291
|
export type Validate = boolean;
|
|
9228
9292
|
}
|
|
9229
9293
|
export interface PathParameters {
|
|
@@ -9331,27 +9395,6 @@ declare namespace Paths {
|
|
|
9331
9395
|
Components.Responses.TooManyRequestsError;
|
|
9332
9396
|
}
|
|
9333
9397
|
}
|
|
9334
|
-
namespace CreateFileCollection {
|
|
9335
|
-
namespace Parameters {
|
|
9336
|
-
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
9337
|
-
}
|
|
9338
|
-
export interface PathParameters {
|
|
9339
|
-
id: Parameters.Id;
|
|
9340
|
-
}
|
|
9341
|
-
export type RequestBody = /* Request body for creating a file collection */ Components.Schemas.FileCollectionCreateRequest;
|
|
9342
|
-
namespace Responses {
|
|
9343
|
-
export type $201 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
|
|
9344
|
-
export type $404 = /**
|
|
9345
|
-
* A generic error returned by the API
|
|
9346
|
-
* example:
|
|
9347
|
-
* {
|
|
9348
|
-
* "status": 404,
|
|
9349
|
-
* "error": "Not Found"
|
|
9350
|
-
* }
|
|
9351
|
-
*/
|
|
9352
|
-
Components.Responses.NotFoundError;
|
|
9353
|
-
}
|
|
9354
|
-
}
|
|
9355
9398
|
namespace CreateSavedView {
|
|
9356
9399
|
export type RequestBody = /* A saved entity view */ Components.Schemas.SavedView;
|
|
9357
9400
|
namespace Responses {
|
|
@@ -9448,6 +9491,8 @@ declare namespace Paths {
|
|
|
9448
9491
|
export type RequestBody = Components.Schemas.TaxonomyClassification;
|
|
9449
9492
|
namespace Responses {
|
|
9450
9493
|
export type $201 = Components.Schemas.TaxonomyClassification;
|
|
9494
|
+
export interface $409 {
|
|
9495
|
+
}
|
|
9451
9496
|
export type $429 = /**
|
|
9452
9497
|
* A generic error returned by the API
|
|
9453
9498
|
* example:
|
|
@@ -9474,7 +9519,7 @@ declare namespace Paths {
|
|
|
9474
9519
|
* example:
|
|
9475
9520
|
* contact
|
|
9476
9521
|
*/
|
|
9477
|
-
Components.Schemas.EntitySlug
|
|
9522
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
9478
9523
|
}
|
|
9479
9524
|
export interface PathParameters {
|
|
9480
9525
|
slug: Parameters.Slug;
|
|
@@ -9498,29 +9543,6 @@ declare namespace Paths {
|
|
|
9498
9543
|
Components.Responses.TooManyRequestsError;
|
|
9499
9544
|
}
|
|
9500
9545
|
}
|
|
9501
|
-
namespace DeleteFileCollection {
|
|
9502
|
-
namespace Parameters {
|
|
9503
|
-
export type CollectionId = string; // uuid
|
|
9504
|
-
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
9505
|
-
}
|
|
9506
|
-
export interface PathParameters {
|
|
9507
|
-
id: Parameters.Id;
|
|
9508
|
-
collection_id: Parameters.CollectionId /* uuid */;
|
|
9509
|
-
}
|
|
9510
|
-
namespace Responses {
|
|
9511
|
-
export interface $200 {
|
|
9512
|
-
}
|
|
9513
|
-
export type $404 = /**
|
|
9514
|
-
* A generic error returned by the API
|
|
9515
|
-
* example:
|
|
9516
|
-
* {
|
|
9517
|
-
* "status": 404,
|
|
9518
|
-
* "error": "Not Found"
|
|
9519
|
-
* }
|
|
9520
|
-
*/
|
|
9521
|
-
Components.Responses.NotFoundError;
|
|
9522
|
-
}
|
|
9523
|
-
}
|
|
9524
9546
|
namespace DeleteRelation {
|
|
9525
9547
|
namespace Parameters {
|
|
9526
9548
|
export type ActivityId = /**
|
|
@@ -9538,7 +9560,7 @@ declare namespace Paths {
|
|
|
9538
9560
|
* example:
|
|
9539
9561
|
* contact
|
|
9540
9562
|
*/
|
|
9541
|
-
Components.Schemas.EntitySlug
|
|
9563
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
9542
9564
|
}
|
|
9543
9565
|
export interface PathParameters {
|
|
9544
9566
|
slug: Parameters.Slug;
|
|
@@ -9601,7 +9623,7 @@ declare namespace Paths {
|
|
|
9601
9623
|
* example:
|
|
9602
9624
|
* contact
|
|
9603
9625
|
*/
|
|
9604
|
-
Components.Schemas.EntitySlug
|
|
9626
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
9605
9627
|
}
|
|
9606
9628
|
export interface PathParameters {
|
|
9607
9629
|
slug: Parameters.Slug;
|
|
@@ -9850,7 +9872,7 @@ declare namespace Paths {
|
|
|
9850
9872
|
* example:
|
|
9851
9873
|
* contact
|
|
9852
9874
|
*/
|
|
9853
|
-
Components.Schemas.EntitySlug
|
|
9875
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
9854
9876
|
}
|
|
9855
9877
|
export interface PathParameters {
|
|
9856
9878
|
id: Parameters.Id;
|
|
@@ -9991,7 +10013,7 @@ declare namespace Paths {
|
|
|
9991
10013
|
* example:
|
|
9992
10014
|
* contact
|
|
9993
10015
|
*/
|
|
9994
|
-
Components.Schemas.EntitySlug
|
|
10016
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
9995
10017
|
export type StartDate = string; // date-time
|
|
9996
10018
|
/**
|
|
9997
10019
|
* example:
|
|
@@ -10074,7 +10096,7 @@ declare namespace Paths {
|
|
|
10074
10096
|
* example:
|
|
10075
10097
|
* contact
|
|
10076
10098
|
*/
|
|
10077
|
-
Components.Schemas.EntitySlug
|
|
10099
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
10078
10100
|
}
|
|
10079
10101
|
export interface PathParameters {
|
|
10080
10102
|
id: Parameters.Id;
|
|
@@ -10143,50 +10165,6 @@ declare namespace Paths {
|
|
|
10143
10165
|
Components.Responses.NotFoundError;
|
|
10144
10166
|
}
|
|
10145
10167
|
}
|
|
10146
|
-
namespace GetFileCollection {
|
|
10147
|
-
namespace Parameters {
|
|
10148
|
-
export type CollectionId = string; // uuid
|
|
10149
|
-
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
10150
|
-
}
|
|
10151
|
-
export interface PathParameters {
|
|
10152
|
-
id: Parameters.Id;
|
|
10153
|
-
collection_id: Parameters.CollectionId /* uuid */;
|
|
10154
|
-
}
|
|
10155
|
-
namespace Responses {
|
|
10156
|
-
export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
|
|
10157
|
-
export type $404 = /**
|
|
10158
|
-
* A generic error returned by the API
|
|
10159
|
-
* example:
|
|
10160
|
-
* {
|
|
10161
|
-
* "status": 404,
|
|
10162
|
-
* "error": "Not Found"
|
|
10163
|
-
* }
|
|
10164
|
-
*/
|
|
10165
|
-
Components.Responses.NotFoundError;
|
|
10166
|
-
}
|
|
10167
|
-
}
|
|
10168
|
-
namespace GetFileCollections {
|
|
10169
|
-
namespace Parameters {
|
|
10170
|
-
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
10171
|
-
}
|
|
10172
|
-
export interface PathParameters {
|
|
10173
|
-
id: Parameters.Id;
|
|
10174
|
-
}
|
|
10175
|
-
namespace Responses {
|
|
10176
|
-
export interface $200 {
|
|
10177
|
-
results?: /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem[];
|
|
10178
|
-
}
|
|
10179
|
-
export type $404 = /**
|
|
10180
|
-
* A generic error returned by the API
|
|
10181
|
-
* example:
|
|
10182
|
-
* {
|
|
10183
|
-
* "status": 404,
|
|
10184
|
-
* "error": "Not Found"
|
|
10185
|
-
* }
|
|
10186
|
-
*/
|
|
10187
|
-
Components.Responses.NotFoundError;
|
|
10188
|
-
}
|
|
10189
|
-
}
|
|
10190
10168
|
namespace GetJsonSchema {
|
|
10191
10169
|
namespace Parameters {
|
|
10192
10170
|
export type Dereference = boolean;
|
|
@@ -10195,7 +10173,7 @@ declare namespace Paths {
|
|
|
10195
10173
|
* example:
|
|
10196
10174
|
* contact
|
|
10197
10175
|
*/
|
|
10198
|
-
Components.Schemas.EntitySlug
|
|
10176
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
10199
10177
|
}
|
|
10200
10178
|
export interface PathParameters {
|
|
10201
10179
|
slug: Parameters.Slug;
|
|
@@ -10514,14 +10492,14 @@ declare namespace Paths {
|
|
|
10514
10492
|
* example:
|
|
10515
10493
|
* contact
|
|
10516
10494
|
*/
|
|
10517
|
-
Components.Schemas.EntitySlug[];
|
|
10495
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
|
|
10518
10496
|
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
10519
10497
|
export type Slug = /**
|
|
10520
10498
|
* URL-friendly identifier for the entity schema
|
|
10521
10499
|
* example:
|
|
10522
10500
|
* contact
|
|
10523
10501
|
*/
|
|
10524
|
-
Components.Schemas.EntitySlug
|
|
10502
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
10525
10503
|
}
|
|
10526
10504
|
export interface PathParameters {
|
|
10527
10505
|
slug: Parameters.Slug;
|
|
@@ -10550,7 +10528,7 @@ declare namespace Paths {
|
|
|
10550
10528
|
* example:
|
|
10551
10529
|
* contact
|
|
10552
10530
|
*/
|
|
10553
|
-
Components.Schemas.EntitySlug[];
|
|
10531
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
|
|
10554
10532
|
export type From = number;
|
|
10555
10533
|
export type Hydrate = boolean;
|
|
10556
10534
|
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
@@ -10560,14 +10538,14 @@ declare namespace Paths {
|
|
|
10560
10538
|
* example:
|
|
10561
10539
|
* contact
|
|
10562
10540
|
*/
|
|
10563
|
-
Components.Schemas.EntitySlug[];
|
|
10541
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
|
|
10564
10542
|
export type Size = number;
|
|
10565
10543
|
export type Slug = /**
|
|
10566
10544
|
* URL-friendly identifier for the entity schema
|
|
10567
10545
|
* example:
|
|
10568
10546
|
* contact
|
|
10569
10547
|
*/
|
|
10570
|
-
Components.Schemas.EntitySlug
|
|
10548
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
10571
10549
|
}
|
|
10572
10550
|
export interface PathParameters {
|
|
10573
10551
|
slug: Parameters.Slug;
|
|
@@ -10625,7 +10603,7 @@ declare namespace Paths {
|
|
|
10625
10603
|
* example:
|
|
10626
10604
|
* contact
|
|
10627
10605
|
*/
|
|
10628
|
-
Components.Schemas.EntitySlug
|
|
10606
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
10629
10607
|
}
|
|
10630
10608
|
export interface PathParameters {
|
|
10631
10609
|
slug: Parameters.Slug;
|
|
@@ -10659,7 +10637,7 @@ declare namespace Paths {
|
|
|
10659
10637
|
* example:
|
|
10660
10638
|
* contact
|
|
10661
10639
|
*/
|
|
10662
|
-
Components.Schemas.EntitySlug[];
|
|
10640
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
|
|
10663
10641
|
export type Fields = /**
|
|
10664
10642
|
* List of entity fields to include or exclude in the response
|
|
10665
10643
|
*
|
|
@@ -10687,7 +10665,7 @@ declare namespace Paths {
|
|
|
10687
10665
|
* example:
|
|
10688
10666
|
* contact
|
|
10689
10667
|
*/
|
|
10690
|
-
Components.Schemas.EntitySlug[];
|
|
10668
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
|
|
10691
10669
|
export type Mode = "direct" | "reverse" | "both";
|
|
10692
10670
|
export type Size = number;
|
|
10693
10671
|
export type Slug = /**
|
|
@@ -10695,7 +10673,7 @@ declare namespace Paths {
|
|
|
10695
10673
|
* example:
|
|
10696
10674
|
* contact
|
|
10697
10675
|
*/
|
|
10698
|
-
Components.Schemas.EntitySlug
|
|
10676
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
10699
10677
|
}
|
|
10700
10678
|
export interface PathParameters {
|
|
10701
10679
|
slug: Parameters.Slug;
|
|
@@ -10752,7 +10730,7 @@ declare namespace Paths {
|
|
|
10752
10730
|
* example:
|
|
10753
10731
|
* contact
|
|
10754
10732
|
*/
|
|
10755
|
-
Components.Schemas.EntitySlug
|
|
10733
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
10756
10734
|
}
|
|
10757
10735
|
export interface PathParameters {
|
|
10758
10736
|
slug: Parameters.Slug;
|
|
@@ -10836,7 +10814,7 @@ declare namespace Paths {
|
|
|
10836
10814
|
* example:
|
|
10837
10815
|
* contact
|
|
10838
10816
|
*/
|
|
10839
|
-
Components.Schemas.EntitySlug
|
|
10817
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
10840
10818
|
}
|
|
10841
10819
|
export interface PathParameters {
|
|
10842
10820
|
slug: Parameters.Slug;
|
|
@@ -10929,7 +10907,7 @@ declare namespace Paths {
|
|
|
10929
10907
|
* example:
|
|
10930
10908
|
* contact
|
|
10931
10909
|
*/
|
|
10932
|
-
Components.Schemas.EntitySlug
|
|
10910
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
10933
10911
|
export type VersionsFrom = number;
|
|
10934
10912
|
export type VersionsSize = number;
|
|
10935
10913
|
}
|
|
@@ -11116,7 +11094,7 @@ declare namespace Paths {
|
|
|
11116
11094
|
* example:
|
|
11117
11095
|
* contact
|
|
11118
11096
|
*/
|
|
11119
|
-
Components.Schemas.EntitySlug
|
|
11097
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
11120
11098
|
}
|
|
11121
11099
|
export interface PathParameters {
|
|
11122
11100
|
slug: Parameters.Slug;
|
|
@@ -11176,7 +11154,7 @@ declare namespace Paths {
|
|
|
11176
11154
|
* example:
|
|
11177
11155
|
* contact
|
|
11178
11156
|
*/
|
|
11179
|
-
Components.Schemas.EntitySlug
|
|
11157
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
11180
11158
|
export type Sort = string;
|
|
11181
11159
|
}
|
|
11182
11160
|
export interface QueryParameters {
|
|
@@ -11234,7 +11212,7 @@ declare namespace Paths {
|
|
|
11234
11212
|
* example:
|
|
11235
11213
|
* contact
|
|
11236
11214
|
*/
|
|
11237
|
-
Components.Schemas.EntitySlug
|
|
11215
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
11238
11216
|
export type TaxonomySlug = string;
|
|
11239
11217
|
}
|
|
11240
11218
|
export interface PathParameters {
|
|
@@ -11268,7 +11246,7 @@ declare namespace Paths {
|
|
|
11268
11246
|
* example:
|
|
11269
11247
|
* contact
|
|
11270
11248
|
*/
|
|
11271
|
-
Components.Schemas.EntitySlug
|
|
11249
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
11272
11250
|
export type Validate = boolean;
|
|
11273
11251
|
}
|
|
11274
11252
|
export interface PathParameters {
|
|
@@ -11391,7 +11369,7 @@ declare namespace Paths {
|
|
|
11391
11369
|
* example:
|
|
11392
11370
|
* contact
|
|
11393
11371
|
*/
|
|
11394
|
-
Components.Schemas.EntitySlug
|
|
11372
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
11395
11373
|
}
|
|
11396
11374
|
export interface PathParameters {
|
|
11397
11375
|
slug: Parameters.Slug;
|
|
@@ -11501,7 +11479,7 @@ declare namespace Paths {
|
|
|
11501
11479
|
* example:
|
|
11502
11480
|
* contact
|
|
11503
11481
|
*/
|
|
11504
|
-
Components.Schemas.EntitySlug
|
|
11482
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
11505
11483
|
}
|
|
11506
11484
|
export interface PathParameters {
|
|
11507
11485
|
id: Parameters.Id;
|
|
@@ -11590,7 +11568,7 @@ declare namespace Paths {
|
|
|
11590
11568
|
* example:
|
|
11591
11569
|
* contact
|
|
11592
11570
|
*/
|
|
11593
|
-
Components.Schemas.EntitySlug
|
|
11571
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
11594
11572
|
}
|
|
11595
11573
|
export interface PathParameters {
|
|
11596
11574
|
slug: Parameters.Slug;
|
|
@@ -11638,7 +11616,7 @@ declare namespace Paths {
|
|
|
11638
11616
|
* example:
|
|
11639
11617
|
* contact
|
|
11640
11618
|
*/
|
|
11641
|
-
Components.Schemas.EntitySlug
|
|
11619
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
11642
11620
|
}
|
|
11643
11621
|
export interface PathParameters {
|
|
11644
11622
|
id: Parameters.Id;
|
|
@@ -11866,7 +11844,7 @@ declare namespace Paths {
|
|
|
11866
11844
|
* example:
|
|
11867
11845
|
* contact
|
|
11868
11846
|
*/
|
|
11869
|
-
Components.Schemas.EntitySlug
|
|
11847
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
11870
11848
|
export type Validate = boolean;
|
|
11871
11849
|
}
|
|
11872
11850
|
export interface PathParameters {
|
|
@@ -11966,29 +11944,6 @@ declare namespace Paths {
|
|
|
11966
11944
|
export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
|
|
11967
11945
|
}
|
|
11968
11946
|
}
|
|
11969
|
-
namespace UpdateFileCollection {
|
|
11970
|
-
namespace Parameters {
|
|
11971
|
-
export type CollectionId = string; // uuid
|
|
11972
|
-
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
11973
|
-
}
|
|
11974
|
-
export interface PathParameters {
|
|
11975
|
-
id: Parameters.Id;
|
|
11976
|
-
collection_id: Parameters.CollectionId /* uuid */;
|
|
11977
|
-
}
|
|
11978
|
-
export type RequestBody = Components.Schemas.FileCollectionAttributes;
|
|
11979
|
-
namespace Responses {
|
|
11980
|
-
export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
|
|
11981
|
-
export type $404 = /**
|
|
11982
|
-
* A generic error returned by the API
|
|
11983
|
-
* example:
|
|
11984
|
-
* {
|
|
11985
|
-
* "status": 404,
|
|
11986
|
-
* "error": "Not Found"
|
|
11987
|
-
* }
|
|
11988
|
-
*/
|
|
11989
|
-
Components.Responses.NotFoundError;
|
|
11990
|
-
}
|
|
11991
|
-
}
|
|
11992
11947
|
namespace UpdateRelation {
|
|
11993
11948
|
namespace Parameters {
|
|
11994
11949
|
export type ActivityId = /**
|
|
@@ -12006,7 +11961,7 @@ declare namespace Paths {
|
|
|
12006
11961
|
* example:
|
|
12007
11962
|
* contact
|
|
12008
11963
|
*/
|
|
12009
|
-
Components.Schemas.EntitySlug
|
|
11964
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
12010
11965
|
}
|
|
12011
11966
|
export interface PathParameters {
|
|
12012
11967
|
slug: Parameters.Slug;
|
|
@@ -12088,7 +12043,7 @@ declare namespace Paths {
|
|
|
12088
12043
|
* example:
|
|
12089
12044
|
* contact
|
|
12090
12045
|
*/
|
|
12091
|
-
Components.Schemas.EntitySlug
|
|
12046
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
12092
12047
|
export type Strict = boolean;
|
|
12093
12048
|
export type Validate = boolean;
|
|
12094
12049
|
}
|
|
@@ -12266,7 +12221,7 @@ declare namespace Paths {
|
|
|
12266
12221
|
* example:
|
|
12267
12222
|
* price
|
|
12268
12223
|
*/
|
|
12269
|
-
export type Slug = string;
|
|
12224
|
+
export type Slug = string; // ^[a-zA-Z0-9_-]+$
|
|
12270
12225
|
}
|
|
12271
12226
|
export interface PathParameters {
|
|
12272
12227
|
slug: /**
|
|
@@ -12274,7 +12229,7 @@ declare namespace Paths {
|
|
|
12274
12229
|
* example:
|
|
12275
12230
|
* price
|
|
12276
12231
|
*/
|
|
12277
|
-
Parameters.Slug
|
|
12232
|
+
Parameters.Slug /* ^[a-zA-Z0-9_-]+$ */;
|
|
12278
12233
|
}
|
|
12279
12234
|
export type RequestBody = /**
|
|
12280
12235
|
* example:
|
|
@@ -12333,7 +12288,7 @@ declare namespace Paths {
|
|
|
12333
12288
|
* example:
|
|
12334
12289
|
* price
|
|
12335
12290
|
*/
|
|
12336
|
-
export type Slug = string;
|
|
12291
|
+
export type Slug = string; // ^[a-zA-Z0-9_-]+$
|
|
12337
12292
|
}
|
|
12338
12293
|
export interface PathParameters {
|
|
12339
12294
|
slug: /**
|
|
@@ -12341,7 +12296,7 @@ declare namespace Paths {
|
|
|
12341
12296
|
* example:
|
|
12342
12297
|
* price
|
|
12343
12298
|
*/
|
|
12344
|
-
Parameters.Slug
|
|
12299
|
+
Parameters.Slug /* ^[a-zA-Z0-9_-]+$ */;
|
|
12345
12300
|
}
|
|
12346
12301
|
export type RequestBody = /**
|
|
12347
12302
|
* example:
|
|
@@ -12400,7 +12355,7 @@ declare namespace Paths {
|
|
|
12400
12355
|
* example:
|
|
12401
12356
|
* contact
|
|
12402
12357
|
*/
|
|
12403
|
-
Components.Schemas.EntitySlug[];
|
|
12358
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
|
|
12404
12359
|
}
|
|
12405
12360
|
namespace Responses {
|
|
12406
12361
|
export interface $201 {
|
|
@@ -13493,56 +13448,6 @@ export interface OperationMethods {
|
|
|
13493
13448
|
data?: any,
|
|
13494
13449
|
config?: AxiosRequestConfig
|
|
13495
13450
|
): OperationResponse<Paths.DeleteSchemaGroupHeadline.Responses.$200>
|
|
13496
|
-
/**
|
|
13497
|
-
* getFileCollections - getFileCollections
|
|
13498
|
-
*
|
|
13499
|
-
* Gets a list of collections that exist for an entity
|
|
13500
|
-
*/
|
|
13501
|
-
'getFileCollections'(
|
|
13502
|
-
parameters?: Parameters<Paths.GetFileCollections.PathParameters> | null,
|
|
13503
|
-
data?: any,
|
|
13504
|
-
config?: AxiosRequestConfig
|
|
13505
|
-
): OperationResponse<Paths.GetFileCollections.Responses.$200>
|
|
13506
|
-
/**
|
|
13507
|
-
* createFileCollection - createFileCollection
|
|
13508
|
-
*
|
|
13509
|
-
* Creates a new file collection for the specified entity
|
|
13510
|
-
*/
|
|
13511
|
-
'createFileCollection'(
|
|
13512
|
-
parameters?: Parameters<Paths.CreateFileCollection.PathParameters> | null,
|
|
13513
|
-
data?: Paths.CreateFileCollection.RequestBody,
|
|
13514
|
-
config?: AxiosRequestConfig
|
|
13515
|
-
): OperationResponse<Paths.CreateFileCollection.Responses.$201>
|
|
13516
|
-
/**
|
|
13517
|
-
* getFileCollection - getFileCollection
|
|
13518
|
-
*
|
|
13519
|
-
* Gets a specific file collection by ID
|
|
13520
|
-
*/
|
|
13521
|
-
'getFileCollection'(
|
|
13522
|
-
parameters?: Parameters<Paths.GetFileCollection.PathParameters> | null,
|
|
13523
|
-
data?: any,
|
|
13524
|
-
config?: AxiosRequestConfig
|
|
13525
|
-
): OperationResponse<Paths.GetFileCollection.Responses.$200>
|
|
13526
|
-
/**
|
|
13527
|
-
* updateFileCollection - updateFileCollection
|
|
13528
|
-
*
|
|
13529
|
-
* Updates a specific file collection by ID
|
|
13530
|
-
*/
|
|
13531
|
-
'updateFileCollection'(
|
|
13532
|
-
parameters?: Parameters<Paths.UpdateFileCollection.PathParameters> | null,
|
|
13533
|
-
data?: Paths.UpdateFileCollection.RequestBody,
|
|
13534
|
-
config?: AxiosRequestConfig
|
|
13535
|
-
): OperationResponse<Paths.UpdateFileCollection.Responses.$200>
|
|
13536
|
-
/**
|
|
13537
|
-
* deleteFileCollection - deleteFileCollection
|
|
13538
|
-
*
|
|
13539
|
-
* Deletes a specific file collection by ID
|
|
13540
|
-
*/
|
|
13541
|
-
'deleteFileCollection'(
|
|
13542
|
-
parameters?: Parameters<Paths.DeleteFileCollection.PathParameters> | null,
|
|
13543
|
-
data?: any,
|
|
13544
|
-
config?: AxiosRequestConfig
|
|
13545
|
-
): OperationResponse<Paths.DeleteFileCollection.Responses.$200>
|
|
13546
13451
|
}
|
|
13547
13452
|
|
|
13548
13453
|
export interface PathsDictionary {
|
|
@@ -14740,60 +14645,6 @@ export interface PathsDictionary {
|
|
|
14740
14645
|
config?: AxiosRequestConfig
|
|
14741
14646
|
): OperationResponse<Paths.DeleteSchemaGroupHeadline.Responses.$200>
|
|
14742
14647
|
}
|
|
14743
|
-
['/v1/entity/{id}/collections']: {
|
|
14744
|
-
/**
|
|
14745
|
-
* getFileCollections - getFileCollections
|
|
14746
|
-
*
|
|
14747
|
-
* Gets a list of collections that exist for an entity
|
|
14748
|
-
*/
|
|
14749
|
-
'get'(
|
|
14750
|
-
parameters?: Parameters<Paths.GetFileCollections.PathParameters> | null,
|
|
14751
|
-
data?: any,
|
|
14752
|
-
config?: AxiosRequestConfig
|
|
14753
|
-
): OperationResponse<Paths.GetFileCollections.Responses.$200>
|
|
14754
|
-
/**
|
|
14755
|
-
* createFileCollection - createFileCollection
|
|
14756
|
-
*
|
|
14757
|
-
* Creates a new file collection for the specified entity
|
|
14758
|
-
*/
|
|
14759
|
-
'post'(
|
|
14760
|
-
parameters?: Parameters<Paths.CreateFileCollection.PathParameters> | null,
|
|
14761
|
-
data?: Paths.CreateFileCollection.RequestBody,
|
|
14762
|
-
config?: AxiosRequestConfig
|
|
14763
|
-
): OperationResponse<Paths.CreateFileCollection.Responses.$201>
|
|
14764
|
-
}
|
|
14765
|
-
['/v1/entity/{id}/collections/{collection_id}']: {
|
|
14766
|
-
/**
|
|
14767
|
-
* getFileCollection - getFileCollection
|
|
14768
|
-
*
|
|
14769
|
-
* Gets a specific file collection by ID
|
|
14770
|
-
*/
|
|
14771
|
-
'get'(
|
|
14772
|
-
parameters?: Parameters<Paths.GetFileCollection.PathParameters> | null,
|
|
14773
|
-
data?: any,
|
|
14774
|
-
config?: AxiosRequestConfig
|
|
14775
|
-
): OperationResponse<Paths.GetFileCollection.Responses.$200>
|
|
14776
|
-
/**
|
|
14777
|
-
* updateFileCollection - updateFileCollection
|
|
14778
|
-
*
|
|
14779
|
-
* Updates a specific file collection by ID
|
|
14780
|
-
*/
|
|
14781
|
-
'put'(
|
|
14782
|
-
parameters?: Parameters<Paths.UpdateFileCollection.PathParameters> | null,
|
|
14783
|
-
data?: Paths.UpdateFileCollection.RequestBody,
|
|
14784
|
-
config?: AxiosRequestConfig
|
|
14785
|
-
): OperationResponse<Paths.UpdateFileCollection.Responses.$200>
|
|
14786
|
-
/**
|
|
14787
|
-
* deleteFileCollection - deleteFileCollection
|
|
14788
|
-
*
|
|
14789
|
-
* Deletes a specific file collection by ID
|
|
14790
|
-
*/
|
|
14791
|
-
'delete'(
|
|
14792
|
-
parameters?: Parameters<Paths.DeleteFileCollection.PathParameters> | null,
|
|
14793
|
-
data?: any,
|
|
14794
|
-
config?: AxiosRequestConfig
|
|
14795
|
-
): OperationResponse<Paths.DeleteFileCollection.Responses.$200>
|
|
14796
|
-
}
|
|
14797
14648
|
}
|
|
14798
14649
|
|
|
14799
14650
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
@@ -14862,10 +14713,6 @@ export type ErrorObject = Components.Schemas.ErrorObject;
|
|
|
14862
14713
|
export type ExportJobId = Components.Schemas.ExportJobId;
|
|
14863
14714
|
export type FieldsParam = Components.Schemas.FieldsParam;
|
|
14864
14715
|
export type FileAttribute = Components.Schemas.FileAttribute;
|
|
14865
|
-
export type FileCollectionAttributes = Components.Schemas.FileCollectionAttributes;
|
|
14866
|
-
export type FileCollectionCreateRequest = Components.Schemas.FileCollectionCreateRequest;
|
|
14867
|
-
export type FileCollectionId = Components.Schemas.FileCollectionId;
|
|
14868
|
-
export type FileCollectionItem = Components.Schemas.FileCollectionItem;
|
|
14869
14716
|
export type GenerateEntityTableAIFiltersRequest = Components.Schemas.GenerateEntityTableAIFiltersRequest;
|
|
14870
14717
|
export type GenerateEntityTableAIFiltersResponse = Components.Schemas.GenerateEntityTableAIFiltersResponse;
|
|
14871
14718
|
export type GetRelatedEntitiesCount = Components.Schemas.GetRelatedEntitiesCount;
|
|
@@ -14891,6 +14738,7 @@ export type PartnerStatusAttribute = Components.Schemas.PartnerStatusAttribute;
|
|
|
14891
14738
|
export type PaymentAttribute = Components.Schemas.PaymentAttribute;
|
|
14892
14739
|
export type PaymentMethodRelationAttribute = Components.Schemas.PaymentMethodRelationAttribute;
|
|
14893
14740
|
export type PhoneAttribute = Components.Schemas.PhoneAttribute;
|
|
14741
|
+
export type PortalAccessAttribute = Components.Schemas.PortalAccessAttribute;
|
|
14894
14742
|
export type PriceComponentAttribute = Components.Schemas.PriceComponentAttribute;
|
|
14895
14743
|
export type PurposeAttribute = Components.Schemas.PurposeAttribute;
|
|
14896
14744
|
export type RedirectEntityView = Components.Schemas.RedirectEntityView;
|