@epilot/entity-client 3.1.0 → 3.1.3-alpha.0

package/dist/openapi.d.ts

@@ -217,7 +217,77 @@ declare namespace Components {
             download_url: string;
             alt_text?: string;
         }
-        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 | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* 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;
+        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 | /* Status select */ StatusAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* 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 | /* An attribute that holds a set of price components, used for dynamic pricing */ PriceComponentsAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute;
+        /**
+         * Automation entity
+         */
+        export interface AutomationAttribute {
+            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;
+            required?: boolean;
+            readonly?: boolean;
+            deprecated?: boolean;
+            default_value?: string | {
+                [name: string]: any;
+            } | number | number | boolean | any[];
+            group?: string;
+            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;
+            /**
+             * 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;
+            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;
+            type?: "automation";
+        }
         export interface BaseAttribute {
             name: string;
             label: string;
@@ -673,6 +743,7 @@ declare namespace Components {
              */
             protected?: boolean;
             type: "currency";
+            currency_selector_only?: boolean;
             /**
              * An array of currency configurations with a country code (ISO-4217)
              */
@@ -781,6 +852,11 @@ declare namespace Components {
                  * EntityDetailsV2:Tab
                  */
                 hook: string;
+                /**
+                 * example:
+                 * composite_price = "false"
+                 */
+                render_condition?: string;
                 /**
                  * render order (ascending)
                  * example:
@@ -914,8 +990,8 @@ declare namespace Components {
          *     "example",
          *     "mock"
          *   ],
-         *   "_created_at": {},
-         *   "_updated_at": {}
+         *   "_created_at": "2021-02-09T12:41:43.662Z",
+         *   "_updated_at": "2021-02-09T12:41:43.662Z"
          * }
          */
         export interface EntityItem {
@@ -974,6 +1050,11 @@ declare namespace Components {
             payload?: {
                 [name: string]: any;
             };
+            diff?: {
+                added?: Entity;
+                updated?: Entity;
+                deleted?: Entity;
+            };
         }
         /**
          * example:
@@ -1051,6 +1132,14 @@ declare namespace Components {
                 list_item?: {
                     summary_attributes?: string[];
                 };
+                sharing?: {
+                    /**
+                     * Show the sharing button in entity detail view
+                     * example:
+                     * true
+                     */
+                    show_sharing_button?: boolean;
+                };
             };
             capabilities?: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
             /**
@@ -1073,10 +1162,21 @@ declare namespace Components {
                 label: string;
                 id: string;
                 expanded?: boolean;
+                /**
+                 * example:
+                 * composite_price = "false"
+                 */
+                render_condition?: string;
                 /**
                  * Render order of the group
                  */
                 order?: number;
+                /**
+                 * This schema should only be active when the feature flag is enabled
+                 * example:
+                 * FF_MY_FEATURE_FLAG
+                 */
+                feature_flag?: string;
                 info_tooltip_title?: {
                     key?: string;
                     default?: string;
@@ -1162,6 +1262,11 @@ declare namespace Components {
             id?: /* Generated uuid for schema */ SchemaId /* uuid */;
             created_at?: string;
             updated_at?: string;
+            comment?: string;
+            source?: {
+                id?: string;
+                type?: string;
+            };
             slug: /**
              * URL-friendly identifier for the entity schema
              * example:
@@ -1219,6 +1324,14 @@ declare namespace Components {
                 list_item?: {
                     summary_attributes?: string[];
                 };
+                sharing?: {
+                    /**
+                     * Show the sharing button in entity detail view
+                     * example:
+                     * true
+                     */
+                    show_sharing_button?: boolean;
+                };
             };
             capabilities?: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
             /**
@@ -1241,10 +1354,21 @@ declare namespace Components {
                 label: string;
                 id: string;
                 expanded?: boolean;
+                /**
+                 * example:
+                 * composite_price = "false"
+                 */
+                render_condition?: string;
                 /**
                  * Render order of the group
                  */
                 order?: number;
+                /**
+                 * This schema should only be active when the feature flag is enabled
+                 * example:
+                 * FF_MY_FEATURE_FLAG
+                 */
+                feature_flag?: string;
                 info_tooltip_title?: {
                     key?: string;
                     default?: string;
@@ -1378,8 +1502,8 @@ declare namespace Components {
              *     "example",
              *     "mock"
              *   ],
-             *   "_created_at": {},
-             *   "_updated_at": {}
+             *   "_created_at": "2021-02-09T12:41:43.662Z",
+             *   "_updated_at": "2021-02-09T12:41:43.662Z"
              * }
              */
             EntityItem[];
@@ -1494,8 +1618,8 @@ declare namespace Components {
          *     "example",
          *     "mock"
          *   ],
-         *   "_created_at": {},
-         *   "_updated_at": {}
+         *   "_created_at": "2021-02-09T12:41:43.662Z",
+         *   "_updated_at": "2021-02-09T12:41:43.662Z"
          * }
          */
         RelationEntity)[];
@@ -1569,8 +1693,8 @@ declare namespace Components {
          *     "example",
          *     "mock"
          *   ],
-         *   "_created_at": {},
-         *   "_updated_at": {},
+         *   "_created_at": "2021-02-09T12:41:43.662Z",
+         *   "_updated_at": "2021-02-09T12:41:43.662Z",
          *   "status": "active",
          *   "customer_number": "abc123",
          *   "email": [
@@ -1714,6 +1838,146 @@ declare namespace Components {
             protected?: boolean;
             type?: "internal";
         }
+        /**
+         * Epilot internal user info
+         */
+        export interface InternalUserAttribute {
+            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;
+            required?: boolean;
+            readonly?: boolean;
+            deprecated?: boolean;
+            default_value?: string | {
+                [name: string]: any;
+            } | number | number | boolean | any[];
+            group?: string;
+            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;
+            /**
+             * 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;
+            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;
+            type?: "internal_user";
+        }
+        /**
+         * Email address for send invitation
+         */
+        export interface InvitationEmailAttribute {
+            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;
+            required?: boolean;
+            readonly?: boolean;
+            deprecated?: boolean;
+            default_value?: string | {
+                [name: string]: any;
+            } | number | number | boolean | any[];
+            group?: string;
+            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;
+            /**
+             * 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;
+            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;
+            type?: "invitation_email";
+        }
         /**
          * Link with title and href
          */
@@ -1995,6 +2259,76 @@ declare namespace Components {
             protected?: boolean;
             type?: "partner_status";
         }
+        /**
+         * An attribute that holds a set of price components, used for dynamic pricing
+         */
+        export interface PriceComponentsAttribute {
+            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;
+            required?: boolean;
+            readonly?: boolean;
+            deprecated?: boolean;
+            default_value?: string | {
+                [name: string]: any;
+            } | number | number | boolean | any[];
+            group?: string;
+            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;
+            /**
+             * 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;
+            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;
+            type?: "price_components";
+        }
         /**
          * example:
          * {
@@ -2111,8 +2445,8 @@ declare namespace Components {
          *     "example",
          *     "mock"
          *   ],
-         *   "_created_at": {},
-         *   "_updated_at": {}
+         *   "_created_at": "2021-02-09T12:41:43.662Z",
+         *   "_updated_at": "2021-02-09T12:41:43.662Z"
          * }
          */
         export interface RelationEntity {
@@ -2212,7 +2546,7 @@ declare namespace Components {
             repeatable?: boolean;
             has_primary?: boolean;
             relation_affinity_mode?: "weak" | "strong";
-            type?: "string" | "phone" | "email" | "address" | "relation" | "payment";
+            type?: "string" | "phone" | "email" | "address" | "relation" | "payment" | "price_component";
             /**
              * when enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link.
              */
@@ -2315,6 +2649,88 @@ declare namespace Components {
                 value: string;
                 title?: string;
             })[];
+            /**
+             * Allow arbitrary input values in addition to provided options
+             */
+            allow_any?: boolean;
+        }
+        /**
+         * Status select
+         */
+        export interface StatusAttribute {
+            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;
+            required?: boolean;
+            readonly?: boolean;
+            deprecated?: boolean;
+            default_value?: string | {
+                [name: string]: any;
+            } | number | number | boolean | any[];
+            group?: string;
+            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;
+            /**
+             * 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;
+            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;
+            type?: "select" | "radio";
+            options?: ((string | null) | {
+                value: string;
+                title?: string;
+            })[];
+            /**
+             * Allow arbitrary input values in addition to provided options
+             */
+            allow_any?: boolean;
         }
         /**
          * Summary Fields are displayed inside list view as a resume of the relation entity.
@@ -2675,8 +3091,8 @@ declare namespace Paths {
              *     "example",
              *     "mock"
              *   ],
-             *   "_created_at": {},
-             *   "_updated_at": {}
+             *   "_created_at": "2021-02-09T12:41:43.662Z",
+             *   "_updated_at": "2021-02-09T12:41:43.662Z"
              * }
              */
             Components.Schemas.EntityItem;
@@ -2821,8 +3237,8 @@ declare namespace Paths {
                  *     "example",
                  *     "mock"
                  *   ],
-                 *   "_created_at": {},
-                 *   "_updated_at": {}
+                 *   "_created_at": "2021-02-09T12:41:43.662Z",
+                 *   "_updated_at": "2021-02-09T12:41:43.662Z"
                  * }
                  */
                 Components.Schemas.EntityItem;
@@ -2836,8 +3252,8 @@ declare namespace Paths {
                  *     "example",
                  *     "mock"
                  *   ],
-                 *   "_created_at": {},
-                 *   "_updated_at": {}
+                 *   "_created_at": "2021-02-09T12:41:43.662Z",
+                 *   "_updated_at": "2021-02-09T12:41:43.662Z"
                  * }
                  */
                 Components.Schemas.EntityItem[];
@@ -3011,8 +3427,8 @@ declare namespace Paths {
              *     "example",
              *     "mock"
              *   ],
-             *   "_created_at": {},
-             *   "_updated_at": {}
+             *   "_created_at": "2021-02-09T12:41:43.662Z",
+             *   "_updated_at": "2021-02-09T12:41:43.662Z"
              * }
              */
             Components.Schemas.EntityItem;
@@ -3051,6 +3467,7 @@ declare namespace Paths {
              * 01F130Q52Q6MWSNS8N2AVXV4JN
              */
             Components.Schemas.ActivityId /* ulid */;
+            export type DryRun = boolean;
             export type Slug = /**
              * URL-friendly identifier for the entity schema
              * example:
@@ -3063,6 +3480,7 @@ declare namespace Paths {
         }
         export interface QueryParameters {
             activity_id?: Parameters.ActivityId;
+            dry_run?: Parameters.DryRun;
         }
         export interface RequestBody {
             /**
@@ -3085,8 +3503,8 @@ declare namespace Paths {
              *     "example",
              *     "mock"
              *   ],
-             *   "_created_at": {},
-             *   "_updated_at": {}
+             *   "_created_at": "2021-02-09T12:41:43.662Z",
+             *   "_updated_at": "2021-02-09T12:41:43.662Z"
              * }
              */
             Components.Schemas.EntityItem;
@@ -3100,8 +3518,8 @@ declare namespace Paths {
              *     "example",
              *     "mock"
              *   ],
-             *   "_created_at": {},
-             *   "_updated_at": {}
+             *   "_created_at": "2021-02-09T12:41:43.662Z",
+             *   "_updated_at": "2021-02-09T12:41:43.662Z"
              * }
              */
             Components.Schemas.EntityItem;