@epilot/entity-client 4.12.0 → 4.13.1-RC.0

package/dist/openapi.d.ts

@@ -1561,20 +1561,29 @@ declare namespace Components {
             classic_view?: string; // uri-reference
         }
         export type EntityId = string; // uuid
+        /**
+         * The parameters for importing entities.
+         */
         export interface EntityImportParams {
+            /**
+             * The S3 bucket and key where the JSON file for import is located.
+             */
             S3Reference: {
                 /**
+                 * The name of the S3 bucket where the JSON file for import is stored.
                  * example:
-                 * epilot-files-prod
+                 * my-bucket
                  */
                 bucket: string;
                 /**
+                 * The key or path to the JSON file within the S3 bucket.
                  * example:
-                 * 123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
+                 * imports/my-import.json
                  */
                 key: string;
             };
             /**
+             * The schema of the entities being imported. This must match the schema of the entities on the platform.
              * example:
              * contact
              */
@@ -2499,7 +2508,9 @@ declare namespace Components {
             view_type?: "disabled";
         }
         /**
-         * Export Job Id to get the result
+         * The unique identifier of the import job.
+         * example:
+         * abc123
          */
         export type ExportJobId = string;
         /**
@@ -5132,8 +5143,18 @@ declare namespace Components {
             };
             type?: "status";
             options?: ((string | null) | {
+                /**
+                 * The stored value of the option
+                 */
                 value: string;
+                /**
+                 * The displayed title of the option
+                 */
                 title?: string;
+                /**
+                 * If true, the option will not be displayed in the UI
+                 */
+                hidden?: boolean;
             })[];
         }
         /**
@@ -5897,7 +5918,12 @@ 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 type JobId = /**
+             * The unique identifier of the import job.
+             * example:
+             * abc123
+             */
+            Components.Schemas.ExportJobId;
             export type Language = /* Export headers translation Language */ Components.Schemas.Language;
         }
         export interface QueryParameters {
@@ -6194,16 +6220,26 @@ declare namespace Paths {
     }
     namespace GetSchemaVersions {
         namespace Parameters {
+            export type DraftsFrom = number;
+            export type DraftsSize = number;
             export type Slug = /**
              * URL-friendly identifier for the entity schema
              * example:
              * contact
              */
             Components.Schemas.EntitySlug;
+            export type VersionsFrom = number;
+            export type VersionsSize = number;
         }
         export interface PathParameters {
             slug: Parameters.Slug;
         }
+        export interface QueryParameters {
+            versions_from?: Parameters.VersionsFrom;
+            versions_size?: Parameters.VersionsSize;
+            drafts_from?: Parameters.DraftsFrom;
+            drafts_size?: Parameters.DraftsSize;
+        }
         namespace Responses {
             export interface $200 {
                 versions?: /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem[];
@@ -6229,12 +6265,17 @@ declare namespace Paths {
     }
     namespace ImportEntities {
         namespace Parameters {
-            export type JobId = /* Export Job Id to get the result */ Components.Schemas.ExportJobId;
+            export type JobId = /**
+             * The unique identifier of the import job.
+             * example:
+             * abc123
+             */
+            Components.Schemas.ExportJobId;
         }
         export interface QueryParameters {
             job_id?: Parameters.JobId;
         }
-        export type RequestBody = Components.Schemas.EntityImportParams;
+        export type RequestBody = /* The parameters for importing entities. */ Components.Schemas.EntityImportParams;
         namespace Responses {
             export interface $201 {
             }
@@ -6845,7 +6886,7 @@ export interface OperationMethods {
    * Get all versions of this schema ordered by the latest versions including drafts.
    */
   'getSchemaVersions'(
-    parameters?: Parameters<Paths.GetSchemaVersions.PathParameters> | null,
+    parameters?: Parameters<Paths.GetSchemaVersions.PathParameters & Paths.GetSchemaVersions.QueryParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetSchemaVersions.Responses.$200>
@@ -7285,9 +7326,12 @@ export interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ExportEntities.Responses.$201>
   /**
-   * importEntities - importEntities
+   * importEntities - Import Entities
+   * 
+   * This endpoint enables the import of entities into the platform.
+   * The entities should be provided in a CSV format inside an S3 bucket.
+   * This API will return the `job_id`` which can be used to fetch the status of the import process.
    * 
-   * import entity data from
    */
   'importEntities'(
     parameters?: Parameters<Paths.ImportEntities.QueryParameters> | null,
@@ -7448,7 +7492,7 @@ export interface PathsDictionary {
      * Get all versions of this schema ordered by the latest versions including drafts.
      */
     'get'(
-      parameters?: Parameters<Paths.GetSchemaVersions.PathParameters> | null,
+      parameters?: Parameters<Paths.GetSchemaVersions.PathParameters & Paths.GetSchemaVersions.QueryParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetSchemaVersions.Responses.$200>
@@ -7920,9 +7964,12 @@ export interface PathsDictionary {
   }
   ['/v1/entity:import']: {
     /**
-     * importEntities - importEntities
+     * importEntities - Import Entities
+     * 
+     * This endpoint enables the import of entities into the platform.
+     * The entities should be provided in a CSV format inside an S3 bucket.
+     * This API will return the `job_id`` which can be used to fetch the status of the import process.
      * 
-     * import entity data from
      */
     'post'(
       parameters?: Parameters<Paths.ImportEntities.QueryParameters> | null,

package/dist/openapi.json

@@ -1669,16 +1669,16 @@
     "/v1/entity:import": {
       "post": {
         "operationId": "importEntities",
-        "summary": "importEntities",
-        "description": "import entity data from",
+        "summary": "Import Entities",
+        "description": "This endpoint enables the import of entities into the platform.\nThe entities should be provided in a CSV format inside an S3 bucket.\nThis API will return the `job_id`` which can be used to fetch the status of the import process.\n",
         "tags": [
-          "Export"
+          "Entity Import"
         ],
         "parameters": [
           {
             "in": "query",
             "name": "job_id",
-            "description": "Import Job Id to get the result",
+            "description": "The ID of the import job. This ID is used to track the progress and fetch the result of the import operation.",
             "schema": {
               "$ref": "#/components/schemas/ExportJobId"
             }
@@ -1695,7 +1695,7 @@
         },
         "responses": {
           "201": {
-            "description": "created import url and download url"
+            "description": "The import operation was initiated successfully.\nThe response includes the URLs for the files containing the successful and failed imported entities.\n"
           }
         }
       }
@@ -2121,8 +2121,9 @@
     },
     "schemas": {
       "ExportJobId": {
-        "description": "Export Job Id to get the result",
-        "type": "string"
+        "description": "The unique identifier of the import job.",
+        "type": "string",
+        "example": "abc123"
       },
       "Language": {
         "description": "Export headers translation Language",
@@ -2940,10 +2941,17 @@
                       "type": "object",
                       "properties": {
                         "value": {
+                          "description": "The stored value of the option",
                           "type": "string"
                         },
                         "title": {
+                          "description": "The displayed title of the option",
                           "type": "string"
+                        },
+                        "hidden": {
+                          "description": "If true, the option will not be displayed in the UI",
+                          "type": "boolean",
+                          "default": false
                         }
                       },
                       "required": [
@@ -4357,27 +4365,32 @@
             "properties": {
               "bucket": {
                 "type": "string",
-                "example": "epilot-files-prod"
+                "description": "The name of the S3 bucket where the JSON file for import is stored.",
+                "example": "my-bucket"
               },
               "key": {
                 "type": "string",
-                "example": "123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
+                "description": "The key or path to the JSON file within the S3 bucket.",
+                "example": "imports/my-import.json"
               }
             },
             "required": [
               "bucket",
               "key"
-            ]
+            ],
+            "description": "The S3 bucket and key where the JSON file for import is located."
           },
           "schema": {
             "type": "string",
+            "description": "The schema of the entities being imported. This must match the schema of the entities on the platform.",
             "example": "contact"
           }
         },
         "required": [
           "S3Reference",
           "schema"
-        ]
+        ],
+        "description": "The parameters for importing entities."
       },
       "EntitySearchResults": {
         "type": "object",