@d19n/youfibre-odin-sdk 2.0.31 → 2.0.33

package/dist/records-v2/AccountCreditRecord.js

@@ -14,6 +14,8 @@
  * await record.createAccountCredit({ ... }).execute();
  * ```
  *
+ * Entity Types: DEFAULT
+ *
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
@@ -29,6 +31,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isAccountCreditRecord = exports.AccountCreditRecord = 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 CreditNoteRecord_1 = require("./CreditNoteRecord");
+const ContactRecord_1 = require("./ContactRecord");
+const InvoiceRecord_1 = require("./InvoiceRecord");
 /**
  * Builder for action execution with dryRun support
  *
@@ -140,6 +146,115 @@ class AccountCreditRecord {
     /** 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 DEFAULT
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to DEFAULT-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isDefault()) {
+     *   // TypeScript knows record.properties is AccountCreditProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks This is the default record type
+     */
+    isDefault() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'DEFAULT'; }
+    /**
+     * Access linked CreditNote records
+     * @remarks Available labels: AccountCredit__CreditNote
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked CreditNote records
+     * const items = await record.creditNotes.list();
+     * const first = await record.creditNotes.first();
+     *
+     * // Filter by label
+     * const specific = await record.creditNotes.first({ label: 'AccountCredit__CreditNote' });
+     * ```
+     */
+    get creditNotes() {
+        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._creditNotes) {
+            this._creditNotes = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'BillingModule:AccountCredit',
+                targetEntity: 'BillingModule:CreditNote',
+                targetModuleName: 'BillingModule',
+                targetEntityName: 'CreditNote',
+                labels: ['AccountCredit__CreditNote'],
+            }, CreditNoteRecord_1.CreditNoteRecord);
+        }
+        return this._creditNotes;
+    }
+    /**
+     * Access linked Contact records
+     * @remarks Available labels: Contact__AccountCredit
+     * @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: 'Contact__AccountCredit' });
+     * ```
+     */
+    get contacts() {
+        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._contacts) {
+            this._contacts = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'BillingModule:AccountCredit',
+                targetEntity: 'CrmModule:Contact',
+                targetModuleName: 'CrmModule',
+                targetEntityName: 'Contact',
+                labels: ['Contact__AccountCredit'],
+            }, ContactRecord_1.ContactRecord);
+        }
+        return this._contacts;
+    }
+    /**
+     * Access linked Invoice records
+     * @remarks Available labels: AccountCredit__Invoice
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Invoice records
+     * const items = await record.invoices.list();
+     * const first = await record.invoices.first();
+     *
+     * // Filter by label
+     * const specific = await record.invoices.first({ label: 'AccountCredit__Invoice' });
+     * ```
+     */
+    get invoices() {
+        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._invoices) {
+            this._invoices = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'BillingModule:AccountCredit',
+                targetEntity: 'BillingModule:Invoice',
+                targetModuleName: 'BillingModule',
+                targetEntityName: 'Invoice',
+                labels: ['AccountCredit__Invoice'],
+            }, InvoiceRecord_1.InvoiceRecord);
+        }
+        return this._invoices;
+    }
+    // ============================================
     // LINK MANAGEMENT
     // ============================================
     /**
@@ -247,6 +362,15 @@ class AccountCreditRecord {
     }
 }
 exports.AccountCreditRecord = AccountCreditRecord;
+// ============================================
+// TYPED LINK ACCESSORS
+// ============================================
+/** Valid labels for CreditNote associations */
+AccountCreditRecord.creditNotesLabels = ['AccountCredit__CreditNote'];
+/** Valid labels for Contact associations */
+AccountCreditRecord.contactsLabels = ['Contact__AccountCredit'];
+/** Valid labels for Invoice associations */
+AccountCreditRecord.invoicesLabels = ['AccountCredit__Invoice'];
 /** Type guard to check if an object is a AccountCreditRecord */
 function isAccountCreditRecord(obj) {
     return obj instanceof AccountCreditRecord;

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

@@ -13,13 +13,16 @@
  * await record.createAccount({ ... }).execute();
  * ```
  *
+ * Entity Types: BUSINESS, MULTIPLE, PRIMARY, RESELLER, SERVICE
+ *
  * 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 { AccountProperties } from '../entities-v2/Account';
+import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
+import { AccountProperties, BusinessAccountProperties, MultipleAccountProperties, PrimaryAccountProperties, ResellerAccountProperties, ServiceAccountProperties } from '../entities-v2/Account';
 import { ChangeBillingModeProperties } from '../actions-v2/ChangeBillingModeDto';
 import { CreateAccountFromBrskProperties } from '../actions-v2/CreateAccountFromBrskDto';
 import { CreateBusinessAccountProperties } from '../actions-v2/CreateBusinessAccountDto';
@@ -28,6 +31,18 @@ import { CreateResellerAccountProperties } from '../actions-v2/CreateResellerAcc
 import { UpdateBusinessAccountProperties } from '../actions-v2/UpdateBusinessAccountDto';
 import { UpdatePrimaryAccountProperties } from '../actions-v2/UpdatePrimaryAccountDto';
 import { UpdateResellerAccountProperties } from '../actions-v2/UpdateResellerAccountDto';
+import { WorkOrderRecord } from './WorkOrderRecord';
+import { NoteRecord } from './NoteRecord';
+import { OneTouchSwitchRecord } from './OneTouchSwitchRecord';
+import { OrderRecord } from './OrderRecord';
+import { InvoiceRecord } from './InvoiceRecord';
+import { AddressRecord } from './AddressRecord';
+import { CaseRecord } from './CaseRecord';
+import { PaymentRecord } from './PaymentRecord';
+import { ContactRecord } from './ContactRecord';
+import { FileRecord } from './FileRecord';
+/** Valid entity types for Account */
+export declare type AccountType = 'BUSINESS' | 'MULTIPLE' | 'PRIMARY' | 'RESELLER' | 'SERVICE';
 /**
  * Builder for action execution with dryRun support
  *
@@ -91,6 +106,17 @@ export declare class AccountRecord<TProps = AccountProperties> {
     private _provider;
     private _pendingLinks;
     private _preGeneratedId;
+    private _workOrders?;
+    private _notes?;
+    private _oneTouchSwitches?;
+    private _orders?;
+    private _invoices?;
+    private _accounts?;
+    private _addresses?;
+    private _cases?;
+    private _payments?;
+    private _contacts?;
+    private _files?;
     /**
      * Create a record wrapper.
      * @param record - The underlying record, or null for create operations
@@ -103,7 +129,7 @@ export declare class AccountRecord<TProps = AccountProperties> {
     /** Record ID - always available (pre-generated for new records) */
     get id(): string;
     get entity(): string;
-    get type(): string | undefined;
+    get type(): AccountType | undefined;
     /** Record properties - empty object for new (unsaved) records */
     get properties(): TProps;
     get title(): string | undefined;
@@ -116,6 +142,284 @@ export declare class AccountRecord<TProps = AccountProperties> {
     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 BUSINESS
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to BUSINESS-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isBusiness()) {
+     *   // TypeScript knows record.properties is BusinessAccountProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Business accounts
+     */
+    isBusiness(): this is AccountRecord<BusinessAccountProperties>;
+    /**
+     * Type guard: check if this record is of type MULTIPLE
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to MULTIPLE-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isMultiple()) {
+     *   // TypeScript knows record.properties is MultipleAccountProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Multiple accounts are for customers who want to purchase multiple services at many addresses
+     */
+    isMultiple(): this is AccountRecord<MultipleAccountProperties>;
+    /**
+     * Type guard: check if this record is of type PRIMARY
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to PRIMARY-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isPrimary()) {
+     *   // TypeScript knows record.properties is PrimaryAccountProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Primary account
+     */
+    isPrimary(): this is AccountRecord<PrimaryAccountProperties>;
+    /**
+     * Type guard: check if this record is of type RESELLER
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to RESELLER-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isReseller()) {
+     *   // TypeScript knows record.properties is ResellerAccountProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Reseller
+     */
+    isReseller(): this is AccountRecord<ResellerAccountProperties>;
+    /**
+     * Type guard: check if this record is of type SERVICE
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to SERVICE-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isService()) {
+     *   // TypeScript knows record.properties is ServiceAccountProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks This is the account where service is being delivered
+     */
+    isService(): this is AccountRecord<ServiceAccountProperties>;
+    /** Valid labels for WorkOrder associations */
+    static readonly workOrdersLabels: readonly ["Account__WorkOrder"];
+    /**
+     * Access linked WorkOrder records
+     * @remarks Available labels: Account__WorkOrder
+     * @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: 'Account__WorkOrder' });
+     * ```
+     */
+    get workOrders(): RecordLinkManager<WorkOrderRecord, typeof AccountRecord['workOrdersLabels'][number]>;
+    /** Valid labels for Note associations */
+    static readonly notesLabels: readonly ["Account__Note"];
+    /**
+     * Access linked Note records
+     * @remarks Available labels: Account__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: 'Account__Note' });
+     * ```
+     */
+    get notes(): RecordLinkManager<NoteRecord, typeof AccountRecord['notesLabels'][number]>;
+    /** Valid labels for OneTouchSwitch associations */
+    static readonly oneTouchSwitchesLabels: readonly ["Account__OneTouchSwitch"];
+    /**
+     * Access linked OneTouchSwitch records
+     * @remarks Available labels: Account__OneTouchSwitch
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked OneTouchSwitch records
+     * const items = await record.oneTouchSwitches.list();
+     * const first = await record.oneTouchSwitches.first();
+     *
+     * // Filter by label
+     * const specific = await record.oneTouchSwitches.first({ label: 'Account__OneTouchSwitch' });
+     * ```
+     */
+    get oneTouchSwitches(): RecordLinkManager<OneTouchSwitchRecord, typeof AccountRecord['oneTouchSwitchesLabels'][number]>;
+    /** Valid labels for Order associations */
+    static readonly ordersLabels: readonly ["Account__Order"];
+    /**
+     * Access linked Order records
+     * @remarks Available labels: Account__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: 'Account__Order' });
+     * ```
+     */
+    get orders(): RecordLinkManager<OrderRecord, typeof AccountRecord['ordersLabels'][number]>;
+    /** Valid labels for Invoice associations */
+    static readonly invoicesLabels: readonly ["Account__Invoice"];
+    /**
+     * Access linked Invoice records
+     * @remarks Available labels: Account__Invoice
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Invoice records
+     * const items = await record.invoices.list();
+     * const first = await record.invoices.first();
+     *
+     * // Filter by label
+     * const specific = await record.invoices.first({ label: 'Account__Invoice' });
+     * ```
+     */
+    get invoices(): RecordLinkManager<InvoiceRecord, typeof AccountRecord['invoicesLabels'][number]>;
+    /** Valid labels for Account associations */
+    static readonly accountsLabels: readonly ["Account_Account"];
+    /**
+     * Access linked Account records
+     * @remarks Available labels: Account_Account
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Account records
+     * const items = await record.accounts.list();
+     * const first = await record.accounts.first();
+     *
+     * // Filter by label
+     * const specific = await record.accounts.first({ label: 'Account_Account' });
+     * ```
+     */
+    get accounts(): RecordLinkManager<AccountRecord, typeof AccountRecord['accountsLabels'][number]>;
+    /** Valid labels for Address associations */
+    static readonly addressesLabels: readonly ["BillingAddress"];
+    /**
+     * Access linked Address records
+     * @remarks Available labels: BillingAddress
+     * @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: 'BillingAddress' });
+     * ```
+     */
+    get addresses(): RecordLinkManager<AddressRecord, typeof AccountRecord['addressesLabels'][number]>;
+    /** Valid labels for Case associations */
+    static readonly casesLabels: readonly ["Account__Case"];
+    /**
+     * Access linked Case records
+     * @remarks Available labels: Account__Case
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Case records
+     * const items = await record.cases.list();
+     * const first = await record.cases.first();
+     *
+     * // Filter by label
+     * const specific = await record.cases.first({ label: 'Account__Case' });
+     * ```
+     */
+    get cases(): RecordLinkManager<CaseRecord, typeof AccountRecord['casesLabels'][number]>;
+    /** Valid labels for Payment associations */
+    static readonly paymentsLabels: readonly ["Account_Payment"];
+    /**
+     * Access linked Payment records
+     * @remarks Available labels: Account_Payment
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Payment records
+     * const items = await record.payments.list();
+     * const first = await record.payments.first();
+     *
+     * // Filter by label
+     * const specific = await record.payments.first({ label: 'Account_Payment' });
+     * ```
+     */
+    get payments(): RecordLinkManager<PaymentRecord, typeof AccountRecord['paymentsLabels'][number]>;
+    /** Valid labels for Contact associations */
+    static readonly contactsLabels: readonly ["BillingContact"];
+    /**
+     * Access linked Contact records
+     * @remarks Available labels: BillingContact
+     * @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: 'BillingContact' });
+     * ```
+     */
+    get contacts(): RecordLinkManager<ContactRecord, typeof AccountRecord['contactsLabels'][number]>;
+    /** Valid labels for File associations */
+    static readonly filesLabels: readonly ["Account__File"];
+    /**
+     * Access linked File records
+     * @remarks Available labels: Account__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: 'Account__File' });
+     * ```
+     */
+    get files(): RecordLinkManager<FileRecord, typeof AccountRecord['filesLabels'][number]>;
     /**
      * Queue a link to be created with the next action.
      * Works for both create and update actions.