@cfxlabsinc/b2b-services
    Preparing search index...

    Class ProductFeeRuleAdminService

    Admin-tier CRUD over product_fee_rule. Accepts any rule type (admin-global, admin-for-customer, or customer).

    Identity / version split: product_fee_rule holds scope columns (routeId, customerId, type) plus a currentVersionId pointer; every mutable field (matcher, status, priority, fee values, label, description) lives on product_fee_rule_version and is append-only. Editing means inserting a new version row and re-pointing currentVersionId in one transaction.

    Duplicate-matcher detection is enforced by the partial unique index product_fee_rule_unique_tuple — see ProductActivationRuleAdminService for the rationale. matcherHash is denormalized onto the identity row; service code maintains identity.matcherHash = currentVersion.matcherHash on every version bump and translates the unique-violation back into DUPLICATE_MATCHER.

    Index

    Constructors

    constructor

    Properties

    db

    Methods

    create delete get search update

    Constructors

    Properties

    db: B2bDatabase

    Methods

    • Parameters

      • input: {
            customerId?: string;
            description?: string;
            effectiveFrom?: Instant;
            fixedFeeAmount?: BigNumber;
            label?: string;
            matcher?: Matcher;
            priority: number;
            routeId: string;
            type?: "ADMIN" | "CUSTOMER";
            variableFeeBps?: BigNumber;
        }
        • OptionalcustomerId?: string
        • Optionaldescription?: string
        • OptionaleffectiveFrom?: Instant

          When this version becomes effective. Defaults to now() at the DB layer when omitted. Pass a future Temporal.Instant to schedule a change (e.g. Reg E 30-day notice).

        • OptionalfixedFeeAmount?: BigNumber
        • Optionallabel?: string
        • Optionalmatcher?: Matcher
        • priority: number
        • routeId: string
        • Optionaltype?: "ADMIN" | "CUSTOMER"
        • OptionalvariableFeeBps?: BigNumber

      Returns Promise<
          | { error: ServiceError; ok: false }
          | { ok: true; value: AdminProductFeeRule },
      >

    • Parameters

      • input: {
            createdAt?: DbTimestampCriteria<Instant>;
            customerIds?: string[];
            ids?: string[];
            orderBy?: "createdAt" | "updatedAt" | "priority";
            page?: number;
            pageSize?: number;
            routeIds?: string[];
            statuses?: ("ACTIVE" | "DISABLED")[];
            types?: ("ADMIN" | "CUSTOMER")[];
            updatedAt?: DbTimestampCriteria<Instant>;
        }

      Returns Promise<{ ok: true; value: { hasNext: boolean; items: AdminProductFeeRule[] } }>

    • Parameters

      • input: {
            data: {
                description?: string | null;
                effectiveFrom?: Instant;
                fixedFeeAmount?: BigNumber | null;
                label?: string | null;
                matcher?: Matcher;
                priority?: number;
                status?: "ACTIVE" | "DISABLED";
                variableFeeBps?: BigNumber | null;
            };
            id: string;
        }

      Returns Promise<
          | { error: ServiceError; ok: false }
          | { ok: true; value: AdminProductFeeRule },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods