@d19n/youfibre-odin-sdk 2.0.122 → 2.0.124

package/dist/actions-v2/UpdateAdditionalNoteDto.d.ts

@@ -0,0 +1,73 @@
+/**
+ * UpdateAdditionalNote Action DTO
+ *
+ * Updates the additional note field
+ *
+ * @module SupportModule
+ * @entity Case
+ * @actionKey UpdateAdditionalNote
+ * @event k1.t-hEOJjsDb.SupportModule.Case.Update.UpdateAdditionalNote
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for UpdateAdditionalNote updated events
+ *
+ * @event k1.t-hEOJjsDb.SupportModule.Case.Update.UpdateAdditionalNote
+ */
+export interface UpdateAdditionalNoteMessage extends OdinRecordUpdatedEvent<UpdateAdditionalNoteDto, UpdateAdditionalNoteProperties> {
+}
+/**
+ * Properties for UpdateAdditionalNote action
+ *
+ * @property Required fields: 1
+ * @property Optional fields: 0
+ */
+export interface UpdateAdditionalNoteProperties {
+    /**
+     * Additional Notes
+     *
+     * Additional Notes (Customer Service - Case)
+     * @type {TEXT_LONG}
+     * @required
+     */
+    AdditionalNotes: string;
+}
+/**
+ * UpdateAdditionalNote
+ *
+ * Updates the additional note field
+ *
+ * @actionType UPDATE - Updates an existing Case record
+ * @module SupportModule
+ * @entity Case
+ * @event k1.t-hEOJjsDb.SupportModule.Case.Update.UpdateAdditionalNote
+ * @permission schema.action.updateadditionalnote.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class UpdateAdditionalNoteDto extends OdinRecordUpdateDto<UpdateAdditionalNoteProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "UPDATE";
+    static readonly ACTION_KEY = "UpdateAdditionalNote";
+    static readonly MODULE_NAME = "SupportModule";
+    static readonly ENTITIES: string[];
+    static readonly EVENT_NAME = "k1.t-hEOJjsDb.SupportModule.Case.Update.UpdateAdditionalNote";
+    static readonly PERMISSION = "schema.action.updateadditionalnote.trigger";
+    /** Step metadata - entity this action targets */
+    static readonly STEP_ENTITY = "SupportModule:Case";
+    static readonly STEP_SCHEMA_ID = "bb540d25-53bf-491b-9d03-f3d42f755b3a";
+    static readonly STEP_SCHEMA_ACTION_ID = "9a7cf6dc-93c1-48d3-8392-45d0ef11ea2b";
+    static readonly AUTO_LINK_PARENT = false;
+    readonly actionName: string;
+    readonly schemaActionId: string;
+    readonly entity: string;
+    constructor(record: OdinRecord<any> | {
+        id: string;
+        entity: string;
+        type?: string;
+    }, properties: UpdateAdditionalNoteProperties, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    });
+}

package/dist/actions-v2/UpdateAdditionalNoteDto.js

@@ -0,0 +1,56 @@
+"use strict";
+/**
+ * UpdateAdditionalNote Action DTO
+ *
+ * Updates the additional note field
+ *
+ * @module SupportModule
+ * @entity Case
+ * @actionKey UpdateAdditionalNote
+ * @event k1.t-hEOJjsDb.SupportModule.Case.Update.UpdateAdditionalNote
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateAdditionalNoteDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * UpdateAdditionalNote
+ *
+ * Updates the additional note field
+ *
+ * @actionType UPDATE - Updates an existing Case record
+ * @module SupportModule
+ * @entity Case
+ * @event k1.t-hEOJjsDb.SupportModule.Case.Update.UpdateAdditionalNote
+ * @permission schema.action.updateadditionalnote.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class UpdateAdditionalNoteDto extends core_1.OdinRecordUpdateDto {
+    constructor(record, properties, options) {
+        super({
+            id: record.id,
+            entity: record.entity,
+            type: record.type,
+            properties,
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+            stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
+        });
+        this.actionName = 'UpdateAdditionalNote';
+        this.schemaActionId = '9a7cf6dc-93c1-48d3-8392-45d0ef11ea2b';
+        this.entity = 'SupportModule:Case';
+    }
+}
+exports.UpdateAdditionalNoteDto = UpdateAdditionalNoteDto;
+/** Used by SDK generators to identify action type */
+UpdateAdditionalNoteDto.ACTION_TYPE = 'UPDATE';
+UpdateAdditionalNoteDto.ACTION_KEY = 'UpdateAdditionalNote';
+UpdateAdditionalNoteDto.MODULE_NAME = 'SupportModule';
+UpdateAdditionalNoteDto.ENTITIES = ['Case'];
+UpdateAdditionalNoteDto.EVENT_NAME = 'k1.t-hEOJjsDb.SupportModule.Case.Update.UpdateAdditionalNote';
+UpdateAdditionalNoteDto.PERMISSION = 'schema.action.updateadditionalnote.trigger';
+/** Step metadata - entity this action targets */
+UpdateAdditionalNoteDto.STEP_ENTITY = 'SupportModule:Case';
+UpdateAdditionalNoteDto.STEP_SCHEMA_ID = 'bb540d25-53bf-491b-9d03-f3d42f755b3a';
+UpdateAdditionalNoteDto.STEP_SCHEMA_ACTION_ID = '9a7cf6dc-93c1-48d3-8392-45d0ef11ea2b';
+UpdateAdditionalNoteDto.AUTO_LINK_PARENT = false;

package/dist/actions-v2/UpdateContactDto.d.ts

@@ -21,8 +21,8 @@ export interface UpdateContactMessage extends OdinRecordUpdatedEvent<UpdateConta
 /**
  * Properties for UpdateContact action
  *
- * @property Required fields: 5
- * @property Optional fields: 11
+ * @property Required fields: 4
+ * @property Optional fields: 14
  */
 export interface UpdateContactProperties {
     /**
@@ -49,22 +49,13 @@ export interface UpdateContactProperties {
      * @required
      */
     LastName: string;
-    /**
-     * Additional Care Reason
-     *
-     * Primary reason for additional care (single select). (Sales - Contact)
-     * @type {ENUM}
-     * @required
-     * @visibleWhen AdditionalCareRequired = [true]
-     */
-    AdditionalCareReason: string;
     /**
      * Additional Care Consent
      *
      * Customer consent for recording additional care requiremetns (Sales - Contact)
      * @type {BOOLEAN}
      * @required
-     * @visibleWhen AdditionalCareRequired = [true]
+     * @visibleWhen AdditionalCareRequired = [true,"YES"]
      */
     AdditionalCareConsent: boolean;
     /**
@@ -118,36 +109,44 @@ export interface UpdateContactProperties {
      */
     CurrentContractType?: string | null;
     /**
-     * Additional Care Required
+     * Critical Dependencies
      *
      * Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact)
-     * @type {BOOLEAN}
-     */
-    AdditionalCareRequired?: boolean | null;
-    /**
-     * Additional Care Notes
-     *
-     * Free-text notes field for Contact. Used by Sales team for documentation.
-     * @type {TEXT_LONG}
-     * @visibleWhen AdditionalCareRequired = [true]
+     * @type {ENUM}
      */
-    AdditionalCareNotes?: string | null;
+    AdditionalCareRequired?: string | null;
     /**
      * Medically Dependant
      *
      * Is the customer medically dependant on their broadband (Sales - Contact)
-     * @type {BOOLEAN}
-     * @visibleWhen AdditionalCareRequired = [true]
+     * @type {ENUM}
+     * @visibleWhen AdditionalCareRequired = [true,"YES"]
      */
-    MedicallyDependant?: boolean | null;
+    MedicallyDependant?: string | null;
     /**
      * Telecare Alarm
      *
      * Does the customer use a Telecare Alarm (Sales - Contact)
-     * @type {BOOLEAN}
-     * @visibleWhen AdditionalCareRequired = [true]
+     * @type {ENUM}
+     * @visibleWhen AdditionalCareRequired = [true,"YES"]
+     */
+    TelecareAlarm?: string | null;
+    /**
+     * Additional Care Requirements
+     *
+     * Primary reason for additional care (single select). (Sales - Contact)
+     * @type {ENUM_MULTI_SELECT}
+     * @visibleWhen AdditionalCareRequired = [true,"YES"]
      */
-    TelecareAlarm?: boolean | null;
+    AdditionalCareReason?: string | null;
+    /**
+     * Additional Care Notes
+     *
+     * Free-text notes field for Contact. Used by Sales team for documentation.
+     * @type {TEXT_LONG}
+     * @visibleWhen AdditionalCareRequired = [true,"YES"]
+     */
+    AdditionalCareNotes?: string | null;
 }
 /**
  * UpdateContact

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

@@ -37,6 +37,7 @@ export declare class AddressApi extends ApiProvider {
     private _case?;
     private _crmdataset?;
     private _addressinteraction?;
+    private _yffieldservicevisit?;
     constructor(authParams?: OauthParams, authToken?: string);
     get file(): ApiRecordLinkManager;
     get note(): ApiRecordLinkManager;
@@ -58,6 +59,7 @@ export declare class AddressApi extends ApiProvider {
     get case(): ApiRecordLinkManager;
     get crmdataset(): ApiRecordLinkManager;
     get addressinteraction(): ApiRecordLinkManager;
+    get yffieldservicevisit(): 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<AddressProperties>>>;

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

@@ -153,6 +153,12 @@ class AddressApi extends api_provider_1.ApiProvider {
         }
         return this._addressinteraction;
     }
+    get yffieldservicevisit() {
+        if (!this._yffieldservicevisit) {
+            this._yffieldservicevisit = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'CrmModule:Address', 'FieldServiceModule:YfFieldServiceVisit', 'YfFieldServiceVisit__ Address');
+        }
+        return this._yffieldservicevisit;
+    }
     // ============================================
     // STANDARD METHODS (Unchanged API)
     // ============================================

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

@@ -37,7 +37,6 @@ export declare class ContactApi extends ApiProvider {
     private _appointment?;
     private _fingerprint?;
     private _case?;
-    private _affiliatecode?;
     private _organization?;
     private _address?;
     private _smsmessage?;
@@ -52,6 +51,7 @@ export declare class ContactApi extends ApiProvider {
     private _workorder__alternative_contact?;
     private _impersonationtracker?;
     private _accountcredit?;
+    private _affiliatecode?;
     constructor(authParams?: OauthParams, authToken?: string);
     get note(): ApiRecordLinkManager;
     get lead(): ApiRecordLinkManager;
@@ -73,7 +73,6 @@ export declare class ContactApi extends ApiProvider {
     get appointment(): ApiRecordLinkManager;
     get fingerprint(): ApiRecordLinkManager;
     get case(): ApiRecordLinkManager;
-    get affiliatecode(): ApiRecordLinkManager;
     get organization(): ApiRecordLinkManager;
     get address(): ApiRecordLinkManager;
     get smsmessage(): ApiRecordLinkManager;
@@ -88,6 +87,7 @@ export declare class ContactApi extends ApiProvider {
     get workorder__alternative_contact(): ApiRecordLinkManager;
     get impersonationtracker(): ApiRecordLinkManager;
     get accountcredit(): ApiRecordLinkManager;
+    get affiliatecode(): 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<ContactProperties>>>;

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

@@ -153,12 +153,6 @@ class ContactApi extends api_provider_1.ApiProvider {
         }
         return this._case;
     }
-    get affiliatecode() {
-        if (!this._affiliatecode) {
-            this._affiliatecode = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'CrmModule:Contact', 'CrmModule:AffiliateCode', 'ContactAffiliateCodes');
-        }
-        return this._affiliatecode;
-    }
     get organization() {
         if (!this._organization) {
             this._organization = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'CrmModule:Contact', 'CrmModule:Organization', 'Organization__Contact');
@@ -243,6 +237,12 @@ class ContactApi extends api_provider_1.ApiProvider {
         }
         return this._accountcredit;
     }
+    get affiliatecode() {
+        if (!this._affiliatecode) {
+            this._affiliatecode = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'CrmModule:Contact', 'CrmModule:AffiliateCode', 'ContactAffiliateCodes');
+        }
+        return this._affiliatecode;
+    }
     // ============================================
     // STANDARD METHODS (Unchanged API)
     // ============================================

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

@@ -20,10 +20,12 @@ export declare class YfFieldServiceVisitApi extends ApiProvider {
     private _note?;
     private _file?;
     private _workorder?;
+    private _address?;
     constructor(authParams?: OauthParams, authToken?: string);
     get note(): ApiRecordLinkManager;
     get file(): ApiRecordLinkManager;
     get workorder(): ApiRecordLinkManager;
+    get address(): 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<YfFieldServiceVisitProperties>>>;

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

@@ -51,6 +51,12 @@ class YfFieldServiceVisitApi extends api_provider_1.ApiProvider {
         }
         return this._workorder;
     }
+    get address() {
+        if (!this._address) {
+            this._address = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'FieldServiceModule:YfFieldServiceVisit', 'CrmModule:Address', 'YfFieldServiceVisit__ Address');
+        }
+        return this._address;
+    }
     // ============================================
     // STANDARD METHODS (Unchanged API)
     // ============================================

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

@@ -0,0 +1,149 @@
+/**
+ * YfFieldServiceVisit DB Accessor
+ *
+ * Provides typed access to YfFieldServiceVisit 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 YfFieldServiceVisitDbAccessor(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 { YfFieldServiceVisitProperties } from '../entities-v2/YfFieldServiceVisit';
+import { YfFieldServiceVisitRecord } from '../records-v2/YfFieldServiceVisitRecord';
+/** Search response with wrapped records */
+export interface YfFieldServiceVisitDbSearchResponse {
+    records: YfFieldServiceVisitRecord[];
+    totalRecords: number;
+    hasMore: boolean;
+}
+export declare class YfFieldServiceVisitDbAccessor {
+    private readonly _provider;
+    private readonly _moduleName;
+    private readonly _entityName;
+    private readonly _defaultOptions?;
+    /**
+     * Create a new YfFieldServiceVisitDbAccessor
+     * @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 YfFieldServiceVisit 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): YfFieldServiceVisitRecord;
+    /**
+     * Get a single YfFieldServiceVisit 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<YfFieldServiceVisitRecord>;
+    /**
+     * Get multiple YfFieldServiceVisit 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<YfFieldServiceVisitRecord[]>;
+    /**
+     * Search YfFieldServiceVisit records
+     *
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
+     */
+    search(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): Promise<YfFieldServiceVisitDbSearchResponse>;
+    /**
+     * Search all YfFieldServiceVisit records with automatic pagination
+     *
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
+     */
+    searchAll(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): Promise<YfFieldServiceVisitRecord[]>;
+    /**
+     * 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<YfFieldServiceVisitRecord[]>;
+    /**
+     * Create a fluent query builder for YfFieldServiceVisit 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<YfFieldServiceVisitProperties, YfFieldServiceVisitRecord>;
+    /** Access the underlying DbProvider */
+    get provider(): DbProvider;
+}