@epilot/entity-client 4.15.0-rc1 → 4.15.0

package/dist/openapi.d.ts

@@ -158,6 +158,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -264,7 +268,7 @@ declare namespace Components {
             type?: "relation_address";
             has_primary?: boolean;
         }
-        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 | /* 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;
+        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 | /* 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;
         /**
          * Automation entity
          */
@@ -280,6 +284,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -397,6 +405,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -581,6 +593,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -707,6 +723,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -827,6 +847,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -949,6 +973,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -1069,6 +1097,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -1199,6 +1231,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -2532,6 +2568,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -2653,6 +2693,13 @@ declare namespace Components {
             enable_description?: boolean;
             default_access_control?: "public-read" | "private";
         }
+        export interface GetRelatedEntitiesCountByEntityId {
+            /**
+             * example:
+             * 1
+             */
+            hits?: number;
+        }
         export type GetRelationsResp = (RelationItem | /**
          * example:
          * {
@@ -2896,6 +2943,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -3016,6 +3067,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -3136,6 +3191,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -3264,6 +3323,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -3384,6 +3447,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -3520,6 +3587,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -3641,6 +3712,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -3746,6 +3821,130 @@ declare namespace Components {
             };
             type?: "ordered_list";
         }
+        /**
+         * Shared Partner Organisations
+         */
+        export interface PartnerOrganisationAttribute {
+            name: string;
+            label: string;
+            placeholder?: string;
+            /**
+             * Do not render attribute in entity views
+             */
+            hidden?: boolean;
+            /**
+             * Render as a column in table views. When defined, overrides `hidden`
+             */
+            show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
+            required?: boolean;
+            readonly?: boolean;
+            deprecated?: boolean;
+            default_value?: any;
+            /**
+             * Which group the attribute should appear in. Accepts group ID or group name
+             */
+            group?: string;
+            /**
+             * Attribute sort order (ascending) in group
+             * example:
+             * 0
+             */
+            order?: number;
+            /**
+             * example:
+             * full_width
+             */
+            layout?: string;
+            /**
+             * When set to true, will hide the label of the field.
+             */
+            hide_label?: boolean;
+            /**
+             * Code name of the icon to used to represent this attribute.
+             * The value must be a valid @epilot/base-elements Icon name
+             *
+             */
+            icon?: string;
+            /**
+             * Defines the conditional rendering expression for showing this field.
+             * When a valid expression is parsed, their evaluation defines the visibility of this attribute.
+             * Note: Empty or invalid expression have no effect on the field visibility.
+             *
+             */
+            render_condition?: string;
+            _purpose?: ClassificationId /* uuid */[];
+            /**
+             * A set of constraints applicable to the attribute.
+             * These constraints should and will be enforced by the attribute renderer.
+             *
+             * example:
+             * {
+             *   "disablePast": true
+             * }
+             */
+            constraints?: {
+                [key: string]: any;
+            };
+            /**
+             * This attribute should only be active when the feature flag is enabled
+             * example:
+             * FF_MY_FEATURE_FLAG
+             */
+            feature_flag?: string;
+            /**
+             * This attribute should only be active when the setting is enabled
+             * example:
+             * MY_SETTING
+             */
+            setting_flag?: string;
+            value_formatter?: string;
+            preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
+            /**
+             * A set of configurations meant to document and assist the user in filling the attribute.
+             */
+            info_helpers?: {
+                /**
+                 * The text to be displayed in the attribute hint helper.
+                 * When specified it overrides the `hint_text_key` configuration.
+                 *
+                 */
+                hint_text?: string;
+                /**
+                 * The key of the hint text to be displayed in the attribute hint helper.
+                 * The key should be a valid i18n key.
+                 *
+                 */
+                hint_text_key?: string;
+                /**
+                 * The name of the custom component to be used as the hint helper.
+                 * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
+                 * When specified it overrides the `hint_text` or `hint_text_key` configuration.
+                 *
+                 */
+                hint_custom_component?: string;
+                /**
+                 * The placement of the hint tooltip.
+                 * The value should be a valid `@mui/core` tooltip placement.
+                 *
+                 * example:
+                 * top
+                 */
+                hint_tooltip_placement?: string;
+            };
+            type?: "partner_organisation";
+        }
         /**
          * Partner Status
          */
@@ -3761,6 +3960,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -3881,6 +4084,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -4006,6 +4213,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -4145,6 +4356,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -4502,6 +4717,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -4648,6 +4867,10 @@ declare namespace Components {
              * true
              */
             shared?: boolean;
+            /**
+             * List of users (IDs) that have favorited the view
+             */
+            isFavoritedBy?: string[];
             created_by: {
                 /**
                  * example:
@@ -4717,6 +4940,10 @@ declare namespace Components {
              * true
              */
             shared?: boolean;
+            /**
+             * List of users (IDs) that have favorited the view
+             */
+            isFavoritedBy?: string[];
             created_by: {
                 /**
                  * example:
@@ -4787,6 +5014,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -4915,6 +5146,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -5042,6 +5277,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -5232,6 +5471,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -5393,6 +5636,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -5514,6 +5761,10 @@ declare namespace Components {
              * Render as a column in table views. When defined, overrides `hidden`
              */
             show_in_table?: boolean;
+            /**
+             * Allow sorting by this attribute in table views if `show_in_table` is true
+             */
+            sortable?: boolean;
             required?: boolean;
             readonly?: boolean;
             deprecated?: boolean;
@@ -5625,6 +5876,12 @@ declare namespace Components {
 declare namespace Paths {
     namespace AddRelations {
         namespace Parameters {
+            export type ActivityId = /**
+             * See https://github.com/ulid/spec
+             * example:
+             * 01F130Q52Q6MWSNS8N2AVXV4JN
+             */
+            Components.Schemas.ActivityId /* ulid */;
             export type Async = boolean;
             export type Id = Components.Schemas.EntityId /* uuid */;
             export type Slug = /**
@@ -5640,6 +5897,7 @@ declare namespace Paths {
         }
         export interface QueryParameters {
             async?: Parameters.Async;
+            activity_id?: Parameters.ActivityId;
         }
         export type RequestBody = Components.Schemas.RelationItem[];
         namespace Responses {
@@ -5861,6 +6119,12 @@ declare namespace Paths {
     }
     namespace DeleteRelation {
         namespace Parameters {
+            export type ActivityId = /**
+             * See https://github.com/ulid/spec
+             * example:
+             * 01F130Q52Q6MWSNS8N2AVXV4JN
+             */
+            Components.Schemas.ActivityId /* ulid */;
             export type Async = boolean;
             export type Attribute = string;
             export type EntityId = string;
@@ -5880,6 +6144,7 @@ declare namespace Paths {
         }
         export interface QueryParameters {
             async?: Parameters.Async;
+            activity_id?: Parameters.ActivityId;
         }
         namespace Responses {
             export interface $204 {
@@ -6074,6 +6339,7 @@ declare namespace Paths {
             export type Before = string; // date-time
             export type From = number;
             export type Id = Components.Schemas.EntityId /* uuid */;
+            export type IncludeRelations = boolean;
             export type Size = number;
             export type Slug = /**
              * URL-friendly identifier for the entity schema
@@ -6101,6 +6367,7 @@ declare namespace Paths {
              * SyncActivity
              */
             Parameters.Type;
+            include_relations?: Parameters.IncludeRelations;
         }
         namespace Responses {
             export interface $200 {
@@ -6137,6 +6404,24 @@ declare namespace Paths {
             export type $200 = Components.Schemas.GetRelationsResp;
         }
     }
+    namespace GetRelatedEntitiesCountByEntityId {
+        namespace Parameters {
+            export type Id = Components.Schemas.EntityId /* uuid */;
+            export type Slug = /**
+             * URL-friendly identifier for the entity schema
+             * example:
+             * contact
+             */
+            Components.Schemas.EntitySlug;
+        }
+        export interface PathParameters {
+            slug: Parameters.Slug;
+            id: Parameters.Id;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.GetRelatedEntitiesCountByEntityId;
+        }
+    }
     namespace GetRelationsV2 {
         namespace Parameters {
             /**
@@ -6281,6 +6566,13 @@ declare namespace Paths {
             }
         }
     }
+    namespace ListFavoriteViewsForUser {
+        namespace Responses {
+            export interface $200 {
+                results?: /* A saved entity view */ Components.Schemas.SavedViewItem[];
+            }
+        }
+    }
     namespace ListSavedViews {
         namespace Responses {
             export interface $200 {
@@ -6640,6 +6932,12 @@ declare namespace Paths {
     }
     namespace UpdateRelation {
         namespace Parameters {
+            export type ActivityId = /**
+             * See https://github.com/ulid/spec
+             * example:
+             * 01F130Q52Q6MWSNS8N2AVXV4JN
+             */
+            Components.Schemas.ActivityId /* ulid */;
             export type Async = boolean;
             export type Attribute = string;
             export type EntityId = string;
@@ -6659,6 +6957,7 @@ declare namespace Paths {
         }
         export interface QueryParameters {
             async?: Parameters.Async;
+            activity_id?: Parameters.ActivityId;
         }
         export interface RequestBody {
             _tags?: string[];
@@ -7295,6 +7594,17 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetRelationsV2.Responses.$200>
+  /**
+   * getRelatedEntitiesCountByEntityId - getRelatedEntitiesCountByEntityId
+   * 
+   * Returns the amount of unique related entities for an entity - includes direct and reverse relations.
+   * 
+   */
+  'getRelatedEntitiesCountByEntityId'(
+    parameters?: Parameters<Paths.GetRelatedEntitiesCountByEntityId.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetRelatedEntitiesCountByEntityId.Responses.$200>
   /**
    * updateRelation - updateRelation
    * 
@@ -7388,6 +7698,16 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteSavedView.Responses.$200>
+  /**
+   * listFavoriteViewsForUser - listFavoriteViewsForUser
+   * 
+   * Get the Favorite Saved Views for user based on the schema
+   */
+  'listFavoriteViewsForUser'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ListFavoriteViewsForUser.Responses.$200>
   /**
    * listTaxonomies - listTaxonomies
    * 
@@ -7928,6 +8248,19 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetRelationsV2.Responses.$200>
   }
+  ['/v2/entity/{slug}/{id}/relations/count']: {
+    /**
+     * getRelatedEntitiesCountByEntityId - getRelatedEntitiesCountByEntityId
+     * 
+     * Returns the amount of unique related entities for an entity - includes direct and reverse relations
+     * 
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetRelatedEntitiesCountByEntityId.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetRelatedEntitiesCountByEntityId.Responses.$200>
+  }
   ['/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}']: {
     /**
      * updateRelation - updateRelation
@@ -8033,6 +8366,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeleteSavedView.Responses.$200>
   }
+  ['/v1/entity/views/favorites']: {
+    /**
+     * listFavoriteViewsForUser - listFavoriteViewsForUser
+     * 
+     * Get the Favorite Saved Views for user based on the schema
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ListFavoriteViewsForUser.Responses.$200>
+  }
   ['/v1/entity/listTaxonomies']: {
     /**
      * listTaxonomies - listTaxonomies