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

package/dist/records-v2/RemediationRequiredReasonRecord.js

@@ -14,6 +14,8 @@
  * await record.createRemediationRequiredReason({ ... }).execute();
  * ```
  *
+ * Entity Types: OUTCOME_FORM
+ *
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
@@ -29,6 +31,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isRemediationRequiredReasonRecord = exports.RemediationRequiredReasonRecord = 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 NoteRecord_1 = require("./NoteRecord");
+const FileRecord_1 = require("./FileRecord");
+const WorkOrderRecord_1 = require("./WorkOrderRecord");
+const PermissionToFailRecord_1 = require("./PermissionToFailRecord");
 /**
  * Builder for action execution with dryRun support
  *
@@ -140,6 +147,145 @@ class RemediationRequiredReasonRecord {
     /** 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 OUTCOME_FORM
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to OUTCOME_FORM-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isOutcomeForm()) {
+     *   // TypeScript knows record.properties is OutcomeFormRemediationRequiredReasonProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks outcome form
+     */
+    isOutcomeForm() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'OUTCOME_FORM'; }
+    /**
+     * Access linked Note records
+     * @remarks Available labels: RemediationRequiredReason__Note
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Note records
+     * const items = await record.notes.list();
+     * const first = await record.notes.first();
+     *
+     * // Filter by label
+     * const specific = await record.notes.first({ label: 'RemediationRequiredReason__Note' });
+     * ```
+     */
+    get notes() {
+        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._notes) {
+            this._notes = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'FieldServiceModule:RemediationRequiredReason',
+                targetEntity: 'SupportModule:Note',
+                targetModuleName: 'SupportModule',
+                targetEntityName: 'Note',
+                labels: ['RemediationRequiredReason__Note'],
+            }, NoteRecord_1.NoteRecord);
+        }
+        return this._notes;
+    }
+    /**
+     * Access linked File records
+     * @remarks Available labels: RemediationRequiredReason__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: 'RemediationRequiredReason__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: 'FieldServiceModule:RemediationRequiredReason',
+                targetEntity: 'SchemaModule:File',
+                targetModuleName: 'SchemaModule',
+                targetEntityName: 'File',
+                labels: ['RemediationRequiredReason__File'],
+            }, FileRecord_1.FileRecord);
+        }
+        return this._files;
+    }
+    /**
+     * Access linked WorkOrder records
+     * @remarks Available labels: WorkOrder__RemediationRequiredReason
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked WorkOrder records
+     * const items = await record.workOrders.list();
+     * const first = await record.workOrders.first();
+     *
+     * // Filter by label
+     * const specific = await record.workOrders.first({ label: 'WorkOrder__RemediationRequiredReason' });
+     * ```
+     */
+    get workOrders() {
+        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._workOrders) {
+            this._workOrders = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'FieldServiceModule:RemediationRequiredReason',
+                targetEntity: 'FieldServiceModule:WorkOrder',
+                targetModuleName: 'FieldServiceModule',
+                targetEntityName: 'WorkOrder',
+                labels: ['WorkOrder__RemediationRequiredReason'],
+            }, WorkOrderRecord_1.WorkOrderRecord);
+        }
+        return this._workOrders;
+    }
+    /**
+     * Access linked PermissionToFail records
+     * @remarks Available labels: PermissionToFail__RemediationRequiredReason
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked PermissionToFail records
+     * const items = await record.permissionToFails.list();
+     * const first = await record.permissionToFails.first();
+     *
+     * // Filter by label
+     * const specific = await record.permissionToFails.first({ label: 'PermissionToFail__RemediationRequiredReason' });
+     * ```
+     */
+    get permissionToFails() {
+        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._permissionToFails) {
+            this._permissionToFails = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'FieldServiceModule:RemediationRequiredReason',
+                targetEntity: 'FieldServiceModule:PermissionToFail',
+                targetModuleName: 'FieldServiceModule',
+                targetEntityName: 'PermissionToFail',
+                labels: ['PermissionToFail__RemediationRequiredReason'],
+            }, PermissionToFailRecord_1.PermissionToFailRecord);
+        }
+        return this._permissionToFails;
+    }
+    // ============================================
     // LINK MANAGEMENT
     // ============================================
     /**
@@ -215,6 +361,17 @@ class RemediationRequiredReasonRecord {
     }
 }
 exports.RemediationRequiredReasonRecord = RemediationRequiredReasonRecord;
+// ============================================
+// TYPED LINK ACCESSORS
+// ============================================
+/** Valid labels for Note associations */
+RemediationRequiredReasonRecord.notesLabels = ['RemediationRequiredReason__Note'];
+/** Valid labels for File associations */
+RemediationRequiredReasonRecord.filesLabels = ['RemediationRequiredReason__File'];
+/** Valid labels for WorkOrder associations */
+RemediationRequiredReasonRecord.workOrdersLabels = ['WorkOrder__RemediationRequiredReason'];
+/** Valid labels for PermissionToFail associations */
+RemediationRequiredReasonRecord.permissionToFailsLabels = ['PermissionToFail__RemediationRequiredReason'];
 /** Type guard to check if an object is a RemediationRequiredReasonRecord */
 function isRemediationRequiredReasonRecord(obj) {
     return obj instanceof RemediationRequiredReasonRecord;

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

@@ -13,16 +13,23 @@
  * await record.createReturns({ ... }).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 { ReturnsProperties } from '../entities-v2/Returns';
 import { CreateNewReturnProperties } from '../actions-v2/CreateNewReturnDto';
 import { EditReturnProperties } from '../actions-v2/EditReturnDto';
 import { ReActionReturnCompletionProperties } from '../actions-v2/ReActionReturnCompletionDto';
+import { WorkOrderRecord } from './WorkOrderRecord';
+import { UserRecord } from './UserRecord';
+/** Valid entity types for Returns */
+export declare type ReturnsType = 'DEFAULT';
 /**
  * Builder for action execution with dryRun support
  *
@@ -86,6 +93,8 @@ export declare class ReturnsRecord<TProps = ReturnsProperties> {
     private _provider;
     private _pendingLinks;
     private _preGeneratedId;
+    private _workOrders?;
+    private _users?;
     /**
      * Create a record wrapper.
      * @param record - The underlying record, or null for create operations
@@ -98,7 +107,7 @@ export declare class ReturnsRecord<TProps = ReturnsProperties> {
     /** Record ID - always available (pre-generated for new records) */
     get id(): string;
     get entity(): string;
-    get type(): string | undefined;
+    get type(): ReturnsType | undefined;
     /** Record properties - empty object for new (unsaved) records */
     get properties(): TProps;
     get title(): string | undefined;
@@ -111,6 +120,58 @@ export declare class ReturnsRecord<TProps = ReturnsProperties> {
     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 ReturnsProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks This is the default record type
+     */
+    isDefault(): this is ReturnsRecord<ReturnsProperties>;
+    /** Valid labels for WorkOrder associations */
+    static readonly workOrdersLabels: readonly ["Returns__WorkOrder"];
+    /**
+     * Access linked WorkOrder records
+     * @remarks Available labels: Returns__WorkOrder
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked WorkOrder records
+     * const items = await record.workOrders.list();
+     * const first = await record.workOrders.first();
+     *
+     * // Filter by label
+     * const specific = await record.workOrders.first({ label: 'Returns__WorkOrder' });
+     * ```
+     */
+    get workOrders(): RecordLinkManager<WorkOrderRecord, typeof ReturnsRecord['workOrdersLabels'][number]>;
+    /** Valid labels for User associations */
+    static readonly usersLabels: readonly ["Returns__Inspected_By"];
+    /**
+     * Access linked User records
+     * @remarks Available labels: Returns__Inspected_By
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked User records
+     * const items = await record.users.list();
+     * const first = await record.users.first();
+     *
+     * // Filter by label
+     * const specific = await record.users.first({ label: 'Returns__Inspected_By' });
+     * ```
+     */
+    get users(): RecordLinkManager<UserRecord, typeof ReturnsRecord['usersLabels'][number]>;
     /**
      * Queue a link to be created with the next action.
      * Works for both create and update actions.

package/dist/records-v2/ReturnsRecord.js

@@ -14,6 +14,8 @@
  * await record.createReturns({ ... }).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.isReturnsRecord = exports.ReturnsRecord = 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 WorkOrderRecord_1 = require("./WorkOrderRecord");
+const UserRecord_1 = require("./UserRecord");
 /**
  * Builder for action execution with dryRun support
  *
@@ -140,6 +145,85 @@ class ReturnsRecord {
     /** 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 ReturnsProperties
+     *   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 WorkOrder records
+     * @remarks Available labels: Returns__WorkOrder
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked WorkOrder records
+     * const items = await record.workOrders.list();
+     * const first = await record.workOrders.first();
+     *
+     * // Filter by label
+     * const specific = await record.workOrders.first({ label: 'Returns__WorkOrder' });
+     * ```
+     */
+    get workOrders() {
+        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._workOrders) {
+            this._workOrders = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'FieldServiceModule:Returns',
+                targetEntity: 'FieldServiceModule:WorkOrder',
+                targetModuleName: 'FieldServiceModule',
+                targetEntityName: 'WorkOrder',
+                labels: ['Returns__WorkOrder'],
+            }, WorkOrderRecord_1.WorkOrderRecord);
+        }
+        return this._workOrders;
+    }
+    /**
+     * Access linked User records
+     * @remarks Available labels: Returns__Inspected_By
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked User records
+     * const items = await record.users.list();
+     * const first = await record.users.first();
+     *
+     * // Filter by label
+     * const specific = await record.users.first({ label: 'Returns__Inspected_By' });
+     * ```
+     */
+    get users() {
+        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._users) {
+            this._users = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'FieldServiceModule:Returns',
+                targetEntity: 'IdentityModule:User',
+                targetModuleName: 'IdentityModule',
+                targetEntityName: 'User',
+                labels: ['Returns__Inspected_By'],
+            }, UserRecord_1.UserRecord);
+        }
+        return this._users;
+    }
+    // ============================================
     // LINK MANAGEMENT
     // ============================================
     /**
@@ -292,6 +376,13 @@ class ReturnsRecord {
     }
 }
 exports.ReturnsRecord = ReturnsRecord;
+// ============================================
+// TYPED LINK ACCESSORS
+// ============================================
+/** Valid labels for WorkOrder associations */
+ReturnsRecord.workOrdersLabels = ['Returns__WorkOrder'];
+/** Valid labels for User associations */
+ReturnsRecord.usersLabels = ['Returns__Inspected_By'];
 /** Type guard to check if an object is a ReturnsRecord */
 function isReturnsRecord(obj) {
     return obj instanceof ReturnsRecord;

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

@@ -13,16 +13,26 @@
  * await record.createReward({ ... }).execute();
  * ```
  *
+ * Entity Types: CASHBACK
+ *
  * 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 { RewardProperties } from '../entities-v2/Reward';
+import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
+import { RewardProperties, CashbackRewardProperties } from '../entities-v2/Reward';
 import { CreateCashbackRewardProperties } from '../actions-v2/CreateCashbackRewardDto';
 import { CreateCashbackRewardForOrderReferralProperties } from '../actions-v2/CreateCashbackRewardForOrderReferralDto';
 import { CreateCashbackRewardForOrderReferralBuilder } from '../actions-v2/CreateCashbackRewardForOrderReferralDto';
+import { CampaignRecord } from './CampaignRecord';
+import { ContactRecord } from './ContactRecord';
+import { AffiliateCodeRecord } from './AffiliateCodeRecord';
+import { PaymentMethodRefundRecord } from './PaymentMethodRefundRecord';
+import { ReferralRecord } from './ReferralRecord';
+/** Valid entity types for Reward */
+export declare type RewardType = 'CASHBACK';
 /**
  * Builder for action execution with dryRun support
  *
@@ -86,6 +96,11 @@ export declare class RewardRecord<TProps = RewardProperties> {
     private _provider;
     private _pendingLinks;
     private _preGeneratedId;
+    private _campaigns?;
+    private _contacts?;
+    private _affiliateCodes?;
+    private _paymentMethodRefunds?;
+    private _referrals?;
     /**
      * Create a record wrapper.
      * @param record - The underlying record, or null for create operations
@@ -98,7 +113,7 @@ export declare class RewardRecord<TProps = RewardProperties> {
     /** Record ID - always available (pre-generated for new records) */
     get id(): string;
     get entity(): string;
-    get type(): string | undefined;
+    get type(): RewardType | undefined;
     /** Record properties - empty object for new (unsaved) records */
     get properties(): TProps;
     get title(): string | undefined;
@@ -111,6 +126,112 @@ export declare class RewardRecord<TProps = RewardProperties> {
     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 CASHBACK
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to CASHBACK-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isCashback()) {
+     *   // TypeScript knows record.properties is CashbackRewardProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks Cashback reward
+     */
+    isCashback(): this is RewardRecord<CashbackRewardProperties>;
+    /** Valid labels for Campaign associations */
+    static readonly campaignsLabels: readonly ["CampaignRewards"];
+    /**
+     * Access linked Campaign records
+     * @remarks Available labels: CampaignRewards
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Campaign records
+     * const items = await record.campaigns.list();
+     * const first = await record.campaigns.first();
+     *
+     * // Filter by label
+     * const specific = await record.campaigns.first({ label: 'CampaignRewards' });
+     * ```
+     */
+    get campaigns(): RecordLinkManager<CampaignRecord, typeof RewardRecord['campaignsLabels'][number]>;
+    /** Valid labels for Contact associations */
+    static readonly contactsLabels: readonly ["ContactReward"];
+    /**
+     * Access linked Contact records
+     * @remarks Available labels: ContactReward
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Contact records
+     * const items = await record.contacts.list();
+     * const first = await record.contacts.first();
+     *
+     * // Filter by label
+     * const specific = await record.contacts.first({ label: 'ContactReward' });
+     * ```
+     */
+    get contacts(): RecordLinkManager<ContactRecord, typeof RewardRecord['contactsLabels'][number]>;
+    /** Valid labels for AffiliateCode associations */
+    static readonly affiliateCodesLabels: readonly ["AffiliateCodeRewards"];
+    /**
+     * Access linked AffiliateCode records
+     * @remarks Available labels: AffiliateCodeRewards
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked AffiliateCode records
+     * const items = await record.affiliateCodes.list();
+     * const first = await record.affiliateCodes.first();
+     *
+     * // Filter by label
+     * const specific = await record.affiliateCodes.first({ label: 'AffiliateCodeRewards' });
+     * ```
+     */
+    get affiliateCodes(): RecordLinkManager<AffiliateCodeRecord, typeof RewardRecord['affiliateCodesLabels'][number]>;
+    /** Valid labels for PaymentMethodRefund associations */
+    static readonly paymentMethodRefundsLabels: readonly ["RewardPaymentMethodRefund"];
+    /**
+     * Access linked PaymentMethodRefund records
+     * @remarks Available labels: RewardPaymentMethodRefund
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked PaymentMethodRefund records
+     * const items = await record.paymentMethodRefunds.list();
+     * const first = await record.paymentMethodRefunds.first();
+     *
+     * // Filter by label
+     * const specific = await record.paymentMethodRefunds.first({ label: 'RewardPaymentMethodRefund' });
+     * ```
+     */
+    get paymentMethodRefunds(): RecordLinkManager<PaymentMethodRefundRecord, typeof RewardRecord['paymentMethodRefundsLabels'][number]>;
+    /** Valid labels for Referral associations */
+    static readonly referralsLabels: readonly ["OrderReferralCashbackReward"];
+    /**
+     * Access linked Referral records
+     * @remarks Available labels: OrderReferralCashbackReward
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Referral records
+     * const items = await record.referrals.list();
+     * const first = await record.referrals.first();
+     *
+     * // Filter by label
+     * const specific = await record.referrals.first({ label: 'OrderReferralCashbackReward' });
+     * ```
+     */
+    get referrals(): RecordLinkManager<ReferralRecord, typeof RewardRecord['referralsLabels'][number]>;
     /**
      * Queue a link to be created with the next action.
      * Works for both create and update actions.