@d19n/youfibre-odin-sdk 2.0.13 → 2.0.14

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

@@ -1,3020 +0,0 @@
-/**
- * Product Entity Definition
- *
- * Product entity for Product Management operations. Part of ProductModule. Contains business data for product management workflows.
- *
- * @module ProductModule
- * @entity Product
- * @schemaId 3dbe2648-7faa-4f21-bd3d-5acc86ebff26
- *
- * AUTO-GENERATED - DO NOT EDIT DIRECTLY
- * Generated from Odin schema definition
- */
-import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
-import { LeadProperties } from './Lead';
-import { RestrictionProperties } from './Restriction';
-import { ProductComponentProperties } from './ProductComponent';
-import { OfferProperties } from './Offer';
-import { ServiceProperties } from './Service';
-import { ConsumptionScheduleProperties } from './ConsumptionSchedule';
-import { VendorProperties } from './Vendor';
-import { PriceBookProperties } from './PriceBook';
-import { OrderItemProperties } from './OrderItem';
-import { FieldServiceProductProperties } from './FieldServiceProduct';
-/**
- * Available types for Product records
- */
-export declare enum ProductEntityTypes {
-    /** Bundle */
-    BUNDLE = "BUNDLE",
-    /** Internet */
-    INTERNET = "INTERNET",
-    /** Labor */
-    LABOR = "LABOR",
-    /** Landline */
-    LANDLINE = "LANDLINE",
-    /** Mesh */
-    MESH = "MESH",
-    /** Mobile */
-    MOBILE = "MOBILE",
-    /** TV product */
-    TELEVISION = "TELEVISION"
-}
-/**
- * Valid values for Product.RequiresOnSiteSetup
- *
- * does the product require on-site setup (Product Management - Product)
- *
- * @remarks Available options:
- * - `NO` - No
- * - `YES` - Yes
- */
-export declare enum ProductRequiresOnSiteSetup {
-    NO = "NO",
-    YES = "YES"
-}
-/**
- * Valid values for Product.UnitType
- *
- * unit of measure the product (Product Management - Product)
- *
- * @remarks Available options:
- * - `100_METER` - Per 100 Meter
- * - `LINEAR_METER` - Per Linear Meter
- * - `UNIT` - Per Unit
- */
-export declare enum ProductUnitType {
-    PER_100_METER = "100_METER",
-    PER_LINEAR_METER = "LINEAR_METER",
-    PER_UNIT = "UNIT"
-}
-/**
- * Valid values for Product.CustomerType
- *
- * customer type the product is available to (Product Management - Product)
- *
- * @remarks Available options:
- * - `BUSINESS` - Business
- * - `RESIDENTIAL` - Residential
- */
-export declare enum ProductCustomerType {
-    BUSINESS = "BUSINESS",
-    RESIDENTIAL = "RESIDENTIAL"
-}
-/**
- * Valid values for Product.TrialUnit
- *
- * trial unit for the product (Product Management - Product)
- *
- * @remarks Available options:
- * - `DAYS` - Days
- * - `MONTHS` - Month
- */
-export declare enum ProductTrialUnit {
-    DAYS = "DAYS",
-    MONTH = "MONTHS"
-}
-/**
- * Valid values for Product.IntervalUnit
- *
- * unit for the billing interval (Product Management - Product)
- *
- * @remarks Available options:
- * - `DAYS` - Days
- * - `MONTHS` - Month
- */
-export declare enum ProductIntervalUnit {
-    DAYS = "DAYS",
-    MONTH = "MONTHS"
-}
-/**
- * Valid values for Product.Type
- *
- * type of product (Product Management - Product)
- *
- * @remarks Available options:
- * - `ADD_ON_PRODUCT` - Add-on product
- * - `ASSEMBLY` - Assembly
- * - `BASE_PRODUCT` - Base product
- * - `NON_INVENTORY` - Non inventory
- */
-export declare enum ProductType {
-    ADD_ON_PRODUCT = "ADD_ON_PRODUCT",
-    ASSEMBLY = "ASSEMBLY",
-    BASE_PRODUCT = "BASE_PRODUCT",
-    NON_INVENTORY = "NON_INVENTORY"
-}
-/**
- * Valid values for Product.DiscountUnit
- *
- * discount duration unit (Product Management - Product)
- *
- * @remarks Available options:
- * - `DAYS` - Days
- * - `MONTHS` - Month
- * - `ON_GOING` - On-going
- */
-export declare enum ProductDiscountUnit {
-    DAYS = "DAYS",
-    MONTH = "MONTHS",
-    ON_GOING = "ON_GOING"
-}
-/**
- * Valid values for Product.DiscountType
- *
- * the type of discount (Product Management - Product)
- *
- * @remarks Available options:
- * - `AMOUNT` - Amount
- * - `PERCENT` - Percent
- */
-export declare enum ProductDiscountType {
-    AMOUNT = "AMOUNT",
-    PERCENT = "PERCENT"
-}
-/**
- * Valid values for Product.Taxable
- *
- * is the product taxable (Product Management - Product)
- *
- * @remarks Available options:
- * - `NO` - No
- * - `YES` - Yes
- */
-export declare enum ProductTaxable {
-    NO = "NO",
-    YES = "YES"
-}
-/**
- * Valid values for Product.Discount2Type
- *
- * the type of discount (AMOUNT | PERCENT) (Product Management - Product)
- *
- * @remarks Available options:
- * - `AMOUNT` - Amount
- * - `PERCENT` - Percent
- */
-export declare enum ProductDiscount2Type {
-    AMOUNT = "AMOUNT",
-    PERCENT = "PERCENT"
-}
-/**
- * Valid values for Product.ChargeType
- *
- * charge type (Product Management - Product)
- *
- * @remarks Available options:
- * - `ONE_TIME` - One-Time
- * - `RECURRING` - Recurring
- * - `USAGE` - Usage
- */
-export declare enum ProductChargeType {
-    ONE_TIME = "ONE_TIME",
-    RECURRING = "RECURRING",
-    USAGE = "USAGE"
-}
-/**
- * Valid values for Product.Discount2Unit
- *
- * the unit type for discount2 (Product Management - Product)
- *
- * @remarks Available options:
- * - `DAYS` - Days
- * - `MONTHS` - Months
- * - `ON_GOING` - On-going
- */
-export declare enum ProductDiscount2Unit {
-    DAYS = "DAYS",
-    MONTHS = "MONTHS",
-    ON_GOING = "ON_GOING"
-}
-/**
- * Valid values for Product.Category
- *
- * category of the product (Product Management - Product)
- *
- * @remarks Available options:
- * - `BROADBAND` - Broadband
- * - `LABOR` - Labor
- * - `MATERIAL` - Material
- * - `TELEVISION` - Television
- * - `VOICE` - Voice
- */
-export declare enum ProductCategory {
-    BROADBAND = "BROADBAND",
-    LABOR = "LABOR",
-    MATERIAL = "MATERIAL",
-    TELEVISION = "TELEVISION",
-    VOICE = "VOICE"
-}
-/**
- * Valid values for Product.RequiresProvisioning
- *
- * does the product require service provisioning (Product Management - Product)
- *
- * @remarks Available options:
- * - `NO` - No
- * - `YES` - Yes
- */
-export declare enum ProductRequiresProvisioning {
-    NO = "NO",
-    YES = "YES"
-}
-/**
- * Valid values for Product.Shippable
- *
- * can the product be shipped to the end customer (Product Management - Product)
- *
- * @remarks Available options:
- * - `NO` - No
- * - `YES` - Yes
- */
-export declare enum ProductShippable {
-    NO = "NO",
-    YES = "YES"
-}
-/**
- * Valid values for Product.Retrievable
- *
- * retrievable product (leased, rented) (Product Management - Product)
- *
- * @remarks Available options:
- * - `NO` - No
- * - `YES` - Yes
- */
-export declare enum ProductRetrievable {
-    NO = "NO",
-    YES = "YES"
-}
-/**
- * Valid values for Product.TaxIncluded
- *
- * is the tax included in the UnitPrice (Product Management - Product)
- *
- * @remarks Available options:
- * - `NO` - No
- * - `YES` - Yes
- */
-export declare enum ProductTaxIncluded {
-    NO = "NO",
-    YES = "YES"
-}
-/**
- * Valid values for Product.ContractType
- *
- * the type of contract required (Product Management - Product)
- *
- * @remarks Available options:
- * - `ANNUAL_12` - 12 months
- * - `ANNUAL_18` - 18 months
- * - `ANNUAL_19` - 19 months
- * - `MONTHLY` - 1 month
- * - `ANNUAL_20` - 20 months
- * - `ANNUAL_21` - 21 months
- * - `ANNUAL_22` - 22 months
- * - `ANNUAL_23` - 23 months
- * - `ANNUAL_24` - 24 months
- * - `ANNUAL_25` - 25 months
- * - `ANNUAL_26` - 26 months
- * - `ANNUAL_27` - 27 months
- * - `ANNUAL_28` - 28 months
- * - `ANNUAL_29` - 29 months
- * - `ANNUAL_30` - 30 months
- * - ... and 14 more
- */
-export declare enum ProductContractType {
-}
-/**
- * Property keys for Product
- * Use these constants instead of string literals for type safety
- */
-export declare enum ProductPropertyKeys {
-    /** suggested price to sell a single product (Product Management - Product) */
-    UnitPrice = "UnitPrice",
-    /** promo label pricing box down (Product Management - Product) */
-    PromoTextLabelDown = "PromoTextLabelDown",
-    /** will determine if the trial cancel T&Cs are  shown in the orders confirmations (Product Management - Product) */
-    IsTrialCancelable = "IsTrialCancelable",
-    /** description of the product (Product Management - Product) */
-    Description = "Description",
-    /** Customer Product Description (Product Management - Product) */
-    CustomerProductDescription = "CustomerProductDescription",
-    /** The product SKU set by the business (Product Management - Product) */
-    Sku = "SKU",
-    /** does the product require on-site setup (Product Management - Product) */
-    RequiresOnSiteSetup = "RequiresOnSiteSetup",
-    /** unit of measure the product (Product Management - Product) */
-    UnitType = "UnitType",
-    /** The Stock Keeping Unit number from the Manufacturer (Product Management - Product) */
-    ManufacturerSku = "ManufacturerSku",
-    /** minimum sale price of the product components default is UnitCost (Product Management - Product) */
-    MinimumSalePrice = "MinimumSalePrice",
-    /** The legal terms of the product (Product Management - Product) */
-    LegalTerms = "LegalTerms",
-    /** length of the billing interval, set to 0 for one-time charges (Product Management - Product) */
-    IntervalLength = "IntervalLength",
-    /** length for the items trial length (Product Management - Product) */
-    TrialLength = "TrialLength",
-    /** quantity in stock (Product Management - Product) */
-    InStockQuantity = "InStockQuantity",
-    /** customer type the product is available to (Product Management - Product) */
-    CustomerType = "CustomerType",
-    /** trial unit for the product (Product Management - Product) */
-    TrialUnit = "TrialUnit",
-    /** unit for the billing interval (Product Management - Product) */
-    IntervalUnit = "IntervalUnit",
-    /** type of product (Product Management - Product) */
-    Type = "Type",
-    /** the value to discount (Product Management - Product) */
-    DiscountValue = "DiscountValue",
-    /** discount duration unit (Product Management - Product) */
-    DiscountUnit = "DiscountUnit",
-    /** the type of discount (Product Management - Product) */
-    DiscountType = "DiscountType",
-    /** tax rate for the product (Product Management - Product) */
-    TaxRate = "TaxRate",
-    /** is the product taxable (Product Management - Product) */
-    Taxable = "Taxable",
-    /** item is available from this date (Product Management - Product) */
-    AvailableFrom = "AvailableFrom",
-    /** disable add ons for the product (Product Management - Product) */
-    DisableAddOns = "DisableAddOns",
-    /** Reference identifier for Product relationships. Used for data integrity. */
-    SandboxRef = "SandboxRef",
-    /** the type of discount (AMOUNT | PERCENT) (Product Management - Product) */
-    Discount2Type = "Discount2Type",
-    /** Used in the website to label the addon price cards on the YouMesh, YouPhone and StaticIp pages (Product Management - Product) */
-    DescriptionLine2 = "DescriptionLine2",
-    /** charge type (Product Management - Product) */
-    ChargeType = "ChargeType",
-    /** account item code (Product Management - Product) */
-    AccountingItemCode = "AccountingItemCode",
-    /** make this the default product (Product Management - Product) */
-    Default = "Default",
-    /** the value of discount 2 (5,10,15..) (Product Management - Product) */
-    Discount2Value = "Discount2Value",
-    /** item is available to this date (Product Management - Product) */
-    AvailableTo = "AvailableTo",
-    /** upper label of the price box (Product Management - Product) */
-    PromoTextLabelUp = "PromoTextLabelUp",
-    /** set a discount length for the discount starting after discount1 (Product Management - Product) */
-    Discount2Length = "Discount2Length",
-    /** the unit type for discount2 (Product Management - Product) */
-    Discount2Unit = "Discount2Unit",
-    /** length for the product discount duration (Product Management - Product) */
-    DiscountLength = "DiscountLength",
-    /** Product name (Product Management - Product) */
-    Name = "Name",
-    /** the line item description will show up when added to orders / invoices (Product Management - Product) */
-    LineItemDescription = "LineItemDescription",
-    /** category of the product (Product Management - Product) */
-    Category = "Category",
-    /** does the product require service provisioning (Product Management - Product) */
-    RequiresProvisioning = "RequiresProvisioning",
-    /** can the product be shipped to the end customer (Product Management - Product) */
-    Shippable = "Shippable",
-    /** retrievable product (leased, rented) (Product Management - Product) */
-    Retrievable = "Retrievable",
-    /** markup percent (Product Management - Product) */
-    MarkUpPercent = "MarkUpPercent",
-    /** is the tax included in the UnitPrice (Product Management - Product) */
-    TaxIncluded = "TaxIncluded",
-    /** The display name for the product, customer facing (Product Management - Product) */
-    DisplayName = "DisplayName",
-    /** unit cost for the product derived from product components UnitCost (Product Management - Product) */
-    UnitCost = "UnitCost",
-    /** these are the terms and conditions for the product (Product Management - Product) */
-    TermsAndConditions = "TermsAndConditions",
-    /** the type of contract required (Product Management - Product) */
-    ContractType = "ContractType",
-    /** Used in the website order flow do describe the products on the Addon section (used for the Addon products) (Product Management - Product) */
-    DescriptionLine1 = "DescriptionLine1"
-}
-/**
- * Properties for Product records
- *
- * @see ProductModule:Product
- */
-export interface ProductProperties {
-    /** suggested price to sell a single product (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     */
-    UnitPrice: string;
-    /** promo label pricing box down (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    PromoTextLabelDown: string;
-    /** will determine if the trial cancel T&Cs are  shown in the orders confirmations (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    IsTrialCancelable: boolean;
-    /** description of the product (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Description: string;
-    /** Customer Product Description (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    CustomerProductDescription: string;
-    /** The product SKU set by the business (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Sku: string;
-    /** does the product require on-site setup (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductRequiresOnSiteSetup}
-     */
-    RequiresOnSiteSetup: ProductRequiresOnSiteSetup;
-    /** unit of measure the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductUnitType}
-     */
-    UnitType: ProductUnitType;
-    /** The Stock Keeping Unit number from the Manufacturer (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     */
-    ManufacturerSku: string;
-    /** minimum sale price of the product components default is UnitCost (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     */
-    MinimumSalePrice: number;
-    /** The legal terms of the product (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    LegalTerms: string;
-    /** length of the billing interval, set to 0 for one-time charges (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 1
-     */
-    IntervalLength: number;
-    /** length for the items trial length (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     */
-    TrialLength: number;
-    /** quantity in stock (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    InStockQuantity: string;
-    /** customer type the product is available to (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductCustomerType}
-     */
-    CustomerType: ProductCustomerType;
-    /** trial unit for the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductTrialUnit}
-     */
-    TrialUnit: ProductTrialUnit;
-    /** unit for the billing interval (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductIntervalUnit}
-     */
-    IntervalUnit: ProductIntervalUnit;
-    /** type of product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default BASE_PRODUCT
-     * @enum {ProductType}
-     */
-    Type: ProductType;
-    /** the value to discount (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    DiscountValue: string;
-    /** discount duration unit (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductDiscountUnit}
-     * @hidden This field is hidden in the UI
-     */
-    DiscountUnit: ProductDiscountUnit;
-    /** the type of discount (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default AMOUNT
-     * @enum {ProductDiscountType}
-     * @hidden This field is hidden in the UI
-     */
-    DiscountType: ProductDiscountType;
-    /** tax rate for the product (Product Management - Product)
-     *
-     * @type {PERCENT}
-     * @default 0
-     */
-    TaxRate: number;
-    /** is the product taxable (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default YES
-     * @enum {ProductTaxable}
-     */
-    Taxable: ProductTaxable;
-    /** item is available from this date (Product Management - Product)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     */
-    AvailableFrom: string;
-    /** disable add ons for the product (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    DisableAddOns: boolean;
-    /** Reference identifier for Product relationships. Used for data integrity.
-     *
-     * @type {UUID}
-     */
-    SandboxRef: string;
-    /** the type of discount (AMOUNT | PERCENT) (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default AMOUNT
-     * @enum {ProductDiscount2Type}
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Type: ProductDiscount2Type;
-    /** Used in the website to label the addon price cards on the YouMesh, YouPhone and StaticIp pages (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DescriptionLine2: string;
-    /** charge type (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductChargeType}
-     */
-    ChargeType: ProductChargeType;
-    /** account item code (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     */
-    AccountingItemCode: string;
-    /** make this the default product (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    Default: boolean;
-    /** the value of discount 2 (5,10,15..) (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Value: string;
-    /** item is available to this date (Product Management - Product)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     * @hidden This field is hidden in the UI
-     */
-    AvailableTo: string;
-    /** upper label of the price box (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    PromoTextLabelUp: string;
-    /** set a discount length for the discount starting after discount1 (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Length: number;
-    /** the unit type for discount2 (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductDiscount2Unit}
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Unit: ProductDiscount2Unit;
-    /** length for the product discount duration (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    DiscountLength: number;
-    /** Product name (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Name: string;
-    /** the line item description will show up when added to orders / invoices (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    LineItemDescription: string;
-    /** category of the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default BROADBAND
-     * @enum {ProductCategory}
-     */
-    Category: ProductCategory;
-    /** does the product require service provisioning (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductRequiresProvisioning}
-     */
-    RequiresProvisioning: ProductRequiresProvisioning;
-    /** can the product be shipped to the end customer (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductShippable}
-     */
-    Shippable: ProductShippable;
-    /** retrievable product (leased, rented) (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default NO
-     * @enum {ProductRetrievable}
-     */
-    Retrievable: ProductRetrievable;
-    /** markup percent (Product Management - Product)
-     *
-     * @type {PERCENT}
-     * @default 0
-     */
-    MarkUpPercent: number;
-    /** is the tax included in the UnitPrice (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default YES
-     * @enum {ProductTaxIncluded}
-     */
-    TaxIncluded: ProductTaxIncluded;
-    /** The display name for the product, customer facing (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DisplayName: string;
-    /** unit cost for the product derived from product components UnitCost (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     */
-    UnitCost: string;
-    /** these are the terms and conditions for the product (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    TermsAndConditions: string;
-    /** the type of contract required (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductContractType}
-     */
-    ContractType: ProductContractType;
-    /** Used in the website order flow do describe the products on the Addon section (used for the Addon products) (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DescriptionLine1: string;
-}
-/**
- * Properties for BUNDLE Product records
- *
- * @see ProductModule:Product
- */
-export interface BundleProductProperties {
-    /** suggested price to sell a single product (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     */
-    UnitPrice: string;
-    /** promo label pricing box down (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    PromoTextLabelDown: string;
-    /** will determine if the trial cancel T&Cs are  shown in the orders confirmations (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    IsTrialCancelable: boolean;
-    /** description of the product (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Description: string;
-    /** Customer Product Description (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    CustomerProductDescription: string;
-    /** The product SKU set by the business (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Sku: string;
-    /** does the product require on-site setup (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductRequiresOnSiteSetup}
-     */
-    RequiresOnSiteSetup: ProductRequiresOnSiteSetup;
-    /** unit of measure the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductUnitType}
-     */
-    UnitType: ProductUnitType;
-    /** The Stock Keeping Unit number from the Manufacturer (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     */
-    ManufacturerSku: string;
-    /** minimum sale price of the product components default is UnitCost (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     */
-    MinimumSalePrice: number;
-    /** The legal terms of the product (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    LegalTerms: string;
-    /** length of the billing interval, set to 0 for one-time charges (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 1
-     */
-    IntervalLength: number;
-    /** length for the items trial length (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     */
-    TrialLength: number;
-    /** quantity in stock (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    InStockQuantity: string;
-    /** customer type the product is available to (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductCustomerType}
-     */
-    CustomerType: ProductCustomerType;
-    /** trial unit for the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductTrialUnit}
-     */
-    TrialUnit: ProductTrialUnit;
-    /** unit for the billing interval (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductIntervalUnit}
-     */
-    IntervalUnit: ProductIntervalUnit;
-    /** type of product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default BASE_PRODUCT
-     * @enum {ProductType}
-     */
-    Type: ProductType;
-    /** the value to discount (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    DiscountValue: string;
-    /** discount duration unit (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductDiscountUnit}
-     * @hidden This field is hidden in the UI
-     */
-    DiscountUnit: ProductDiscountUnit;
-    /** the type of discount (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default AMOUNT
-     * @enum {ProductDiscountType}
-     * @hidden This field is hidden in the UI
-     */
-    DiscountType: ProductDiscountType;
-    /** tax rate for the product (Product Management - Product)
-     *
-     * @type {PERCENT}
-     * @default 0
-     */
-    TaxRate: number;
-    /** is the product taxable (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default YES
-     * @enum {ProductTaxable}
-     */
-    Taxable: ProductTaxable;
-    /** item is available from this date (Product Management - Product)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     */
-    AvailableFrom: string;
-    /** disable add ons for the product (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    DisableAddOns: boolean;
-    /** Reference identifier for Product relationships. Used for data integrity.
-     *
-     * @type {UUID}
-     */
-    SandboxRef: string;
-    /** the type of discount (AMOUNT | PERCENT) (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default AMOUNT
-     * @enum {ProductDiscount2Type}
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Type: ProductDiscount2Type;
-    /** Used in the website to label the addon price cards on the YouMesh, YouPhone and StaticIp pages (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DescriptionLine2: string;
-    /** charge type (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductChargeType}
-     */
-    ChargeType: ProductChargeType;
-    /** account item code (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     */
-    AccountingItemCode: string;
-    /** make this the default product (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    Default: boolean;
-    /** the value of discount 2 (5,10,15..) (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Value: string;
-    /** item is available to this date (Product Management - Product)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     * @hidden This field is hidden in the UI
-     */
-    AvailableTo: string;
-    /** upper label of the price box (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    PromoTextLabelUp: string;
-    /** set a discount length for the discount starting after discount1 (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Length: number;
-    /** the unit type for discount2 (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductDiscount2Unit}
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Unit: ProductDiscount2Unit;
-    /** length for the product discount duration (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    DiscountLength: number;
-    /** Product name (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Name: string;
-    /** the line item description will show up when added to orders / invoices (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    LineItemDescription: string;
-    /** category of the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default BROADBAND
-     * @enum {ProductCategory}
-     */
-    Category: ProductCategory;
-    /** does the product require service provisioning (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductRequiresProvisioning}
-     */
-    RequiresProvisioning: ProductRequiresProvisioning;
-    /** can the product be shipped to the end customer (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductShippable}
-     */
-    Shippable: ProductShippable;
-    /** retrievable product (leased, rented) (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default NO
-     * @enum {ProductRetrievable}
-     */
-    Retrievable: ProductRetrievable;
-    /** markup percent (Product Management - Product)
-     *
-     * @type {PERCENT}
-     * @default 0
-     */
-    MarkUpPercent: number;
-    /** is the tax included in the UnitPrice (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default YES
-     * @enum {ProductTaxIncluded}
-     */
-    TaxIncluded: ProductTaxIncluded;
-    /** The display name for the product, customer facing (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DisplayName: string;
-    /** unit cost for the product derived from product components UnitCost (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     */
-    UnitCost: string;
-    /** these are the terms and conditions for the product (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    TermsAndConditions: string;
-    /** the type of contract required (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductContractType}
-     */
-    ContractType: ProductContractType;
-    /** Used in the website order flow do describe the products on the Addon section (used for the Addon products) (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DescriptionLine1: string;
-}
-/**
- * Properties for INTERNET Product records
- *
- * @see ProductModule:Product
- */
-export interface InternetProductProperties {
-    /** suggested price to sell a single product (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     */
-    UnitPrice: string;
-    /** promo label pricing box down (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    PromoTextLabelDown: string;
-    /** will determine if the trial cancel T&Cs are  shown in the orders confirmations (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    IsTrialCancelable: boolean;
-    /** description of the product (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Description: string;
-    /** Customer Product Description (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    CustomerProductDescription: string;
-    /** The product SKU set by the business (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Sku: string;
-    /** does the product require on-site setup (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductRequiresOnSiteSetup}
-     */
-    RequiresOnSiteSetup: ProductRequiresOnSiteSetup;
-    /** unit of measure the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductUnitType}
-     */
-    UnitType: ProductUnitType;
-    /** The Stock Keeping Unit number from the Manufacturer (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     */
-    ManufacturerSku: string;
-    /** minimum sale price of the product components default is UnitCost (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     */
-    MinimumSalePrice: number;
-    /** The legal terms of the product (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    LegalTerms: string;
-    /** length of the billing interval, set to 0 for one-time charges (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 1
-     */
-    IntervalLength: number;
-    /** length for the items trial length (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     */
-    TrialLength: number;
-    /** quantity in stock (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    InStockQuantity: string;
-    /** customer type the product is available to (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductCustomerType}
-     */
-    CustomerType: ProductCustomerType;
-    /** trial unit for the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductTrialUnit}
-     */
-    TrialUnit: ProductTrialUnit;
-    /** unit for the billing interval (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductIntervalUnit}
-     */
-    IntervalUnit: ProductIntervalUnit;
-    /** type of product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default BASE_PRODUCT
-     * @enum {ProductType}
-     */
-    Type: ProductType;
-    /** the value to discount (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    DiscountValue: string;
-    /** discount duration unit (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductDiscountUnit}
-     * @hidden This field is hidden in the UI
-     */
-    DiscountUnit: ProductDiscountUnit;
-    /** the type of discount (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default AMOUNT
-     * @enum {ProductDiscountType}
-     * @hidden This field is hidden in the UI
-     */
-    DiscountType: ProductDiscountType;
-    /** tax rate for the product (Product Management - Product)
-     *
-     * @type {PERCENT}
-     * @default 0
-     */
-    TaxRate: number;
-    /** is the product taxable (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default YES
-     * @enum {ProductTaxable}
-     */
-    Taxable: ProductTaxable;
-    /** item is available from this date (Product Management - Product)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     */
-    AvailableFrom: string;
-    /** disable add ons for the product (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    DisableAddOns: boolean;
-    /** Reference identifier for Product relationships. Used for data integrity.
-     *
-     * @type {UUID}
-     */
-    SandboxRef: string;
-    /** the type of discount (AMOUNT | PERCENT) (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default AMOUNT
-     * @enum {ProductDiscount2Type}
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Type: ProductDiscount2Type;
-    /** Used in the website to label the addon price cards on the YouMesh, YouPhone and StaticIp pages (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DescriptionLine2: string;
-    /** charge type (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductChargeType}
-     */
-    ChargeType: ProductChargeType;
-    /** account item code (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     */
-    AccountingItemCode: string;
-    /** make this the default product (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    Default: boolean;
-    /** the value of discount 2 (5,10,15..) (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Value: string;
-    /** item is available to this date (Product Management - Product)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     * @hidden This field is hidden in the UI
-     */
-    AvailableTo: string;
-    /** upper label of the price box (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    PromoTextLabelUp: string;
-    /** set a discount length for the discount starting after discount1 (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Length: number;
-    /** the unit type for discount2 (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductDiscount2Unit}
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Unit: ProductDiscount2Unit;
-    /** length for the product discount duration (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    DiscountLength: number;
-    /** Product name (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Name: string;
-    /** the line item description will show up when added to orders / invoices (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    LineItemDescription: string;
-    /** category of the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default BROADBAND
-     * @enum {ProductCategory}
-     */
-    Category: ProductCategory;
-    /** does the product require service provisioning (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductRequiresProvisioning}
-     */
-    RequiresProvisioning: ProductRequiresProvisioning;
-    /** can the product be shipped to the end customer (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductShippable}
-     */
-    Shippable: ProductShippable;
-    /** retrievable product (leased, rented) (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default NO
-     * @enum {ProductRetrievable}
-     */
-    Retrievable: ProductRetrievable;
-    /** markup percent (Product Management - Product)
-     *
-     * @type {PERCENT}
-     * @default 0
-     */
-    MarkUpPercent: number;
-    /** is the tax included in the UnitPrice (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default YES
-     * @enum {ProductTaxIncluded}
-     */
-    TaxIncluded: ProductTaxIncluded;
-    /** The display name for the product, customer facing (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DisplayName: string;
-    /** unit cost for the product derived from product components UnitCost (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     */
-    UnitCost: string;
-    /** these are the terms and conditions for the product (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    TermsAndConditions: string;
-    /** the type of contract required (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductContractType}
-     */
-    ContractType: ProductContractType;
-    /** Used in the website order flow do describe the products on the Addon section (used for the Addon products) (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DescriptionLine1: string;
-}
-/**
- * Properties for LABOR Product records
- *
- * @see ProductModule:Product
- */
-export interface LaborProductProperties {
-    /** suggested price to sell a single product (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     */
-    UnitPrice: string;
-    /** promo label pricing box down (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    PromoTextLabelDown: string;
-    /** will determine if the trial cancel T&Cs are  shown in the orders confirmations (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    IsTrialCancelable: boolean;
-    /** description of the product (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Description: string;
-    /** Customer Product Description (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    CustomerProductDescription: string;
-    /** The product SKU set by the business (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Sku: string;
-    /** does the product require on-site setup (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductRequiresOnSiteSetup}
-     */
-    RequiresOnSiteSetup: ProductRequiresOnSiteSetup;
-    /** unit of measure the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductUnitType}
-     */
-    UnitType: ProductUnitType;
-    /** The Stock Keeping Unit number from the Manufacturer (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     */
-    ManufacturerSku: string;
-    /** minimum sale price of the product components default is UnitCost (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     */
-    MinimumSalePrice: number;
-    /** The legal terms of the product (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    LegalTerms: string;
-    /** length of the billing interval, set to 0 for one-time charges (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 1
-     */
-    IntervalLength: number;
-    /** length for the items trial length (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     */
-    TrialLength: number;
-    /** quantity in stock (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    InStockQuantity: string;
-    /** customer type the product is available to (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductCustomerType}
-     */
-    CustomerType: ProductCustomerType;
-    /** trial unit for the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductTrialUnit}
-     */
-    TrialUnit: ProductTrialUnit;
-    /** unit for the billing interval (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductIntervalUnit}
-     */
-    IntervalUnit: ProductIntervalUnit;
-    /** type of product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default BASE_PRODUCT
-     * @enum {ProductType}
-     */
-    Type: ProductType;
-    /** the value to discount (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    DiscountValue: string;
-    /** discount duration unit (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductDiscountUnit}
-     * @hidden This field is hidden in the UI
-     */
-    DiscountUnit: ProductDiscountUnit;
-    /** the type of discount (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default AMOUNT
-     * @enum {ProductDiscountType}
-     * @hidden This field is hidden in the UI
-     */
-    DiscountType: ProductDiscountType;
-    /** tax rate for the product (Product Management - Product)
-     *
-     * @type {PERCENT}
-     * @default 0
-     */
-    TaxRate: number;
-    /** is the product taxable (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default YES
-     * @enum {ProductTaxable}
-     */
-    Taxable: ProductTaxable;
-    /** item is available from this date (Product Management - Product)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     */
-    AvailableFrom: string;
-    /** disable add ons for the product (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    DisableAddOns: boolean;
-    /** Reference identifier for Product relationships. Used for data integrity.
-     *
-     * @type {UUID}
-     */
-    SandboxRef: string;
-    /** the type of discount (AMOUNT | PERCENT) (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default AMOUNT
-     * @enum {ProductDiscount2Type}
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Type: ProductDiscount2Type;
-    /** Used in the website to label the addon price cards on the YouMesh, YouPhone and StaticIp pages (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DescriptionLine2: string;
-    /** charge type (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductChargeType}
-     */
-    ChargeType: ProductChargeType;
-    /** account item code (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     */
-    AccountingItemCode: string;
-    /** make this the default product (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    Default: boolean;
-    /** the value of discount 2 (5,10,15..) (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Value: string;
-    /** item is available to this date (Product Management - Product)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     * @hidden This field is hidden in the UI
-     */
-    AvailableTo: string;
-    /** upper label of the price box (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    PromoTextLabelUp: string;
-    /** set a discount length for the discount starting after discount1 (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Length: number;
-    /** the unit type for discount2 (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductDiscount2Unit}
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Unit: ProductDiscount2Unit;
-    /** length for the product discount duration (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    DiscountLength: number;
-    /** Product name (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Name: string;
-    /** the line item description will show up when added to orders / invoices (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    LineItemDescription: string;
-    /** category of the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default BROADBAND
-     * @enum {ProductCategory}
-     */
-    Category: ProductCategory;
-    /** does the product require service provisioning (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductRequiresProvisioning}
-     */
-    RequiresProvisioning: ProductRequiresProvisioning;
-    /** can the product be shipped to the end customer (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductShippable}
-     */
-    Shippable: ProductShippable;
-    /** retrievable product (leased, rented) (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default NO
-     * @enum {ProductRetrievable}
-     */
-    Retrievable: ProductRetrievable;
-    /** markup percent (Product Management - Product)
-     *
-     * @type {PERCENT}
-     * @default 0
-     */
-    MarkUpPercent: number;
-    /** is the tax included in the UnitPrice (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default YES
-     * @enum {ProductTaxIncluded}
-     */
-    TaxIncluded: ProductTaxIncluded;
-    /** The display name for the product, customer facing (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DisplayName: string;
-    /** unit cost for the product derived from product components UnitCost (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     */
-    UnitCost: string;
-    /** these are the terms and conditions for the product (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    TermsAndConditions: string;
-    /** the type of contract required (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductContractType}
-     */
-    ContractType: ProductContractType;
-    /** Used in the website order flow do describe the products on the Addon section (used for the Addon products) (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DescriptionLine1: string;
-}
-/**
- * Properties for LANDLINE Product records
- *
- * @see ProductModule:Product
- */
-export interface LandlineProductProperties {
-    /** suggested price to sell a single product (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     */
-    UnitPrice: string;
-    /** promo label pricing box down (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    PromoTextLabelDown: string;
-    /** will determine if the trial cancel T&Cs are  shown in the orders confirmations (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    IsTrialCancelable: boolean;
-    /** description of the product (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Description: string;
-    /** Customer Product Description (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    CustomerProductDescription: string;
-    /** The product SKU set by the business (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Sku: string;
-    /** does the product require on-site setup (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductRequiresOnSiteSetup}
-     */
-    RequiresOnSiteSetup: ProductRequiresOnSiteSetup;
-    /** unit of measure the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductUnitType}
-     */
-    UnitType: ProductUnitType;
-    /** The Stock Keeping Unit number from the Manufacturer (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     */
-    ManufacturerSku: string;
-    /** minimum sale price of the product components default is UnitCost (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     */
-    MinimumSalePrice: number;
-    /** The legal terms of the product (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    LegalTerms: string;
-    /** length of the billing interval, set to 0 for one-time charges (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 1
-     */
-    IntervalLength: number;
-    /** length for the items trial length (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     */
-    TrialLength: number;
-    /** quantity in stock (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    InStockQuantity: string;
-    /** customer type the product is available to (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductCustomerType}
-     */
-    CustomerType: ProductCustomerType;
-    /** trial unit for the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductTrialUnit}
-     */
-    TrialUnit: ProductTrialUnit;
-    /** unit for the billing interval (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductIntervalUnit}
-     */
-    IntervalUnit: ProductIntervalUnit;
-    /** type of product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default BASE_PRODUCT
-     * @enum {ProductType}
-     */
-    Type: ProductType;
-    /** the value to discount (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    DiscountValue: string;
-    /** discount duration unit (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductDiscountUnit}
-     * @hidden This field is hidden in the UI
-     */
-    DiscountUnit: ProductDiscountUnit;
-    /** the type of discount (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default AMOUNT
-     * @enum {ProductDiscountType}
-     * @hidden This field is hidden in the UI
-     */
-    DiscountType: ProductDiscountType;
-    /** tax rate for the product (Product Management - Product)
-     *
-     * @type {PERCENT}
-     * @default 0
-     */
-    TaxRate: number;
-    /** is the product taxable (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default YES
-     * @enum {ProductTaxable}
-     */
-    Taxable: ProductTaxable;
-    /** item is available from this date (Product Management - Product)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     */
-    AvailableFrom: string;
-    /** disable add ons for the product (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    DisableAddOns: boolean;
-    /** Reference identifier for Product relationships. Used for data integrity.
-     *
-     * @type {UUID}
-     */
-    SandboxRef: string;
-    /** the type of discount (AMOUNT | PERCENT) (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default AMOUNT
-     * @enum {ProductDiscount2Type}
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Type: ProductDiscount2Type;
-    /** Used in the website to label the addon price cards on the YouMesh, YouPhone and StaticIp pages (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DescriptionLine2: string;
-    /** charge type (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductChargeType}
-     */
-    ChargeType: ProductChargeType;
-    /** account item code (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     */
-    AccountingItemCode: string;
-    /** make this the default product (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    Default: boolean;
-    /** the value of discount 2 (5,10,15..) (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Value: string;
-    /** item is available to this date (Product Management - Product)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     * @hidden This field is hidden in the UI
-     */
-    AvailableTo: string;
-    /** upper label of the price box (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    PromoTextLabelUp: string;
-    /** set a discount length for the discount starting after discount1 (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Length: number;
-    /** the unit type for discount2 (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductDiscount2Unit}
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Unit: ProductDiscount2Unit;
-    /** length for the product discount duration (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    DiscountLength: number;
-    /** Product name (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Name: string;
-    /** the line item description will show up when added to orders / invoices (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    LineItemDescription: string;
-    /** category of the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default BROADBAND
-     * @enum {ProductCategory}
-     */
-    Category: ProductCategory;
-    /** does the product require service provisioning (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductRequiresProvisioning}
-     */
-    RequiresProvisioning: ProductRequiresProvisioning;
-    /** can the product be shipped to the end customer (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductShippable}
-     */
-    Shippable: ProductShippable;
-    /** retrievable product (leased, rented) (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default NO
-     * @enum {ProductRetrievable}
-     */
-    Retrievable: ProductRetrievable;
-    /** markup percent (Product Management - Product)
-     *
-     * @type {PERCENT}
-     * @default 0
-     */
-    MarkUpPercent: number;
-    /** is the tax included in the UnitPrice (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default YES
-     * @enum {ProductTaxIncluded}
-     */
-    TaxIncluded: ProductTaxIncluded;
-    /** The display name for the product, customer facing (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DisplayName: string;
-    /** unit cost for the product derived from product components UnitCost (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     */
-    UnitCost: string;
-    /** these are the terms and conditions for the product (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    TermsAndConditions: string;
-    /** the type of contract required (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductContractType}
-     */
-    ContractType: ProductContractType;
-    /** Used in the website order flow do describe the products on the Addon section (used for the Addon products) (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DescriptionLine1: string;
-}
-/**
- * Properties for MESH Product records
- *
- * @see ProductModule:Product
- */
-export interface MeshProductProperties {
-    /** suggested price to sell a single product (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     */
-    UnitPrice: string;
-    /** promo label pricing box down (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    PromoTextLabelDown: string;
-    /** will determine if the trial cancel T&Cs are  shown in the orders confirmations (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    IsTrialCancelable: boolean;
-    /** description of the product (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Description: string;
-    /** Customer Product Description (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    CustomerProductDescription: string;
-    /** The product SKU set by the business (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Sku: string;
-    /** does the product require on-site setup (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductRequiresOnSiteSetup}
-     */
-    RequiresOnSiteSetup: ProductRequiresOnSiteSetup;
-    /** unit of measure the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductUnitType}
-     */
-    UnitType: ProductUnitType;
-    /** The Stock Keeping Unit number from the Manufacturer (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     */
-    ManufacturerSku: string;
-    /** minimum sale price of the product components default is UnitCost (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     */
-    MinimumSalePrice: number;
-    /** The legal terms of the product (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    LegalTerms: string;
-    /** length of the billing interval, set to 0 for one-time charges (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 1
-     */
-    IntervalLength: number;
-    /** length for the items trial length (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     */
-    TrialLength: number;
-    /** quantity in stock (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    InStockQuantity: string;
-    /** customer type the product is available to (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductCustomerType}
-     */
-    CustomerType: ProductCustomerType;
-    /** trial unit for the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductTrialUnit}
-     */
-    TrialUnit: ProductTrialUnit;
-    /** unit for the billing interval (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductIntervalUnit}
-     */
-    IntervalUnit: ProductIntervalUnit;
-    /** type of product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default BASE_PRODUCT
-     * @enum {ProductType}
-     */
-    Type: ProductType;
-    /** the value to discount (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    DiscountValue: string;
-    /** discount duration unit (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductDiscountUnit}
-     * @hidden This field is hidden in the UI
-     */
-    DiscountUnit: ProductDiscountUnit;
-    /** the type of discount (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default AMOUNT
-     * @enum {ProductDiscountType}
-     * @hidden This field is hidden in the UI
-     */
-    DiscountType: ProductDiscountType;
-    /** tax rate for the product (Product Management - Product)
-     *
-     * @type {PERCENT}
-     * @default 0
-     */
-    TaxRate: number;
-    /** is the product taxable (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default YES
-     * @enum {ProductTaxable}
-     */
-    Taxable: ProductTaxable;
-    /** item is available from this date (Product Management - Product)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     */
-    AvailableFrom: string;
-    /** disable add ons for the product (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    DisableAddOns: boolean;
-    /** Reference identifier for Product relationships. Used for data integrity.
-     *
-     * @type {UUID}
-     */
-    SandboxRef: string;
-    /** the type of discount (AMOUNT | PERCENT) (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default AMOUNT
-     * @enum {ProductDiscount2Type}
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Type: ProductDiscount2Type;
-    /** Used in the website to label the addon price cards on the YouMesh, YouPhone and StaticIp pages (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DescriptionLine2: string;
-    /** charge type (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductChargeType}
-     */
-    ChargeType: ProductChargeType;
-    /** account item code (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     */
-    AccountingItemCode: string;
-    /** make this the default product (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    Default: boolean;
-    /** the value of discount 2 (5,10,15..) (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Value: string;
-    /** item is available to this date (Product Management - Product)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     * @hidden This field is hidden in the UI
-     */
-    AvailableTo: string;
-    /** upper label of the price box (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    PromoTextLabelUp: string;
-    /** set a discount length for the discount starting after discount1 (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Length: number;
-    /** the unit type for discount2 (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductDiscount2Unit}
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Unit: ProductDiscount2Unit;
-    /** length for the product discount duration (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    DiscountLength: number;
-    /** Product name (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Name: string;
-    /** the line item description will show up when added to orders / invoices (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    LineItemDescription: string;
-    /** category of the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default BROADBAND
-     * @enum {ProductCategory}
-     */
-    Category: ProductCategory;
-    /** does the product require service provisioning (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductRequiresProvisioning}
-     */
-    RequiresProvisioning: ProductRequiresProvisioning;
-    /** can the product be shipped to the end customer (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductShippable}
-     */
-    Shippable: ProductShippable;
-    /** retrievable product (leased, rented) (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default NO
-     * @enum {ProductRetrievable}
-     */
-    Retrievable: ProductRetrievable;
-    /** markup percent (Product Management - Product)
-     *
-     * @type {PERCENT}
-     * @default 0
-     */
-    MarkUpPercent: number;
-    /** is the tax included in the UnitPrice (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default YES
-     * @enum {ProductTaxIncluded}
-     */
-    TaxIncluded: ProductTaxIncluded;
-    /** The display name for the product, customer facing (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DisplayName: string;
-    /** unit cost for the product derived from product components UnitCost (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     */
-    UnitCost: string;
-    /** these are the terms and conditions for the product (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    TermsAndConditions: string;
-    /** the type of contract required (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductContractType}
-     */
-    ContractType: ProductContractType;
-    /** Used in the website order flow do describe the products on the Addon section (used for the Addon products) (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DescriptionLine1: string;
-}
-/**
- * Properties for MOBILE Product records
- *
- * @see ProductModule:Product
- */
-export interface MobileProductProperties {
-    /** suggested price to sell a single product (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     */
-    UnitPrice: string;
-    /** promo label pricing box down (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    PromoTextLabelDown: string;
-    /** will determine if the trial cancel T&Cs are  shown in the orders confirmations (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    IsTrialCancelable: boolean;
-    /** description of the product (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Description: string;
-    /** Customer Product Description (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    CustomerProductDescription: string;
-    /** The product SKU set by the business (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Sku: string;
-    /** does the product require on-site setup (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductRequiresOnSiteSetup}
-     */
-    RequiresOnSiteSetup: ProductRequiresOnSiteSetup;
-    /** unit of measure the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductUnitType}
-     */
-    UnitType: ProductUnitType;
-    /** The Stock Keeping Unit number from the Manufacturer (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     */
-    ManufacturerSku: string;
-    /** minimum sale price of the product components default is UnitCost (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     */
-    MinimumSalePrice: number;
-    /** The legal terms of the product (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    LegalTerms: string;
-    /** length of the billing interval, set to 0 for one-time charges (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 1
-     */
-    IntervalLength: number;
-    /** length for the items trial length (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     */
-    TrialLength: number;
-    /** quantity in stock (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    InStockQuantity: string;
-    /** customer type the product is available to (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductCustomerType}
-     */
-    CustomerType: ProductCustomerType;
-    /** trial unit for the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductTrialUnit}
-     */
-    TrialUnit: ProductTrialUnit;
-    /** unit for the billing interval (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductIntervalUnit}
-     */
-    IntervalUnit: ProductIntervalUnit;
-    /** type of product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default BASE_PRODUCT
-     * @enum {ProductType}
-     */
-    Type: ProductType;
-    /** the value to discount (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    DiscountValue: string;
-    /** discount duration unit (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductDiscountUnit}
-     * @hidden This field is hidden in the UI
-     */
-    DiscountUnit: ProductDiscountUnit;
-    /** the type of discount (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default AMOUNT
-     * @enum {ProductDiscountType}
-     * @hidden This field is hidden in the UI
-     */
-    DiscountType: ProductDiscountType;
-    /** tax rate for the product (Product Management - Product)
-     *
-     * @type {PERCENT}
-     * @default 0
-     */
-    TaxRate: number;
-    /** is the product taxable (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default YES
-     * @enum {ProductTaxable}
-     */
-    Taxable: ProductTaxable;
-    /** item is available from this date (Product Management - Product)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     */
-    AvailableFrom: string;
-    /** disable add ons for the product (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    DisableAddOns: boolean;
-    /** Reference identifier for Product relationships. Used for data integrity.
-     *
-     * @type {UUID}
-     */
-    SandboxRef: string;
-    /** the type of discount (AMOUNT | PERCENT) (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default AMOUNT
-     * @enum {ProductDiscount2Type}
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Type: ProductDiscount2Type;
-    /** Used in the website to label the addon price cards on the YouMesh, YouPhone and StaticIp pages (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DescriptionLine2: string;
-    /** charge type (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductChargeType}
-     */
-    ChargeType: ProductChargeType;
-    /** account item code (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     */
-    AccountingItemCode: string;
-    /** make this the default product (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    Default: boolean;
-    /** the value of discount 2 (5,10,15..) (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Value: string;
-    /** item is available to this date (Product Management - Product)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     * @hidden This field is hidden in the UI
-     */
-    AvailableTo: string;
-    /** upper label of the price box (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    PromoTextLabelUp: string;
-    /** set a discount length for the discount starting after discount1 (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Length: number;
-    /** the unit type for discount2 (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductDiscount2Unit}
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Unit: ProductDiscount2Unit;
-    /** length for the product discount duration (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    DiscountLength: number;
-    /** Product name (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Name: string;
-    /** the line item description will show up when added to orders / invoices (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    LineItemDescription: string;
-    /** category of the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default BROADBAND
-     * @enum {ProductCategory}
-     */
-    Category: ProductCategory;
-    /** does the product require service provisioning (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductRequiresProvisioning}
-     */
-    RequiresProvisioning: ProductRequiresProvisioning;
-    /** can the product be shipped to the end customer (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductShippable}
-     */
-    Shippable: ProductShippable;
-    /** retrievable product (leased, rented) (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default NO
-     * @enum {ProductRetrievable}
-     */
-    Retrievable: ProductRetrievable;
-    /** markup percent (Product Management - Product)
-     *
-     * @type {PERCENT}
-     * @default 0
-     */
-    MarkUpPercent: number;
-    /** is the tax included in the UnitPrice (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default YES
-     * @enum {ProductTaxIncluded}
-     */
-    TaxIncluded: ProductTaxIncluded;
-    /** The display name for the product, customer facing (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DisplayName: string;
-    /** unit cost for the product derived from product components UnitCost (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     */
-    UnitCost: string;
-    /** these are the terms and conditions for the product (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    TermsAndConditions: string;
-    /** the type of contract required (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductContractType}
-     */
-    ContractType: ProductContractType;
-    /** Used in the website order flow do describe the products on the Addon section (used for the Addon products) (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DescriptionLine1: string;
-}
-/**
- * Properties for TELEVISION Product records
- *
- * @see ProductModule:Product
- */
-export interface TelevisionProductProperties {
-    /** suggested price to sell a single product (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     */
-    UnitPrice: string;
-    /** promo label pricing box down (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    PromoTextLabelDown: string;
-    /** will determine if the trial cancel T&Cs are  shown in the orders confirmations (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    IsTrialCancelable: boolean;
-    /** description of the product (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Description: string;
-    /** Customer Product Description (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    CustomerProductDescription: string;
-    /** The product SKU set by the business (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Sku: string;
-    /** does the product require on-site setup (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductRequiresOnSiteSetup}
-     */
-    RequiresOnSiteSetup: ProductRequiresOnSiteSetup;
-    /** unit of measure the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductUnitType}
-     */
-    UnitType: ProductUnitType;
-    /** The Stock Keeping Unit number from the Manufacturer (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     */
-    ManufacturerSku: string;
-    /** minimum sale price of the product components default is UnitCost (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     */
-    MinimumSalePrice: number;
-    /** The legal terms of the product (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    LegalTerms: string;
-    /** length of the billing interval, set to 0 for one-time charges (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 1
-     */
-    IntervalLength: number;
-    /** length for the items trial length (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     */
-    TrialLength: number;
-    /** quantity in stock (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    InStockQuantity: string;
-    /** customer type the product is available to (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductCustomerType}
-     */
-    CustomerType: ProductCustomerType;
-    /** trial unit for the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductTrialUnit}
-     */
-    TrialUnit: ProductTrialUnit;
-    /** unit for the billing interval (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductIntervalUnit}
-     */
-    IntervalUnit: ProductIntervalUnit;
-    /** type of product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default BASE_PRODUCT
-     * @enum {ProductType}
-     */
-    Type: ProductType;
-    /** the value to discount (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    DiscountValue: string;
-    /** discount duration unit (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductDiscountUnit}
-     * @hidden This field is hidden in the UI
-     */
-    DiscountUnit: ProductDiscountUnit;
-    /** the type of discount (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default AMOUNT
-     * @enum {ProductDiscountType}
-     * @hidden This field is hidden in the UI
-     */
-    DiscountType: ProductDiscountType;
-    /** tax rate for the product (Product Management - Product)
-     *
-     * @type {PERCENT}
-     * @default 0
-     */
-    TaxRate: number;
-    /** is the product taxable (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default YES
-     * @enum {ProductTaxable}
-     */
-    Taxable: ProductTaxable;
-    /** item is available from this date (Product Management - Product)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     */
-    AvailableFrom: string;
-    /** disable add ons for the product (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    DisableAddOns: boolean;
-    /** Reference identifier for Product relationships. Used for data integrity.
-     *
-     * @type {UUID}
-     */
-    SandboxRef: string;
-    /** the type of discount (AMOUNT | PERCENT) (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default AMOUNT
-     * @enum {ProductDiscount2Type}
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Type: ProductDiscount2Type;
-    /** Used in the website to label the addon price cards on the YouMesh, YouPhone and StaticIp pages (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DescriptionLine2: string;
-    /** charge type (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductChargeType}
-     */
-    ChargeType: ProductChargeType;
-    /** account item code (Product Management - Product)
-     *
-     * @type {TEXT}
-     * @default 0
-     */
-    AccountingItemCode: string;
-    /** make this the default product (Product Management - Product)
-     *
-     * @type {BOOLEAN}
-     */
-    Default: boolean;
-    /** the value of discount 2 (5,10,15..) (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Value: string;
-    /** item is available to this date (Product Management - Product)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     * @hidden This field is hidden in the UI
-     */
-    AvailableTo: string;
-    /** upper label of the price box (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    PromoTextLabelUp: string;
-    /** set a discount length for the discount starting after discount1 (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Length: number;
-    /** the unit type for discount2 (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default MONTHS
-     * @enum {ProductDiscount2Unit}
-     * @hidden This field is hidden in the UI
-     */
-    Discount2Unit: ProductDiscount2Unit;
-    /** length for the product discount duration (Product Management - Product)
-     *
-     * @type {NUMBER}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    DiscountLength: number;
-    /** Product name (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    Name: string;
-    /** the line item description will show up when added to orders / invoices (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    LineItemDescription: string;
-    /** category of the product (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default BROADBAND
-     * @enum {ProductCategory}
-     */
-    Category: ProductCategory;
-    /** does the product require service provisioning (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductRequiresProvisioning}
-     */
-    RequiresProvisioning: ProductRequiresProvisioning;
-    /** can the product be shipped to the end customer (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductShippable}
-     */
-    Shippable: ProductShippable;
-    /** retrievable product (leased, rented) (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default NO
-     * @enum {ProductRetrievable}
-     */
-    Retrievable: ProductRetrievable;
-    /** markup percent (Product Management - Product)
-     *
-     * @type {PERCENT}
-     * @default 0
-     */
-    MarkUpPercent: number;
-    /** is the tax included in the UnitPrice (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @default YES
-     * @enum {ProductTaxIncluded}
-     */
-    TaxIncluded: ProductTaxIncluded;
-    /** The display name for the product, customer facing (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DisplayName: string;
-    /** unit cost for the product derived from product components UnitCost (Product Management - Product)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     */
-    UnitCost: string;
-    /** these are the terms and conditions for the product (Product Management - Product)
-     *
-     * @type {TEXT_LONG}
-     */
-    TermsAndConditions: string;
-    /** the type of contract required (Product Management - Product)
-     *
-     * @type {ENUM}
-     * @enum {ProductContractType}
-     */
-    ContractType: ProductContractType;
-    /** Used in the website order flow do describe the products on the Addon section (used for the Addon products) (Product Management - Product)
-     *
-     * @type {TEXT}
-     */
-    DescriptionLine1: string;
-}
-/**
- * Product entity from ProductModule
- *
- * Product entity for Product Management operations. Part of ProductModule. Contains business data for product management workflows.
- *
- * @module ProductModule
- * @entity Product
- * @schemaId 3dbe2648-7faa-4f21-bd3d-5acc86ebff26
- * @recordPrefix SKU
- * @menuLabel Products
- * @capabilities searchable, updateable, undeletable, triggerable
- */
-export declare class Product extends OdinRecord<ProductProperties> {
-    entity: 'ProductModule:Product';
-    type: ProductEntityTypes;
-    schemaId: '3dbe2648-7faa-4f21-bd3d-5acc86ebff26';
-    properties: ProductProperties;
-    /** Linked Lead records (Lead__Product) */
-    Lead: OdinLink<LinkedOdinRecord<LeadProperties>>;
-    /** Linked Restriction records (Product__Restriction) */
-    Restriction: OdinLink<LinkedOdinRecord<RestrictionProperties>>;
-    /** Linked ProductComponent records (Product__ProductComponent) */
-    ProductComponent: OdinLink<LinkedOdinRecord<ProductComponentProperties>>;
-    /** Linked Offer records (Offer__Product) */
-    Offer: OdinLink<LinkedOdinRecord<OfferProperties>>;
-    /** Linked Service records (Product__Service) */
-    Service: OdinLink<LinkedOdinRecord<ServiceProperties>>;
-    /** Linked ConsumptionSchedule records (Product__ConsumptionSchedule) */
-    ConsumptionSchedule: OdinLink<LinkedOdinRecord<ConsumptionScheduleProperties>>;
-    /** Linked Product records (Product__Product) */
-    Product: OdinLink<LinkedOdinRecord<ProductProperties>>;
-    /** Linked Vendor records (Vendor__Product) */
-    Vendor: OdinLink<LinkedOdinRecord<VendorProperties>>;
-    /** Linked PriceBook records (PriceBook__Product) */
-    PriceBook: OdinLink<LinkedOdinRecord<PriceBookProperties>>;
-    /** Linked OrderItem records (OrderItem__Product) */
-    OrderItem: OdinLink<LinkedOdinRecord<OrderItemProperties>>;
-    /** Linked FieldServiceProduct records (FieldServiceProduct__CompatibleProducts) */
-    FieldServiceProduct: OdinLink<LinkedOdinRecord<FieldServiceProductProperties>>;
-}
-/**
- * RabbitMQ routing keys for Product events
- */
-export declare const ROUTING_KEY_PRODUCT_CREATED = "ProductModule.Product.SubDbRecordCreated";
-export declare const ROUTING_KEY_PRODUCT_UPDATED = "ProductModule.Product.SubDbRecordUpdated";
-export declare const ROUTING_KEY_PRODUCT_DELETED = "ProductModule.Product.SubDbRecordDeleted";
-/**
- * Type-specific routing keys for Product events
- * Subscribe to these for events on specific entity types only
- */
-/** Bundle created */
-export declare const ROUTING_KEY_PRODUCT_BUNDLE_CREATED = "ProductModule.Product.BUNDLE.SubDbRecordCreated";
-/** Bundle updated */
-export declare const ROUTING_KEY_PRODUCT_BUNDLE_UPDATED = "ProductModule.Product.BUNDLE.SubDbRecordUpdated";
-/** Bundle deleted */
-export declare const ROUTING_KEY_PRODUCT_BUNDLE_DELETED = "ProductModule.Product.BUNDLE.SubDbRecordDeleted";
-/** Internet created */
-export declare const ROUTING_KEY_PRODUCT_INTERNET_CREATED = "ProductModule.Product.INTERNET.SubDbRecordCreated";
-/** Internet updated */
-export declare const ROUTING_KEY_PRODUCT_INTERNET_UPDATED = "ProductModule.Product.INTERNET.SubDbRecordUpdated";
-/** Internet deleted */
-export declare const ROUTING_KEY_PRODUCT_INTERNET_DELETED = "ProductModule.Product.INTERNET.SubDbRecordDeleted";
-/** Labor created */
-export declare const ROUTING_KEY_PRODUCT_LABOR_CREATED = "ProductModule.Product.LABOR.SubDbRecordCreated";
-/** Labor updated */
-export declare const ROUTING_KEY_PRODUCT_LABOR_UPDATED = "ProductModule.Product.LABOR.SubDbRecordUpdated";
-/** Labor deleted */
-export declare const ROUTING_KEY_PRODUCT_LABOR_DELETED = "ProductModule.Product.LABOR.SubDbRecordDeleted";
-/** Landline created */
-export declare const ROUTING_KEY_PRODUCT_LANDLINE_CREATED = "ProductModule.Product.LANDLINE.SubDbRecordCreated";
-/** Landline updated */
-export declare const ROUTING_KEY_PRODUCT_LANDLINE_UPDATED = "ProductModule.Product.LANDLINE.SubDbRecordUpdated";
-/** Landline deleted */
-export declare const ROUTING_KEY_PRODUCT_LANDLINE_DELETED = "ProductModule.Product.LANDLINE.SubDbRecordDeleted";
-/** Mesh created */
-export declare const ROUTING_KEY_PRODUCT_MESH_CREATED = "ProductModule.Product.MESH.SubDbRecordCreated";
-/** Mesh updated */
-export declare const ROUTING_KEY_PRODUCT_MESH_UPDATED = "ProductModule.Product.MESH.SubDbRecordUpdated";
-/** Mesh deleted */
-export declare const ROUTING_KEY_PRODUCT_MESH_DELETED = "ProductModule.Product.MESH.SubDbRecordDeleted";
-/** Mobile created */
-export declare const ROUTING_KEY_PRODUCT_MOBILE_CREATED = "ProductModule.Product.MOBILE.SubDbRecordCreated";
-/** Mobile updated */
-export declare const ROUTING_KEY_PRODUCT_MOBILE_UPDATED = "ProductModule.Product.MOBILE.SubDbRecordUpdated";
-/** Mobile deleted */
-export declare const ROUTING_KEY_PRODUCT_MOBILE_DELETED = "ProductModule.Product.MOBILE.SubDbRecordDeleted";
-/** TV product created */
-export declare const ROUTING_KEY_PRODUCT_TELEVISION_CREATED = "ProductModule.Product.TELEVISION.SubDbRecordCreated";
-/** TV product updated */
-export declare const ROUTING_KEY_PRODUCT_TELEVISION_UPDATED = "ProductModule.Product.TELEVISION.SubDbRecordUpdated";
-/** TV product deleted */
-export declare const ROUTING_KEY_PRODUCT_TELEVISION_DELETED = "ProductModule.Product.TELEVISION.SubDbRecordDeleted";
-/** Event: Product__Restriction link created */
-export declare const ROUTING_KEY_LINK_PRODUCT_RESTRICTION_CREATED = "ProductModule.Product.Restriction.SubDbRecordAssociationCreated";
-/** Event: Product__Restriction link deleted */
-export declare const ROUTING_KEY_LINK_PRODUCT_RESTRICTION_DELETED = "ProductModule.Product.Restriction.SubDbRecordAssociationDeleted";
-/** Event: Product__ProductComponent link created */
-export declare const ROUTING_KEY_LINK_PRODUCT_PRODUCT_COMPONENT_CREATED = "ProductModule.Product.ProductComponent.SubDbRecordAssociationCreated";
-/** Event: Product__ProductComponent link deleted */
-export declare const ROUTING_KEY_LINK_PRODUCT_PRODUCT_COMPONENT_DELETED = "ProductModule.Product.ProductComponent.SubDbRecordAssociationDeleted";
-/** Event: Product__Service link created */
-export declare const ROUTING_KEY_LINK_PRODUCT_SERVICE_CREATED = "ProductModule.Product.Service.SubDbRecordAssociationCreated";
-/** Event: Product__Service link deleted */
-export declare const ROUTING_KEY_LINK_PRODUCT_SERVICE_DELETED = "ProductModule.Product.Service.SubDbRecordAssociationDeleted";
-/** Event: Product__ConsumptionSchedule link created */
-export declare const ROUTING_KEY_LINK_PRODUCT_CONSUMPTION_SCHEDULE_CREATED = "ProductModule.Product.ConsumptionSchedule.SubDbRecordAssociationCreated";
-/** Event: Product__ConsumptionSchedule link deleted */
-export declare const ROUTING_KEY_LINK_PRODUCT_CONSUMPTION_SCHEDULE_DELETED = "ProductModule.Product.ConsumptionSchedule.SubDbRecordAssociationDeleted";
-/** Event: Product__Product link created */
-export declare const ROUTING_KEY_LINK_PRODUCT_PRODUCT_CREATED = "ProductModule.Product.Product.SubDbRecordAssociationCreated";
-/** Event: Product__Product link deleted */
-export declare const ROUTING_KEY_LINK_PRODUCT_PRODUCT_DELETED = "ProductModule.Product.Product.SubDbRecordAssociationDeleted";