@schematichq/schematic-typescript-node 1.5.0 → 1.5.1

package/dist/Client.d.ts

@@ -69,6 +69,14 @@ export declare class SchematicClient {
     get scheduledcheckout(): ScheduledcheckoutClient;
     get accesstokens(): AccesstokensClient;
     get webhooks(): WebhooksClient;
+    /**
+     * @param {SchematicClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.getCreditLedger()
+     */
+    getCreditLedger(requestOptions?: SchematicClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __getCreditLedger;
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.
      * This is useful for making requests to endpoints not yet supported in the SDK.

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

@@ -419,54 +419,6 @@ export declare class CreditsClient {
      */
     releaseCreditLease(lease_id: string, request: Schematic.ReleaseCreditLeaseRequestBody, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.ReleaseCreditLeaseResponse>;
     private __releaseCreditLease;
-    /**
-     * @param {Schematic.GetEnrichedCreditLedgerRequest} request
-     * @param {CreditsClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Schematic.BadRequestError}
-     * @throws {@link Schematic.UnauthorizedError}
-     * @throws {@link Schematic.ForbiddenError}
-     * @throws {@link Schematic.NotFoundError}
-     * @throws {@link Schematic.InternalServerError}
-     *
-     * @example
-     *     await client.credits.getEnrichedCreditLedger({
-     *         companyId: "company_id",
-     *         billingCreditId: "billing_credit_id",
-     *         featureId: "feature_id",
-     *         period: "daily",
-     *         startTime: "start_time",
-     *         endTime: "end_time",
-     *         limit: 1000000,
-     *         offset: 1000000
-     *     })
-     */
-    getEnrichedCreditLedger(request: Schematic.GetEnrichedCreditLedgerRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetEnrichedCreditLedgerResponse>;
-    private __getEnrichedCreditLedger;
-    /**
-     * @param {Schematic.CountCreditLedgerRequest} request
-     * @param {CreditsClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Schematic.BadRequestError}
-     * @throws {@link Schematic.UnauthorizedError}
-     * @throws {@link Schematic.ForbiddenError}
-     * @throws {@link Schematic.NotFoundError}
-     * @throws {@link Schematic.InternalServerError}
-     *
-     * @example
-     *     await client.credits.countCreditLedger({
-     *         companyId: "company_id",
-     *         billingCreditId: "billing_credit_id",
-     *         featureId: "feature_id",
-     *         period: "daily",
-     *         startTime: "start_time",
-     *         endTime: "end_time",
-     *         limit: 1000000,
-     *         offset: 1000000
-     *     })
-     */
-    countCreditLedger(request: Schematic.CountCreditLedgerRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCreditLedgerResponse>;
-    private __countCreditLedger;
     /**
      * @param {Schematic.ListBillingPlanCreditGrantsRequest} request
      * @param {CreditsClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -5,13 +5,11 @@ export type { CountBillingPlanCreditGrantsRequest } from "./CountBillingPlanCred
 export type { CountCompanyGrantsRequest } from "./CountCompanyGrantsRequest";
 export type { CountCreditBundlesRequest } from "./CountCreditBundlesRequest";
 export type { CountCreditEventLedgerRequest } from "./CountCreditEventLedgerRequest";
-export type { CountCreditLedgerRequest } from "./CountCreditLedgerRequest";
 export type { CreateBillingCreditRequestBody } from "./CreateBillingCreditRequestBody";
 export type { CreateCompanyCreditGrant } from "./CreateCompanyCreditGrant";
 export type { CreateCreditBundleRequestBody } from "./CreateCreditBundleRequestBody";
 export type { DeleteBillingPlanCreditGrantRequest } from "./DeleteBillingPlanCreditGrantRequest";
 export type { ExtendCreditLeaseRequestBody } from "./ExtendCreditLeaseRequestBody";
-export type { GetEnrichedCreditLedgerRequest } from "./GetEnrichedCreditLedgerRequest";
 export type { ListBillingCreditsRequest } from "./ListBillingCreditsRequest";
 export type { ListBillingPlanCreditGrantsRequest } from "./ListBillingPlanCreditGrantsRequest";
 export type { ListCompanyCreditBalancesRequest } from "./ListCompanyCreditBalancesRequest";

package/dist/api/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/api/resources/plangroups/client/Client.d.ts

@@ -43,6 +43,7 @@ export declare class PlangroupsClient {
      *         checkoutCollectEmail: true,
      *         checkoutCollectPhone: true,
      *         enableTaxCollection: true,
+     *         optInEnabled: true,
      *         orderedAddOns: [{
      *                 planId: "plan_id"
      *             }],
@@ -84,6 +85,7 @@ export declare class PlangroupsClient {
      *         checkoutCollectEmail: true,
      *         checkoutCollectPhone: true,
      *         enableTaxCollection: true,
+     *         optInEnabled: true,
      *         orderedAddOns: [{
      *                 planId: "plan_id"
      *             }],

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

@@ -7,6 +7,7 @@ import type * as Schematic from "../../../../index";
  *         checkoutCollectEmail: true,
  *         checkoutCollectPhone: true,
  *         enableTaxCollection: true,
+ *         optInEnabled: true,
  *         orderedAddOns: [{
  *                 planId: "plan_id"
  *             }],
@@ -42,6 +43,9 @@ export interface CreatePlanGroupRequestBody {
     fallbackPlanId?: string;
     initialPlanId?: string;
     initialPlanPriceId?: string;
+    optInEnabled: boolean;
+    optInText?: string;
+    optInTitle?: string;
     orderedAddOns: Schematic.OrderedPlansInGroup[];
     orderedBundleList: Schematic.PlanGroupBundleOrder[];
     orderedPlans: Schematic.OrderedPlansInGroup[];

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

@@ -7,6 +7,7 @@ import type * as Schematic from "../../../../index";
  *         checkoutCollectEmail: true,
  *         checkoutCollectPhone: true,
  *         enableTaxCollection: true,
+ *         optInEnabled: true,
  *         orderedAddOns: [{
  *                 planId: "plan_id"
  *             }],
@@ -42,6 +43,9 @@ export interface UpdatePlanGroupRequestBody {
     fallbackPlanId?: string;
     initialPlanId?: string;
     initialPlanPriceId?: string;
+    optInEnabled: boolean;
+    optInText?: string;
+    optInTitle?: string;
     orderedAddOns: Schematic.OrderedPlansInGroup[];
     orderedBundleList: Schematic.PlanGroupBundleOrder[];
     orderedPlans: Schematic.OrderedPlansInGroup[];

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

@@ -81,11 +81,7 @@ export declare class PlansClient {
      *
      * @example
      *     await client.plans.retryCustomPlanBilling("custom_plan_billing_id", {
-     *         customerEmail: "customer_email",
-     *         payInAdvance: [{
-     *                 priceId: "price_id",
-     *                 quantity: 1000000
-     *             }]
+     *         customerEmail: "customer_email"
      *     })
      */
     retryCustomPlanBilling(custom_plan_billing_id: string, request: Schematic.RetryCustomPlanBillingRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.RetryCustomPlanBillingResponse>;

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

@@ -2,16 +2,11 @@ import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {
- *         customerEmail: "customer_email",
- *         payInAdvance: [{
- *                 priceId: "price_id",
- *                 quantity: 1000000
- *             }]
+ *         customerEmail: "customer_email"
  *     }
  */
 export interface RetryCustomPlanBillingRequestBody {
     activationStrategy?: Schematic.CustomPlanActivationStrategy;
     customerEmail: string;
     daysUntilDue?: number;
-    payInAdvance: Schematic.UpdatePayInAdvanceRequestBody[];
 }

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

@@ -3,5 +3,6 @@ export declare const BillingCreditGrantZeroedOutReason: {
     readonly Manual: "manual";
     readonly PlanChange: "plan_change";
     readonly PlanPeriodReset: "plan_period_reset";
+    readonly Reconciled: "reconciled";
 };
 export type BillingCreditGrantZeroedOutReason = (typeof BillingCreditGrantZeroedOutReason)[keyof typeof BillingCreditGrantZeroedOutReason];

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

@@ -8,6 +8,7 @@ export interface ChangeSubscriptionInternalRequestBody {
     customFieldValues: Schematic.CheckoutFieldValue[];
     newPlanId: string;
     newPriceId: string;
+    optInAccepted?: boolean;
     payInAdvance: Schematic.UpdatePayInAdvanceRequestBody[];
     paymentMethodId?: string;
     promoCode?: string;

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

@@ -7,6 +7,7 @@ export interface ChangeSubscriptionRequestBody {
     customFieldValues: Schematic.CheckoutFieldValue[];
     newPlanId: string;
     newPriceId: string;
+    optInAccepted?: boolean;
     payInAdvance: Schematic.UpdatePayInAdvanceRequestBody[];
     paymentMethodId?: string;
     promoCode?: string;

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

@@ -2,4 +2,7 @@ export interface CheckoutSettingsResponseData {
     collectAddress: boolean;
     collectEmail: boolean;
     collectPhone: boolean;
+    optInEnabled: boolean;
+    optInText?: string;
+    optInTitle?: string;
 }

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

@@ -4,8 +4,12 @@ export interface FeatureEntitlement {
     allocation?: number;
     /** If the company has a credit-based entitlement for this feature, the ID of the credit */
     creditId?: string;
-    /** If the company has a credit-based entitlement for this feature, the remaining credit amount */
+    /** If the company has a credit-based entitlement for this feature, the credit available to fund new consumption or a new lease hold — open lease holds are excluded. Clients that hold a lease should gate on this plus their own unspent hold; clients with no lease awareness should use credit_settled instead */
     creditRemaining?: number;
+    /** If the company has a credit-based entitlement for this feature, the unspent amount held by an open credit lease. Returns to credit_remaining when the lease is released */
+    creditReserved?: number;
+    /** If the company has a credit-based entitlement for this feature, the balance net of actual consumption, unaffected by open lease holds (credit_remaining plus credit_reserved). The number to display to end users */
+    creditSettled?: number;
     /** If the company has a credit-based entitlement for this feature, the total credit amount */
     creditTotal?: number;
     /** If the company has a credit-based entitlement for this feature, the amount of credit used */

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

@@ -16,6 +16,8 @@ export interface PlanChangeResponseData {
     createdAt: Date;
     environmentId: string;
     id: string;
+    /** True when this change moved the company to a different version of the same plan (e.g. a plan version migration) rather than to a different plan. */
+    isVersionUpgrade: boolean;
     previousBasePlan?: Schematic.PlanSnapshotView;
     /** The plan version of the previous base plan before this change. */
     previousBasePlanVersion?: Schematic.PlanVersionSnapshotView;

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

@@ -5,6 +5,9 @@ export interface PreviewSubscriptionChangeResponseData {
     finance?: Schematic.PreviewSubscriptionFinanceResponseData;
     isScheduledDowngrade: boolean;
     newCharges: number;
+    optInRequired: boolean;
+    optInText?: string;
+    optInTitle?: string;
     paymentMethodRequired: boolean;
     percentOff: number;
     periodStart: Date;

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

@@ -4,8 +4,12 @@ export interface RulesengineFeatureEntitlement {
     allocation?: number;
     /** If the company has a credit-based entitlement for this feature, the ID of the credit */
     creditId?: string;
-    /** If the company has a credit-based entitlement for this feature, the remaining credit amount */
+    /** If the company has a credit-based entitlement for this feature, the credit available to fund new consumption or a new lease hold — open lease holds are excluded. Clients that hold a lease should gate on this plus their own unspent hold; clients with no lease awareness should use credit_settled instead */
     creditRemaining?: number;
+    /** If the company has a credit-based entitlement for this feature, the unspent amount held by an open credit lease. Returns to credit_remaining when the lease is released */
+    creditReserved?: number;
+    /** If the company has a credit-based entitlement for this feature, the balance net of actual consumption, unaffected by open lease holds (credit_remaining plus credit_reserved). The number to display to end users */
+    creditSettled?: number;
     /** If the company has a credit-based entitlement for this feature, the total credit amount */
     creditTotal?: number;
     /** If the company has a credit-based entitlement for this feature, the amount of credit used */

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

@@ -137,8 +137,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";