@stewardhq/sdk 0.2.0 → 0.5.0

package/dist/_chunks/events.d.ts

@@ -1,8 +1,17 @@
 import { z } from "zod";
 //#region ../contract/src/accounts.d.ts
+declare const AccountLocaleSchema: z.ZodEnum<{
+  tr: "tr";
+  en: "en";
+}>;
 declare const AccountUpsertInputSchema: z.ZodObject<{
   displayName: z.ZodString;
   metadata: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+  notificationEmails: z.ZodOptional<z.ZodPipe<z.ZodArray<z.ZodEmail>, z.ZodTransform<string[], string[]>>>;
+  locale: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+    tr: "tr";
+    en: "en";
+  }>>>;
 }, z.core.$strip>;
 type AccountUpsertInput = z.input<typeof AccountUpsertInputSchema>;
 declare const BillingProfileKindSchema: z.ZodEnum<{
@@ -95,7 +104,10 @@ declare const AccountDunningStateSchema: z.ZodObject<{
   nextActionAt: z.ZodNullable<z.ZodISODateTime>;
 }, z.core.$strip>;
 type AccountDunningState = z.infer<typeof AccountDunningStateSchema>;
-/** Dönem sonunda uygulanacak plan değişikliği. F4b'ye kadar her zaman null. */
+/**
+ * Change applied at the period end (`POST /v1/subscriptions/:id/change`, MF9). Null until then.
+ * `price: "current"` on the same plan shows the same `planCode`/`interval` with the new `amountMinor`.
+ */
 declare const AccountScheduledChangeSchema: z.ZodObject<{
   planCode: z.ZodString;
   interval: z.ZodEnum<{
@@ -103,6 +115,7 @@ declare const AccountScheduledChangeSchema: z.ZodObject<{
     year: "year";
   }>;
   effectiveAt: z.ZodISODateTime;
+  amountMinor: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 type AccountScheduledChange = z.infer<typeof AccountScheduledChangeSchema>;
 declare const AccountSubscriptionStateSchema: z.ZodObject<{
@@ -137,6 +150,7 @@ declare const AccountSubscriptionStateSchema: z.ZodObject<{
       year: "year";
     }>;
     effectiveAt: z.ZodISODateTime;
+    amountMinor: z.ZodOptional<z.ZodNumber>;
   }, z.core.$strip>>;
 }, z.core.$strip>;
 type AccountSubscriptionState = z.infer<typeof AccountSubscriptionStateSchema>;
@@ -154,6 +168,52 @@ declare const AccountOpenCheckoutSchema: z.ZodObject<{
   expiresAt: z.ZodISODateTime;
 }, z.core.$strip>;
 type AccountOpenCheckout = z.infer<typeof AccountOpenCheckoutSchema>;
+/**
+ * An unpaid invoice of the account (billing core, M22/M34): renewal or final invoices written
+ * before payment. Account level (not under a subscription) so the final invoice of an ended
+ * subscription stays visible; the product can show a banner before `dueAt`.
+ */
+declare const AccountOpenInvoiceSchema: z.ZodObject<{
+  id: z.ZodUUID;
+  subscriptionId: z.ZodNullable<z.ZodUUID>;
+  billingReason: z.ZodEnum<{
+    subscription_create: "subscription_create";
+    subscription_cycle: "subscription_cycle";
+    subscription_update: "subscription_update";
+    purchase: "purchase";
+    manual: "manual";
+  }>;
+  totalMinor: z.ZodNumber;
+  currency: z.ZodString;
+  dueAt: z.ZodISODateTime;
+}, z.core.$strip>;
+type AccountOpenInvoice = z.infer<typeof AccountOpenInvoiceSchema>;
+/**
+ * Low-churn meter facts of the account state (metering, M13; Polar `active_meters`, coarse). One
+ * entry per catalog meter. Balances and period bounds are NOT here (they change with every event;
+ * read them with `GET /v1/accounts/:ref/meters`): this block changes when the plan changes, a
+ * threshold is crossed or a new period resets the standing — never per event.
+ */
+declare const AccountMeterStateSchema: z.ZodObject<{
+  includedUnits: z.ZodNullable<z.ZodNumber>;
+  billable: z.ZodBoolean;
+  standing: z.ZodEnum<{
+    ok: "ok";
+    low: "low";
+    exhausted: "exhausted";
+  }>;
+}, z.core.$strip>;
+type AccountMeterState = z.infer<typeof AccountMeterStateSchema>;
+declare const AccountMetersStateSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
+  includedUnits: z.ZodNullable<z.ZodNumber>;
+  billable: z.ZodBoolean;
+  standing: z.ZodEnum<{
+    ok: "ok";
+    low: "low";
+    exhausted: "exhausted";
+  }>;
+}, z.core.$strip>>;
+type AccountMetersState = z.infer<typeof AccountMetersStateSchema>;
 /** Fatura profili özeti: yalnızca var mı ve türü (alanlar PII, burada yok). */
 declare const AccountProfileStateSchema: z.ZodObject<{
   present: z.ZodBoolean;
@@ -207,6 +267,7 @@ declare const AccountStateSchema: z.ZodObject<{
         year: "year";
       }>;
       effectiveAt: z.ZodISODateTime;
+      amountMinor: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>>;
   }, z.core.$strip>>;
   openCheckout: z.ZodNullable<z.ZodObject<{
@@ -228,6 +289,71 @@ declare const AccountStateSchema: z.ZodObject<{
       company: "company";
     }>>;
   }, z.core.$strip>;
+  subscriptions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    id: z.ZodUUID;
+    status: z.ZodEnum<{
+      active: "active";
+      suspended: "suspended";
+      past_due: "past_due";
+      canceled: "canceled";
+      expired: "expired";
+    }>;
+    planCode: z.ZodString;
+    interval: z.ZodEnum<{
+      month: "month";
+      year: "year";
+    }>;
+    amountMinor: z.ZodNumber;
+    currency: z.ZodString;
+    currentPeriodEnd: z.ZodNullable<z.ZodISODateTime>;
+    cancelAt: z.ZodNullable<z.ZodISODateTime>;
+    cancelAtPeriodEnd: z.ZodBoolean;
+    pastDueSince: z.ZodNullable<z.ZodISODateTime>;
+    currentPeriodStart: z.ZodNullable<z.ZodISODateTime>;
+    dunning: z.ZodNullable<z.ZodObject<{
+      step: z.ZodNumber;
+      nextActionAt: z.ZodNullable<z.ZodISODateTime>;
+    }, z.core.$strip>>;
+    scheduledChange: z.ZodNullable<z.ZodObject<{
+      planCode: z.ZodString;
+      interval: z.ZodEnum<{
+        month: "month";
+        year: "year";
+      }>;
+      effectiveAt: z.ZodISODateTime;
+      amountMinor: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+  }, z.core.$strip>>>;
+  openInvoices: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    id: z.ZodUUID;
+    subscriptionId: z.ZodNullable<z.ZodUUID>;
+    billingReason: z.ZodEnum<{
+      subscription_create: "subscription_create";
+      subscription_cycle: "subscription_cycle";
+      subscription_update: "subscription_update";
+      purchase: "purchase";
+      manual: "manual";
+    }>;
+    totalMinor: z.ZodNumber;
+    currency: z.ZodString;
+    dueAt: z.ZodISODateTime;
+  }, z.core.$strip>>>;
+  benefits: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    code: z.ZodNullable<z.ZodString>;
+    type: z.ZodString;
+    properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    source: z.ZodString;
+    grantedAt: z.ZodISODateTime;
+  }, z.core.$strip>>>;
+  meters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+    includedUnits: z.ZodNullable<z.ZodNumber>;
+    billable: z.ZodBoolean;
+    standing: z.ZodEnum<{
+      ok: "ok";
+      low: "low";
+      exhausted: "exhausted";
+    }>;
+  }, z.core.$strip>>>;
 }, z.core.$strip>;
 type AccountState = z.infer<typeof AccountStateSchema>;
 declare const AccountSchema: z.ZodObject<{
@@ -263,6 +389,11 @@ declare const AccountSchema: z.ZodObject<{
       cancelAt: z.ZodNullable<z.ZodISODateTime>;
     }, z.core.$strip>>;
   }, z.core.$strip>;
+  notificationEmails: z.ZodDefault<z.ZodArray<z.ZodString>>;
+  locale: z.ZodDefault<z.ZodNullable<z.ZodEnum<{
+    tr: "tr";
+    en: "en";
+  }>>>;
 }, z.core.$strip>;
 type Account = z.infer<typeof AccountSchema>;
 declare const AccountDeleteResponseSchema: z.ZodObject<{
@@ -313,6 +444,7 @@ declare const EVENT_DETAIL_SCHEMAS: {
     paymentId: z.ZodNullable<z.ZodUUID>;
     attempt: z.ZodNumber;
     nextRetryAt: z.ZodNullable<z.ZodISODateTime>;
+    invoiceId: z.ZodOptional<z.ZodUUID>;
     subscriptionId: z.ZodUUID;
   }, z.core.$strip>;
   readonly "subscription.suspended": z.ZodObject<{
@@ -372,6 +504,94 @@ declare const EVENT_DETAIL_SCHEMAS: {
     deletedAt: z.ZodISODateTime;
     actorRef: z.ZodNullable<z.ZodString>;
   }, z.core.$strip>;
+  readonly "invoice.paid": z.ZodObject<{
+    invoiceId: z.ZodUUID;
+    subscriptionId: z.ZodNullable<z.ZodUUID>;
+    paymentId: z.ZodUUID;
+    billingReason: z.ZodNullable<z.ZodEnum<{
+      subscription_create: "subscription_create";
+      subscription_cycle: "subscription_cycle";
+      subscription_update: "subscription_update";
+      purchase: "purchase";
+      manual: "manual";
+    }>>;
+    totalMinor: z.ZodNumber;
+    currency: z.ZodString;
+    paidAt: z.ZodISODateTime;
+  }, z.core.$strip>;
+  readonly "benefit_grant.created": z.ZodObject<{
+    grantId: z.ZodUUID;
+    benefit: z.ZodObject<{
+      code: z.ZodNullable<z.ZodString>;
+      type: z.ZodString;
+      properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+      source: z.ZodString;
+      grantedAt: z.ZodISODateTime;
+    }, z.core.$strip>;
+  }, z.core.$strip>;
+  readonly "benefit_grant.updated": z.ZodObject<{
+    previousProperties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    grantId: z.ZodUUID;
+    benefit: z.ZodObject<{
+      code: z.ZodNullable<z.ZodString>;
+      type: z.ZodString;
+      properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+      source: z.ZodString;
+      grantedAt: z.ZodISODateTime;
+    }, z.core.$strip>;
+  }, z.core.$strip>;
+  readonly "benefit_grant.revoked": z.ZodObject<{
+    revokedAt: z.ZodISODateTime;
+    grantId: z.ZodUUID;
+    benefit: z.ZodObject<{
+      code: z.ZodNullable<z.ZodString>;
+      type: z.ZodString;
+      properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+      source: z.ZodString;
+      grantedAt: z.ZodISODateTime;
+    }, z.core.$strip>;
+  }, z.core.$strip>;
+  readonly "benefit_grant.cycled": z.ZodObject<{
+    periodStart: z.ZodISODateTime;
+    periodEnd: z.ZodISODateTime;
+    grantId: z.ZodUUID;
+    benefit: z.ZodObject<{
+      code: z.ZodNullable<z.ZodString>;
+      type: z.ZodString;
+      properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+      source: z.ZodString;
+      grantedAt: z.ZodISODateTime;
+    }, z.core.$strip>;
+  }, z.core.$strip>;
+  readonly "meter.threshold_crossed": z.ZodObject<{
+    meter: z.ZodString;
+    standing: z.ZodEnum<{
+      ok: "ok";
+      low: "low";
+      exhausted: "exhausted";
+    }>;
+    previous: z.ZodEnum<{
+      ok: "ok";
+      low: "low";
+      exhausted: "exhausted";
+    }>;
+    periodStart: z.ZodISODateTime;
+    periodEnd: z.ZodISODateTime;
+    consumedUnits: z.ZodNumber;
+    creditedUnits: z.ZodNumber;
+  }, z.core.$strip>;
+  readonly "meter.period_closed": z.ZodObject<{
+    periodStart: z.ZodISODateTime;
+    periodEnd: z.ZodISODateTime;
+    subscriptionId: z.ZodNullable<z.ZodUUID>;
+    meters: z.ZodArray<z.ZodObject<{
+      meter: z.ZodString;
+      consumedUnits: z.ZodNumber;
+      creditedUnits: z.ZodNumber;
+      overageUnits: z.ZodNumber;
+    }, z.core.$strip>>;
+    meterChargeId: z.ZodNullable<z.ZodUUID>;
+  }, z.core.$strip>;
 };
 type EventType = keyof typeof EVENT_DETAIL_SCHEMAS;
 /** Tüm event tipleri (yenileri dahil). */
@@ -383,9 +603,11 @@ declare const EVENT_TYPES: EventType[];
 declare const LEGACY_EVENT_TYPES: readonly ["account.updated", "checkout.completed", "checkout.failed", "checkout.expired", "subscription.activated", "subscription.renewed", "subscription.payment_failed", "subscription.suspended", "subscription.reactivated", "subscription.cancel_scheduled", "subscription.canceled", "subscription.expired", "subscription.terminated", "invoice.created", "invoice.issued"];
 type LegacyEventType = (typeof LEGACY_EVENT_TYPES)[number];
 /** `account.state_changed.detail.cause` — bilinen değerler; küme açık. */
-type AccountStateChangeCause = LegacyEventType | "account.upserted" | "billing_profile.updated" | "checkout.opened" | "checkout.initialize_failed" | "checkout.canceled" | "grant.created" | "grant.revoked" | "grant.window_applied" | "dunning.advanced" | "dunning_policy.updated" | "payment.recorded" | "catalog.synced" | "account.refreshed" | "grant.plan_set" | "resync" | "account.deleted" | (string & Record<never, never>);
-type FullStateEventType = "account.state_changed" | "account.deleted";
+type AccountStateChangeCause = LegacyEventType | "account.upserted" | "billing_profile.updated" | "checkout.opened" | "checkout.initialize_failed" | "checkout.canceled" | "grant.created" | "grant.revoked" | "grant.window_applied" | "dunning.advanced" | "dunning_policy.updated" | "payment.recorded" | "catalog.synced" | "account.refreshed" | "grant.plan_set" | "resync" | "account.deleted" | "invoice.paid" | "subscription.period_advanced" | "subscription.uncanceled" | "subscription.change_scheduled" | "invoice.waived" | "invoice.payment_reminder" | "meter.threshold_crossed" | "meter.period_rolled" | "credits.granted" | (string & Record<never, never>);
+type FullStateEventType = "account.state_changed" | "account.deleted" | "invoice.paid" | "benefit_grant.created" | "benefit_grant.updated" | "benefit_grant.revoked" | "benefit_grant.cycled" | "meter.threshold_crossed" | "meter.period_closed";
 type AccountSchemaOf<T extends EventType> = T extends FullStateEventType ? typeof AccountStateSchema : typeof EntitlementSnapshotSchema;
+/** Event types whose `data.account` is the full `AccountState` (the others: the entitlement snapshot). */
+declare const FULL_STATE_EVENT_TYPES: ReadonlySet<string>;
 declare function envelope<T extends EventType>(type: T): z.ZodObject<{
   id: z.ZodString;
   type: z.ZodLiteral<T>;
@@ -432,6 +654,7 @@ declare function envelope<T extends EventType>(type: T): z.ZodObject<{
         paymentId: z.ZodNullable<z.ZodUUID>;
         attempt: z.ZodNumber;
         nextRetryAt: z.ZodNullable<z.ZodISODateTime>;
+        invoiceId: z.ZodOptional<z.ZodUUID>;
         subscriptionId: z.ZodUUID;
       }, z.core.$strip>;
       readonly "subscription.suspended": z.ZodObject<{
@@ -491,6 +714,94 @@ declare function envelope<T extends EventType>(type: T): z.ZodObject<{
         deletedAt: z.ZodISODateTime;
         actorRef: z.ZodNullable<z.ZodString>;
       }, z.core.$strip>;
+      readonly "invoice.paid": z.ZodObject<{
+        invoiceId: z.ZodUUID;
+        subscriptionId: z.ZodNullable<z.ZodUUID>;
+        paymentId: z.ZodUUID;
+        billingReason: z.ZodNullable<z.ZodEnum<{
+          subscription_create: "subscription_create";
+          subscription_cycle: "subscription_cycle";
+          subscription_update: "subscription_update";
+          purchase: "purchase";
+          manual: "manual";
+        }>>;
+        totalMinor: z.ZodNumber;
+        currency: z.ZodString;
+        paidAt: z.ZodISODateTime;
+      }, z.core.$strip>;
+      readonly "benefit_grant.created": z.ZodObject<{
+        grantId: z.ZodUUID;
+        benefit: z.ZodObject<{
+          code: z.ZodNullable<z.ZodString>;
+          type: z.ZodString;
+          properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+          source: z.ZodString;
+          grantedAt: z.ZodISODateTime;
+        }, z.core.$strip>;
+      }, z.core.$strip>;
+      readonly "benefit_grant.updated": z.ZodObject<{
+        previousProperties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        grantId: z.ZodUUID;
+        benefit: z.ZodObject<{
+          code: z.ZodNullable<z.ZodString>;
+          type: z.ZodString;
+          properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+          source: z.ZodString;
+          grantedAt: z.ZodISODateTime;
+        }, z.core.$strip>;
+      }, z.core.$strip>;
+      readonly "benefit_grant.revoked": z.ZodObject<{
+        revokedAt: z.ZodISODateTime;
+        grantId: z.ZodUUID;
+        benefit: z.ZodObject<{
+          code: z.ZodNullable<z.ZodString>;
+          type: z.ZodString;
+          properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+          source: z.ZodString;
+          grantedAt: z.ZodISODateTime;
+        }, z.core.$strip>;
+      }, z.core.$strip>;
+      readonly "benefit_grant.cycled": z.ZodObject<{
+        periodStart: z.ZodISODateTime;
+        periodEnd: z.ZodISODateTime;
+        grantId: z.ZodUUID;
+        benefit: z.ZodObject<{
+          code: z.ZodNullable<z.ZodString>;
+          type: z.ZodString;
+          properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+          source: z.ZodString;
+          grantedAt: z.ZodISODateTime;
+        }, z.core.$strip>;
+      }, z.core.$strip>;
+      readonly "meter.threshold_crossed": z.ZodObject<{
+        meter: z.ZodString;
+        standing: z.ZodEnum<{
+          ok: "ok";
+          low: "low";
+          exhausted: "exhausted";
+        }>;
+        previous: z.ZodEnum<{
+          ok: "ok";
+          low: "low";
+          exhausted: "exhausted";
+        }>;
+        periodStart: z.ZodISODateTime;
+        periodEnd: z.ZodISODateTime;
+        consumedUnits: z.ZodNumber;
+        creditedUnits: z.ZodNumber;
+      }, z.core.$strip>;
+      readonly "meter.period_closed": z.ZodObject<{
+        periodStart: z.ZodISODateTime;
+        periodEnd: z.ZodISODateTime;
+        subscriptionId: z.ZodNullable<z.ZodUUID>;
+        meters: z.ZodArray<z.ZodObject<{
+          meter: z.ZodString;
+          consumedUnits: z.ZodNumber;
+          creditedUnits: z.ZodNumber;
+          overageUnits: z.ZodNumber;
+        }, z.core.$strip>>;
+        meterChargeId: z.ZodNullable<z.ZodUUID>;
+      }, z.core.$strip>;
     }[T];
   }, z.core.$strip>;
 }, z.core.$strip>;
@@ -534,4 +845,4 @@ declare const PingSchema: z.ZodObject<{
 }, z.core.$strip>;
 type Ping = z.infer<typeof PingSchema>;
 //#endregion
-export { AccountProfileState as A, AccountUpsertInputSchema as B, AccountDeleteResponse as C, AccountInclude as D, AccountDunningStateSchema as E, AccountState as F, EntitlementSnapshot as G, BillingProfileInput as H, AccountStateSchema as I, SubscriptionStatusSchema as J, EntitlementSnapshotSchema as K, AccountSubscriptionState as L, AccountScheduledChange as M, AccountScheduledChangeSchema as N, AccountOpenCheckout as O, AccountSchema as P, AccountSubscriptionStateSchema as R, Account as S, AccountDunningState as T, BillingProfileKindSchema as U, BillingProfile as V, BillingProfileSchema as W, SubscriptionSummarySchema as X, SubscriptionSummary as Y, PingSchema as _, BillingEvent as a, AccessState as b, EVENT_DETAIL_SCHEMAS as c, EventIdSchema as d, EventType as f, Ping as g, PING_EVENT_TYPE as h, ApiVersionSchema as i, AccountProfileStateSchema as j, AccountOpenCheckoutSchema as k, EVENT_TYPES as l, LegacyEventType as m, AnyBillingEvent as n, BillingEventOf as o, LEGACY_EVENT_TYPES as p, SubscriptionStatus as q, AnyBillingEventSchema as r, BillingEventSchema as s, AccountStateChangeCause as t, EventDetail as u, isEventType as v, AccountDeleteResponseSchema as w, AccessStateSchema as x, ACCOUNT_INCLUDES as y, AccountUpsertInput as z };
+export { EntitlementSnapshot as $, AccountMeterState as A, AccountScheduledChange as B, Account as C, AccountDunningStateSchema as D, AccountDunningState as E, AccountOpenCheckoutSchema as F, AccountSubscriptionState as G, AccountSchema as H, AccountOpenInvoice as I, AccountUpsertInputSchema as J, AccountSubscriptionStateSchema as K, AccountOpenInvoiceSchema as L, AccountMetersState as M, AccountMetersStateSchema as N, AccountInclude as O, AccountOpenCheckout as P, BillingProfileSchema as Q, AccountProfileState as R, AccessStateSchema as S, AccountDeleteResponseSchema as T, AccountState as U, AccountScheduledChangeSchema as V, AccountStateSchema as W, BillingProfileInput as X, BillingProfile as Y, BillingProfileKindSchema as Z, Ping as _, BillingEvent as a, ACCOUNT_INCLUDES as b, EVENT_DETAIL_SCHEMAS as c, EventIdSchema as d, EntitlementSnapshotSchema as et, EventType as f, PING_EVENT_TYPE as g, LegacyEventType as h, ApiVersionSchema as i, SubscriptionSummarySchema as it, AccountMeterStateSchema as j, AccountLocaleSchema as k, EVENT_TYPES as l, LEGACY_EVENT_TYPES as m, AnyBillingEvent as n, SubscriptionStatusSchema as nt, BillingEventOf as o, FULL_STATE_EVENT_TYPES as p, AccountUpsertInput as q, AnyBillingEventSchema as r, SubscriptionSummary as rt, BillingEventSchema as s, AccountStateChangeCause as t, SubscriptionStatus as tt, EventDetail as u, PingSchema as v, AccountDeleteResponse as w, AccessState as x, isEventType as y, AccountProfileStateSchema as z };