@quotivity/cpq-inventory-core 0.1.0

package/lib/extract/records.d.ts

@@ -0,0 +1,421 @@
+/**
+ * Record shapes and field lists, one per object the tool reads. Field names follow the schema
+ * notes in the spec (verified against CPQ package v67). Do not "tidy" them: several look wrong
+ * and are not (TargetObject__c is the evaluation scope; Field__c means different things on
+ * PriceCondition and PriceAction; PriceCondition and ErrorCondition are not field-compatible).
+ */
+export interface Audited {
+    Id: string;
+    LastModifiedDate?: string;
+    CreatedById?: string;
+    CreatedDate?: string;
+}
+export declare const AUDIT: readonly ["Id", "LastModifiedDate", "CreatedById", "CreatedDate"];
+export interface Product2Rec extends Audited {
+    Name: string;
+    ProductCode?: string | null;
+    IsActive: boolean;
+    SBQQ__PricingMethod__c?: string | null;
+    SBQQ__SubscriptionPricing__c?: string | null;
+    SBQQ__SubscriptionTerm__c?: number | null;
+    SBQQ__ChargeType__c?: string | null;
+    SBQQ__NonDiscountable__c?: boolean | null;
+    SBQQ__PriceEditable__c?: boolean | null;
+    SBQQ__OptionSelectionMethod__c?: string | null;
+    SBQQ__ConfigurationType__c?: string | null;
+}
+export declare const PRODUCT2_FIELDS: string[];
+export interface Pricebook2Rec extends Audited {
+    Name: string;
+    IsActive: boolean;
+    IsStandard: boolean;
+}
+export declare const PRICEBOOK2_FIELDS: string[];
+export interface CurrencyTypeRec {
+    Id: string;
+    IsoCode: string;
+    IsActive: boolean;
+    IsCorporate: boolean;
+}
+export declare const CURRENCY_FIELDS: string[];
+export interface DatedConversionRateRec {
+    Id: string;
+    IsoCode: string;
+    StartDate: string;
+    NextStartDate?: string | null;
+    ConversionRate: number;
+}
+export declare const DCR_FIELDS: string[];
+export interface ProductFeatureRec extends Audited {
+    Name: string;
+    SBQQ__ConfiguredSKU__c: string;
+    SBQQ__MinOptionCount__c?: number | null;
+    SBQQ__MaxOptionCount__c?: number | null;
+    SBQQ__Number__c?: number | null;
+}
+export declare const FEATURE_FIELDS: string[];
+export interface ProductOptionRec extends Audited {
+    SBQQ__ConfiguredSKU__c: string;
+    SBQQ__OptionalSKU__c: string;
+    SBQQ__Feature__c?: string | null;
+    SBQQ__Selected__c?: boolean | null;
+    SBQQ__Required__c?: boolean | null;
+    SBQQ__Type__c?: string | null;
+    SBQQ__Number__c?: number | null;
+}
+export declare const OPTION_FIELDS: string[];
+export interface OptionConstraintRec extends Audited {
+    Name: string;
+    SBQQ__Type__c: string;
+    SBQQ__ConfiguredSKU__c?: string | null;
+    SBQQ__ConstrainedOption__c?: string | null;
+    SBQQ__ConstrainingOption__c?: string | null;
+    SBQQ__Active__c?: boolean | null;
+}
+export declare const CONSTRAINT_FIELDS: string[];
+export interface ConfigurationRuleRec extends Audited {
+    SBQQ__Product__c?: string | null;
+    SBQQ__ProductRule__c?: string | null;
+    SBQQ__ProductFeature__c?: string | null;
+    SBQQ__Active__c?: boolean | null;
+}
+export declare const CONFIG_RULE_FIELDS: string[];
+export interface ConfigurationAttributeRec extends Audited {
+    Name: string;
+    SBQQ__Product__c?: string | null;
+    SBQQ__TargetField__c?: string | null;
+    SBQQ__ApplyToProductOptions__c?: boolean | null;
+    SBQQ__Required__c?: boolean | null;
+}
+export declare const ATTRIBUTE_FIELDS: string[];
+export interface QuoteProcessRec extends Audited {
+    Name: string;
+    SBQQ__Default__c?: boolean | null;
+}
+export declare const QUOTE_PROCESS_FIELDS: string[];
+export interface ProcessInputRec extends Audited {
+    Name: string;
+    SBQQ__QuoteProcess__c?: string | null;
+    SBQQ__Required__c?: boolean | null;
+}
+export declare const PROCESS_INPUT_FIELDS: string[];
+export interface ProcessInputConditionRec {
+    Id: string;
+    SBQQ__ProcessInput__c?: string | null;
+    SBQQ__Field__c?: string | null;
+    SBQQ__Operator__c?: string | null;
+    SBQQ__Value__c?: string | null;
+}
+export declare const PROCESS_INPUT_CONDITION_FIELDS: string[];
+export interface ProductRuleRec extends Audited {
+    Name: string;
+    SBQQ__Type__c?: string | null;
+    SBQQ__Scope__c?: string | null;
+    SBQQ__Active__c?: boolean | null;
+    SBQQ__ConditionsMet__c?: string | null;
+    SBQQ__AdvancedCondition__c?: string | null;
+    /** Always / Save / Edit on product rules — a different domain from the price-rule field. */
+    SBQQ__EvaluationEvent__c?: string | null;
+    SBQQ__ErrorMessage__c?: string | null;
+    SBQQ__LookupObject__c?: string | null;
+}
+export declare const PRODUCT_RULE_FIELDS: string[];
+export interface ErrorConditionRec {
+    Id: string;
+    SBQQ__Rule__c: string;
+    SBQQ__Index__c?: number | null;
+    SBQQ__TestedObject__c?: string | null;
+    SBQQ__TestedField__c?: string | null;
+    SBQQ__Operator__c?: string | null;
+    SBQQ__FilterType__c?: string | null;
+    SBQQ__FilterValue__c?: string | null;
+    SBQQ__TestedVariable__c?: string | null;
+    SBQQ__FilterVariable__c?: string | null;
+    SBQQ__TestedConfigurationAttribute__c?: string | null;
+}
+export declare const ERROR_CONDITION_FIELDS: string[];
+export interface ProductActionRec {
+    Id: string;
+    SBQQ__Rule__c: string;
+    SBQQ__Type__c?: string | null;
+    SBQQ__Product__c?: string | null;
+    SBQQ__ValueField__c?: string | null;
+    SBQQ__ValueAttribute__c?: string | null;
+    SBQQ__Required__c?: boolean | null;
+    SBQQ__FilterField__c?: string | null;
+    SBQQ__FilterValue__c?: string | null;
+}
+export declare const PRODUCT_ACTION_FIELDS: string[];
+export interface PriceRuleRec extends Audited {
+    Name: string;
+    SBQQ__Active__c?: boolean | null;
+    /** Evaluation scope: Configurator / Calculator. Read this first. */
+    SBQQ__TargetObject__c?: string | null;
+    /** Multipicklist, Calculator scope only. Populated on Configurator rules too — ignore it there. */
+    SBQQ__EvaluationEvent__c?: string | null;
+    /** Save / Edit, Configurator scope only. */
+    SBQQ__ConfiguratorEvaluationEvent__c?: string | null;
+    SBQQ__ConditionsMet__c?: string | null;
+    SBQQ__AdvancedCondition__c?: string | null;
+    SBQQ__EvaluationOrder__c?: number | null;
+    SBQQ__LookupObject__c?: string | null;
+}
+export declare const PRICE_RULE_FIELDS: string[];
+export interface PriceConditionRec {
+    Id: string;
+    SBQQ__Rule__c: string;
+    SBQQ__Index__c?: number | null;
+    SBQQ__Object__c?: string | null;
+    /** The TESTED field. */
+    SBQQ__Field__c?: string | null;
+    SBQQ__Operator__c?: string | null;
+    SBQQ__FilterType__c?: string | null;
+    SBQQ__Value__c?: string | null;
+    SBQQ__TestedVariable__c?: string | null;
+    SBQQ__FilterVariable__c?: string | null;
+}
+export declare const PRICE_CONDITION_FIELDS: string[];
+export interface PriceActionRec {
+    Id: string;
+    SBQQ__Rule__c: string;
+    SBQQ__TargetObject__c?: string | null;
+    /** The TARGET field. */
+    SBQQ__Field__c?: string | null;
+    SBQQ__Formula__c?: string | null;
+    SBQQ__Value__c?: string | null;
+    SBQQ__ValueField__c?: string | null;
+    SBQQ__SourceVariable__c?: string | null;
+    SBQQ__SourceLookupField__c?: string | null;
+    SBQQ__Order__c?: number | null;
+}
+export declare const PRICE_ACTION_FIELDS: string[];
+export interface SummaryVariableRec extends Audited {
+    Name: string;
+    SBQQ__TargetObject__c?: string | null;
+    SBQQ__Scope__c?: string | null;
+    SBQQ__AggregateFunction__c?: string | null;
+    SBQQ__AggregateField__c?: string | null;
+    SBQQ__FilterField__c?: string | null;
+    SBQQ__Operator__c?: string | null;
+    SBQQ__FilterValue__c?: string | null;
+    SBQQ__ConstraintField__c?: string | null;
+    SBQQ__CombineWith__c?: string | null;
+    SBQQ__CompositeOperator__c?: string | null;
+    SBQQ__ValueElement__c?: number | null;
+}
+export declare const SUMMARY_VARIABLE_FIELDS: string[];
+export interface LookupQueryRec extends Audited {
+    Name: string;
+    SBQQ__ProductRule__c?: string | null;
+    SBQQ__PriceRule__c?: string | null;
+    SBQQ__LookupField__c?: string | null;
+    SBQQ__TestedObject__c?: string | null;
+    SBQQ__TestedField__c?: string | null;
+    SBQQ__Operator__c?: string | null;
+}
+export declare const LOOKUP_QUERY_FIELDS: string[];
+export interface DiscountScheduleRec extends Audited {
+    Name: string;
+    SBQQ__Type__c?: string | null;
+    SBQQ__AggregationScope__c?: string | null;
+    SBQQ__DiscountUnit__c?: string | null;
+    SBQQ__Product__c?: string | null;
+}
+export declare const DISCOUNT_SCHEDULE_FIELDS: string[];
+export interface DiscountTierRec {
+    Id: string;
+    SBQQ__Schedule__c: string;
+    SBQQ__LowerBound__c?: number | null;
+    SBQQ__UpperBound__c?: number | null;
+    SBQQ__Discount__c?: number | null;
+    SBQQ__DiscountAmount__c?: number | null;
+    SBQQ__Price__c?: number | null;
+    SBQQ__Number__c?: number | null;
+}
+export declare const DISCOUNT_TIER_FIELDS: string[];
+export interface BlockPriceRec extends Audited {
+    SBQQ__Product__c: string;
+    SBQQ__LowerBound__c?: number | null;
+    SBQQ__UpperBound__c?: number | null;
+    SBQQ__Price__c?: number | null;
+}
+export declare const BLOCK_PRICE_FIELDS: string[];
+export interface ContractedPriceRec extends Audited {
+    Name: string;
+    SBQQ__Account__c?: string | null;
+    SBQQ__Product__c?: string | null;
+    SBQQ__Price__c?: number | null;
+    SBQQ__Discount__c?: number | null;
+    SBQQ__DiscountSchedule__c?: string | null;
+    SBQQ__EffectiveDate__c?: string | null;
+    SBQQ__ExpirationDate__c?: string | null;
+}
+export declare const CONTRACTED_PRICE_FIELDS: string[];
+export interface DimensionRec extends Audited {
+    Name: string;
+    SBQQ__Product__c?: string | null;
+    SBQQ__Type__c?: string | null;
+}
+export declare const DIMENSION_FIELDS: string[];
+export interface SegmentedLineRec {
+    Id: string;
+    SBQQ__Quote__c?: string | null;
+    SBQQ__Dimension__c?: string | null;
+    SBQQ__SegmentKey__c?: string | null;
+    SBQQ__SegmentIndex__c?: number | null;
+    SBQQ__Quantity__c?: number | null;
+}
+export declare const SEGMENTED_LINE_FIELDS: string[];
+export interface ApprovalRuleRec extends Audited {
+    Name: string;
+    sbaa__Active__c?: boolean | null;
+    sbaa__ApprovalChain__c?: string | null;
+    sbaa__ApprovalStep__c?: number | null;
+    sbaa__Approver__c?: string | null;
+    sbaa__ApproverField__c?: string | null;
+    sbaa__TargetObject__c?: string | null;
+    sbaa__ConditionsMet__c?: string | null;
+    sbaa__AdvancedCondition__c?: string | null;
+}
+export declare const APPROVAL_RULE_FIELDS: string[];
+export interface ApprovalConditionRec {
+    Id: string;
+    sbaa__ApprovalRule__c: string;
+    sbaa__Index__c?: number | null;
+    sbaa__TestedField__c?: string | null;
+    sbaa__Operator__c?: string | null;
+    sbaa__FilterValue__c?: string | null;
+    sbaa__TestedVariable__c?: string | null;
+}
+export declare const APPROVAL_CONDITION_FIELDS: string[];
+export interface NamedRec extends Audited {
+    Name: string;
+}
+export declare const NAMED_FIELDS: string[];
+export interface ApproverRec extends Audited {
+    Name: string;
+    sbaa__User__c?: string | null;
+    sbaa__GroupId__c?: string | null;
+}
+export declare const APPROVER_FIELDS: string[];
+export interface ApprovalHistoryRec {
+    Id: string;
+    sbaa__Status__c?: string | null;
+    sbaa__Rule__c?: string | null;
+    CreatedDate: string;
+    LastModifiedDate: string;
+}
+export declare const APPROVAL_HISTORY_FIELDS: string[];
+export interface ProcessInstanceRec {
+    Id: string;
+    Status: string;
+    CreatedDate: string;
+    CompletedDate?: string | null;
+    ProcessDefinitionId: string;
+}
+export declare const PROCESS_INSTANCE_FIELDS: string[];
+export interface ProcessDefinitionRec {
+    Id: string;
+    Name: string;
+    DeveloperName: string;
+    Type: string;
+    TableEnumOrId: string;
+    State: string;
+    LastModifiedDate?: string;
+}
+export declare const PROCESS_DEFINITION_FIELDS: string[];
+export interface TemplateSectionRec {
+    Id: string;
+    SBQQ__Template__c?: string | null;
+    SBQQ__Content__c?: string | null;
+}
+export declare const TEMPLATE_SECTION_FIELDS: string[];
+export interface TemplateContentRec extends Audited {
+    Name: string;
+    SBQQ__Type__c?: string | null;
+}
+export declare const TEMPLATE_CONTENT_FIELDS: string[];
+export interface LineColumnRec extends Audited {
+    Name: string;
+    SBQQ__Template__c?: string | null;
+    SBQQ__FieldName__c?: string | null;
+}
+export declare const LINE_COLUMN_FIELDS: string[];
+export interface TermConditionRec {
+    Id: string;
+    SBQQ__QuoteTerm__c?: string | null;
+    SBQQ__Field__c?: string | null;
+    SBQQ__Operator__c?: string | null;
+    SBQQ__Value__c?: string | null;
+    SBQQ__TestedVariable__c?: string | null;
+    SBQQ__Index__c?: number | null;
+}
+export declare const TERM_CONDITION_FIELDS: string[];
+export interface CustomScriptRec extends Audited {
+    Name: string;
+    SBQQ__Code__c?: string | null;
+    SBQQ__QuoteFields__c?: string | null;
+    SBQQ__QuoteLineFields__c?: string | null;
+    SBQQ__GroupFields__c?: string | null;
+}
+export declare const CUSTOM_SCRIPT_FIELDS: string[];
+export interface CustomActionRec extends Audited {
+    Name: string;
+    SBQQ__Type__c?: string | null;
+    SBQQ__Location__c?: string | null;
+    SBQQ__Page__c?: string | null;
+    SBQQ__Active__c?: boolean | null;
+}
+export declare const CUSTOM_ACTION_FIELDS: string[];
+export interface ApexTriggerRec {
+    Id: string;
+    Name: string;
+    TableEnumOrId: string;
+    NamespacePrefix?: string | null;
+    Status?: string | null;
+    Body?: string | null;
+    LastModifiedDate?: string;
+}
+export declare const APEX_TRIGGER_FIELDS: string[];
+export interface WebLinkRec {
+    Id: string;
+    Name: string;
+    PageOrSobjectType?: string | null;
+    NamespacePrefix?: string | null;
+}
+export declare const WEBLINK_FIELDS: string[];
+export interface LayoutRec {
+    Id: string;
+    Name: string;
+    TableEnumOrId?: string | null;
+    NamespacePrefix?: string | null;
+}
+export declare const LAYOUT_FIELDS: string[];
+export interface FlexiPageRec {
+    Id: string;
+    DeveloperName: string;
+    EntityDefinitionId?: string | null;
+    NamespacePrefix?: string | null;
+    Type?: string | null;
+}
+export declare const FLEXIPAGE_FIELDS: string[];
+export interface ValidationRuleRec {
+    Id: string;
+    ValidationName: string;
+    NamespacePrefix?: string | null;
+    Active?: boolean | null;
+    EntityDefinition?: {
+        QualifiedApiName?: string | null;
+    } | null;
+}
+export declare const VALIDATION_RULE_FIELDS: string[];
+export interface FieldDefinitionRec {
+    QualifiedApiName: string;
+    Label?: string | null;
+    DataType?: string | null;
+    NamespacePrefix?: string | null;
+}
+export declare const FIELD_DEFINITION_FIELDS: string[];
+export declare const SBQQ_OBJECT_PREFIXES: string[];
+export declare function isCpqObject(apiName: string | null | undefined): boolean;
+//# sourceMappingURL=records.d.ts.map