@d19n/youfibre-odin-sdk 2.0.346 → 2.0.348

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -24,7 +24,48 @@ import { IOdinProvider } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
24
24
  import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
25
25
  import { FileProperties, AfpInvoiceFileProperties, CboFinalBillFileProperties, CsvFileProperties, EmailFileProperties, InvoiceFileProperties, NaProblemEvidenceFileProperties, NaSolutionEvidenceFileProperties, OpenreachA55FileProperties, OtdrFileProperties, ProcessingOutputFileProperties } from '../entities-v2/File';
26
26
  import { CreateFileProperties } from '../actions-v2/CreateFileDto';
27
+ import { OverlayRealA55Record } from './OverlayRealA55Record';
28
+ import { AppointmentRecord } from './AppointmentRecord';
29
+ import { UgExternalAuditRecord } from './UgExternalAuditRecord';
30
+ import { BillingRequestRecord } from './BillingRequestRecord';
31
+ import { TransactionRecord } from './TransactionRecord';
32
+ import { CreditNoteRecord } from './CreditNoteRecord';
33
+ import { AddressRecord } from './AddressRecord';
34
+ import { ChangeReasonRecord } from './ChangeReasonRecord';
35
+ import { DiscountRecord } from './DiscountRecord';
36
+ import { PaymentMethodRefundRecord } from './PaymentMethodRefundRecord';
37
+ import { ServiceAppointmentRecord } from './ServiceAppointmentRecord';
38
+ import { CustomerDeviceRouterRecord } from './CustomerDeviceRouterRecord';
39
+ import { VisitRecord } from './VisitRecord';
40
+ import { WayleaveAuditRecord } from './WayleaveAuditRecord';
41
+ import { WorkOrderRecord } from './WorkOrderRecord';
42
+ import { OrderItemRecord } from './OrderItemRecord';
43
+ import { KnowledgeArticleRecord } from './KnowledgeArticleRecord';
44
+ import { CaseRecord } from './CaseRecord';
45
+ import { ActivityRecord } from './ActivityRecord';
46
+ import { OneTouchSwitchRecord } from './OneTouchSwitchRecord';
47
+ import { RemediationRequiredReasonRecord } from './RemediationRequiredReasonRecord';
48
+ import { InvoiceRecord } from './InvoiceRecord';
27
49
  import { NoteRecord } from './NoteRecord';
50
+ import { LeadRecord } from './LeadRecord';
51
+ import { AccountRecord } from './AccountRecord';
52
+ import { PaymentMethodRecord } from './PaymentMethodRecord';
53
+ import { ContractBuyOutRecord } from './ContractBuyOutRecord';
54
+ import { SiteSpecificRiskAssessmentOutcomeFormRecord } from './SiteSpecificRiskAssessmentOutcomeFormRecord';
55
+ import { RemediationOutcomeFormRecord } from './RemediationOutcomeFormRecord';
56
+ import { OrderRecord } from './OrderRecord';
57
+ import { CallRecord } from './CallRecord';
58
+ import { OhExternalAuditRecord } from './OhExternalAuditRecord';
59
+ import { CustomerDeviceOntRecord } from './CustomerDeviceOntRecord';
60
+ import { BillingAdjustmentRecord } from './BillingAdjustmentRecord';
61
+ import { ContactRecord } from './ContactRecord';
62
+ import { MessageRecord } from './MessageRecord';
63
+ import { EmailRecord } from './EmailRecord';
64
+ import { PgDirectDebitFileRecord } from './PgDirectDebitFileRecord';
65
+ import { YfWifiSurveyRecord } from './YfWifiSurveyRecord';
66
+ import { YfFieldVisitOutcomeFormRecord } from './YfFieldVisitOutcomeFormRecord';
67
+ import { DocumentRecord } from './DocumentRecord';
68
+ import { DocumentProcessingRecord } from './DocumentProcessingRecord';
28
69
  /** Valid entity types for File */
29
70
  export declare type FileType = 'AFP_INVOICE' | 'CBO_FINAL_BILL' | 'CSV' | 'DEFAULT' | 'EMAIL' | 'INVOICE' | 'NA_PROBLEM_EVIDENCE' | 'NA_SOLUTION_EVIDENCE' | 'OPENREACH_A55' | 'OTDR' | 'PROCESSING_OUTPUT';
30
71
  /**
@@ -90,8 +131,48 @@ export declare class FileRecord<TProps = FileProperties> {
90
131
  private _provider;
91
132
  private _pendingLinks;
92
133
  private _preGeneratedId;
93
- private _files?;
134
+ private _overlayRealA55s?;
135
+ private _appointments?;
136
+ private _ugExternalAudits?;
137
+ private _billingRequests?;
138
+ private _transactions?;
139
+ private _creditNotes?;
140
+ private _addresses?;
141
+ private _changeReasons?;
142
+ private _discounts?;
143
+ private _paymentMethodRefunds?;
144
+ private _serviceAppointments?;
145
+ private _customerDeviceRouters?;
146
+ private _visits?;
147
+ private _wayleaveAudits?;
148
+ private _workOrders?;
149
+ private _orderItems?;
150
+ private _knowledgeArticles?;
151
+ private _cases?;
152
+ private _activities?;
153
+ private _oneTouchSwitches?;
154
+ private _remediationRequiredReasons?;
155
+ private _invoices?;
94
156
  private _notes?;
157
+ private _leads?;
158
+ private _accounts?;
159
+ private _paymentMethods?;
160
+ private _contractBuyOuts?;
161
+ private _siteSpecificRiskAssessmentOutcomeForms?;
162
+ private _remediationOutcomeForms?;
163
+ private _orders?;
164
+ private _calls?;
165
+ private _ohExternalAudits?;
166
+ private _customerDeviceOnts?;
167
+ private _billingAdjustments?;
168
+ private _contacts?;
169
+ private _messages?;
170
+ private _emails?;
171
+ private _pgDirectDebitFiles?;
172
+ private _yfWifiSurveys?;
173
+ private _yfFieldVisitOutcomeForms?;
174
+ private _documents?;
175
+ private _documentProcessings?;
95
176
  /**
96
177
  * Create a record wrapper.
97
178
  * @param record - The underlying record, or null for create operations
@@ -295,29 +376,407 @@ export declare class FileRecord<TProps = FileProperties> {
295
376
  * @remarks JSON detail of a document pipeline run, linked to its AiModule:DocumentProcessing row (e.g. per-question verdicts and reasons).
296
377
  */
297
378
  isProcessingOutput(): this is FileRecord<ProcessingOutputFileProperties>;
298
- /** Valid labels for File associations */
299
- static readonly filesLabels: readonly ["ServiceVisitAudit__File", "BlockageA55_File", "NetomniaFtth2StageInstallAudit__File", "NetomniaFtth1StageInstallAudit__File", "OverlayRealA55_File", "Appointment__File", "UgExternalAudit_File", "BillingRequest__File", "Transaction__File", "CreditNote__File", "Address__File", "ChangeReason__File", "Discount__File", "PaymentMethodRefund__File", "ServiceAppointment__File", "CustomerDeviceRouter__File", "Visit__File", "Fingerprint__File", "YfToolAudit_File", "WayleaveAudit_File", "WorkOrder__File", "OrderItem__File", "InternalInstallAudit_File", "KnowledgeArticle__File", "Case__File", "Activity__File", "NetomniaFtthServiceVisitSheet__File", "YfStockCount__File", "OneTouchSwitch_File", "RemediationRequiredReason__File", "Invoice__File", "YfVanAudit_File", "UgInstallationAudit__File", "OhInstallationAudit__File", "UgAuditOfInstallation__File", "YfEquipmentCollection__File", "Lead__File", "Account__File", "PaymentMethod__File", "SweeperMaintenanceAudit__File", "BlockageReportA55__File", "OhAuditOfInstallation__File", "OhInProgressAudit_File", "ContractBuyOut__File", "SiteSpecificRiskAssessmentOutcomeForm__File", "RemediationOutcomeForm_File", "Order__File", "Call__File", "OhExternalAudit_File", "CustomerDeviceOnt__File", "YfFieldServiceVisit__File", "BillingAdjustment__File", "Contact__File", "Message_File", "NetomniaInstallVerification__File", "Attachments", "UgRetroAudit__File", "OhRetroAudit__File", "UgInProgressAudit_File", "PgDirectDebitFile__File", "YfWifiSurvey__File", "YfFieldVisitOutcomeForm__File", "Note__File", "Document__File", "DocumentProcessing__File"];
379
+ /** Valid labels for OverlayRealA55 associations */
380
+ static readonly overlayRealA55sLabels: readonly ["OverlayRealA55_File"];
300
381
  /**
301
- * Access linked File records
302
- * @remarks Available labels: ServiceVisitAudit__File, BlockageA55_File, NetomniaFtth2StageInstallAudit__File, NetomniaFtth1StageInstallAudit__File, OverlayRealA55_File, Appointment__File, UgExternalAudit_File, BillingRequest__File, Transaction__File, CreditNote__File, Address__File, ChangeReason__File, Discount__File, PaymentMethodRefund__File, ServiceAppointment__File, CustomerDeviceRouter__File, Visit__File, Fingerprint__File, YfToolAudit_File, WayleaveAudit_File, WorkOrder__File, OrderItem__File, InternalInstallAudit_File, KnowledgeArticle__File, Case__File, Activity__File, NetomniaFtthServiceVisitSheet__File, YfStockCount__File, OneTouchSwitch_File, RemediationRequiredReason__File, Invoice__File, YfVanAudit_File, UgInstallationAudit__File, OhInstallationAudit__File, UgAuditOfInstallation__File, YfEquipmentCollection__File, Lead__File, Account__File, PaymentMethod__File, SweeperMaintenanceAudit__File, BlockageReportA55__File, OhAuditOfInstallation__File, OhInProgressAudit_File, ContractBuyOut__File, SiteSpecificRiskAssessmentOutcomeForm__File, RemediationOutcomeForm_File, Order__File, Call__File, OhExternalAudit_File, CustomerDeviceOnt__File, YfFieldServiceVisit__File, BillingAdjustment__File, Contact__File, Message_File, NetomniaInstallVerification__File, Attachments, UgRetroAudit__File, OhRetroAudit__File, UgInProgressAudit_File, PgDirectDebitFile__File, YfWifiSurvey__File, YfFieldVisitOutcomeForm__File, Note__File, Document__File, DocumentProcessing__File
382
+ * Access linked OverlayRealA55 records
383
+ * @remarks Available labels: OverlayRealA55_File
303
384
  * @throws Error if called on a new (unsaved) record
304
385
  *
305
386
  * @example
306
387
  * ```typescript
307
- * // Get all linked File records
308
- * const items = await record.files.list();
309
- * const first = await record.files.first();
388
+ * // Get all linked OverlayRealA55 records
389
+ * const items = await record.overlayRealA55s.list();
390
+ * const first = await record.overlayRealA55s.first();
310
391
  *
311
392
  * // Filter by label
312
- * const specific = await record.files.first({ label: 'ServiceVisitAudit__File' });
393
+ * const specific = await record.overlayRealA55s.first({ label: 'OverlayRealA55_File' });
313
394
  * ```
314
395
  */
315
- get files(): RecordLinkManager<FileRecord, typeof FileRecord['filesLabels'][number]>;
396
+ get overlayRealA55s(): RecordLinkManager<OverlayRealA55Record, typeof FileRecord['overlayRealA55sLabels'][number]>;
397
+ /** Valid labels for Appointment associations */
398
+ static readonly appointmentsLabels: readonly ["Appointment__File"];
399
+ /**
400
+ * Access linked Appointment records
401
+ * @remarks Available labels: Appointment__File
402
+ * @throws Error if called on a new (unsaved) record
403
+ *
404
+ * @example
405
+ * ```typescript
406
+ * // Get all linked Appointment records
407
+ * const items = await record.appointments.list();
408
+ * const first = await record.appointments.first();
409
+ *
410
+ * // Filter by label
411
+ * const specific = await record.appointments.first({ label: 'Appointment__File' });
412
+ * ```
413
+ */
414
+ get appointments(): RecordLinkManager<AppointmentRecord, typeof FileRecord['appointmentsLabels'][number]>;
415
+ /** Valid labels for UgExternalAudit associations */
416
+ static readonly ugExternalAuditsLabels: readonly ["UgExternalAudit_File"];
417
+ /**
418
+ * Access linked UgExternalAudit records
419
+ * @remarks Available labels: UgExternalAudit_File
420
+ * @throws Error if called on a new (unsaved) record
421
+ *
422
+ * @example
423
+ * ```typescript
424
+ * // Get all linked UgExternalAudit records
425
+ * const items = await record.ugExternalAudits.list();
426
+ * const first = await record.ugExternalAudits.first();
427
+ *
428
+ * // Filter by label
429
+ * const specific = await record.ugExternalAudits.first({ label: 'UgExternalAudit_File' });
430
+ * ```
431
+ */
432
+ get ugExternalAudits(): RecordLinkManager<UgExternalAuditRecord, typeof FileRecord['ugExternalAuditsLabels'][number]>;
433
+ /** Valid labels for BillingRequest associations */
434
+ static readonly billingRequestsLabels: readonly ["BillingRequest__File"];
435
+ /**
436
+ * Access linked BillingRequest records
437
+ * @remarks Available labels: BillingRequest__File
438
+ * @throws Error if called on a new (unsaved) record
439
+ *
440
+ * @example
441
+ * ```typescript
442
+ * // Get all linked BillingRequest records
443
+ * const items = await record.billingRequests.list();
444
+ * const first = await record.billingRequests.first();
445
+ *
446
+ * // Filter by label
447
+ * const specific = await record.billingRequests.first({ label: 'BillingRequest__File' });
448
+ * ```
449
+ */
450
+ get billingRequests(): RecordLinkManager<BillingRequestRecord, typeof FileRecord['billingRequestsLabels'][number]>;
451
+ /** Valid labels for Transaction associations */
452
+ static readonly transactionsLabels: readonly ["Transaction__File"];
453
+ /**
454
+ * Access linked Transaction records
455
+ * @remarks Available labels: Transaction__File
456
+ * @throws Error if called on a new (unsaved) record
457
+ *
458
+ * @example
459
+ * ```typescript
460
+ * // Get all linked Transaction records
461
+ * const items = await record.transactions.list();
462
+ * const first = await record.transactions.first();
463
+ *
464
+ * // Filter by label
465
+ * const specific = await record.transactions.first({ label: 'Transaction__File' });
466
+ * ```
467
+ */
468
+ get transactions(): RecordLinkManager<TransactionRecord, typeof FileRecord['transactionsLabels'][number]>;
469
+ /** Valid labels for CreditNote associations */
470
+ static readonly creditNotesLabels: readonly ["CreditNote__File"];
471
+ /**
472
+ * Access linked CreditNote records
473
+ * @remarks Available labels: CreditNote__File
474
+ * @throws Error if called on a new (unsaved) record
475
+ *
476
+ * @example
477
+ * ```typescript
478
+ * // Get all linked CreditNote records
479
+ * const items = await record.creditNotes.list();
480
+ * const first = await record.creditNotes.first();
481
+ *
482
+ * // Filter by label
483
+ * const specific = await record.creditNotes.first({ label: 'CreditNote__File' });
484
+ * ```
485
+ */
486
+ get creditNotes(): RecordLinkManager<CreditNoteRecord, typeof FileRecord['creditNotesLabels'][number]>;
487
+ /** Valid labels for Address associations */
488
+ static readonly addressesLabels: readonly ["Address__File"];
489
+ /**
490
+ * Access linked Address records
491
+ * @remarks Available labels: Address__File
492
+ * @throws Error if called on a new (unsaved) record
493
+ *
494
+ * @example
495
+ * ```typescript
496
+ * // Get all linked Address records
497
+ * const items = await record.addresses.list();
498
+ * const first = await record.addresses.first();
499
+ *
500
+ * // Filter by label
501
+ * const specific = await record.addresses.first({ label: 'Address__File' });
502
+ * ```
503
+ */
504
+ get addresses(): RecordLinkManager<AddressRecord, typeof FileRecord['addressesLabels'][number]>;
505
+ /** Valid labels for ChangeReason associations */
506
+ static readonly changeReasonsLabels: readonly ["ChangeReason__File"];
507
+ /**
508
+ * Access linked ChangeReason records
509
+ * @remarks Available labels: ChangeReason__File
510
+ * @throws Error if called on a new (unsaved) record
511
+ *
512
+ * @example
513
+ * ```typescript
514
+ * // Get all linked ChangeReason records
515
+ * const items = await record.changeReasons.list();
516
+ * const first = await record.changeReasons.first();
517
+ *
518
+ * // Filter by label
519
+ * const specific = await record.changeReasons.first({ label: 'ChangeReason__File' });
520
+ * ```
521
+ */
522
+ get changeReasons(): RecordLinkManager<ChangeReasonRecord, typeof FileRecord['changeReasonsLabels'][number]>;
523
+ /** Valid labels for Discount associations */
524
+ static readonly discountsLabels: readonly ["Discount__File"];
525
+ /**
526
+ * Access linked Discount records
527
+ * @remarks Available labels: Discount__File
528
+ * @throws Error if called on a new (unsaved) record
529
+ *
530
+ * @example
531
+ * ```typescript
532
+ * // Get all linked Discount records
533
+ * const items = await record.discounts.list();
534
+ * const first = await record.discounts.first();
535
+ *
536
+ * // Filter by label
537
+ * const specific = await record.discounts.first({ label: 'Discount__File' });
538
+ * ```
539
+ */
540
+ get discounts(): RecordLinkManager<DiscountRecord, typeof FileRecord['discountsLabels'][number]>;
541
+ /** Valid labels for PaymentMethodRefund associations */
542
+ static readonly paymentMethodRefundsLabels: readonly ["PaymentMethodRefund__File"];
543
+ /**
544
+ * Access linked PaymentMethodRefund records
545
+ * @remarks Available labels: PaymentMethodRefund__File
546
+ * @throws Error if called on a new (unsaved) record
547
+ *
548
+ * @example
549
+ * ```typescript
550
+ * // Get all linked PaymentMethodRefund records
551
+ * const items = await record.paymentMethodRefunds.list();
552
+ * const first = await record.paymentMethodRefunds.first();
553
+ *
554
+ * // Filter by label
555
+ * const specific = await record.paymentMethodRefunds.first({ label: 'PaymentMethodRefund__File' });
556
+ * ```
557
+ */
558
+ get paymentMethodRefunds(): RecordLinkManager<PaymentMethodRefundRecord, typeof FileRecord['paymentMethodRefundsLabels'][number]>;
559
+ /** Valid labels for ServiceAppointment associations */
560
+ static readonly serviceAppointmentsLabels: readonly ["ServiceAppointment__File"];
561
+ /**
562
+ * Access linked ServiceAppointment records
563
+ * @remarks Available labels: ServiceAppointment__File
564
+ * @throws Error if called on a new (unsaved) record
565
+ *
566
+ * @example
567
+ * ```typescript
568
+ * // Get all linked ServiceAppointment records
569
+ * const items = await record.serviceAppointments.list();
570
+ * const first = await record.serviceAppointments.first();
571
+ *
572
+ * // Filter by label
573
+ * const specific = await record.serviceAppointments.first({ label: 'ServiceAppointment__File' });
574
+ * ```
575
+ */
576
+ get serviceAppointments(): RecordLinkManager<ServiceAppointmentRecord, typeof FileRecord['serviceAppointmentsLabels'][number]>;
577
+ /** Valid labels for CustomerDeviceRouter associations */
578
+ static readonly customerDeviceRoutersLabels: readonly ["CustomerDeviceRouter__File"];
579
+ /**
580
+ * Access linked CustomerDeviceRouter records
581
+ * @remarks Available labels: CustomerDeviceRouter__File
582
+ * @throws Error if called on a new (unsaved) record
583
+ *
584
+ * @example
585
+ * ```typescript
586
+ * // Get all linked CustomerDeviceRouter records
587
+ * const items = await record.customerDeviceRouters.list();
588
+ * const first = await record.customerDeviceRouters.first();
589
+ *
590
+ * // Filter by label
591
+ * const specific = await record.customerDeviceRouters.first({ label: 'CustomerDeviceRouter__File' });
592
+ * ```
593
+ */
594
+ get customerDeviceRouters(): RecordLinkManager<CustomerDeviceRouterRecord, typeof FileRecord['customerDeviceRoutersLabels'][number]>;
595
+ /** Valid labels for Visit associations */
596
+ static readonly visitsLabels: readonly ["Visit__File"];
597
+ /**
598
+ * Access linked Visit records
599
+ * @remarks Available labels: Visit__File
600
+ * @throws Error if called on a new (unsaved) record
601
+ *
602
+ * @example
603
+ * ```typescript
604
+ * // Get all linked Visit records
605
+ * const items = await record.visits.list();
606
+ * const first = await record.visits.first();
607
+ *
608
+ * // Filter by label
609
+ * const specific = await record.visits.first({ label: 'Visit__File' });
610
+ * ```
611
+ */
612
+ get visits(): RecordLinkManager<VisitRecord, typeof FileRecord['visitsLabels'][number]>;
613
+ /** Valid labels for WayleaveAudit associations */
614
+ static readonly wayleaveAuditsLabels: readonly ["WayleaveAudit_File"];
615
+ /**
616
+ * Access linked WayleaveAudit records
617
+ * @remarks Available labels: WayleaveAudit_File
618
+ * @throws Error if called on a new (unsaved) record
619
+ *
620
+ * @example
621
+ * ```typescript
622
+ * // Get all linked WayleaveAudit records
623
+ * const items = await record.wayleaveAudits.list();
624
+ * const first = await record.wayleaveAudits.first();
625
+ *
626
+ * // Filter by label
627
+ * const specific = await record.wayleaveAudits.first({ label: 'WayleaveAudit_File' });
628
+ * ```
629
+ */
630
+ get wayleaveAudits(): RecordLinkManager<WayleaveAuditRecord, typeof FileRecord['wayleaveAuditsLabels'][number]>;
631
+ /** Valid labels for WorkOrder associations */
632
+ static readonly workOrdersLabels: readonly ["WorkOrder__File"];
633
+ /**
634
+ * Access linked WorkOrder records
635
+ * @remarks Available labels: WorkOrder__File
636
+ * @throws Error if called on a new (unsaved) record
637
+ *
638
+ * @example
639
+ * ```typescript
640
+ * // Get all linked WorkOrder records
641
+ * const items = await record.workOrders.list();
642
+ * const first = await record.workOrders.first();
643
+ *
644
+ * // Filter by label
645
+ * const specific = await record.workOrders.first({ label: 'WorkOrder__File' });
646
+ * ```
647
+ */
648
+ get workOrders(): RecordLinkManager<WorkOrderRecord, typeof FileRecord['workOrdersLabels'][number]>;
649
+ /** Valid labels for OrderItem associations */
650
+ static readonly orderItemsLabels: readonly ["OrderItem__File"];
651
+ /**
652
+ * Access linked OrderItem records
653
+ * @remarks Available labels: OrderItem__File
654
+ * @throws Error if called on a new (unsaved) record
655
+ *
656
+ * @example
657
+ * ```typescript
658
+ * // Get all linked OrderItem records
659
+ * const items = await record.orderItems.list();
660
+ * const first = await record.orderItems.first();
661
+ *
662
+ * // Filter by label
663
+ * const specific = await record.orderItems.first({ label: 'OrderItem__File' });
664
+ * ```
665
+ */
666
+ get orderItems(): RecordLinkManager<OrderItemRecord, typeof FileRecord['orderItemsLabels'][number]>;
667
+ /** Valid labels for KnowledgeArticle associations */
668
+ static readonly knowledgeArticlesLabels: readonly ["KnowledgeArticle__File"];
669
+ /**
670
+ * Access linked KnowledgeArticle records
671
+ * @remarks Available labels: KnowledgeArticle__File
672
+ * @throws Error if called on a new (unsaved) record
673
+ *
674
+ * @example
675
+ * ```typescript
676
+ * // Get all linked KnowledgeArticle records
677
+ * const items = await record.knowledgeArticles.list();
678
+ * const first = await record.knowledgeArticles.first();
679
+ *
680
+ * // Filter by label
681
+ * const specific = await record.knowledgeArticles.first({ label: 'KnowledgeArticle__File' });
682
+ * ```
683
+ */
684
+ get knowledgeArticles(): RecordLinkManager<KnowledgeArticleRecord, typeof FileRecord['knowledgeArticlesLabels'][number]>;
685
+ /** Valid labels for Case associations */
686
+ static readonly casesLabels: readonly ["Case__File"];
687
+ /**
688
+ * Access linked Case records
689
+ * @remarks Available labels: Case__File
690
+ * @throws Error if called on a new (unsaved) record
691
+ *
692
+ * @example
693
+ * ```typescript
694
+ * // Get all linked Case records
695
+ * const items = await record.cases.list();
696
+ * const first = await record.cases.first();
697
+ *
698
+ * // Filter by label
699
+ * const specific = await record.cases.first({ label: 'Case__File' });
700
+ * ```
701
+ */
702
+ get cases(): RecordLinkManager<CaseRecord, typeof FileRecord['casesLabels'][number]>;
703
+ /** Valid labels for Activity associations */
704
+ static readonly activitiesLabels: readonly ["Activity__File"];
705
+ /**
706
+ * Access linked Activity records
707
+ * @remarks Available labels: Activity__File
708
+ * @throws Error if called on a new (unsaved) record
709
+ *
710
+ * @example
711
+ * ```typescript
712
+ * // Get all linked Activity records
713
+ * const items = await record.activities.list();
714
+ * const first = await record.activities.first();
715
+ *
716
+ * // Filter by label
717
+ * const specific = await record.activities.first({ label: 'Activity__File' });
718
+ * ```
719
+ */
720
+ get activities(): RecordLinkManager<ActivityRecord, typeof FileRecord['activitiesLabels'][number]>;
721
+ /** Valid labels for OneTouchSwitch associations */
722
+ static readonly oneTouchSwitchesLabels: readonly ["OneTouchSwitch_File"];
723
+ /**
724
+ * Access linked OneTouchSwitch records
725
+ * @remarks Available labels: OneTouchSwitch_File
726
+ * @throws Error if called on a new (unsaved) record
727
+ *
728
+ * @example
729
+ * ```typescript
730
+ * // Get all linked OneTouchSwitch records
731
+ * const items = await record.oneTouchSwitches.list();
732
+ * const first = await record.oneTouchSwitches.first();
733
+ *
734
+ * // Filter by label
735
+ * const specific = await record.oneTouchSwitches.first({ label: 'OneTouchSwitch_File' });
736
+ * ```
737
+ */
738
+ get oneTouchSwitches(): RecordLinkManager<OneTouchSwitchRecord, typeof FileRecord['oneTouchSwitchesLabels'][number]>;
739
+ /** Valid labels for RemediationRequiredReason associations */
740
+ static readonly remediationRequiredReasonsLabels: readonly ["RemediationRequiredReason__File"];
741
+ /**
742
+ * Access linked RemediationRequiredReason records
743
+ * @remarks Available labels: RemediationRequiredReason__File
744
+ * @throws Error if called on a new (unsaved) record
745
+ *
746
+ * @example
747
+ * ```typescript
748
+ * // Get all linked RemediationRequiredReason records
749
+ * const items = await record.remediationRequiredReasons.list();
750
+ * const first = await record.remediationRequiredReasons.first();
751
+ *
752
+ * // Filter by label
753
+ * const specific = await record.remediationRequiredReasons.first({ label: 'RemediationRequiredReason__File' });
754
+ * ```
755
+ */
756
+ get remediationRequiredReasons(): RecordLinkManager<RemediationRequiredReasonRecord, typeof FileRecord['remediationRequiredReasonsLabels'][number]>;
757
+ /** Valid labels for Invoice associations */
758
+ static readonly invoicesLabels: readonly ["Invoice__File"];
759
+ /**
760
+ * Access linked Invoice records
761
+ * @remarks Available labels: Invoice__File
762
+ * @throws Error if called on a new (unsaved) record
763
+ *
764
+ * @example
765
+ * ```typescript
766
+ * // Get all linked Invoice records
767
+ * const items = await record.invoices.list();
768
+ * const first = await record.invoices.first();
769
+ *
770
+ * // Filter by label
771
+ * const specific = await record.invoices.first({ label: 'Invoice__File' });
772
+ * ```
773
+ */
774
+ get invoices(): RecordLinkManager<InvoiceRecord, typeof FileRecord['invoicesLabels'][number]>;
316
775
  /** Valid labels for Note associations */
317
- static readonly notesLabels: readonly ["File__Note"];
776
+ static readonly notesLabels: readonly ["File__Note", "Note__File"];
318
777
  /**
319
778
  * Access linked Note records
320
- * @remarks Available labels: File__Note
779
+ * @remarks Available labels: File__Note, Note__File
321
780
  * @throws Error if called on a new (unsaved) record
322
781
  *
323
782
  * @example
@@ -331,6 +790,348 @@ export declare class FileRecord<TProps = FileProperties> {
331
790
  * ```
332
791
  */
333
792
  get notes(): RecordLinkManager<NoteRecord, typeof FileRecord['notesLabels'][number]>;
793
+ /** Valid labels for Lead associations */
794
+ static readonly leadsLabels: readonly ["Lead__File"];
795
+ /**
796
+ * Access linked Lead records
797
+ * @remarks Available labels: Lead__File
798
+ * @throws Error if called on a new (unsaved) record
799
+ *
800
+ * @example
801
+ * ```typescript
802
+ * // Get all linked Lead records
803
+ * const items = await record.leads.list();
804
+ * const first = await record.leads.first();
805
+ *
806
+ * // Filter by label
807
+ * const specific = await record.leads.first({ label: 'Lead__File' });
808
+ * ```
809
+ */
810
+ get leads(): RecordLinkManager<LeadRecord, typeof FileRecord['leadsLabels'][number]>;
811
+ /** Valid labels for Account associations */
812
+ static readonly accountsLabels: readonly ["Account__File"];
813
+ /**
814
+ * Access linked Account records
815
+ * @remarks Available labels: Account__File
816
+ * @throws Error if called on a new (unsaved) record
817
+ *
818
+ * @example
819
+ * ```typescript
820
+ * // Get all linked Account records
821
+ * const items = await record.accounts.list();
822
+ * const first = await record.accounts.first();
823
+ *
824
+ * // Filter by label
825
+ * const specific = await record.accounts.first({ label: 'Account__File' });
826
+ * ```
827
+ */
828
+ get accounts(): RecordLinkManager<AccountRecord, typeof FileRecord['accountsLabels'][number]>;
829
+ /** Valid labels for PaymentMethod associations */
830
+ static readonly paymentMethodsLabels: readonly ["PaymentMethod__File"];
831
+ /**
832
+ * Access linked PaymentMethod records
833
+ * @remarks Available labels: PaymentMethod__File
834
+ * @throws Error if called on a new (unsaved) record
835
+ *
836
+ * @example
837
+ * ```typescript
838
+ * // Get all linked PaymentMethod records
839
+ * const items = await record.paymentMethods.list();
840
+ * const first = await record.paymentMethods.first();
841
+ *
842
+ * // Filter by label
843
+ * const specific = await record.paymentMethods.first({ label: 'PaymentMethod__File' });
844
+ * ```
845
+ */
846
+ get paymentMethods(): RecordLinkManager<PaymentMethodRecord, typeof FileRecord['paymentMethodsLabels'][number]>;
847
+ /** Valid labels for ContractBuyOut associations */
848
+ static readonly contractBuyOutsLabels: readonly ["ContractBuyOut__File"];
849
+ /**
850
+ * Access linked ContractBuyOut records
851
+ * @remarks Available labels: ContractBuyOut__File
852
+ * @throws Error if called on a new (unsaved) record
853
+ *
854
+ * @example
855
+ * ```typescript
856
+ * // Get all linked ContractBuyOut records
857
+ * const items = await record.contractBuyOuts.list();
858
+ * const first = await record.contractBuyOuts.first();
859
+ *
860
+ * // Filter by label
861
+ * const specific = await record.contractBuyOuts.first({ label: 'ContractBuyOut__File' });
862
+ * ```
863
+ */
864
+ get contractBuyOuts(): RecordLinkManager<ContractBuyOutRecord, typeof FileRecord['contractBuyOutsLabels'][number]>;
865
+ /** Valid labels for SiteSpecificRiskAssessmentOutcomeForm associations */
866
+ static readonly siteSpecificRiskAssessmentOutcomeFormsLabels: readonly ["SiteSpecificRiskAssessmentOutcomeForm__File"];
867
+ /**
868
+ * Access linked SiteSpecificRiskAssessmentOutcomeForm records
869
+ * @remarks Available labels: SiteSpecificRiskAssessmentOutcomeForm__File
870
+ * @throws Error if called on a new (unsaved) record
871
+ *
872
+ * @example
873
+ * ```typescript
874
+ * // Get all linked SiteSpecificRiskAssessmentOutcomeForm records
875
+ * const items = await record.siteSpecificRiskAssessmentOutcomeForms.list();
876
+ * const first = await record.siteSpecificRiskAssessmentOutcomeForms.first();
877
+ *
878
+ * // Filter by label
879
+ * const specific = await record.siteSpecificRiskAssessmentOutcomeForms.first({ label: 'SiteSpecificRiskAssessmentOutcomeForm__File' });
880
+ * ```
881
+ */
882
+ get siteSpecificRiskAssessmentOutcomeForms(): RecordLinkManager<SiteSpecificRiskAssessmentOutcomeFormRecord, typeof FileRecord['siteSpecificRiskAssessmentOutcomeFormsLabels'][number]>;
883
+ /** Valid labels for RemediationOutcomeForm associations */
884
+ static readonly remediationOutcomeFormsLabels: readonly ["RemediationOutcomeForm_File"];
885
+ /**
886
+ * Access linked RemediationOutcomeForm records
887
+ * @remarks Available labels: RemediationOutcomeForm_File
888
+ * @throws Error if called on a new (unsaved) record
889
+ *
890
+ * @example
891
+ * ```typescript
892
+ * // Get all linked RemediationOutcomeForm records
893
+ * const items = await record.remediationOutcomeForms.list();
894
+ * const first = await record.remediationOutcomeForms.first();
895
+ *
896
+ * // Filter by label
897
+ * const specific = await record.remediationOutcomeForms.first({ label: 'RemediationOutcomeForm_File' });
898
+ * ```
899
+ */
900
+ get remediationOutcomeForms(): RecordLinkManager<RemediationOutcomeFormRecord, typeof FileRecord['remediationOutcomeFormsLabels'][number]>;
901
+ /** Valid labels for Order associations */
902
+ static readonly ordersLabels: readonly ["Order__File"];
903
+ /**
904
+ * Access linked Order records
905
+ * @remarks Available labels: Order__File
906
+ * @throws Error if called on a new (unsaved) record
907
+ *
908
+ * @example
909
+ * ```typescript
910
+ * // Get all linked Order records
911
+ * const items = await record.orders.list();
912
+ * const first = await record.orders.first();
913
+ *
914
+ * // Filter by label
915
+ * const specific = await record.orders.first({ label: 'Order__File' });
916
+ * ```
917
+ */
918
+ get orders(): RecordLinkManager<OrderRecord, typeof FileRecord['ordersLabels'][number]>;
919
+ /** Valid labels for Call associations */
920
+ static readonly callsLabels: readonly ["Call__File"];
921
+ /**
922
+ * Access linked Call records
923
+ * @remarks Available labels: Call__File
924
+ * @throws Error if called on a new (unsaved) record
925
+ *
926
+ * @example
927
+ * ```typescript
928
+ * // Get all linked Call records
929
+ * const items = await record.calls.list();
930
+ * const first = await record.calls.first();
931
+ *
932
+ * // Filter by label
933
+ * const specific = await record.calls.first({ label: 'Call__File' });
934
+ * ```
935
+ */
936
+ get calls(): RecordLinkManager<CallRecord, typeof FileRecord['callsLabels'][number]>;
937
+ /** Valid labels for OhExternalAudit associations */
938
+ static readonly ohExternalAuditsLabels: readonly ["OhExternalAudit_File"];
939
+ /**
940
+ * Access linked OhExternalAudit records
941
+ * @remarks Available labels: OhExternalAudit_File
942
+ * @throws Error if called on a new (unsaved) record
943
+ *
944
+ * @example
945
+ * ```typescript
946
+ * // Get all linked OhExternalAudit records
947
+ * const items = await record.ohExternalAudits.list();
948
+ * const first = await record.ohExternalAudits.first();
949
+ *
950
+ * // Filter by label
951
+ * const specific = await record.ohExternalAudits.first({ label: 'OhExternalAudit_File' });
952
+ * ```
953
+ */
954
+ get ohExternalAudits(): RecordLinkManager<OhExternalAuditRecord, typeof FileRecord['ohExternalAuditsLabels'][number]>;
955
+ /** Valid labels for CustomerDeviceOnt associations */
956
+ static readonly customerDeviceOntsLabels: readonly ["CustomerDeviceOnt__File"];
957
+ /**
958
+ * Access linked CustomerDeviceOnt records
959
+ * @remarks Available labels: CustomerDeviceOnt__File
960
+ * @throws Error if called on a new (unsaved) record
961
+ *
962
+ * @example
963
+ * ```typescript
964
+ * // Get all linked CustomerDeviceOnt records
965
+ * const items = await record.customerDeviceOnts.list();
966
+ * const first = await record.customerDeviceOnts.first();
967
+ *
968
+ * // Filter by label
969
+ * const specific = await record.customerDeviceOnts.first({ label: 'CustomerDeviceOnt__File' });
970
+ * ```
971
+ */
972
+ get customerDeviceOnts(): RecordLinkManager<CustomerDeviceOntRecord, typeof FileRecord['customerDeviceOntsLabels'][number]>;
973
+ /** Valid labels for BillingAdjustment associations */
974
+ static readonly billingAdjustmentsLabels: readonly ["BillingAdjustment__File"];
975
+ /**
976
+ * Access linked BillingAdjustment records
977
+ * @remarks Available labels: BillingAdjustment__File
978
+ * @throws Error if called on a new (unsaved) record
979
+ *
980
+ * @example
981
+ * ```typescript
982
+ * // Get all linked BillingAdjustment records
983
+ * const items = await record.billingAdjustments.list();
984
+ * const first = await record.billingAdjustments.first();
985
+ *
986
+ * // Filter by label
987
+ * const specific = await record.billingAdjustments.first({ label: 'BillingAdjustment__File' });
988
+ * ```
989
+ */
990
+ get billingAdjustments(): RecordLinkManager<BillingAdjustmentRecord, typeof FileRecord['billingAdjustmentsLabels'][number]>;
991
+ /** Valid labels for Contact associations */
992
+ static readonly contactsLabels: readonly ["Contact__File"];
993
+ /**
994
+ * Access linked Contact records
995
+ * @remarks Available labels: Contact__File
996
+ * @throws Error if called on a new (unsaved) record
997
+ *
998
+ * @example
999
+ * ```typescript
1000
+ * // Get all linked Contact records
1001
+ * const items = await record.contacts.list();
1002
+ * const first = await record.contacts.first();
1003
+ *
1004
+ * // Filter by label
1005
+ * const specific = await record.contacts.first({ label: 'Contact__File' });
1006
+ * ```
1007
+ */
1008
+ get contacts(): RecordLinkManager<ContactRecord, typeof FileRecord['contactsLabels'][number]>;
1009
+ /** Valid labels for Message associations */
1010
+ static readonly messagesLabels: readonly ["Message_File"];
1011
+ /**
1012
+ * Access linked Message records
1013
+ * @remarks Available labels: Message_File
1014
+ * @throws Error if called on a new (unsaved) record
1015
+ *
1016
+ * @example
1017
+ * ```typescript
1018
+ * // Get all linked Message records
1019
+ * const items = await record.messages.list();
1020
+ * const first = await record.messages.first();
1021
+ *
1022
+ * // Filter by label
1023
+ * const specific = await record.messages.first({ label: 'Message_File' });
1024
+ * ```
1025
+ */
1026
+ get messages(): RecordLinkManager<MessageRecord, typeof FileRecord['messagesLabels'][number]>;
1027
+ /** Valid labels for Email associations */
1028
+ static readonly emailsLabels: readonly ["Attachments"];
1029
+ /**
1030
+ * Access linked Email records
1031
+ * @remarks Available labels: Attachments
1032
+ * @throws Error if called on a new (unsaved) record
1033
+ *
1034
+ * @example
1035
+ * ```typescript
1036
+ * // Get all linked Email records
1037
+ * const items = await record.emails.list();
1038
+ * const first = await record.emails.first();
1039
+ *
1040
+ * // Filter by label
1041
+ * const specific = await record.emails.first({ label: 'Attachments' });
1042
+ * ```
1043
+ */
1044
+ get emails(): RecordLinkManager<EmailRecord, typeof FileRecord['emailsLabels'][number]>;
1045
+ /** Valid labels for PgDirectDebitFile associations */
1046
+ static readonly pgDirectDebitFilesLabels: readonly ["PgDirectDebitFile__File"];
1047
+ /**
1048
+ * Access linked PgDirectDebitFile records
1049
+ * @remarks Available labels: PgDirectDebitFile__File
1050
+ * @throws Error if called on a new (unsaved) record
1051
+ *
1052
+ * @example
1053
+ * ```typescript
1054
+ * // Get all linked PgDirectDebitFile records
1055
+ * const items = await record.pgDirectDebitFiles.list();
1056
+ * const first = await record.pgDirectDebitFiles.first();
1057
+ *
1058
+ * // Filter by label
1059
+ * const specific = await record.pgDirectDebitFiles.first({ label: 'PgDirectDebitFile__File' });
1060
+ * ```
1061
+ */
1062
+ get pgDirectDebitFiles(): RecordLinkManager<PgDirectDebitFileRecord, typeof FileRecord['pgDirectDebitFilesLabels'][number]>;
1063
+ /** Valid labels for YfWifiSurvey associations */
1064
+ static readonly yfWifiSurveysLabels: readonly ["YfWifiSurvey__File"];
1065
+ /**
1066
+ * Access linked YfWifiSurvey records
1067
+ * @remarks Available labels: YfWifiSurvey__File
1068
+ * @throws Error if called on a new (unsaved) record
1069
+ *
1070
+ * @example
1071
+ * ```typescript
1072
+ * // Get all linked YfWifiSurvey records
1073
+ * const items = await record.yfWifiSurveys.list();
1074
+ * const first = await record.yfWifiSurveys.first();
1075
+ *
1076
+ * // Filter by label
1077
+ * const specific = await record.yfWifiSurveys.first({ label: 'YfWifiSurvey__File' });
1078
+ * ```
1079
+ */
1080
+ get yfWifiSurveys(): RecordLinkManager<YfWifiSurveyRecord, typeof FileRecord['yfWifiSurveysLabels'][number]>;
1081
+ /** Valid labels for YfFieldVisitOutcomeForm associations */
1082
+ static readonly yfFieldVisitOutcomeFormsLabels: readonly ["YfFieldVisitOutcomeForm__File"];
1083
+ /**
1084
+ * Access linked YfFieldVisitOutcomeForm records
1085
+ * @remarks Available labels: YfFieldVisitOutcomeForm__File
1086
+ * @throws Error if called on a new (unsaved) record
1087
+ *
1088
+ * @example
1089
+ * ```typescript
1090
+ * // Get all linked YfFieldVisitOutcomeForm records
1091
+ * const items = await record.yfFieldVisitOutcomeForms.list();
1092
+ * const first = await record.yfFieldVisitOutcomeForms.first();
1093
+ *
1094
+ * // Filter by label
1095
+ * const specific = await record.yfFieldVisitOutcomeForms.first({ label: 'YfFieldVisitOutcomeForm__File' });
1096
+ * ```
1097
+ */
1098
+ get yfFieldVisitOutcomeForms(): RecordLinkManager<YfFieldVisitOutcomeFormRecord, typeof FileRecord['yfFieldVisitOutcomeFormsLabels'][number]>;
1099
+ /** Valid labels for Document associations */
1100
+ static readonly documentsLabels: readonly ["Document__File"];
1101
+ /**
1102
+ * Access linked Document records
1103
+ * @remarks Available labels: Document__File
1104
+ * @throws Error if called on a new (unsaved) record
1105
+ *
1106
+ * @example
1107
+ * ```typescript
1108
+ * // Get all linked Document records
1109
+ * const items = await record.documents.list();
1110
+ * const first = await record.documents.first();
1111
+ *
1112
+ * // Filter by label
1113
+ * const specific = await record.documents.first({ label: 'Document__File' });
1114
+ * ```
1115
+ */
1116
+ get documents(): RecordLinkManager<DocumentRecord, typeof FileRecord['documentsLabels'][number]>;
1117
+ /** Valid labels for DocumentProcessing associations */
1118
+ static readonly documentProcessingsLabels: readonly ["DocumentProcessing__File"];
1119
+ /**
1120
+ * Access linked DocumentProcessing records
1121
+ * @remarks Available labels: DocumentProcessing__File
1122
+ * @throws Error if called on a new (unsaved) record
1123
+ *
1124
+ * @example
1125
+ * ```typescript
1126
+ * // Get all linked DocumentProcessing records
1127
+ * const items = await record.documentProcessings.list();
1128
+ * const first = await record.documentProcessings.first();
1129
+ *
1130
+ * // Filter by label
1131
+ * const specific = await record.documentProcessings.first({ label: 'DocumentProcessing__File' });
1132
+ * ```
1133
+ */
1134
+ get documentProcessings(): RecordLinkManager<DocumentProcessingRecord, typeof FileRecord['documentProcessingsLabels'][number]>;
334
1135
  /**
335
1136
  * Queue a link to be created with the next action.
336
1137
  * Works for both create and update actions.