@epilot/entity-client 4.0.4 → 4.0.6

package/dist/openapi.d.ts

@@ -223,7 +223,7 @@ 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 | /* 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;
+        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;
         /**
          * Automation entity
          */
@@ -993,9 +993,23 @@ declare namespace Components {
         }
         export interface EntityDefaultCreate {
             view_type?: "default";
+            search_params?: {
+                [name: string]: string;
+            };
+            table_menu_options?: {
+                icon?: string;
+                label?: string;
+            };
         }
         export interface EntityDefaultEdit {
             view_type?: "default";
+            search_params?: {
+                [name: string]: string;
+            };
+            table_menu_options?: {
+                icon?: string;
+                label?: string;
+            };
         }
         export interface EntityDefaultOverview {
             view_type?: "default";
@@ -1040,6 +1054,25 @@ declare namespace Components {
             classic_view?: string; // uri
         }
         export type EntityId = string; // uuid
+        export interface EntityImportParams {
+            S3Reference: {
+                /**
+                 * example:
+                 * epilot-files-prod
+                 */
+                bucket: string;
+                /**
+                 * example:
+                 * 123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
+                 */
+                key: string;
+            };
+            /**
+             * example:
+             * contact
+             */
+            schema: string;
+        }
         /**
          * example:
          * {
@@ -1082,6 +1115,12 @@ declare namespace Components {
              * 123
              */
             org: string;
+            activity_id?: /**
+             * See https://github.com/ulid/spec
+             * example:
+             * 01F130Q52Q6MWSNS8N2AVXV4JN
+             */
+            ActivityId /* ulid */;
             operation: "createEntity" | "updateEntity" | "deleteEntity";
             /**
              * example:
@@ -1199,7 +1238,7 @@ declare namespace Components {
                      *   "label": "Price components"
                      *   "value": "{{item.prices.length}} price components"
                      *   "show_as_tag": true
-                     *   "render_condition": "is_composite_price = \"true\""
+                     *   "render_condition": "is_composite_price = "true""
                      * }
                      * ```
                      * The value field supports handlebar expressions from which you can pick any field from the entity state.
@@ -1412,7 +1451,7 @@ declare namespace Components {
                      *   "label": "Price components"
                      *   "value": "{{item.prices.length}} price components"
                      *   "show_as_tag": true
-                     *   "render_condition": "is_composite_price = \"true\""
+                     *   "render_condition": "is_composite_price = "true""
                      * }
                      * ```
                      * The value field supports handlebar expressions from which you can pick any field from the entity state.
@@ -1564,7 +1603,7 @@ declare namespace Components {
             from?: number;
             size?: number;
             /**
-             * When true, enables entity hydration to resolve nested $relation references in-place.
+             * When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
              */
             hydrate?: boolean;
             /**
@@ -1624,6 +1663,10 @@ declare namespace Components {
         export interface EntityViewDisabled {
             view_type?: "disabled";
         }
+        /**
+         * Export Job Id to get the result
+         */
+        export type ExportJobId = string;
         /**
          * File or Image Attachment
          */
@@ -2094,6 +2137,10 @@ declare namespace Components {
             protected?: boolean;
             type?: "invitation_email";
         }
+        /**
+         * Pass 'true' to generate import template
+         */
+        export type IsTemplate = boolean;
         /**
          * Link with title and href
          */
@@ -2170,6 +2217,98 @@ declare namespace Components {
             protected?: boolean;
             type?: "link";
         }
+        /**
+         * Multi Choice Selection
+         */
+        export interface MultiSelectAttribute {
+            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;
+            /**
+             * 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;
+            type?: "multiselect" | "checkbox";
+            /**
+             * controls if the matching of values against the options is case sensitive or not
+             */
+            disable_case_sensitive?: boolean | null;
+            /**
+             * controls if the 360 ui will allow the user to enter a value which is not defined by the options
+             */
+            allow_extra_options?: boolean | null;
+            options?: ((string | null) | {
+                value: string;
+                title?: string;
+            })[];
+            /**
+             * Allow arbitrary input values in addition to provided options
+             */
+            allow_any?: boolean;
+        }
         /**
          * Numeric input
          */
@@ -3078,7 +3217,7 @@ declare namespace Components {
          *   "label": "Price components"
          *   "value": "{{item.prices.length}} price components"
          *   "show_as_tag": true
-         *   "render_condition": "is_composite_price = \"true\""
+         *   "render_condition": "is_composite_price = "true""
          * }
          * ```
          * The value field supports handlebar expressions from which you can pick any field from the entity state.
@@ -3594,6 +3733,21 @@ declare namespace Paths {
             }
         }
     }
+    namespace ExportEntities {
+        namespace Parameters {
+            export type IsTemplate = /* Pass 'true' to generate import template */ Components.Schemas.IsTemplate;
+            export type JobId = /* Export Job Id to get the result */ Components.Schemas.ExportJobId;
+        }
+        export interface QueryParameters {
+            job_id?: Parameters.JobId;
+            is_template?: Parameters.IsTemplate;
+        }
+        export type RequestBody = Components.Schemas.EntitySearchParams;
+        namespace Responses {
+            export interface $201 {
+            }
+        }
+    }
     namespace GetActivity {
         namespace Parameters {
             export type Id = /**
@@ -3769,6 +3923,19 @@ declare namespace Paths {
             }
         }
     }
+    namespace ImportEntities {
+        namespace Parameters {
+            export type JobId = /* Export Job Id to get the result */ Components.Schemas.ExportJobId;
+        }
+        export interface QueryParameters {
+            job_id?: Parameters.JobId;
+        }
+        export type RequestBody = Components.Schemas.EntityImportParams;
+        namespace Responses {
+            export interface $201 {
+            }
+        }
+    }
     namespace ListSchemaBlueprints {
         namespace Responses {
             export interface $200 {
@@ -4015,6 +4182,12 @@ export interface OperationMethods {
    *       { "entity_id": "456", "_tags": ["primary"] },
    *       { "entity_id": "789", "_tags": ["secondary"] },
    *     ]
+   *   },
+   *   "addresses": {
+   *     "$relation_ref": [
+   *       { "entity_id": "123", "_tags": ["primary"], "path": "address.0" },
+   *       { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" },
+   *     ]
    *   }
    * }
    * ```
@@ -4038,6 +4211,20 @@ export interface OperationMethods {
    *       "name": "child 2",
    *       "_tags": ["child"]
    *     }
+   *   ],
+   *   "addresses": [
+   *     {
+   *       "$relation_ref": { "entity_id": "123", "_tags": ["primary"], "path": "address.0" },
+   *       "_id": "123",
+   *       "address": "address 1",
+   *       "_tags": ["child"]
+   *     },
+   *     {
+   *       "$relation_ref": { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" },
+   *       "_id": "234",
+   *       "address": "address 2",
+   *       "_tags": ["child"]
+   *     }
    *   ]
    * }
    * ```
@@ -4122,6 +4309,12 @@ export interface OperationMethods {
    *       { "entity_id": "456", "_tags": ["primary"] },
    *       { "entity_id": "789", "_tags": ["secondary"] },
    *     ]
+   *   },
+   *   "addresses": {
+   *     "$relation_ref": [
+   *       { "entity_id": "123", "_tags": ["primary"], "path": "address.0" },
+   *       { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" },
+   *     ]
    *   }
    * }
    * ```
@@ -4145,6 +4338,20 @@ export interface OperationMethods {
    *       "name": "child 2",
    *       "_tags": ["child"]
    *     }
+   *   ],
+   *   "addresses": [
+   *     {
+   *       "$relation_ref": { "entity_id": "123", "_tags": ["primary"], "path": "address.0" },
+   *       "_id": "123",
+   *       "address": "address 1",
+   *       "_tags": ["child"]
+   *     },
+   *     {
+   *       "$relation_ref": { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" },
+   *       "_id": "234",
+   *       "address": "address 2",
+   *       "_tags": ["child"]
+   *     }
    *   ]
    * }
    * ```
@@ -4301,6 +4508,26 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteRelation.Responses.$204>
+  /**
+   * exportEntities - exportEntities
+   * 
+   * create export file of entities
+   */
+  'exportEntities'(
+    parameters?: Parameters<Paths.ExportEntities.QueryParameters> | null,
+    data?: Paths.ExportEntities.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ExportEntities.Responses.$201>
+  /**
+   * importEntities - importEntities
+   * 
+   * import entity data from
+   */
+  'importEntities'(
+    parameters?: Parameters<Paths.ImportEntities.QueryParameters> | null,
+    data?: Paths.ImportEntities.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ImportEntities.Responses.$201>
 }
 
 export interface PathsDictionary {
@@ -4395,6 +4622,12 @@ export interface PathsDictionary {
      *       { "entity_id": "456", "_tags": ["primary"] },
      *       { "entity_id": "789", "_tags": ["secondary"] },
      *     ]
+     *   },
+     *   "addresses": {
+     *     "$relation_ref": [
+     *       { "entity_id": "123", "_tags": ["primary"], "path": "address.0" },
+     *       { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" },
+     *     ]
      *   }
      * }
      * ```
@@ -4418,6 +4651,20 @@ export interface PathsDictionary {
      *       "name": "child 2",
      *       "_tags": ["child"]
      *     }
+     *   ],
+     *   "addresses": [
+     *     {
+     *       "$relation_ref": { "entity_id": "123", "_tags": ["primary"], "path": "address.0" },
+     *       "_id": "123",
+     *       "address": "address 1",
+     *       "_tags": ["child"]
+     *     },
+     *     {
+     *       "$relation_ref": { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" },
+     *       "_id": "234",
+     *       "address": "address 2",
+     *       "_tags": ["child"]
+     *     }
      *   ]
      * }
      * ```
@@ -4508,6 +4755,12 @@ export interface PathsDictionary {
      *       { "entity_id": "456", "_tags": ["primary"] },
      *       { "entity_id": "789", "_tags": ["secondary"] },
      *     ]
+     *   },
+     *   "addresses": {
+     *     "$relation_ref": [
+     *       { "entity_id": "123", "_tags": ["primary"], "path": "address.0" },
+     *       { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" },
+     *     ]
      *   }
      * }
      * ```
@@ -4531,6 +4784,20 @@ export interface PathsDictionary {
      *       "name": "child 2",
      *       "_tags": ["child"]
      *     }
+     *   ],
+     *   "addresses": [
+     *     {
+     *       "$relation_ref": { "entity_id": "123", "_tags": ["primary"], "path": "address.0" },
+     *       "_id": "123",
+     *       "address": "address 1",
+     *       "_tags": ["child"]
+     *     },
+     *     {
+     *       "$relation_ref": { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" },
+     *       "_id": "234",
+     *       "address": "address 2",
+     *       "_tags": ["child"]
+     *     }
      *   ]
      * }
      * ```
@@ -4702,6 +4969,30 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeleteRelation.Responses.$204>
   }
+  ['/v1/entity:export']: {
+    /**
+     * exportEntities - exportEntities
+     * 
+     * create export file of entities
+     */
+    'post'(
+      parameters?: Parameters<Paths.ExportEntities.QueryParameters> | null,
+      data?: Paths.ExportEntities.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ExportEntities.Responses.$201>
+  }
+  ['/v1/entity:import']: {
+    /**
+     * importEntities - importEntities
+     * 
+     * import entity data from
+     */
+    'post'(
+      parameters?: Parameters<Paths.ImportEntities.QueryParameters> | null,
+      data?: Paths.ImportEntities.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ImportEntities.Responses.$201>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>