@epilot/entity-client 4.3.0 → 4.3.2

package/dist/openapi.d.ts

@@ -486,6 +486,12 @@ declare namespace Components {
             protected?: boolean;
             type?: "boolean";
         }
+        export type ClassificationId = string; // uuid
+        export interface ClassificationsUpdate {
+            create?: TaxonomyClassification[];
+            update?: TaxonomyClassification[];
+            delete?: TaxonomyClassification[];
+        }
         /**
          * 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)
          */
@@ -1011,7 +1017,7 @@ declare namespace Components {
                 label?: string;
             };
         }
-        export interface EntityDefaultOverview {
+        export interface EntityDefaultTable {
             view_type?: "default";
             dropdown_items?: ({
                 type?: "entity";
@@ -1051,6 +1057,19 @@ declare namespace Components {
                 legacy?: boolean;
             })[];
             row_actions?: string[];
+            navbar_actions?: {
+                type: string;
+                options?: {
+                    label: string;
+                    params?: {
+                        [key: string]: any;
+                    };
+                }[];
+            }[];
+            /**
+             * Enable the thumbnail column
+             */
+            enable_thumbnails?: boolean;
             classic_view?: string; // uri
         }
         export type EntityId = string; // uuid
@@ -1652,7 +1671,7 @@ declare namespace Components {
          * contact
          */
         export type EntitySlug = string;
-        export type EntityViewConfig = EntityDefaultCreate | EntityDefaultEdit | EntityDefaultOverview | /**
+        export type EntityViewConfig = EntityDefaultCreate | EntityDefaultEdit | EntityDefaultTable | /**
          * example:
          * {
          *   "type": "redirect",
@@ -2158,6 +2177,10 @@ declare namespace Components {
          * Pass 'true' to generate import template
          */
         export type IsTemplate = boolean;
+        /**
+         * Export headers translation Language
+         */
+        export type Language = string;
         /**
          * Link with title and href
          */
@@ -2723,7 +2746,9 @@ declare namespace Components {
             protected?: boolean;
             type?: "relation";
             relation_type?: "has_many" | "has_one";
-            delete_mode?: "cascade";
+            /**
+             * Weak relation attributes are kept when duplicating an entity. Strong relation attributes are discarded when duplicating an entity.
+             */
             relation_affinity_mode?: "weak" | "strong";
             /**
              * 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.
@@ -2960,6 +2985,9 @@ declare namespace Components {
             protected?: boolean;
             repeatable?: boolean;
             has_primary?: boolean;
+            /**
+             * Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity.
+             */
             relation_affinity_mode?: "weak" | "strong";
             type?: "string" | "phone" | "email" | "address" | "relation" | "payment" | "price_component" | "date";
             /**
@@ -3483,6 +3511,46 @@ declare namespace Components {
             options?: string[];
             suggestions?: string[];
         }
+        export interface Taxonomy {
+            slug: /**
+             * Taxonomy slug e.g. purpose, folder etc
+             * example:
+             * purpose
+             */
+            TaxonomySlug;
+            /**
+             * A simple name of a taxonomy could be any string e.g. Purpos, Folder, Product Category
+             * example:
+             * Purpose
+             */
+            name: string;
+            /**
+             * An optional parameter to add a plural name e.g. Purposes, Folders, Product Categories
+             * example:
+             * Purposes
+             */
+            plural?: string;
+            values?: TaxonomyClassification[];
+            created_at?: string; // date-time
+            updated_at?: string; // date-time
+        }
+        export interface TaxonomyClassification {
+            id?: ClassificationId /* uuid */;
+            /**
+             * example:
+             * Wallbox PV
+             */
+            name?: string;
+            parents?: ClassificationId /* uuid */[];
+            created_at?: string; // date-time
+            updated_at?: string; // date-time
+        }
+        /**
+         * Taxonomy slug e.g. purpose, folder etc
+         * example:
+         * purpose
+         */
+        export type TaxonomySlug = string;
         /**
          * Textarea or text input
          */
@@ -3891,10 +3959,12 @@ declare namespace Paths {
         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 Language = /* Export headers translation Language */ Components.Schemas.Language;
         }
         export interface QueryParameters {
             job_id?: Parameters.JobId;
             is_template?: Parameters.IsTemplate;
+            language?: Parameters.Language;
         }
         export type RequestBody = Components.Schemas.EntitySearchParams;
         namespace Responses {
@@ -4092,6 +4162,33 @@ declare namespace Paths {
             }
         }
     }
+    namespace GetTaxonomy {
+        namespace Parameters {
+            export type TaxonomySlug = /**
+             * Taxonomy slug e.g. purpose, folder etc
+             * example:
+             * purpose
+             */
+            Components.Schemas.TaxonomySlug;
+        }
+        export interface PathParameters {
+            taxonomySlug: Parameters.TaxonomySlug;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.Taxonomy;
+        }
+    }
+    namespace GetTaxonomyClassifications {
+        namespace Parameters {
+            export type TaxonomySlug = string;
+        }
+        export interface PathParameters {
+            taxonomySlug: Parameters.TaxonomySlug;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.Taxonomy;
+        }
+    }
     namespace ImportEntities {
         namespace Parameters {
             export type JobId = /* Export Job Id to get the result */ Components.Schemas.ExportJobId;
@@ -4132,12 +4229,50 @@ declare namespace Paths {
             }
         }
     }
+    namespace ListTaxonomies {
+        namespace Responses {
+            export interface $200 {
+                results?: Components.Schemas.Taxonomy[];
+            }
+        }
+    }
     namespace SearchEntities {
         export type RequestBody = Components.Schemas.EntitySearchParams;
         namespace Responses {
             export type $200 = Components.Schemas.EntitySearchResults;
         }
     }
+    namespace TaxonomiesAutocomplete {
+        namespace Parameters {
+            export type Query = string;
+            export type Size = number;
+            export type TaxonomySlug = string;
+        }
+        export interface QueryParameters {
+            query?: Parameters.Query;
+            taxonomySlug: Parameters.TaxonomySlug;
+            size?: Parameters.Size;
+        }
+        namespace Responses {
+            export interface $200 {
+                results?: Components.Schemas.Taxonomy[];
+            }
+        }
+    }
+    namespace UpdateClassificationsForTaxonomy {
+        namespace Parameters {
+            export type TaxonomySlug = string;
+        }
+        export interface PathParameters {
+            taxonomySlug: Parameters.TaxonomySlug;
+        }
+        export type RequestBody = Components.Schemas.ClassificationsUpdate;
+        namespace Responses {
+            export interface $200 {
+                results?: Components.Schemas.Taxonomy[];
+            }
+        }
+    }
     namespace UpdateEntity {
         namespace Parameters {
             export type ActivityId = /**
@@ -4771,6 +4906,56 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteSavedView.Responses.$200>
+  /**
+   * listTaxonomies - listTaxonomies
+   * 
+   * List taxonomies in an organisation
+   */
+  'listTaxonomies'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ListTaxonomies.Responses.$200>
+  /**
+   * getTaxonomy - getTaxonomy
+   * 
+   * Get taxonomy by slug
+   */
+  'getTaxonomy'(
+    parameters?: Parameters<Paths.GetTaxonomy.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetTaxonomy.Responses.$200>
+  /**
+   * taxonomiesAutocomplete - taxonomiesAutocomplete
+   * 
+   * Taxonomies auocomplete
+   */
+  'taxonomiesAutocomplete'(
+    parameters?: Parameters<Paths.TaxonomiesAutocomplete.QueryParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.TaxonomiesAutocomplete.Responses.$200>
+  /**
+   * getTaxonomyClassifications - getTaxonomyClassifications
+   * 
+   * List taxomies in an organisation based on taxonomy slug
+   */
+  'getTaxonomyClassifications'(
+    parameters?: Parameters<Paths.GetTaxonomyClassifications.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetTaxonomyClassifications.Responses.$200>
+  /**
+   * updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
+   * 
+   * Update taxonomies in an organisation based in taxonomy slug
+   */
+  'updateClassificationsForTaxonomy'(
+    parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
+    data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
 }
 
 export interface PathsDictionary {
@@ -5297,6 +5482,64 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeleteSavedView.Responses.$200>
   }
+  ['/v1/entity/listTaxonomies']: {
+    /**
+     * listTaxonomies - listTaxonomies
+     * 
+     * List taxonomies in an organisation
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ListTaxonomies.Responses.$200>
+  }
+  ['/v1/entity/taxonomies/{taxonomySlug}']: {
+    /**
+     * getTaxonomy - getTaxonomy
+     * 
+     * Get taxonomy by slug
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetTaxonomy.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetTaxonomy.Responses.$200>
+  }
+  ['/v1/entity/taxonomies:autocomplete']: {
+    /**
+     * taxonomiesAutocomplete - taxonomiesAutocomplete
+     * 
+     * Taxonomies auocomplete
+     */
+    'get'(
+      parameters?: Parameters<Paths.TaxonomiesAutocomplete.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.TaxonomiesAutocomplete.Responses.$200>
+  }
+  ['/v1/entity/taxonomies/{taxonomySlug}/classifications']: {
+    /**
+     * getTaxonomyClassifications - getTaxonomyClassifications
+     * 
+     * List taxomies in an organisation based on taxonomy slug
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetTaxonomyClassifications.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetTaxonomyClassifications.Responses.$200>
+    /**
+     * updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
+     * 
+     * Update taxonomies in an organisation based in taxonomy slug
+     */
+    'post'(
+      parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
+      data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>