@schematichq/schematic-vue 1.6.0 → 1.7.0

package/dist/schematic-vue.d.ts

@@ -37,6 +37,12 @@ declare namespace billingApi {
         ApiErrorToJSON,
         ApiErrorToJSONTyped,
         ApiError,
+        instanceOfBillingProviderType,
+        BillingProviderTypeFromJSON,
+        BillingProviderTypeFromJSONTyped,
+        BillingProviderTypeToJSON,
+        BillingProviderTypeToJSONTyped,
+        BillingProviderType,
         instanceOfCompanyDiscountResponseData,
         CompanyDiscountResponseDataFromJSON,
         CompanyDiscountResponseDataFromJSONTyped,
@@ -55,12 +61,42 @@ declare namespace billingApi {
         CompanyInvoicesResponseDataToJSON,
         CompanyInvoicesResponseDataToJSONTyped,
         CompanyInvoicesResponseData,
+        instanceOfCompanyPaymentMethodResponseData,
+        CompanyPaymentMethodResponseDataFromJSON,
+        CompanyPaymentMethodResponseDataFromJSONTyped,
+        CompanyPaymentMethodResponseDataToJSON,
+        CompanyPaymentMethodResponseDataToJSONTyped,
+        CompanyPaymentMethodResponseData,
+        instanceOfCompanyPaymentMethodsResponseData,
+        CompanyPaymentMethodsResponseDataFromJSON,
+        CompanyPaymentMethodsResponseDataFromJSONTyped,
+        CompanyPaymentMethodsResponseDataToJSON,
+        CompanyPaymentMethodsResponseDataToJSONTyped,
+        CompanyPaymentMethodsResponseData,
         instanceOfCompanyUpcomingInvoiceResponseData,
         CompanyUpcomingInvoiceResponseDataFromJSON,
         CompanyUpcomingInvoiceResponseDataFromJSONTyped,
         CompanyUpcomingInvoiceResponseDataToJSON,
         CompanyUpcomingInvoiceResponseDataToJSONTyped,
         CompanyUpcomingInvoiceResponseData,
+        instanceOfCreateSetupIntentResponse,
+        CreateSetupIntentResponseFromJSON,
+        CreateSetupIntentResponseFromJSONTyped,
+        CreateSetupIntentResponseToJSON,
+        CreateSetupIntentResponseToJSONTyped,
+        CreateSetupIntentResponse,
+        instanceOfDeletePaymentMethodResponse,
+        DeletePaymentMethodResponseFromJSON,
+        DeletePaymentMethodResponseFromJSONTyped,
+        DeletePaymentMethodResponseToJSON,
+        DeletePaymentMethodResponseToJSONTyped,
+        DeletePaymentMethodResponse,
+        instanceOfDeleteResponse,
+        DeleteResponseFromJSON,
+        DeleteResponseFromJSONTyped,
+        DeleteResponseToJSON,
+        DeleteResponseToJSONTyped,
+        DeleteResponse,
         instanceOfGetCompanyInvoicesParams,
         GetCompanyInvoicesParamsFromJSON,
         GetCompanyInvoicesParamsFromJSONTyped,
@@ -73,6 +109,12 @@ declare namespace billingApi {
         GetCompanyInvoicesResponseToJSON,
         GetCompanyInvoicesResponseToJSONTyped,
         GetCompanyInvoicesResponse,
+        instanceOfGetCompanyPaymentMethodsResponse,
+        GetCompanyPaymentMethodsResponseFromJSON,
+        GetCompanyPaymentMethodsResponseFromJSONTyped,
+        GetCompanyPaymentMethodsResponseToJSON,
+        GetCompanyPaymentMethodsResponseToJSONTyped,
+        GetCompanyPaymentMethodsResponse,
         instanceOfGetCompanyUpcomingInvoiceResponse,
         GetCompanyUpcomingInvoiceResponseFromJSON,
         GetCompanyUpcomingInvoiceResponseFromJSONTyped,
@@ -84,19 +126,52 @@ declare namespace billingApi {
         InvoiceStatusFromJSONTyped,
         InvoiceStatusToJSON,
         InvoiceStatusToJSONTyped,
-        InvoiceStatus
+        InvoiceStatus,
+        instanceOfPaymentMethodResponseData,
+        PaymentMethodResponseDataFromJSON,
+        PaymentMethodResponseDataFromJSONTyped,
+        PaymentMethodResponseDataToJSON,
+        PaymentMethodResponseDataToJSONTyped,
+        PaymentMethodResponseData,
+        instanceOfSetupIntentResponseData,
+        SetupIntentResponseDataFromJSON,
+        SetupIntentResponseDataFromJSONTyped,
+        SetupIntentResponseDataToJSON,
+        SetupIntentResponseDataToJSONTyped,
+        SetupIntentResponseData,
+        instanceOfUpdatePaymentMethodRequestBody,
+        UpdatePaymentMethodRequestBodyFromJSON,
+        UpdatePaymentMethodRequestBodyFromJSONTyped,
+        UpdatePaymentMethodRequestBodyToJSON,
+        UpdatePaymentMethodRequestBodyToJSONTyped,
+        UpdatePaymentMethodRequestBody,
+        instanceOfUpdatePaymentMethodResponse,
+        UpdatePaymentMethodResponseFromJSON,
+        UpdatePaymentMethodResponseFromJSONTyped,
+        UpdatePaymentMethodResponseToJSON,
+        UpdatePaymentMethodResponseToJSONTyped,
+        UpdatePaymentMethodResponse
     }
 }
 
 /**
- * What a reader of billing data can ask for. Subscription and usage — the
- * rest of what `hydrate` serves — and the checkout calls that change them
- * join this interface as their endpoints ship.
+ * What a reader of billing data can ask for, and the few writes beside it.
+ * Subscription and usage — the rest of what `hydrate` serves — and the
+ * checkout calls that change them join this interface as their endpoints
+ * ship.
  */
 declare interface BillingClient {
     fetchInvoices(params: InvoicesRequest): Promise<InvoicesResult>;
     /** `null` when the company has no next bill. */
     fetchUpcomingInvoice(): Promise<UpcomingInvoice | null>;
+    /** Empty when the company has no method on file. */
+    fetchPaymentMethods(): Promise<PaymentMethod[]>;
+    /** What a provider's card form is mounted with to add a method. */
+    createSetupIntent(): Promise<SetupIntent>;
+    /** Makes the method the default, by the provider's id (`externalId`). */
+    updatePaymentMethod(externalId: string): Promise<void>;
+    /** Removes the method, by Schematic's id (`id`). */
+    deletePaymentMethod(id: string): Promise<void>;
     readonly sessionStatus: SessionStatus;
     readonly sessionKey: string | undefined;
     setSession(session: SessionInput): void;
@@ -140,6 +215,7 @@ declare type BillingResourceName = keyof BillingResources;
 declare interface BillingResourceParams {
     invoices: InvoiceQuery;
     upcomingInvoice: Record<string, never>;
+    paymentMethods: Record<string, never>;
 }
 
 /**
@@ -158,6 +234,11 @@ declare interface BillingResources {
      * `undefined` means the resource has not loaded.
      */
     upcomingInvoice: UpcomingInvoice | null;
+    /**
+     * `GET /company/payment-methods`. Empty is a loaded value — the company
+     * has no method on file — so only `undefined` means not loaded.
+     */
+    paymentMethods: PaymentMethod[];
 }
 
 declare type BooleanListenerFn = (value: boolean) => void;
@@ -370,6 +451,12 @@ declare interface CheckFlagsResponseData {
     creditBalances?: {
         [key: string]: CompanyCreditBalance;
     };
+    /**
+     * Credit spend policies binding the evaluated company and user; empty when none bind. Each response carries the whole set, so replace any previously received set with it. Advisory: the flag values do not reflect them, since a check names no draw amount
+     * @type {Array<CreditSpendPolicy>}
+     * @memberof CheckFlagsResponseData
+     */
+    creditSpendPolicies: Array<CreditSpendPolicy_2>;
     /**
      *
      * @type {Array<CheckFlagResponseData>}
@@ -551,6 +638,109 @@ declare interface CompanyInvoiceResponseData {
     url?: string | null;
 }
 
+/**
+ * Schematic API
+ * Schematic API
+ *
+ * The version of the OpenAPI document: 0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CompanyPaymentMethodResponseData
+ */
+declare interface CompanyPaymentMethodResponseData {
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPaymentMethodResponseData
+     */
+    accountLast4?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPaymentMethodResponseData
+     */
+    accountName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPaymentMethodResponseData
+     */
+    bankName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPaymentMethodResponseData
+     */
+    billingEmail?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPaymentMethodResponseData
+     */
+    billingName?: string | null;
+    /**
+     * Whether DELETE /checkout/paymentmethod/:id would succeed. False only for the sole method while an active paid subscription needs it; the default can be removed like any other.
+     * @type {boolean}
+     * @memberof CompanyPaymentMethodResponseData
+     */
+    canRemove: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPaymentMethodResponseData
+     */
+    cardBrand?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyPaymentMethodResponseData
+     */
+    cardExpMonth?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyPaymentMethodResponseData
+     */
+    cardExpYear?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPaymentMethodResponseData
+     */
+    cardLast4?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPaymentMethodResponseData
+     */
+    externalId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPaymentMethodResponseData
+     */
+    id: string;
+    /**
+     * Whether this is the method the company is billed with: the subscription's own when it has one, else the customer default. At most one method is the default.
+     * @type {boolean}
+     * @memberof CompanyPaymentMethodResponseData
+     */
+    isDefault: boolean;
+    /**
+     * The Stripe payment method type, such as card or us_bank_account.
+     * @type {string}
+     * @memberof CompanyPaymentMethodResponseData
+     */
+    type: string;
+}
+
 /**
  *
  * @export
@@ -582,7 +772,7 @@ declare interface CompanyUpcomingInvoiceResponseData {
      */
     customerBalanceRemaining: number;
     /**
-     * Only active discounts that reduce the bill.
+     * The subscription's active discounts, to show beside the bill. Informational: the amounts come from the provider's preview and already reflect whatever it applied, so subtotal less these need not equal amount_due.
      * @type {Array<CompanyDiscountResponseData>}
      * @memberof CompanyUpcomingInvoiceResponseData
      */
@@ -620,6 +810,153 @@ declare const CreditBalancesFromJSON: (json: any) => CreditBalances;
 
 declare type CreditBalancesListenerFn = (value: CreditBalances) => void;
 
+/** Every spend policy binding the current context, company-scope first */
+export declare type CreditSpendPolicies = CreditSpendPolicy[];
+
+/** Compare two policy sets by value, so an unchanged restream skips the notify. */
+declare const creditSpendPoliciesEqual: (a: CreditSpendPolicies, b: CreditSpendPolicies) => boolean;
+
+declare const CreditSpendPoliciesFromJSON: (json: any) => CreditSpendPolicies;
+
+declare type CreditSpendPoliciesListenerFn = (value: CreditSpendPolicies) => void;
+
+/** One limit on spending a credit */
+export declare type CreditSpendPolicy = {
+    id: string;
+    creditId: string;
+    kind: CreditSpendPolicyKind;
+    scope: CreditSpendPolicyScope;
+    label?: string;
+    /** The ceiling, in credits */
+    limit: number;
+    /** How much of the limit is already spent in the current period; 0 for per_draw */
+    consumed: number;
+    /** For windowed kinds, when the current period ends and consumed no longer applies */
+    resetsAt?: Date;
+    /** Set for windowed kinds only */
+    window?: CreditSpendWindow;
+};
+
+/**
+ *
+ * @export
+ * @interface CreditSpendPolicy
+ */
+declare interface CreditSpendPolicy_2 {
+    /**
+     * How much of the limit is already spent in the current period
+     * @type {number}
+     * @memberof CreditSpendPolicy
+     */
+    consumed?: number;
+    /**
+     * The credit the policy limits
+     * @type {string}
+     * @memberof CreditSpendPolicy
+     */
+    creditId: string;
+    /**
+     * The ID of the policy
+     * @type {string}
+     * @memberof CreditSpendPolicy
+     */
+    id: string;
+    /**
+     * How the limit is applied
+     * @type {string}
+     * @memberof CreditSpendPolicy
+     */
+    kind: string;
+    /**
+     * The name the account gave the policy
+     * @type {string}
+     * @memberof CreditSpendPolicy
+     */
+    label?: string | null;
+    /**
+     * The ceiling, in credits
+     * @type {number}
+     * @memberof CreditSpendPolicy
+     */
+    limit: number;
+    /**
+     * For a windowed limit, when the current period ends and consumed no longer applies
+     * @type {Date}
+     * @memberof CreditSpendPolicy
+     */
+    resetsAt?: Date | null;
+    /**
+     * Whether the policy limits the company or one user
+     * @type {CreditSpendPolicyScope}
+     * @memberof CreditSpendPolicy
+     */
+    scope: CreditSpendPolicyScope_2;
+    /**
+     * For a windowed limit, the period it accumulates over
+     * @type {CreditSpendWindow}
+     * @memberof CreditSpendPolicy
+     */
+    window?: CreditSpendWindow_2;
+}
+
+/** How a spend policy applies its limit. Unknown kinds are carried, not dropped:
+ * the server may ship a kind this SDK version predates. */
+export declare type CreditSpendPolicyKind = "per_draw" | "window" | (string & {});
+
+declare type CreditSpendPolicyListenerFn = CreditSpendPoliciesListenerFn | EmptyListenerFn;
+
+/** Whether a spend policy limits the company or one user */
+export declare type CreditSpendPolicyScope = "company" | "user" | (string & {});
+
+/**
+ *
+ * @export
+ */
+declare const CreditSpendPolicyScope_2: {
+    readonly Company: "company";
+    readonly User: "user";
+    readonly Group: "group";
+};
+
+declare type CreditSpendPolicyScope_2 = (typeof CreditSpendPolicyScope_2)[keyof typeof CreditSpendPolicyScope_2];
+
+/** The period a windowed spend policy accumulates over */
+export declare type CreditSpendWindow = {
+    unit: string;
+    count: number;
+};
+
+/**
+ * Schematic API
+ * Schematic API
+ *
+ * The version of the OpenAPI document: 0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreditSpendWindow
+ */
+declare interface CreditSpendWindow_2 {
+    /**
+     * How many units make up one period
+     * @type {number}
+     * @memberof CreditSpendWindow
+     */
+    count: number;
+    /**
+     * The period the limit accumulates over
+     * @type {string}
+     * @memberof CreditSpendWindow
+     */
+    unit: string;
+}
+
 /**
  *
  * @export
@@ -1010,6 +1347,20 @@ declare type MetricPeriodMonthReset = (typeof MetricPeriodMonthReset)[keyof type
  */
 declare function normalizeInvoiceQuery(query: InvoiceQuery): InvoiceQuery;
 
+/**
+ * One way the company pays. Two flags the server has already decided, so a
+ * consumer never re-derives a provider's rules:
+ *
+ * * `isDefault` — the subscription's default method, or, when the
+ *   subscription names none, the customer's.
+ * * `canRemove` — whether a delete would be accepted; the server's rule,
+ *   not `!isDefault`.
+ *
+ * `id` is Schematic's, and is what a delete takes; `externalId` is the
+ * provider's, and is what making it the default takes.
+ */
+declare type PaymentMethod = CompanyPaymentMethodResponseData;
+
 declare type PendingListenerFn = BooleanListenerFn | EmptyListenerFn;
 
 declare type PlanListenerFn = CheckPlanReturnListenerFn | EmptyListenerFn;
@@ -1086,6 +1437,7 @@ export declare class Schematic {
     private isPendingListeners;
     private planListeners;
     private creditBalanceListeners;
+    private creditSpendPolicyListeners;
     private storage;
     private persistFlagState;
     private flagStateCacheKey;
@@ -1096,6 +1448,7 @@ export declare class Schematic {
     private featureUsageEventMap;
     private planChecks;
     private creditBalances;
+    private creditSpendPolicies;
     private webSocketUrl;
     private webSocketConnectionTimeout;
     private webSocketReconnect;
@@ -1314,6 +1667,10 @@ export declare class Schematic {
     getCreditBalances: () => CreditBalances;
     /** Get the company's lease-aware balance for a single credit type in the current context */
     getCreditBalance: (creditId: string) => CreditBalance | undefined;
+    /** Get every credit spend policy binding the current context, company-scope first */
+    getCreditSpendPolicies: () => CreditSpendPolicies;
+    /** Get the spend policies binding a single credit type in the current context */
+    getCreditSpendPoliciesForCredit: (creditId: string) => CreditSpendPolicies;
     getFlagCheck: (flagKey: string) => CheckFlagReturn | undefined;
     getFlagValue: (flagKey: string) => boolean | undefined;
     /** Register an event listener that will be notified with the boolean value for a given flag when this value changes */
@@ -1323,11 +1680,14 @@ export declare class Schematic {
     addPlanListener: (listener: PlanListenerFn) => () => void;
     /** Register an event listener that will be notified with the company's credit balances (keyed by credit ID) whenever they change */
     addCreditBalanceListener: (listener: CreditBalanceListenerFn) => () => void;
+    /** Register an event listener that will be notified with the context's credit spend policies whenever the set changes */
+    addCreditSpendPolicyListener: (listener: CreditSpendPolicyListenerFn) => () => void;
     private notifyFlagCheckListeners;
     /** Add or update a CheckFlagReturn in the featureUsageEventMap */
     private updateFeatureUsageEventMap;
     private notifyFlagValueListeners;
     private notifyPlanListeners;
+    private notifyCreditSpendPolicyListeners;
     private notifyCreditBalanceListeners;
 }
 
@@ -1351,6 +1711,10 @@ declare class SchematicBillingClient implements BillingClient {
     onSessionChange(listener: (event: SessionEvent) => void): () => void;
     fetchInvoices(params: InvoicesRequest): Promise<InvoicesResult>;
     fetchUpcomingInvoice(): Promise<UpcomingInvoice | null>;
+    fetchPaymentMethods(): Promise<PaymentMethod[]>;
+    createSetupIntent(): Promise<SetupIntent>;
+    updatePaymentMethod(externalId: string): Promise<void>;
+    deletePaymentMethod(id: string): Promise<void>;
 }
 
 export declare interface SchematicComposableOpts {
@@ -1399,12 +1763,22 @@ declare namespace SchematicJS {
         CompanyCreditBalance,
         CompanyDiscountResponseData,
         CompanyInvoiceResponseData,
+        CompanyPaymentMethodResponseData,
         CompanyUpcomingInvoiceResponseData,
         CreditBalance,
         CreditBalanceListenerFn,
         CreditBalances,
         CreditBalancesFromJSON,
         CreditBalancesListenerFn,
+        CreditSpendPolicies,
+        creditSpendPoliciesEqual,
+        CreditSpendPoliciesFromJSON,
+        CreditSpendPoliciesListenerFn,
+        CreditSpendPolicy,
+        CreditSpendPolicyKind,
+        CreditSpendPolicyListenerFn,
+        CreditSpendPolicyScope,
+        CreditSpendWindow,
         DEFAULT_INVOICE_QUERY,
         Discount,
         EmptyListenerFn,
@@ -1425,6 +1799,7 @@ declare namespace SchematicJS {
         InvoicesResult,
         InvoiceStatus,
         Keys,
+        PaymentMethod,
         PendingListenerFn,
         PlanListenerFn,
         RequestOptions,
@@ -1441,6 +1816,8 @@ declare namespace SchematicJS {
         SessionInput,
         SessionOptions,
         SessionStatus,
+        SetupIntent,
+        SetupIntentResponseData,
         SINGLETON,
         StoragePersister,
         TOKEN_CACHE_SIZE,
@@ -1636,6 +2013,52 @@ declare interface SessionOptions {
 
 declare type SessionStatus = "pending" | "active" | "ended";
 
+/** What a provider's card form is mounted with to add a method. */
+declare type SetupIntent = SetupIntentResponseData;
+
+/**
+ * Schematic API
+ * Schematic API
+ *
+ * The version of the OpenAPI document: 0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SetupIntentResponseData
+ */
+declare interface SetupIntentResponseData {
+    /**
+     *
+     * @type {string}
+     * @memberof SetupIntentResponseData
+     */
+    accountId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SetupIntentResponseData
+     */
+    publishableKey?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SetupIntentResponseData
+     */
+    schematicPublishableKey: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SetupIntentResponseData
+     */
+    setupIntentClientSecret?: string | null;
+}
+
 /** The params of every singleton resource. */
 declare const SINGLETON: Record<string, never>;
 
@@ -1751,6 +2174,51 @@ export declare const useSchematicCreditBalance: (creditId: MaybeRefOrGetter<stri
     isLoading: ComputedRef<boolean>;
 };
 
+/**
+ * Get every credit spend policy binding the current context.
+ * Returns reactive computed refs for the policies and a loading flag.
+ *
+ * Company-scope policies come first, then the user's own. The list updates
+ * as partials arrive over the DataStream, so a policy edited or deleted in the
+ * dashboard reaches the component without a refetch. A window policy also
+ * carries `consumed` and `resetsAt`, which update as credits are spent.
+ *
+ * @param opts - Optional configuration including a client override
+ * @returns Object with `policies` and `isLoading` computed refs
+ *
+ * @example
+ * ```typescript
+ * const { policies, isLoading } = useSchematicCreditSpendPolicies()
+ *
+ * // In template
+ * <div v-if="isLoading">Loading…</div>
+ * <ul v-else>
+ *   <li v-for="policy in policies" :key="policy.id">
+ *     {{ policy.scope }} limit: {{ policy.limit }} credits
+ *   </li>
+ * </ul>
+ * ```
+ */
+export declare const useSchematicCreditSpendPolicies: (opts?: SchematicComposableOpts) => {
+    /** Company-scope policies first, then the user's own; empty when none bind */
+    policies: ComputedRef<    {
+    id: string;
+    creditId: string;
+    kind: SchematicJS.CreditSpendPolicyKind;
+    scope: SchematicJS.CreditSpendPolicyScope;
+    label?: string | undefined;
+    limit: number;
+    consumed: number;
+    resetsAt?: Date | undefined;
+    window?: {
+    unit: string;
+    count: number;
+    } | undefined;
+    }[]>;
+    /** True while the policies are still loading and nothing has arrived yet */
+    isLoading: ComputedRef<boolean>;
+};
+
 /**
  * Check feature entitlement with usage details
  * Returns reactive refs for flag value, usage, allocation, and exceeded status