@d19n/youfibre-odin-sdk 2.0.13-beta.1 → 2.0.13

package/dist/records-v2/ActivityRecord.js

@@ -14,6 +14,8 @@
  * await record.createActivity({ ... }).execute();
  * ```
  *
+ * Entity Types: EVENT, NOTIFICATION, TASK
+ *
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
@@ -29,6 +31,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isActivityRecord = exports.ActivityRecord = void 0;
 const uuid_1 = require("uuid");
 const core_1 = require("@d19n/odin-types/dist/core");
+const record_link_manager_1 = require("@d19n/odin-sdk-generator/dist/record-link-manager");
+const ContactRecord_1 = require("./ContactRecord");
+const NoteRecord_1 = require("./NoteRecord");
+const OneTouchSwitchRecord_1 = require("./OneTouchSwitchRecord");
+const BillingRequestRecord_1 = require("./BillingRequestRecord");
+const OrderItemRecord_1 = require("./OrderItemRecord");
+const FileRecord_1 = require("./FileRecord");
+const CustomerDeviceOntRecord_1 = require("./CustomerDeviceOntRecord");
+const PaymentMethodRefundRecord_1 = require("./PaymentMethodRefundRecord");
+const WorkOrderRecord_1 = require("./WorkOrderRecord");
+const OrderRecord_1 = require("./OrderRecord");
 /**
  * Builder for action execution with dryRun support
  *
@@ -140,6 +153,357 @@ class ActivityRecord {
     /** Access the underlying OdinRecord (null for new records) */
     get record() { return this._record; }
     // ============================================
+    // TYPE GUARDS (with TypeScript type predicates)
+    // ============================================
+    /**
+     * Type guard: check if this record is of type EVENT
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to EVENT-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isEvent()) {
+     *   // TypeScript knows record.properties is EventActivityProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks General Events
+     */
+    isEvent() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'EVENT'; }
+    /**
+     * Type guard: check if this record is of type NOTIFICATION
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to NOTIFICATION-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isNotification()) {
+     *   // TypeScript knows record.properties is NotificationActivityProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks track notification activities
+     */
+    isNotification() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'NOTIFICATION'; }
+    /**
+     * Type guard: check if this record is of type TASK
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to TASK-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isTask()) {
+     *   // TypeScript knows record.properties is TaskActivityProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks task activity tracks if an activity is resolved
+     */
+    isTask() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'TASK'; }
+    /**
+     * Access linked Contact records
+     * @remarks Available labels: Contact__Activity
+     * @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__Activity' });
+     * ```
+     */
+    get contacts() {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('Cannot access links on a new (unsaved) record');
+        if (!this._contacts) {
+            this._contacts = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'SchemaModule:Activity',
+                targetEntity: 'CrmModule:Contact',
+                targetModuleName: 'CrmModule',
+                targetEntityName: 'Contact',
+                labels: ['Contact__Activity'],
+            }, ContactRecord_1.ContactRecord);
+        }
+        return this._contacts;
+    }
+    /**
+     * Access linked Note records
+     * @remarks Available labels: Activity__Note
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Note records
+     * const items = await record.notes.list();
+     * const first = await record.notes.first();
+     *
+     * // Filter by label
+     * const specific = await record.notes.first({ label: 'Activity__Note' });
+     * ```
+     */
+    get notes() {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('Cannot access links on a new (unsaved) record');
+        if (!this._notes) {
+            this._notes = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'SchemaModule:Activity',
+                targetEntity: 'SupportModule:Note',
+                targetModuleName: 'SupportModule',
+                targetEntityName: 'Note',
+                labels: ['Activity__Note'],
+            }, NoteRecord_1.NoteRecord);
+        }
+        return this._notes;
+    }
+    /**
+     * Access linked OneTouchSwitch records
+     * @remarks Available labels: OneTouchSwitch__Activity
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked OneTouchSwitch records
+     * const items = await record.oneTouchSwitches.list();
+     * const first = await record.oneTouchSwitches.first();
+     *
+     * // Filter by label
+     * const specific = await record.oneTouchSwitches.first({ label: 'OneTouchSwitch__Activity' });
+     * ```
+     */
+    get oneTouchSwitches() {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('Cannot access links on a new (unsaved) record');
+        if (!this._oneTouchSwitches) {
+            this._oneTouchSwitches = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'SchemaModule:Activity',
+                targetEntity: 'OrderModule:OneTouchSwitch',
+                targetModuleName: 'OrderModule',
+                targetEntityName: 'OneTouchSwitch',
+                labels: ['OneTouchSwitch__Activity'],
+            }, OneTouchSwitchRecord_1.OneTouchSwitchRecord);
+        }
+        return this._oneTouchSwitches;
+    }
+    /**
+     * Access linked BillingRequest records
+     * @remarks Available labels: BillingRequest__Activity
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked BillingRequest records
+     * const items = await record.billingRequests.list();
+     * const first = await record.billingRequests.first();
+     *
+     * // Filter by label
+     * const specific = await record.billingRequests.first({ label: 'BillingRequest__Activity' });
+     * ```
+     */
+    get billingRequests() {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('Cannot access links on a new (unsaved) record');
+        if (!this._billingRequests) {
+            this._billingRequests = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'SchemaModule:Activity',
+                targetEntity: 'BillingModule:BillingRequest',
+                targetModuleName: 'BillingModule',
+                targetEntityName: 'BillingRequest',
+                labels: ['BillingRequest__Activity'],
+            }, BillingRequestRecord_1.BillingRequestRecord);
+        }
+        return this._billingRequests;
+    }
+    /**
+     * Access linked OrderItem records
+     * @remarks Available labels: OrderItem__Activity
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked OrderItem records
+     * const items = await record.orderItems.list();
+     * const first = await record.orderItems.first();
+     *
+     * // Filter by label
+     * const specific = await record.orderItems.first({ label: 'OrderItem__Activity' });
+     * ```
+     */
+    get orderItems() {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('Cannot access links on a new (unsaved) record');
+        if (!this._orderItems) {
+            this._orderItems = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'SchemaModule:Activity',
+                targetEntity: 'OrderModule:OrderItem',
+                targetModuleName: 'OrderModule',
+                targetEntityName: 'OrderItem',
+                labels: ['OrderItem__Activity'],
+            }, OrderItemRecord_1.OrderItemRecord);
+        }
+        return this._orderItems;
+    }
+    /**
+     * Access linked File records
+     * @remarks Available labels: Activity__File
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked File records
+     * const items = await record.files.list();
+     * const first = await record.files.first();
+     *
+     * // Filter by label
+     * const specific = await record.files.first({ label: 'Activity__File' });
+     * ```
+     */
+    get files() {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('Cannot access links on a new (unsaved) record');
+        if (!this._files) {
+            this._files = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'SchemaModule:Activity',
+                targetEntity: 'SchemaModule:File',
+                targetModuleName: 'SchemaModule',
+                targetEntityName: 'File',
+                labels: ['Activity__File'],
+            }, FileRecord_1.FileRecord);
+        }
+        return this._files;
+    }
+    /**
+     * Access linked CustomerDeviceOnt records
+     * @remarks Available labels: CustomerDeviceOnt__Activity
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked CustomerDeviceOnt records
+     * const items = await record.customerDeviceOnts.list();
+     * const first = await record.customerDeviceOnts.first();
+     *
+     * // Filter by label
+     * const specific = await record.customerDeviceOnts.first({ label: 'CustomerDeviceOnt__Activity' });
+     * ```
+     */
+    get customerDeviceOnts() {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('Cannot access links on a new (unsaved) record');
+        if (!this._customerDeviceOnts) {
+            this._customerDeviceOnts = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'SchemaModule:Activity',
+                targetEntity: 'ServiceModule:CustomerDeviceOnt',
+                targetModuleName: 'ServiceModule',
+                targetEntityName: 'CustomerDeviceOnt',
+                labels: ['CustomerDeviceOnt__Activity'],
+            }, CustomerDeviceOntRecord_1.CustomerDeviceOntRecord);
+        }
+        return this._customerDeviceOnts;
+    }
+    /**
+     * Access linked PaymentMethodRefund records
+     * @remarks Available labels: PaymentMethodRefund__Activity
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked PaymentMethodRefund records
+     * const items = await record.paymentMethodRefunds.list();
+     * const first = await record.paymentMethodRefunds.first();
+     *
+     * // Filter by label
+     * const specific = await record.paymentMethodRefunds.first({ label: 'PaymentMethodRefund__Activity' });
+     * ```
+     */
+    get paymentMethodRefunds() {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('Cannot access links on a new (unsaved) record');
+        if (!this._paymentMethodRefunds) {
+            this._paymentMethodRefunds = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'SchemaModule:Activity',
+                targetEntity: 'BillingModule:PaymentMethodRefund',
+                targetModuleName: 'BillingModule',
+                targetEntityName: 'PaymentMethodRefund',
+                labels: ['PaymentMethodRefund__Activity'],
+            }, PaymentMethodRefundRecord_1.PaymentMethodRefundRecord);
+        }
+        return this._paymentMethodRefunds;
+    }
+    /**
+     * Access linked WorkOrder records
+     * @remarks Available labels: WorkOrder__Activity
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked WorkOrder records
+     * const items = await record.workOrders.list();
+     * const first = await record.workOrders.first();
+     *
+     * // Filter by label
+     * const specific = await record.workOrders.first({ label: 'WorkOrder__Activity' });
+     * ```
+     */
+    get workOrders() {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('Cannot access links on a new (unsaved) record');
+        if (!this._workOrders) {
+            this._workOrders = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'SchemaModule:Activity',
+                targetEntity: 'FieldServiceModule:WorkOrder',
+                targetModuleName: 'FieldServiceModule',
+                targetEntityName: 'WorkOrder',
+                labels: ['WorkOrder__Activity'],
+            }, WorkOrderRecord_1.WorkOrderRecord);
+        }
+        return this._workOrders;
+    }
+    /**
+     * Access linked Order records
+     * @remarks Available labels: Order__Activity
+     * @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__Activity' });
+     * ```
+     */
+    get orders() {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('Cannot access links on a new (unsaved) record');
+        if (!this._orders) {
+            this._orders = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
+                sourceEntity: 'SchemaModule:Activity',
+                targetEntity: 'OrderModule:Order',
+                targetModuleName: 'OrderModule',
+                targetEntityName: 'Order',
+                labels: ['Order__Activity'],
+            }, OrderRecord_1.OrderRecord);
+        }
+        return this._orders;
+    }
+    // ============================================
     // LINK MANAGEMENT
     // ============================================
     /**
@@ -247,6 +611,29 @@ class ActivityRecord {
     }
 }
 exports.ActivityRecord = ActivityRecord;
+// ============================================
+// TYPED LINK ACCESSORS
+// ============================================
+/** Valid labels for Contact associations */
+ActivityRecord.contactsLabels = ['Contact__Activity'];
+/** Valid labels for Note associations */
+ActivityRecord.notesLabels = ['Activity__Note'];
+/** Valid labels for OneTouchSwitch associations */
+ActivityRecord.oneTouchSwitchesLabels = ['OneTouchSwitch__Activity'];
+/** Valid labels for BillingRequest associations */
+ActivityRecord.billingRequestsLabels = ['BillingRequest__Activity'];
+/** Valid labels for OrderItem associations */
+ActivityRecord.orderItemsLabels = ['OrderItem__Activity'];
+/** Valid labels for File associations */
+ActivityRecord.filesLabels = ['Activity__File'];
+/** Valid labels for CustomerDeviceOnt associations */
+ActivityRecord.customerDeviceOntsLabels = ['CustomerDeviceOnt__Activity'];
+/** Valid labels for PaymentMethodRefund associations */
+ActivityRecord.paymentMethodRefundsLabels = ['PaymentMethodRefund__Activity'];
+/** Valid labels for WorkOrder associations */
+ActivityRecord.workOrdersLabels = ['WorkOrder__Activity'];
+/** Valid labels for Order associations */
+ActivityRecord.ordersLabels = ['Order__Activity'];
 /** Type guard to check if an object is a ActivityRecord */
 function isActivityRecord(obj) {
     return obj instanceof ActivityRecord;