@d19n/youfibre-odin-sdk 2.0.40 → 2.0.41

package/dist/db-accessors-v2/PhoneNumberDbAccessor.d.ts

@@ -1,149 +0,0 @@
-/**
- * PhoneNumber DB Accessor
- *
- * Provides typed access to PhoneNumber records via direct database access.
- * For use in backend services with principal + dbService.
- * Returns wrapped records with typed action methods.
- *
- * @example
- * ```typescript
- * // Simple get
- * const record = await accessor.get(id);
- *
- * // With related entities
- * const record = await accessor.get(id, { entities: ["Contact", "Address"] });
- *
- * // With permissions bypass (separate options)
- * const record = await accessor.get(id, {}, { omitPermissionsCheck: true });
- *
- * // Silent write (no RabbitMQ events)
- * const result = await accessor.upsert([dto], { omitWriteEvents: true });
- *
- * // Constructor-level default (applies to all calls)
- * const accessor = new PhoneNumberDbAccessor(principal, dbService, { omitPermissionsCheck: true });
- * ```
- *
- * AUTO-GENERATED - DO NOT EDIT DIRECTLY
- */
-import { OdinSearchV2 } from '@d19n/odin-types/dist/core';
-import { DbProvider, DbProviderOptions, DbGetQueryOptions } from '@d19n/odin-sdk-generator/dist/db.provider';
-import { QueryBuilder } from '@d19n/odin-sdk-generator/dist/query-builder';
-import { PhoneNumberProperties } from '../entities-v2/PhoneNumber';
-import { PhoneNumberRecord } from '../records-v2/PhoneNumberRecord';
-/** Search response with wrapped records */
-export interface PhoneNumberDbSearchResponse {
-    records: PhoneNumberRecord[];
-    totalRecords: number;
-    hasMore: boolean;
-}
-export declare class PhoneNumberDbAccessor {
-    private readonly _provider;
-    private readonly _moduleName;
-    private readonly _entityName;
-    private readonly _defaultOptions?;
-    /**
-     * Create a new PhoneNumberDbAccessor
-     * @param principal - The authenticated principal
-     * @param dbService - The database service instance
-     * @param defaultOptions - Default provider options applied to all operations
-     */
-    constructor(principal: any, dbService: any, defaultOptions?: DbProviderOptions);
-    get moduleName(): string;
-    get entityName(): string;
-    /**
-     * Create a new empty PhoneNumber record instance for create operations.
-     * Pre-generates an ID that can be referenced before the record is saved.
-     *
-     * @param id - Optional ID to use (auto-generated UUID if not provided)
-     * @returns A new record wrapper with pre-generated ID
-     *
-     * @example
-     * ```typescript
-     * // Auto-generated ID
-     * const note = odinDb.notes.new();
-     * console.log(note.id); // UUID available immediately
-     *
-     * // Custom ID
-     * const order = odinDb.orders.new("custom-id-123");
-     *
-     * // Reference ID before save
-     * const account = odinDb.accounts.new();
-     * const contact = odinDb.contacts.new();
-     * await contact
-     *   .link({ id: account.id, entity: "CrmModule:Account" })
-     *   .createContact({ FirstName: "John" });
-     * ```
-     */
-    new(id?: string): PhoneNumberRecord;
-    /**
-     * Get a single PhoneNumber record by ID
-     *
-     * @param id - The record ID
-     * @param queryOptions - Query options (WHAT to fetch: entities to include)
-     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
-     *
-     * @example
-     * ```typescript
-     * // Simple get
-     * const record = await accessor.get(id);
-     *
-     * // With related entities
-     * const record = await accessor.get(id, { entities: ["Contact", "Address"] });
-     *
-     * // With permissions bypass
-     * const record = await accessor.get(id, {}, { omitPermissionsCheck: true });
-     *
-     * // Both options
-     * const record = await accessor.get(id, { entities: ["Invoice"] }, { omitPermissionsCheck: true });
-     * ```
-     */
-    get(id: string, queryOptions?: DbGetQueryOptions, providerOptions?: DbProviderOptions): Promise<PhoneNumberRecord>;
-    /**
-     * Get multiple PhoneNumber records by IDs
-     *
-     * @param ids - Array of record IDs
-     * @param queryOptions - Query options (WHAT to fetch: entities to include)
-     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
-     */
-    getMany(ids: string[], queryOptions?: DbGetQueryOptions, providerOptions?: DbProviderOptions): Promise<PhoneNumberRecord[]>;
-    /**
-     * Search PhoneNumber records
-     *
-     * @param params - Search parameters
-     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
-     */
-    search(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): Promise<PhoneNumberDbSearchResponse>;
-    /**
-     * Search all PhoneNumber records with automatic pagination
-     *
-     * @param params - Search parameters
-     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
-     */
-    searchAll(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): Promise<PhoneNumberRecord[]>;
-    /**
-     * Async generator for paginating through all matching records.
-     * Yields batches of wrapped records.
-     *
-     * @param params - Search parameters
-     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
-     */
-    paginate(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): AsyncGenerator<PhoneNumberRecord[]>;
-    /**
-     * Create a fluent query builder for PhoneNumber records
-     *
-     * @example
-     * ```typescript
-     * const results = await accessor
-     *   .query()
-     *   .where('Status', 'in', ['Active', 'Pending'])
-     *   .where('CreatedAt', 'gte', '2025-01-01')
-     *   .select('id', 'title', 'properties.*')
-     *   .sortBy('createdAt', 'desc')
-     *   .limit(100)
-     *   .execute();
-     * ```
-     */
-    query(): QueryBuilder<PhoneNumberProperties, PhoneNumberRecord>;
-    /** Access the underlying DbProvider */
-    get provider(): DbProvider;
-}

package/dist/db-accessors-v2/PhoneNumberDbAccessor.js

@@ -1,227 +0,0 @@
-"use strict";
-/**
- * PhoneNumber DB Accessor
- *
- * Provides typed access to PhoneNumber records via direct database access.
- * For use in backend services with principal + dbService.
- * Returns wrapped records with typed action methods.
- *
- * @example
- * ```typescript
- * // Simple get
- * const record = await accessor.get(id);
- *
- * // With related entities
- * const record = await accessor.get(id, { entities: ["Contact", "Address"] });
- *
- * // With permissions bypass (separate options)
- * const record = await accessor.get(id, {}, { omitPermissionsCheck: true });
- *
- * // Silent write (no RabbitMQ events)
- * const result = await accessor.upsert([dto], { omitWriteEvents: true });
- *
- * // Constructor-level default (applies to all calls)
- * const accessor = new PhoneNumberDbAccessor(principal, dbService, { omitPermissionsCheck: true });
- * ```
- *
- * 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());
-    });
-};
-var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
-var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
-    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
-    var g = generator.apply(thisArg, _arguments || []), i, q = [];
-    return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
-    function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
-    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
-    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
-    function fulfill(value) { resume("next", value); }
-    function reject(value) { resume("throw", value); }
-    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PhoneNumberDbAccessor = void 0;
-const db_provider_1 = require("@d19n/odin-sdk-generator/dist/db.provider");
-const query_builder_1 = require("@d19n/odin-sdk-generator/dist/query-builder");
-const PhoneNumberRecord_1 = require("../records-v2/PhoneNumberRecord");
-class PhoneNumberDbAccessor {
-    /**
-     * Create a new PhoneNumberDbAccessor
-     * @param principal - The authenticated principal
-     * @param dbService - The database service instance
-     * @param defaultOptions - Default provider options applied to all operations
-     */
-    constructor(principal, dbService, defaultOptions) {
-        this._moduleName = 'CrmModule';
-        this._entityName = 'PhoneNumber';
-        this._provider = new db_provider_1.DbProvider(principal, dbService, defaultOptions);
-        this._defaultOptions = defaultOptions;
-    }
-    get moduleName() { return this._moduleName; }
-    get entityName() { return this._entityName; }
-    // ============================================
-    // RECORD CREATION
-    // ============================================
-    /**
-     * Create a new empty PhoneNumber record instance for create operations.
-     * Pre-generates an ID that can be referenced before the record is saved.
-     *
-     * @param id - Optional ID to use (auto-generated UUID if not provided)
-     * @returns A new record wrapper with pre-generated ID
-     *
-     * @example
-     * ```typescript
-     * // Auto-generated ID
-     * const note = odinDb.notes.new();
-     * console.log(note.id); // UUID available immediately
-     *
-     * // Custom ID
-     * const order = odinDb.orders.new("custom-id-123");
-     *
-     * // Reference ID before save
-     * const account = odinDb.accounts.new();
-     * const contact = odinDb.contacts.new();
-     * await contact
-     *   .link({ id: account.id, entity: "CrmModule:Account" })
-     *   .createContact({ FirstName: "John" });
-     * ```
-     */
-    new(id) {
-        return new PhoneNumberRecord_1.PhoneNumberRecord(null, this._provider, id);
-    }
-    // ============================================
-    // RECORD RETRIEVAL
-    // ============================================
-    /**
-     * Get a single PhoneNumber record by ID
-     *
-     * @param id - The record ID
-     * @param queryOptions - Query options (WHAT to fetch: entities to include)
-     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
-     *
-     * @example
-     * ```typescript
-     * // Simple get
-     * const record = await accessor.get(id);
-     *
-     * // With related entities
-     * const record = await accessor.get(id, { entities: ["Contact", "Address"] });
-     *
-     * // With permissions bypass
-     * const record = await accessor.get(id, {}, { omitPermissionsCheck: true });
-     *
-     * // Both options
-     * const record = await accessor.get(id, { entities: ["Invoice"] }, { omitPermissionsCheck: true });
-     * ```
-     */
-    get(id, queryOptions, providerOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const record = yield this._provider._getByPrimaryKey(this._moduleName, this._entityName, id, queryOptions, providerOptions);
-            return new PhoneNumberRecord_1.PhoneNumberRecord(record, this._provider);
-        });
-    }
-    /**
-     * Get multiple PhoneNumber records by IDs
-     *
-     * @param ids - Array of record IDs
-     * @param queryOptions - Query options (WHAT to fetch: entities to include)
-     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
-     */
-    getMany(ids, queryOptions, providerOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (ids.length === 0)
-                return [];
-            const records = yield this._provider._getManyByPrimaryKey(this._moduleName, this._entityName, ids, queryOptions, providerOptions);
-            return records.map((r) => new PhoneNumberRecord_1.PhoneNumberRecord(r, this._provider));
-        });
-    }
-    // ============================================
-    // SEARCH OPERATIONS
-    // ============================================
-    /**
-     * Search PhoneNumber records
-     *
-     * @param params - Search parameters
-     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
-     */
-    search(params, providerOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const result = yield this._provider._searchRecords(this._moduleName, this._entityName, params, providerOptions);
-            return {
-                records: result.records.map((r) => new PhoneNumberRecord_1.PhoneNumberRecord(r, this._provider)),
-                totalRecords: result.totalRecords,
-                hasMore: result.hasMore,
-            };
-        });
-    }
-    /**
-     * Search all PhoneNumber records with automatic pagination
-     *
-     * @param params - Search parameters
-     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
-     */
-    searchAll(params, providerOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const result = yield this._provider._searchAllRecordsAndPaginate(this._moduleName, this._entityName, params, 0, providerOptions);
-            return result.records.map((r) => new PhoneNumberRecord_1.PhoneNumberRecord(r, this._provider));
-        });
-    }
-    /**
-     * Async generator for paginating through all matching records.
-     * Yields batches of wrapped records.
-     *
-     * @param params - Search parameters
-     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
-     */
-    paginate(params, providerOptions) {
-        var _a;
-        return __asyncGenerator(this, arguments, function* paginate_1() {
-            let hasMore = true;
-            let searchAfter;
-            const query = Object.assign(Object.assign({}, params.query), { pageSize: ((_a = params.query) === null || _a === void 0 ? void 0 : _a.pageSize) || 500 });
-            while (hasMore) {
-                const result = yield __await(this._provider._searchRecords(this._moduleName, this._entityName, Object.assign(Object.assign({}, params), { query: Object.assign(Object.assign({}, query), { searchAfter }) }), providerOptions));
-                if (result.records.length > 0) {
-                    yield yield __await(result.records.map((r) => new PhoneNumberRecord_1.PhoneNumberRecord(r, this._provider)));
-                    const lastRecord = result.records[result.records.length - 1];
-                    searchAfter = lastRecord === null || lastRecord === void 0 ? void 0 : lastRecord.sort;
-                }
-                hasMore = result.hasMore && result.records.length >= query.pageSize;
-            }
-        });
-    }
-    // ============================================
-    // QUERY BUILDER
-    // ============================================
-    /**
-     * Create a fluent query builder for PhoneNumber records
-     *
-     * @example
-     * ```typescript
-     * const results = await accessor
-     *   .query()
-     *   .where('Status', 'in', ['Active', 'Pending'])
-     *   .where('CreatedAt', 'gte', '2025-01-01')
-     *   .select('id', 'title', 'properties.*')
-     *   .sortBy('createdAt', 'desc')
-     *   .limit(100)
-     *   .execute();
-     * ```
-     */
-    query() {
-        return (0, query_builder_1.createQueryBuilder)(this);
-    }
-    /** Access the underlying DbProvider */
-    get provider() {
-        return this._provider;
-    }
-}
-exports.PhoneNumberDbAccessor = PhoneNumberDbAccessor;

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

@@ -1,205 +0,0 @@
-/**
- * PhoneNumber 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.phoneNumbers.new();
- * await record.createPhoneNumber({ ... }).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 { PhoneNumberProperties } from '../entities-v2/PhoneNumber';
-import { CreatePhoneNumberFromBrskProperties } from '../actions-v2/CreatePhoneNumberFromBrskDto';
-import { OrderRecord } from './OrderRecord';
-import { ContactRecord } from './ContactRecord';
-/**
- * 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 PhoneNumberRecord<TProps = PhoneNumberProperties> {
-    private _record;
-    private _provider;
-    private _pendingLinks;
-    private _preGeneratedId;
-    private _orders?;
-    private _contacts?;
-    /**
-     * 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 Order associations */
-    static readonly ordersLabels: readonly ["Order__PhoneNumber"];
-    /**
-     * Access linked Order records
-     * @remarks Available labels: Order__PhoneNumber
-     * @throws Error if called on a new (unsaved) record
-     *
-     * @example
-     * ```typescript
-     * // Get all linked Order records
-     * const items = await record.orders.list();
-     * const first = await record.orders.first();
-     *
-     * // Filter by label
-     * const specific = await record.orders.first({ label: 'Order__PhoneNumber' });
-     * ```
-     */
-    get orders(): RecordLinkManager<OrderRecord, typeof PhoneNumberRecord['ordersLabels'][number]>;
-    /** Valid labels for Contact associations */
-    static readonly contactsLabels: readonly ["Contact__PhoneNumber"];
-    /**
-     * Access linked Contact records
-     * @remarks Available labels: Contact__PhoneNumber
-     * @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: 'Contact__PhoneNumber' });
-     * ```
-     */
-    get contacts(): RecordLinkManager<ContactRecord, typeof PhoneNumberRecord['contactsLabels'][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>;
-    /**
-     * CreatePhoneNumberFromBrsk
-     *
-     * Creates a new PhoneNumber 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.phoneNumbers.new();
-     * await record.createPhoneNumberFromBrsk({ ... }).execute();
-     *
-     * // Dry run (for debugging)
-     * const payload = record.createPhoneNumberFromBrsk({ ... }).dryRun();
-     * ```
-     */
-    createPhoneNumberFromBrsk(properties?: CreatePhoneNumberFromBrskProperties, options?: {
-        type?: string;
-        journeyId?: string;
-        stageKey?: string;
-    }): ActionBuilder;
-}
-/** Type guard to check if an object is a PhoneNumberRecord */
-export declare function isPhoneNumberRecord(obj: any): obj is PhoneNumberRecord;
-export {};