@atlasauth/cli 0.25.0 → 0.25.1

package/dist/commands/referrals.d.ts

@@ -0,0 +1,69 @@
+import { type ParsedArgs } from '../args';
+import type { RunContext } from '../context';
+/**
+ * `atlas referrals connect | backfill | resync | status`: referral attribution from the
+ * terminal.
+ *
+ * `connect --provider referalli` is bring-your-own-key: the Referalli merchant
+ * key is used for one call (it creates the Atlas connection on Referalli) and
+ * is never stored or printed. The connection id and secret Referalli returns
+ * go straight onto the instance; the secret is never printed either.
+ */
+/** The Referalli API version pinned on every call. */
+export declare const REFERALLI_VERSION = "2026-10-21";
+interface PingRead {
+    ok?: boolean;
+    org_name?: string | null;
+    program_name?: string | null;
+    program_id?: string | null;
+    auto_enroll_users?: boolean | null;
+    server_time?: string | number | null;
+    clock_skew_ms?: number | null;
+}
+interface TestRead {
+    ok: boolean;
+    http_status?: number | null;
+    latency_ms?: number | null;
+    error?: {
+        code: string;
+        message: string;
+    } | null;
+    ping?: PingRead | null;
+}
+/** Platform clock minus ours, in ms, from a ping. */
+export declare function pingSkewMs(ping: PingRead, receivedAt: number, latencyMs?: number | null): number | null;
+/** Lines describing a connection test (a ping where the provider supports it). */
+export declare function describeTestLines(test: TestRead, receivedAt: number): string[];
+/** A `customerRef,code` CSV → map; throws on a bad line. A header row is skipped. */
+export declare function parseCodeCsv(text: string, flag?: string): Record<string, string>;
+/** The exact origins of an instance's app: its allowed origins (no wildcards) and its Frontend API host. */
+export declare function appOrigins(instance: {
+    allowed_origins?: unknown[];
+    frontend_api_host?: string | null;
+}): string[];
+/** The Referalli topics two-way sync subscribes to (changes to a referral after sign-up). */
+export declare const REFERALLI_SYNC_TOPICS: readonly ["referral.created", "referral.held", "referral.paused", "referral.resumed", "referral.approved", "referral.voided", "referral.reassigned"];
+/**
+ * Whether the merchant key reaches live or test data: the org's `livemode`,
+ * else the key prefix (rk_test_ = test; rk_live_ and older rk_ keys = live).
+ * `known` is false when Referalli reports no mode (no test mode there).
+ */
+export declare function referalliKeyMode(ctx: RunContext, input: {
+    baseUrl: string;
+    key: string;
+}): Promise<{
+    live: boolean;
+    known: boolean;
+    org: Record<string, unknown> | null;
+}>;
+/** A Referalli list answer: a plain array (API version 2026-10-21) or a `{ data: [...] }` page. */
+export declare function referalliList(body: unknown): Record<string, unknown>[];
+/** Referalli's public tracked link for a code: `{host}/go/{trackingToken}/{code}`, on the org's link domain once it is active. */
+export declare function referalliLinkTemplate(baseUrl: string, trackingToken: string, branding: Record<string, unknown> | null): string;
+/** The `programIds` a Referalli webhook endpoint is limited to: null or [] means every program in the organization. */
+export declare function webhookScope(endpoint: Record<string, unknown> | null): {
+    scope: 'program' | 'all_programs' | 'unknown';
+    program_ids: string[] | null;
+};
+export declare function referrals(ctx: RunContext, args: ParsedArgs): Promise<number>;
+export {};