@d19n/youfibre-odin-sdk 2.0.76 → 2.0.78

package/dist/records-v2/EmailRecord.js

@@ -1003,6 +1003,114 @@ class EmailRecord {
         };
         return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
     }
+    /**
+     * SendDirectDebitCreatedEmail
+     *
+     * Creates a new Email record with the specified properties.
+     * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
+     *
+     * @remarks Record type: TRANSACTIONAL
+     *
+     * @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.emails.new();
+     * await record.sendDirectDebitCreatedEmail({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.sendDirectDebitCreatedEmail({ ... }).dryRun();
+     * ```
+     */
+    sendDirectDebitCreatedEmail(properties, options) {
+        const payload = {
+            entity: 'NotificationModule:Email',
+            type: 'TRANSACTIONAL',
+            actionName: 'SendDirectDebitCreatedEmail',
+            properties: properties || {},
+            associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+            stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
+        };
+        return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
+    }
+    /**
+     * SendDirectDebitSetupConfirmationEmail
+     *
+     * Creates a new Email record with the specified properties.
+     * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
+     *
+     * @remarks Record type: TRANSACTIONAL
+     *
+     * @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.emails.new();
+     * await record.sendDirectDebitSetupConfirmationEmail({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.sendDirectDebitSetupConfirmationEmail({ ... }).dryRun();
+     * ```
+     */
+    sendDirectDebitSetupConfirmationEmail(properties, options) {
+        const payload = {
+            entity: 'NotificationModule:Email',
+            type: 'TRANSACTIONAL',
+            actionName: 'SendDirectDebitSetupConfirmationEmail',
+            properties: properties || {},
+            associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+            stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
+        };
+        return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
+    }
+    /**
+     * SendRefundTransactionEmail
+     *
+     * Creates a new Email record with the specified properties.
+     * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
+     *
+     * @param properties - The properties for the new record
+     * @param options - Optional settings
+     * @param options.type - Override the record type
+     * @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.emails.new();
+     * await record.sendRefundTransactionEmail({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.sendRefundTransactionEmail({ ... }).dryRun();
+     * ```
+     */
+    sendRefundTransactionEmail(properties, options) {
+        var _a, _b;
+        const payload = {
+            entity: 'NotificationModule:Email',
+            type: (_a = options === null || options === void 0 ? void 0 : options.type) !== null && _a !== void 0 ? _a : (_b = this._record) === null || _b === void 0 ? void 0 : _b.type,
+            actionName: 'SendRefundTransactionEmail',
+            properties: properties || {},
+            associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+            stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
+        };
+        return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
+    }
     /**
      * SendTlosNinjaCaseEmail
      *

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

@@ -23,6 +23,7 @@ import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-man
 import { ExchangeProperties } from '../entities-v2/Exchange';
 import { CreateExchangeProperties } from '../actions-v2/CreateExchangeDto';
 import { UpdateExchangeProperties } from '../actions-v2/UpdateExchangeDto';
+import { RegionRecord } from './RegionRecord';
 import { CrmDatasetRecord } from './CrmDatasetRecord';
 import { SalesTerritoryRecord } from './SalesTerritoryRecord';
 /**
@@ -88,6 +89,7 @@ export declare class ExchangeRecord<TProps = ExchangeProperties> {
     private _provider;
     private _pendingLinks;
     private _preGeneratedId;
+    private _regions?;
     private _crmDatasets?;
     private _salesTerritories?;
     /**
@@ -115,6 +117,24 @@ export declare class ExchangeRecord<TProps = ExchangeProperties> {
     get groups(): string[];
     /** Access the underlying OdinRecord (null for new records) */
     get record(): OdinRecord<TProps> | null;
+    /** Valid labels for Region associations */
+    static readonly regionsLabels: readonly ["Region__Exchange"];
+    /**
+     * Access linked Region records
+     * @remarks Available labels: Region__Exchange
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Region records
+     * const items = await record.regions.list();
+     * const first = await record.regions.first();
+     *
+     * // Filter by label
+     * const specific = await record.regions.first({ label: 'Region__Exchange' });
+     * ```
+     */
+    get regions(): RecordLinkManager<RegionRecord, typeof ExchangeRecord['regionsLabels'][number]>;
     /** Valid labels for CrmDataset associations */
     static readonly crmDatasetsLabels: readonly ["Exchange__CrmDataset"];
     /**

package/dist/records-v2/ExchangeRecord.js

@@ -30,6 +30,7 @@ exports.isExchangeRecord = exports.ExchangeRecord = 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 RegionRecord_1 = require("./RegionRecord");
 const CrmDatasetRecord_1 = require("./CrmDatasetRecord");
 const SalesTerritoryRecord_1 = require("./SalesTerritoryRecord");
 /**
@@ -142,6 +143,36 @@ class ExchangeRecord {
     get groups() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.groups) || []; }
     /** Access the underlying OdinRecord (null for new records) */
     get record() { return this._record; }
+    /**
+     * Access linked Region records
+     * @remarks Available labels: Region__Exchange
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Region records
+     * const items = await record.regions.list();
+     * const first = await record.regions.first();
+     *
+     * // Filter by label
+     * const specific = await record.regions.first({ label: 'Region__Exchange' });
+     * ```
+     */
+    get regions() {
+        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._regions) {
+            this._regions = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'ProjectModule:Exchange',
+                targetEntity: 'ProjectModule:Region',
+                targetModuleName: 'ProjectModule',
+                targetEntityName: 'Region',
+                labels: ['Region__Exchange'],
+            }, RegionRecord_1.RegionRecord);
+        }
+        return this._regions;
+    }
     /**
      * Access linked CrmDataset records
      * @remarks Available labels: Exchange__CrmDataset
@@ -313,6 +344,8 @@ exports.ExchangeRecord = ExchangeRecord;
 // ============================================
 // TYPED LINK ACCESSORS
 // ============================================
+/** Valid labels for Region associations */
+ExchangeRecord.regionsLabels = ['Region__Exchange'];
 /** Valid labels for CrmDataset associations */
 ExchangeRecord.crmDatasetsLabels = ['Exchange__CrmDataset'];
 /** Valid labels for SalesTerritory associations */

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

@@ -0,0 +1,205 @@
+/**
+ * Region 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.regions.new();
+ * await record.createRegion({ ... }).execute();
+ * ```
+ *
+ * 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 { RegionProperties } from '../entities-v2/Region';
+import { CreateRegionProperties } from '../actions-v2/CreateRegionDto';
+import { ExchangeRecord } from './ExchangeRecord';
+import { ServiceAppointmentConfigRecord } from './ServiceAppointmentConfigRecord';
+/**
+ * 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 RegionRecord<TProps = RegionProperties> {
+    private _record;
+    private _provider;
+    private _pendingLinks;
+    private _preGeneratedId;
+    private _exchanges?;
+    private _serviceAppointmentConfigs?;
+    /**
+     * 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(): string | 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;
+    /** Valid labels for Exchange associations */
+    static readonly exchangesLabels: readonly ["Region__Exchange"];
+    /**
+     * Access linked Exchange records
+     * @remarks Available labels: Region__Exchange
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Exchange records
+     * const items = await record.exchanges.list();
+     * const first = await record.exchanges.first();
+     *
+     * // Filter by label
+     * const specific = await record.exchanges.first({ label: 'Region__Exchange' });
+     * ```
+     */
+    get exchanges(): RecordLinkManager<ExchangeRecord, typeof RegionRecord['exchangesLabels'][number]>;
+    /** Valid labels for ServiceAppointmentConfig associations */
+    static readonly serviceAppointmentConfigsLabels: readonly ["ServiceAppointmentConfig_Region"];
+    /**
+     * Access linked ServiceAppointmentConfig records
+     * @remarks Available labels: ServiceAppointmentConfig_Region
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked ServiceAppointmentConfig records
+     * const items = await record.serviceAppointmentConfigs.list();
+     * const first = await record.serviceAppointmentConfigs.first();
+     *
+     * // Filter by label
+     * const specific = await record.serviceAppointmentConfigs.first({ label: 'ServiceAppointmentConfig_Region' });
+     * ```
+     */
+    get serviceAppointmentConfigs(): RecordLinkManager<ServiceAppointmentConfigRecord, typeof RegionRecord['serviceAppointmentConfigsLabels'][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>;
+    /**
+     * CreateRegion
+     *
+     * Creates a new Region record with the specified properties.
+     * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
+     *
+     * @param properties - The properties for the new record
+     * @param options - Optional settings
+     * @param options.type - Override the record type
+     * @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.regions.new();
+     * await record.createRegion({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.createRegion({ ... }).dryRun();
+     * ```
+     */
+    createRegion(properties?: CreateRegionProperties, options?: {
+        type?: string;
+        journeyId?: string;
+        stageKey?: string;
+    }): ActionBuilder;
+}
+/** Type guard to check if an object is a RegionRecord */
+export declare function isRegionRecord(obj: any): obj is RegionRecord;
+export {};