@happyvertical/smrt-sales 0.57.34 → 0.57.35

package/dist/referrals/recipes.d.ts

@@ -0,0 +1,363 @@
+/**
+ * Declared recipes for the referrals module of smrt-sales (#4409, #4437).
+ *
+ * `affiliates.referrals` lives here, not in `@happyvertical/smrt-affiliates`:
+ * that package is a deprecated shim that declares no models, and a recipe
+ * needs models of its own package. The id keeps the word people use
+ * ("affiliates"); the scanner and the planner catalog read it from this
+ * package's manifest.
+ *
+ * @packageDocumentation
+ */
+import { SmrtRecipe } from '@happyvertical/smrt-core';
+import { Commission } from '../commissions/models/Commission.js';
+import { CommissionPayout } from '../commissions/models/CommissionPayout.js';
+import { Earner } from '../commissions/models/Earner.js';
+import { Referral } from './models/Referral.js';
+import { ReferralProgram } from './models/ReferralProgram.js';
+import { Referrer } from './models/Referrer.js';
+/** Affiliates: Reward partners for the customers they send you, and pay them what they earn. */
+export declare class AffiliatesReferralsRecipe extends SmrtRecipe {
+    static id: string;
+    static help: string;
+    static label: string;
+    static summary: string;
+    static synonyms: string[];
+    static section: {
+        id: string;
+        label: string;
+        icon: string;
+        description: string;
+    };
+    static models: (typeof Commission | typeof Earner | typeof CommissionPayout | typeof Referral | typeof ReferralProgram | typeof Referrer)[];
+    static nav: ({
+        label: string;
+        model: typeof Referrer;
+        icon: string;
+        description: string;
+        noun: string;
+    } | {
+        label: string;
+        model: typeof ReferralProgram;
+        icon: string;
+        description: string;
+        noun: string;
+    } | {
+        label: string;
+        model: typeof Referral;
+        icon: string;
+        description: string;
+        noun?: undefined;
+    } | {
+        label: string;
+        model: typeof Commission;
+        icon: string;
+        description: string;
+        noun?: undefined;
+    } | {
+        label: string;
+        model: typeof CommissionPayout;
+        icon: string;
+        description: string;
+        noun?: undefined;
+    })[];
+    static options: {
+        readonly Referrer: {
+            readonly fields: {
+                readonly displayName: {
+                    readonly label: "Name";
+                    readonly order: 1;
+                };
+                readonly status: {
+                    readonly order: 2;
+                };
+                readonly profileId: {
+                    readonly label: "Person";
+                    readonly visibility: "advanced";
+                };
+                readonly tenantId: {
+                    readonly visibility: "hidden";
+                };
+                readonly earnerId: {
+                    readonly label: "Payee";
+                    readonly visibility: "advanced";
+                };
+                readonly metadata: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly ReferralProgram: {
+            readonly fields: {
+                readonly name: {
+                    readonly order: 1;
+                };
+                readonly key: {
+                    readonly label: "Short name";
+                    readonly order: 2;
+                };
+                readonly status: {
+                    readonly order: 3;
+                };
+                readonly defaultCommissionPlanKey: {
+                    readonly visibility: "advanced";
+                };
+                readonly defaultAttributionPolicyKey: {
+                    readonly visibility: "advanced";
+                };
+                readonly tenantId: {
+                    readonly visibility: "hidden";
+                };
+                readonly metadata: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly Referral: {
+            readonly fields: {
+                readonly referrerId: {
+                    readonly label: "Affiliate";
+                    readonly order: 1;
+                };
+                readonly programId: {
+                    readonly label: "Program";
+                    readonly order: 2;
+                };
+                readonly status: {
+                    readonly order: 3;
+                };
+                readonly tenantId: {
+                    readonly visibility: "hidden";
+                };
+                readonly policyKey: {
+                    readonly visibility: "hidden";
+                };
+                readonly policyVersion: {
+                    readonly visibility: "hidden";
+                };
+                readonly targetKind: {
+                    readonly visibility: "advanced";
+                };
+                readonly targetId: {
+                    readonly visibility: "advanced";
+                };
+                readonly creditFraction: {
+                    readonly visibility: "advanced";
+                };
+                readonly splitGroupId: {
+                    readonly visibility: "hidden";
+                };
+                readonly primaryTouchId: {
+                    readonly visibility: "hidden";
+                };
+                readonly attributedAt: {
+                    readonly visibility: "advanced";
+                };
+                readonly qualifiedAt: {
+                    readonly visibility: "advanced";
+                };
+                readonly expiresAt: {
+                    readonly visibility: "advanced";
+                };
+                readonly snapshotId: {
+                    readonly visibility: "hidden";
+                };
+                readonly metadata: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly Earner: {
+            readonly fields: {
+                readonly displayName: {
+                    readonly label: "Name";
+                    readonly order: 1;
+                };
+                readonly status: {
+                    readonly order: 2;
+                };
+                readonly tenantId: {
+                    readonly visibility: "hidden";
+                };
+                readonly kind: {
+                    readonly visibility: "advanced";
+                };
+                readonly profileId: {
+                    readonly visibility: "advanced";
+                };
+                readonly payoutMethod: {
+                    readonly visibility: "advanced";
+                };
+                readonly payoutDestination: {
+                    readonly visibility: "advanced";
+                };
+                readonly payoutThresholdCents: {
+                    readonly visibility: "advanced";
+                };
+                readonly payoutScheduleKey: {
+                    readonly visibility: "advanced";
+                };
+                readonly currency: {
+                    readonly visibility: "advanced";
+                };
+                readonly metadata: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly Commission: {
+            readonly fields: {
+                readonly earnerId: {
+                    readonly label: "Affiliate";
+                    readonly order: 1;
+                };
+                readonly amountCents: {
+                    readonly label: "Amount";
+                    readonly order: 2;
+                };
+                readonly currency: {
+                    readonly order: 3;
+                };
+                readonly status: {
+                    readonly order: 4;
+                };
+                readonly tenantId: {
+                    readonly visibility: "hidden";
+                };
+                readonly earningEventId: {
+                    readonly visibility: "hidden";
+                };
+                readonly planKey: {
+                    readonly visibility: "advanced";
+                };
+                readonly planVersion: {
+                    readonly visibility: "hidden";
+                };
+                readonly componentKey: {
+                    readonly visibility: "hidden";
+                };
+                readonly termsSnapshotKind: {
+                    readonly visibility: "hidden";
+                };
+                readonly termsSnapshotId: {
+                    readonly visibility: "hidden";
+                };
+                readonly basis: {
+                    readonly visibility: "advanced";
+                };
+                readonly baseAmountCents: {
+                    readonly visibility: "advanced";
+                };
+                readonly rate: {
+                    readonly visibility: "advanced";
+                };
+                readonly shareFraction: {
+                    readonly visibility: "hidden";
+                };
+                readonly splitGroupId: {
+                    readonly visibility: "hidden";
+                };
+                readonly clearingEndsAt: {
+                    readonly visibility: "advanced";
+                };
+                readonly earnedAt: {
+                    readonly visibility: "advanced";
+                };
+                readonly approvedAt: {
+                    readonly visibility: "advanced";
+                };
+                readonly payableAt: {
+                    readonly visibility: "advanced";
+                };
+                readonly paidAt: {
+                    readonly visibility: "advanced";
+                };
+                readonly payoutId: {
+                    readonly visibility: "advanced";
+                };
+                readonly sourceKind: {
+                    readonly visibility: "hidden";
+                };
+                readonly sourceId: {
+                    readonly visibility: "hidden";
+                };
+                readonly calculationTrace: {
+                    readonly visibility: "hidden";
+                };
+                readonly dedupeKey: {
+                    readonly visibility: "hidden";
+                };
+                readonly metadata: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly CommissionPayout: {
+            readonly fields: {
+                readonly earnerId: {
+                    readonly label: "Affiliate";
+                    readonly order: 1;
+                };
+                readonly totalAmountCents: {
+                    readonly label: "Total";
+                    readonly order: 2;
+                };
+                readonly currency: {
+                    readonly order: 3;
+                };
+                readonly status: {
+                    readonly order: 4;
+                };
+                readonly paidAt: {
+                    readonly order: 5;
+                };
+                readonly tenantId: {
+                    readonly visibility: "hidden";
+                };
+                readonly periodStart: {
+                    readonly visibility: "advanced";
+                };
+                readonly periodEnd: {
+                    readonly visibility: "advanced";
+                };
+                readonly commissionTotalCents: {
+                    readonly visibility: "advanced";
+                };
+                readonly adjustmentTotalCents: {
+                    readonly visibility: "advanced";
+                };
+                readonly payoutMethod: {
+                    readonly visibility: "advanced";
+                };
+                readonly payoutDestination: {
+                    readonly visibility: "advanced";
+                };
+                readonly paymentReference: {
+                    readonly visibility: "advanced";
+                };
+                readonly providerRef: {
+                    readonly visibility: "hidden";
+                };
+                readonly invoiceId: {
+                    readonly visibility: "hidden";
+                };
+                readonly notes: {
+                    readonly visibility: "advanced";
+                };
+                readonly idempotencyKey: {
+                    readonly visibility: "hidden";
+                };
+                readonly sourceKind: {
+                    readonly visibility: "hidden";
+                };
+                readonly sourceId: {
+                    readonly visibility: "hidden";
+                };
+                readonly metadata: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+    };
+}
+//# sourceMappingURL=recipes.d.ts.map

package/dist/referrals/recipes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipes.d.ts","sourceRoot":"","sources":["../../src/referrals/recipes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2CAA2C,CAAC;AAC7E,OAAO,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEhD,gGAAgG;AAChG,qBAAa,yBAA0B,SAAQ,UAAU;IACvD,MAAM,CAAC,EAAE,SAA0B;IACnC,MAAM,CAAC,IAAI,SAA2B;IACtC,MAAM,CAAC,KAAK,SAAgB;IAC5B,MAAM,CAAC,OAAO,SACoE;IAClF,MAAM,CAAC,QAAQ,WAOb;IACF,MAAM,CAAC,OAAO;;;;;MAKZ;IACF,MAAM,CAAC,MAAM,+HAOX;IACF,MAAM,CAAC,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAiCR;IACF,MAAM,CAAC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAgHH;CACZ"}

package/dist/referrals.js

@@ -1,3 +1,3 @@
-import "./chunks/__smrt-register__--Xxi-XCu.js";
-import { A as ReferralClickOperation, B as ATTRIBUTION_RESOLUTION_MODES, C as ReferralTouchCollection, D as ReferralCollection, E as assertHttpTargetUrl, F as validateAttributionPolicyTerms, G as REFERRAL_STATUSES, H as REFERRAL_AGREEMENT_STATUSES, I as ATTRIBUTION_CONFLICT_BEHAVIORS, J as AttributionExceptionCollection, K as REFERRAL_TOUCH_KINDS, L as ATTRIBUTION_CREDIT_MODES, M as ReferralAgreement, N as AttributionPolicyCollection, O as Referral, P as AttributionPolicy, R as ATTRIBUTION_EXCEPTION_STATUSES, S as generateReferralCode, T as ReferralLink, U as REFERRAL_LINK_STATUSES, V as REFERRAL_AGREEMENT_APPROVAL_MODES, W as REFERRAL_PROGRAM_STATUSES, Y as AttributionException, _ as REFERRAL_CODE_ALPHABET, a as ReferralAgreementExecutionService, b as ReferralClickValidationError, c as ReferrerCollection, d as ReferralTermSnapshot, f as ReferralProgramCollection, g as MAX_REFERRAL_CLICK_IDEMPOTENCY_KEY_BYTES, h as MAX_CODE_GENERATION_ATTEMPTS, i as REFERRAL_AGREEMENT_SOURCE_KIND, j as ReferralAgreementCollection, k as ReferralClickOperationCollection, l as Referrer, m as DEFAULT_REFERRAL_CLICK_EVIDENCE_MAX_BYTES, n as REFERRAL_TERMS_SNAPSHOT_KIND, o as AttributionService, p as ReferralProgram, q as REFERRER_STATUSES, r as ReferralCommissionService, s as QualifiedReferralOverrideError, t as ReferralQualificationService, u as ReferralTermSnapshotCollection, v as REFERRAL_CODE_LENGTH, w as ReferralTouch, x as ReferralLinkCollection, y as ReferralClickReplayConflictError, z as ATTRIBUTION_POLICY_STATUSES } from "./chunks/referrals-BPEaXqCz.js";
-export { ATTRIBUTION_CONFLICT_BEHAVIORS, ATTRIBUTION_CREDIT_MODES, ATTRIBUTION_EXCEPTION_STATUSES, ATTRIBUTION_POLICY_STATUSES, ATTRIBUTION_RESOLUTION_MODES, AttributionException, AttributionExceptionCollection, AttributionPolicy, AttributionPolicyCollection, AttributionService, DEFAULT_REFERRAL_CLICK_EVIDENCE_MAX_BYTES, MAX_CODE_GENERATION_ATTEMPTS, MAX_REFERRAL_CLICK_IDEMPOTENCY_KEY_BYTES, QualifiedReferralOverrideError, REFERRAL_AGREEMENT_APPROVAL_MODES, REFERRAL_AGREEMENT_SOURCE_KIND, REFERRAL_AGREEMENT_STATUSES, REFERRAL_CODE_ALPHABET, REFERRAL_CODE_LENGTH, REFERRAL_LINK_STATUSES, REFERRAL_PROGRAM_STATUSES, REFERRAL_STATUSES, REFERRAL_TERMS_SNAPSHOT_KIND, REFERRAL_TOUCH_KINDS, REFERRER_STATUSES, Referral, ReferralAgreement, ReferralAgreementCollection, ReferralAgreementExecutionService, ReferralClickOperation, ReferralClickOperationCollection, ReferralClickReplayConflictError, ReferralClickValidationError, ReferralCollection, ReferralCommissionService, ReferralLink, ReferralLinkCollection, ReferralProgram, ReferralProgramCollection, ReferralQualificationService, ReferralTermSnapshot, ReferralTermSnapshotCollection, ReferralTouch, ReferralTouchCollection, Referrer, ReferrerCollection, assertHttpTargetUrl, generateReferralCode, validateAttributionPolicyTerms };
+import "./chunks/__smrt-register__-GmKW_4zz.js";
+import { A as ReferralClickOperationCollection, B as ATTRIBUTION_POLICY_STATUSES, C as generateReferralCode, D as assertHttpTargetUrl, E as ReferralLink, F as AttributionPolicy, G as REFERRAL_PROGRAM_STATUSES, H as REFERRAL_AGREEMENT_APPROVAL_MODES, I as validateAttributionPolicyTerms, J as REFERRER_STATUSES, K as REFERRAL_STATUSES, L as ATTRIBUTION_CONFLICT_BEHAVIORS, M as ReferralAgreementCollection, N as ReferralAgreement, O as ReferralCollection, P as AttributionPolicyCollection, R as ATTRIBUTION_CREDIT_MODES, S as ReferralLinkCollection, T as ReferralTouch, U as REFERRAL_AGREEMENT_STATUSES, V as ATTRIBUTION_RESOLUTION_MODES, W as REFERRAL_LINK_STATUSES, X as AttributionException, Y as AttributionExceptionCollection, _ as MAX_REFERRAL_CLICK_IDEMPOTENCY_KEY_BYTES, a as ReferralAgreementExecutionService, b as ReferralClickReplayConflictError, c as AffiliatesReferralsRecipe, d as ReferralTermSnapshotCollection, f as ReferralTermSnapshot, g as MAX_CODE_GENERATION_ATTEMPTS, h as DEFAULT_REFERRAL_CLICK_EVIDENCE_MAX_BYTES, i as REFERRAL_AGREEMENT_SOURCE_KIND, j as ReferralClickOperation, k as Referral, l as ReferrerCollection, m as ReferralProgram, n as REFERRAL_TERMS_SNAPSHOT_KIND, o as AttributionService, p as ReferralProgramCollection, q as REFERRAL_TOUCH_KINDS, r as ReferralCommissionService, s as QualifiedReferralOverrideError, t as ReferralQualificationService, u as Referrer, v as REFERRAL_CODE_ALPHABET, w as ReferralTouchCollection, x as ReferralClickValidationError, y as REFERRAL_CODE_LENGTH, z as ATTRIBUTION_EXCEPTION_STATUSES } from "./chunks/referrals-o8qZG5fw.js";
+export { ATTRIBUTION_CONFLICT_BEHAVIORS, ATTRIBUTION_CREDIT_MODES, ATTRIBUTION_EXCEPTION_STATUSES, ATTRIBUTION_POLICY_STATUSES, ATTRIBUTION_RESOLUTION_MODES, AffiliatesReferralsRecipe, AttributionException, AttributionExceptionCollection, AttributionPolicy, AttributionPolicyCollection, AttributionService, DEFAULT_REFERRAL_CLICK_EVIDENCE_MAX_BYTES, MAX_CODE_GENERATION_ATTEMPTS, MAX_REFERRAL_CLICK_IDEMPOTENCY_KEY_BYTES, QualifiedReferralOverrideError, REFERRAL_AGREEMENT_APPROVAL_MODES, REFERRAL_AGREEMENT_SOURCE_KIND, REFERRAL_AGREEMENT_STATUSES, REFERRAL_CODE_ALPHABET, REFERRAL_CODE_LENGTH, REFERRAL_LINK_STATUSES, REFERRAL_PROGRAM_STATUSES, REFERRAL_STATUSES, REFERRAL_TERMS_SNAPSHOT_KIND, REFERRAL_TOUCH_KINDS, REFERRER_STATUSES, Referral, ReferralAgreement, ReferralAgreementCollection, ReferralAgreementExecutionService, ReferralClickOperation, ReferralClickOperationCollection, ReferralClickReplayConflictError, ReferralClickValidationError, ReferralCollection, ReferralCommissionService, ReferralLink, ReferralLinkCollection, ReferralProgram, ReferralProgramCollection, ReferralQualificationService, ReferralTermSnapshot, ReferralTermSnapshotCollection, ReferralTouch, ReferralTouchCollection, Referrer, ReferrerCollection, assertHttpTargetUrl, generateReferralCode, validateAttributionPolicyTerms };