@schematichq/schematic-components 2.21.0 → 2.21.1-rc.1

package/dist/schematic-components.d.ts

@@ -702,10 +702,10 @@ declare interface BillingCreditView {
     pricePerUnitDecimal?: string | null;
     /**
      *
-     * @type {BillingProductResponseData}
+     * @type {BillingProductRecordResponseData}
      * @memberof BillingCreditView
      */
-    product?: BillingProductResponseData;
+    product?: BillingProductRecordResponseData;
     /**
      *
      * @type {string}
@@ -836,10 +836,10 @@ declare interface BillingCreditView_2 {
     pricePerUnitDecimal?: string | null;
     /**
      *
-     * @type {BillingProductResponseData}
+     * @type {BillingProductRecordResponseData}
      * @memberof BillingCreditView
      */
-    product?: BillingProductResponseData_2;
+    product?: BillingProductRecordResponseData_2;
     /**
      *
      * @type {string}
@@ -1054,6 +1054,12 @@ declare interface BillingPlanCreditGrantResponseData {
      * @memberof BillingPlanCreditGrantResponseData
      */
     canBuyBundles: boolean;
+    /**
+     * Credits granted once per company on top of the per-license amount. Always 0 when scaling is fixed.
+     * @type {number}
+     * @memberof BillingPlanCreditGrantResponseData
+     */
+    companyCreditAmount: number;
     /**
      *
      * @type {Date}
@@ -1123,6 +1129,12 @@ declare interface BillingPlanCreditGrantResponseData {
      * @memberof BillingPlanCreditGrantResponseData
      */
     id: string;
+    /**
+     * The license whose quantity scales this grant. Set only when scaling is per_license.
+     * @type {string}
+     * @memberof BillingPlanCreditGrantResponseData
+     */
+    licenseId?: string | null;
     /**
      *
      * @type {PreviewObjectResponseData}
@@ -1172,6 +1184,12 @@ declare interface BillingPlanCreditGrantResponseData {
      * @memberof BillingPlanCreditGrantResponseData
      */
     rolloverPercentage: number;
+    /**
+     * Whether the grant is a fixed amount per company, or issued once per license the company holds.
+     * @type {PlanCreditGrantScaling}
+     * @memberof BillingPlanCreditGrantResponseData
+     */
+    scaling: PlanCreditGrantScaling;
     /**
      *
      * @type {Date}
@@ -2236,6 +2254,130 @@ declare interface BillingProductPriceTierResponseData_2 {
     upTo?: number | null;
 }
 
+/**
+ *
+ * @export
+ * @interface BillingProductRecordResponseData
+ */
+declare interface BillingProductRecordResponseData {
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductRecordResponseData
+     */
+    accountId: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof BillingProductRecordResponseData
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductRecordResponseData
+     */
+    environmentId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductRecordResponseData
+     */
+    externalId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductRecordResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof BillingProductRecordResponseData
+     */
+    isActive: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductRecordResponseData
+     */
+    name: string;
+    /**
+     *
+     * @type {BillingProviderType}
+     * @memberof BillingProductRecordResponseData
+     */
+    providerType: BillingProviderType;
+    /**
+     *
+     * @type {Date}
+     * @memberof BillingProductRecordResponseData
+     */
+    updatedAt: Date;
+}
+
+/**
+ *
+ * @export
+ * @interface BillingProductRecordResponseData
+ */
+declare interface BillingProductRecordResponseData_2 {
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductRecordResponseData
+     */
+    accountId: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof BillingProductRecordResponseData
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductRecordResponseData
+     */
+    environmentId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductRecordResponseData
+     */
+    externalId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductRecordResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof BillingProductRecordResponseData
+     */
+    isActive: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductRecordResponseData
+     */
+    name: string;
+    /**
+     *
+     * @type {BillingProviderType}
+     * @memberof BillingProductRecordResponseData
+     */
+    providerType: BillingProviderType_2;
+    /**
+     *
+     * @type {Date}
+     * @memberof BillingProductRecordResponseData
+     */
+    updatedAt: Date;
+}
+
 /**
  *
  * @export
@@ -3099,7 +3241,7 @@ declare type ChargeType_2 = (typeof ChargeType_2)[keyof typeof ChargeType_2];
 
 export declare const Checkbox: IStyledComponentBase<"web", FastOmit<FastOmit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, keyof ClassAttributes<HTMLInputElement> | keyof InputHTMLAttributes<HTMLInputElement>> & ClassAttributes<HTMLInputElement> & InputHTMLAttributes<HTMLInputElement>, "type"> & Partial<Pick<FastOmit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, keyof ClassAttributes<HTMLInputElement> | keyof InputHTMLAttributes<HTMLInputElement>> & ClassAttributes<HTMLInputElement> & InputHTMLAttributes<HTMLInputElement>, "type">>> & string;
 
-export declare const Checkout: ({ customCheckoutFields, customFieldValues, isPaymentMethodRequired, onCustomFieldChange, optInRequired, optInTitle, optInText, optInAccepted, setOptInAccepted, setPaymentMethodId, promoCode, updatePromoCode, confirmPaymentIntentProps, financeData, onPaymentMethodSaved, }: CheckoutProps) => JSX.Element | null;
+export declare const Checkout: ({ collectTaxId, customCheckoutFields, customFieldValues, isPaymentMethodRequired, onCustomFieldChange, taxIdValues, onTaxIdChange, onTaxIdBlur, taxIdError, optInRequired, optInTitle, optInText, optInAccepted, setOptInAccepted, setPaymentMethodId, promoCode, updatePromoCode, confirmPaymentIntentProps, financeData, onPaymentMethodSaved, }: CheckoutProps) => JSX.Element | null;
 
 /**
  * Host-provided initial values used to pre-populate the checkout payment form.
@@ -3226,10 +3368,15 @@ export declare interface CheckoutPrefill {
 }
 
 declare interface CheckoutProps {
+    collectTaxId?: boolean;
     customCheckoutFields?: CheckoutFieldWithValue[];
     customFieldValues: Record<string, string>;
     isPaymentMethodRequired: boolean;
     onCustomFieldChange: (fieldId: string, value: string) => void;
+    taxIdValues?: TaxIdValues;
+    onTaxIdChange?: (value: TaxIdValues) => void;
+    onTaxIdBlur?: () => void;
+    taxIdError?: string;
     optInRequired: boolean;
     optInTitle?: string | null;
     optInText?: string | null;
@@ -4057,6 +4204,12 @@ declare interface CompanyPlanCreditGrantView {
      * @memberof CompanyPlanCreditGrantView
      */
     companyAutoTopupThresholdCredits?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    companyCreditAmount: number;
     /**
      *
      * @type {Date}
@@ -4126,6 +4279,12 @@ declare interface CompanyPlanCreditGrantView {
      * @memberof CompanyPlanCreditGrantView
      */
     id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    licenseId?: string | null;
     /**
      *
      * @type {GenericPreviewObject}
@@ -4175,6 +4334,12 @@ declare interface CompanyPlanCreditGrantView {
      * @memberof CompanyPlanCreditGrantView
      */
     rolloverPercentage: number;
+    /**
+     *
+     * @type {PlanCreditGrantScaling}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    scaling: PlanCreditGrantScaling;
     /**
      * Deprecated field, will be removed in the future. Use Credit.SingularName instead.
      * @type {string}
@@ -4391,12 +4556,12 @@ declare interface CompanyPlanDetailResponseData {
      */
     isDefault: boolean;
     /**
-     * Deprecated: Use BillingStrategy instead
+     * Deprecated: reports the plan's charge type, not its price. Read the plan's prices to tell whether it costs anything, or billing_strategy to tell how it is billed.
      * @type {boolean}
      * @memberof CompanyPlanDetailResponseData
      * @deprecated
      */
-    isFree: boolean;
+    isFree?: boolean | null;
     /**
      *
      * @type {boolean}
@@ -4660,6 +4825,55 @@ declare interface CompanySubscriptionResponseData {
     trialEnd?: Date | 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 CompanyTaxIDView
+ */
+declare interface CompanyTaxIDView {
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyTaxIDView
+     */
+    country: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyTaxIDView
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyTaxIDView
+     */
+    type: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyTaxIDView
+     */
+    value: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyTaxIDView
+     */
+    verificationStatus?: string | null;
+}
+
 /**
  *
  * @export
@@ -4818,17 +5032,6 @@ declare interface ComponentCapabilities_2 {
     checkout: boolean;
 }
 
-/**
- * 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
@@ -4853,6 +5056,18 @@ declare interface ComponentCheckoutSettings {
      * @memberof ComponentCheckoutSettings
      */
     collectPhone: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ComponentCheckoutSettings
+     */
+    collectTaxId: boolean;
+    /**
+     *
+     * @type {ProrationBehavior}
+     * @memberof ComponentCheckoutSettings
+     */
+    prorationBehavior: ProrationBehavior;
     /**
      *
      * @type {boolean}
@@ -5460,6 +5675,12 @@ declare interface CreditCompanyGrantView {
      * @memberof CreditCompanyGrantView
      */
     companyId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreditCompanyGrantView
+     */
+    companyLicenseId?: string | null;
     /**
      *
      * @type {string}
@@ -5538,6 +5759,12 @@ declare interface CreditCompanyGrantView {
      * @memberof CreditCompanyGrantView
      */
     id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreditCompanyGrantView
+     */
+    licenseName?: string | null;
     /**
      *
      * @type {string}
@@ -5997,6 +6224,12 @@ declare interface CustomPlanBillingResponseData {
      * @memberof CustomPlanBillingResponseData
      */
     publishedAt?: Date | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CustomPlanBillingResponseData
+     */
+    sendInvoice: boolean;
     /**
      *
      * @type {CustomPlanBillingStatus}
@@ -6470,6 +6703,8 @@ export declare interface EmbedContextProps extends EmbedState {
     finishCheckout: (changeSubscriptionRequestBody: CheckoutResponseData) => void;
     unsubscribe: () => DebouncedApiPromise<CheckoutUnsubscribeResponse>;
     updateCustomFieldValues: (values: Record<string, string>) => Promise<void> | undefined;
+    updateTaxId: (taxId: TaxIDInput) => Promise<UpdateCheckoutTaxIDResponse | undefined>;
+    getTaxId: () => Promise<GetCheckoutTaxIDResponse | undefined>;
     setAccessToken: (token: string) => void;
     setError: (error: Error) => void;
     setLayout: (layout: EmbedLayout) => void;
@@ -8404,6 +8639,26 @@ declare interface GenericPreviewObject_2 {
     name: string;
 }
 
+/**
+ *
+ * @export
+ * @interface GetCheckoutTaxIDResponse
+ */
+declare interface GetCheckoutTaxIDResponse {
+    /**
+     *
+     * @type {UpdateCheckoutTaxIDResponseData}
+     * @memberof GetCheckoutTaxIDResponse
+     */
+    data: UpdateCheckoutTaxIDResponseData;
+    /**
+     * Input parameters
+     * @type {object}
+     * @memberof GetCheckoutTaxIDResponse
+     */
+    params: object;
+}
+
 /**
  *
  * @export
@@ -8488,6 +8743,8 @@ export declare const initialContext: {
     checkout: () => never;
     unsubscribe: () => never;
     updateCustomFieldValues: () => never;
+    updateTaxId: () => never;
+    getTaxId: () => never;
     setError: () => never;
     setAccessToken: () => never;
     setLayout: () => never;
@@ -9155,6 +9412,28 @@ declare interface PlanCatalogMembershipResponseData_2 {
     name: string;
 }
 
+/**
+ *
+ * @export
+ */
+declare const PlanCreditGrantScaling: {
+    readonly Fixed: "fixed";
+    readonly PerLicense: "per_license";
+};
+
+declare type PlanCreditGrantScaling = (typeof PlanCreditGrantScaling)[keyof typeof PlanCreditGrantScaling];
+
+/**
+ *
+ * @export
+ */
+declare const PlanCreditGrantScaling_2: {
+    readonly Fixed: "fixed";
+    readonly PerLicense: "per_license";
+};
+
+declare type PlanCreditGrantScaling_2 = (typeof PlanCreditGrantScaling_2)[keyof typeof PlanCreditGrantScaling_2];
+
 /**
  *
  * @export
@@ -9227,6 +9506,12 @@ declare interface PlanCreditGrantView {
      * @memberof PlanCreditGrantView
      */
     billingCreditCanBuyBundles: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof PlanCreditGrantView
+     */
+    companyCreditAmount: number;
     /**
      *
      * @type {Date}
@@ -9296,6 +9581,12 @@ declare interface PlanCreditGrantView {
      * @memberof PlanCreditGrantView
      */
     id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanCreditGrantView
+     */
+    licenseId?: string | null;
     /**
      *
      * @type {GenericPreviewObject}
@@ -9345,6 +9636,12 @@ declare interface PlanCreditGrantView {
      * @memberof PlanCreditGrantView
      */
     rolloverPercentage: number;
+    /**
+     *
+     * @type {PlanCreditGrantScaling}
+     * @memberof PlanCreditGrantView
+     */
+    scaling: PlanCreditGrantScaling;
     /**
      * Deprecated field, will be removed in the future. Use Credit.SingularName instead.
      * @type {string}
@@ -9432,6 +9729,12 @@ declare interface PlanCreditGrantView_2 {
      * @memberof PlanCreditGrantView
      */
     billingCreditCanBuyBundles: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof PlanCreditGrantView
+     */
+    companyCreditAmount: number;
     /**
      *
      * @type {Date}
@@ -9501,6 +9804,12 @@ declare interface PlanCreditGrantView_2 {
      * @memberof PlanCreditGrantView
      */
     id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanCreditGrantView
+     */
+    licenseId?: string | null;
     /**
      *
      * @type {GenericPreviewObject}
@@ -9550,6 +9859,12 @@ declare interface PlanCreditGrantView_2 {
      * @memberof PlanCreditGrantView
      */
     rolloverPercentage: number;
+    /**
+     *
+     * @type {PlanCreditGrantScaling}
+     * @memberof PlanCreditGrantView
+     */
+    scaling: PlanCreditGrantScaling_2;
     /**
      * Deprecated field, will be removed in the future. Use Credit.SingularName instead.
      * @type {string}
@@ -9794,12 +10109,12 @@ declare interface PlanDetailResponseData {
      */
     isDefault: boolean;
     /**
-     * Deprecated: Use BillingStrategy instead
+     * Deprecated: reports the plan's charge type, not its price. Read the plan's prices to tell whether it costs anything, or billing_strategy to tell how it is billed.
      * @type {boolean}
      * @memberof PlanDetailResponseData
      * @deprecated
      */
-    isFree: boolean;
+    isFree?: boolean | null;
     /**
      *
      * @type {boolean}
@@ -10866,12 +11181,12 @@ declare interface PlanViewPublicResponseData {
      */
     isDefault: boolean;
     /**
-     * Deprecated: Use BillingStrategy instead
+     * Deprecated: reports the plan's charge type, not its price. Read the plan's prices to tell whether it costs anything, or billing_strategy to tell how it is billed.
      * @type {boolean}
      * @memberof PlanViewPublicResponseData
      * @deprecated
      */
-    isFree: boolean;
+    isFree?: boolean | null;
     /**
      *
      * @type {boolean}
@@ -11496,6 +11811,17 @@ export declare interface ProgressBarProps extends React.ComponentPropsWithoutRef
 
 export declare const progressColorMap: ("blue" | "red" | "yellow")[];
 
+/**
+ *
+ * @export
+ */
+declare const ProrationBehavior: {
+    readonly CreateProrations: "create_prorations";
+    readonly InvoiceImmediately: "invoice_immediately";
+};
+
+declare type ProrationBehavior = (typeof ProrationBehavior)[keyof typeof ProrationBehavior];
+
 /**
  *
  * @export
@@ -12425,6 +12751,84 @@ export declare const stub: () => never;
 
 export declare const StyledCard: IStyledComponentBase<"web", FastOmit<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never> & Partial<Pick<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>>> & string;
 
+/**
+ *
+ * @export
+ * @interface TaxIDInput
+ */
+declare interface TaxIDInput {
+    /**
+     *
+     * @type {TaxIdType}
+     * @memberof TaxIDInput
+     */
+    type: TaxIdType;
+    /**
+     *
+     * @type {string}
+     * @memberof TaxIDInput
+     */
+    value: string;
+}
+
+/**
+ *
+ * @export
+ */
+declare const TaxIdType: {
+    readonly AeTrn: "ae_trn";
+    readonly AuAbn: "au_abn";
+    readonly AuArn: "au_arn";
+    readonly BrCnpj: "br_cnpj";
+    readonly BrCpf: "br_cpf";
+    readonly CaBn: "ca_bn";
+    readonly CaGstHst: "ca_gst_hst";
+    readonly CaPstBc: "ca_pst_bc";
+    readonly CaPstMb: "ca_pst_mb";
+    readonly CaPstSk: "ca_pst_sk";
+    readonly CaQst: "ca_qst";
+    readonly ChUid: "ch_uid";
+    readonly ChVat: "ch_vat";
+    readonly EuVat: "eu_vat";
+    readonly GbVat: "gb_vat";
+    readonly HkBr: "hk_br";
+    readonly IdNpwp: "id_npwp";
+    readonly IlVat: "il_vat";
+    readonly InGst: "in_gst";
+    readonly JpCn: "jp_cn";
+    readonly JpRn: "jp_rn";
+    readonly JpTrn: "jp_trn";
+    readonly KrBrn: "kr_brn";
+    readonly MxRfc: "mx_rfc";
+    readonly MyFrp: "my_frp";
+    readonly MyItn: "my_itn";
+    readonly MySst: "my_sst";
+    readonly NoVat: "no_vat";
+    readonly NzGst: "nz_gst";
+    readonly PhTin: "ph_tin";
+    readonly SaVat: "sa_vat";
+    readonly SgGst: "sg_gst";
+    readonly SgUen: "sg_uen";
+    readonly ThVat: "th_vat";
+    readonly TrTin: "tr_tin";
+    readonly TwVat: "tw_vat";
+    readonly UsEin: "us_ein";
+    readonly ZaVat: "za_vat";
+};
+
+declare type TaxIdType = (typeof TaxIdType)[keyof typeof TaxIdType];
+
+/**
+ * TaxIdValues is the form-state shape the tax-ID field group reads and writes.
+ * `country` narrows the picker; `type` is the Stripe tax-ID type actually
+ * submitted; `value` is the ID itself.
+ */
+declare type TaxIdValues = {
+    country: string;
+    type: string;
+    value: string;
+};
+
 declare const Text_2: IStyledComponentBase<"web", FastOmit<FastOmit<FastOmit<DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, keyof ClassAttributes<HTMLSpanElement> | keyof HTMLAttributes<HTMLSpanElement>> & ClassAttributes<HTMLSpanElement> & HTMLAttributes<HTMLSpanElement>, keyof TextProps> & TextProps, "tabIndex"> & Partial<Pick<FastOmit<FastOmit<DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, keyof ClassAttributes<HTMLSpanElement> | keyof HTMLAttributes<HTMLSpanElement>> & ClassAttributes<HTMLSpanElement> & HTMLAttributes<HTMLSpanElement>, keyof TextProps> & TextProps, "tabIndex">>> & string;
 export { Text_2 as Text }
 
@@ -12703,6 +13107,40 @@ declare interface UpdateAutoTopupOverrideRequestBody {
     planCreditGrantId: string;
 }
 
+/**
+ *
+ * @export
+ * @interface UpdateCheckoutTaxIDResponse
+ */
+declare interface UpdateCheckoutTaxIDResponse {
+    /**
+     *
+     * @type {UpdateCheckoutTaxIDResponseData}
+     * @memberof UpdateCheckoutTaxIDResponse
+     */
+    data: UpdateCheckoutTaxIDResponseData;
+    /**
+     * Input parameters
+     * @type {object}
+     * @memberof UpdateCheckoutTaxIDResponse
+     */
+    params: object;
+}
+
+/**
+ *
+ * @export
+ * @interface UpdateCheckoutTaxIDResponseData
+ */
+declare interface UpdateCheckoutTaxIDResponseData {
+    /**
+     *
+     * @type {Array<CompanyTaxIDView>}
+     * @memberof UpdateCheckoutTaxIDResponseData
+     */
+    taxIds: Array<CompanyTaxIDView>;
+}
+
 /**
  * Schematic API
  * Schematic API