@d19n/youfibre-odin-sdk 2.0.285 → 2.0.287

package/dist/actions-v2/CreateCustomerDeviceRouterFromDispatchDto.js

@@ -0,0 +1,54 @@
+"use strict";
+/**
+ * CreateCustomerDeviceRouterFromDispatch Action DTO
+ *
+ * Create a CustomerDeviceRouter from a dispatched parcel — the serial and mac AMCO reported, and nothing else.
+ *
+ * @module ServiceModule
+ * @entity CustomerDeviceRouter
+ * @actionKey CreateCustomerDeviceRouterFromDispatch
+ * @event k1.t-hEOJjsDb.ServiceModule.CustomerDeviceRouter.Create.CreateCustomerDeviceRouterFromDispatch
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateCustomerDeviceRouterFromDispatchDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * CreateCustomerDeviceRouterFromDispatch
+ *
+ * Create a CustomerDeviceRouter from a dispatched parcel — the serial and mac AMCO reported, and nothing else.
+ *
+ * @actionType CREATE - Creates a new CustomerDeviceRouter record
+ * @module ServiceModule
+ * @entity CustomerDeviceRouter
+ * @event k1.t-hEOJjsDb.ServiceModule.CustomerDeviceRouter.Create.CreateCustomerDeviceRouterFromDispatch
+ * @permission schema.action.createcustomerdevicerouterfromdispatch.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class CreateCustomerDeviceRouterFromDispatchDto extends core_1.OdinRecordCreateDto {
+    constructor(properties, options) {
+        super({
+            entity: 'ServiceModule:CustomerDeviceRouter',
+            type: undefined,
+            properties,
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+        });
+        this.actionName = 'CreateCustomerDeviceRouterFromDispatch';
+        this.schemaActionId = '5b818ad9-c6e5-4787-a990-539145fe47fe';
+        this.entity = 'ServiceModule:CustomerDeviceRouter';
+    }
+}
+exports.CreateCustomerDeviceRouterFromDispatchDto = CreateCustomerDeviceRouterFromDispatchDto;
+/** Used by SDK generators to identify action type */
+CreateCustomerDeviceRouterFromDispatchDto.ACTION_TYPE = 'CREATE';
+CreateCustomerDeviceRouterFromDispatchDto.ACTION_KEY = 'CreateCustomerDeviceRouterFromDispatch';
+CreateCustomerDeviceRouterFromDispatchDto.MODULE_NAME = 'ServiceModule';
+CreateCustomerDeviceRouterFromDispatchDto.ENTITIES = ['CustomerDeviceRouter'];
+CreateCustomerDeviceRouterFromDispatchDto.EVENT_NAME = 'k1.t-hEOJjsDb.ServiceModule.CustomerDeviceRouter.Create.CreateCustomerDeviceRouterFromDispatch';
+CreateCustomerDeviceRouterFromDispatchDto.PERMISSION = 'schema.action.createcustomerdevicerouterfromdispatch.trigger';
+/** Step metadata - entity this action targets */
+CreateCustomerDeviceRouterFromDispatchDto.STEP_ENTITY = 'ServiceModule:CustomerDeviceRouter';
+CreateCustomerDeviceRouterFromDispatchDto.STEP_SCHEMA_ID = '4c9cdf3a-e059-4e45-8050-e6cdf9fdd87d';
+CreateCustomerDeviceRouterFromDispatchDto.STEP_SCHEMA_ACTION_ID = '5b818ad9-c6e5-4787-a990-539145fe47fe';
+CreateCustomerDeviceRouterFromDispatchDto.AUTO_LINK_PARENT = true;

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

@@ -0,0 +1,63 @@
+/**
+ * CreateRecontract Action DTO
+ *
+ * Create Recontract
+ *
+ * @module OrderModule
+ * @entity Recontract
+ * @entityType DEFAULT
+ * @actionKey CreateRecontract
+ * @event k1.t-hEOJjsDb.OrderModule.Recontract.Create.CreateRecontract
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for CreateRecontract created events
+ *
+ * @event k1.t-hEOJjsDb.OrderModule.Recontract.Create.CreateRecontract
+ */
+export interface CreateRecontractMessage extends OdinRecordCreatedEvent<CreateRecontractDto, CreateRecontractProperties> {
+}
+/**
+ * Properties for CreateRecontract action
+ *
+ */
+export interface CreateRecontractProperties {
+}
+/**
+ * CreateRecontract
+ *
+ * Create Recontract
+ *
+ * @actionType CREATE - Creates a new Recontract record
+ * @module OrderModule
+ * @entity Recontract
+ * @entityType DEFAULT (Default)
+ * @event k1.t-hEOJjsDb.OrderModule.Recontract.Create.CreateRecontract
+ * @permission schema.action.createrecontract.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class CreateRecontractDto extends OdinRecordCreateDto<CreateRecontractProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "CREATE";
+    static readonly ACTION_KEY = "CreateRecontract";
+    static readonly MODULE_NAME = "OrderModule";
+    static readonly ENTITIES: string[];
+    static readonly ENTITY_TYPE = "DEFAULT";
+    static readonly EVENT_NAME = "k1.t-hEOJjsDb.OrderModule.Recontract.Create.CreateRecontract";
+    static readonly PERMISSION = "schema.action.createrecontract.trigger";
+    /** Step metadata - entity this action targets */
+    static readonly STEP_ENTITY = "OrderModule:Recontract";
+    static readonly STEP_SCHEMA_ID = "737797cf-3ab0-49da-827c-18ec499db889";
+    static readonly STEP_SCHEMA_ACTION_ID = "ca8242d6-738e-49b0-9822-8804ac5c379e";
+    static readonly STEP_SCHEMA_TYPE_ID = "61db803a-cf84-4fee-b460-eb0cba01b705";
+    static readonly STEP_TYPE = "DEFAULT";
+    static readonly AUTO_LINK_PARENT = true;
+    readonly actionName: string;
+    readonly schemaActionId: string;
+    readonly entity: string;
+    constructor(properties: CreateRecontractProperties, options?: {
+        journeyId?: string;
+    });
+}

package/dist/actions-v2/CreateRecontractDto.js

@@ -0,0 +1,59 @@
+"use strict";
+/**
+ * CreateRecontract Action DTO
+ *
+ * Create Recontract
+ *
+ * @module OrderModule
+ * @entity Recontract
+ * @entityType DEFAULT
+ * @actionKey CreateRecontract
+ * @event k1.t-hEOJjsDb.OrderModule.Recontract.Create.CreateRecontract
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateRecontractDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * CreateRecontract
+ *
+ * Create Recontract
+ *
+ * @actionType CREATE - Creates a new Recontract record
+ * @module OrderModule
+ * @entity Recontract
+ * @entityType DEFAULT (Default)
+ * @event k1.t-hEOJjsDb.OrderModule.Recontract.Create.CreateRecontract
+ * @permission schema.action.createrecontract.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class CreateRecontractDto extends core_1.OdinRecordCreateDto {
+    constructor(properties, options) {
+        super({
+            entity: 'OrderModule:Recontract',
+            type: 'DEFAULT',
+            properties,
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+        });
+        this.actionName = 'CreateRecontract';
+        this.schemaActionId = 'ca8242d6-738e-49b0-9822-8804ac5c379e';
+        this.entity = 'OrderModule:Recontract';
+    }
+}
+exports.CreateRecontractDto = CreateRecontractDto;
+/** Used by SDK generators to identify action type */
+CreateRecontractDto.ACTION_TYPE = 'CREATE';
+CreateRecontractDto.ACTION_KEY = 'CreateRecontract';
+CreateRecontractDto.MODULE_NAME = 'OrderModule';
+CreateRecontractDto.ENTITIES = ['Recontract'];
+CreateRecontractDto.ENTITY_TYPE = 'DEFAULT';
+CreateRecontractDto.EVENT_NAME = 'k1.t-hEOJjsDb.OrderModule.Recontract.Create.CreateRecontract';
+CreateRecontractDto.PERMISSION = 'schema.action.createrecontract.trigger';
+/** Step metadata - entity this action targets */
+CreateRecontractDto.STEP_ENTITY = 'OrderModule:Recontract';
+CreateRecontractDto.STEP_SCHEMA_ID = '737797cf-3ab0-49da-827c-18ec499db889';
+CreateRecontractDto.STEP_SCHEMA_ACTION_ID = 'ca8242d6-738e-49b0-9822-8804ac5c379e';
+CreateRecontractDto.STEP_SCHEMA_TYPE_ID = '61db803a-cf84-4fee-b460-eb0cba01b705';
+CreateRecontractDto.STEP_TYPE = 'DEFAULT';
+CreateRecontractDto.AUTO_LINK_PARENT = true;

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

@@ -0,0 +1,70 @@
+/**
+ * MoveCollectionAmcoToPendingPayment Action DTO
+ *
+ * Move the collection work order to Pending Payment.
+ *
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType COLLECTION_AMCO
+ * @actionKey MoveCollectionAmcoToPendingPayment
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingPayment
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for MoveCollectionAmcoToPendingPayment step flow events
+ *
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingPayment
+ */
+export interface MoveCollectionAmcoToPendingPaymentMessage extends OdinRecordUpdatedEvent<MoveCollectionAmcoToPendingPaymentDto, {}> {
+}
+/**
+ * Properties for MoveCollectionAmcoToPendingPayment action
+ *
+ */
+export interface MoveCollectionAmcoToPendingPaymentProperties {
+}
+/**
+ * MoveCollectionAmcoToPendingPayment
+ *
+ * Move the collection work order to Pending Payment.
+ *
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType COLLECTION_AMCO ( 3PL Collection)
+ * @targetStages CollectionAmcoStagePendingPayment
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingPayment
+ * @permission schema.action.movecollectionamcotopendingpayment.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class MoveCollectionAmcoToPendingPaymentDto extends OdinRecordUpdateDto<Record<string, any>> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "UPDATE";
+    static readonly ACTION_KEY = "MoveCollectionAmcoToPendingPayment";
+    static readonly MODULE_NAME = "FieldServiceModule";
+    static readonly ENTITIES: string[];
+    static readonly ENTITY_TYPE = "COLLECTION_AMCO";
+    static readonly EVENT_NAME = "k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingPayment";
+    static readonly SCHEMA_ACTION_ID = "2136c985-8f01-4ca8-a265-4b73ae810f7e";
+    static readonly PERMISSION = "schema.action.movecollectionamcotopendingpayment.trigger";
+    static readonly TARGET_STAGES: readonly ["CollectionAmcoStagePendingPayment"];
+    static readonly IS_STAGE_TRANSITION = true;
+    static readonly IS_MULTI_STEP_FLOW = false;
+    static readonly HAS_STEP_LINKS = false;
+    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: [];
+}

package/dist/actions-v2/MoveCollectionAmcoToPendingPaymentDto.js

@@ -0,0 +1,62 @@
+"use strict";
+/**
+ * MoveCollectionAmcoToPendingPayment Action DTO
+ *
+ * Move the collection work order to Pending Payment.
+ *
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType COLLECTION_AMCO
+ * @actionKey MoveCollectionAmcoToPendingPayment
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingPayment
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MoveCollectionAmcoToPendingPaymentDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * MoveCollectionAmcoToPendingPayment
+ *
+ * Move the collection work order to Pending Payment.
+ *
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType COLLECTION_AMCO ( 3PL Collection)
+ * @targetStages CollectionAmcoStagePendingPayment
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingPayment
+ * @permission schema.action.movecollectionamcotopendingpayment.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class MoveCollectionAmcoToPendingPaymentDto 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 = 'MoveCollectionAmcoToPendingPayment';
+        this.schemaActionId = '2136c985-8f01-4ca8-a265-4b73ae810f7e';
+        this.entity = 'FieldServiceModule:WorkOrder';
+        this.stageKey = 'CollectionAmcoStagePendingPayment';
+    }
+}
+exports.MoveCollectionAmcoToPendingPaymentDto = MoveCollectionAmcoToPendingPaymentDto;
+/** Used by SDK generators to identify action type */
+MoveCollectionAmcoToPendingPaymentDto.ACTION_TYPE = 'UPDATE';
+MoveCollectionAmcoToPendingPaymentDto.ACTION_KEY = 'MoveCollectionAmcoToPendingPayment';
+MoveCollectionAmcoToPendingPaymentDto.MODULE_NAME = 'FieldServiceModule';
+MoveCollectionAmcoToPendingPaymentDto.ENTITIES = ['WorkOrder'];
+MoveCollectionAmcoToPendingPaymentDto.ENTITY_TYPE = 'COLLECTION_AMCO';
+MoveCollectionAmcoToPendingPaymentDto.EVENT_NAME = 'k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingPayment';
+MoveCollectionAmcoToPendingPaymentDto.SCHEMA_ACTION_ID = '2136c985-8f01-4ca8-a265-4b73ae810f7e';
+MoveCollectionAmcoToPendingPaymentDto.PERMISSION = 'schema.action.movecollectionamcotopendingpayment.trigger';
+MoveCollectionAmcoToPendingPaymentDto.TARGET_STAGES = ['CollectionAmcoStagePendingPayment'];
+MoveCollectionAmcoToPendingPaymentDto.IS_STAGE_TRANSITION = true;
+MoveCollectionAmcoToPendingPaymentDto.IS_MULTI_STEP_FLOW = false;
+MoveCollectionAmcoToPendingPaymentDto.HAS_STEP_LINKS = false;
+/** Step classes that can be used with this action */
+MoveCollectionAmcoToPendingPaymentDto.stepClasses = [];

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

@@ -0,0 +1,149 @@
+/**
+ * Recontract DB Accessor
+ *
+ * Provides typed access to Recontract 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 RecontractDbAccessor(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 { RecontractProperties } from '../entities-v2/Recontract';
+import { RecontractRecord } from '../records-v2/RecontractRecord';
+/** Search response with wrapped records */
+export interface RecontractDbSearchResponse {
+    records: RecontractRecord[];
+    totalRecords: number;
+    hasMore: boolean;
+}
+export declare class RecontractDbAccessor {
+    private readonly _provider;
+    private readonly _moduleName;
+    private readonly _entityName;
+    private readonly _defaultOptions?;
+    /**
+     * Create a new RecontractDbAccessor
+     * @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 Recontract 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): RecontractRecord;
+    /**
+     * Get a single Recontract 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<RecontractRecord>;
+    /**
+     * Get multiple Recontract 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<RecontractRecord[]>;
+    /**
+     * Search Recontract records
+     *
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
+     */
+    search(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): Promise<RecontractDbSearchResponse>;
+    /**
+     * Search all Recontract records with automatic pagination
+     *
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
+     */
+    searchAll(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): Promise<RecontractRecord[]>;
+    /**
+     * 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<RecontractRecord[]>;
+    /**
+     * Create a fluent query builder for Recontract 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<RecontractProperties, RecontractRecord>;
+    /** Access the underlying DbProvider */
+    get provider(): DbProvider;
+}