@d19n/youfibre-odin-sdk 2.0.236 → 2.0.237-beta.0

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

@@ -0,0 +1,1109 @@
+/**
+ * File Record Wrapper
+ *
+ * Provides typed action methods and link management.
+ * Works with both ApiProvider and DbProvider.
+ *
+ * All action methods return an ActionBuilder or FlowBuilder.
+ * Call .execute() to run or .dryRun() to get the payload for debugging.
+ *
+ * Can be instantiated with null record for create operations:
+ * ```typescript
+ * const record = odinClient.files.new();
+ * await record.createFile({ ... }).execute();
+ * ```
+ *
+ * Entity Types: AFP_INVOICE, CBO_FINAL_BILL, CSV, DEFAULT, EMAIL, INVOICE, NA_PROBLEM_EVIDENCE, NA_SOLUTION_EVIDENCE, OPENREACH_A55, OTDR
+ *
+ * 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 { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
+import { FileProperties, AfpInvoiceFileProperties, CboFinalBillFileProperties, CsvFileProperties, EmailFileProperties, InvoiceFileProperties, NaProblemEvidenceFileProperties, NaSolutionEvidenceFileProperties, OpenreachA55FileProperties, OtdrFileProperties } from '../entities-v2/File';
+import { CreateFileProperties } from '../actions-v2/CreateFileDto';
+import { OverlayRealA55Record } from './OverlayRealA55Record';
+import { AppointmentRecord } from './AppointmentRecord';
+import { UgExternalAuditRecord } from './UgExternalAuditRecord';
+import { BillingRequestRecord } from './BillingRequestRecord';
+import { TransactionRecord } from './TransactionRecord';
+import { CreditNoteRecord } from './CreditNoteRecord';
+import { AddressRecord } from './AddressRecord';
+import { ChangeReasonRecord } from './ChangeReasonRecord';
+import { DiscountRecord } from './DiscountRecord';
+import { PaymentMethodRefundRecord } from './PaymentMethodRefundRecord';
+import { ServiceAppointmentRecord } from './ServiceAppointmentRecord';
+import { CustomerDeviceRouterRecord } from './CustomerDeviceRouterRecord';
+import { VisitRecord } from './VisitRecord';
+import { WayleaveAuditRecord } from './WayleaveAuditRecord';
+import { WorkOrderRecord } from './WorkOrderRecord';
+import { OrderItemRecord } from './OrderItemRecord';
+import { KnowledgeArticleRecord } from './KnowledgeArticleRecord';
+import { CaseRecord } from './CaseRecord';
+import { ActivityRecord } from './ActivityRecord';
+import { OneTouchSwitchRecord } from './OneTouchSwitchRecord';
+import { RemediationRequiredReasonRecord } from './RemediationRequiredReasonRecord';
+import { InvoiceRecord } from './InvoiceRecord';
+import { NoteRecord } from './NoteRecord';
+import { LeadRecord } from './LeadRecord';
+import { AccountRecord } from './AccountRecord';
+import { PaymentMethodRecord } from './PaymentMethodRecord';
+import { ContractBuyOutRecord } from './ContractBuyOutRecord';
+import { SiteSpecificRiskAssessmentOutcomeFormRecord } from './SiteSpecificRiskAssessmentOutcomeFormRecord';
+import { RemediationOutcomeFormRecord } from './RemediationOutcomeFormRecord';
+import { OrderRecord } from './OrderRecord';
+import { CallRecord } from './CallRecord';
+import { OhExternalAuditRecord } from './OhExternalAuditRecord';
+import { CustomerDeviceOntRecord } from './CustomerDeviceOntRecord';
+import { YfFieldServiceVisitRecord } from './YfFieldServiceVisitRecord';
+import { BillingAdjustmentRecord } from './BillingAdjustmentRecord';
+import { ContactRecord } from './ContactRecord';
+import { MessageRecord } from './MessageRecord';
+import { EmailRecord } from './EmailRecord';
+import { PgDirectDebitFileRecord } from './PgDirectDebitFileRecord';
+/** Valid entity types for File */
+export declare type FileType = 'AFP_INVOICE' | 'CBO_FINAL_BILL' | 'CSV' | 'DEFAULT' | 'EMAIL' | 'INVOICE' | 'NA_PROBLEM_EVIDENCE' | 'NA_SOLUTION_EVIDENCE' | 'OPENREACH_A55' | 'OTDR';
+/**
+ * Builder for action execution with dryRun support
+ *
+ * Provides a consistent API across all action types:
+ * - `.execute()` - Execute the action and return results
+ * - `.dryRun()` - Return the payload without executing (for debugging)
+ */
+declare class ActionBuilder<T = IDbRecordCreateUpdateRes[]> {
+    private _provider;
+    private _moduleName;
+    private _entityName;
+    private _payload;
+    private _clearPendingLinks;
+    constructor(provider: IOdinProvider, moduleName: string, entityName: string, payload: Record<string, any>, clearPendingLinks: () => void);
+    /**
+     * Set an external system identifier for this record.
+     * Links the record to a corresponding entry in an external application.
+     *
+     * @param externalId - The ID in the external system
+     * @param externalAppId - The external application identifier
+     * @returns this (for chaining)
+     *
+     * @example
+     * ```typescript
+     * await record.createOrder({ ... }).withExternalId('SF-123', 'salesforce').execute();
+     * ```
+     */
+    withExternalId(externalId: string, externalAppId: string): this;
+    /**
+     * Set security/access groups for this record.
+     * Controls which user groups can access the record.
+     *
+     * @param groups - Array of group names
+     * @returns this (for chaining)
+     *
+     * @example
+     * ```typescript
+     * await record.createOrder({ ... }).withGroups(['TenantA', 'BillingTeam']).execute();
+     * ```
+     */
+    withGroups(groups: string[]): this;
+    /**
+     * Execute the action
+     * @returns The result from the API
+     */
+    execute(): Promise<T>;
+    /**
+     * Returns the request payload without executing (for debugging)
+     * @returns The request payload that would be sent to the API
+     */
+    dryRun(): Record<string, any>;
+    /**
+     * Prevents accidental `await actionBuilder` without .execute()
+     * Forces developers to explicitly call .execute()
+     * @throws Error always - use .execute() or .dryRun() instead
+     */
+    then(): never;
+}
+export declare class FileRecord<TProps = FileProperties> {
+    private _record;
+    private _provider;
+    private _pendingLinks;
+    private _preGeneratedId;
+    private _overlayRealA55s?;
+    private _appointments?;
+    private _ugExternalAudits?;
+    private _billingRequests?;
+    private _transactions?;
+    private _creditNotes?;
+    private _addresses?;
+    private _changeReasons?;
+    private _discounts?;
+    private _paymentMethodRefunds?;
+    private _serviceAppointments?;
+    private _customerDeviceRouters?;
+    private _visits?;
+    private _wayleaveAudits?;
+    private _workOrders?;
+    private _orderItems?;
+    private _knowledgeArticles?;
+    private _cases?;
+    private _activities?;
+    private _oneTouchSwitches?;
+    private _remediationRequiredReasons?;
+    private _invoices?;
+    private _notes?;
+    private _leads?;
+    private _accounts?;
+    private _paymentMethods?;
+    private _contractBuyOuts?;
+    private _siteSpecificRiskAssessmentOutcomeForms?;
+    private _remediationOutcomeForms?;
+    private _orders?;
+    private _calls?;
+    private _ohExternalAudits?;
+    private _customerDeviceOnts?;
+    private _yfFieldServiceVisits?;
+    private _billingAdjustments?;
+    private _contacts?;
+    private _messages?;
+    private _emails?;
+    private _pgDirectDebitFiles?;
+    /**
+     * Create a record wrapper.
+     * @param record - The underlying record, or null for create operations
+     * @param provider - The API or DB provider
+     * @param preGeneratedId - Optional pre-generated ID for new records (auto-generated if not provided)
+     */
+    constructor(record: OdinRecord<TProps> | null, provider: IOdinProvider, preGeneratedId?: string);
+    /** Returns true if this is a new (unsaved) record */
+    get isNew(): boolean;
+    /** Record ID - always available (pre-generated for new records) */
+    get id(): string;
+    get entity(): string;
+    get type(): FileType | undefined;
+    /** Record properties - empty object for new (unsaved) records */
+    get properties(): TProps;
+    get title(): string | undefined;
+    get recordNumber(): string | undefined;
+    get stage(): PipelineStageEntity | undefined;
+    get createdAt(): string | undefined;
+    get updatedAt(): string | undefined;
+    get externalId(): string | undefined;
+    get externalAppId(): string | undefined;
+    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 AFP_INVOICE
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to AFP_INVOICE-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isAfpInvoice()) {
+     *   // TypeScript knows record.properties is AfpInvoiceFileProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks application for payment invoice
+     */
+    isAfpInvoice(): this is FileRecord<AfpInvoiceFileProperties>;
+    /**
+     * Type guard: check if this record is of type CBO_FINAL_BILL
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to CBO_FINAL_BILL-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isCboFinalBill()) {
+     *   // TypeScript knows record.properties is CboFinalBillFileProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Used when customer send their final bill
+     */
+    isCboFinalBill(): this is FileRecord<CboFinalBillFileProperties>;
+    /**
+     * Type guard: check if this record is of type CSV
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to CSV-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isCsv()) {
+     *   // TypeScript knows record.properties is CsvFileProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks CSV
+     */
+    isCsv(): this is FileRecord<CsvFileProperties>;
+    /**
+     * 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 FileProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks This is the default record type
+     */
+    isDefault(): this is FileRecord<FileProperties>;
+    /**
+     * Type guard: check if this record is of type EMAIL
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to EMAIL-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isEmail()) {
+     *   // TypeScript knows record.properties is EmailFileProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Email
+     */
+    isEmail(): this is FileRecord<EmailFileProperties>;
+    /**
+     * Type guard: check if this record is of type INVOICE
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to INVOICE-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isInvoice()) {
+     *   // TypeScript knows record.properties is InvoiceFileProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks invoice
+     */
+    isInvoice(): this is FileRecord<InvoiceFileProperties>;
+    /**
+     * Type guard: check if this record is of type NA_PROBLEM_EVIDENCE
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to NA_PROBLEM_EVIDENCE-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isNaProblemEvidence()) {
+     *   // TypeScript knows record.properties is NaProblemEvidenceFileProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Openreach Network Adjustment Problem Evidence
+     */
+    isNaProblemEvidence(): this is FileRecord<NaProblemEvidenceFileProperties>;
+    /**
+     * Type guard: check if this record is of type NA_SOLUTION_EVIDENCE
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to NA_SOLUTION_EVIDENCE-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isNaSolutionEvidence()) {
+     *   // TypeScript knows record.properties is NaSolutionEvidenceFileProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Openreach Network Adjustment Problem Evidence
+     */
+    isNaSolutionEvidence(): this is FileRecord<NaSolutionEvidenceFileProperties>;
+    /**
+     * Type guard: check if this record is of type OPENREACH_A55
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to OPENREACH_A55-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isOpenreachA55()) {
+     *   // TypeScript knows record.properties is OpenreachA55FileProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Openreach A55
+     */
+    isOpenreachA55(): this is FileRecord<OpenreachA55FileProperties>;
+    /**
+     * Type guard: check if this record is of type OTDR
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to OTDR-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isOtdr()) {
+     *   // TypeScript knows record.properties is OtdrFileProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks OTDR evidence for L1 and L2 closures
+     */
+    isOtdr(): this is FileRecord<OtdrFileProperties>;
+    /** Valid labels for OverlayRealA55 associations */
+    static readonly overlayRealA55sLabels: readonly ["OverlayRealA55_File"];
+    /**
+     * Access linked OverlayRealA55 records
+     * @remarks Available labels: OverlayRealA55_File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked OverlayRealA55 records
+     * const items = await record.overlayRealA55s.list();
+     * const first = await record.overlayRealA55s.first();
+     *
+     * // Filter by label
+     * const specific = await record.overlayRealA55s.first({ label: 'OverlayRealA55_File' });
+     * ```
+     */
+    get overlayRealA55s(): RecordLinkManager<OverlayRealA55Record, typeof FileRecord['overlayRealA55sLabels'][number]>;
+    /** Valid labels for Appointment associations */
+    static readonly appointmentsLabels: readonly ["Appointment__File"];
+    /**
+     * Access linked Appointment records
+     * @remarks Available labels: Appointment__File
+     * @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: 'Appointment__File' });
+     * ```
+     */
+    get appointments(): RecordLinkManager<AppointmentRecord, typeof FileRecord['appointmentsLabels'][number]>;
+    /** Valid labels for UgExternalAudit associations */
+    static readonly ugExternalAuditsLabels: readonly ["UgExternalAudit_File"];
+    /**
+     * Access linked UgExternalAudit records
+     * @remarks Available labels: UgExternalAudit_File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked UgExternalAudit records
+     * const items = await record.ugExternalAudits.list();
+     * const first = await record.ugExternalAudits.first();
+     *
+     * // Filter by label
+     * const specific = await record.ugExternalAudits.first({ label: 'UgExternalAudit_File' });
+     * ```
+     */
+    get ugExternalAudits(): RecordLinkManager<UgExternalAuditRecord, typeof FileRecord['ugExternalAuditsLabels'][number]>;
+    /** Valid labels for BillingRequest associations */
+    static readonly billingRequestsLabels: readonly ["BillingRequest__File"];
+    /**
+     * Access linked BillingRequest records
+     * @remarks Available labels: BillingRequest__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked BillingRequest records
+     * const items = await record.billingRequests.list();
+     * const first = await record.billingRequests.first();
+     *
+     * // Filter by label
+     * const specific = await record.billingRequests.first({ label: 'BillingRequest__File' });
+     * ```
+     */
+    get billingRequests(): RecordLinkManager<BillingRequestRecord, typeof FileRecord['billingRequestsLabels'][number]>;
+    /** Valid labels for Transaction associations */
+    static readonly transactionsLabels: readonly ["Transaction__File"];
+    /**
+     * Access linked Transaction records
+     * @remarks Available labels: Transaction__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Transaction records
+     * const items = await record.transactions.list();
+     * const first = await record.transactions.first();
+     *
+     * // Filter by label
+     * const specific = await record.transactions.first({ label: 'Transaction__File' });
+     * ```
+     */
+    get transactions(): RecordLinkManager<TransactionRecord, typeof FileRecord['transactionsLabels'][number]>;
+    /** Valid labels for CreditNote associations */
+    static readonly creditNotesLabels: readonly ["CreditNote__File"];
+    /**
+     * Access linked CreditNote records
+     * @remarks Available labels: CreditNote__File
+     * @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: 'CreditNote__File' });
+     * ```
+     */
+    get creditNotes(): RecordLinkManager<CreditNoteRecord, typeof FileRecord['creditNotesLabels'][number]>;
+    /** Valid labels for Address associations */
+    static readonly addressesLabels: readonly ["Address__File"];
+    /**
+     * Access linked Address records
+     * @remarks Available labels: Address__File
+     * @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: 'Address__File' });
+     * ```
+     */
+    get addresses(): RecordLinkManager<AddressRecord, typeof FileRecord['addressesLabels'][number]>;
+    /** Valid labels for ChangeReason associations */
+    static readonly changeReasonsLabels: readonly ["ChangeReason__File"];
+    /**
+     * Access linked ChangeReason records
+     * @remarks Available labels: ChangeReason__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked ChangeReason records
+     * const items = await record.changeReasons.list();
+     * const first = await record.changeReasons.first();
+     *
+     * // Filter by label
+     * const specific = await record.changeReasons.first({ label: 'ChangeReason__File' });
+     * ```
+     */
+    get changeReasons(): RecordLinkManager<ChangeReasonRecord, typeof FileRecord['changeReasonsLabels'][number]>;
+    /** Valid labels for Discount associations */
+    static readonly discountsLabels: readonly ["Discount__File"];
+    /**
+     * Access linked Discount records
+     * @remarks Available labels: Discount__File
+     * @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: 'Discount__File' });
+     * ```
+     */
+    get discounts(): RecordLinkManager<DiscountRecord, typeof FileRecord['discountsLabels'][number]>;
+    /** Valid labels for PaymentMethodRefund associations */
+    static readonly paymentMethodRefundsLabels: readonly ["PaymentMethodRefund__File"];
+    /**
+     * Access linked PaymentMethodRefund records
+     * @remarks Available labels: PaymentMethodRefund__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked PaymentMethodRefund records
+     * const items = await record.paymentMethodRefunds.list();
+     * const first = await record.paymentMethodRefunds.first();
+     *
+     * // Filter by label
+     * const specific = await record.paymentMethodRefunds.first({ label: 'PaymentMethodRefund__File' });
+     * ```
+     */
+    get paymentMethodRefunds(): RecordLinkManager<PaymentMethodRefundRecord, typeof FileRecord['paymentMethodRefundsLabels'][number]>;
+    /** Valid labels for ServiceAppointment associations */
+    static readonly serviceAppointmentsLabels: readonly ["ServiceAppointment__File"];
+    /**
+     * Access linked ServiceAppointment records
+     * @remarks Available labels: ServiceAppointment__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked ServiceAppointment records
+     * const items = await record.serviceAppointments.list();
+     * const first = await record.serviceAppointments.first();
+     *
+     * // Filter by label
+     * const specific = await record.serviceAppointments.first({ label: 'ServiceAppointment__File' });
+     * ```
+     */
+    get serviceAppointments(): RecordLinkManager<ServiceAppointmentRecord, typeof FileRecord['serviceAppointmentsLabels'][number]>;
+    /** Valid labels for CustomerDeviceRouter associations */
+    static readonly customerDeviceRoutersLabels: readonly ["CustomerDeviceRouter__File"];
+    /**
+     * Access linked CustomerDeviceRouter records
+     * @remarks Available labels: CustomerDeviceRouter__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked CustomerDeviceRouter records
+     * const items = await record.customerDeviceRouters.list();
+     * const first = await record.customerDeviceRouters.first();
+     *
+     * // Filter by label
+     * const specific = await record.customerDeviceRouters.first({ label: 'CustomerDeviceRouter__File' });
+     * ```
+     */
+    get customerDeviceRouters(): RecordLinkManager<CustomerDeviceRouterRecord, typeof FileRecord['customerDeviceRoutersLabels'][number]>;
+    /** Valid labels for Visit associations */
+    static readonly visitsLabels: readonly ["Visit__File"];
+    /**
+     * Access linked Visit records
+     * @remarks Available labels: Visit__File
+     * @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: 'Visit__File' });
+     * ```
+     */
+    get visits(): RecordLinkManager<VisitRecord, typeof FileRecord['visitsLabels'][number]>;
+    /** Valid labels for WayleaveAudit associations */
+    static readonly wayleaveAuditsLabels: readonly ["WayleaveAudit_File"];
+    /**
+     * Access linked WayleaveAudit records
+     * @remarks Available labels: WayleaveAudit_File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked WayleaveAudit records
+     * const items = await record.wayleaveAudits.list();
+     * const first = await record.wayleaveAudits.first();
+     *
+     * // Filter by label
+     * const specific = await record.wayleaveAudits.first({ label: 'WayleaveAudit_File' });
+     * ```
+     */
+    get wayleaveAudits(): RecordLinkManager<WayleaveAuditRecord, typeof FileRecord['wayleaveAuditsLabels'][number]>;
+    /** Valid labels for WorkOrder associations */
+    static readonly workOrdersLabels: readonly ["WorkOrder__File"];
+    /**
+     * Access linked WorkOrder records
+     * @remarks Available labels: WorkOrder__File
+     * @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__File' });
+     * ```
+     */
+    get workOrders(): RecordLinkManager<WorkOrderRecord, typeof FileRecord['workOrdersLabels'][number]>;
+    /** Valid labels for OrderItem associations */
+    static readonly orderItemsLabels: readonly ["OrderItem__File"];
+    /**
+     * Access linked OrderItem records
+     * @remarks Available labels: OrderItem__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked OrderItem records
+     * const items = await record.orderItems.list();
+     * const first = await record.orderItems.first();
+     *
+     * // Filter by label
+     * const specific = await record.orderItems.first({ label: 'OrderItem__File' });
+     * ```
+     */
+    get orderItems(): RecordLinkManager<OrderItemRecord, typeof FileRecord['orderItemsLabels'][number]>;
+    /** Valid labels for KnowledgeArticle associations */
+    static readonly knowledgeArticlesLabels: readonly ["KnowledgeArticle__File"];
+    /**
+     * Access linked KnowledgeArticle records
+     * @remarks Available labels: KnowledgeArticle__File
+     * @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__File' });
+     * ```
+     */
+    get knowledgeArticles(): RecordLinkManager<KnowledgeArticleRecord, typeof FileRecord['knowledgeArticlesLabels'][number]>;
+    /** Valid labels for Case associations */
+    static readonly casesLabels: readonly ["Case__File"];
+    /**
+     * Access linked Case records
+     * @remarks Available labels: Case__File
+     * @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: 'Case__File' });
+     * ```
+     */
+    get cases(): RecordLinkManager<CaseRecord, typeof FileRecord['casesLabels'][number]>;
+    /** Valid labels for Activity associations */
+    static readonly activitiesLabels: readonly ["Activity__File"];
+    /**
+     * Access linked Activity records
+     * @remarks Available labels: Activity__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Activity records
+     * const items = await record.activities.list();
+     * const first = await record.activities.first();
+     *
+     * // Filter by label
+     * const specific = await record.activities.first({ label: 'Activity__File' });
+     * ```
+     */
+    get activities(): RecordLinkManager<ActivityRecord, typeof FileRecord['activitiesLabels'][number]>;
+    /** Valid labels for OneTouchSwitch associations */
+    static readonly oneTouchSwitchesLabels: readonly ["OneTouchSwitch_File"];
+    /**
+     * Access linked OneTouchSwitch records
+     * @remarks Available labels: OneTouchSwitch_File
+     * @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: 'OneTouchSwitch_File' });
+     * ```
+     */
+    get oneTouchSwitches(): RecordLinkManager<OneTouchSwitchRecord, typeof FileRecord['oneTouchSwitchesLabels'][number]>;
+    /** Valid labels for RemediationRequiredReason associations */
+    static readonly remediationRequiredReasonsLabels: readonly ["RemediationRequiredReason__File"];
+    /**
+     * Access linked RemediationRequiredReason records
+     * @remarks Available labels: RemediationRequiredReason__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked RemediationRequiredReason records
+     * const items = await record.remediationRequiredReasons.list();
+     * const first = await record.remediationRequiredReasons.first();
+     *
+     * // Filter by label
+     * const specific = await record.remediationRequiredReasons.first({ label: 'RemediationRequiredReason__File' });
+     * ```
+     */
+    get remediationRequiredReasons(): RecordLinkManager<RemediationRequiredReasonRecord, typeof FileRecord['remediationRequiredReasonsLabels'][number]>;
+    /** Valid labels for Invoice associations */
+    static readonly invoicesLabels: readonly ["Invoice__File"];
+    /**
+     * Access linked Invoice records
+     * @remarks Available labels: Invoice__File
+     * @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: 'Invoice__File' });
+     * ```
+     */
+    get invoices(): RecordLinkManager<InvoiceRecord, typeof FileRecord['invoicesLabels'][number]>;
+    /** Valid labels for Note associations */
+    static readonly notesLabels: readonly ["File__Note", "Note__File"];
+    /**
+     * Access linked Note records
+     * @remarks Available labels: File__Note, Note__File
+     * @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: 'File__Note' });
+     * ```
+     */
+    get notes(): RecordLinkManager<NoteRecord, typeof FileRecord['notesLabels'][number]>;
+    /** Valid labels for Lead associations */
+    static readonly leadsLabels: readonly ["Lead__File"];
+    /**
+     * Access linked Lead records
+     * @remarks Available labels: Lead__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Lead records
+     * const items = await record.leads.list();
+     * const first = await record.leads.first();
+     *
+     * // Filter by label
+     * const specific = await record.leads.first({ label: 'Lead__File' });
+     * ```
+     */
+    get leads(): RecordLinkManager<LeadRecord, typeof FileRecord['leadsLabels'][number]>;
+    /** Valid labels for Account associations */
+    static readonly accountsLabels: readonly ["Account__File"];
+    /**
+     * Access linked Account records
+     * @remarks Available labels: Account__File
+     * @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__File' });
+     * ```
+     */
+    get accounts(): RecordLinkManager<AccountRecord, typeof FileRecord['accountsLabels'][number]>;
+    /** Valid labels for PaymentMethod associations */
+    static readonly paymentMethodsLabels: readonly ["PaymentMethod__File"];
+    /**
+     * Access linked PaymentMethod records
+     * @remarks Available labels: PaymentMethod__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked PaymentMethod records
+     * const items = await record.paymentMethods.list();
+     * const first = await record.paymentMethods.first();
+     *
+     * // Filter by label
+     * const specific = await record.paymentMethods.first({ label: 'PaymentMethod__File' });
+     * ```
+     */
+    get paymentMethods(): RecordLinkManager<PaymentMethodRecord, typeof FileRecord['paymentMethodsLabels'][number]>;
+    /** Valid labels for ContractBuyOut associations */
+    static readonly contractBuyOutsLabels: readonly ["ContractBuyOut__File"];
+    /**
+     * Access linked ContractBuyOut records
+     * @remarks Available labels: ContractBuyOut__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked ContractBuyOut records
+     * const items = await record.contractBuyOuts.list();
+     * const first = await record.contractBuyOuts.first();
+     *
+     * // Filter by label
+     * const specific = await record.contractBuyOuts.first({ label: 'ContractBuyOut__File' });
+     * ```
+     */
+    get contractBuyOuts(): RecordLinkManager<ContractBuyOutRecord, typeof FileRecord['contractBuyOutsLabels'][number]>;
+    /** Valid labels for SiteSpecificRiskAssessmentOutcomeForm associations */
+    static readonly siteSpecificRiskAssessmentOutcomeFormsLabels: readonly ["SiteSpecificRiskAssessmentOutcomeForm__File"];
+    /**
+     * Access linked SiteSpecificRiskAssessmentOutcomeForm records
+     * @remarks Available labels: SiteSpecificRiskAssessmentOutcomeForm__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked SiteSpecificRiskAssessmentOutcomeForm records
+     * const items = await record.siteSpecificRiskAssessmentOutcomeForms.list();
+     * const first = await record.siteSpecificRiskAssessmentOutcomeForms.first();
+     *
+     * // Filter by label
+     * const specific = await record.siteSpecificRiskAssessmentOutcomeForms.first({ label: 'SiteSpecificRiskAssessmentOutcomeForm__File' });
+     * ```
+     */
+    get siteSpecificRiskAssessmentOutcomeForms(): RecordLinkManager<SiteSpecificRiskAssessmentOutcomeFormRecord, typeof FileRecord['siteSpecificRiskAssessmentOutcomeFormsLabels'][number]>;
+    /** Valid labels for RemediationOutcomeForm associations */
+    static readonly remediationOutcomeFormsLabels: readonly ["RemediationOutcomeForm_File"];
+    /**
+     * Access linked RemediationOutcomeForm records
+     * @remarks Available labels: RemediationOutcomeForm_File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked RemediationOutcomeForm records
+     * const items = await record.remediationOutcomeForms.list();
+     * const first = await record.remediationOutcomeForms.first();
+     *
+     * // Filter by label
+     * const specific = await record.remediationOutcomeForms.first({ label: 'RemediationOutcomeForm_File' });
+     * ```
+     */
+    get remediationOutcomeForms(): RecordLinkManager<RemediationOutcomeFormRecord, typeof FileRecord['remediationOutcomeFormsLabels'][number]>;
+    /** Valid labels for Order associations */
+    static readonly ordersLabels: readonly ["Order__File"];
+    /**
+     * Access linked Order records
+     * @remarks Available labels: Order__File
+     * @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: 'Order__File' });
+     * ```
+     */
+    get orders(): RecordLinkManager<OrderRecord, typeof FileRecord['ordersLabels'][number]>;
+    /** Valid labels for Call associations */
+    static readonly callsLabels: readonly ["Call__File"];
+    /**
+     * Access linked Call records
+     * @remarks Available labels: Call__File
+     * @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__File' });
+     * ```
+     */
+    get calls(): RecordLinkManager<CallRecord, typeof FileRecord['callsLabels'][number]>;
+    /** Valid labels for OhExternalAudit associations */
+    static readonly ohExternalAuditsLabels: readonly ["OhExternalAudit_File"];
+    /**
+     * Access linked OhExternalAudit records
+     * @remarks Available labels: OhExternalAudit_File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked OhExternalAudit records
+     * const items = await record.ohExternalAudits.list();
+     * const first = await record.ohExternalAudits.first();
+     *
+     * // Filter by label
+     * const specific = await record.ohExternalAudits.first({ label: 'OhExternalAudit_File' });
+     * ```
+     */
+    get ohExternalAudits(): RecordLinkManager<OhExternalAuditRecord, typeof FileRecord['ohExternalAuditsLabels'][number]>;
+    /** Valid labels for CustomerDeviceOnt associations */
+    static readonly customerDeviceOntsLabels: readonly ["CustomerDeviceOnt__File"];
+    /**
+     * Access linked CustomerDeviceOnt records
+     * @remarks Available labels: CustomerDeviceOnt__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked CustomerDeviceOnt records
+     * const items = await record.customerDeviceOnts.list();
+     * const first = await record.customerDeviceOnts.first();
+     *
+     * // Filter by label
+     * const specific = await record.customerDeviceOnts.first({ label: 'CustomerDeviceOnt__File' });
+     * ```
+     */
+    get customerDeviceOnts(): RecordLinkManager<CustomerDeviceOntRecord, typeof FileRecord['customerDeviceOntsLabels'][number]>;
+    /** Valid labels for YfFieldServiceVisit associations */
+    static readonly yfFieldServiceVisitsLabels: readonly ["YfFieldServiceVisit__File"];
+    /**
+     * Access linked YfFieldServiceVisit records
+     * @remarks Available labels: YfFieldServiceVisit__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked YfFieldServiceVisit records
+     * const items = await record.yfFieldServiceVisits.list();
+     * const first = await record.yfFieldServiceVisits.first();
+     *
+     * // Filter by label
+     * const specific = await record.yfFieldServiceVisits.first({ label: 'YfFieldServiceVisit__File' });
+     * ```
+     */
+    get yfFieldServiceVisits(): RecordLinkManager<YfFieldServiceVisitRecord, typeof FileRecord['yfFieldServiceVisitsLabels'][number]>;
+    /** Valid labels for BillingAdjustment associations */
+    static readonly billingAdjustmentsLabels: readonly ["BillingAdjustment__File"];
+    /**
+     * Access linked BillingAdjustment records
+     * @remarks Available labels: BillingAdjustment__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked BillingAdjustment records
+     * const items = await record.billingAdjustments.list();
+     * const first = await record.billingAdjustments.first();
+     *
+     * // Filter by label
+     * const specific = await record.billingAdjustments.first({ label: 'BillingAdjustment__File' });
+     * ```
+     */
+    get billingAdjustments(): RecordLinkManager<BillingAdjustmentRecord, typeof FileRecord['billingAdjustmentsLabels'][number]>;
+    /** Valid labels for Contact associations */
+    static readonly contactsLabels: readonly ["Contact__File"];
+    /**
+     * Access linked Contact records
+     * @remarks Available labels: Contact__File
+     * @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__File' });
+     * ```
+     */
+    get contacts(): RecordLinkManager<ContactRecord, typeof FileRecord['contactsLabels'][number]>;
+    /** Valid labels for Message associations */
+    static readonly messagesLabels: readonly ["Message_File"];
+    /**
+     * Access linked Message records
+     * @remarks Available labels: Message_File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Message records
+     * const items = await record.messages.list();
+     * const first = await record.messages.first();
+     *
+     * // Filter by label
+     * const specific = await record.messages.first({ label: 'Message_File' });
+     * ```
+     */
+    get messages(): RecordLinkManager<MessageRecord, typeof FileRecord['messagesLabels'][number]>;
+    /** Valid labels for Email associations */
+    static readonly emailsLabels: readonly ["Attachments"];
+    /**
+     * Access linked Email records
+     * @remarks Available labels: Attachments
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Email records
+     * const items = await record.emails.list();
+     * const first = await record.emails.first();
+     *
+     * // Filter by label
+     * const specific = await record.emails.first({ label: 'Attachments' });
+     * ```
+     */
+    get emails(): RecordLinkManager<EmailRecord, typeof FileRecord['emailsLabels'][number]>;
+    /** Valid labels for PgDirectDebitFile associations */
+    static readonly pgDirectDebitFilesLabels: readonly ["PgDirectDebitFile__File"];
+    /**
+     * Access linked PgDirectDebitFile records
+     * @remarks Available labels: PgDirectDebitFile__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked PgDirectDebitFile records
+     * const items = await record.pgDirectDebitFiles.list();
+     * const first = await record.pgDirectDebitFiles.first();
+     *
+     * // Filter by label
+     * const specific = await record.pgDirectDebitFiles.first({ label: 'PgDirectDebitFile__File' });
+     * ```
+     */
+    get pgDirectDebitFiles(): RecordLinkManager<PgDirectDebitFileRecord, typeof FileRecord['pgDirectDebitFilesLabels'][number]>;
+    /**
+     * Queue a link to be created with the next action.
+     * Works for both create and update actions.
+     * @returns this (for chaining)
+     */
+    link(target: OdinRecord<any> | {
+        id: string;
+        entity: string;
+    }): this;
+    /** Get the currently queued links */
+    get pendingLinks(): OdinRecordLinkDto[];
+    /** Clear pending links without executing an action */
+    clearPendingLinks(): this;
+    /**
+     * Immediately unlink a record (API call).
+     * Unlike link(), this executes immediately.
+     * @throws Error if called on a new (unsaved) record
+     */
+    unlink(target: OdinRecord<any> | {
+        id: string;
+    } | string): Promise<void>;
+    /**
+     * CreateFile
+     *
+     * Creates a new File record with the specified properties.
+     * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
+     *
+     * @remarks Record type: DEFAULT
+     *
+     * @param properties - The properties for the new record
+     * @param options - Optional settings
+     * @param options.journeyId - Associate with a journey
+     * @param options.stageKey - Set initial pipeline stage
+     * @returns ActionBuilder - call .execute() to create or .dryRun() for payload
+     *
+     * @example
+     * ```typescript
+     * // Create with properties
+     * const record = odinClient.files.new();
+     * await record.createFile({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.createFile({ ... }).dryRun();
+     * ```
+     */
+    createFile(properties?: CreateFileProperties, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    }): ActionBuilder;
+}
+/** Type guard to check if an object is a FileRecord */
+export declare function isFileRecord(obj: any): obj is FileRecord;
+export {};