@d19n/youfibre-odin-sdk 2.0.18 → 2.0.19

package/dist/actions-v2/MoveInstallWorkOrderToCancelledDto.d.ts

@@ -0,0 +1,115 @@
+/**
+ * MoveInstallWorkOrderToCancelled Action DTO
+ *
+ * MoveInstallWorkOrderToCancelled
+ *
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType INSTALL
+ * @actionKey MoveInstallWorkOrderToCancelled
+ * @event k1.t-t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveInstallWorkOrderToCancelled
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+declare type StepClassMap = {};
+/**
+ * Link definition for connecting steps in MoveInstallWorkOrderToCancelled
+ */
+export interface MoveInstallWorkOrderToCancelledStepLink {
+    /**
+     * The stepKey of the target step to link TO
+     * Must reference another step's stepKey in the same flow
+     */
+    stepKey: string;
+    /**
+     * The schema association ID (UUID) defining the relationship
+     * Use the association.id from the schema association definition
+     * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
+     */
+    schemaAssociationId: string;
+}
+/**
+ * Step definition with linking metadata for MoveInstallWorkOrderToCancelled
+ */
+export interface MoveInstallWorkOrderToCancelledStepDefinition {
+    /** Unique identifier for this step */
+    stepKey: string;
+    /** The DTO class name for this step */
+    dtoClass: string;
+    /** The entity this step creates (Module:Entity format) */
+    entity: string;
+    /** Links to create after this step executes */
+    linksTo: MoveInstallWorkOrderToCancelledStepLink[] | null;
+}
+/**
+ * Type-safe step keys for MoveInstallWorkOrderToCancelled
+ */
+export declare const MoveInstallWorkOrderToCancelledSteps: {
+    readonly step_1: "step_1";
+};
+export declare type MoveInstallWorkOrderToCancelledStepKey = typeof MoveInstallWorkOrderToCancelledSteps[keyof typeof MoveInstallWorkOrderToCancelledSteps];
+/**
+ * RabbitMQ message payload for MoveInstallWorkOrderToCancelled step flow events
+ *
+ * @event k1.t-t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveInstallWorkOrderToCancelled
+ */
+export interface MoveInstallWorkOrderToCancelledMessage extends OdinRecordUpdatedEvent<MoveInstallWorkOrderToCancelledDto, {}> {
+}
+/**
+ * Properties for MoveInstallWorkOrderToCancelled action
+ *
+ */
+export interface MoveInstallWorkOrderToCancelledProperties {
+}
+/**
+ * MoveInstallWorkOrderToCancelled
+ *
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType INSTALL (install)
+ * @targetStages WorkOrderStageCancelled
+ * @event k1.t-t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveInstallWorkOrderToCancelled
+ * @permission schema.action.moveinstallworkordertocancelled.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class MoveInstallWorkOrderToCancelledDto extends OdinRecordUpdateDto<Record<string, any>> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "UPDATE";
+    static readonly ACTION_KEY = "MoveInstallWorkOrderToCancelled";
+    static readonly MODULE_NAME = "FieldServiceModule";
+    static readonly ENTITIES: string[];
+    static readonly ENTITY_TYPE = "INSTALL";
+    static readonly EVENT_NAME = "k1.t-t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveInstallWorkOrderToCancelled";
+    static readonly SCHEMA_ACTION_ID = "7ae669f2-491c-4815-a2c2-c37c057e5680";
+    static readonly PERMISSION = "schema.action.moveinstallworkordertocancelled.trigger";
+    static readonly TARGET_STAGES: readonly ["WorkOrderStageCancelled"];
+    static readonly IS_STAGE_TRANSITION = true;
+    static readonly IS_MULTI_STEP_FLOW = false;
+    static readonly HAS_STEP_LINKS = false;
+    /**
+     * Step definitions with linking metadata
+     * Used by SDK and backend for auto-linking after step execution
+     */
+    static readonly stepDefinitions: MoveInstallWorkOrderToCancelledStepDefinition[];
+    /** Type-safe step key accessor */
+    static readonly Steps: {
+        readonly step_1: "step_1";
+    };
+    readonly actionName: string;
+    readonly schemaActionId: string;
+    readonly entity: string;
+    readonly stageKey: string;
+    constructor(record: OdinRecord<any> | {
+        id: string;
+        entity: string;
+        type?: string;
+    }, options?: {
+        journeyId?: string;
+    });
+    /** Step classes that can be used with this action */
+    static readonly stepClasses: readonly [];
+    steps: StepClassMap[(typeof MoveInstallWorkOrderToCancelledDto.stepClasses)[number]][];
+}
+export {};

package/dist/actions-v2/MoveInstallWorkOrderToCancelledDto.js

@@ -0,0 +1,80 @@
+"use strict";
+/**
+ * MoveInstallWorkOrderToCancelled Action DTO
+ *
+ * MoveInstallWorkOrderToCancelled
+ *
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType INSTALL
+ * @actionKey MoveInstallWorkOrderToCancelled
+ * @event k1.t-t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveInstallWorkOrderToCancelled
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MoveInstallWorkOrderToCancelledDto = exports.MoveInstallWorkOrderToCancelledSteps = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * Type-safe step keys for MoveInstallWorkOrderToCancelled
+ */
+exports.MoveInstallWorkOrderToCancelledSteps = {
+    step_1: 'step_1',
+};
+/**
+ * MoveInstallWorkOrderToCancelled
+ *
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType INSTALL (install)
+ * @targetStages WorkOrderStageCancelled
+ * @event k1.t-t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveInstallWorkOrderToCancelled
+ * @permission schema.action.moveinstallworkordertocancelled.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class MoveInstallWorkOrderToCancelledDto extends core_1.OdinRecordUpdateDto {
+    constructor(record, options) {
+        super({
+            id: record.id,
+            entity: record.entity,
+            type: record.type,
+            properties: {},
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+        });
+        this.actionName = 'MoveInstallWorkOrderToCancelled';
+        this.schemaActionId = '7ae669f2-491c-4815-a2c2-c37c057e5680';
+        this.entity = 'FieldServiceModule:WorkOrder';
+        this.stageKey = 'WorkOrderStageCancelled';
+    }
+}
+exports.MoveInstallWorkOrderToCancelledDto = MoveInstallWorkOrderToCancelledDto;
+/** Used by SDK generators to identify action type */
+MoveInstallWorkOrderToCancelledDto.ACTION_TYPE = 'UPDATE';
+MoveInstallWorkOrderToCancelledDto.ACTION_KEY = 'MoveInstallWorkOrderToCancelled';
+MoveInstallWorkOrderToCancelledDto.MODULE_NAME = 'FieldServiceModule';
+MoveInstallWorkOrderToCancelledDto.ENTITIES = ['WorkOrder'];
+MoveInstallWorkOrderToCancelledDto.ENTITY_TYPE = 'INSTALL';
+MoveInstallWorkOrderToCancelledDto.EVENT_NAME = 'k1.t-t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveInstallWorkOrderToCancelled';
+MoveInstallWorkOrderToCancelledDto.SCHEMA_ACTION_ID = '7ae669f2-491c-4815-a2c2-c37c057e5680';
+MoveInstallWorkOrderToCancelledDto.PERMISSION = 'schema.action.moveinstallworkordertocancelled.trigger';
+MoveInstallWorkOrderToCancelledDto.TARGET_STAGES = ['WorkOrderStageCancelled'];
+MoveInstallWorkOrderToCancelledDto.IS_STAGE_TRANSITION = true;
+MoveInstallWorkOrderToCancelledDto.IS_MULTI_STEP_FLOW = false;
+MoveInstallWorkOrderToCancelledDto.HAS_STEP_LINKS = false;
+/**
+ * Step definitions with linking metadata
+ * Used by SDK and backend for auto-linking after step execution
+ */
+MoveInstallWorkOrderToCancelledDto.stepDefinitions = [
+    {
+        stepKey: 'step_1',
+        dtoClass: 'unknown',
+        entity: 'unknown',
+        linksTo: null
+    }
+];
+/** Type-safe step key accessor */
+MoveInstallWorkOrderToCancelledDto.Steps = exports.MoveInstallWorkOrderToCancelledSteps;
+/** Step classes that can be used with this action */
+MoveInstallWorkOrderToCancelledDto.stepClasses = [];

package/dist/actions-v2/UpdateCaseCsatDto.d.ts

@@ -0,0 +1,135 @@
+/**
+ * UpdateCaseCsat Action DTO
+ *
+ * Updates the customer satisfaction fields
+ *
+ * @module SupportModule
+ * @entity Case
+ * @actionKey UpdateCaseCsat
+ * @event k1.t-t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseCsat
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for UpdateCaseCsat updated events
+ *
+ * @event k1.t-t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseCsat
+ */
+export interface UpdateCaseCsatMessage extends OdinRecordUpdatedEvent<UpdateCaseCsatDto, UpdateCaseCsatProperties> {
+}
+/**
+ * Properties for UpdateCaseCsat action
+ *
+ * @property Required fields: 0
+ * @property Optional fields: 10
+ */
+export interface UpdateCaseCsatProperties {
+    /**
+     * Resolution CSAT Score
+     *
+     * Customer satisfaction score for the resolution of the case.
+     * @type {NUMBER}
+     */
+    CsatResolutionScore?: number | null;
+    /**
+     * Resolution CSAT Reason
+     *
+     * Main reason for the resolution CSAT score.
+     * @type {ENUM}
+     */
+    CsatResolutionReason?: string | null;
+    /**
+     * Other Resolution CSAT Reason
+     *
+     * Reason when Resolution CSAT Reason is OTHER.
+     * @type {TEXT_LONG}
+     */
+    CsatResolutionOtherReason?: string | null;
+    /**
+     * Resolution CSAT Comment
+     *
+     * Optional customer comment about the resolution.
+     * @type {TEXT_LONG}
+     */
+    CsatResolutionComment?: string | null;
+    /**
+     * Agent CSAT Comment
+     *
+     * Optional customer comment about the agent.
+     * @type {TEXT_LONG}
+     */
+    CsatAgentComment?: string | null;
+    /**
+     * Other Agent CSAT Reason
+     *
+     * Reason when Agent CSAT Reason is OTHER.
+     * @type {TEXT_LONG}
+     */
+    CsatAgentOtherReason?: string | null;
+    /**
+     * Agent CSAT Reason
+     *
+     * Main reason for the agent CSAT score.
+     * @type {ENUM}
+     */
+    CsatAgentReason?: string | null;
+    /**
+     * Agent CSAT Score
+     *
+     * Customer satisfaction score for the agent who handled the case.
+     * @type {NUMBER}
+     */
+    CsatAgentScore?: number | null;
+    /**
+     * CSAT Response Date
+     *
+     * Timestamp of the CSAT response
+     * @type {DATE_TIME}
+     */
+    CsatResponseAt?: string | null;
+    /**
+     * CSAT Sent At
+     *
+     * Indicates when the CSAT has been sent
+     * @type {DATE_TIME}
+     */
+    CsatSentAt?: string | null;
+}
+/**
+ * UpdateCaseCsat
+ *
+ * Updates the customer satisfaction fields
+ *
+ * @actionType UPDATE - Updates an existing Case record
+ * @module SupportModule
+ * @entity Case
+ * @event k1.t-t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseCsat
+ * @permission schema.action.updatecasecsat.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class UpdateCaseCsatDto extends OdinRecordUpdateDto<UpdateCaseCsatProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "UPDATE";
+    static readonly ACTION_KEY = "UpdateCaseCsat";
+    static readonly MODULE_NAME = "SupportModule";
+    static readonly ENTITIES: string[];
+    static readonly EVENT_NAME = "k1.t-t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseCsat";
+    static readonly PERMISSION = "schema.action.updatecasecsat.trigger";
+    /** Step metadata - entity this action targets */
+    static readonly STEP_ENTITY = "SupportModule:Case";
+    static readonly STEP_SCHEMA_ID = "be8173eb-269b-4a67-be0c-11ce6af5d561";
+    static readonly STEP_SCHEMA_ACTION_ID = "69f8e454-d840-4dce-8484-321c2146f5f3";
+    static readonly AUTO_LINK_PARENT = false;
+    readonly actionName: string;
+    readonly schemaActionId: string;
+    readonly entity: string;
+    constructor(record: OdinRecord<any> | {
+        id: string;
+        entity: string;
+        type?: string;
+    }, properties: UpdateCaseCsatProperties, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    });
+}

package/dist/actions-v2/UpdateCaseCsatDto.js

@@ -0,0 +1,56 @@
+"use strict";
+/**
+ * UpdateCaseCsat Action DTO
+ *
+ * Updates the customer satisfaction fields
+ *
+ * @module SupportModule
+ * @entity Case
+ * @actionKey UpdateCaseCsat
+ * @event k1.t-t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseCsat
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateCaseCsatDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * UpdateCaseCsat
+ *
+ * Updates the customer satisfaction fields
+ *
+ * @actionType UPDATE - Updates an existing Case record
+ * @module SupportModule
+ * @entity Case
+ * @event k1.t-t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseCsat
+ * @permission schema.action.updatecasecsat.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class UpdateCaseCsatDto extends core_1.OdinRecordUpdateDto {
+    constructor(record, properties, options) {
+        super({
+            id: record.id,
+            entity: record.entity,
+            type: record.type,
+            properties,
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+            stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
+        });
+        this.actionName = 'UpdateCaseCsat';
+        this.schemaActionId = '69f8e454-d840-4dce-8484-321c2146f5f3';
+        this.entity = 'SupportModule:Case';
+    }
+}
+exports.UpdateCaseCsatDto = UpdateCaseCsatDto;
+/** Used by SDK generators to identify action type */
+UpdateCaseCsatDto.ACTION_TYPE = 'UPDATE';
+UpdateCaseCsatDto.ACTION_KEY = 'UpdateCaseCsat';
+UpdateCaseCsatDto.MODULE_NAME = 'SupportModule';
+UpdateCaseCsatDto.ENTITIES = ['Case'];
+UpdateCaseCsatDto.EVENT_NAME = 'k1.t-t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseCsat';
+UpdateCaseCsatDto.PERMISSION = 'schema.action.updatecasecsat.trigger';
+/** Step metadata - entity this action targets */
+UpdateCaseCsatDto.STEP_ENTITY = 'SupportModule:Case';
+UpdateCaseCsatDto.STEP_SCHEMA_ID = 'be8173eb-269b-4a67-be0c-11ce6af5d561';
+UpdateCaseCsatDto.STEP_SCHEMA_ACTION_ID = '69f8e454-d840-4dce-8484-321c2146f5f3';
+UpdateCaseCsatDto.AUTO_LINK_PARENT = false;

package/dist/db-accessors-v2/BngProvisionDbAccessor.d.ts

@@ -0,0 +1,149 @@
+/**
+ * BngProvision DB Accessor
+ *
+ * Provides typed access to BngProvision records via direct database access.
+ * For use in backend services with principal + dbService.
+ * Returns wrapped records with typed action methods.
+ *
+ * @example
+ * ```typescript
+ * // Simple get
+ * const record = await accessor.get(id);
+ *
+ * // With related entities
+ * const record = await accessor.get(id, { entities: ["Contact", "Address"] });
+ *
+ * // With permissions bypass (separate options)
+ * const record = await accessor.get(id, {}, { omitPermissionsCheck: true });
+ *
+ * // Silent write (no RabbitMQ events)
+ * const result = await accessor.upsert([dto], { omitWriteEvents: true });
+ *
+ * // Constructor-level default (applies to all calls)
+ * const accessor = new BngProvisionDbAccessor(principal, dbService, { omitPermissionsCheck: true });
+ * ```
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinSearchV2 } from '@d19n/odin-types/dist/core';
+import { DbProvider, DbProviderOptions, DbGetQueryOptions } from '@d19n/odin-sdk-generator/dist/db.provider';
+import { QueryBuilder } from '@d19n/odin-sdk-generator/dist/query-builder';
+import { BngProvisionProperties } from '../entities-v2/BngProvision';
+import { BngProvisionRecord } from '../records-v2/BngProvisionRecord';
+/** Search response with wrapped records */
+export interface BngProvisionDbSearchResponse {
+    records: BngProvisionRecord[];
+    totalRecords: number;
+    hasMore: boolean;
+}
+export declare class BngProvisionDbAccessor {
+    private readonly _provider;
+    private readonly _moduleName;
+    private readonly _entityName;
+    private readonly _defaultOptions?;
+    /**
+     * Create a new BngProvisionDbAccessor
+     * @param principal - The authenticated principal
+     * @param dbService - The database service instance
+     * @param defaultOptions - Default provider options applied to all operations
+     */
+    constructor(principal: any, dbService: any, defaultOptions?: DbProviderOptions);
+    get moduleName(): string;
+    get entityName(): string;
+    /**
+     * Create a new empty BngProvision record instance for create operations.
+     * Pre-generates an ID that can be referenced before the record is saved.
+     *
+     * @param id - Optional ID to use (auto-generated UUID if not provided)
+     * @returns A new record wrapper with pre-generated ID
+     *
+     * @example
+     * ```typescript
+     * // Auto-generated ID
+     * const note = odinDb.notes.new();
+     * console.log(note.id); // UUID available immediately
+     *
+     * // Custom ID
+     * const order = odinDb.orders.new("custom-id-123");
+     *
+     * // Reference ID before save
+     * const account = odinDb.accounts.new();
+     * const contact = odinDb.contacts.new();
+     * await contact
+     *   .link({ id: account.id, entity: "CrmModule:Account" })
+     *   .createContact({ FirstName: "John" });
+     * ```
+     */
+    new(id?: string): BngProvisionRecord;
+    /**
+     * Get a single BngProvision record by ID
+     *
+     * @param id - The record ID
+     * @param queryOptions - Query options (WHAT to fetch: entities to include)
+     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
+     *
+     * @example
+     * ```typescript
+     * // Simple get
+     * const record = await accessor.get(id);
+     *
+     * // With related entities
+     * const record = await accessor.get(id, { entities: ["Contact", "Address"] });
+     *
+     * // With permissions bypass
+     * const record = await accessor.get(id, {}, { omitPermissionsCheck: true });
+     *
+     * // Both options
+     * const record = await accessor.get(id, { entities: ["Invoice"] }, { omitPermissionsCheck: true });
+     * ```
+     */
+    get(id: string, queryOptions?: DbGetQueryOptions, providerOptions?: DbProviderOptions): Promise<BngProvisionRecord>;
+    /**
+     * Get multiple BngProvision records by IDs
+     *
+     * @param ids - Array of record IDs
+     * @param queryOptions - Query options (WHAT to fetch: entities to include)
+     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
+     */
+    getMany(ids: string[], queryOptions?: DbGetQueryOptions, providerOptions?: DbProviderOptions): Promise<BngProvisionRecord[]>;
+    /**
+     * Search BngProvision records
+     *
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
+     */
+    search(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): Promise<BngProvisionDbSearchResponse>;
+    /**
+     * Search all BngProvision records with automatic pagination
+     *
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
+     */
+    searchAll(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): Promise<BngProvisionRecord[]>;
+    /**
+     * Async generator for paginating through all matching records.
+     * Yields batches of wrapped records.
+     *
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
+     */
+    paginate(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): AsyncGenerator<BngProvisionRecord[]>;
+    /**
+     * Create a fluent query builder for BngProvision records
+     *
+     * @example
+     * ```typescript
+     * const results = await accessor
+     *   .query()
+     *   .where('Status', 'in', ['Active', 'Pending'])
+     *   .where('CreatedAt', 'gte', '2025-01-01')
+     *   .select('id', 'title', 'properties.*')
+     *   .sortBy('createdAt', 'desc')
+     *   .limit(100)
+     *   .execute();
+     * ```
+     */
+    query(): QueryBuilder<BngProvisionProperties, BngProvisionRecord>;
+    /** Access the underlying DbProvider */
+    get provider(): DbProvider;
+}