@d19n/youfibre-odin-sdk 2.0.13-beta.1 → 2.0.13

package/dist/records-v2/KnowledgeArticleRecord.d.ts

@@ -13,15 +13,22 @@
  * await record.createKnowledgeArticle({ ... }).execute();
  * ```
  *
+ * Entity Types: RELEASE_NOTE, USER_GUIDE
+ *
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
  */
 import { OdinRecord, OdinRecordLinkDto } from '@d19n/odin-types/dist/core';
 import { PipelineStageEntity } from '@d19n/odin-types/dist/core';
 import { IDbRecordCreateUpdateRes } from '@d19n/odin-types/dist/core/interfaces/v1.db.interfaces';
 import { IOdinProvider } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
-import { KnowledgeArticleProperties } from '../entities-v2/KnowledgeArticle';
+import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
+import { KnowledgeArticleProperties, ReleaseNoteKnowledgeArticleProperties, UserGuideKnowledgeArticleProperties } from '../entities-v2/KnowledgeArticle';
 import { KnowledgeArticleReleaseNoteCreateProperties } from '../actions-v2/KnowledgeArticleReleaseNoteCreateDto';
 import { KnowledgeArticleUserGuideCreateProperties } from '../actions-v2/KnowledgeArticleUserGuideCreateDto';
+import { NoteRecord } from './NoteRecord';
+import { FileRecord } from './FileRecord';
+/** Valid entity types for KnowledgeArticle */
+export declare type KnowledgeArticleType = 'RELEASE_NOTE' | 'USER_GUIDE';
 /**
  * Builder for action execution with dryRun support
  *
@@ -85,6 +92,9 @@ export declare class KnowledgeArticleRecord<TProps = KnowledgeArticleProperties>
     private _provider;
     private _pendingLinks;
     private _preGeneratedId;
+    private _notes?;
+    private _files?;
+    private _knowledgeArticles?;
     /**
      * Create a record wrapper.
      * @param record - The underlying record, or null for create operations
@@ -97,7 +107,7 @@ export declare class KnowledgeArticleRecord<TProps = KnowledgeArticleProperties>
     /** Record ID - always available (pre-generated for new records) */
     get id(): string;
     get entity(): string;
-    get type(): string | undefined;
+    get type(): KnowledgeArticleType | undefined;
     /** Record properties - empty object for new (unsaved) records */
     get properties(): TProps;
     get title(): string | undefined;
@@ -110,6 +120,92 @@ export declare class KnowledgeArticleRecord<TProps = KnowledgeArticleProperties>
     get groups(): string[];
     /** Access the underlying OdinRecord (null for new records) */
     get record(): OdinRecord<TProps> | null;
+    /**
+     * Type guard: check if this record is of type RELEASE_NOTE
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to RELEASE_NOTE-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isReleaseNote()) {
+     *   // TypeScript knows record.properties is ReleaseNoteKnowledgeArticleProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Odin Release Note
+     */
+    isReleaseNote(): this is KnowledgeArticleRecord<ReleaseNoteKnowledgeArticleProperties>;
+    /**
+     * Type guard: check if this record is of type USER_GUIDE
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to USER_GUIDE-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isUserGuide()) {
+     *   // TypeScript knows record.properties is UserGuideKnowledgeArticleProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Odin User Guide
+     */
+    isUserGuide(): this is KnowledgeArticleRecord<UserGuideKnowledgeArticleProperties>;
+    /** Valid labels for Note associations */
+    static readonly notesLabels: readonly ["KnowledgeArticle__Note"];
+    /**
+     * Access linked Note records
+     * @remarks Available labels: KnowledgeArticle__Note
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Note records
+     * const items = await record.notes.list();
+     * const first = await record.notes.first();
+     *
+     * // Filter by label
+     * const specific = await record.notes.first({ label: 'KnowledgeArticle__Note' });
+     * ```
+     */
+    get notes(): RecordLinkManager<NoteRecord, typeof KnowledgeArticleRecord['notesLabels'][number]>;
+    /** Valid labels for File associations */
+    static readonly filesLabels: readonly ["KnowledgeArticle__File"];
+    /**
+     * Access linked File records
+     * @remarks Available labels: KnowledgeArticle__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked File records
+     * const items = await record.files.list();
+     * const first = await record.files.first();
+     *
+     * // Filter by label
+     * const specific = await record.files.first({ label: 'KnowledgeArticle__File' });
+     * ```
+     */
+    get files(): RecordLinkManager<FileRecord, typeof KnowledgeArticleRecord['filesLabels'][number]>;
+    /** Valid labels for KnowledgeArticle associations */
+    static readonly knowledgeArticlesLabels: readonly ["KnowledgeArticle__KnowledgeArticle"];
+    /**
+     * Access linked KnowledgeArticle records
+     * @remarks Available labels: KnowledgeArticle__KnowledgeArticle
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked KnowledgeArticle records
+     * const items = await record.knowledgeArticles.list();
+     * const first = await record.knowledgeArticles.first();
+     *
+     * // Filter by label
+     * const specific = await record.knowledgeArticles.first({ label: 'KnowledgeArticle__KnowledgeArticle' });
+     * ```
+     */
+    get knowledgeArticles(): RecordLinkManager<KnowledgeArticleRecord, typeof KnowledgeArticleRecord['knowledgeArticlesLabels'][number]>;
     /**
      * Queue a link to be created with the next action.
      * Works for both create and update actions.

package/dist/records-v2/KnowledgeArticleRecord.js

@@ -14,6 +14,8 @@
  * await record.createKnowledgeArticle({ ... }).execute();
  * ```
  *
+ * Entity Types: RELEASE_NOTE, USER_GUIDE
+ *
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
@@ -29,6 +31,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isKnowledgeArticleRecord = exports.KnowledgeArticleRecord = void 0;
 const uuid_1 = require("uuid");
 const core_1 = require("@d19n/odin-types/dist/core");
+const record_link_manager_1 = require("@d19n/odin-sdk-generator/dist/record-link-manager");
+const NoteRecord_1 = require("./NoteRecord");
+const FileRecord_1 = require("./FileRecord");
 /**
  * Builder for action execution with dryRun support
  *
@@ -140,6 +145,131 @@ class KnowledgeArticleRecord {
     /** Access the underlying OdinRecord (null for new records) */
     get record() { return this._record; }
     // ============================================
+    // TYPE GUARDS (with TypeScript type predicates)
+    // ============================================
+    /**
+     * Type guard: check if this record is of type RELEASE_NOTE
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to RELEASE_NOTE-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isReleaseNote()) {
+     *   // TypeScript knows record.properties is ReleaseNoteKnowledgeArticleProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Odin Release Note
+     */
+    isReleaseNote() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'RELEASE_NOTE'; }
+    /**
+     * Type guard: check if this record is of type USER_GUIDE
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to USER_GUIDE-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isUserGuide()) {
+     *   // TypeScript knows record.properties is UserGuideKnowledgeArticleProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Odin User Guide
+     */
+    isUserGuide() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'USER_GUIDE'; }
+    /**
+     * Access linked Note records
+     * @remarks Available labels: KnowledgeArticle__Note
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Note records
+     * const items = await record.notes.list();
+     * const first = await record.notes.first();
+     *
+     * // Filter by label
+     * const specific = await record.notes.first({ label: 'KnowledgeArticle__Note' });
+     * ```
+     */
+    get notes() {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('Cannot access links on a new (unsaved) record');
+        if (!this._notes) {
+            this._notes = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'SupportModule:KnowledgeArticle',
+                targetEntity: 'SupportModule:Note',
+                targetModuleName: 'SupportModule',
+                targetEntityName: 'Note',
+                labels: ['KnowledgeArticle__Note'],
+            }, NoteRecord_1.NoteRecord);
+        }
+        return this._notes;
+    }
+    /**
+     * Access linked File records
+     * @remarks Available labels: KnowledgeArticle__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked File records
+     * const items = await record.files.list();
+     * const first = await record.files.first();
+     *
+     * // Filter by label
+     * const specific = await record.files.first({ label: 'KnowledgeArticle__File' });
+     * ```
+     */
+    get files() {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('Cannot access links on a new (unsaved) record');
+        if (!this._files) {
+            this._files = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'SupportModule:KnowledgeArticle',
+                targetEntity: 'SchemaModule:File',
+                targetModuleName: 'SchemaModule',
+                targetEntityName: 'File',
+                labels: ['KnowledgeArticle__File'],
+            }, FileRecord_1.FileRecord);
+        }
+        return this._files;
+    }
+    /**
+     * Access linked KnowledgeArticle records
+     * @remarks Available labels: KnowledgeArticle__KnowledgeArticle
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked KnowledgeArticle records
+     * const items = await record.knowledgeArticles.list();
+     * const first = await record.knowledgeArticles.first();
+     *
+     * // Filter by label
+     * const specific = await record.knowledgeArticles.first({ label: 'KnowledgeArticle__KnowledgeArticle' });
+     * ```
+     */
+    get knowledgeArticles() {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('Cannot access links on a new (unsaved) record');
+        if (!this._knowledgeArticles) {
+            this._knowledgeArticles = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'SupportModule:KnowledgeArticle',
+                targetEntity: 'SupportModule:KnowledgeArticle',
+                targetModuleName: 'SupportModule',
+                targetEntityName: 'KnowledgeArticle',
+                labels: ['KnowledgeArticle__KnowledgeArticle'],
+            }, KnowledgeArticleRecord);
+        }
+        return this._knowledgeArticles;
+    }
+    // ============================================
     // LINK MANAGEMENT
     // ============================================
     /**
@@ -251,6 +381,15 @@ class KnowledgeArticleRecord {
     }
 }
 exports.KnowledgeArticleRecord = KnowledgeArticleRecord;
+// ============================================
+// TYPED LINK ACCESSORS
+// ============================================
+/** Valid labels for Note associations */
+KnowledgeArticleRecord.notesLabels = ['KnowledgeArticle__Note'];
+/** Valid labels for File associations */
+KnowledgeArticleRecord.filesLabels = ['KnowledgeArticle__File'];
+/** Valid labels for KnowledgeArticle associations */
+KnowledgeArticleRecord.knowledgeArticlesLabels = ['KnowledgeArticle__KnowledgeArticle'];
 /** Type guard to check if an object is a KnowledgeArticleRecord */
 function isKnowledgeArticleRecord(obj) {
     return obj instanceof KnowledgeArticleRecord;

package/dist/records-v2/LeadRecord.d.ts

@@ -19,10 +19,24 @@ import { OdinRecord, OdinRecordLinkDto } from '@d19n/odin-types/dist/core';
 import { PipelineStageEntity } from '@d19n/odin-types/dist/core';
 import { IDbRecordCreateUpdateRes } from '@d19n/odin-types/dist/core/interfaces/v1.db.interfaces';
 import { IOdinProvider } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
+import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
 import { LeadProperties } from '../entities-v2/Lead';
 import { CreateLeadProperties } from '../actions-v2/CreateLeadDto';
 import { CreateLeadFromBrskProperties } from '../actions-v2/CreateLeadFromBrskDto';
 import { UpdateLeadProperties } from '../actions-v2/UpdateLeadDto';
+import { NoteRecord } from './NoteRecord';
+import { CallRecord } from './CallRecord';
+import { OfferRecord } from './OfferRecord';
+import { DiscountRecord } from './DiscountRecord';
+import { ProductRecord } from './ProductRecord';
+import { ContactRecord } from './ContactRecord';
+import { OrderRecord } from './OrderRecord';
+import { FileRecord } from './FileRecord';
+import { WorkOrderRecord } from './WorkOrderRecord';
+import { CrmDatasetRecord } from './CrmDatasetRecord';
+import { VisitRecord } from './VisitRecord';
+import { AddressRecord } from './AddressRecord';
+import { AppointmentRecord } from './AppointmentRecord';
 /**
  * Builder for action execution with dryRun support
  *
@@ -86,6 +100,19 @@ export declare class LeadRecord<TProps = LeadProperties> {
     private _provider;
     private _pendingLinks;
     private _preGeneratedId;
+    private _notes?;
+    private _calls?;
+    private _offers?;
+    private _discounts?;
+    private _products?;
+    private _contacts?;
+    private _orders?;
+    private _files?;
+    private _workOrders?;
+    private _crmDatasets?;
+    private _visits?;
+    private _addresses?;
+    private _appointments?;
     /**
      * Create a record wrapper.
      * @param record - The underlying record, or null for create operations
@@ -111,6 +138,240 @@ export declare class LeadRecord<TProps = LeadProperties> {
     get groups(): string[];
     /** Access the underlying OdinRecord (null for new records) */
     get record(): OdinRecord<TProps> | null;
+    /** Valid labels for Note associations */
+    static readonly notesLabels: readonly ["Lead__Note"];
+    /**
+     * Access linked Note records
+     * @remarks Available labels: Lead__Note
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Note records
+     * const items = await record.notes.list();
+     * const first = await record.notes.first();
+     *
+     * // Filter by label
+     * const specific = await record.notes.first({ label: 'Lead__Note' });
+     * ```
+     */
+    get notes(): RecordLinkManager<NoteRecord, typeof LeadRecord['notesLabels'][number]>;
+    /** Valid labels for Call associations */
+    static readonly callsLabels: readonly ["Call__Lead"];
+    /**
+     * Access linked Call records
+     * @remarks Available labels: Call__Lead
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Call records
+     * const items = await record.calls.list();
+     * const first = await record.calls.first();
+     *
+     * // Filter by label
+     * const specific = await record.calls.first({ label: 'Call__Lead' });
+     * ```
+     */
+    get calls(): RecordLinkManager<CallRecord, typeof LeadRecord['callsLabels'][number]>;
+    /** Valid labels for Offer associations */
+    static readonly offersLabels: readonly ["Lead__Offer"];
+    /**
+     * Access linked Offer records
+     * @remarks Available labels: Lead__Offer
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Offer records
+     * const items = await record.offers.list();
+     * const first = await record.offers.first();
+     *
+     * // Filter by label
+     * const specific = await record.offers.first({ label: 'Lead__Offer' });
+     * ```
+     */
+    get offers(): RecordLinkManager<OfferRecord, typeof LeadRecord['offersLabels'][number]>;
+    /** Valid labels for Discount associations */
+    static readonly discountsLabels: readonly ["Lead__Discount"];
+    /**
+     * Access linked Discount records
+     * @remarks Available labels: Lead__Discount
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Discount records
+     * const items = await record.discounts.list();
+     * const first = await record.discounts.first();
+     *
+     * // Filter by label
+     * const specific = await record.discounts.first({ label: 'Lead__Discount' });
+     * ```
+     */
+    get discounts(): RecordLinkManager<DiscountRecord, typeof LeadRecord['discountsLabels'][number]>;
+    /** Valid labels for Product associations */
+    static readonly productsLabels: readonly ["Lead__Product"];
+    /**
+     * Access linked Product records
+     * @remarks Available labels: Lead__Product
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Product records
+     * const items = await record.products.list();
+     * const first = await record.products.first();
+     *
+     * // Filter by label
+     * const specific = await record.products.first({ label: 'Lead__Product' });
+     * ```
+     */
+    get products(): RecordLinkManager<ProductRecord, typeof LeadRecord['productsLabels'][number]>;
+    /** Valid labels for Contact associations */
+    static readonly contactsLabels: readonly ["Lead__Contact"];
+    /**
+     * Access linked Contact records
+     * @remarks Available labels: Lead__Contact
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Contact records
+     * const items = await record.contacts.list();
+     * const first = await record.contacts.first();
+     *
+     * // Filter by label
+     * const specific = await record.contacts.first({ label: 'Lead__Contact' });
+     * ```
+     */
+    get contacts(): RecordLinkManager<ContactRecord, typeof LeadRecord['contactsLabels'][number]>;
+    /** Valid labels for Order associations */
+    static readonly ordersLabels: readonly ["Lead_Order"];
+    /**
+     * Access linked Order records
+     * @remarks Available labels: Lead_Order
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Order records
+     * const items = await record.orders.list();
+     * const first = await record.orders.first();
+     *
+     * // Filter by label
+     * const specific = await record.orders.first({ label: 'Lead_Order' });
+     * ```
+     */
+    get orders(): RecordLinkManager<OrderRecord, typeof LeadRecord['ordersLabels'][number]>;
+    /** Valid labels for File associations */
+    static readonly filesLabels: readonly ["Lead__File"];
+    /**
+     * Access linked File records
+     * @remarks Available labels: Lead__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked File records
+     * const items = await record.files.list();
+     * const first = await record.files.first();
+     *
+     * // Filter by label
+     * const specific = await record.files.first({ label: 'Lead__File' });
+     * ```
+     */
+    get files(): RecordLinkManager<FileRecord, typeof LeadRecord['filesLabels'][number]>;
+    /** Valid labels for WorkOrder associations */
+    static readonly workOrdersLabels: readonly ["WorkOrder__Lead"];
+    /**
+     * Access linked WorkOrder records
+     * @remarks Available labels: WorkOrder__Lead
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked WorkOrder records
+     * const items = await record.workOrders.list();
+     * const first = await record.workOrders.first();
+     *
+     * // Filter by label
+     * const specific = await record.workOrders.first({ label: 'WorkOrder__Lead' });
+     * ```
+     */
+    get workOrders(): RecordLinkManager<WorkOrderRecord, typeof LeadRecord['workOrdersLabels'][number]>;
+    /** Valid labels for CrmDataset associations */
+    static readonly crmDatasetsLabels: readonly ["CrmDataset__Lead"];
+    /**
+     * Access linked CrmDataset records
+     * @remarks Available labels: CrmDataset__Lead
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked CrmDataset records
+     * const items = await record.crmDatasets.list();
+     * const first = await record.crmDatasets.first();
+     *
+     * // Filter by label
+     * const specific = await record.crmDatasets.first({ label: 'CrmDataset__Lead' });
+     * ```
+     */
+    get crmDatasets(): RecordLinkManager<CrmDatasetRecord, typeof LeadRecord['crmDatasetsLabels'][number]>;
+    /** Valid labels for Visit associations */
+    static readonly visitsLabels: readonly ["Lead__Visit"];
+    /**
+     * Access linked Visit records
+     * @remarks Available labels: Lead__Visit
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Visit records
+     * const items = await record.visits.list();
+     * const first = await record.visits.first();
+     *
+     * // Filter by label
+     * const specific = await record.visits.first({ label: 'Lead__Visit' });
+     * ```
+     */
+    get visits(): RecordLinkManager<VisitRecord, typeof LeadRecord['visitsLabels'][number]>;
+    /** Valid labels for Address associations */
+    static readonly addressesLabels: readonly ["Lead_Address"];
+    /**
+     * Access linked Address records
+     * @remarks Available labels: Lead_Address
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Address records
+     * const items = await record.addresses.list();
+     * const first = await record.addresses.first();
+     *
+     * // Filter by label
+     * const specific = await record.addresses.first({ label: 'Lead_Address' });
+     * ```
+     */
+    get addresses(): RecordLinkManager<AddressRecord, typeof LeadRecord['addressesLabels'][number]>;
+    /** Valid labels for Appointment associations */
+    static readonly appointmentsLabels: readonly ["Lead_Appointment"];
+    /**
+     * Access linked Appointment records
+     * @remarks Available labels: Lead_Appointment
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Appointment records
+     * const items = await record.appointments.list();
+     * const first = await record.appointments.first();
+     *
+     * // Filter by label
+     * const specific = await record.appointments.first({ label: 'Lead_Appointment' });
+     * ```
+     */
+    get appointments(): RecordLinkManager<AppointmentRecord, typeof LeadRecord['appointmentsLabels'][number]>;
     /**
      * Queue a link to be created with the next action.
      * Works for both create and update actions.