@d19n/youfibre-odin-sdk 2.0.229 → 2.0.231

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

@@ -34,6 +34,7 @@ import { UpdatePgSubmissionProperties } from '../actions-v2/UpdatePgSubmissionDt
 import { FileRecord } from './FileRecord';
 import { PgFileAllocationRecord } from './PgFileAllocationRecord';
 import { PgDisputeRecord } from './PgDisputeRecord';
+import { PgReportEventRecord } from './PgReportEventRecord';
 /** Valid entity types for PgDirectDebitFile */
 export declare type PgDirectDebitFileType = 'DEFAULT' | 'RESPONSE' | 'SUBMISSION';
 /**
@@ -102,6 +103,7 @@ export declare class PgDirectDebitFileRecord<TProps = PgDirectDebitFilePropertie
     private _files?;
     private _pgFileAllocations?;
     private _pgDisputes?;
+    private _pgReportEvents?;
     /**
      * Create a record wrapper.
      * @param record - The underlying record, or null for create operations
@@ -229,6 +231,24 @@ export declare class PgDirectDebitFileRecord<TProps = PgDirectDebitFilePropertie
      * ```
      */
     get pgDisputes(): RecordLinkManager<PgDisputeRecord, typeof PgDirectDebitFileRecord['pgDisputesLabels'][number]>;
+    /** Valid labels for PgReportEvent associations */
+    static readonly pgReportEventsLabels: readonly ["PgDirectDebitFile__PgReportEvent"];
+    /**
+     * Access linked PgReportEvent records
+     * @remarks Available labels: PgDirectDebitFile__PgReportEvent
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked PgReportEvent records
+     * const items = await record.pgReportEvents.list();
+     * const first = await record.pgReportEvents.first();
+     *
+     * // Filter by label
+     * const specific = await record.pgReportEvents.first({ label: 'PgDirectDebitFile__PgReportEvent' });
+     * ```
+     */
+    get pgReportEvents(): RecordLinkManager<PgReportEventRecord, typeof PgDirectDebitFileRecord['pgReportEventsLabels'][number]>;
     /**
      * Queue a link to be created with the next action.
      * Works for both create and update actions.

package/dist/records-v2/PgDirectDebitFileRecord.js

@@ -35,6 +35,7 @@ const record_link_manager_1 = require("@d19n/odin-sdk-generator/dist/record-link
 const FileRecord_1 = require("./FileRecord");
 const PgFileAllocationRecord_1 = require("./PgFileAllocationRecord");
 const PgDisputeRecord_1 = require("./PgDisputeRecord");
+const PgReportEventRecord_1 = require("./PgReportEventRecord");
 /**
  * Builder for action execution with dryRun support
  *
@@ -286,6 +287,36 @@ class PgDirectDebitFileRecord {
         }
         return this._pgDisputes;
     }
+    /**
+     * Access linked PgReportEvent records
+     * @remarks Available labels: PgDirectDebitFile__PgReportEvent
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked PgReportEvent records
+     * const items = await record.pgReportEvents.list();
+     * const first = await record.pgReportEvents.first();
+     *
+     * // Filter by label
+     * const specific = await record.pgReportEvents.first({ label: 'PgDirectDebitFile__PgReportEvent' });
+     * ```
+     */
+    get pgReportEvents() {
+        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._pgReportEvents) {
+            this._pgReportEvents = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'BillingModule:PgDirectDebitFile',
+                targetEntity: 'BillingModule:PgReportEvent',
+                targetModuleName: 'BillingModule',
+                targetEntityName: 'PgReportEvent',
+                labels: ['PgDirectDebitFile__PgReportEvent'],
+            }, PgReportEventRecord_1.PgReportEventRecord);
+        }
+        return this._pgReportEvents;
+    }
     // ============================================
     // LINK MANAGEMENT
     // ============================================
@@ -948,6 +979,8 @@ PgDirectDebitFileRecord.filesLabels = ['PgDirectDebitFile__File'];
 PgDirectDebitFileRecord.pgFileAllocationsLabels = ['PgDirectDebitFile__PgFileAllocation'];
 /** Valid labels for PgDispute associations */
 PgDirectDebitFileRecord.pgDisputesLabels = ['PgDirectDebitFile__PgDispute'];
+/** Valid labels for PgReportEvent associations */
+PgDirectDebitFileRecord.pgReportEventsLabels = ['PgDirectDebitFile__PgReportEvent'];
 /** Type guard to check if an object is a PgDirectDebitFileRecord */
 function isPgDirectDebitFileRecord(obj) {
     return obj instanceof PgDirectDebitFileRecord;

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

@@ -34,6 +34,7 @@ import { PgTransactionRecord } from './PgTransactionRecord';
 import { PgWebhookRecord } from './PgWebhookRecord';
 import { PgContactRecord } from './PgContactRecord';
 import { PgFileAllocationRecord } from './PgFileAllocationRecord';
+import { PgReportEventRecord } from './PgReportEventRecord';
 /** Valid entity types for PgPaymentMethod */
 export declare type PgPaymentMethodType = 'DEFAULT';
 /**
@@ -103,6 +104,7 @@ export declare class PgPaymentMethodRecord<TProps = PgPaymentMethodProperties> {
     private _pgWebhooks?;
     private _pgContacts?;
     private _pgFileAllocations?;
+    private _pgReportEvents?;
     /**
      * Create a record wrapper.
      * @param record - The underlying record, or null for create operations
@@ -216,6 +218,24 @@ export declare class PgPaymentMethodRecord<TProps = PgPaymentMethodProperties> {
      * ```
      */
     get pgFileAllocations(): RecordLinkManager<PgFileAllocationRecord, typeof PgPaymentMethodRecord['pgFileAllocationsLabels'][number]>;
+    /** Valid labels for PgReportEvent associations */
+    static readonly pgReportEventsLabels: readonly ["PgPaymentMethod__PgReportEvent"];
+    /**
+     * Access linked PgReportEvent records
+     * @remarks Available labels: PgPaymentMethod__PgReportEvent
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked PgReportEvent records
+     * const items = await record.pgReportEvents.list();
+     * const first = await record.pgReportEvents.first();
+     *
+     * // Filter by label
+     * const specific = await record.pgReportEvents.first({ label: 'PgPaymentMethod__PgReportEvent' });
+     * ```
+     */
+    get pgReportEvents(): RecordLinkManager<PgReportEventRecord, typeof PgPaymentMethodRecord['pgReportEventsLabels'][number]>;
     /**
      * Queue a link to be created with the next action.
      * Works for both create and update actions.

package/dist/records-v2/PgPaymentMethodRecord.js

@@ -36,6 +36,7 @@ const PgTransactionRecord_1 = require("./PgTransactionRecord");
 const PgWebhookRecord_1 = require("./PgWebhookRecord");
 const PgContactRecord_1 = require("./PgContactRecord");
 const PgFileAllocationRecord_1 = require("./PgFileAllocationRecord");
+const PgReportEventRecord_1 = require("./PgReportEventRecord");
 /**
  * Builder for action execution with dryRun support
  *
@@ -285,6 +286,36 @@ class PgPaymentMethodRecord {
         }
         return this._pgFileAllocations;
     }
+    /**
+     * Access linked PgReportEvent records
+     * @remarks Available labels: PgPaymentMethod__PgReportEvent
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked PgReportEvent records
+     * const items = await record.pgReportEvents.list();
+     * const first = await record.pgReportEvents.first();
+     *
+     * // Filter by label
+     * const specific = await record.pgReportEvents.first({ label: 'PgPaymentMethod__PgReportEvent' });
+     * ```
+     */
+    get pgReportEvents() {
+        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._pgReportEvents) {
+            this._pgReportEvents = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'BillingModule:PgPaymentMethod',
+                targetEntity: 'BillingModule:PgReportEvent',
+                targetModuleName: 'BillingModule',
+                targetEntityName: 'PgReportEvent',
+                labels: ['PgPaymentMethod__PgReportEvent'],
+            }, PgReportEventRecord_1.PgReportEventRecord);
+        }
+        return this._pgReportEvents;
+    }
     // ============================================
     // LINK MANAGEMENT
     // ============================================
@@ -971,6 +1002,8 @@ PgPaymentMethodRecord.pgWebhooksLabels = ['PgPaymentMethod__PgWebhook'];
 PgPaymentMethodRecord.pgContactsLabels = ['PgContact__PgPaymentMethod'];
 /** Valid labels for PgFileAllocation associations */
 PgPaymentMethodRecord.pgFileAllocationsLabels = ['PgPaymentMethod__PgFileAllocation'];
+/** Valid labels for PgReportEvent associations */
+PgPaymentMethodRecord.pgReportEventsLabels = ['PgPaymentMethod__PgReportEvent'];
 /** Type guard to check if an object is a PgPaymentMethodRecord */
 function isPgPaymentMethodRecord(obj) {
     return obj instanceof PgPaymentMethodRecord;

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

@@ -0,0 +1,347 @@
+/**
+ * PgReportEvent 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.pgReportEvents.new();
+ * await record.createPgReportEvent({ ... }).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 { PgReportEventProperties } from '../entities-v2/PgReportEvent';
+import { CreatePgReportEventProperties } from '../actions-v2/CreatePgReportEventDto';
+import { UpdatePgReportEventProperties } from '../actions-v2/UpdatePgReportEventDto';
+import { PgDirectDebitFileRecord } from './PgDirectDebitFileRecord';
+import { PgPaymentMethodRecord } from './PgPaymentMethodRecord';
+import { PgTransactionRecord } from './PgTransactionRecord';
+/** Valid entity types for PgReportEvent */
+export declare type PgReportEventType = 'DEFAULT';
+/**
+ * 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 PgReportEventRecord<TProps = PgReportEventProperties> {
+    private _record;
+    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
+     * @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(): PgReportEventType | 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 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 PgReportEventProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks This is the default record type
+     */
+    isDefault(): this is PgReportEventRecord<PgReportEventProperties>;
+    /** Valid labels for PgDirectDebitFile associations */
+    static readonly pgDirectDebitFilesLabels: readonly ["PgDirectDebitFile__PgReportEvent"];
+    /**
+     * Access linked PgDirectDebitFile records
+     * @remarks Available labels: PgDirectDebitFile__PgReportEvent
+     * @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__PgReportEvent' });
+     * ```
+     */
+    get pgDirectDebitFiles(): RecordLinkManager<PgDirectDebitFileRecord, typeof PgReportEventRecord['pgDirectDebitFilesLabels'][number]>;
+    /** Valid labels for PgPaymentMethod associations */
+    static readonly pgPaymentMethodsLabels: readonly ["PgPaymentMethod__PgReportEvent"];
+    /**
+     * Access linked PgPaymentMethod records
+     * @remarks Available labels: PgPaymentMethod__PgReportEvent
+     * @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__PgReportEvent' });
+     * ```
+     */
+    get pgPaymentMethods(): RecordLinkManager<PgPaymentMethodRecord, typeof PgReportEventRecord['pgPaymentMethodsLabels'][number]>;
+    /** Valid labels for PgTransaction associations */
+    static readonly pgTransactionsLabels: readonly ["PgTransaction__PgReportEvent"];
+    /**
+     * Access linked PgTransaction records
+     * @remarks Available labels: PgTransaction__PgReportEvent
+     * @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__PgReportEvent' });
+     * ```
+     */
+    get pgTransactions(): RecordLinkManager<PgTransactionRecord, typeof PgReportEventRecord['pgTransactionsLabels'][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>;
+    /**
+     * CreatePgReportEvent
+     *
+     * Creates a new PgReportEvent 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.pgReportEvents.new();
+     * await record.createPgReportEvent({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.createPgReportEvent({ ... }).dryRun();
+     * ```
+     */
+    createPgReportEvent(properties: CreatePgReportEventProperties, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    }): ActionBuilder;
+    /**
+     * MovePgReportEventToFailed
+     *
+     * Transitions this PgReportEvent record to a new pipeline stage.
+     * Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
+     *
+     * @remarks Transitions to stage: EventStatusStageFailed
+     *
+     * @param options - Optional settings
+     * @param options.journeyId - Associate with a journey
+     * @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * const record = await odinClient.pgReportEvents.get(id);
+     * await record.movePgReportEventToFailed().execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.movePgReportEventToFailed().dryRun();
+     * ```
+     */
+    movePgReportEventToFailed(options?: {
+        journeyId?: string;
+    }): ActionBuilder;
+    /**
+     * MovePgReportEventToSkipped
+     *
+     * Transitions this PgReportEvent record to a new pipeline stage.
+     * Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
+     *
+     * @remarks Transitions to stage: EventStatusStageSkipped
+     *
+     * @param options - Optional settings
+     * @param options.journeyId - Associate with a journey
+     * @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * const record = await odinClient.pgReportEvents.get(id);
+     * await record.movePgReportEventToSkipped().execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.movePgReportEventToSkipped().dryRun();
+     * ```
+     */
+    movePgReportEventToSkipped(options?: {
+        journeyId?: string;
+    }): ActionBuilder;
+    /**
+     * MovePgReportEventToSucceeded
+     *
+     * Transitions this PgReportEvent record to a new pipeline stage.
+     * Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
+     *
+     * @remarks Transitions to stage: EventStatusStageSucceeded
+     *
+     * @param options - Optional settings
+     * @param options.journeyId - Associate with a journey
+     * @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * const record = await odinClient.pgReportEvents.get(id);
+     * await record.movePgReportEventToSucceeded().execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.movePgReportEventToSucceeded().dryRun();
+     * ```
+     */
+    movePgReportEventToSucceeded(options?: {
+        journeyId?: string;
+    }): ActionBuilder;
+    /**
+     * UpdatePgReportEvent
+     *
+     * Updates this PgReportEvent record with the specified properties.
+     * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
+     *
+     * @param properties - Required properties for this action
+     * @param options - Optional settings
+     * @param options.journeyId - Associate with a journey
+     * @param options.stageKey - Transition to pipeline stage
+     * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * const record = await odinClient.pgReportEvents.get(id);
+     * await record.updatePgReportEvent({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.updatePgReportEvent({ ... }).dryRun();
+     * ```
+     */
+    updatePgReportEvent(properties: UpdatePgReportEventProperties, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    }): ActionBuilder;
+}
+/** Type guard to check if an object is a PgReportEventRecord */
+export declare function isPgReportEventRecord(obj: any): obj is PgReportEventRecord;
+export {};