@epilot/entity-client 3.0.5 → 3.0.8

package/dist/openapi.d.ts

@@ -201,7 +201,10 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             type?: "relation_address";
             has_primary?: boolean;
         }
@@ -276,7 +279,10 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
         }
         /**
          * example:
@@ -380,7 +386,10 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             type?: "boolean";
         }
         /**
@@ -447,7 +456,10 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             type?: "computed";
         }
         /**
@@ -514,7 +526,10 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             type: "consent";
             topic: string;
             identifiers?: string[];
@@ -583,7 +598,10 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             type?: "country";
         }
         /**
@@ -650,7 +668,10 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             type: "currency";
             /**
              * An array of currency configurations with a country code (ISO-4217)
@@ -726,7 +747,10 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             type?: "date" | "datetime";
         }
         export interface Entity {
@@ -999,6 +1023,16 @@ declare namespace Components {
              * Contacts
              */
             plural: string;
+            /**
+             * example:
+             * false
+             */
+            published?: boolean;
+            /**
+             * example:
+             * false
+             */
+            draft?: boolean;
             /**
              * example:
              * person
@@ -1043,6 +1077,12 @@ declare namespace Components {
                  * 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;
@@ -1126,6 +1166,13 @@ declare namespace Components {
          */
         export interface EntitySchemaItem {
             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:
@@ -1155,6 +1202,16 @@ declare namespace Components {
              * Contacts
              */
             plural: string;
+            /**
+             * example:
+             * false
+             */
+            published?: boolean;
+            /**
+             * example:
+             * false
+             */
+            draft?: boolean;
             /**
              * example:
              * person
@@ -1199,6 +1256,12 @@ declare namespace Components {
                  * 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;
@@ -1426,7 +1489,10 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             type: "image" | "file";
             multiple?: boolean;
             /**
@@ -1659,7 +1725,10 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             type?: "internal";
         }
         /**
@@ -1726,7 +1795,10 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             type?: "link";
         }
         /**
@@ -1793,7 +1865,10 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             type?: "number";
             format?: string;
         }
@@ -1861,7 +1936,10 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             type?: "ordered_list";
         }
         /**
@@ -1928,7 +2006,10 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             type?: "partner_status";
         }
         /**
@@ -2010,9 +2091,12 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             type?: "relation";
-            relation_type?: "belongs_to" | "has_many";
+            relation_type?: "has_many" | "has_one";
             delete_mode?: "cascade";
             relation_affinity_mode?: "weak" | "strong";
             /**
@@ -2138,11 +2222,14 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             repeatable?: boolean;
             has_primary?: boolean;
             relation_affinity_mode?: "weak" | "strong";
-            type?: "string" | "phone" | "email" | "address" | "relation";
+            type?: "string" | "phone" | "email" | "address" | "relation" | "payment";
             /**
              * 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.
              */
@@ -2236,12 +2323,19 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: 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.
@@ -2320,7 +2414,10 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             type?: "tags";
             options?: string[];
             suggestions?: string[];
@@ -2389,7 +2486,10 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             type?: "string";
             multiline?: boolean;
         }
@@ -2457,7 +2557,10 @@ declare namespace Components {
              * Setting to `true` disables editing the attribute on the entity builder UI
              */
             entity_builder_disable_edit?: boolean;
-            deletable?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
             type?: "relation_user";
             multiple?: boolean;
         }
@@ -2600,6 +2703,27 @@ declare namespace Paths {
             Components.Schemas.EntityItem;
         }
     }
+    namespace CreateNewSchemaVersion {
+        namespace Parameters {
+            export type Draft = boolean;
+            export type Slug = /**
+             * URL-friendly identifier for the entity schema
+             * example:
+             * contact
+             */
+            Components.Schemas.EntitySlug;
+        }
+        export interface PathParameters {
+            slug: Parameters.Slug;
+        }
+        export interface QueryParameters {
+            draft?: Parameters.Draft;
+        }
+        export type RequestBody = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchema;
+        namespace Responses {
+            export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
+        }
+    }
     namespace DeleteEntity {
         namespace Parameters {
             export type ActivityId = /**
@@ -2651,9 +2775,9 @@ declare namespace Paths {
             }
         }
     }
-    namespace DeleteSchema {
+    namespace DeleteSchemaById {
         namespace Parameters {
-            export type Id = string;
+            export type Id = /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
             export type Slug = /**
              * URL-friendly identifier for the entity schema
              * example:
@@ -2665,7 +2789,7 @@ declare namespace Paths {
             slug: Parameters.Slug;
         }
         export interface QueryParameters {
-            id?: Parameters.Id;
+            id: Parameters.Id;
         }
         namespace Responses {
             export interface $204 {
@@ -2810,7 +2934,7 @@ declare namespace Paths {
     }
     namespace GetSchema {
         namespace Parameters {
-            export type Id = string;
+            export type Id = /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
             export type Slug = /**
              * URL-friendly identifier for the entity schema
              * example:
@@ -2842,7 +2966,8 @@ declare namespace Paths {
         }
         namespace Responses {
             export interface $200 {
-                results?: /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem[];
+                versions?: /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem[];
+                drafts?: /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem[];
             }
         }
     }
@@ -2854,31 +2979,16 @@ declare namespace Paths {
         }
     }
     namespace ListSchemas {
-        namespace Responses {
-            export interface $200 {
-                results?: /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem[];
-            }
-        }
-    }
-    namespace PutSchema {
         namespace Parameters {
-            export type Draft = boolean;
-            export type Slug = /**
-             * URL-friendly identifier for the entity schema
-             * example:
-             * contact
-             */
-            Components.Schemas.EntitySlug;
-        }
-        export interface PathParameters {
-            slug: Parameters.Slug;
+            export type Unpublished = boolean;
         }
         export interface QueryParameters {
-            draft?: Parameters.Draft;
+            unpublished?: Parameters.Unpublished;
         }
-        export type RequestBody = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchema;
         namespace Responses {
-            export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
+            export interface $200 {
+                results?: /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem[];
+            }
         }
     }
     namespace SearchEntities {
@@ -3026,10 +3136,10 @@ export interface OperationMethods {
   /**
    * listSchemas - listSchemas
    * 
-   * List local versions of all available schemas
+   * Get the latest version of local schema
    */
   'listSchemas'(
-    parameters?: Parameters<UnknownParamsObject> | null,
+    parameters?: Parameters<Paths.ListSchemas.QueryParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ListSchemas.Responses.$200>
@@ -3046,7 +3156,7 @@ export interface OperationMethods {
   /**
    * getSchemaVersions - getSchemaVersions
    * 
-   * Get all versions of this schema
+   * Get all versions of this schema ordered by the latest versions including drafts.
    */
   'getSchemaVersions'(
     parameters?: Parameters<Paths.GetSchemaVersions.PathParameters> | null,
@@ -3055,6 +3165,8 @@ export interface OperationMethods {
   ): OperationResponse<Paths.GetSchemaVersions.Responses.$200>
   /**
    * getSchema - getSchema
+   * 
+   * By default gets the latest version of the Schema and to get the specific version of schema pass the id.
    */
   'getSchema'(
     parameters?: Parameters<Paths.GetSchema.PathParameters & Paths.GetSchema.QueryParameters> | null,
@@ -3062,23 +3174,25 @@ export interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetSchema.Responses.$200>
   /**
-   * putSchema - putSchema
+   * createNewSchemaVersion - createNewSchemaVersion
    * 
-   * Create new version of the schema
+   * Create new version of the schema and default draft is false.
    */
-  'putSchema'(
-    parameters?: Parameters<Paths.PutSchema.PathParameters & Paths.PutSchema.QueryParameters> | null,
-    data?: Paths.PutSchema.RequestBody,
+  'createNewSchemaVersion'(
+    parameters?: Parameters<Paths.CreateNewSchemaVersion.PathParameters & Paths.CreateNewSchemaVersion.QueryParameters> | null,
+    data?: Paths.CreateNewSchemaVersion.RequestBody,
     config?: AxiosRequestConfig  
-  ): OperationResponse<Paths.PutSchema.Responses.$200>
+  ): OperationResponse<Paths.CreateNewSchemaVersion.Responses.$200>
   /**
-   * deleteSchema - deleteSchema
+   * deleteSchemaById - deleteSchemaById
+   * 
+   * Delete schema by Id
    */
-  'deleteSchema'(
-    parameters?: Parameters<Paths.DeleteSchema.PathParameters & Paths.DeleteSchema.QueryParameters> | null,
+  'deleteSchemaById'(
+    parameters?: Parameters<Paths.DeleteSchemaById.PathParameters & Paths.DeleteSchemaById.QueryParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
-  ): OperationResponse<Paths.DeleteSchema.Responses.$204>
+  ): OperationResponse<Paths.DeleteSchemaById.Responses.$204>
   /**
    * searchEntities - searchEntities
    * 
@@ -3394,10 +3508,10 @@ export interface PathsDictionary {
     /**
      * listSchemas - listSchemas
      * 
-     * List local versions of all available schemas
+     * Get the latest version of local schema
      */
     'get'(
-      parameters?: Parameters<UnknownParamsObject> | null,
+      parameters?: Parameters<Paths.ListSchemas.QueryParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.ListSchemas.Responses.$200>
@@ -3418,7 +3532,7 @@ export interface PathsDictionary {
     /**
      * getSchemaVersions - getSchemaVersions
      * 
-     * Get all versions of this schema
+     * Get all versions of this schema ordered by the latest versions including drafts.
      */
     'get'(
       parameters?: Parameters<Paths.GetSchemaVersions.PathParameters> | null,
@@ -3429,6 +3543,8 @@ export interface PathsDictionary {
   ['/v1/entity/schemas/{slug}']: {
     /**
      * getSchema - getSchema
+     * 
+     * By default gets the latest version of the Schema and to get the specific version of schema pass the id.
      */
     'get'(
       parameters?: Parameters<Paths.GetSchema.PathParameters & Paths.GetSchema.QueryParameters> | null,
@@ -3436,23 +3552,25 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetSchema.Responses.$200>
     /**
-     * putSchema - putSchema
+     * createNewSchemaVersion - createNewSchemaVersion
      * 
-     * Create new version of the schema
+     * Create new version of the schema and default draft is false.
      */
     'put'(
-      parameters?: Parameters<Paths.PutSchema.PathParameters & Paths.PutSchema.QueryParameters> | null,
-      data?: Paths.PutSchema.RequestBody,
+      parameters?: Parameters<Paths.CreateNewSchemaVersion.PathParameters & Paths.CreateNewSchemaVersion.QueryParameters> | null,
+      data?: Paths.CreateNewSchemaVersion.RequestBody,
       config?: AxiosRequestConfig  
-    ): OperationResponse<Paths.PutSchema.Responses.$200>
+    ): OperationResponse<Paths.CreateNewSchemaVersion.Responses.$200>
     /**
-     * deleteSchema - deleteSchema
+     * deleteSchemaById - deleteSchemaById
+     * 
+     * Delete schema by Id
      */
     'delete'(
-      parameters?: Parameters<Paths.DeleteSchema.PathParameters & Paths.DeleteSchema.QueryParameters> | null,
+      parameters?: Parameters<Paths.DeleteSchemaById.PathParameters & Paths.DeleteSchemaById.QueryParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
-    ): OperationResponse<Paths.DeleteSchema.Responses.$204>
+    ): OperationResponse<Paths.DeleteSchemaById.Responses.$204>
   }
   ['/v1/entity:search']: {
     /**