palbase 0.4.0 → 0.5.0

package/types/internal/src/modules/purchases.d.ts

@@ -239,6 +239,36 @@ export type AppliedStripe = {
         [key: string]: StripeProduct;
     }) | null;
 };
+/**
+ * A key the project's apps sent in their attributes, as they said it — unverified, a suggestion for writing rules —, never its value.
+ */
+export type AttributeKey = {
+    /**
+     * The key.
+     */
+    key: string;
+    /**
+     * When an app last sent it — the hour's: a key is seen again at most once an hour.
+     */
+    last_seen_at: string;
+    /**
+     * How many hours it was seen in: counted at most once an hour, as the apps go on sending it.
+     */
+    seen_hours: number;
+    /**
+     * The JSON type it was last sent as.
+     */
+    type: "string" | "number" | "boolean";
+};
+/**
+ * The attribute keys the project's apps sent (at most 200), as they said them, unverified: the most used first.
+ */
+export type AttributeKeys = {
+    /**
+     * The keys, by the hours each was seen in, then the newest seen.
+     */
+    attributes: AttributeKey[];
+};
 /**
  * The project's one definition of what it sells: each product once — its kind, plans and prices, its names in each language, the channels it is sold on and what it gives. Read strictly: a field it does not know is refused (400 `invalid_catalog`). What a store's rules allow is not part of the shape: POST /purchases/catalog/validate says it, problem by problem.
  */
@@ -473,6 +503,337 @@ export type Channel = {
      */
     tax_code?: string;
 };
+/**
+ * A chart, period by period.
+ */
+export type Chart = {
+    /**
+     * A cohort's: the unit of its ages' values.
+     */
+    age_unit?: "currency" | "count" | "ratio";
+    /**
+     * The chart's key.
+     */
+    chart: "revenue" | "mrr" | "mrr_movement" | "arr" | "active_subscriptions" | "active_subscriptions_movement" | "active_trials" | "active_trials_movement" | "new_trials" | "paid_subscriptions" | "churn" | "subscription_status" | "refunds" | "refund_rate" | "non_subscription_purchases" | "new_customers" | "active_customers" | "initial_conversion" | "conversion_to_paying" | "trial_conversion" | "realized_ltv_per_customer" | "realized_ltv_per_paying_customer" | "subscription_retention" | "cohort_explorer";
+    /**
+     * The cohort explorer's cohorts.
+     */
+    cohort?: "new_customers" | "new_paying_customers";
+    /**
+     * When the chart was computed.
+     */
+    computed_at: string;
+    /**
+     * The currency money is reported in.
+     */
+    currency: string;
+    /**
+     * Whether a value holds an estimate: taxes the store did not state (an App Store or Google Play price's VAT), the stores' commission and Stripe's fee (proceeds), a Google Play offer's period at its plan's recurring price (any revenue type).
+     */
+    estimated: boolean;
+    /**
+     * The values it is filtered to.
+     */
+    filters: ChartFilter[];
+    /**
+     * The first day.
+     */
+    from: string;
+    /**
+     * flow, snapshot, ratio or cohort (ChartDefinition).
+     */
+    kind: "flow" | "snapshot" | "ratio" | "cohort";
+    /**
+     * Its name.
+     */
+    name: string;
+    /**
+     * The periods.
+     */
+    resolution: "day" | "week" | "month";
+    /**
+     * A monetary chart's: what of the money it counts.
+     */
+    revenue_type?: "gross" | "net_of_taxes" | "proceeds";
+    /**
+     * Whether the stores' test purchases count.
+     */
+    sandbox: boolean;
+    /**
+     * The dimension it is split by; absent for none.
+     */
+    segment?: "store" | "platform" | "country" | "product" | "plan" | "duration" | "sandbox" | "paywall" | "experiment";
+    /**
+     * The chart's segments, the biggest first: one, all, when it is not split; else the 20 largest values and, when there are more, `(other)` last, the rest together.
+     */
+    segments: ChartSegment[];
+    summary: ChartSummary;
+    /**
+     * The last day, included.
+     */
+    to: string;
+    /**
+     * The currencies of amounts left out: the European Central Bank publishes no rate of them (or none for their day).
+     */
+    unconverted: string[];
+    /**
+     * The unit of its values.
+     */
+    unit: "currency" | "count" | "ratio";
+    /**
+     * The conversion timeframe or customer lifetime; absent for none (to now).
+     */
+    window_days?: number;
+};
+/**
+ * A cohort's value at an age.
+ */
+export type ChartAge = {
+    /**
+     * The age: periods of the resolution (renewals, for retention) from the cohort's start.
+     */
+    age: number;
+    /**
+     * The age is not over for every member of the cohort.
+     */
+    incomplete?: boolean;
+    /**
+     * The measures, by key.
+     */
+    measures: {
+        [key: string]: number;
+    };
+    /**
+     * The value, in the chart's age unit.
+     */
+    value: number;
+};
+/**
+ * A chart: what it is called and counts.
+ */
+export type ChartDefinition = {
+    /**
+     * A cohort's: the unit of its ages' values.
+     */
+    age_unit?: "currency" | "count" | "ratio";
+    /**
+     * Its definition: what it counts, over which period, and how refunds, product changes, resubscriptions and test purchases count.
+     */
+    description: string;
+    /**
+     * The chart's key, as GET /purchases/charts/{chart} names it.
+     */
+    key: "revenue" | "mrr" | "mrr_movement" | "arr" | "active_subscriptions" | "active_subscriptions_movement" | "active_trials" | "active_trials_movement" | "new_trials" | "paid_subscriptions" | "churn" | "subscription_status" | "refunds" | "refund_rate" | "non_subscription_purchases" | "new_customers" | "active_customers" | "initial_conversion" | "conversion_to_paying" | "trial_conversion" | "realized_ltv_per_customer" | "realized_ltv_per_paying_customer" | "subscription_retention" | "cohort_explorer";
+    /**
+     * flow (what happened in a period; the summary sums), snapshot (the state at a period's end; the summary is the last), ratio (one measure over another; the summary divides the sums), cohort (what began in a period, over its ages).
+     */
+    kind: "flow" | "snapshot" | "ratio" | "cohort";
+    /**
+     * The measures each point is made of.
+     */
+    measures: ChartMeasure[];
+    /**
+     * Its name.
+     */
+    name: string;
+    /**
+     * Whether it is money, of the revenue type asked for.
+     */
+    revenue: boolean;
+    /**
+     * Whether it is segmented and filtered by the dimensions.
+     */
+    segmentable: boolean;
+    /**
+     * The unit of its values: currency (units of the reporting currency, 12.5 is 12.50), count, ratio (0.25 is a quarter).
+     */
+    unit: "currency" | "count" | "ratio";
+    /**
+     * Whether it takes window_days (a conversion timeframe, a customer lifetime).
+     */
+    window: boolean;
+};
+/**
+ * What a chart is segmented or filtered by.
+ */
+export type ChartDimension = {
+    /**
+     * Its values.
+     */
+    description: string;
+    /**
+     * The dimension.
+     */
+    key: "store" | "platform" | "country" | "product" | "plan" | "duration" | "sandbox" | "paywall" | "experiment";
+};
+/**
+ * A value a dimension is filtered to.
+ */
+export type ChartFilter = {
+    /**
+     * The dimension.
+     */
+    dimension: "store" | "platform" | "country" | "product" | "plan" | "duration" | "sandbox" | "paywall" | "experiment";
+    /**
+     * The value.
+     */
+    value: string;
+};
+/**
+ * The charts the module draws, and what they are cut by.
+ */
+export type ChartList = {
+    /**
+     * Every chart, with its definition.
+     */
+    charts: ChartDefinition[];
+    /**
+     * What a segmentable chart is segmented and filtered by.
+     */
+    dimensions: ChartDimension[];
+    /**
+     * What of the money a monetary chart counts.
+     */
+    revenue_types: ("gross" | "net_of_taxes" | "proceeds")[];
+};
+/**
+ * One of the numbers a chart's point is made of.
+ */
+export type ChartMeasure = {
+    /**
+     * What it counts.
+     */
+    description: string;
+    /**
+     * Its key in a point's measures.
+     */
+    key: string;
+    /**
+     * Its unit.
+     */
+    unit: "currency" | "count" | "ratio";
+};
+/**
+ * A period's value, and the measures it is made of.
+ */
+export type ChartPoint = {
+    /**
+     * A cohort's ages, from 0.
+     */
+    ages?: ChartAge[];
+    /**
+     * The period (a cohort's window) is not over: the value may still change.
+     */
+    incomplete?: boolean;
+    /**
+     * The measures, by key (ChartDefinition's measures).
+     */
+    measures: {
+        [key: string]: number;
+    };
+    /**
+     * The period's first day (a Monday for a week, the 1st for a month).
+     */
+    period: string;
+    /**
+     * The chart's value, in its unit.
+     */
+    value: number;
+};
+/**
+ * A value of the dimension a chart is split by (all, when it is not).
+ */
+export type ChartSegment = {
+    /**
+     * The value (a store, a country, a product's key …); all for the whole; `(other)` for the values past the 20 largest, together.
+     */
+    key: string;
+    /**
+     * What the value is called (a product's name, a paywall's), when it has a name.
+     */
+    label?: string;
+    /**
+     * Its value in each period, in order.
+     */
+    points: ChartPoint[];
+    summary: ChartSummary;
+};
+/**
+ * The chart over its whole range: a flow's and a ratio's measures summed (and divided), a snapshot's last period's, a cohort's sizes summed and its ages over the cohorts that completed them.
+ */
+export type ChartSummary = {
+    /**
+     * A cohort's ages over every cohort that completed them.
+     */
+    ages?: ChartAge[];
+    /**
+     * The measures over the range.
+     */
+    measures: {
+        [key: string]: number;
+    };
+    /**
+     * The value over the range.
+     */
+    value: number;
+};
+/**
+ * The project's figures of now and of its last 28 days.
+ */
+export type ChartsOverview = {
+    /**
+     * Customers seen in the 28 days.
+     */
+    active_customers_last_28_days: number;
+    /**
+     * Paid subscriptions in force now.
+     */
+    active_subscriptions: number;
+    /**
+     * Free trials in force now.
+     */
+    active_trials: number;
+    /**
+     * When it was computed.
+     */
+    computed_at: string;
+    /**
+     * The currency money is reported in.
+     */
+    currency: string;
+    /**
+     * Whether a figure holds an estimate (taxes, commission, a Google Play offer's period).
+     */
+    estimated: boolean;
+    /**
+     * MRR now.
+     */
+    mrr: number;
+    /**
+     * Customers first counted in the 28 days.
+     */
+    new_customers_last_28_days: number;
+    /**
+     * Revenue over the 28 days, refunds taken off.
+     */
+    revenue_last_28_days: number;
+    /**
+     * What of the money revenue counts.
+     */
+    revenue_type: "gross" | "net_of_taxes" | "proceeds";
+    /**
+     * Whether the stores' test purchases count.
+     */
+    sandbox: boolean;
+    /**
+     * The first of the 28 days.
+     */
+    since: string;
+    /**
+     * The currencies of amounts left out: the European Central Bank publishes no rate of them.
+     */
+    unconverted: string[];
+};
 /**
  * A Stripe Checkout session to send the customer to.
  */
@@ -3266,6 +3627,39 @@ export type PlacementRequest = {
      */
     paywall_id: string;
 };
+/**
+ * What a placement's viewers did, by where what they were shown came from.
+ */
+export type PlacementResults = {
+    /**
+     * When the numbers were counted.
+     */
+    computed_at: string;
+    /**
+     * The days of exposures the results look back over.
+     */
+    days: number;
+    /**
+     * The placement.
+     */
+    placement: string;
+    /**
+     * Whether the stores' test purchases count.
+     */
+    sandbox: boolean;
+    /**
+     * Where the results look back to: exposures from then on are counted.
+     */
+    since: string;
+    /**
+     * Each source: the placement's rules in their order, then the rules it no longer has, the experiments' variants and the default, the newest shown first.
+     */
+    sources: PlacementSource[];
+    /**
+     * The days after first seeing what a source showed a purchase counts for it.
+     */
+    window_days: number;
+};
 /**
  * One of a placement's rules: when all its conditions hold for a viewer — none holds for everyone —, it shows its target.
  */
@@ -3320,6 +3714,63 @@ export type PlacementRules = {
 export type PlacementRulesRequest = {
     rules: PlacementRule[];
 };
+/**
+ * One source's numbers: what showed a paywall at the placement — a rule, a variant of the experiment running for everyone there, the default — and the paywall.
+ */
+export type PlacementSource = {
+    /**
+     * converters over viewers. A viewer never signed in cannot be followed to a purchase: the rate is a lower bound.
+     */
+    conversion_rate: number;
+    /**
+     * How many of its viewers made one.
+     */
+    converters: number;
+    /**
+     * The experiment whose variant it showed: the one its rule sent viewers to (kind rule), or the one running for everyone there (kind experiment).
+     */
+    experiment_id?: string;
+    /**
+     * How many times it was shown (a subject once in ten minutes).
+     */
+    exposures: number;
+    /**
+     * Where what was shown came from: a rule, the experiment running for everyone at the placement, its default.
+     */
+    kind: "rule" | "experiment" | "default";
+    /**
+     * The paywall shown.
+     */
+    paywall_id: string;
+    /**
+     * The purchases the stores confirmed (a subscription's start, a one-time product) that its viewers made within the window after first seeing it — each counted once, for what its buyer saw first at the placement.
+     */
+    purchases: number;
+    /**
+     * What its purchases were paid to date, renewals included, net of refunds, by currency.
+     */
+    revenue: Revenue[];
+    /**
+     * Whether the rule is one of the placement's rules now; false for a rule since removed, the experiment and the default.
+     */
+    rule_current: boolean;
+    /**
+     * The rule that showed it (kind rule).
+     */
+    rule_id?: string;
+    /**
+     * The rule's name, while the placement has it.
+     */
+    rule_name?: string;
+    /**
+     * The experiment's variant it showed.
+     */
+    variant?: string;
+    /**
+     * How many subjects saw it: users, guests, and installations no one had signed in on.
+     */
+    viewers: number;
+};
 /**
  * The project's placements (at most 200), by key.
  */
@@ -3996,13 +4447,17 @@ export type SaveCatalogError = {
     status: number;
 };
 /**
- * The project's choices for its customers' purchases; the defaults (everyone, cancel on delete, UTC) until it makes its own.
+ * The project's choices for its customers' purchases and for its charts; the defaults (everyone, cancel on delete, UTC, USD, standard commission, Stripe's 2.9% + 0.30 USD) until it makes its own.
  */
 export type Settings = {
     /**
      * Whether a deleted user's renewing web (Stripe) subscriptions stop renewing; they keep the period they paid. Only the customer can cancel what they bought in the App Store or Google Play.
      */
     cancel_on_delete: boolean;
+    /**
+     * The currency the charts report money in: every amount converted at the European Central Bank's reference rate of the day it was paid (USD unless set). One the Bank published a rate of in the last ten days. The ledger keeps what was paid as it was paid: changing it changes every chart from its first day.
+     */
+    reporting_currency: string;
     /**
      * Whether a store's test purchases — Apple's sandbox (where App Review and TestFlight buy), Google Play's license testers, Stripe's test mode — open entitlements here: everyone, only the customers on sandbox_allowlist, or nobody.
      */
@@ -4011,6 +4466,22 @@ export type Settings = {
      * The customers whose test purchases open entitlements when sandbox_access is allowlist.
      */
     sandbox_allowlist: string[];
+    /**
+     * The share the App Store and Google Play keep, which the charts' proceeds take off: standard (30%; 15% of a subscription's renewals after its first paid year in the App Store, and of every subscription on Google Play) or small_business (15%: the App Store Small Business Program, Google Play's first million). standard unless set.
+     */
+    store_commission: "standard" | "small_business";
+    /**
+     * Stripe's fee of a payment, which the ledger does not hold, as the charts' proceeds take it off: its share in basis points (290 is 2.9%, unless set), up to 2000.
+     */
+    stripe_fee_bps: number;
+    /**
+     * The currency of Stripe's fixed fee (USD unless set): one the European Central Bank published a rate of in the last ten days.
+     */
+    stripe_fee_fixed_currency: string;
+    /**
+     * And its fixed part, in micro-units of stripe_fee_fixed_currency (300000 is 0.30, unless set).
+     */
+    stripe_fee_fixed_micros: number;
     /**
      * Where the quotas' calendar windows (a day, a month) begin: an IANA name such as Europe/Istanbul.
      */
@@ -4028,6 +4499,10 @@ export type SettingsUpdate = {
      * Whether a deleted user's renewing web (Stripe) subscriptions stop renewing; they keep the period they paid. Only the customer can cancel what they bought in the App Store or Google Play.
      */
     cancel_on_delete?: boolean;
+    /**
+     * The currency the charts report money in: every amount converted at the European Central Bank's reference rate of the day it was paid (USD unless set). One the Bank published a rate of in the last ten days. The ledger keeps what was paid as it was paid: changing it changes every chart from its first day.
+     */
+    reporting_currency?: string;
     /**
      * Whether a store's test purchases — Apple's sandbox (where App Review and TestFlight buy), Google Play's license testers, Stripe's test mode — open entitlements here: everyone, only the customers on sandbox_allowlist, or nobody.
      */
@@ -4036,6 +4511,22 @@ export type SettingsUpdate = {
      * The customers whose test purchases open entitlements when sandbox_access is allowlist.
      */
     sandbox_allowlist?: string[];
+    /**
+     * The share the App Store and Google Play keep, which the charts' proceeds take off: standard (30%; 15% of a subscription's renewals after its first paid year in the App Store, and of every subscription on Google Play) or small_business (15%: the App Store Small Business Program, Google Play's first million). standard unless set.
+     */
+    store_commission?: "standard" | "small_business";
+    /**
+     * Stripe's fee of a payment, which the ledger does not hold, as the charts' proceeds take it off: its share in basis points (290 is 2.9%, unless set), up to 2000.
+     */
+    stripe_fee_bps?: number;
+    /**
+     * The currency of Stripe's fixed fee (USD unless set): one the European Central Bank published a rate of in the last ten days.
+     */
+    stripe_fee_fixed_currency?: string;
+    /**
+     * And its fixed part, in micro-units of stripe_fee_fixed_currency (300000 is 0.30, unless set).
+     */
+    stripe_fee_fixed_micros?: number;
     /**
      * Where the quotas' calendar windows (a day, a month) begin: an IANA name such as Europe/Istanbul.
      */
@@ -4736,6 +5227,50 @@ export declare function client(t: Transport): {
         body: Catalog; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<200, CatalogValidation>>;
+    /**
+     * List the charts
+     *
+     * Every chart the module draws from the project's ledger — RevenueCat's charts: revenue, MRR and its movement, ARR, active subscriptions and trials and their movements, new trials, paid subscriptions, churn, subscription status, refunds and the refund rate, non-subscription purchases, new and active customers, initial conversion, conversion to paying, trial conversion, realized LTV per customer and per paying customer, subscription retention, the cohort explorer — each with its definition (what it counts, over which period, and how refunds, product changes, resubscriptions and test purchases count), the unit of its values and the measures its points are made of; the dimensions charts are segmented and filtered by; the revenue types.
+     */
+    listCharts(input?: {
+        signal?: AbortSignal;
+    }): Promise<Reply<200, ChartList>>;
+    /**
+     * Read the charts' overview
+     *
+     * The project's figures at a glance: MRR, active subscriptions and active trials now; revenue (of revenue_type), new customers and active customers over the last 28 days, today included — each as its chart counts it. Money is in the reporting currency (or currency); an amount in a currency the European Central Bank does not publish is left out and named (unconverted). A replica computes two charts (the overview among them) at once and one of a project; another is refused at once as busy (503 `charts_busy`, Retry-After), and so is one that takes longer than 15 seconds. The same request within a minute is answered from the replica's cache (a change of the project's settings drops it there). A replica computes 3 charts of a project in a row, then one each 10 seconds (6 a minute); past that a chart is refused (429 `too_many_charts`, Retry-After) — an answer from the cache is not counted.
+     */
+    getChartsOverview(input?: {
+        query?: {
+            sandbox?: boolean; /** What of the money a monetary chart counts: gross (what customers paid), net_of_taxes, or proceeds (net of taxes and the store's commission); gross unless said. What the ledger does not state is estimated, and the answer says so (estimated). */
+            revenue_type?: "gross" | "net_of_taxes" | "proceeds"; /** The currency to report money in, for this answer: one the European Central Bank publishes a reference rate for. The project's reporting currency (settings) unless said. */
+            currency?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, ChartsOverview>>;
+    /**
+     * Read a chart
+     *
+     * One chart of the project's ledger, period by period (GET /purchases/charts says what each counts). Periods are UTC days, ISO weeks (Monday to Sunday) or calendar months, the first and the last cut to `from` and `to` (both included, at most two years apart; `to` later than today is today). A flow counts what happened in the period, a snapshot is the state at its end (now, for the period now is in), a ratio divides its measures, a cohort follows what began in the period over its ages. The ledger is read whole each time: a refund arriving later, a renewal, a product change, a guest merged into an account and a change of the settings are in the next answer. Money is converted to the reporting currency (or `currency`) at the European Central Bank's reference rate of the day it was paid; what is in a currency it does not publish is left out and named (`unconverted`). A store's test purchases count only with sandbox=true. `segment` splits a segmentable chart by a dimension: the 20 largest values each a segment, the rest together in one keyed `(other)` (the segments' sum is the whole; a subscription changing segment is churned in one and moved in to the other); `filter` (repeated, one dimension:value each) keeps what has one of the values given for each dimension named. The paywall and experiment dimensions attribute a subscription whose first purchase is in the days asked for (by the exposures of those days and the 7 before); an older one is `none`. A cohort chart follows at most 120 cohorts (by day, 120 days). Answered as CSV when the request accepts text/csv first: a row a segment and period (and age, for a cohort), its value, its measures. The ledger is read customer by customer, never held whole. A customer holding more than 20,000 transactions is refused (422 `chart_too_large`). The same request within a minute is answered from the replica's cache (a change of the project's settings drops it there). A replica computes two charts at once and one of a project; another is refused at once as busy (503 `charts_busy`, Retry-After), and so is one whose reading and computing take longer than 15 seconds. A replica computes 3 charts of a project in a row, then one each 10 seconds (6 a minute); past that a chart is refused (429 `too_many_charts`, Retry-After) — an answer from the cache is not counted.
+     */
+    getChart(input: {
+        path: {
+            chart: "revenue" | "mrr" | "mrr_movement" | "arr" | "active_subscriptions" | "active_subscriptions_movement" | "active_trials" | "active_trials_movement" | "new_trials" | "paid_subscriptions" | "churn" | "subscription_status" | "refunds" | "refund_rate" | "non_subscription_purchases" | "new_customers" | "active_customers" | "initial_conversion" | "conversion_to_paying" | "trial_conversion" | "realized_ltv_per_customer" | "realized_ltv_per_paying_customer" | "subscription_retention" | "cohort_explorer";
+        };
+        query?: {
+            from?: string; /** The last day, YYYY-MM-DD, included: today unless said (a later day is today). */
+            to?: string; /** The periods: day, week (ISO, Monday to Sunday) or month; day unless said. */
+            resolution?: "day" | "week" | "month"; /** Count the stores' test purchases too (Apple's sandbox, Stripe's test mode); segment or filter by sandbox to tell them apart. */
+            sandbox?: boolean; /** Split the chart by a dimension (a segmentable chart's). */
+            segment?: "store" | "platform" | "country" | "product" | "plan" | "duration" | "sandbox" | "paywall" | "experiment"; /** Keep what has, for each dimension named, one of the values given: one dimension:value a parameter, repeated for more (filter=store:apple&filter=country:TR&filter=country:DE), at most 20; the value is everything after the first colon (commas and colons are the value's). A segmentable chart's. */
+            filter?: string[]; /** The currency to report money in, for this answer: one the European Central Bank publishes a reference rate for. The project's reporting currency (settings) unless said. */
+            currency?: string; /** What of the money a monetary chart counts: gross (what customers paid), net_of_taxes, or proceeds (net of taxes and the store's commission); gross unless said. What the ledger does not state is estimated, and the answer says so (estimated). */
+            revenue_type?: "gross" | "net_of_taxes" | "proceeds"; /** The conversion charts' conversion timeframe and the lifetime charts' customer lifetime, in days from a customer's first day (0: that day); to now unless said. */
+            window_days?: number; /** The cohort explorer's cohorts: new_customers (by their first day; unless said) or new_paying_customers (by their first payment). */
+            cohort?: "new_customers" | "new_paying_customers";
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Chart>>;
     /**
      * The connect page
      *
@@ -5277,6 +5812,14 @@ export declare function client(t: Transport): {
     listPlacements(input?: {
         signal?: AbortSignal;
     }): Promise<Reply<200, Placements>>;
+    /**
+     * List the attribute keys apps send
+     *
+     * The attribute keys the project's apps sent with a placement's paywall (X-Palbase-Attributes), as the apps said them: a suggestion for writing `attribute` conditions, not a list of what an app defines. They are unverified — any holder of the project's publishable key can send a key. Each key with the JSON type it was last sent as (a string that reads as a number is a string), the hours it was seen in, and when it was last seen; the values are never kept. The most used come first: by `seen_hours`, then the newest seen. A key is seen again at most once an hour (`last_seen_at` is the hour's, `seen_hours` rises at most once an hour). A project keeps at most 200 keys; past them a new key takes the place of the key seen longest ago when that one was last seen over 24 hours ago, else it is not kept — keys sent once age out, the keys apps go on sending stay.
+     */
+    listAttributeKeys(input?: {
+        signal?: AbortSignal;
+    }): Promise<Reply<200, AttributeKeys>>;
     /**
      * Give a placement a paywall
      *
@@ -5341,7 +5884,7 @@ export declare function client(t: Transport): {
             "X-Palbase-Client-Version"?: string; /** The registered app's id: app rules read it. */
             "X-Palbase-App"?: string; /** The SDK's name and version, name/version (palbase-swift/1.4.0): sdk_version rules read it. */
             "X-Palbase-SDK"?: string; /** The store's country — StoreKit's Storefront.countryCode, Play's billing country —, ISO 3166-1 alpha-2 or alpha-3: country rules read it, the request's address's country when absent. */
-            "X-Palbase-Storefront"?: string; /** What the app says of the viewer, for attribute rules (targeting only): a JSON object of at most 20 keys (a letter, then letters, digits and _ . -, at most 40), values strings (at most 256), numbers or booleans; at most 2 KiB, non-ASCII escaped (\uXXXX). */
+            "X-Palbase-Storefront"?: string; /** What the app says of the viewer, for attribute rules (targeting only): a JSON object of at most 20 keys (a letter, then letters, digits and _ . -, at most 40), values strings (at most 256), numbers or booleans; at most 2 KiB, non-ASCII escaped (\uXXXX). Its keys, and their types, are kept as the app said them to suggest in the rules' editor (GET /purchases/placements/attributes); its values never are. */
             "X-Palbase-Attributes"?: string; /** The app's languages: locale rules read the first. */
             "Accept-Language"?: string;
         }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
@@ -5362,6 +5905,22 @@ export declare function client(t: Transport): {
         body: PreviewRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<200, PlacementPreview>>;
+    /**
+     * Read a placement's results by rule
+     *
+     * What a placement's viewers did over its last `days` (30 unless said, at most 90), by where what they were shown came from: each rule — with the variant of the experiment it sent them to —, each variant of the experiment running for everyone there, the default; one source for each rule, variant and paywall the placement's exposures name. Each counts as an experiment's variants are counted: exposures and viewers (distinct subjects); the purchases the stores confirmed that its viewers made within `window_days` (7 unless said) after first seeing it — the ledger's, never what an app reports —, each counted once, for what its buyer saw first at the placement; how many viewers made one; the conversion rate; what was paid for them to date, net of refunds, by currency. The placement's rules come first, in their order and named; then the rules it no longer has (`rule_current` false, unnamed), the experiments' variants and the default, the newest shown first. A store's test purchases count only with sandbox=true (a development environment's are all test purchases). Counting that takes longer than 15 seconds is refused as busy (503 `results_busy`, Retry-After) rather than left running.
+     */
+    getPlacementResults(input: {
+        path: {
+            placement: string;
+        };
+        query?: {
+            days?: number; /** The days after first seeing what a source showed a purchase counts for it (7 unless said). */
+            window_days?: number; /** Count the stores' test purchases too. */
+            sandbox?: boolean;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, PlacementResults>>;
     /**
      * Read a placement's rules
      *
@@ -5400,7 +5959,7 @@ export declare function client(t: Transport): {
     /**
      * Change the settings
      *
-     * Changes the settings given — whether a store's test purchases open entitlements, ending a deleted user's renewing web subscriptions, where the quotas' calendar windows begin — and leaves the others as they are.
+     * Changes the settings given — whether a store's test purchases open entitlements, ending a deleted user's renewing web subscriptions, where the quotas' calendar windows begin, the charts' reporting currency, store commission and Stripe fee — and leaves the others as they are.
      */
     updateSettings(input: {
         headers?: {