@d19n/youfibre-odin-sdk 2.0.342 → 2.0.343

package/dist/api-sdk-v2/EquipmentReturnApi.js

@@ -0,0 +1,151 @@
+"use strict";
+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.EquipmentReturnApi = void 0;
+const api_provider_1 = require("@d19n/odin-sdk-generator/dist/api.provider");
+/**
+ * @deprecated Use OdinApiClient.
+ *
+ * Migration:
+ * - Old: new EquipmentReturnApi(authParams).get(id)
+ * - New: new odin.equipmentreturn.get(id)
+ *
+ * The new OdinApiClient returns typed record wrappers with action methods.
+ */
+class EquipmentReturnApi extends api_provider_1.ApiProvider {
+    // ============================================
+    // PRIVATE BACKING FIELDS (Lazy Loading)
+    // ============================================
+    constructor(authParams, authToken) {
+        super(authParams, authToken);
+        this.authToken = authToken;
+        this.moduleName = 'FieldServiceModule';
+        this.entityName = 'EquipmentReturn';
+        // Link managers are lazy-loaded on first access
+    }
+    // ============================================
+    // LAZY-LOADED LINK MANAGERS (Public Getters)
+    // ============================================
+    // Usage remains identical: api.address.list(recordId)
+    // ============================================
+    // STANDARD METHODS (Unchanged API)
+    // ============================================
+    setRecord(sourceRecord) {
+        this.sourceRecord = sourceRecord;
+    }
+    schema() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.getSchema(this.moduleName, this.entityName);
+        });
+    }
+    // Use this function when you want to search and handle all pagination on your own
+    search(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._searchRecords(this.moduleName, this.entityName, params);
+        });
+    }
+    // Use this function when you want paginating through the results to be handled
+    searchAndPaginate(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._searchAllRecordsAndPaginate(this.moduleName, this.entityName, params);
+        });
+    }
+    // Use this function to re-index records in elastic search
+    reIndex(body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._reIndexRecords(body);
+        });
+    }
+    // Use this function when you want to return a single record
+    get(equipmentReturnId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._getByPrimaryKey(this.moduleName, this.entityName, equipmentReturnId);
+            if (res)
+                this.setRecord(res);
+            return res;
+        });
+    }
+    // Use this function when you want to return many records by primaryKeys
+    getMany(equipmentReturnIds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getManyByPrimaryKey(this.moduleName, this.entityName, equipmentReturnIds);
+        });
+    }
+    // Use this function when you want to upsert one record
+    upsert(upsertDto) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._upsert(this.moduleName, this.entityName, [upsertDto]);
+            return res[0];
+        });
+    }
+    // Use this function when you want to upsert many records
+    upsertMany(upsertDtos) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._upsert(this.moduleName, this.entityName, upsertDtos);
+        });
+    }
+    // Use this function when you want to update one record
+    update(updateDto) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._update(this.moduleName, this.entityName, [updateDto]);
+            return res[0];
+        });
+    }
+    // Use this function when you want to update many records
+    updateMany(updateDtos) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._update(this.moduleName, this.entityName, updateDtos);
+        });
+    }
+    // Use this function when you want to delete one record
+    delete(equipmentReturnId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._delete(this.moduleName, this.entityName, [equipmentReturnId]);
+        });
+    }
+    // Use this function when you want to delete many records
+    deleteMany(equipmentReturnIds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._delete(this.moduleName, this.entityName, equipmentReturnIds);
+        });
+    }
+    // Use this function when you want to restore one or many records
+    restore(equipmentReturnIds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._restore(this.moduleName, this.entityName, equipmentReturnIds);
+        });
+    }
+    // Use this function when you want to apply a single action
+    applyAction(dto) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._applyAction(this.moduleName, this.entityName, dto);
+        });
+    }
+    // Use this function when you want to bulk apply actions 
+    bulkApplyActions(dtos) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._bulkApplyActions(this.moduleName, this.entityName, dtos);
+        });
+    }
+    // Use this function when you want to return the versions for a single record
+    getVersions() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getVersions(this.moduleName, this.entityName, this.sourceRecord.id);
+        });
+    }
+    // Use this function when you want to return the change history for a single record
+    getRevisionTimeline() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getRevisionTimeline(this.moduleName, this.entityName, this.sourceRecord.id);
+        });
+    }
+}
+exports.EquipmentReturnApi = EquipmentReturnApi;

package/dist/api-sdk-v2/EquipmentReturnItemApi.d.ts

@@ -0,0 +1,45 @@
+import { OauthParams } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
+import { ApiProvider } from '@d19n/odin-sdk-generator/dist/api.provider';
+import { OdinSearchV2, OdinRecordCreateDto, OdinRecordUpdateDto } from '@d19n/odin-types/dist/core';
+import { EquipmentReturnItemProperties } from '../entities-v2/EquipmentReturnItem';
+/**
+ * @deprecated Use OdinApiClient.
+ *
+ * Migration:
+ * - Old: new EquipmentReturnItemApi(authParams).get(id)
+ * - New: new odin.equipmentreturnitem.get(id)
+ *
+ * The new OdinApiClient returns typed record wrappers with action methods.
+ */
+export declare class EquipmentReturnItemApi extends ApiProvider {
+    protected readonly authToken?: string;
+    private readonly moduleName;
+    private readonly entityName;
+    private sourceRecord;
+    constructor(authParams?: OauthParams, authToken?: string);
+    setRecord(sourceRecord: any): void;
+    schema(): Promise<import("@d19n/odin-types/dist/core").OdinSchema>;
+    search(params: Partial<OdinSearchV2>): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<EquipmentReturnItemProperties>>>;
+    searchAndPaginate(params: Partial<OdinSearchV2>): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<EquipmentReturnItemProperties>>>;
+    reIndex(body: {
+        id: string;
+        schemaId: string;
+    }[]): Promise<any>;
+    get(equipmentReturnItemId: string): Promise<import("@d19n/odin-types/dist/core").OdinRecord<EquipmentReturnItemProperties>>;
+    getMany(equipmentReturnItemIds: string[]): Promise<import("@d19n/odin-types/dist/core").OdinRecord<EquipmentReturnItemProperties>[]>;
+    upsert(upsertDto: OdinRecordCreateDto): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").IDbRecordCreateUpdateRes>;
+    upsertMany(upsertDtos: OdinRecordCreateDto[]): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").IDbRecordCreateUpdateRes[]>;
+    update(updateDto: OdinRecordUpdateDto): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").IDbRecordCreateUpdateRes>;
+    updateMany(updateDtos: OdinRecordUpdateDto[]): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").IDbRecordCreateUpdateRes[]>;
+    delete(equipmentReturnItemId: string): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinDeleteResponse[]>;
+    deleteMany(equipmentReturnItemIds: string[]): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinDeleteResponse[]>;
+    restore(equipmentReturnItemIds: string[]): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinRestoreResponse[]>;
+    applyAction(dto: any): Promise<any[]>;
+    bulkApplyActions(dtos: any[]): Promise<any[]>;
+    getVersions(): Promise<{
+        [key: string]: Record<string, any>;
+    }>;
+    getRevisionTimeline(): Promise<{
+        [key: string]: Record<string, any>[];
+    }>;
+}

package/dist/api-sdk-v2/EquipmentReturnItemApi.js

@@ -0,0 +1,151 @@
+"use strict";
+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.EquipmentReturnItemApi = void 0;
+const api_provider_1 = require("@d19n/odin-sdk-generator/dist/api.provider");
+/**
+ * @deprecated Use OdinApiClient.
+ *
+ * Migration:
+ * - Old: new EquipmentReturnItemApi(authParams).get(id)
+ * - New: new odin.equipmentreturnitem.get(id)
+ *
+ * The new OdinApiClient returns typed record wrappers with action methods.
+ */
+class EquipmentReturnItemApi extends api_provider_1.ApiProvider {
+    // ============================================
+    // PRIVATE BACKING FIELDS (Lazy Loading)
+    // ============================================
+    constructor(authParams, authToken) {
+        super(authParams, authToken);
+        this.authToken = authToken;
+        this.moduleName = 'FieldServiceModule';
+        this.entityName = 'EquipmentReturnItem';
+        // Link managers are lazy-loaded on first access
+    }
+    // ============================================
+    // LAZY-LOADED LINK MANAGERS (Public Getters)
+    // ============================================
+    // Usage remains identical: api.address.list(recordId)
+    // ============================================
+    // STANDARD METHODS (Unchanged API)
+    // ============================================
+    setRecord(sourceRecord) {
+        this.sourceRecord = sourceRecord;
+    }
+    schema() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.getSchema(this.moduleName, this.entityName);
+        });
+    }
+    // Use this function when you want to search and handle all pagination on your own
+    search(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._searchRecords(this.moduleName, this.entityName, params);
+        });
+    }
+    // Use this function when you want paginating through the results to be handled
+    searchAndPaginate(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._searchAllRecordsAndPaginate(this.moduleName, this.entityName, params);
+        });
+    }
+    // Use this function to re-index records in elastic search
+    reIndex(body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._reIndexRecords(body);
+        });
+    }
+    // Use this function when you want to return a single record
+    get(equipmentReturnItemId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._getByPrimaryKey(this.moduleName, this.entityName, equipmentReturnItemId);
+            if (res)
+                this.setRecord(res);
+            return res;
+        });
+    }
+    // Use this function when you want to return many records by primaryKeys
+    getMany(equipmentReturnItemIds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getManyByPrimaryKey(this.moduleName, this.entityName, equipmentReturnItemIds);
+        });
+    }
+    // Use this function when you want to upsert one record
+    upsert(upsertDto) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._upsert(this.moduleName, this.entityName, [upsertDto]);
+            return res[0];
+        });
+    }
+    // Use this function when you want to upsert many records
+    upsertMany(upsertDtos) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._upsert(this.moduleName, this.entityName, upsertDtos);
+        });
+    }
+    // Use this function when you want to update one record
+    update(updateDto) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._update(this.moduleName, this.entityName, [updateDto]);
+            return res[0];
+        });
+    }
+    // Use this function when you want to update many records
+    updateMany(updateDtos) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._update(this.moduleName, this.entityName, updateDtos);
+        });
+    }
+    // Use this function when you want to delete one record
+    delete(equipmentReturnItemId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._delete(this.moduleName, this.entityName, [equipmentReturnItemId]);
+        });
+    }
+    // Use this function when you want to delete many records
+    deleteMany(equipmentReturnItemIds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._delete(this.moduleName, this.entityName, equipmentReturnItemIds);
+        });
+    }
+    // Use this function when you want to restore one or many records
+    restore(equipmentReturnItemIds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._restore(this.moduleName, this.entityName, equipmentReturnItemIds);
+        });
+    }
+    // Use this function when you want to apply a single action
+    applyAction(dto) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._applyAction(this.moduleName, this.entityName, dto);
+        });
+    }
+    // Use this function when you want to bulk apply actions 
+    bulkApplyActions(dtos) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._bulkApplyActions(this.moduleName, this.entityName, dtos);
+        });
+    }
+    // Use this function when you want to return the versions for a single record
+    getVersions() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getVersions(this.moduleName, this.entityName, this.sourceRecord.id);
+        });
+    }
+    // Use this function when you want to return the change history for a single record
+    getRevisionTimeline() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getRevisionTimeline(this.moduleName, this.entityName, this.sourceRecord.id);
+        });
+    }
+}
+exports.EquipmentReturnItemApi = EquipmentReturnItemApi;

package/dist/api-sdk-v2/FileApi.d.ts

@@ -81,6 +81,8 @@ export declare class FileApi extends ApiProvider {
     private _pgdirectdebitfile?;
     private _yfwifisurvey?;
     private _yffieldvisitoutcomeform?;
+    private _document?;
+    private _documentprocessing?;
     constructor(authParams?: OauthParams, authToken?: string);
     get servicevisitaudit(): ApiRecordLinkManager;
     get blockagea55(): ApiRecordLinkManager;
@@ -146,6 +148,8 @@ export declare class FileApi extends ApiProvider {
     get pgdirectdebitfile(): ApiRecordLinkManager;
     get yfwifisurvey(): ApiRecordLinkManager;
     get yffieldvisitoutcomeform(): ApiRecordLinkManager;
+    get document(): ApiRecordLinkManager;
+    get documentprocessing(): ApiRecordLinkManager;
     setRecord(sourceRecord: any): void;
     schema(): Promise<import("@d19n/odin-types/dist/core").OdinSchema>;
     search(params: Partial<OdinSearchV2>): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<FileProperties>>>;

package/dist/api-sdk-v2/FileApi.js

@@ -417,6 +417,18 @@ class FileApi extends api_provider_1.ApiProvider {
         }
         return this._yffieldvisitoutcomeform;
     }
+    get document() {
+        if (!this._document) {
+            this._document = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'SchemaModule:File', 'AiModule:Document', 'Document__File');
+        }
+        return this._document;
+    }
+    get documentprocessing() {
+        if (!this._documentprocessing) {
+            this._documentprocessing = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'SchemaModule:File', 'AiModule:DocumentProcessing', 'DocumentProcessing__File');
+        }
+        return this._documentprocessing;
+    }
     // ============================================
     // STANDARD METHODS (Unchanged API)
     // ============================================

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

@@ -0,0 +1,180 @@
+/**
+ * Document DB Accessor
+ *
+ * Provides typed access to Document 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 DocumentDbAccessor(principal, dbService, { omitPermissionsCheck: true });
+ * ```
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinSearchV2 } from '@d19n/odin-types/dist/core';
+import { DbProvider, DbProviderOptions, DbGetQueryOptions, DbExternalIdQueryOptions } from '@d19n/odin-sdk-generator/dist/db.provider';
+import { QueryBuilder } from '@d19n/odin-sdk-generator/dist/query-builder';
+import { DocumentProperties } from '../entities-v2/Document';
+import { DocumentRecord } from '../records-v2/DocumentRecord';
+/** Search response with wrapped records */
+export interface DocumentDbSearchResponse {
+    records: DocumentRecord[];
+    totalRecords: number;
+    hasMore: boolean;
+    aggregations?: Record<string, any>;
+}
+export declare class DocumentDbAccessor {
+    private readonly _provider;
+    private readonly _moduleName;
+    private readonly _entityName;
+    private readonly _defaultOptions?;
+    /**
+     * Create a new DocumentDbAccessor
+     * @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 Document 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): DocumentRecord;
+    /**
+     * Get a single Document 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<DocumentRecord>;
+    /**
+     * Get multiple Document 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<DocumentRecord[]>;
+    /**
+     * Get Document records by the RECORD-LEVEL external id.
+     *
+     * Resolved server-side in Postgres against `record.external_id` - not a property
+     * search, and not reachable through `query()` (`externalId` is not a queryable
+     * column). Use this when an external system hands back its own identifier.
+     *
+     * Platform limits: max 5000 ids per call, each at most 36 characters. An unknown
+     * `type` is rejected with 400 `invalid type`.
+     *
+     * @param externalIds - The external ids to match (plural - the platform takes an array)
+     * @param queryOptions - Query options (WHAT to fetch: narrow by record type)
+     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck, withLinks)
+     *
+     * @example
+     * ```typescript
+     * // Correlate a provider webhook back to the record it wrote
+     * const [message] = await accessor.getManyByExternalId([body.SmsSid]);
+     *
+     * // Narrowed by record type
+     * const closures = await accessor.getManyByExternalId(refs, { type: 'CLOSURE' });
+     *
+     * // Background job, no link hydration
+     * const records = await accessor.getManyByExternalId(refs, undefined, {
+     *   omitPermissionsCheck: true,
+     *   withLinks: false,
+     * });
+     * ```
+     */
+    getManyByExternalId(externalIds: string[], queryOptions?: DbExternalIdQueryOptions, providerOptions?: DbProviderOptions): Promise<DocumentRecord[]>;
+    /**
+     * Search Document records
+     *
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
+     */
+    search(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): Promise<DocumentDbSearchResponse>;
+    /**
+     * Search all Document records with automatic pagination
+     *
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
+     */
+    searchAll(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): Promise<DocumentRecord[]>;
+    /**
+     * 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<DocumentRecord[]>;
+    /**
+     * Create a fluent query builder for Document 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<DocumentProperties, DocumentRecord>;
+    /** Access the underlying DbProvider */
+    get provider(): DbProvider;
+}