@schematichq/schematic-components 2.9.1 → 2.10.0

package/dist/schematic-components.d.ts

@@ -27,6 +27,11 @@ declare interface AddOnsProps {
     currency?: string;
 }
 
+export declare interface AvailableCurrenciesResult {
+    currencies: string[];
+    invalidFilterEntries: string[];
+}
+
 declare interface AvailablePlanOptions {
     useSelectedPeriod?: boolean;
 }
@@ -2224,6 +2229,7 @@ declare interface BillingProductResponseData_2 {
  * @export
  */
 declare const BillingProviderType: {
+    readonly Orb: "orb";
     readonly Schematic: "schematic";
     readonly Stripe: "stripe";
 };
@@ -2235,6 +2241,7 @@ declare type BillingProviderType = (typeof BillingProviderType)[keyof typeof Bil
  * @export
  */
 declare const BillingProviderType_2: {
+    readonly Orb: "orb";
     readonly Schematic: "schematic";
     readonly Stripe: "stripe";
 };
@@ -3115,6 +3122,12 @@ declare interface CompanyDetailResponseData {
      * @memberof CompanyDetailResponseData
      */
     createdAt: Date;
+    /**
+     *
+     * @type {Array<CustomPlanBillingResponseData>}
+     * @memberof CompanyDetailResponseData
+     */
+    customPlanBillings: Array<CustomPlanBillingResponseData>;
     /**
      *
      * @type {PaymentMethodResponseData}
@@ -3542,6 +3555,18 @@ declare interface CompanyPlanDetailResponseData {
      * @memberof CompanyPlanDetailResponseData
      */
     companyCount: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPlanDetailResponseData
+     */
+    companyId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPlanDetailResponseData
+     */
+    companyName?: string | null;
     /**
      *
      * @type {Array<string>}
@@ -3550,10 +3575,16 @@ declare interface CompanyPlanDetailResponseData {
     compatiblePlanIds: Array<string>;
     /**
      *
-     * @type {PlanControlledByType}
+     * @type {string}
+     * @memberof CompanyPlanDetailResponseData
+     */
+    controlledBy: string;
+    /**
+     *
+     * @type {string}
      * @memberof CompanyPlanDetailResponseData
      */
-    controlledBy: PlanControlledByType;
+    copiedFromPlanId?: string | null;
     /**
      *
      * @type {Date}
@@ -5077,6 +5108,103 @@ declare interface CurrencyBalance {
     currency: string;
 }
 
+/**
+ *
+ * @export
+ */
+declare const CustomPlanActivationStrategy: {
+    readonly Payment: "on_payment";
+    readonly Publish: "on_publish";
+};
+
+declare type CustomPlanActivationStrategy = (typeof CustomPlanActivationStrategy)[keyof typeof CustomPlanActivationStrategy];
+
+/**
+ *
+ * @export
+ * @interface CustomPlanBillingResponseData
+ */
+declare interface CustomPlanBillingResponseData {
+    /**
+     *
+     * @type {CustomPlanActivationStrategy}
+     * @memberof CustomPlanBillingResponseData
+     */
+    activationStrategy: CustomPlanActivationStrategy;
+    /**
+     *
+     * @type {string}
+     * @memberof CustomPlanBillingResponseData
+     */
+    companyId: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof CustomPlanBillingResponseData
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomPlanBillingResponseData
+     */
+    daysUntilDue: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CustomPlanBillingResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof CustomPlanBillingResponseData
+     */
+    paidAt?: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CustomPlanBillingResponseData
+     */
+    planId: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof CustomPlanBillingResponseData
+     */
+    publishedAt?: Date | null;
+    /**
+     *
+     * @type {CustomPlanBillingStatus}
+     * @memberof CustomPlanBillingResponseData
+     */
+    status: CustomPlanBillingStatus;
+    /**
+     *
+     * @type {string}
+     * @memberof CustomPlanBillingResponseData
+     */
+    stripeInvoiceUrl?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CustomPlanBillingResponseData
+     */
+    updatedAt: Date;
+}
+
+/**
+ *
+ * @export
+ */
+declare const CustomPlanBillingStatus: {
+    readonly Active: "active";
+    readonly Paid: "paid";
+    readonly Pending: "pending";
+};
+
+declare type CustomPlanBillingStatus = (typeof CustomPlanBillingStatus)[keyof typeof CustomPlanBillingStatus];
+
 /**
  * Schematic API
  * Schematic API
@@ -5497,7 +5625,7 @@ export declare interface EmbedProps {
     accessToken?: string;
 }
 
-export declare const EmbedProvider: ({ children, apiKey, apiConfig, ...options }: EmbedProviderProps) => JSX.Element;
+export declare const EmbedProvider: ({ children, apiKey, apiConfig, currencyFilter, ...options }: EmbedProviderProps) => JSX.Element;
 
 export declare interface EmbedProviderProps {
     children: React.ReactNode;
@@ -5505,6 +5633,12 @@ export declare interface EmbedProviderProps {
     apiConfig?: ConfigurationParameters;
     settings?: DeepPartial<EmbedSettings>;
     debug?: boolean;
+    /**
+     * Restricts which currencies are presented in components that support
+     * multi-currency display (PricingTable, CheckoutDialog). Entries are
+     * ISO-4217 codes; case-insensitive. Omit to disable filtering.
+     */
+    currencyFilter?: string[];
 }
 
 export declare type EmbedSettings = {
@@ -5525,6 +5659,7 @@ export declare interface EmbedState {
     settings: EmbedSettings;
     layout: EmbedLayout;
     checkoutState?: CheckoutState;
+    currencyFilter?: string[];
 }
 
 export declare const Entitlement: ({ entitlement, period, credits, tooltipPortal, currency: selectedCurrency, }: EntitlementProps) => JSX.Element;
@@ -7303,6 +7438,7 @@ export declare const initialContext: {
     settings: EmbedSettings;
     layout: EmbedLayout;
     checkoutState?: CheckoutState;
+    currencyFilter?: string[];
 };
 
 export declare const initialState: EmbedState;
@@ -7708,28 +7844,6 @@ export declare const Plan: ({ isLoading, plans, selectedPlan, period, selectPlan
 
 declare type Plan_2 = CompanyPlanDetailResponseData;
 
-/**
- *
- * @export
- */
-declare const PlanControlledByType: {
-    readonly Schematic: "schematic";
-    readonly Stripe: "stripe";
-};
-
-declare type PlanControlledByType = (typeof PlanControlledByType)[keyof typeof PlanControlledByType];
-
-/**
- *
- * @export
- */
-declare const PlanControlledByType_2: {
-    readonly Schematic: "schematic";
-    readonly Stripe: "stripe";
-};
-
-declare type PlanControlledByType_2 = (typeof PlanControlledByType_2)[keyof typeof PlanControlledByType_2];
-
 /**
  *
  * @export
@@ -8201,10 +8315,28 @@ declare interface PlanDetailResponseData {
     companyCount: number;
     /**
      *
-     * @type {PlanControlledByType}
+     * @type {string}
      * @memberof PlanDetailResponseData
      */
-    controlledBy: PlanControlledByType;
+    companyId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanDetailResponseData
+     */
+    companyName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanDetailResponseData
+     */
+    controlledBy: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanDetailResponseData
+     */
+    copiedFromPlanId?: string | null;
     /**
      *
      * @type {Date}
@@ -8764,6 +8896,18 @@ declare interface PlanResponseData {
      * @deprecated
      */
     audienceType?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanResponseData
+     */
+    companyId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanResponseData
+     */
+    copiedFromPlanId?: string | null;
     /**
      *
      * @type {Date}
@@ -8821,6 +8965,18 @@ declare interface PlanResponseData_2 {
      * @deprecated
      */
     audienceType?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanResponseData
+     */
+    companyId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanResponseData
+     */
+    copiedFromPlanId?: string | null;
     /**
      *
      * @type {Date}
@@ -9102,6 +9258,18 @@ declare interface PlanViewPublicResponseData {
      * @memberof PlanViewPublicResponseData
      */
     companyCount: number;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanViewPublicResponseData
+     */
+    companyId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanViewPublicResponseData
+     */
+    companyName?: string | null;
     /**
      *
      * @type {Array<string>}
@@ -9110,10 +9278,16 @@ declare interface PlanViewPublicResponseData {
     compatiblePlanIds: Array<string>;
     /**
      *
-     * @type {PlanControlledByType}
+     * @type {string}
      * @memberof PlanViewPublicResponseData
      */
-    controlledBy: PlanControlledByType_2;
+    controlledBy: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanViewPublicResponseData
+     */
+    copiedFromPlanId?: string | null;
     /**
      *
      * @type {Date}
@@ -10976,8 +11150,21 @@ declare interface UsageBasedEntitlementResponseData {
     yearlyUsageBasedPrice?: BillingPriceView;
 }
 
+/**
+ * Returns the currencies that should be displayed in the UI. When a
+ * `currencyFilter` is configured on EmbedProvider, this is the intersection
+ * of the filter with the hydrated currency set. Otherwise it is the full
+ * hydrated set.
+ */
 export declare function useAvailableCurrencies(): string[];
 
+/**
+ * Like `useAvailableCurrencies` but also returns the list of filter entries
+ * that did not match any currency in the hydrated data. Consumers can render
+ * an error notice and (optionally) log these invalid inputs.
+ */
+export declare function useAvailableCurrenciesWithInvalid(): AvailableCurrenciesResult;
+
 export declare function useAvailablePlans(activePeriod: string, options?: AvailablePlanOptions): {
     plans: SelectedPlan[];
     addOns: SelectedPlan[];