@epilot/entity-client 4.22.0 → 4.23.0

package/{dist → src}/openapi.d.ts

@@ -348,6 +348,16 @@ declare namespace Components {
             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 | /* Shared Partner Organisations */ PartnerOrganisationAttribute;
+        /**
+         * a readonly computed ID for the attribute including schema slug and the attribute ID
+         */
+        export type AttributeWithCompositeID = {
+            /**
+             * example:
+             * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
+             */
+            composite_id?: string;
+        } & (/* 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);
         /**
          * Automation entity
          */
@@ -474,6 +484,45 @@ declare namespace Components {
             };
             type?: "automation";
         }
+        export interface BaseActivityItem {
+            _id?: /**
+             * See https://github.com/ulid/spec
+             * example:
+             * 01F130Q52Q6MWSNS8N2AVXV4JN
+             */
+            ActivityId /* ulid */;
+            timestamp?: string; // date-time
+            /**
+             * example:
+             * MyCustomActivity
+             */
+            type: string;
+            /**
+             * Title for activity. Supports handlebars syntax.
+             * example:
+             * My custom activity
+             */
+            title: string;
+            /**
+             * Message for activity. Supports handlebars syntax.
+             * example:
+             * {{caller}} did something with {{entity payload.entity.id}}.
+             */
+            message: string;
+            /**
+             * example:
+             * {
+             *   "entity": {
+             *     "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+             *     "schema": "contact"
+             *   }
+             * }
+             */
+            payload?: {
+                [name: string]: any;
+            };
+            caller?: ActivityCallerContext;
+        }
         export interface BaseAttribute {
             name: string;
             label: string;
@@ -1651,6 +1700,120 @@ declare namespace Components {
              */
             settings_flag?: SettingFlag[];
         }
+        /**
+         * a readonly computed ID for the entity capability including schema slug and the capability ID
+         */
+        export interface EntityCapabilityWithCompositeID {
+            /**
+             * Unique name for the capability
+             * example:
+             * customer_messaging
+             */
+            name: string;
+            /**
+             * Human readable title of the capability
+             * example:
+             * Messaging
+             */
+            title?: string;
+            attributes?: Attribute[];
+            _purpose?: /**
+             * example:
+             * taxonomy-slug:classification-slug
+             */
+            ClassificationId[];
+            ui_hooks?: {
+                [name: string]: any;
+                /**
+                 * name of the hook to use
+                 * example:
+                 * EntityDetailsV2:Tab
+                 */
+                hook: string;
+                /**
+                 * example:
+                 * _is_composite_price = "false"
+                 */
+                render_condition?: string;
+                /**
+                 * render order (ascending)
+                 * example:
+                 * 10
+                 */
+                order?: number;
+                /**
+                 * example:
+                 * Notes
+                 */
+                title?: string;
+                /**
+                 * Sets the group expand/collapse default state
+                 */
+                group_expanded?: boolean;
+                /**
+                 * package to be imported
+                 * example:
+                 * @epilot360/notes
+                 */
+                import?: string;
+                /**
+                 * the component to be dynamically loaded
+                 * example:
+                 * PricingItems
+                 */
+                component?: string;
+                /**
+                 * route for specified capability
+                 * example:
+                 * notes
+                 */
+                route?: string;
+                /**
+                 * Preview icon name(As in Base elements) for the capability
+                 * example:
+                 * email
+                 */
+                icon?: string;
+                /**
+                 * Whether capability should be disabled
+                 */
+                disabled?: boolean;
+                /**
+                 * Specific to Activity pilot
+                 */
+                header?: boolean;
+                /**
+                 * Require a permission to display UI hook
+                 */
+                requiredPermission?: {
+                    /**
+                     * example:
+                     * note:view
+                     */
+                    action: string;
+                    /**
+                     * example:
+                     * 123
+                     */
+                    resource?: string;
+                };
+            }[];
+            /**
+             * This capability should only be active when the feature flag is enabled
+             * example:
+             * FF_MY_FEATURE_FLAG
+             */
+            feature_flag?: string;
+            /**
+             * This capability should only be active when all the settings have the correct value
+             */
+            settings_flag?: SettingFlag[];
+            /**
+             * example:
+             * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
+             */
+            composite_id?: string;
+        }
         export interface EntityDefaultCreate {
             view_type?: "default";
             search_params?: {
@@ -2914,73 +3077,6 @@ declare namespace Components {
             hits?: number;
             relations?: GetRelationsResp;
         }
-        /**
-         * Entity with relation data resolved into the attribute values
-         * example:
-         * {
-         *   "_relations": [
-         *     {
-         *       "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
-         *     }
-         *   ],
-         *   "status": "active",
-         *   "customer_number": "abc123",
-         *   "email": [
-         *     {
-         *       "label": "work",
-         *       "email": "user@example.com"
-         *     }
-         *   ],
-         *   "phone": [
-         *     {
-         *       "label": "work",
-         *       "phone": "+49123456789"
-         *     }
-         *   ],
-         *   "first_name": "First Name",
-         *   "middle_name": "Middle Name",
-         *   "last_name": "Last Name",
-         *   "date_of_birth": "2019-08-24",
-         *   "title": "Mr.",
-         *   "account": [
-         *     {
-         *       "status": "active",
-         *       "name": "Company name",
-         *       "company_email": [
-         *         {
-         *           "label": "Company email",
-         *           "email": "company@example.com"
-         *         }
-         *       ],
-         *       "company_phone": [
-         *         {
-         *           "label": "Support phone",
-         *           "phone": "+49123456789"
-         *         }
-         *       ],
-         *       "company_website": "https://example.com",
-         *       "tax_id": "DE123456789",
-         *       "tax_exemption": "2019-08-24",
-         *       "contacts": {
-         *         "$relation": [
-         *           {
-         *             "_tags": [
-         *               "CEO"
-         *             ],
-         *             "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
-         *           }
-         *         ]
-         *       }
-         *     }
-         *   ]
-         * }
-         */
-        export interface HydratedEntity {
-            [name: string]: any;
-            _relations: {
-                entity_id: EntityId /* uuid */;
-            }[];
-        }
         /**
          * No UI representation
          */
@@ -3769,6 +3865,10 @@ declare namespace Components {
             };
             type?: "number";
             format?: string;
+            /**
+             * Whether or not to show a thousands separator
+             */
+            show_separator?: boolean;
         }
         /**
          * Type of attribute to render N number of ordered fields
@@ -6092,7 +6192,7 @@ declare namespace Paths {
             entities?: Parameters.Entities;
         }
         namespace Responses {
-            export type $200 = Components.Schemas.ActivityItem;
+            export type $200 = Components.Schemas.BaseActivityItem;
         }
     }
     namespace Autocomplete {
@@ -6149,7 +6249,7 @@ declare namespace Paths {
         }
         export type RequestBody = Components.Schemas.Activity;
         namespace Responses {
-            export type $200 = Components.Schemas.ActivityItem;
+            export type $200 = Components.Schemas.BaseActivityItem;
         }
     }
     namespace CreateEntity {
@@ -6414,6 +6514,44 @@ declare namespace Paths {
             }
         }
     }
+    namespace DeleteSchemaAttribute {
+        namespace Parameters {
+            /**
+             * example:
+             * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
+             */
+            export type CompositeId = string; // ^.+:.+$
+        }
+        export interface PathParameters {
+            composite_id: /**
+             * example:
+             * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
+             */
+            Parameters.CompositeId /* ^.+:.+$ */;
+        }
+        namespace Responses {
+            export type $200 = /* a readonly computed ID for the attribute including schema slug and the attribute ID */ Components.Schemas.AttributeWithCompositeID;
+        }
+    }
+    namespace DeleteSchemaCapability {
+        namespace Parameters {
+            /**
+             * example:
+             * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
+             */
+            export type CompositeId = string; // ^.+:.+$
+        }
+        export interface PathParameters {
+            composite_id: /**
+             * example:
+             * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
+             */
+            Parameters.CompositeId /* ^.+:.+$ */;
+        }
+        namespace Responses {
+            export type $200 = /* a readonly computed ID for the entity capability including schema slug and the capability ID */ Components.Schemas.EntityCapabilityWithCompositeID;
+        }
+    }
     namespace DeleteTaxonomy {
         namespace Parameters {
             export type Permanent = boolean;
@@ -6924,6 +7062,44 @@ declare namespace Paths {
             export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
         }
     }
+    namespace GetSchemaAttribute {
+        namespace Parameters {
+            /**
+             * example:
+             * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
+             */
+            export type CompositeId = string; // ^.+:.+$
+        }
+        export interface PathParameters {
+            composite_id: /**
+             * example:
+             * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
+             */
+            Parameters.CompositeId /* ^.+:.+$ */;
+        }
+        namespace Responses {
+            export type $200 = /* a readonly computed ID for the attribute including schema slug and the attribute ID */ Components.Schemas.AttributeWithCompositeID;
+        }
+    }
+    namespace GetSchemaCapability {
+        namespace Parameters {
+            /**
+             * example:
+             * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
+             */
+            export type CompositeId = string; // ^.+:.+$
+        }
+        export interface PathParameters {
+            composite_id: /**
+             * example:
+             * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
+             */
+            Parameters.CompositeId /* ^.+:.+$ */;
+        }
+        namespace Responses {
+            export type $200 = /* a readonly computed ID for the entity capability including schema slug and the capability ID */ Components.Schemas.EntityCapabilityWithCompositeID;
+        }
+    }
     namespace GetSchemaVersions {
         namespace Parameters {
             export type DraftsFrom = number;
@@ -7236,6 +7412,46 @@ declare namespace Paths {
             export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
         }
     }
+    namespace PutSchemaAttribute {
+        namespace Parameters {
+            /**
+             * example:
+             * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
+             */
+            export type CompositeId = string; // ^.+:.+$
+        }
+        export interface PathParameters {
+            composite_id: /**
+             * example:
+             * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
+             */
+            Parameters.CompositeId /* ^.+:.+$ */;
+        }
+        export type RequestBody = /* a readonly computed ID for the attribute including schema slug and the attribute ID */ Components.Schemas.AttributeWithCompositeID;
+        namespace Responses {
+            export type $200 = /* a readonly computed ID for the attribute including schema slug and the attribute ID */ Components.Schemas.AttributeWithCompositeID;
+        }
+    }
+    namespace PutSchemaCapability {
+        namespace Parameters {
+            /**
+             * example:
+             * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
+             */
+            export type CompositeId = string; // ^.+:.+$
+        }
+        export interface PathParameters {
+            composite_id: /**
+             * example:
+             * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
+             */
+            Parameters.CompositeId /* ^.+:.+$ */;
+        }
+        export type RequestBody = /* a readonly computed ID for the entity capability including schema slug and the capability ID */ Components.Schemas.EntityCapabilityWithCompositeID;
+        namespace Responses {
+            export type $200 = /* a readonly computed ID for the entity capability including schema slug and the capability ID */ Components.Schemas.EntityCapabilityWithCompositeID;
+        }
+    }
     namespace SearchEntities {
         export type RequestBody = Components.Schemas.EntitySearchParams;
         namespace Responses {
@@ -8473,6 +8689,66 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$204>
+  /**
+   * getSchemaAttribute - getSchemaAttribute
+   * 
+   * Get a schema attribute from given attribute ID
+   */
+  'getSchemaAttribute'(
+    parameters?: Parameters<Paths.GetSchemaAttribute.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetSchemaAttribute.Responses.$200>
+  /**
+   * putSchemaAttribute - putSchemaAttribute
+   * 
+   * Adds or updates an attribute in the schema
+   */
+  'putSchemaAttribute'(
+    parameters?: Parameters<Paths.PutSchemaAttribute.PathParameters> | null,
+    data?: Paths.PutSchemaAttribute.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.PutSchemaAttribute.Responses.$200>
+  /**
+   * deleteSchemaAttribute - deleteSchemaAttribute
+   * 
+   * Deletes an attribute from a schema
+   */
+  'deleteSchemaAttribute'(
+    parameters?: Parameters<Paths.DeleteSchemaAttribute.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteSchemaAttribute.Responses.$200>
+  /**
+   * getSchemaCapability - getSchemaCapability
+   * 
+   * Get a schema capability from given capability ID
+   */
+  'getSchemaCapability'(
+    parameters?: Parameters<Paths.GetSchemaCapability.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetSchemaCapability.Responses.$200>
+  /**
+   * putSchemaCapability - putSchemaCapability
+   * 
+   * Adds or updates an capability in the schema
+   */
+  'putSchemaCapability'(
+    parameters?: Parameters<Paths.PutSchemaCapability.PathParameters> | null,
+    data?: Paths.PutSchemaCapability.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.PutSchemaCapability.Responses.$200>
+  /**
+   * deleteSchemaCapability - deleteSchemaCapability
+   * 
+   * Deletes a Capability from a schema
+   */
+  'deleteSchemaCapability'(
+    parameters?: Parameters<Paths.DeleteSchemaCapability.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteSchemaCapability.Responses.$200>
 }
 
 export interface PathsDictionary {
@@ -9273,6 +9549,70 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$204>
   }
+  ['/v1/entity/schemas/attributes/{composite_id}']: {
+    /**
+     * getSchemaAttribute - getSchemaAttribute
+     * 
+     * Get a schema attribute from given attribute ID
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetSchemaAttribute.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetSchemaAttribute.Responses.$200>
+    /**
+     * putSchemaAttribute - putSchemaAttribute
+     * 
+     * Adds or updates an attribute in the schema
+     */
+    'put'(
+      parameters?: Parameters<Paths.PutSchemaAttribute.PathParameters> | null,
+      data?: Paths.PutSchemaAttribute.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.PutSchemaAttribute.Responses.$200>
+    /**
+     * deleteSchemaAttribute - deleteSchemaAttribute
+     * 
+     * Deletes an attribute from a schema
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteSchemaAttribute.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DeleteSchemaAttribute.Responses.$200>
+  }
+  ['/v1/entity/schemas/capabilities/{composite_id}']: {
+    /**
+     * getSchemaCapability - getSchemaCapability
+     * 
+     * Get a schema capability from given capability ID
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetSchemaCapability.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetSchemaCapability.Responses.$200>
+    /**
+     * putSchemaCapability - putSchemaCapability
+     * 
+     * Adds or updates an capability in the schema
+     */
+    'put'(
+      parameters?: Parameters<Paths.PutSchemaCapability.PathParameters> | null,
+      data?: Paths.PutSchemaCapability.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.PutSchemaCapability.Responses.$200>
+    /**
+     * deleteSchemaCapability - deleteSchemaCapability
+     * 
+     * Deletes a Capability from a schema
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteSchemaCapability.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DeleteSchemaCapability.Responses.$200>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>