@schematichq/schematic-typescript-node 1.5.10 → 1.5.13

package/dist/api/resources/events/types/UpsertOtlpEnvironmentSettingsResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface UpsertOtlpEnvironmentSettingsResponse {
+    data: Schematic.OtlpEnvironmentSettingsResponseData;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

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

@@ -1,8 +1,11 @@
 export * from "./CreateEventBatchResponse";
 export * from "./CreateEventResponse";
+export * from "./DeleteOtlpEnvironmentSettingsResponse";
 export * from "./GetEventResponse";
 export * from "./GetEventSummariesParams";
 export * from "./GetEventSummariesResponse";
+export * from "./GetOtlpEnvironmentSettingsResponse";
 export * from "./GetSegmentIntegrationStatusResponse";
 export * from "./ListEventsParams";
 export * from "./ListEventsResponse";
+export * from "./UpsertOtlpEnvironmentSettingsResponse";

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

@@ -120,6 +120,55 @@ export declare class IntegrationsapiClient {
      */
     loadSampleDataSet(requestOptions?: IntegrationsapiClient.RequestOptions): core.HttpResponsePromise<Schematic.LoadSampleDataSetResponse>;
     private __loadSampleDataSet;
+    /**
+     * @param {IntegrationsapiClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.integrationsapi.getStripeSandboxClaimLink()
+     */
+    getStripeSandboxClaimLink(requestOptions?: IntegrationsapiClient.RequestOptions): core.HttpResponsePromise<Schematic.GetStripeSandboxClaimLinkResponse>;
+    private __getStripeSandboxClaimLink;
+    /**
+     * @param {IntegrationsapiClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.integrationsapi.getStripeSandboxKeys()
+     */
+    getStripeSandboxKeys(requestOptions?: IntegrationsapiClient.RequestOptions): core.HttpResponsePromise<Schematic.GetStripeSandboxKeysResponse>;
+    private __getStripeSandboxKeys;
+    /**
+     * @param {Schematic.ClaimStripeSandboxKeysRequestBody} request
+     * @param {IntegrationsapiClient.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}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.integrationsapi.claimStripeSandboxKeys({
+     *         token: "token"
+     *     })
+     */
+    claimStripeSandboxKeys(request: Schematic.ClaimStripeSandboxKeysRequestBody, requestOptions?: IntegrationsapiClient.RequestOptions): core.HttpResponsePromise<Schematic.ClaimStripeSandboxKeysResponse>;
+    private __claimStripeSandboxKeys;
     /**
      * @param {Schematic.InstallIntegrationRequestBody} request
      * @param {IntegrationsapiClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -158,6 +207,40 @@ export declare class IntegrationsapiClient {
      */
     installStripe(request: Schematic.InstallIntegrationRequestBody, requestOptions?: IntegrationsapiClient.RequestOptions): core.HttpResponsePromise<Schematic.InstallStripeResponse>;
     private __installStripe;
+    /**
+     * @param {Schematic.InstallStripeSandboxRequestBody} request
+     * @param {IntegrationsapiClient.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}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.integrationsapi.installStripeClaimableSandbox({
+     *         email: "email"
+     *     })
+     */
+    installStripeClaimableSandbox(request: Schematic.InstallStripeSandboxRequestBody, requestOptions?: IntegrationsapiClient.RequestOptions): core.HttpResponsePromise<Schematic.InstallStripeClaimableSandboxResponse>;
+    private __installStripeClaimableSandbox;
+    /**
+     * @param {IntegrationsapiClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.integrationsapi.listStripeSandboxCountries()
+     */
+    listStripeSandboxCountries(requestOptions?: IntegrationsapiClient.RequestOptions): core.HttpResponsePromise<Schematic.ListStripeSandboxCountriesResponse>;
+    private __listStripeSandboxCountries;
     /**
      * @param {string} integration_id - integration_id
      * @param {IntegrationsapiClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/api/resources/integrationsapi/client/requests/ClaimStripeSandboxKeysRequestBody.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @example
+ *     {
+ *         token: "token"
+ *     }
+ */
+export interface ClaimStripeSandboxKeysRequestBody {
+    token: string;
+}

package/dist/api/resources/integrationsapi/client/requests/InstallStripeSandboxRequestBody.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @example
+ *     {
+ *         email: "email"
+ *     }
+ */
+export interface InstallStripeSandboxRequestBody {
+    country?: string;
+    email: string;
+    name?: string;
+    seedSampleData?: boolean;
+}

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

@@ -1,2 +1,4 @@
+export type { ClaimStripeSandboxKeysRequestBody } from "./ClaimStripeSandboxKeysRequestBody";
+export type { InstallStripeSandboxRequestBody } from "./InstallStripeSandboxRequestBody";
 export type { ListIntegrationsRequest } from "./ListIntegrationsRequest";
 export type { StartDataImportRequestBody } from "./StartDataImportRequestBody";

package/dist/api/resources/integrationsapi/types/ClaimStripeSandboxKeysResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface ClaimStripeSandboxKeysResponse {
+    data: Schematic.ClaimedStripeSandboxKeysResponseData;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/integrationsapi/types/GetStripeSandboxClaimLinkResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface GetStripeSandboxClaimLinkResponse {
+    data: Schematic.StripeSandboxClaimLink;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/integrationsapi/types/GetStripeSandboxKeysResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface GetStripeSandboxKeysResponse {
+    data: Schematic.ClaimedStripeSandboxKeysResponseData;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/integrationsapi/types/InstallStripeClaimableSandboxResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface InstallStripeClaimableSandboxResponse {
+    data: Schematic.StripeSandboxInstallResponseData;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/integrationsapi/types/ListStripeSandboxCountriesResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface ListStripeSandboxCountriesResponse {
+    data: Schematic.StripeSandboxCountriesResponseData;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

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

@@ -1,9 +1,14 @@
 export * from "./AssumeStripeInstalledResponse";
+export * from "./ClaimStripeSandboxKeysResponse";
 export * from "./GetIntegrationWebhookUrlResponse";
+export * from "./GetStripeSandboxClaimLinkResponse";
+export * from "./GetStripeSandboxKeysResponse";
 export * from "./InstallIntegrationResponse";
+export * from "./InstallStripeClaimableSandboxResponse";
 export * from "./InstallStripeResponse";
 export * from "./ListIntegrationsParams";
 export * from "./ListIntegrationsResponse";
+export * from "./ListStripeSandboxCountriesResponse";
 export * from "./LoadSampleDataSetResponse";
 export * from "./RunIntegrationResponse";
 export * from "./StartDataImportResponse";

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

@@ -67,6 +67,7 @@ export interface CreatePlanGroupRequestBody {
     showZeroPriceAsFree: boolean;
     syncCustomerBillingDetails: boolean;
     trialDays?: number;
+    trialEligibilityPerPlan?: boolean;
     trialExpiryPlanId?: string;
     trialExpiryPlanPriceId?: string;
     trialPaymentMethodRequired?: boolean;

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

@@ -67,6 +67,7 @@ export interface UpdatePlanGroupRequestBody {
     showZeroPriceAsFree: boolean;
     syncCustomerBillingDetails: boolean;
     trialDays?: number;
+    trialEligibilityPerPlan?: boolean;
     trialExpiryPlanId?: string;
     trialExpiryPlanPriceId?: string;
     trialPaymentMethodRequired?: boolean;

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

@@ -26,7 +26,7 @@ export declare class PlanmigrationsClient {
      *     await client.planmigrations.listCompanyMigrations({
      *         migrationId: "migration_id",
      *         q: "q",
-     *         status: "completed",
+     *         status: "cancelled",
      *         limit: 1000000,
      *         offset: 1000000
      *     })
@@ -66,7 +66,7 @@ export declare class PlanmigrationsClient {
      *     await client.planmigrations.countCompanyMigrations({
      *         migrationId: "migration_id",
      *         q: "q",
-     *         status: "completed",
+     *         status: "cancelled",
      *         limit: 1000000,
      *         offset: 1000000
      *     })
@@ -88,7 +88,7 @@ export declare class PlanmigrationsClient {
      * @example
      *     await client.planmigrations.listMigrations({
      *         planVersionId: "plan_version_id",
-     *         status: "completed",
+     *         status: "cancelled",
      *         limit: 1000000,
      *         offset: 1000000
      *     })
@@ -111,7 +111,7 @@ export declare class PlanmigrationsClient {
      *     await client.planmigrations.createMigration({
      *         planId: "plan_id",
      *         planVersionIdTo: "plan_version_id_to",
-     *         strategy: "immediate",
+     *         strategy: "end_of_billing_period",
      *         targetPlanType: "plan"
      *     })
      */
@@ -133,6 +133,41 @@ export declare class PlanmigrationsClient {
      */
     getMigration(plan_version_migration_id: string, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetMigrationResponse>;
     private __getMigration;
+    /**
+     * @param {string} plan_version_migration_id - plan_version_migration_id
+     * @param {PlanmigrationsClient.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}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.planmigrations.cancelMigration("plan_version_migration_id")
+     */
+    cancelMigration(plan_version_migration_id: string, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.CancelMigrationResponse>;
+    private __cancelMigration;
+    /**
+     * @param {string} plan_version_migration_id - plan_version_migration_id
+     * @param {Schematic.CompleteMigrationNowRequestBody} request
+     * @param {PlanmigrationsClient.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}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.planmigrations.completeMigrationNow("plan_version_migration_id")
+     */
+    completeMigrationNow(plan_version_migration_id: string, request?: Schematic.CompleteMigrationNowRequestBody, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.CompleteMigrationNowResponse>;
+    private __completeMigrationNow;
     /**
      * @param {string} plan_version_migration_id - plan_version_migration_id
      * @param {Schematic.RetryMigrationRequestBody} request
@@ -168,7 +203,7 @@ export declare class PlanmigrationsClient {
      * @example
      *     await client.planmigrations.countMigrations({
      *         planVersionId: "plan_version_id",
-     *         status: "completed",
+     *         status: "cancelled",
      *         limit: 1000000,
      *         offset: 1000000
      *     })

package/dist/api/resources/planmigrations/client/requests/CompleteMigrationNowRequestBody.d.ts

@@ -0,0 +1,8 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {}
+ */
+export interface CompleteMigrationNowRequestBody {
+    prorationBehavior?: Schematic.MigrationProrationBehavior;
+}

package/dist/api/resources/planmigrations/client/requests/CountCompanyMigrationsRequest.d.ts

@@ -4,7 +4,7 @@ import type * as Schematic from "../../../../index";
  *     {
  *         migrationId: "migration_id",
  *         q: "q",
- *         status: "completed",
+ *         status: "cancelled",
  *         limit: 1000000,
  *         offset: 1000000
  *     }

package/dist/api/resources/planmigrations/client/requests/CountMigrationsRequest.d.ts

@@ -3,7 +3,7 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         planVersionId: "plan_version_id",
- *         status: "completed",
+ *         status: "cancelled",
  *         limit: 1000000,
  *         offset: 1000000
  *     }

package/dist/api/resources/planmigrations/client/requests/CreateMigrationInput.d.ts

@@ -4,7 +4,7 @@ import type * as Schematic from "../../../../index";
  *     {
  *         planId: "plan_id",
  *         planVersionIdTo: "plan_version_id_to",
- *         strategy: "immediate",
+ *         strategy: "end_of_billing_period",
  *         targetPlanType: "plan"
  *     }
  */

package/dist/api/resources/planmigrations/client/requests/ListCompanyMigrationsRequest.d.ts

@@ -4,7 +4,7 @@ import type * as Schematic from "../../../../index";
  *     {
  *         migrationId: "migration_id",
  *         q: "q",
- *         status: "completed",
+ *         status: "cancelled",
  *         limit: 1000000,
  *         offset: 1000000
  *     }

package/dist/api/resources/planmigrations/client/requests/ListMigrationsRequest.d.ts

@@ -3,7 +3,7 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         planVersionId: "plan_version_id",
- *         status: "completed",
+ *         status: "cancelled",
  *         limit: 1000000,
  *         offset: 1000000
  *     }

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

@@ -1,3 +1,4 @@
+export type { CompleteMigrationNowRequestBody } from "./CompleteMigrationNowRequestBody";
 export type { CountCompanyMigrationsRequest } from "./CountCompanyMigrationsRequest";
 export type { CountMigrationsRequest } from "./CountMigrationsRequest";
 export type { CreateMigrationInput } from "./CreateMigrationInput";

package/dist/api/resources/planmigrations/types/CancelMigrationResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface CancelMigrationResponse {
+    data: Schematic.PlanVersionMigrationResponseData;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/planmigrations/types/CompleteMigrationNowResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface CompleteMigrationNowResponse {
+    data: Schematic.PlanVersionMigrationResponseData;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

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

@@ -1,3 +1,5 @@
+export * from "./CancelMigrationResponse";
+export * from "./CompleteMigrationNowResponse";
 export * from "./CountCompanyMigrationsParams";
 export * from "./CountCompanyMigrationsResponse";
 export * from "./CountMigrationsParams";

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

@@ -132,6 +132,7 @@ export declare class PlansClient {
      *         companyId: "company_id",
      *         companyScopedOnly: true,
      *         excludeCompanyScoped: true,
+     *         excludeUnused: true,
      *         forFallbackPlan: true,
      *         forInitialPlan: true,
      *         forTrialExpiryPlan: true,
@@ -330,6 +331,7 @@ export declare class PlansClient {
      *         companyId: "company_id",
      *         companyScopedOnly: true,
      *         excludeCompanyScoped: true,
+     *         excludeUnused: true,
      *         forFallbackPlan: true,
      *         forInitialPlan: true,
      *         forTrialExpiryPlan: true,
@@ -404,7 +406,7 @@ export declare class PlansClient {
      * @example
      *     await client.plans.publishPlanVersion("plan_version_id", {
      *         excludedCompanyIds: ["excluded_company_ids"],
-     *         migrationStrategy: "immediate"
+     *         migrationStrategy: "end_of_billing_period"
      *     })
      */
     publishPlanVersion(plan_version_id: string, request: Schematic.PublishPlanVersionRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.PublishPlanVersionResponse>;

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

@@ -5,6 +5,7 @@ import type * as Schematic from "../../../../index";
  *         companyId: "company_id",
  *         companyScopedOnly: true,
  *         excludeCompanyScoped: true,
+ *         excludeUnused: true,
  *         forFallbackPlan: true,
  *         forInitialPlan: true,
  *         forTrialExpiryPlan: true,
@@ -27,6 +28,8 @@ export interface CountPlansRequest {
     companyScopedOnly?: boolean;
     /** Exclude plans that are scoped to a company (custom plans assigned to a company) */
     excludeCompanyScoped?: boolean;
+    /** Exclude plans that nothing is using: no company is on the plan and it has no draft version */
+    excludeUnused?: boolean;
     /** 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) */

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

@@ -5,6 +5,7 @@ import type * as Schematic from "../../../../index";
  *         companyId: "company_id",
  *         companyScopedOnly: true,
  *         excludeCompanyScoped: true,
+ *         excludeUnused: true,
  *         forFallbackPlan: true,
  *         forInitialPlan: true,
  *         forTrialExpiryPlan: true,
@@ -27,6 +28,8 @@ export interface ListPlansRequest {
     companyScopedOnly?: boolean;
     /** Exclude plans that are scoped to a company (custom plans assigned to a company) */
     excludeCompanyScoped?: boolean;
+    /** Exclude plans that nothing is using: no company is on the plan and it has no draft version */
+    excludeUnused?: boolean;
     /** 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) */

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

@@ -3,12 +3,14 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         excludedCompanyIds: ["excluded_company_ids"],
- *         migrationStrategy: "immediate"
+ *         migrationStrategy: "end_of_billing_period"
  *     }
  */
 export interface PublishPlanVersionRequestBody {
     activationStrategy?: Schematic.CustomPlanActivationStrategy;
     address?: Schematic.CustomerBillingAddress;
+    /** The date the subscription's billing period renews on. Only honored on a first publish that starts a subscription. */
+    billingCycleAnchor?: Date;
     couponExternalId?: string;
     customFieldValues?: Schematic.CheckoutFieldValue[];
     customerEmail?: string;
@@ -16,6 +18,8 @@ export interface PublishPlanVersionRequestBody {
     excludedCompanyIds: string[];
     migrationStrategy: Schematic.PlanVersionMigrationStrategy;
     phone?: string;
+    /** When true, the partial period between the subscription starting and its renewal date is billed pro rata straight away. When false that period is free and no invoice is raised until the renewal date. Only applies alongside billing_cycle_anchor. Defaults to true. */
+    prorateFirstPeriod?: boolean;
     prorationBehavior?: Schematic.MigrationProrationBehavior;
     /** Refuse the publish if any company would be migrated onto the new version */
     requireNoMigration?: boolean;

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

@@ -7,8 +7,12 @@ import type * as Schematic from "../../../../index";
  */
 export interface RetryCustomPlanBillingRequestBody {
     activationStrategy?: Schematic.CustomPlanActivationStrategy;
+    /** The date the subscription's billing period renews on. Only honored when the retry creates a subscription. */
+    billingCycleAnchor?: Date;
     customerEmail: string;
     daysUntilDue?: number;
+    /** When true, the partial period between the subscription starting and its renewal date is billed pro rata straight away. When false that period is free and no invoice is raised until the renewal date. Only applies alongside billing_cycle_anchor. Defaults to true. */
+    prorateFirstPeriod?: boolean;
     /** Whether Stripe emails the invoice when it is finalized. Defaults to true. */
     sendInvoice?: boolean;
 }

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

@@ -8,6 +8,8 @@ export interface CountPlansParams {
     companyScopedOnly?: boolean;
     /** Exclude plans that are scoped to a company (custom plans assigned to a company) */
     excludeCompanyScoped?: boolean;
+    /** Exclude plans that nothing is using: no company is on the plan and it has no draft version */
+    excludeUnused?: boolean;
     /** 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) */

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

@@ -8,6 +8,8 @@ export interface ListPlansParams {
     companyScopedOnly?: boolean;
     /** Exclude plans that are scoped to a company (custom plans assigned to a company) */
     excludeCompanyScoped?: boolean;
+    /** Exclude plans that nothing is using: no company is on the plan and it has no draft version */
+    excludeUnused?: boolean;
     /** 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) */

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

@@ -0,0 +1,5 @@
+export declare const BillingArrearsAnchor: {
+    readonly BillingPeriodStart: "billing_period_start";
+    readonly MonthEnd: "month_end";
+};
+export type BillingArrearsAnchor = (typeof BillingArrearsAnchor)[keyof typeof BillingArrearsAnchor];

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

@@ -0,0 +1,5 @@
+export declare const BillingArrearsCadence: {
+    readonly EndOfBillingPeriod: "end_of_billing_period";
+    readonly Monthly: "monthly";
+};
+export type BillingArrearsCadence = (typeof BillingArrearsCadence)[keyof typeof BillingArrearsCadence];

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

@@ -5,6 +5,8 @@ export interface BillingCreditGrantResponseData {
     companyLicenseId?: string;
     companyName: string;
     createdAt: Date;
+    /** The catalog bundle this grant was issued from, when the company bought one. */
+    creditBundleId?: string;
     creditIcon?: string;
     creditId: string;
     creditName: string;
@@ -16,6 +18,11 @@ export interface BillingCreditGrantResponseData {
     licenseName?: string;
     planId?: string;
     planName?: string;
+    /** What the postpaid charges costs, in the currency's minor unit. */
+    postpaidChargeAmount?: number;
+    postpaidChargeCurrency?: string;
+    /** Credits consumed past a zero balance in the window still open. */
+    postpaidChargedCredits?: number;
     price?: Schematic.BillingPriceResponseData;
     quantity: number;
     quantityRemaining: number;

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

@@ -1,5 +1,9 @@
 import type * as Schematic from "../index";
 export interface BillingPlanCreditGrantResponseData {
+    /** Which boundary closes a monthly arrears window. Only meaningful when arrears_cadence is monthly. */
+    arrearsAnchor?: Schematic.BillingArrearsAnchor;
+    /** How often postpaid charges are closed and invoiced. Defaults to end_of_billing_period. */
+    arrearsCadence?: Schematic.BillingArrearsCadence;
     autoTopupAmount?: number;
     autoTopupAmountType?: string;
     autoTopupAvailability: Schematic.BillingCreditAutoTopupAvailability;
@@ -32,11 +36,19 @@ export interface BillingPlanCreditGrantResponseData {
     id: string;
     /** The license whose quantity scales this grant. Set only when scaling is per_license. */
     licenseId?: string;
+    /** Optional limit on how far the balance may go below zero, in credits. A floor on the balance, not an allowance per invoice window: consumption is denied once the balance would fall below minus this figure, and stays denied until a new grant lands or the negative balance is settled. Absent means no limit. */
+    overdraftLimit?: number;
     plan?: Schematic.PreviewObjectResponseData;
     planId: string;
     /** Use plan.name from the nested plan object instead */
     planName: string;
     planVersionId?: string;
+    /** Whether consumption may continue past a zero balance, accruing at postpaid_rate_per_unit rather than being denied. */
+    postpaidEnabled: boolean;
+    /** Amount charged per credit consumed past zero, in the currency's minor unit. Defaults to the credit's own cost basis when postpaid is enabled without one. */
+    postpaidRatePerUnit?: number;
+    /** Decimal form of postpaid_rate_per_unit, for rates finer than one minor unit. */
+    postpaidRatePerUnitDecimal?: string;
     resetCadence?: Schematic.BillingPlanCreditGrantResetCadence;
     resetStart?: Schematic.BillingPlanCreditGrantResetStart;
     resetType?: Schematic.BillingPlanCreditGrantResetType;

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

@@ -5,10 +5,12 @@ export interface CheckoutDataResponseData {
     activeUsageBasedEntitlements: Schematic.UsageBasedEntitlementResponseData[];
     availableCreditBundles: Schematic.BillingCreditBundleResponseData[];
     company?: Schematic.CompanyDetailResponseData;
+    companyCanTrialSelectedPlan: boolean;
     customCheckoutFields: Schematic.CheckoutFieldWithValue[];
     featureUsage?: Schematic.FeatureUsageDetailResponseData;
     selectedCreditBundles: Schematic.CreditBundlePurchaseResponseData[];
     selectedPlan?: Schematic.PlanDetailResponseData;
+    selectedPlanAlreadyTrialed: boolean;
     selectedUsageBasedEntitlements: Schematic.UsageBasedEntitlementResponseData[];
     subscription?: Schematic.CompanySubscriptionResponseData;
 }

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

@@ -0,0 +1,5 @@
+export interface ClaimedStripeSandboxKeysResponseData {
+    publishable: string;
+    sandboxId: string;
+    secret: string;
+}

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

@@ -0,0 +1,17 @@
+import type * as Schematic from "../index";
+export interface CompanyBillingProfileResponseData {
+    accountId: string;
+    billingCustomerId?: string;
+    collectionMethod: Schematic.BillingCollectionMethod;
+    companyId: string;
+    createdAt: Date;
+    daysUntilDue?: number;
+    environmentId: string;
+    id: string;
+    isDefault: boolean;
+    name?: string;
+    paymentMethodId?: string;
+    prorationBehavior?: Schematic.ProrationBehavior;
+    providerType: Schematic.BillingProviderType;
+    updatedAt: Date;
+}