@schematichq/schematic-typescript-node 1.2.1 → 1.2.3

package/dist/api/resources/plans/client/requests/ListPlansRequest.d.ts

@@ -4,10 +4,36 @@
 import * as Schematic from "../../../../index";
 /**
  * @example
- *     {}
+ *     {
+ *         companyId: "company_id",
+ *         forFallbackPlan: true,
+ *         forInitialPlan: true,
+ *         forTrialExpiryPlan: true,
+ *         hasProductId: true,
+ *         planType: "plan",
+ *         q: "q",
+ *         requiresPaymentMethod: true,
+ *         withoutEntitlementFor: "without_entitlement_for",
+ *         withoutProductId: true,
+ *         withoutPaidProductId: true,
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ListPlansRequest {
     companyId?: string;
+    /**
+     * Filter for plans valid as fallback plans (not linked to billing)
+     */
+    forFallbackPlan?: boolean;
+    /**
+     * Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial)
+     */
+    forInitialPlan?: boolean;
+    /**
+     * Filter for plans valid as trial expiry plans (not linked to billing or free)
+     */
+    forTrialExpiryPlan?: boolean;
     /**
      * Filter out plans that do not have a billing product ID
      */
@@ -18,6 +44,10 @@ export interface ListPlansRequest {
      */
     planType?: Schematic.ListPlansRequestPlanType;
     q?: string;
+    /**
+     * Filter for plans that require a payment method (inverse of ForInitialPlan)
+     */
+    requiresPaymentMethod?: boolean;
     /**
      * Filter out plans that already have a plan entitlement for the specified feature ID
      */

package/dist/api/resources/plans/client/requests/index.d.ts

@@ -5,3 +5,4 @@ export { type CreatePlanRequestBody } from "./CreatePlanRequestBody";
 export { type UpdatePlanRequestBody } from "./UpdatePlanRequestBody";
 export { type UpsertBillingProductRequestBody } from "./UpsertBillingProductRequestBody";
 export { type CountPlansRequest } from "./CountPlansRequest";
+export { type ListPlanIssuesRequest } from "./ListPlanIssuesRequest";

package/dist/api/resources/plans/types/CountPlansParams.d.ts

@@ -7,6 +7,12 @@ import * as Schematic from "../../../index";
  */
 export interface CountPlansParams {
     companyId?: string;
+    /** Filter for plans valid as fallback plans (not linked to billing) */
+    forFallbackPlan?: boolean;
+    /** Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial) */
+    forInitialPlan?: boolean;
+    /** Filter for plans valid as trial expiry plans (not linked to billing or free) */
+    forTrialExpiryPlan?: boolean;
     /** Filter out plans that do not have a billing product ID */
     hasProductId?: boolean;
     ids?: string[];
@@ -17,6 +23,8 @@ export interface CountPlansParams {
     /** Filter by plan type */
     planType?: Schematic.CountPlansResponseParamsPlanType;
     q?: string;
+    /** Filter for plans that require a payment method (inverse of ForInitialPlan) */
+    requiresPaymentMethod?: boolean;
     /** Filter out plans that already have a plan entitlement for the specified feature ID */
     withoutEntitlementFor?: string;
     /** Filter out plans that have a paid billing product ID */

package/dist/api/resources/plans/types/ListPlanIssuesParams.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Input parameters
+ */
+export interface ListPlanIssuesParams {
+    planId?: string;
+}

package/dist/api/resources/plans/types/ListPlanIssuesResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../../../index";
+export interface ListPlanIssuesResponse {
+    data: Schematic.PlanIssueResponseData[];
+    /** Input parameters */
+    params: Schematic.ListPlanIssuesParams;
+}

package/dist/api/resources/plans/types/ListPlansParams.d.ts

@@ -7,6 +7,12 @@ import * as Schematic from "../../../index";
  */
 export interface ListPlansParams {
     companyId?: string;
+    /** Filter for plans valid as fallback plans (not linked to billing) */
+    forFallbackPlan?: boolean;
+    /** Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial) */
+    forInitialPlan?: boolean;
+    /** Filter for plans valid as trial expiry plans (not linked to billing or free) */
+    forTrialExpiryPlan?: boolean;
     /** Filter out plans that do not have a billing product ID */
     hasProductId?: boolean;
     ids?: string[];
@@ -17,6 +23,8 @@ export interface ListPlansParams {
     /** Filter by plan type */
     planType?: Schematic.ListPlansResponseParamsPlanType;
     q?: string;
+    /** Filter for plans that require a payment method (inverse of ForInitialPlan) */
+    requiresPaymentMethod?: boolean;
     /** Filter out plans that already have a plan entitlement for the specified feature ID */
     withoutEntitlementFor?: string;
     /** Filter out plans that have a paid billing product ID */

package/dist/api/resources/plans/types/ListPlansResponse.d.ts

@@ -3,7 +3,6 @@
  */
 import * as Schematic from "../../../index";
 export interface ListPlansResponse {
-    /** The returned resources */
     data: Schematic.PlanDetailResponseData[];
     /** Input parameters */
     params: Schematic.ListPlansParams;

package/dist/api/resources/plans/types/index.d.ts

@@ -17,3 +17,5 @@ export * from "./CountPlansRequestPlanType";
 export * from "./CountPlansResponseParamsPlanType";
 export * from "./CountPlansParams";
 export * from "./CountPlansResponse";
+export * from "./ListPlanIssuesParams";
+export * from "./ListPlanIssuesResponse";

package/dist/api/resources/webhooks/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Webhooks {
         environment?: core.Supplier<environments.SchematicEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -25,7 +25,7 @@ export declare namespace Webhooks {
 }
 export declare class Webhooks {
     protected readonly _options: Webhooks.Options;
-    constructor(_options: Webhooks.Options);
+    constructor(_options?: Webhooks.Options);
     /**
      * @param {Schematic.ListWebhookEventsRequest} request
      * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
@@ -37,7 +37,12 @@ export declare class Webhooks {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.webhooks.listWebhookEvents()
+     *     await client.webhooks.listWebhookEvents({
+     *         q: "q",
+     *         webhookId: "webhook_id",
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     listWebhookEvents(request?: Schematic.ListWebhookEventsRequest, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<Schematic.ListWebhookEventsResponse>;
     private __listWebhookEvents;
@@ -66,7 +71,12 @@ export declare class Webhooks {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.webhooks.countWebhookEvents()
+     *     await client.webhooks.countWebhookEvents({
+     *         q: "q",
+     *         webhookId: "webhook_id",
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     countWebhookEvents(request?: Schematic.CountWebhookEventsRequest, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<Schematic.CountWebhookEventsResponse>;
     private __countWebhookEvents;
@@ -81,7 +91,11 @@ export declare class Webhooks {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.webhooks.listWebhooks()
+     *     await client.webhooks.listWebhooks({
+     *         q: "q",
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     listWebhooks(request?: Schematic.ListWebhooksRequest, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<Schematic.ListWebhooksResponse>;
     private __listWebhooks;
@@ -160,11 +174,15 @@ export declare class Webhooks {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.webhooks.countWebhooks()
+     *     await client.webhooks.countWebhooks({
+     *         q: "q",
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     countWebhooks(request?: Schematic.CountWebhooksRequest, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<Schematic.CountWebhooksResponse>;
     private __countWebhooks;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "X-Schematic-Api-Key": string;
+        "X-Schematic-Api-Key": string | undefined;
     }>;
 }

package/dist/api/resources/webhooks/client/requests/CountWebhookEventsRequest.d.ts

@@ -3,7 +3,12 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         q: "q",
+ *         webhookId: "webhook_id",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface CountWebhookEventsRequest {
     ids?: string | string[];

package/dist/api/resources/webhooks/client/requests/CountWebhooksRequest.d.ts

@@ -3,7 +3,11 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         q: "q",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface CountWebhooksRequest {
     q?: string;

package/dist/api/resources/webhooks/client/requests/ListWebhookEventsRequest.d.ts

@@ -3,7 +3,12 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         q: "q",
+ *         webhookId: "webhook_id",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ListWebhookEventsRequest {
     ids?: string | string[];

package/dist/api/resources/webhooks/client/requests/ListWebhooksRequest.d.ts

@@ -3,7 +3,11 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         q: "q",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ListWebhooksRequest {
     q?: string;

package/dist/api/resources/webhooks/types/ListWebhookEventsResponse.d.ts

@@ -3,7 +3,6 @@
  */
 import * as Schematic from "../../../index";
 export interface ListWebhookEventsResponse {
-    /** The returned resources */
     data: Schematic.WebhookEventDetailResponseData[];
     /** Input parameters */
     params: Schematic.ListWebhookEventsParams;

package/dist/api/resources/webhooks/types/ListWebhooksResponse.d.ts

@@ -3,7 +3,6 @@
  */
 import * as Schematic from "../../../index";
 export interface ListWebhooksResponse {
-    /** The returned resources */
     data: Schematic.WebhookResponseData[];
     /** Input parameters */
     params: Schematic.ListWebhooksParams;

package/dist/api/types/ApiKeyCreateResponseData.d.ts

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The created resource
- */
 export interface ApiKeyCreateResponseData {
     createdAt: Date;
     description?: string;

package/dist/api/types/ApiKeyRequestResponseData.d.ts

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The returned resource
- */
 export interface ApiKeyRequestResponseData {
     apiKeyId: string;
     endedAt?: Date;

package/dist/api/types/ApiKeyResponseData.d.ts

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The updated resource
- */
 export interface ApiKeyResponseData {
     createdAt: Date;
     description?: string;

package/dist/api/types/BillingCreditBundleResponseData.d.ts

@@ -13,6 +13,7 @@ export interface BillingCreditBundleResponseData {
     expiryType: string;
     expiryUnit: string;
     expiryUnitCount?: number;
+    hasGrants: boolean;
     id: string;
     name: string;
     pluralName?: string;

package/dist/api/types/BillingCreditBundleView.d.ts

@@ -13,6 +13,7 @@ export interface BillingCreditBundleView {
     expiryType: string;
     expiryUnit: string;
     expiryUnitCount?: number;
+    hasGrants: boolean;
     id: string;
     name: string;
     pluralName?: string;

package/dist/api/types/BillingCreditLedgerResponseData.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface BillingCreditLedgerResponseData {
+    description?: string;
+    icon?: string;
+    id: string;
+    name: string;
+    pluralName?: string;
+    singularName?: string;
+}

package/dist/api/types/BillingCustomerResponseData.d.ts

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The created resource
- */
 export interface BillingCustomerResponseData {
     companyId?: string;
     deletedAt?: Date;

package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts

@@ -5,10 +5,17 @@ export interface BillingPlanCreditGrantResponseData {
     createdAt: Date;
     creditAmount: number;
     creditId: string;
+    creditName: string;
+    creditPluralName?: string;
+    creditSingularName?: string;
+    expiryType?: string;
+    expiryUnit?: string;
+    expiryUnitCount?: number;
     id: string;
     planId: string;
     planName: string;
     resetCadence: string;
     resetStart: string;
+    resetType?: string;
     updatedAt: Date;
 }

package/dist/api/types/BillingProductDetailResponseData.d.ts

@@ -5,7 +5,8 @@ import * as Schematic from "../index";
 export interface BillingProductDetailResponseData {
     accountId: string;
     createdAt: Date;
-    currency: string;
+    /** Deprecated; currencies are associated with prices, not products */
+    currency?: string;
     environmentId: string;
     externalId: string;
     isActive: boolean;

package/dist/api/types/BillingProductForSubscriptionResponseData.d.ts

@@ -4,6 +4,7 @@
 import * as Schematic from "../index";
 export interface BillingProductForSubscriptionResponseData {
     billingScheme: string;
+    billingThreshold?: number;
     createdAt: Date;
     currency: string;
     environmentId: string;
@@ -20,6 +21,7 @@ export interface BillingProductForSubscriptionResponseData {
     priceTier: Schematic.BillingProductPriceTierResponseData[];
     quantity: number;
     subscriptionId: string;
+    subscriptionItemExternalId?: string;
     updatedAt: Date;
     usageType: string;
 }

package/dist/api/types/BillingProductPlanResponseData.d.ts

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The updated resource
- */
 export interface BillingProductPlanResponseData {
     accountId: string;
     billingProductId: string;

package/dist/api/types/BillingProductPricing.d.ts

@@ -3,6 +3,7 @@
  */
 import * as Schematic from "../index";
 export interface BillingProductPricing {
+    billingThreshold?: number;
     currency: string;
     interval: string;
     meterId?: string;
@@ -12,5 +13,6 @@ export interface BillingProductPricing {
     priceExternalId: string;
     productExternalId: string;
     quantity: number;
+    subscriptionItemExternalId?: string;
     usageType: Schematic.BillingProductPricingUsageType;
 }

package/dist/api/types/BillingProductResponseData.d.ts

@@ -4,7 +4,8 @@
 export interface BillingProductResponseData {
     accountId: string;
     createdAt: Date;
-    currency: string;
+    /** Deprecated; currencies are associated with prices, not products */
+    currency?: string;
     environmentId: string;
     externalId: string;
     isActive: boolean;

package/dist/api/types/BillingSubscriptionView.d.ts

@@ -2,9 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Schematic from "../index";
-/**
- * The updated resource
- */
 export interface BillingSubscriptionView {
     cancelAt?: number;
     cancelAtPeriodEnd: boolean;

package/dist/api/types/CheckFlagResponseData.d.ts

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The returned resource
- */
 export interface CheckFlagResponseData {
     /** If company keys were provided and matched a company, its ID */
     companyId?: string;

package/dist/api/types/CheckFlagsResponseData.d.ts

@@ -2,9 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Schematic from "../index";
-/**
- * The created resource
- */
 export interface CheckFlagsResponseData {
     flags: Schematic.CheckFlagResponseData[];
 }

package/dist/api/types/CheckoutDataResponseData.d.ts

@@ -2,9 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Schematic from "../index";
-/**
- * The requested resource
- */
 export interface CheckoutDataResponseData {
     activeAddOns: Schematic.PlanDetailResponseData[];
     activePlan?: Schematic.PlanDetailResponseData;

package/dist/api/types/CheckoutSettingsResponseData.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CheckoutSettingsResponseData {
+    collectAddress: boolean;
+    collectEmail: boolean;
+    collectPhone: boolean;
+}

package/dist/api/types/CheckoutSubscription.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CheckoutSubscription {
+    cancelAt?: number;
+    cancelAtPeriodEnd: boolean;
+    companyId?: string;
+    confirmPaymentIntentClientSecret?: string;
+    confirmPaymentIntentId?: string;
+    createdAt: Date;
+    currency: string;
+    customerExternalId: string;
+    defaultPaymentMethodId?: string;
+    expiredAt?: Date;
+    id: string;
+    interval: string;
+    metadata?: Record<string, unknown>;
+    periodEnd: number;
+    periodStart: number;
+    status: string;
+    subscriptionExternalId: string;
+    totalPrice: number;
+    trialEnd?: number;
+    trialEndSetting?: string;
+}

package/dist/api/types/CompanyDetailResponseData.d.ts

@@ -20,6 +20,7 @@ export interface CompanyDetailResponseData {
     paymentMethods: Schematic.PaymentMethodResponseData[];
     plan?: Schematic.CompanyPlanWithBillingSubView;
     plans: Schematic.GenericPreviewObject[];
+    rules: Schematic.Rule[];
     /** A map of trait names to trait values */
     traits?: Record<string, unknown>;
     updatedAt: Date;

package/dist/api/types/CompanyLedgerResponseData.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CompanyLedgerResponseData {
+    id: string;
+    logoUrl?: string;
+    name: string;
+}

package/dist/api/types/CompanyOverrideNoteResponseData.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CompanyOverrideNoteResponseData {
+    createdAt: Date;
+    externalUserId: string;
+    externalUserName: string;
+    id: string;
+    note: string;
+    updatedAt: Date;
+}

package/dist/api/types/CompanyOverrideResponseData.d.ts

@@ -14,6 +14,7 @@ export interface CompanyOverrideResponseData {
     id: string;
     metricPeriod?: string;
     metricPeriodMonthReset?: string;
+    notes: Schematic.CompanyOverrideNoteResponseData[];
     ruleId?: string;
     ruleIdUsageExceeded?: string;
     updatedAt: Date;

package/dist/api/types/CompanyPlanDetailResponseData.d.ts

@@ -30,6 +30,7 @@ export interface CompanyPlanDetailResponseData {
     planType: string;
     trialDays?: number;
     updatedAt: Date;
+    usageViolations: Schematic.FeatureUsageResponseData[];
     valid: boolean;
     yearlyPrice?: Schematic.BillingPriceResponseData;
 }

package/dist/api/types/CompanyViewWithFeatureUsageResponseData.d.ts

@@ -21,6 +21,7 @@ export interface CompanyViewWithFeatureUsageResponseData {
     paymentMethods: Schematic.PaymentMethodResponseData[];
     plan?: Schematic.CompanyPlanWithBillingSubView;
     plans: Schematic.GenericPreviewObject[];
+    rules: Schematic.Rule[];
     /** A map of trait names to trait values */
     traits?: Record<string, unknown>;
     updatedAt: Date;

package/dist/api/types/ComponentCheckoutSettings.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ComponentCheckoutSettings {
+    collectAddress: boolean;
+    collectEmail: boolean;
+    collectPhone: boolean;
+    taxCollectionEnabled: boolean;
+}

package/dist/api/types/ComponentHydrateResponseData.d.ts

@@ -8,13 +8,17 @@ export interface ComponentHydrateResponseData {
     activeUsageBasedEntitlements: Schematic.UsageBasedEntitlementResponseData[];
     addOnCompatibilities: Schematic.CompatiblePlans[];
     capabilities?: Schematic.ComponentCapabilities;
+    checkoutSettings: Schematic.ComponentCheckoutSettings;
     company?: Schematic.CompanyDetailResponseData;
     component?: Schematic.ComponentResponseData;
     creditBundles: Schematic.BillingCreditBundleView[];
     creditGrants: Schematic.CreditCompanyGrantView[];
     defaultPlan?: Schematic.PlanDetailResponseData;
     featureUsage?: Schematic.FeatureUsageDetailResponseData;
+    postTrialPlan?: Schematic.PlanDetailResponseData;
+    showCredits: boolean;
     showPeriodToggle: boolean;
+    showZeroPriceAsFree: boolean;
     stripeEmbed?: Schematic.StripeEmbedInfo;
     subscription?: Schematic.CompanySubscriptionResponseData;
     trialPaymentMethodRequired?: boolean;

package/dist/api/types/ComponentPreviewResponseData.d.ts

@@ -2,15 +2,13 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Schematic from "../index";
-/**
- * The returned resource
- */
 export interface ComponentPreviewResponseData {
     activeAddOns: Schematic.CompanyPlanDetailResponseData[];
     activePlans: Schematic.CompanyPlanDetailResponseData[];
     activeUsageBasedEntitlements: Schematic.UsageBasedEntitlementResponseData[];
     addOnCompatibilities: Schematic.CompatiblePlans[];
     capabilities?: Schematic.ComponentCapabilities;
+    checkoutSettings: Schematic.ComponentCheckoutSettings;
     company?: Schematic.CompanyDetailResponseData;
     component?: Schematic.ComponentResponseData;
     creditBundles: Schematic.BillingCreditBundleView[];
@@ -18,7 +16,10 @@ export interface ComponentPreviewResponseData {
     defaultPlan?: Schematic.PlanDetailResponseData;
     featureUsage?: Schematic.FeatureUsageDetailResponseData;
     invoices: Schematic.InvoiceResponseData[];
+    postTrialPlan?: Schematic.PlanDetailResponseData;
+    showCredits: boolean;
     showPeriodToggle: boolean;
+    showZeroPriceAsFree: boolean;
     stripeEmbed?: Schematic.StripeEmbedInfo;
     subscription?: Schematic.CompanySubscriptionResponseData;
     trialPaymentMethodRequired?: boolean;

package/dist/api/types/ComponentResponseData.d.ts

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The updated resource
- */
 export interface ComponentResponseData {
     ast?: Record<string, number>;
     createdAt: Date;