@epilot/entity-client 4.33.2 → 4.33.3

package/dist/openapi.d.ts

@@ -2488,6 +2488,11 @@ declare namespace Components {
              * https://docs.epilot.io/docs/pricing/entities
              */
             docs_url?: string; // uri
+            /**
+             * example:
+             * customer_relations
+             */
+            category?: "customer_relations" | "sales" | "product_hub" | "contracts" | "journeys" | "messaging" | "system";
             /**
              * example:
              * false
@@ -2857,6 +2862,11 @@ declare namespace Components {
              * https://docs.epilot.io/docs/pricing/entities
              */
             docs_url?: string; // uri
+            /**
+             * example:
+             * customer_relations
+             */
+            category?: "customer_relations" | "sales" | "product_hub" | "contracts" | "journeys" | "messaging" | "system";
             /**
              * example:
              * false
@@ -5480,8 +5490,18 @@ declare namespace Components {
              * taxonomy-slug:classification-slug
              */
             ClassificationId[];
+            /**
+             * Color of the classification
+             * example:
+             * #FF5733
+             */
+            color?: string;
             created_at?: string; // date-time
             updated_at?: string; // date-time
+            /**
+             * Archived classification are not visible in the UI
+             */
+            archived?: boolean;
             type?: "purpose";
         }
         /**
@@ -7065,20 +7085,60 @@ declare namespace Components {
              */
             enabled_locations?: TaxonomyLocationId[];
         }
+        /**
+         * example:
+         * {
+         *   "job_id": "123e4567-e89b-12d3-a456-426614174000",
+         *   "status": "PENDING",
+         *   "action_type": "MOVE_LABELS",
+         *   "created_by": 10598,
+         *   "created_at": "2024-01-01T00:00:00.000Z",
+         *   "updated_at": "2024-01-01T00:00:00.000Z",
+         *   "org": 66,
+         *   "progress": 0.5
+         * }
+         */
         export interface TaxonomyBulkJob {
             job_id?: string; // uuid
-            status?: /* The status of the bulk job */ TaxonomyBulkJobStatus;
-            type?: TaxonomyBulkJobType;
+            job_status?: /* The status of the bulk job */ TaxonomyBulkJobStatus;
+            action_type?: TaxonomyBulkJobActionType;
+            request?: {
+                target_taxonomy?: /**
+                 * URL-friendly name for taxonomy
+                 * example:
+                 * purpose
+                 */
+                TaxonomySlug;
+                classification_ids?: /**
+                 * example:
+                 * taxonomy-slug:classification-slug
+                 */
+                ClassificationId[];
+            };
+            output?: {
+                target_entities?: EntityId /* uuid */[];
+                affected_entities?: EntityId /* uuid */[];
+                failures_count?: number;
+                failed_entities?: EntityId /* uuid */[];
+            };
+            created_by?: string;
+            created_at?: string; // date-time
+            updated_at?: string; // date-time
+            org?: string;
+            /**
+             * Progress of the job on a scale of 0 to 1
+             */
+            progress?: number;
         }
+        export type TaxonomyBulkJobActionType = "MOVE_CLASSIFICATIONS" | "DELETE_CLASSIFICATIONS";
         /**
          * The status of the bulk job
          */
-        export type TaxonomyBulkJobStatus = "PENDING" | "FAILED" | "COMPLETED";
+        export type TaxonomyBulkJobStatus = "PENDING" | "FAILED" | "COMPLETED" | "CANCELLED";
         export interface TaxonomyBulkJobTriggerResponse {
             job_id?: string; // uuid
             status?: /* The status of the bulk job */ TaxonomyBulkJobStatus;
         }
-        export type TaxonomyBulkJobType = "MOVE_LABELS" | "DELETE_LABELS";
         export interface TaxonomyClassification {
             id?: /**
              * example:
@@ -7101,8 +7161,18 @@ declare namespace Components {
              * taxonomy-slug:classification-slug
              */
             ClassificationId[];
+            /**
+             * Color of the classification
+             * example:
+             * #FF5733
+             */
+            color?: string;
             created_at?: string; // date-time
             updated_at?: string; // date-time
+            /**
+             * Archived classification are not visible in the UI
+             */
+            archived?: boolean;
             /**
              * Manifest ID used to create/update the taxonomy classification
              */
@@ -7489,13 +7559,11 @@ declare namespace Paths {
         }
     }
     namespace BulkDeleteClassifications {
-        namespace Parameters {
-            export type Permanent = boolean;
-        }
-        export interface QueryParameters {
-            permanent?: Parameters.Permanent;
-        }
         export interface RequestBody {
+            /**
+             * Job ID for tracking the status of a bulk operation request
+             */
+            job_id?: string;
             classification_ids?: /**
              * example:
              * taxonomy-slug:classification-slug
@@ -7507,18 +7575,20 @@ declare namespace Paths {
         }
     }
     namespace BulkMoveClassifications {
-        namespace Parameters {
-            export type TargetTaxonomy = /**
+        export interface RequestBody {
+            /**
+             * Job ID for tracking the status of a bulk operation request
+             */
+            job_id?: string;
+            /**
+             * The target taxonomy to which the classifications will be moved
+             */
+            target_taxonomy?: /**
              * URL-friendly name for taxonomy
              * example:
              * purpose
              */
             Components.Schemas.TaxonomySlug;
-        }
-        export interface QueryParameters {
-            target_taxonomy?: Parameters.TargetTaxonomy;
-        }
-        export interface RequestBody {
             classification_ids?: /**
              * example:
              * taxonomy-slug:classification-slug
@@ -8184,17 +8254,6 @@ declare namespace Paths {
             Components.Schemas.EntityItem;
         }
     }
-    namespace GetJobs {
-        namespace Parameters {
-            export type Status = /* The status of the bulk job */ Components.Schemas.TaxonomyBulkJobStatus;
-        }
-        export interface QueryParameters {
-            status?: Parameters.Status;
-        }
-        namespace Responses {
-            export type $200 = Components.Schemas.TaxonomyBulkJob[];
-        }
-    }
     namespace GetJsonSchema {
         namespace Parameters {
             export type Slug = /**
@@ -8852,6 +8911,54 @@ declare namespace Paths {
             export type $200 = Components.Schemas.Taxonomy;
         }
     }
+    namespace GetTaxonomyBulkActionJobById {
+        namespace Parameters {
+            export type JobId = string;
+        }
+        export interface PathParameters {
+            job_id?: Parameters.JobId;
+        }
+        namespace Responses {
+            export type $200 = /**
+             * example:
+             * {
+             *   "job_id": "123e4567-e89b-12d3-a456-426614174000",
+             *   "status": "PENDING",
+             *   "action_type": "MOVE_LABELS",
+             *   "created_by": 10598,
+             *   "created_at": "2024-01-01T00:00:00.000Z",
+             *   "updated_at": "2024-01-01T00:00:00.000Z",
+             *   "org": 66,
+             *   "progress": 0.5
+             * }
+             */
+            Components.Schemas.TaxonomyBulkJob[];
+        }
+    }
+    namespace GetTaxonomyBulkActionJobs {
+        namespace Parameters {
+            export type Status = /* The status of the bulk job */ Components.Schemas.TaxonomyBulkJobStatus;
+        }
+        export interface QueryParameters {
+            status?: Parameters.Status;
+        }
+        namespace Responses {
+            export type $200 = /**
+             * example:
+             * {
+             *   "job_id": "123e4567-e89b-12d3-a456-426614174000",
+             *   "status": "PENDING",
+             *   "action_type": "MOVE_LABELS",
+             *   "created_by": 10598,
+             *   "created_at": "2024-01-01T00:00:00.000Z",
+             *   "updated_at": "2024-01-01T00:00:00.000Z",
+             *   "org": 66,
+             *   "progress": 0.5
+             * }
+             */
+            Components.Schemas.TaxonomyBulkJob[];
+        }
+    }
     namespace GetTaxonomyClassification {
         namespace Parameters {
             export type ClassificationSlug = string;
@@ -9338,6 +9445,11 @@ declare namespace Paths {
     }
     namespace TaxonomiesClassificationsSearch {
         namespace Parameters {
+            /**
+             * example:
+             * false
+             */
+            export type Archived = boolean;
             /**
              * example:
              * sales
@@ -9352,6 +9464,11 @@ declare namespace Paths {
              * sales
              */
             Parameters.Query;
+            archived?: /**
+             * example:
+             * false
+             */
+            Parameters.Archived;
         }
         export interface RequestBody {
             classificationIds?: /**
@@ -10683,15 +10800,30 @@ export interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ListTaxonomyClassificationsForSchema.Responses.$200>
   /**
-   * getJobs - getJobs
+   * getTaxonomyBulkActionJobs - getTaxonomyBulkActionJobs
+   * 
+   * Gets bulk actions jobs by job status:
+   * - <undefined> = all active jobs
+   * - PENDING = all active jobs
+   * - FAILED = all failed jobs
+   * - COMPLETED = all completed jobs
    * 
-   * Gets bulk jobs by job status
    */
-  'getJobs'(
-    parameters?: Parameters<Paths.GetJobs.QueryParameters> | null,
+  'getTaxonomyBulkActionJobs'(
+    parameters?: Parameters<Paths.GetTaxonomyBulkActionJobs.QueryParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
-  ): OperationResponse<Paths.GetJobs.Responses.$200>
+  ): OperationResponse<Paths.GetTaxonomyBulkActionJobs.Responses.$200>
+  /**
+   * getTaxonomyBulkActionJobById - getTaxonomyBulkActionJobById
+   * 
+   * Gets a bulk action job by job id
+   */
+  'getTaxonomyBulkActionJobById'(
+    parameters?: Parameters<Paths.GetTaxonomyBulkActionJobById.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetTaxonomyBulkActionJobById.Responses.$200>
   /**
    * bulkMoveClassifications - bulkMoveClassifications
    * 
@@ -10700,19 +10832,20 @@ export interface OperationMethods {
    * 
    */
   'bulkMoveClassifications'(
-    parameters?: Parameters<Paths.BulkMoveClassifications.QueryParameters> | null,
+    parameters?: Parameters<UnknownParamsObject> | null,
     data?: Paths.BulkMoveClassifications.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.BulkMoveClassifications.Responses.$200>
   /**
    * bulkDeleteClassifications - bulkDeleteClassifications
    * 
-   * Archives or permanently deletes taxonomy classifications. When permanent is true, the classifications are deleted through a bulk 
-   * async operation which also deletes all references of the deleted classifications from the entities referencing them.
+   * Permanently deletes taxonomy classifications. The classifications are deleted through a bulk 
+   * async operation which also deletes all references of the deleted classifications from the entities 
+   * referencing them.
    * 
    */
   'bulkDeleteClassifications'(
-    parameters?: Parameters<Paths.BulkDeleteClassifications.QueryParameters> | null,
+    parameters?: Parameters<UnknownParamsObject> | null,
     data?: Paths.BulkDeleteClassifications.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.BulkDeleteClassifications.Responses.$200>
@@ -11747,17 +11880,34 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.ListTaxonomyClassificationsForSchema.Responses.$200>
   }
-  ['/v1/entity/taxonomies/jobs']: {
+  ['/v1/entity/taxonomies/bulk-jobs']: {
+    /**
+     * getTaxonomyBulkActionJobs - getTaxonomyBulkActionJobs
+     * 
+     * Gets bulk actions jobs by job status:
+     * - <undefined> = all active jobs
+     * - PENDING = all active jobs
+     * - FAILED = all failed jobs
+     * - COMPLETED = all completed jobs
+     * 
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetTaxonomyBulkActionJobs.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetTaxonomyBulkActionJobs.Responses.$200>
+  }
+  ['/v1/entity/taxonomies/bulk-jobs/{job_id}']: {
     /**
-     * getJobs - getJobs
+     * getTaxonomyBulkActionJobById - getTaxonomyBulkActionJobById
      * 
-     * Gets bulk jobs by job status
+     * Gets a bulk action job by job id
      */
     'get'(
-      parameters?: Parameters<Paths.GetJobs.QueryParameters> | null,
+      parameters?: Parameters<Paths.GetTaxonomyBulkActionJobById.PathParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
-    ): OperationResponse<Paths.GetJobs.Responses.$200>
+    ): OperationResponse<Paths.GetTaxonomyBulkActionJobById.Responses.$200>
   }
   ['/v1/entity/taxonomies/classifications:move']: {
     /**
@@ -11768,7 +11918,7 @@ export interface PathsDictionary {
      * 
      */
     'post'(
-      parameters?: Parameters<Paths.BulkMoveClassifications.QueryParameters> | null,
+      parameters?: Parameters<UnknownParamsObject> | null,
       data?: Paths.BulkMoveClassifications.RequestBody,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.BulkMoveClassifications.Responses.$200>
@@ -11777,12 +11927,13 @@ export interface PathsDictionary {
     /**
      * bulkDeleteClassifications - bulkDeleteClassifications
      * 
-     * Archives or permanently deletes taxonomy classifications. When permanent is true, the classifications are deleted through a bulk 
-     * async operation which also deletes all references of the deleted classifications from the entities referencing them.
+     * Permanently deletes taxonomy classifications. The classifications are deleted through a bulk 
+     * async operation which also deletes all references of the deleted classifications from the entities 
+     * referencing them.
      * 
      */
     'post'(
-      parameters?: Parameters<Paths.BulkDeleteClassifications.QueryParameters> | null,
+      parameters?: Parameters<UnknownParamsObject> | null,
       data?: Paths.BulkDeleteClassifications.RequestBody,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.BulkDeleteClassifications.Responses.$200>
@@ -12070,9 +12221,9 @@ export type SummaryField = Components.Schemas.SummaryField;
 export type TagsAttribute = Components.Schemas.TagsAttribute;
 export type Taxonomy = Components.Schemas.Taxonomy;
 export type TaxonomyBulkJob = Components.Schemas.TaxonomyBulkJob;
+export type TaxonomyBulkJobActionType = Components.Schemas.TaxonomyBulkJobActionType;
 export type TaxonomyBulkJobStatus = Components.Schemas.TaxonomyBulkJobStatus;
 export type TaxonomyBulkJobTriggerResponse = Components.Schemas.TaxonomyBulkJobTriggerResponse;
-export type TaxonomyBulkJobType = Components.Schemas.TaxonomyBulkJobType;
 export type TaxonomyClassification = Components.Schemas.TaxonomyClassification;
 export type TaxonomyLocationId = Components.Schemas.TaxonomyLocationId;
 export type TaxonomySlug = Components.Schemas.TaxonomySlug;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/entity-client",
-  "version": "4.33.2",
+  "version": "4.33.3",
   "description": "JavaScript client library for the epilot Core Entity API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",