@schematichq/schematic-typescript-node 1.5.0 → 1.5.2

package/dist/rules-engine.d.ts

@@ -9,13 +9,17 @@ export interface WasmFeatureEntitlement {
     softLimit?: number;
     usage?: number;
     eventName?: string;
+    eventSubtype?: string;
     metricPeriod?: Schematic.RulesengineMetricPeriod;
     monthReset?: Schematic.RulesengineMetricPeriodMonthReset;
     metricResetAt?: string;
     creditId?: string;
+    consumptionRate?: number;
     creditTotal?: number;
     creditUsed?: number;
     creditRemaining?: number;
+    creditReserved?: number;
+    creditSettled?: number;
 }
 /** Result returned by the WASM rules engine */
 export interface WasmCheckFlagResult {

package/dist/serialization/resources/billing/types/DeleteBillingCouponResponse.d.ts

@@ -0,0 +1,11 @@
+import type * as Schematic from "../../../../api/index";
+import * as core from "../../../../core";
+import type * as serializers from "../../../index";
+import { DeleteResponse } from "../../../types/DeleteResponse";
+export declare const DeleteBillingCouponResponse: core.serialization.ObjectSchema<serializers.DeleteBillingCouponResponse.Raw, Schematic.DeleteBillingCouponResponse>;
+export declare namespace DeleteBillingCouponResponse {
+    interface Raw {
+        data: DeleteResponse.Raw;
+        params: Record<string, unknown>;
+    }
+}

package/dist/serialization/resources/billing/types/DeleteBillingCustomerResponse.d.ts

@@ -0,0 +1,11 @@
+import type * as Schematic from "../../../../api/index";
+import * as core from "../../../../core";
+import type * as serializers from "../../../index";
+import { DeleteResponse } from "../../../types/DeleteResponse";
+export declare const DeleteBillingCustomerResponse: core.serialization.ObjectSchema<serializers.DeleteBillingCustomerResponse.Raw, Schematic.DeleteBillingCustomerResponse>;
+export declare namespace DeleteBillingCustomerResponse {
+    interface Raw {
+        data: DeleteResponse.Raw;
+        params: Record<string, unknown>;
+    }
+}

package/dist/serialization/resources/billing/types/DeleteBillingInvoiceResponse.d.ts

@@ -0,0 +1,11 @@
+import type * as Schematic from "../../../../api/index";
+import * as core from "../../../../core";
+import type * as serializers from "../../../index";
+import { DeleteResponse } from "../../../types/DeleteResponse";
+export declare const DeleteBillingInvoiceResponse: core.serialization.ObjectSchema<serializers.DeleteBillingInvoiceResponse.Raw, Schematic.DeleteBillingInvoiceResponse>;
+export declare namespace DeleteBillingInvoiceResponse {
+    interface Raw {
+        data: DeleteResponse.Raw;
+        params: Record<string, unknown>;
+    }
+}

package/dist/serialization/resources/billing/types/ListBillingPricesParams.d.ts

@@ -15,6 +15,7 @@ export declare namespace ListBillingPricesParams {
         is_active?: boolean | null;
         limit?: number | null;
         offset?: number | null;
+        plan_version_id?: string | null;
         price?: number | null;
         product_id?: string | null;
         product_ids?: string[] | null;

package/dist/serialization/resources/billing/types/ListBillingProductPricesParams.d.ts

@@ -15,6 +15,7 @@ export declare namespace ListBillingProductPricesParams {
         is_active?: boolean | null;
         limit?: number | null;
         offset?: number | null;
+        plan_version_id?: string | null;
         price?: number | null;
         product_id?: string | null;
         product_ids?: string[] | null;

package/dist/serialization/resources/billing/types/index.d.ts

@@ -2,6 +2,9 @@ export * from "./CountBillingProductsParams";
 export * from "./CountBillingProductsResponse";
 export * from "./CountCustomersParams";
 export * from "./CountCustomersResponse";
+export * from "./DeleteBillingCouponResponse";
+export * from "./DeleteBillingCustomerResponse";
+export * from "./DeleteBillingInvoiceResponse";
 export * from "./DeleteBillingProductResponse";
 export * from "./DeletePaymentMethodByExternalIdResponse";
 export * from "./DeleteProductPriceResponse";

package/dist/serialization/resources/credits/types/index.d.ts

@@ -11,8 +11,6 @@ export * from "./CountCreditBundlesParams";
 export * from "./CountCreditBundlesResponse";
 export * from "./CountCreditEventLedgerParams";
 export * from "./CountCreditEventLedgerResponse";
-export * from "./CountCreditLedgerParams";
-export * from "./CountCreditLedgerResponse";
 export * from "./CreateBillingCreditResponse";
 export * from "./CreateBillingPlanCreditGrantResponse";
 export * from "./CreateCreditBundleResponse";
@@ -21,8 +19,6 @@ export * from "./DeleteBillingPlanCreditGrantResponse";
 export * from "./DeleteCreditBundleResponse";
 export * from "./ExtendCreditLeaseResponse";
 export * from "./GetCreditBundleResponse";
-export * from "./GetEnrichedCreditLedgerParams";
-export * from "./GetEnrichedCreditLedgerResponse";
 export * from "./GetSingleBillingCreditResponse";
 export * from "./GetSingleBillingPlanCreditGrantResponse";
 export * from "./GrantBillingCreditsToCompanyResponse";

package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts

@@ -23,6 +23,9 @@ export declare namespace CreatePlanGroupRequestBody {
         fallback_plan_id?: string | null;
         initial_plan_id?: string | null;
         initial_plan_price_id?: string | null;
+        opt_in_enabled: boolean;
+        opt_in_text?: string | null;
+        opt_in_title?: string | null;
         ordered_add_ons: OrderedPlansInGroup.Raw[];
         ordered_bundle_list: PlanGroupBundleOrder.Raw[];
         ordered_plans: OrderedPlansInGroup.Raw[];

package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts

@@ -23,6 +23,9 @@ export declare namespace UpdatePlanGroupRequestBody {
         fallback_plan_id?: string | null;
         initial_plan_id?: string | null;
         initial_plan_price_id?: string | null;
+        opt_in_enabled: boolean;
+        opt_in_text?: string | null;
+        opt_in_title?: string | null;
         ordered_add_ons: OrderedPlansInGroup.Raw[];
         ordered_bundle_list: PlanGroupBundleOrder.Raw[];
         ordered_plans: OrderedPlansInGroup.Raw[];

package/dist/serialization/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts

@@ -3,7 +3,6 @@ import * as core from "../../../../../core";
 import type * as serializers from "../../../../index";
 import { CustomPlanActivationStrategy } from "../../../../types/CustomPlanActivationStrategy";
 import { PlanVersionMigrationStrategy } from "../../../../types/PlanVersionMigrationStrategy";
-import { UpdatePayInAdvanceRequestBody } from "../../../../types/UpdatePayInAdvanceRequestBody";
 export declare const PublishPlanVersionRequestBody: core.serialization.Schema<serializers.PublishPlanVersionRequestBody.Raw, Schematic.PublishPlanVersionRequestBody>;
 export declare namespace PublishPlanVersionRequestBody {
     interface Raw {
@@ -12,6 +11,5 @@ export declare namespace PublishPlanVersionRequestBody {
         days_until_due?: number | null;
         excluded_company_ids: string[];
         migration_strategy: PlanVersionMigrationStrategy.Raw;
-        pay_in_advance: UpdatePayInAdvanceRequestBody.Raw[];
     }
 }

package/dist/serialization/resources/plans/client/requests/RetryCustomPlanBillingRequestBody.d.ts

@@ -2,13 +2,11 @@ import type * as Schematic from "../../../../../api/index";
 import * as core from "../../../../../core";
 import type * as serializers from "../../../../index";
 import { CustomPlanActivationStrategy } from "../../../../types/CustomPlanActivationStrategy";
-import { UpdatePayInAdvanceRequestBody } from "../../../../types/UpdatePayInAdvanceRequestBody";
 export declare const RetryCustomPlanBillingRequestBody: core.serialization.Schema<serializers.RetryCustomPlanBillingRequestBody.Raw, Schematic.RetryCustomPlanBillingRequestBody>;
 export declare namespace RetryCustomPlanBillingRequestBody {
     interface Raw {
         activation_strategy?: CustomPlanActivationStrategy.Raw | null;
         customer_email: string;
         days_until_due?: number | null;
-        pay_in_advance: UpdatePayInAdvanceRequestBody.Raw[];
     }
 }

package/dist/serialization/resources/webhooks/client/requests/TestWebhookRequestBody.d.ts

@@ -0,0 +1,10 @@
+import type * as Schematic from "../../../../../api/index";
+import * as core from "../../../../../core";
+import type * as serializers from "../../../../index";
+import { WebhookRequestType } from "../../../../types/WebhookRequestType";
+export declare const TestWebhookRequestBody: core.serialization.Schema<serializers.TestWebhookRequestBody.Raw, Schematic.TestWebhookRequestBody>;
+export declare namespace TestWebhookRequestBody {
+    interface Raw {
+        request_type: WebhookRequestType.Raw;
+    }
+}

package/dist/serialization/resources/webhooks/client/requests/index.d.ts

@@ -1,2 +1,3 @@
 export { CreateWebhookRequestBody } from "./CreateWebhookRequestBody";
+export { TestWebhookRequestBody } from "./TestWebhookRequestBody";
 export { UpdateWebhookRequestBody } from "./UpdateWebhookRequestBody";

package/dist/serialization/resources/webhooks/types/SendTestWebhookActionResponse.d.ts

@@ -0,0 +1,11 @@
+import type * as Schematic from "../../../../api/index";
+import * as core from "../../../../core";
+import type * as serializers from "../../../index";
+import { TestWebhookResponseData } from "../../../types/TestWebhookResponseData";
+export declare const SendTestWebhookActionResponse: core.serialization.ObjectSchema<serializers.SendTestWebhookActionResponse.Raw, Schematic.SendTestWebhookActionResponse>;
+export declare namespace SendTestWebhookActionResponse {
+    interface Raw {
+        data: TestWebhookResponseData.Raw;
+        params: Record<string, unknown>;
+    }
+}

package/dist/serialization/resources/webhooks/types/index.d.ts

@@ -10,4 +10,5 @@ export * from "./ListWebhookEventsParams";
 export * from "./ListWebhookEventsResponse";
 export * from "./ListWebhooksParams";
 export * from "./ListWebhooksResponse";
+export * from "./SendTestWebhookActionResponse";
 export * from "./UpdateWebhookResponse";

package/dist/serialization/types/AccountMemberPermission.d.ts

@@ -3,5 +3,5 @@ import * as core from "../../core";
 import type * as serializers from "../index";
 export declare const AccountMemberPermission: core.serialization.Schema<serializers.AccountMemberPermission.Raw, Schematic.AccountMemberPermission>;
 export declare namespace AccountMemberPermission {
-    type Raw = "billing_credits_edit" | "companies_edit" | "company_users_edit" | "components_edit" | "data_exports_edit" | "features_edit" | "flag_rules_edit" | "flags_edit" | "overrides_edit" | "plan_billing_edit" | "plan_entitlements_edit" | "plan_versions_edit" | "plans_edit" | "webhooks_edit" | "webhooks_reveal_secret";
+    type Raw = "companies_edit" | "company_users_edit" | "components_edit" | "data_exports_edit" | "features_edit" | "flag_rules_edit" | "flags_edit" | "overrides_edit" | "plan_billing_edit" | "plan_entitlements_edit" | "plan_versions_edit" | "plans_edit" | "webhooks_edit" | "webhooks_reveal_secret";
 }

package/dist/serialization/types/BillingCreditGrantZeroedOutReason.d.ts

@@ -3,5 +3,5 @@ import * as core from "../../core";
 import type * as serializers from "../index";
 export declare const BillingCreditGrantZeroedOutReason: core.serialization.Schema<serializers.BillingCreditGrantZeroedOutReason.Raw, Schematic.BillingCreditGrantZeroedOutReason>;
 export declare namespace BillingCreditGrantZeroedOutReason {
-    type Raw = "expired" | "manual" | "plan_change" | "plan_period_reset";
+    type Raw = "expired" | "manual" | "plan_change" | "plan_period_reset" | "reconciled";
 }

package/dist/serialization/types/ChangeSubscriptionInternalRequestBody.d.ts

@@ -17,6 +17,7 @@ export declare namespace ChangeSubscriptionInternalRequestBody {
         custom_field_values: CheckoutFieldValue.Raw[];
         new_plan_id: string;
         new_price_id: string;
+        opt_in_accepted?: boolean | null;
         pay_in_advance: UpdatePayInAdvanceRequestBody.Raw[];
         payment_method_id?: string | null;
         promo_code?: string | null;

package/dist/serialization/types/ChangeSubscriptionRequestBody.d.ts

@@ -16,6 +16,7 @@ export declare namespace ChangeSubscriptionRequestBody {
         custom_field_values: CheckoutFieldValue.Raw[];
         new_plan_id: string;
         new_price_id: string;
+        opt_in_accepted?: boolean | null;
         pay_in_advance: UpdatePayInAdvanceRequestBody.Raw[];
         payment_method_id?: string | null;
         promo_code?: string | null;

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

@@ -2,10 +2,12 @@ import type * as Schematic from "../../api/index";
 import * as core from "../../core";
 import type * as serializers from "../index";
 import { CheckFlagResponseData } from "./CheckFlagResponseData";
+import { CompanyCreditBalance } from "./CompanyCreditBalance";
 import { DatastreamCompanyPlan } from "./DatastreamCompanyPlan";
 export declare const CheckFlagsResponseData: core.serialization.ObjectSchema<serializers.CheckFlagsResponseData.Raw, Schematic.CheckFlagsResponseData>;
 export declare namespace CheckFlagsResponseData {
     interface Raw {
+        credit_balances?: Record<string, CompanyCreditBalance.Raw> | null;
         flags: CheckFlagResponseData.Raw[];
         plan?: DatastreamCompanyPlan.Raw | null;
     }

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

@@ -7,5 +7,8 @@ export declare namespace CheckoutSettingsResponseData {
         collect_address: boolean;
         collect_email: boolean;
         collect_phone: boolean;
+        opt_in_enabled: boolean;
+        opt_in_text?: string | null;
+        opt_in_title?: string | null;
     }
 }

package/dist/serialization/types/CompanyCreditBalance.d.ts

@@ -0,0 +1,11 @@
+import type * as Schematic from "../../api/index";
+import * as core from "../../core";
+import type * as serializers from "../index";
+export declare const CompanyCreditBalance: core.serialization.ObjectSchema<serializers.CompanyCreditBalance.Raw, Schematic.CompanyCreditBalance>;
+export declare namespace CompanyCreditBalance {
+    interface Raw {
+        remaining: number;
+        reserved: number;
+        settled: number;
+    }
+}

package/dist/serialization/types/CompanySubscriptionResponseData.d.ts

@@ -16,6 +16,7 @@ export declare namespace CompanySubscriptionResponseData {
         discounts: BillingSubscriptionDiscountView.Raw[];
         expired_at?: string | null;
         interval: string;
+        is_initial: boolean;
         latest_invoice?: InvoiceResponseData.Raw | null;
         payment_method?: PaymentMethodResponseData.Raw | null;
         products: BillingProductForSubscriptionResponseData.Raw[];

package/dist/serialization/types/FeatureEntitlement.d.ts

@@ -8,11 +8,15 @@ export declare const FeatureEntitlement: core.serialization.ObjectSchema<seriali
 export declare namespace FeatureEntitlement {
     interface Raw {
         allocation?: number | null;
+        consumption_rate?: number | null;
         credit_id?: string | null;
         credit_remaining?: number | null;
+        credit_reserved?: number | null;
+        credit_settled?: number | null;
         credit_total?: number | null;
         credit_used?: number | null;
         event_name?: string | null;
+        event_subtype?: string | null;
         feature_id: string;
         feature_key: string;
         metric_period?: MetricPeriod.Raw | null;

package/dist/serialization/types/PlanChangeResponseData.d.ts

@@ -28,6 +28,7 @@ export declare namespace PlanChangeResponseData {
         created_at: string;
         environment_id: string;
         id: string;
+        is_version_upgrade: boolean;
         previous_base_plan?: PlanSnapshotView.Raw | null;
         previous_base_plan_version?: PlanVersionSnapshotView.Raw | null;
         request_id?: string | null;

package/dist/serialization/types/PreviewSubscriptionChangeResponseData.d.ts

@@ -11,6 +11,9 @@ export declare namespace PreviewSubscriptionChangeResponseData {
         finance?: PreviewSubscriptionFinanceResponseData.Raw | null;
         is_scheduled_downgrade: boolean;
         new_charges: number;
+        opt_in_required: boolean;
+        opt_in_text?: string | null;
+        opt_in_title?: string | null;
         payment_method_required: boolean;
         percent_off: number;
         period_start: string;

package/dist/serialization/types/RulesengineFeatureEntitlement.d.ts

@@ -8,11 +8,15 @@ export declare const RulesengineFeatureEntitlement: core.serialization.ObjectSch
 export declare namespace RulesengineFeatureEntitlement {
     interface Raw {
         allocation?: number | null;
+        consumption_rate?: number | null;
         credit_id?: string | null;
         credit_remaining?: number | null;
+        credit_reserved?: number | null;
+        credit_settled?: number | null;
         credit_total?: number | null;
         credit_used?: number | null;
         event_name?: string | null;
+        event_subtype?: string | null;
         feature_id: string;
         feature_key: string;
         metric_period?: RulesengineMetricPeriod.Raw | null;

package/dist/serialization/types/TestWebhookResponseData.d.ts

@@ -0,0 +1,10 @@
+import type * as Schematic from "../../api/index";
+import * as core from "../../core";
+import type * as serializers from "../index";
+export declare const TestWebhookResponseData: core.serialization.ObjectSchema<serializers.TestWebhookResponseData.Raw, Schematic.TestWebhookResponseData>;
+export declare namespace TestWebhookResponseData {
+    interface Raw {
+        response_code: number;
+        success: boolean;
+    }
+}

package/dist/serialization/types/index.d.ts

@@ -73,6 +73,7 @@ export * from "./CheckoutFieldWithValue";
 export * from "./CheckoutSettingsResponseData";
 export * from "./CheckoutSubscription";
 export * from "./ClerkIntegrationConfig";
+export * from "./CompanyCreditBalance";
 export * from "./CompanyCreditBalanceResponseData";
 export * from "./CompanyDetailResponseData";
 export * from "./CompanyEventPeriodMetricsResponseData";
@@ -137,8 +138,6 @@ export * from "./CreditGrantDetail";
 export * from "./CreditGrantExpiryRequestBody";
 export * from "./CreditGrantSortOrder";
 export * from "./CreditLeaseResponseData";
-export * from "./CreditLedgerEnrichedEntryResponseData";
-export * from "./CreditLedgerPeriod";
 export * from "./CreditsAutoTopupCompanySummary";
 export * from "./CreditsAutoTopupCreditSummary";
 export * from "./CreditsAutoTopupHardFailure";
@@ -341,6 +340,7 @@ export * from "./SubscriptionTraitUpdate";
 export * from "./SubscriptionType";
 export * from "./TemporaryAccessTokenResourceType";
 export * from "./TemporaryAccessTokenResponseData";
+export * from "./TestWebhookResponseData";
 export * from "./TimeSeriesGranularity";
 export * from "./TopFeatureByUsageResponseData";
 export * from "./TopFeaturesByUsageResponseData";