@d19n/youfibre-odin-sdk 2.0.378 → 2.0.379

package/README.md

@@ -124,7 +124,7 @@ await workOrder.completeWorkOrder({ ... });
 
 ## Entities
 
-This SDK includes **207** entities across **13** modules.
+This SDK includes **208** entities across **13** modules.
 
 ### CrmModule
 
@@ -247,6 +247,7 @@ This SDK includes **207** entities across **13** modules.
 | **BillingAdjustment** | BillingAdjustment Entity Definition | DEFAULT |
 | **ChurnRequest** | ChurnRequest Entity Definition | DEFAULT |
 | **Commitment** | Commitment Entity Definition | DEFAULT |
+| **Contract** | Contract Entity Definition | DEFAULT |
 | **ContractBuyOut** | ContractBuyOut Entity Definition | DEFAULT |
 | **DeactivationApproval** | DeactivationApproval Entity Definition | DEFAULT |
 | **HomeMove** | HomeMove Entity Definition | DEFAULT |

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

@@ -33,6 +33,7 @@ export declare class AccountApi extends ApiProvider {
     private _dataissue?;
     private _frustrationscore?;
     private _frustrationevent?;
+    private _contract?;
     constructor(authParams?: OauthParams, authToken?: string);
     get note(): ApiRecordLinkManager;
     get organization(): ApiRecordLinkManager;
@@ -50,6 +51,7 @@ export declare class AccountApi extends ApiProvider {
     get dataissue(): ApiRecordLinkManager;
     get frustrationscore(): ApiRecordLinkManager;
     get frustrationevent(): ApiRecordLinkManager;
+    get contract(): 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<AccountProperties>>>;

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

@@ -129,6 +129,12 @@ class AccountApi extends api_provider_1.ApiProvider {
         }
         return this._frustrationevent;
     }
+    get contract() {
+        if (!this._contract) {
+            this._contract = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'CrmModule:Account', 'OrderModule:Contract', 'Contract__Account');
+        }
+        return this._contract;
+    }
     // ============================================
     // STANDARD METHODS (Unchanged API)
     // ============================================

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

@@ -0,0 +1,52 @@
+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 { ApiRecordLinkManager } from '@d19n/odin-sdk-generator/dist/api.record.link.manager';
+import { ContractProperties } from '../entities-v2/Contract';
+/**
+ * @deprecated Use OdinApiClient.
+ *
+ * Migration:
+ * - Old: new ContractApi(authParams).get(id)
+ * - New: new odin.contract.get(id)
+ *
+ * The new OdinApiClient returns typed record wrappers with action methods.
+ */
+export declare class ContractApi extends ApiProvider {
+    protected readonly authToken?: string;
+    private readonly moduleName;
+    private readonly entityName;
+    private sourceRecord;
+    private _order?;
+    private _account?;
+    private _recontract?;
+    constructor(authParams?: OauthParams, authToken?: string);
+    get order(): ApiRecordLinkManager;
+    get account(): ApiRecordLinkManager;
+    get recontract(): 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<ContractProperties>>>;
+    searchAndPaginate(params: Partial<OdinSearchV2>): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<ContractProperties>>>;
+    reIndex(body: {
+        id: string;
+        schemaId: string;
+    }[]): Promise<any>;
+    get(contractId: string): Promise<import("@d19n/odin-types/dist/core").OdinRecord<ContractProperties>>;
+    getMany(contractIds: string[]): Promise<import("@d19n/odin-types/dist/core").OdinRecord<ContractProperties>[]>;
+    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(contractId: string): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinDeleteResponse[]>;
+    deleteMany(contractIds: string[]): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinDeleteResponse[]>;
+    restore(contractIds: 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/ContractApi.js

@@ -0,0 +1,167 @@
+"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.ContractApi = void 0;
+const api_provider_1 = require("@d19n/odin-sdk-generator/dist/api.provider");
+const api_record_link_manager_1 = require("@d19n/odin-sdk-generator/dist/api.record.link.manager");
+/**
+ * @deprecated Use OdinApiClient.
+ *
+ * Migration:
+ * - Old: new ContractApi(authParams).get(id)
+ * - New: new odin.contract.get(id)
+ *
+ * The new OdinApiClient returns typed record wrappers with action methods.
+ */
+class ContractApi extends api_provider_1.ApiProvider {
+    constructor(authParams, authToken) {
+        super(authParams, authToken);
+        this.authToken = authToken;
+        this.moduleName = 'OrderModule';
+        this.entityName = 'Contract';
+        // Link managers are lazy-loaded on first access
+    }
+    // ============================================
+    // LAZY-LOADED LINK MANAGERS (Public Getters)
+    // ============================================
+    // Usage remains identical: api.address.list(recordId)
+    get order() {
+        if (!this._order) {
+            this._order = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'OrderModule:Contract', 'OrderModule:Order', 'Contract__Order');
+        }
+        return this._order;
+    }
+    get account() {
+        if (!this._account) {
+            this._account = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'OrderModule:Contract', 'CrmModule:Account', 'Contract__Account');
+        }
+        return this._account;
+    }
+    get recontract() {
+        if (!this._recontract) {
+            this._recontract = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'OrderModule:Contract', 'OrderModule:Recontract', 'Recontract__Contract');
+        }
+        return this._recontract;
+    }
+    // ============================================
+    // 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(contractId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._getByPrimaryKey(this.moduleName, this.entityName, contractId);
+            if (res)
+                this.setRecord(res);
+            return res;
+        });
+    }
+    // Use this function when you want to return many records by primaryKeys
+    getMany(contractIds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getManyByPrimaryKey(this.moduleName, this.entityName, contractIds);
+        });
+    }
+    // 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(contractId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._delete(this.moduleName, this.entityName, [contractId]);
+        });
+    }
+    // Use this function when you want to delete many records
+    deleteMany(contractIds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._delete(this.moduleName, this.entityName, contractIds);
+        });
+    }
+    // Use this function when you want to restore one or many records
+    restore(contractIds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._restore(this.moduleName, this.entityName, contractIds);
+        });
+    }
+    // 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.ContractApi = ContractApi;

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

@@ -62,6 +62,7 @@ export declare class OrderApi extends ApiProvider {
     private _commitment?;
     private _homemove__oldorder?;
     private _homemove__neworder?;
+    private _contract?;
     constructor(authParams?: OauthParams, authToken?: string);
     get note(): ApiRecordLinkManager;
     get lead(): ApiRecordLinkManager;
@@ -108,6 +109,7 @@ export declare class OrderApi extends ApiProvider {
     get commitment(): ApiRecordLinkManager;
     get homemove__oldorder(): ApiRecordLinkManager;
     get homemove__neworder(): ApiRecordLinkManager;
+    get contract(): 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<OrderProperties>>>;

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

@@ -303,6 +303,12 @@ class OrderApi extends api_provider_1.ApiProvider {
         }
         return this._homemove__neworder;
     }
+    get contract() {
+        if (!this._contract) {
+            this._contract = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'OrderModule:Order', 'OrderModule:Contract', 'Contract__Order');
+        }
+        return this._contract;
+    }
     // ============================================
     // STANDARD METHODS (Unchanged API)
     // ============================================

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

@@ -19,9 +19,11 @@ export declare class RecontractApi extends ApiProvider {
     private sourceRecord;
     private _order?;
     private _modifyservicerequest?;
+    private _contract?;
     constructor(authParams?: OauthParams, authToken?: string);
     get order(): ApiRecordLinkManager;
     get modifyservicerequest(): ApiRecordLinkManager;
+    get contract(): 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<RecontractProperties>>>;

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

@@ -45,6 +45,12 @@ class RecontractApi extends api_provider_1.ApiProvider {
         }
         return this._modifyservicerequest;
     }
+    get contract() {
+        if (!this._contract) {
+            this._contract = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'OrderModule:Recontract', 'OrderModule:Contract', 'Recontract__Contract');
+        }
+        return this._contract;
+    }
     // ============================================
     // STANDARD METHODS (Unchanged API)
     // ============================================

package/dist/db-sdk-v2/AccountDb.d.ts

@@ -37,6 +37,7 @@ export declare class AccountDb extends DbProvider {
     private _dataissue?;
     private _frustrationscore?;
     private _frustrationevent?;
+    private _contract?;
     constructor(principal: any, dbService: any, defaultOptions?: DbProviderOptions);
     get note(): DbRecordLinkManager;
     get organization(): DbRecordLinkManager;
@@ -54,6 +55,7 @@ export declare class AccountDb extends DbProvider {
     get dataissue(): DbRecordLinkManager;
     get frustrationscore(): DbRecordLinkManager;
     get frustrationevent(): DbRecordLinkManager;
+    get contract(): DbRecordLinkManager;
     setRecord(sourceRecord: any): void;
     /**
      * Search records with manual pagination control

package/dist/db-sdk-v2/AccountDb.js

@@ -134,6 +134,12 @@ class AccountDb extends db_provider_1.DbProvider {
         }
         return this._frustrationevent;
     }
+    get contract() {
+        if (!this._contract) {
+            this._contract = new db_record_link_manager_1.DbRecordLinkManager(this.principal, this.dbService, 'CrmModule:Account', 'OrderModule:Contract', 'Contract__Account');
+        }
+        return this._contract;
+    }
     // ============================================
     // STANDARD METHODS
     // ============================================

package/dist/db-sdk-v2/ContractDb.d.ts

@@ -0,0 +1,124 @@
+import { DbProvider, DbProviderOptions, DbGetQueryOptions } from '@d19n/odin-sdk-generator/dist/db.provider';
+import { OdinSearchV2, OdinRecordCreateDto, OdinRecordUpdateDto } from '@d19n/odin-types/dist/core';
+import { DbRecordLinkManager } from '@d19n/odin-sdk-generator/dist/db.record.link.manager';
+import { ContractProperties } from '../entities-v2/Contract';
+/**
+ * @deprecated Use OdinDbClient.
+ *
+ * Migration:
+ * - Old: new ContractApi(authParams).get(id)
+ * - New: new odin.contract.get(id)
+ *
+ * The new OdinDbClient returns typed record wrappers with action methods.
+ *
+ * Supports separate query options and provider options:
+ * - Constructor level: new ContractDb(principal, dbService, { omitPermissionsCheck: true })
+ * - Method level: await db.getByPrimaryKey(id, { entities: [] }, { omitPermissionsCheck: true })
+ */
+export declare class ContractDb extends DbProvider {
+    protected readonly principal: any;
+    protected readonly dbService: any;
+    private readonly moduleName;
+    private readonly entityName;
+    private sourceRecord;
+    private _order?;
+    private _account?;
+    private _recontract?;
+    constructor(principal: any, dbService: any, defaultOptions?: DbProviderOptions);
+    get order(): DbRecordLinkManager;
+    get account(): DbRecordLinkManager;
+    get recontract(): DbRecordLinkManager;
+    setRecord(sourceRecord: any): void;
+    /**
+     * Search records with manual pagination control
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    searchRecords(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core/interfaces/v2.db.interfaces").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<ContractProperties>>>;
+    /**
+     * Search all records with automatic pagination
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    searchAllRecordsAndPaginate(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core/interfaces/v2.db.interfaces").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<ContractProperties>>>;
+    /**
+     * Get a single record by primary key
+     * @param contractId - Record ID
+     * @param queryOptions - Query options (WHAT: entities to include)
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     *
+     * @example
+     * // Simple get
+     * const record = await db.getByPrimaryKey(id);
+     *
+     * // With related entities
+     * const record = await db.getByPrimaryKey(id, { entities: ['InvoiceItem', 'Transaction'] });
+     *
+     * // With permissions bypass
+     * const record = await db.getByPrimaryKey(id, {}, { omitPermissionsCheck: true });
+     *
+     * // Both options
+     * const record = await db.getByPrimaryKey(id, { entities: ['Invoice'] }, { omitPermissionsCheck: true });
+     */
+    getByPrimaryKey(contractId: string, queryOptions?: DbGetQueryOptions, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").OdinRecord<ContractProperties>>;
+    /**
+     * Get multiple records by primary keys
+     * @param contractIds - Array of record IDs
+     * @param queryOptions - Query options (WHAT: entities to include)
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    getManyByPrimaryKey(contractIds: string[], queryOptions?: DbGetQueryOptions, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").OdinRecord<ContractProperties>[]>;
+    /**
+     * Upsert a single record
+     * @param upsertDto - Record to upsert
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    upsert(upsertDto: OdinRecordCreateDto, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").IDbRecordCreateUpdateRes>;
+    /**
+     * Upsert multiple records
+     * @param upsertDtos - Records to upsert
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    upsertMany(upsertDtos: OdinRecordCreateDto[], providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").IDbRecordCreateUpdateRes[]>;
+    /**
+     * Update a single record
+     * @param updateDto - Record to update
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    update(updateDto: OdinRecordUpdateDto, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").IDbRecordCreateUpdateRes>;
+    /**
+     * Update multiple records
+     * @param updateDtos - Records to update
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    updateMany(updateDtos: OdinRecordUpdateDto[], providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").IDbRecordCreateUpdateRes[]>;
+    /**
+     * Delete one or many records
+     * @param contractIds - Record IDs to delete
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    delete(contractIds: string[], providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-sdk-generator").DbRecordDeleted[]>;
+    /**
+     * Restore one or many deleted records
+     * @param contractIds - Record IDs to restore
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    restore(contractIds: string[], providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-sdk-generator").DbRecordRestored[]>;
+    /**
+     * Apply an action to a record
+     * @param actionName - The action key
+     * @param dto - The action DTO
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    applyAction(actionName: string, dto: any, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").IDbRecordCreateUpdateRes[]>;
+    /**
+     * Get version history for the current source record
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    getVersions(providerOptions?: DbProviderOptions): Promise<any>;
+    /**
+     * Get revision timeline for the current source record
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    getRevisionTimeline(providerOptions?: DbProviderOptions): Promise<any>;
+}