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

package/README.md

@@ -352,7 +352,7 @@ This SDK includes **164** entities across **12** modules.
 
 ## Actions
 
-This SDK includes **579** actions.
+This SDK includes **580** actions.
 
 ### Action Types
 
@@ -1310,6 +1310,16 @@ This SDK includes **579** actions.
 | `CreateOrderCheck` | CREATE | k1.t-hEOJjsDb.ServiceModule.OrderCheck.Create.CreateOrderCheck |
 | `Update` | UPDATE | k1.t-hEOJjsDb.ServiceModule.OrderCheck.Update.Update |
 
+#### OrderItem
+
+| Action | Type | Event |
+|--------|------|-------|
+| `CreateOrderItemFromBrsk` | CREATE | k1.t-t-hEOJjsDb.OrderModule.OrderItem.Create.CreateOrderItemFromBrsk |
+| `CreateRecontractOrderItem` | CREATE | k1.t-hEOJjsDb.OrderModule.OrderItem.Create.CreateRecontractOrderItem |
+| `OrderItemUpdate` | UPDATE | k1.t-hEOJjsDb.OrderModule.OrderItem.Update.OrderItemUpdate |
+| `PriceMatch` | UPDATE | k1.t-hEOJjsDb.OrderModule.OrderItem.Update.PriceMatch |
+| `ReassociateOrderItemDevices` | UPDATE | k1.t-hEOJjsDb.OrderModule.OrderItem.Update.ReassociateOrderItemDevices |
+
 #### OrderKci
 
 | Action | Type | Event |
@@ -1598,15 +1608,6 @@ This SDK includes **579** actions.
 | `CreatePushNotification` | CREATE | k1.t-hEOJjsDb.NotificationModule.PushNotification.Create.CreatePushNotification |
 | `UpdatePushNotification` | UPDATE | k1.t-hEOJjsDb.NotificationModule.PushNotification.Update.UpdatePushNotification |
 
-#### OrderItem
-
-| Action | Type | Event |
-|--------|------|-------|
-| `CreateRecontractOrderItem` | CREATE | k1.t-hEOJjsDb.OrderModule.OrderItem.Create.CreateRecontractOrderItem |
-| `OrderItemUpdate` | UPDATE | k1.t-hEOJjsDb.OrderModule.OrderItem.Update.OrderItemUpdate |
-| `PriceMatch` | UPDATE | k1.t-hEOJjsDb.OrderModule.OrderItem.Update.PriceMatch |
-| `ReassociateOrderItemDevices` | UPDATE | k1.t-hEOJjsDb.OrderModule.OrderItem.Update.ReassociateOrderItemDevices |
-
 #### VoiceConfiguration
 
 | Action | Type | Event |

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

@@ -21,8 +21,83 @@ export interface CreateOrderFromBrskMessage extends OdinRecordCreatedEvent<Creat
 /**
  * Properties for CreateOrderFromBrsk action
  *
+ * @property Required fields: 0
+ * @property Optional fields: 10
  */
 export interface CreateOrderFromBrskProperties {
+    /**
+     * activation status
+     *
+     * status of the order (must be activated for billing) (Sales - Order)
+     * @type {ENUM}
+     */
+    ActivationStatus?: string | null;
+    /**
+     * ExternalReference
+     *
+     * ExternalReference
+     * @type {TEXT}
+     */
+    ExternalReference?: string | null;
+    /**
+     * name
+     *
+     * Display name/title for Order records. Primary identifier for Sales team.
+     * @type {TEXT}
+     */
+    Name?: string | null;
+    /**
+     * address
+     *
+     * Reference identifier for Order relationships. Used for data integrity.
+     * @type {LOOKUP}
+     */
+    AddressId?: string | null;
+    /**
+     * contract start date
+     *
+     * the date the contract start (Sales - Order)
+     * @type {DATE}
+     * @format DD/MM/YYYY
+     */
+    ContractStartDate?: string | null;
+    /**
+     * billing start date
+     *
+     * Billing start date (Sales - Order)
+     * @type {DATE}
+     * @format DD/MM/YYYY
+     */
+    BillingStartDate?: string | null;
+    /**
+     * source
+     *
+     * Data field for Order records. Used by Sales team.
+     * @type {TEXT}
+     */
+    Source?: string | null;
+    /**
+     * provider
+     *
+     * network provider (Sales - Order)
+     * @type {ENUM}
+     */
+    Provider?: string | null;
+    /**
+     * contract end date
+     *
+     * the date the contract will end (Sales - Order)
+     * @type {DATE}
+     * @format DD/MM/YYYY
+     */
+    ContractEndDate?: string | null;
+    /**
+     * Desired Billing Day
+     *
+     * Desired Billing Day (Sales - Order)
+     * @type {NUMBER}
+     */
+    DesiredBillingDay?: number | null;
 }
 /**
  * CreateOrderFromBrsk

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

@@ -0,0 +1,191 @@
+/**
+ * CreateOrderItemFromBrsk Action DTO
+ *
+ * CreateOrderItemFromBrsk
+ *
+ * @module OrderModule
+ * @entity OrderItem
+ * @actionKey CreateOrderItemFromBrsk
+ * @event k1.t-t-hEOJjsDb.OrderModule.OrderItem.Create.CreateOrderItemFromBrsk
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for CreateOrderItemFromBrsk created events
+ *
+ * @event k1.t-t-hEOJjsDb.OrderModule.OrderItem.Create.CreateOrderItemFromBrsk
+ */
+export interface CreateOrderItemFromBrskMessage extends OdinRecordCreatedEvent<CreateOrderItemFromBrskDto, CreateOrderItemFromBrskProperties> {
+}
+/**
+ * Properties for CreateOrderItemFromBrsk action
+ *
+ * @property Required fields: 0
+ * @property Optional fields: 19
+ */
+export interface CreateOrderItemFromBrskProperties {
+    /**
+     * ExternalReference
+     *
+     * ExternalReference
+     * @type {TEXT}
+     */
+    ExternalReference?: string | null;
+    /**
+     * activation status
+     *
+     * status of the order item (must be closed for billing) (Sales - OrderItem)
+     * @type {ENUM}
+     */
+    ActivationStatus?: string | null;
+    /**
+     * description
+     *
+     * description of the order item (Sales - OrderItem)
+     * @type {TEXT}
+     */
+    Description?: string | null;
+    /**
+     * Discount2Length
+     *
+     * Discount2Length (Sales - OrderItem)
+     * @type {NUMBER}
+     */
+    Discount2Length?: number | null;
+    /**
+     * taxable
+     *
+     * is the item taxable (Sales - OrderItem)
+     * @type {ENUM}
+     */
+    Taxable?: string | null;
+    /**
+     * tax rate
+     *
+     * tax rate for the item (Sales - OrderItem)
+     * @type {NUMBER}
+     */
+    TaxRate?: number | null;
+    /**
+     * Is tax included
+     *
+     * is tax included in the UnitPrice (Sales - OrderItem)
+     * @type {ENUM}
+     */
+    TaxIncluded?: string | null;
+    /**
+     * discount 2 type
+     *
+     * the type of discount (Sales - OrderItem)
+     * @type {ENUM}
+     */
+    Discount2Type?: string | null;
+    /**
+     * unit price
+     *
+     * suggested retail price cost + markup (Sales - OrderItem)
+     * @type {CURRENCY}
+     */
+    UnitPrice?: string | null;
+    /**
+     * Product Id
+     *
+     * id of the product (Sales - OrderItem)
+     * @type {UUID}
+     */
+    ProductRef?: string | null;
+    /**
+     * ProductPbRelationId
+     *
+     * ProductPbRelationId (Sales - OrderItem)
+     * @type {UUID}
+     */
+    ProductPbRelationId?: string | null;
+    /**
+     * product category
+     *
+     * category of the product being sold (Sales - OrderItem)
+     * @type {TEXT}
+     */
+    ProductCategory?: string | null;
+    /**
+     * product customer type
+     *
+     * product customer type (Sales - OrderItem)
+     * @type {TEXT}
+     */
+    ProductCustomerType?: string | null;
+    /**
+     * product type
+     *
+     * the type of product being sold (Sales - OrderItem)
+     * @type {TEXT}
+     */
+    ProductType?: string | null;
+    /**
+     * discount 2 value
+     *
+     * the value of the 2nd discount (Sales - OrderItem)
+     * @type {CURRENCY}
+     */
+    Discount2Value?: string | null;
+    /**
+     * DiscountLength
+     *
+     * DiscountLength (Sales - OrderItem)
+     * @type {NUMBER}
+     */
+    DiscountLength?: number | null;
+    /**
+     * discount type
+     *
+     * the type of discount (Sales - OrderItem)
+     * @type {ENUM}
+     */
+    DiscountType?: string | null;
+    /**
+     * discount value
+     *
+     * the value to discount (Sales - OrderItem)
+     * @type {CURRENCY}
+     */
+    DiscountValue?: string | null;
+    /**
+     * quantity
+     *
+     * quantity item (Sales - OrderItem)
+     * @type {NUMBER}
+     */
+    Quantity?: number | null;
+}
+/**
+ * CreateOrderItemFromBrsk
+ *
+ * @actionType CREATE - Creates a new OrderItem record
+ * @module OrderModule
+ * @entity OrderItem
+ * @event k1.t-t-hEOJjsDb.OrderModule.OrderItem.Create.CreateOrderItemFromBrsk
+ * @permission schema.action.createorderitemfrombrsk.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class CreateOrderItemFromBrskDto extends OdinRecordCreateDto<CreateOrderItemFromBrskProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "CREATE";
+    static readonly ACTION_KEY = "CreateOrderItemFromBrsk";
+    static readonly MODULE_NAME = "OrderModule";
+    static readonly ENTITIES: string[];
+    static readonly EVENT_NAME = "k1.t-t-hEOJjsDb.OrderModule.OrderItem.Create.CreateOrderItemFromBrsk";
+    static readonly PERMISSION = "schema.action.createorderitemfrombrsk.trigger";
+    /** Step metadata - entity this action targets */
+    static readonly STEP_ENTITY = "OrderModule:OrderItem";
+    static readonly STEP_SCHEMA_ID = "4966152a-6468-462a-bd76-b48992e6769f";
+    static readonly STEP_SCHEMA_ACTION_ID = "c8c9e5d9-0c44-4248-962f-75c7720e15a7";
+    static readonly AUTO_LINK_PARENT = true;
+    readonly actionName: string;
+    readonly schemaActionId: string;
+    readonly entity: string;
+    constructor(properties: CreateOrderItemFromBrskProperties, options?: {
+        journeyId?: string;
+    });
+}

package/dist/actions-v2/CreateOrderItemFromBrskDto.js

@@ -0,0 +1,52 @@
+"use strict";
+/**
+ * CreateOrderItemFromBrsk Action DTO
+ *
+ * CreateOrderItemFromBrsk
+ *
+ * @module OrderModule
+ * @entity OrderItem
+ * @actionKey CreateOrderItemFromBrsk
+ * @event k1.t-t-hEOJjsDb.OrderModule.OrderItem.Create.CreateOrderItemFromBrsk
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateOrderItemFromBrskDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * CreateOrderItemFromBrsk
+ *
+ * @actionType CREATE - Creates a new OrderItem record
+ * @module OrderModule
+ * @entity OrderItem
+ * @event k1.t-t-hEOJjsDb.OrderModule.OrderItem.Create.CreateOrderItemFromBrsk
+ * @permission schema.action.createorderitemfrombrsk.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class CreateOrderItemFromBrskDto extends core_1.OdinRecordCreateDto {
+    constructor(properties, options) {
+        super({
+            entity: 'OrderModule:OrderItem',
+            type: undefined,
+            properties,
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+        });
+        this.actionName = 'CreateOrderItemFromBrsk';
+        this.schemaActionId = 'c8c9e5d9-0c44-4248-962f-75c7720e15a7';
+        this.entity = 'OrderModule:OrderItem';
+    }
+}
+exports.CreateOrderItemFromBrskDto = CreateOrderItemFromBrskDto;
+/** Used by SDK generators to identify action type */
+CreateOrderItemFromBrskDto.ACTION_TYPE = 'CREATE';
+CreateOrderItemFromBrskDto.ACTION_KEY = 'CreateOrderItemFromBrsk';
+CreateOrderItemFromBrskDto.MODULE_NAME = 'OrderModule';
+CreateOrderItemFromBrskDto.ENTITIES = ['OrderItem'];
+CreateOrderItemFromBrskDto.EVENT_NAME = 'k1.t-t-hEOJjsDb.OrderModule.OrderItem.Create.CreateOrderItemFromBrsk';
+CreateOrderItemFromBrskDto.PERMISSION = 'schema.action.createorderitemfrombrsk.trigger';
+/** Step metadata - entity this action targets */
+CreateOrderItemFromBrskDto.STEP_ENTITY = 'OrderModule:OrderItem';
+CreateOrderItemFromBrskDto.STEP_SCHEMA_ID = '4966152a-6468-462a-bd76-b48992e6769f';
+CreateOrderItemFromBrskDto.STEP_SCHEMA_ACTION_ID = 'c8c9e5d9-0c44-4248-962f-75c7720e15a7';
+CreateOrderItemFromBrskDto.AUTO_LINK_PARENT = true;

package/dist/entities-v2/Order.d.ts

@@ -273,6 +273,8 @@ export declare enum OrderDiscountUnit {
  * Use these constants instead of string literals for type safety
  */
 export declare enum OrderPropertyKeys {
+    /** ExternalReference */
+    ExternalReference = "ExternalReference",
     /** Data field for Order records. Used by Sales team. */
     VatNumber = "VATNumber",
     /** the datetime when the amendment was performed (Sales - Order) */
@@ -452,6 +454,11 @@ export declare enum OrderPropertyKeys {
  * @see OrderModule:Order
  */
 export interface OrderProperties {
+    /** ExternalReference
+     *
+     * @type {TEXT}
+     */
+    ExternalReference: string;
     /** Data field for Order records. Used by Sales team.
      *
      * @type {TEXT}

package/dist/entities-v2/Order.js

@@ -255,6 +255,8 @@ var OrderDiscountUnit;
  */
 var OrderPropertyKeys;
 (function (OrderPropertyKeys) {
+    /** ExternalReference */
+    OrderPropertyKeys["ExternalReference"] = "ExternalReference";
     /** Data field for Order records. Used by Sales team. */
     OrderPropertyKeys["VatNumber"] = "VATNumber";
     /** the datetime when the amendment was performed (Sales - Order) */

package/dist/entities-v2/OrderItem.d.ts

@@ -135,6 +135,8 @@ export declare enum OrderItemTaxable {
  * Use these constants instead of string literals for type safety
  */
 export declare enum OrderItemPropertyKeys {
+    /** ExternalReference */
+    ExternalReference = "ExternalReference",
     /** name of the order item (Sales - OrderItem) */
     Name = "Name",
     /** the date the trial period ends (Sales - OrderItem) */
@@ -214,6 +216,11 @@ export declare enum OrderItemPropertyKeys {
  * @see OrderModule:OrderItem
  */
 export interface OrderItemProperties {
+    /** ExternalReference
+     *
+     * @type {TEXT}
+     */
+    ExternalReference: string;
     /** name of the order item (Sales - OrderItem)
      *
      * @type {TEXT}

package/dist/entities-v2/OrderItem.js

@@ -132,6 +132,8 @@ var OrderItemTaxable;
  */
 var OrderItemPropertyKeys;
 (function (OrderItemPropertyKeys) {
+    /** ExternalReference */
+    OrderItemPropertyKeys["ExternalReference"] = "ExternalReference";
     /** name of the order item (Sales - OrderItem) */
     OrderItemPropertyKeys["Name"] = "Name";
     /** the date the trial period ends (Sales - OrderItem) */

package/dist/entities-v2/Product.d.ts

@@ -309,8 +309,6 @@ export declare enum ProductContractType {
  * Use these constants instead of string literals for type safety
  */
 export declare enum ProductPropertyKeys {
-    /** External Reference ID */
-    ExternalRef = "ExternalRef",
     /** suggested price to sell a single product (Product Management - Product) */
     UnitPrice = "UnitPrice",
     /** promo label pricing box down (Product Management - Product) */
@@ -418,11 +416,6 @@ export declare enum ProductPropertyKeys {
  * @see ProductModule:Product
  */
 export interface ProductProperties {
-    /** External Reference ID
-     *
-     * @type {TEXT}
-     */
-    ExternalRef: string;
     /** suggested price to sell a single product (Product Management - Product)
      *
      * @type {CURRENCY}
@@ -735,11 +728,6 @@ export interface ProductProperties {
  * @see ProductModule:Product
  */
 export interface BundleProductProperties {
-    /** External Reference ID
-     *
-     * @type {TEXT}
-     */
-    ExternalRef: string;
     /** suggested price to sell a single product (Product Management - Product)
      *
      * @type {CURRENCY}
@@ -1052,11 +1040,6 @@ export interface BundleProductProperties {
  * @see ProductModule:Product
  */
 export interface InternetProductProperties {
-    /** External Reference ID
-     *
-     * @type {TEXT}
-     */
-    ExternalRef: string;
     /** suggested price to sell a single product (Product Management - Product)
      *
      * @type {CURRENCY}
@@ -1369,11 +1352,6 @@ export interface InternetProductProperties {
  * @see ProductModule:Product
  */
 export interface LaborProductProperties {
-    /** External Reference ID
-     *
-     * @type {TEXT}
-     */
-    ExternalRef: string;
     /** suggested price to sell a single product (Product Management - Product)
      *
      * @type {CURRENCY}
@@ -1686,11 +1664,6 @@ export interface LaborProductProperties {
  * @see ProductModule:Product
  */
 export interface LandlineProductProperties {
-    /** External Reference ID
-     *
-     * @type {TEXT}
-     */
-    ExternalRef: string;
     /** suggested price to sell a single product (Product Management - Product)
      *
      * @type {CURRENCY}
@@ -2003,11 +1976,6 @@ export interface LandlineProductProperties {
  * @see ProductModule:Product
  */
 export interface MeshProductProperties {
-    /** External Reference ID
-     *
-     * @type {TEXT}
-     */
-    ExternalRef: string;
     /** suggested price to sell a single product (Product Management - Product)
      *
      * @type {CURRENCY}
@@ -2320,11 +2288,6 @@ export interface MeshProductProperties {
  * @see ProductModule:Product
  */
 export interface MobileProductProperties {
-    /** External Reference ID
-     *
-     * @type {TEXT}
-     */
-    ExternalRef: string;
     /** suggested price to sell a single product (Product Management - Product)
      *
      * @type {CURRENCY}
@@ -2637,11 +2600,6 @@ export interface MobileProductProperties {
  * @see ProductModule:Product
  */
 export interface TelevisionProductProperties {
-    /** External Reference ID
-     *
-     * @type {TEXT}
-     */
-    ExternalRef: string;
     /** suggested price to sell a single product (Product Management - Product)
      *
      * @type {CURRENCY}

package/dist/entities-v2/Product.js

@@ -323,8 +323,6 @@ var ProductContractType;
  */
 var ProductPropertyKeys;
 (function (ProductPropertyKeys) {
-    /** External Reference ID */
-    ProductPropertyKeys["ExternalRef"] = "ExternalRef";
     /** suggested price to sell a single product (Product Management - Product) */
     ProductPropertyKeys["UnitPrice"] = "UnitPrice";
     /** promo label pricing box down (Product Management - Product) */

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

@@ -13,15 +13,22 @@
  * await record.createAccountCredit({ ... }).execute();
  * ```
  *
+ * Entity Types: DEFAULT
+ *
  * 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 { AccountCreditProperties } from '../entities-v2/AccountCredit';
 import { CreateAccountCreditProperties } from '../actions-v2/CreateAccountCreditDto';
 import { UpdateAccountCreditBalanceProperties } from '../actions-v2/UpdateAccountCreditBalanceDto';
+import { ContactRecord } from './ContactRecord';
+import { InvoiceRecord } from './InvoiceRecord';
+/** Valid entity types for AccountCredit */
+export declare type AccountCreditType = 'DEFAULT';
 /**
  * Builder for action execution with dryRun support
  *
@@ -85,6 +92,8 @@ export declare class AccountCreditRecord<TProps = AccountCreditProperties> {
     private _provider;
     private _pendingLinks;
     private _preGeneratedId;
+    private _contacts?;
+    private _invoices?;
     /**
      * Create a record wrapper.
      * @param record - The underlying record, or null for create operations
@@ -97,7 +106,7 @@ export declare class AccountCreditRecord<TProps = AccountCreditProperties> {
     /** Record ID - always available (pre-generated for new records) */
     get id(): string;
     get entity(): string;
-    get type(): string | undefined;
+    get type(): AccountCreditType | undefined;
     /** Record properties - empty object for new (unsaved) records */
     get properties(): TProps;
     get title(): string | undefined;
@@ -110,6 +119,58 @@ export declare class AccountCreditRecord<TProps = AccountCreditProperties> {
     get groups(): string[];
     /** Access the underlying OdinRecord (null for new records) */
     get record(): OdinRecord<TProps> | null;
+    /**
+     * Type guard: check if this record is of type DEFAULT
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to DEFAULT-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isDefault()) {
+     *   // TypeScript knows record.properties is AccountCreditProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks This is the default record type
+     */
+    isDefault(): this is AccountCreditRecord<AccountCreditProperties>;
+    /** Valid labels for Contact associations */
+    static readonly contactsLabels: readonly ["Contact__AccountCredit"];
+    /**
+     * Access linked Contact records
+     * @remarks Available labels: Contact__AccountCredit
+     * @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__AccountCredit' });
+     * ```
+     */
+    get contacts(): RecordLinkManager<ContactRecord, typeof AccountCreditRecord['contactsLabels'][number]>;
+    /** Valid labels for Invoice associations */
+    static readonly invoicesLabels: readonly ["AccountCredit__Invoice"];
+    /**
+     * Access linked Invoice records
+     * @remarks Available labels: AccountCredit__Invoice
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * // Get all linked Invoice records
+     * const items = await record.invoices.list();
+     * const first = await record.invoices.first();
+     *
+     * // Filter by label
+     * const specific = await record.invoices.first({ label: 'AccountCredit__Invoice' });
+     * ```
+     */
+    get invoices(): RecordLinkManager<InvoiceRecord, typeof AccountCreditRecord['invoicesLabels'][number]>;
     /**
      * Queue a link to be created with the next action.
      * Works for both create and update actions.