@d19n/youfibre-odin-sdk 2.0.312 → 2.0.314

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

@@ -0,0 +1,207 @@
+/**
+ * QaReport 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.qaReports.new();
+ * await record.createQaReport({ ... }).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 { QaReportProperties } from '../entities-v2/QaReport';
+import { CreateQaReportProperties } from '../actions-v2/CreateQaReportDto';
+import { CaseRecord } from './CaseRecord';
+/** Valid entity types for QaReport */
+export declare type QaReportType = '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 QaReportRecord<TProps = QaReportProperties> {
+    private _record;
+    private _provider;
+    private _pendingLinks;
+    private _preGeneratedId;
+    private _cases?;
+    /**
+     * 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(): QaReportType | 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[];
+    /** Link metadata - populated only when the read passed withLinks (empty otherwise) */
+    get links(): OdinRecord<TProps>['links'];
+    /** 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 QaReportProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks This is the default record type
+     */
+    isDefault(): this is QaReportRecord<QaReportProperties>;
+    /** Valid labels for Case associations */
+    static readonly casesLabels: readonly ["Case__QaReport"];
+    /**
+     * Access linked Case records
+     * @remarks Available labels: Case__QaReport
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Case records
+     * const items = await record.cases.list();
+     * const first = await record.cases.first();
+     *
+     * // Filter by label
+     * const specific = await record.cases.first({ label: 'Case__QaReport' });
+     * ```
+     */
+    get cases(): RecordLinkManager<CaseRecord, typeof QaReportRecord['casesLabels'][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>;
+    /**
+     * CreateQaReport
+     *
+     * Creates a new QaReport 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.qaReports.new();
+     * await record.createQaReport({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.createQaReport({ ... }).dryRun();
+     * ```
+     */
+    createQaReport(properties: CreateQaReportProperties, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    }): ActionBuilder;
+}
+/** Type guard to check if an object is a QaReportRecord */
+export declare function isQaReportRecord(obj: any): obj is QaReportRecord;
+export {};

package/dist/records-v2/QaReportRecord.js

@@ -0,0 +1,282 @@
+"use strict";
+/**
+ * QaReport 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.qaReports.new();
+ * await record.createQaReport({ ... }).execute();
+ * ```
+ *
+ * Entity Types: DEFAULT
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isQaReportRecord = exports.QaReportRecord = 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 CaseRecord_1 = require("./CaseRecord");
+/**
+ * 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)
+ */
+class ActionBuilder {
+    constructor(provider, moduleName, entityName, payload, clearPendingLinks) {
+        this._provider = provider;
+        this._moduleName = moduleName;
+        this._entityName = entityName;
+        this._payload = payload;
+        this._clearPendingLinks = clearPendingLinks;
+    }
+    /**
+     * 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, externalAppId) {
+        this._payload.externalId = externalId;
+        this._payload.externalAppId = externalAppId;
+        return 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) {
+        this._payload.groups = groups;
+        return this;
+    }
+    /**
+     * Execute the action
+     * @returns The result from the API
+     */
+    execute() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this._provider._applyAction(this._moduleName, this._entityName, this._payload);
+            this._clearPendingLinks();
+            return result;
+        });
+    }
+    /**
+     * Returns the request payload without executing (for debugging)
+     * @returns The request payload that would be sent to the API
+     */
+    dryRun() {
+        return this._payload;
+    }
+    /**
+     * Prevents accidental `await actionBuilder` without .execute()
+     * Forces developers to explicitly call .execute()
+     * @throws Error always - use .execute() or .dryRun() instead
+     */
+    then() {
+        throw new Error('ActionBuilder cannot be awaited directly. Call .execute() to run the action or .dryRun() to get the payload.');
+    }
+}
+class QaReportRecord {
+    /**
+     * 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, provider, preGeneratedId) {
+        this._pendingLinks = [];
+        this._record = record;
+        this._provider = provider;
+        this._preGeneratedId = preGeneratedId !== null && preGeneratedId !== void 0 ? preGeneratedId : (0, uuid_1.v4)();
+    }
+    // ============================================
+    // CORE PROPERTIES
+    // ============================================
+    /** Returns true if this is a new (unsaved) record */
+    get isNew() { var _a; return !((_a = this._record) === null || _a === void 0 ? void 0 : _a.id); }
+    /** Record ID - always available (pre-generated for new records) */
+    get id() { var _a, _b; return (_b = (_a = this._record) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : this._preGeneratedId; }
+    get entity() { var _a, _b; return (_b = (_a = this._record) === null || _a === void 0 ? void 0 : _a.entity) !== null && _b !== void 0 ? _b : 'SupportModule:QaReport'; }
+    get type() { var _a; return (_a = this._record) === null || _a === void 0 ? void 0 : _a.type; }
+    /** Record properties - empty object for new (unsaved) records */
+    get properties() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.properties) || {}; }
+    get title() { var _a; return (_a = this._record) === null || _a === void 0 ? void 0 : _a.title; }
+    get recordNumber() { var _a; return (_a = this._record) === null || _a === void 0 ? void 0 : _a.recordNumber; }
+    get stage() { var _a; return (_a = this._record) === null || _a === void 0 ? void 0 : _a.stage; }
+    get createdAt() { var _a; return (_a = this._record) === null || _a === void 0 ? void 0 : _a.createdAt; }
+    get updatedAt() { var _a; return (_a = this._record) === null || _a === void 0 ? void 0 : _a.updatedAt; }
+    get externalId() { var _a; return (_a = this._record) === null || _a === void 0 ? void 0 : _a.externalId; }
+    get externalAppId() { var _a; return (_a = this._record) === null || _a === void 0 ? void 0 : _a.externalAppId; }
+    get groups() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.groups) || []; }
+    /** Link metadata - populated only when the read passed withLinks (empty otherwise) */
+    get links() { var _a, _b; return (_b = (_a = this._record) === null || _a === void 0 ? void 0 : _a.links) !== null && _b !== void 0 ? _b : []; }
+    /** 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 QaReportProperties
+     *   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 Case records
+     * @remarks Available labels: Case__QaReport
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Case records
+     * const items = await record.cases.list();
+     * const first = await record.cases.first();
+     *
+     * // Filter by label
+     * const specific = await record.cases.first({ label: 'Case__QaReport' });
+     * ```
+     */
+    get cases() {
+        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._cases) {
+            this._cases = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'SupportModule:QaReport',
+                targetEntity: 'SupportModule:Case',
+                targetModuleName: 'SupportModule',
+                targetEntityName: 'Case',
+                labels: ['Case__QaReport'],
+            }, CaseRecord_1.CaseRecord);
+        }
+        return this._cases;
+    }
+    // ============================================
+    // LINK MANAGEMENT
+    // ============================================
+    /**
+     * Queue a link to be created with the next action.
+     * Works for both create and update actions.
+     * @returns this (for chaining)
+     */
+    link(target) {
+        this._pendingLinks.push(new core_1.OdinRecordLinkDto({ id: target.id, entity: target.entity }));
+        return this;
+    }
+    /** Get the currently queued links */
+    get pendingLinks() {
+        return [...this._pendingLinks];
+    }
+    /** Clear pending links without executing an action */
+    clearPendingLinks() {
+        this._pendingLinks = [];
+        return this;
+    }
+    /**
+     * Immediately unlink a record (API call).
+     * Unlike link(), this executes immediately.
+     * @throws Error if called on a new (unsaved) record
+     */
+    unlink(target) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+                throw new Error('Cannot unlink from a new (unsaved) record');
+            const targetId = typeof target === 'string' ? target : target.id;
+            yield this._provider._deleteLinks('SupportModule', 'QaReport', this._record.id, targetId);
+        });
+    }
+    // ============================================
+    // CREATE ACTIONS (no existing record required)
+    // ============================================
+    /**
+     * CreateQaReport
+     *
+     * Creates a new QaReport 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.qaReports.new();
+     * await record.createQaReport({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.createQaReport({ ... }).dryRun();
+     * ```
+     */
+    createQaReport(properties, options) {
+        const payload = {
+            entity: 'SupportModule:QaReport',
+            type: 'DEFAULT',
+            actionName: 'CreateQaReport',
+            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, 'SupportModule', 'QaReport', payload, () => { this._pendingLinks = []; });
+    }
+}
+exports.QaReportRecord = QaReportRecord;
+// ============================================
+// TYPED LINK ACCESSORS
+// ============================================
+/** Valid labels for Case associations */
+QaReportRecord.casesLabels = ['Case__QaReport'];
+/** Type guard to check if an object is a QaReportRecord */
+function isQaReportRecord(obj) {
+    return obj instanceof QaReportRecord;
+}
+exports.isQaReportRecord = isQaReportRecord;