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

package/dist/records-v2/PgDirectDebitFileRecord.js

@@ -14,6 +14,8 @@
  * await record.createPgDirectDebitFile({ ... }).execute();
  * ```
  *
+ * Entity Types: DEFAULT, RESPONSE, SUBMISSION
+ *
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
@@ -29,6 +31,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isPgDirectDebitFileRecord = exports.PgDirectDebitFileRecord = 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 FileRecord_1 = require("./FileRecord");
+const PgFileAllocationRecord_1 = require("./PgFileAllocationRecord");
 /**
  * Builder for action execution with dryRun support
  *
@@ -140,6 +145,117 @@ class PgDirectDebitFileRecord {
     /** 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 PgDirectDebitFileProperties
+     *   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'; }
+    /**
+     * Type guard: check if this record is of type RESPONSE
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to RESPONSE-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isResponse()) {
+     *   // TypeScript knows record.properties is ResponsePgDirectDebitFileProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Files received from HSBC
+     */
+    isResponse() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'RESPONSE'; }
+    /**
+     * Type guard: check if this record is of type SUBMISSION
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to SUBMISSION-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isSubmission()) {
+     *   // TypeScript knows record.properties is SubmissionPgDirectDebitFileProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Files submitted to HSBC
+     */
+    isSubmission() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'SUBMISSION'; }
+    /**
+     * Access linked File records
+     * @remarks Available labels: PgDirectDebitFile__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: 'PgDirectDebitFile__File' });
+     * ```
+     */
+    get files() {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('Cannot access links on a new (unsaved) record');
+        if (!this._files) {
+            this._files = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'BillingModule:PgDirectDebitFile',
+                targetEntity: 'SchemaModule:File',
+                targetModuleName: 'SchemaModule',
+                targetEntityName: 'File',
+                labels: ['PgDirectDebitFile__File'],
+            }, FileRecord_1.FileRecord);
+        }
+        return this._files;
+    }
+    /**
+     * Access linked PgFileAllocation records
+     * @remarks Available labels: PgDirectDebitFile__PgFileAllocation
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked PgFileAllocation records
+     * const items = await record.pgFileAllocations.list();
+     * const first = await record.pgFileAllocations.first();
+     *
+     * // Filter by label
+     * const specific = await record.pgFileAllocations.first({ label: 'PgDirectDebitFile__PgFileAllocation' });
+     * ```
+     */
+    get pgFileAllocations() {
+        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._pgFileAllocations) {
+            this._pgFileAllocations = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'BillingModule:PgDirectDebitFile',
+                targetEntity: 'BillingModule:PgFileAllocation',
+                targetModuleName: 'BillingModule',
+                targetEntityName: 'PgFileAllocation',
+                labels: ['PgDirectDebitFile__PgFileAllocation'],
+            }, PgFileAllocationRecord_1.PgFileAllocationRecord);
+        }
+        return this._pgFileAllocations;
+    }
+    // ============================================
     // LINK MANAGEMENT
     // ============================================
     /**
@@ -705,6 +821,13 @@ class PgDirectDebitFileRecord {
     }
 }
 exports.PgDirectDebitFileRecord = PgDirectDebitFileRecord;
+// ============================================
+// TYPED LINK ACCESSORS
+// ============================================
+/** Valid labels for File associations */
+PgDirectDebitFileRecord.filesLabels = ['PgDirectDebitFile__File'];
+/** Valid labels for PgFileAllocation associations */
+PgDirectDebitFileRecord.pgFileAllocationsLabels = ['PgDirectDebitFile__PgFileAllocation'];
 /** Type guard to check if an object is a PgDirectDebitFileRecord */
 function isPgDirectDebitFileRecord(obj) {
     return obj instanceof PgDirectDebitFileRecord;

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

@@ -13,14 +13,21 @@
  * await record.createPgDispute({ ... }).execute();
  * ```
  *
+ * Entity Types: DEFAULT
+ *
  * 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 { PgDisputeProperties } from '../entities-v2/PgDispute';
 import { CreatePgDisputeProperties } from '../actions-v2/CreatePgDisputeDto';
+import { PgWebhookRecord } from './PgWebhookRecord';
+import { PgTransactionRecord } from './PgTransactionRecord';
+/** Valid entity types for PgDispute */
+export declare type PgDisputeType = 'DEFAULT';
 /**
  * Builder for action execution with dryRun support
  *
@@ -84,6 +91,8 @@ export declare class PgDisputeRecord<TProps = PgDisputeProperties> {
     private _provider;
     private _pendingLinks;
     private _preGeneratedId;
+    private _pgWebhooks?;
+    private _pgTransactions?;
     /**
      * Create a record wrapper.
      * @param record - The underlying record, or null for create operations
@@ -96,7 +105,7 @@ export declare class PgDisputeRecord<TProps = PgDisputeProperties> {
     /** Record ID - always available (pre-generated for new records) */
     get id(): string;
     get entity(): string;
-    get type(): string | undefined;
+    get type(): PgDisputeType | undefined;
     /** Record properties - empty object for new (unsaved) records */
     get properties(): TProps;
     get title(): string | undefined;
@@ -109,6 +118,58 @@ export declare class PgDisputeRecord<TProps = PgDisputeProperties> {
     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 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 PgDisputeProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks This is the default record type
+     */
+    isDefault(): this is PgDisputeRecord<PgDisputeProperties>;
+    /** Valid labels for PgWebhook associations */
+    static readonly pgWebhooksLabels: readonly ["PgDispute__PgWebhook"];
+    /**
+     * Access linked PgWebhook records
+     * @remarks Available labels: PgDispute__PgWebhook
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked PgWebhook records
+     * const items = await record.pgWebhooks.list();
+     * const first = await record.pgWebhooks.first();
+     *
+     * // Filter by label
+     * const specific = await record.pgWebhooks.first({ label: 'PgDispute__PgWebhook' });
+     * ```
+     */
+    get pgWebhooks(): RecordLinkManager<PgWebhookRecord, typeof PgDisputeRecord['pgWebhooksLabels'][number]>;
+    /** Valid labels for PgTransaction associations */
+    static readonly pgTransactionsLabels: readonly ["PgTransaction__PgDispute"];
+    /**
+     * Access linked PgTransaction records
+     * @remarks Available labels: PgTransaction__PgDispute
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked PgTransaction records
+     * const items = await record.pgTransactions.list();
+     * const first = await record.pgTransactions.first();
+     *
+     * // Filter by label
+     * const specific = await record.pgTransactions.first({ label: 'PgTransaction__PgDispute' });
+     * ```
+     */
+    get pgTransactions(): RecordLinkManager<PgTransactionRecord, typeof PgDisputeRecord['pgTransactionsLabels'][number]>;
     /**
      * Queue a link to be created with the next action.
      * Works for both create and update actions.

package/dist/records-v2/PgDisputeRecord.js

@@ -14,6 +14,8 @@
  * await record.createPgDispute({ ... }).execute();
  * ```
  *
+ * Entity Types: DEFAULT
+ *
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
@@ -29,6 +31,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isPgDisputeRecord = exports.PgDisputeRecord = 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 PgWebhookRecord_1 = require("./PgWebhookRecord");
+const PgTransactionRecord_1 = require("./PgTransactionRecord");
 /**
  * Builder for action execution with dryRun support
  *
@@ -140,6 +145,85 @@ class PgDisputeRecord {
     /** 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 PgDisputeProperties
+     *   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 PgWebhook records
+     * @remarks Available labels: PgDispute__PgWebhook
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked PgWebhook records
+     * const items = await record.pgWebhooks.list();
+     * const first = await record.pgWebhooks.first();
+     *
+     * // Filter by label
+     * const specific = await record.pgWebhooks.first({ label: 'PgDispute__PgWebhook' });
+     * ```
+     */
+    get pgWebhooks() {
+        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._pgWebhooks) {
+            this._pgWebhooks = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'BillingModule:PgDispute',
+                targetEntity: 'AuditModule:PgWebhook',
+                targetModuleName: 'AuditModule',
+                targetEntityName: 'PgWebhook',
+                labels: ['PgDispute__PgWebhook'],
+            }, PgWebhookRecord_1.PgWebhookRecord);
+        }
+        return this._pgWebhooks;
+    }
+    /**
+     * Access linked PgTransaction records
+     * @remarks Available labels: PgTransaction__PgDispute
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked PgTransaction records
+     * const items = await record.pgTransactions.list();
+     * const first = await record.pgTransactions.first();
+     *
+     * // Filter by label
+     * const specific = await record.pgTransactions.first({ label: 'PgTransaction__PgDispute' });
+     * ```
+     */
+    get pgTransactions() {
+        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._pgTransactions) {
+            this._pgTransactions = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'BillingModule:PgDispute',
+                targetEntity: 'BillingModule:PgTransaction',
+                targetModuleName: 'BillingModule',
+                targetEntityName: 'PgTransaction',
+                labels: ['PgTransaction__PgDispute'],
+            }, PgTransactionRecord_1.PgTransactionRecord);
+        }
+        return this._pgTransactions;
+    }
+    // ============================================
     // LINK MANAGEMENT
     // ============================================
     /**
@@ -334,6 +418,13 @@ class PgDisputeRecord {
     }
 }
 exports.PgDisputeRecord = PgDisputeRecord;
+// ============================================
+// TYPED LINK ACCESSORS
+// ============================================
+/** Valid labels for PgWebhook associations */
+PgDisputeRecord.pgWebhooksLabels = ['PgDispute__PgWebhook'];
+/** Valid labels for PgTransaction associations */
+PgDisputeRecord.pgTransactionsLabels = ['PgTransaction__PgDispute'];
 /** Type guard to check if an object is a PgDisputeRecord */
 function isPgDisputeRecord(obj) {
     return obj instanceof PgDisputeRecord;

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

@@ -13,19 +13,27 @@
  * await record.createPgFileAllocation({ ... }).execute();
  * ```
  *
+ * Entity Types: DEFAULT, REPORT, SUBMISSION
+ *
  * 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 { PgFileAllocationProperties } from '../entities-v2/PgFileAllocation';
+import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
+import { PgFileAllocationProperties, ReportPgFileAllocationProperties, SubmissionPgFileAllocationProperties } from '../entities-v2/PgFileAllocation';
 import { CreateAuddisPgSubmissionAllocationProperties } from '../actions-v2/CreateAuddisPgSubmissionAllocationDto';
 import { CreateBacsPgSubmissionAllocationProperties } from '../actions-v2/CreateBacsPgSubmissionAllocationDto';
 import { UpdatePgAllocationWithAcknowledgementOneProperties } from '../actions-v2/UpdatePgAllocationWithAcknowledgementOneDto';
 import { UpdatePgAllocationWithAcknowledgementTwoProperties } from '../actions-v2/UpdatePgAllocationWithAcknowledgementTwoDto';
 import { UpdatePgAllocationWithBacsReportProperties } from '../actions-v2/UpdatePgAllocationWithBacsReportDto';
 import { UpdatePgFileAllocationProperties } from '../actions-v2/UpdatePgFileAllocationDto';
+import { PgDirectDebitFileRecord } from './PgDirectDebitFileRecord';
+import { PgPaymentMethodRecord } from './PgPaymentMethodRecord';
+import { PgTransactionRecord } from './PgTransactionRecord';
+/** Valid entity types for PgFileAllocation */
+export declare type PgFileAllocationType = 'DEFAULT' | 'REPORT' | 'SUBMISSION';
 /**
  * Builder for action execution with dryRun support
  *
@@ -89,6 +97,9 @@ export declare class PgFileAllocationRecord<TProps = PgFileAllocationProperties>
     private _provider;
     private _pendingLinks;
     private _preGeneratedId;
+    private _pgDirectDebitFiles?;
+    private _pgPaymentMethods?;
+    private _pgTransactions?;
     /**
      * Create a record wrapper.
      * @param record - The underlying record, or null for create operations
@@ -101,7 +112,7 @@ export declare class PgFileAllocationRecord<TProps = PgFileAllocationProperties>
     /** Record ID - always available (pre-generated for new records) */
     get id(): string;
     get entity(): string;
-    get type(): string | undefined;
+    get type(): PgFileAllocationType | undefined;
     /** Record properties - empty object for new (unsaved) records */
     get properties(): TProps;
     get title(): string | undefined;
@@ -114,6 +125,108 @@ export declare class PgFileAllocationRecord<TProps = PgFileAllocationProperties>
     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 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 PgFileAllocationProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks This is the default record type
+     */
+    isDefault(): this is PgFileAllocationRecord<PgFileAllocationProperties>;
+    /**
+     * Type guard: check if this record is of type REPORT
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to REPORT-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isReport()) {
+     *   // TypeScript knows record.properties is ReportPgFileAllocationProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Report
+     */
+    isReport(): this is PgFileAllocationRecord<ReportPgFileAllocationProperties>;
+    /**
+     * Type guard: check if this record is of type SUBMISSION
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to SUBMISSION-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isSubmission()) {
+     *   // TypeScript knows record.properties is SubmissionPgFileAllocationProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Submission
+     */
+    isSubmission(): this is PgFileAllocationRecord<SubmissionPgFileAllocationProperties>;
+    /** Valid labels for PgDirectDebitFile associations */
+    static readonly pgDirectDebitFilesLabels: readonly ["PgDirectDebitFile__PgFileAllocation"];
+    /**
+     * Access linked PgDirectDebitFile records
+     * @remarks Available labels: PgDirectDebitFile__PgFileAllocation
+     * @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__PgFileAllocation' });
+     * ```
+     */
+    get pgDirectDebitFiles(): RecordLinkManager<PgDirectDebitFileRecord, typeof PgFileAllocationRecord['pgDirectDebitFilesLabels'][number]>;
+    /** Valid labels for PgPaymentMethod associations */
+    static readonly pgPaymentMethodsLabels: readonly ["PgPaymentMethod__PgFileAllocation"];
+    /**
+     * Access linked PgPaymentMethod records
+     * @remarks Available labels: PgPaymentMethod__PgFileAllocation
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked PgPaymentMethod records
+     * const items = await record.pgPaymentMethods.list();
+     * const first = await record.pgPaymentMethods.first();
+     *
+     * // Filter by label
+     * const specific = await record.pgPaymentMethods.first({ label: 'PgPaymentMethod__PgFileAllocation' });
+     * ```
+     */
+    get pgPaymentMethods(): RecordLinkManager<PgPaymentMethodRecord, typeof PgFileAllocationRecord['pgPaymentMethodsLabels'][number]>;
+    /** Valid labels for PgTransaction associations */
+    static readonly pgTransactionsLabels: readonly ["PgTransaction__PgFileAllocation"];
+    /**
+     * Access linked PgTransaction records
+     * @remarks Available labels: PgTransaction__PgFileAllocation
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked PgTransaction records
+     * const items = await record.pgTransactions.list();
+     * const first = await record.pgTransactions.first();
+     *
+     * // Filter by label
+     * const specific = await record.pgTransactions.first({ label: 'PgTransaction__PgFileAllocation' });
+     * ```
+     */
+    get pgTransactions(): RecordLinkManager<PgTransactionRecord, typeof PgFileAllocationRecord['pgTransactionsLabels'][number]>;
     /**
      * Queue a link to be created with the next action.
      * Works for both create and update actions.