@epilot/entity-client 4.0.2 → 4.0.5

package/dist/openapi.d.ts

@@ -1082,6 +1082,12 @@ declare namespace Components {
              * 123
              */
             org: string;
+            activity_id?: /**
+             * See https://github.com/ulid/spec
+             * example:
+             * 01F130Q52Q6MWSNS8N2AVXV4JN
+             */
+            ActivityId /* ulid */;
             operation: "createEntity" | "updateEntity" | "deleteEntity";
             /**
              * example:
@@ -1189,6 +1195,7 @@ declare namespace Components {
                 table_view?: EntityViewConfig;
                 create_view?: EntityViewConfig;
                 edit_view?: EntityViewConfig;
+                single_view?: EntityViewConfig;
                 list_item?: {
                     summary_attributes?: (/**
                      * Represents an expanded version of an attribute to be displayed in the list item summary.
@@ -1198,7 +1205,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.
@@ -1401,6 +1408,7 @@ declare namespace Components {
                 table_view?: EntityViewConfig;
                 create_view?: EntityViewConfig;
                 edit_view?: EntityViewConfig;
+                single_view?: EntityViewConfig;
                 list_item?: {
                     summary_attributes?: (/**
                      * Represents an expanded version of an attribute to be displayed in the list item summary.
@@ -1410,7 +1418,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.
@@ -1622,6 +1630,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
          */
@@ -3076,7 +3088,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.
@@ -3592,6 +3604,19 @@ declare namespace Paths {
             }
         }
     }
+    namespace ExportEntities {
+        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.EntitySearchParams;
+        namespace Responses {
+            export interface $201 {
+            }
+        }
+    }
     namespace GetActivity {
         namespace Parameters {
             export type Id = /**
@@ -4299,6 +4324,16 @@ 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>
 }
 
 export interface PathsDictionary {
@@ -4700,6 +4735,18 @@ 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>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>

package/dist/openapi.json

@@ -14,9 +14,17 @@
             "name": "Entities",
             "description": "CRUD Access for Entities"
         },
+        {
+            "name": "Relations",
+            "description": "Entity Relationships"
+        },
         {
             "name": "Activity",
             "description": "Entity Events"
+        },
+        {
+            "name": "Export",
+            "description": "Export and Import entities via files"
         }
     ],
     "security": [
@@ -1240,6 +1248,40 @@
                     }
                 }
             }
+        },
+        "/v1/entity:export": {
+            "post": {
+                "operationId": "exportEntities",
+                "summary": "exportEntities",
+                "description": "create export file of entities",
+                "tags": [
+                    "Export"
+                ],
+                "parameters": [
+                    {
+                        "in": "query",
+                        "name": "job_id",
+                        "description": "Export Job Id to get the result",
+                        "schema": {
+                            "$ref": "#/components/schemas/ExportJobId"
+                        }
+                    }
+                ],
+                "requestBody": {
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/EntitySearchParams"
+                            }
+                        }
+                    }
+                },
+                "responses": {
+                    "201": {
+                        "description": "created export url and download url"
+                    }
+                }
+            }
         }
     },
     "components": {
@@ -1258,6 +1300,10 @@
             }
         },
         "schemas": {
+            "ExportJobId": {
+                "description": "Export Job Id to get the result",
+                "type": "string"
+            },
             "SchemaId": {
                 "description": "Generated uuid for schema",
                 "type": "string",
@@ -1328,6 +1374,9 @@
                             "edit_view": {
                                 "$ref": "#/components/schemas/EntityViewConfig"
                             },
+                            "single_view": {
+                                "$ref": "#/components/schemas/EntityViewConfig"
+                            },
                             "list_item": {
                                 "type": "object",
                                 "properties": {
@@ -2592,7 +2641,7 @@
                 ]
             },
             "SummaryAttribute": {
-                "description": "Represents an expanded version of an attribute to be displayed in the list item summary.\nThis configuration can be used in the following way:\n```js\n{\n  \"label\": \"Price components\"\n  \"value\": \"{{item.prices.length}} price components\"\n  \"show_as_tag\": true\n  \"render_condition\": \"is_composite_price = \\\"true\\\"\"\n}\n```\nThe value field supports handlebar expressions from which you can pick any field from the entity state.\n",
+                "description": "Represents an expanded version of an attribute to be displayed in the list item summary.\nThis configuration can be used in the following way:\n```js\n{\n  \"label\": \"Price components\"\n  \"value\": \"{{item.prices.length}} price components\"\n  \"show_as_tag\": true\n  \"render_condition\": \"is_composite_price = \"true\"\"\n}\n```\nThe value field supports handlebar expressions from which you can pick any field from the entity state.\n",
                 "type": "object",
                 "properties": {
                     "label": {
@@ -3311,6 +3360,9 @@
                         "type": "string",
                         "example": "123"
                     },
+                    "activity_id": {
+                        "$ref": "#/components/schemas/ActivityId"
+                    },
                     "operation": {
                         "type": "string",
                         "enum": [
@@ -4030,6 +4082,9 @@
         }
     },
     "servers": [
+        {
+            "url": "https://entity.sls.epilot.io"
+        },
         {
             "url": "https://entity.sls.epilot.io"
         }