@schematichq/schematic-typescript-node 1.4.5 → 1.4.7

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

@@ -4,6 +4,10 @@ import type * as Schematic from "../../../index";
  */
 export interface CountPlansParams {
     companyId?: string;
+    /** Only return plans that are scoped to a company (custom plans assigned to a company) */
+    companyScopedOnly?: boolean;
+    /** Exclude plans that are scoped to a company (custom plans assigned to a company) */
+    excludeCompanyScoped?: 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) */
@@ -22,6 +26,10 @@ export interface CountPlansParams {
     /** Filter by plan type */
     planType?: Schematic.PlanType;
     q?: string;
+    /** Filter plans scoped to a specific company (custom plans) */
+    scopedToCompanyId?: string;
+    /** Include each plan's entitlements in the response */
+    withEntitlements?: 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/CreateCustomPlanResponse.d.ts

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

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

@@ -0,0 +1,6 @@
+/**
+ * Input parameters
+ */
+export interface DeletePlanVersionParams {
+    promoteArchivedVersion?: boolean;
+}

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

@@ -2,5 +2,5 @@ import type * as Schematic from "../../../index";
 export interface DeletePlanVersionResponse {
     data: Schematic.DeleteResponse;
     /** Input parameters */
-    params: Record<string, unknown>;
+    params: Schematic.DeletePlanVersionParams;
 }

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

@@ -0,0 +1,13 @@
+/**
+ * Input parameters
+ */
+export interface ListBillingProductMatchCompaniesParams {
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+    /** The plan ID to find billing product match companies for */
+    planId?: string;
+    /** Search for companies by name, keys or string traits */
+    q?: string;
+}

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

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface ListBillingProductMatchCompaniesResponse {
+    data: Schematic.CompanyDetailResponseData[];
+    /** Input parameters */
+    params: Schematic.ListBillingProductMatchCompaniesParams;
+}

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

@@ -0,0 +1,18 @@
+import type * as Schematic from "../../../index";
+/**
+ * Input parameters
+ */
+export interface ListCustomPlanBillingsParams {
+    /** Filter by company ID */
+    companyId?: string;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+    /** Filter by plan ID */
+    planId?: string;
+    /** Filter by billing status */
+    status?: Schematic.CustomPlanBillingStatus;
+    /** Filter by multiple billing statuses */
+    statuses?: Schematic.CustomPlanBillingStatus[];
+}

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

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface ListCustomPlanBillingsResponse {
+    data: Schematic.CustomPlanBillingResponseData[];
+    /** Input parameters */
+    params: Schematic.ListCustomPlanBillingsParams;
+}

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

@@ -4,6 +4,10 @@ import type * as Schematic from "../../../index";
  */
 export interface ListPlansParams {
     companyId?: string;
+    /** Only return plans that are scoped to a company (custom plans assigned to a company) */
+    companyScopedOnly?: boolean;
+    /** Exclude plans that are scoped to a company (custom plans assigned to a company) */
+    excludeCompanyScoped?: 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) */
@@ -22,6 +26,10 @@ export interface ListPlansParams {
     /** Filter by plan type */
     planType?: Schematic.PlanType;
     q?: string;
+    /** Filter plans scoped to a specific company (custom plans) */
+    scopedToCompanyId?: string;
+    /** Include each plan's entitlements in the response */
+    withEntitlements?: 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/MarkCustomPlanBillingPaidResponse.d.ts

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

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

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

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

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

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

@@ -1,15 +1,26 @@
+export * from "./CountBillingProductMatchCompaniesParams";
+export * from "./CountBillingProductMatchCompaniesResponse";
 export * from "./CountPlansParams";
 export * from "./CountPlansResponse";
+export * from "./CreateCustomPlanResponse";
 export * from "./CreatePlanResponse";
 export * from "./DeletePlanResponse";
+export * from "./DeletePlanVersionParams";
 export * from "./DeletePlanVersionResponse";
 export * from "./GetPlanParams";
 export * from "./GetPlanResponse";
+export * from "./ListBillingProductMatchCompaniesParams";
+export * from "./ListBillingProductMatchCompaniesResponse";
+export * from "./ListCustomPlanBillingsParams";
+export * from "./ListCustomPlanBillingsResponse";
 export * from "./ListPlanIssuesParams";
 export * from "./ListPlanIssuesResponse";
 export * from "./ListPlansParams";
 export * from "./ListPlansResponse";
+export * from "./MarkCustomPlanBillingPaidResponse";
 export * from "./PublishPlanVersionResponse";
+export * from "./RetryCustomPlanBillingResponse";
 export * from "./UpdateCompanyPlansResponse";
 export * from "./UpdatePlanResponse";
 export * from "./UpsertBillingProductPlanResponse";
+export * from "./UpsertPlanForBillingProductResponse";

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

@@ -22,6 +22,7 @@ export declare class WebhooksClient {
      *
      * @example
      *     await client.webhooks.listWebhookEvents({
+     *         ids: ["ids"],
      *         q: "q",
      *         webhookId: "webhook_id",
      *         limit: 1000000,
@@ -56,6 +57,7 @@ export declare class WebhooksClient {
      *
      * @example
      *     await client.webhooks.countWebhookEvents({
+     *         ids: ["ids"],
      *         q: "q",
      *         webhookId: "webhook_id",
      *         limit: 1000000,

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

@@ -1,6 +1,7 @@
 /**
  * @example
  *     {
+ *         ids: ["ids"],
  *         q: "q",
  *         webhookId: "webhook_id",
  *         limit: 1000000,

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

@@ -1,6 +1,7 @@
 /**
  * @example
  *     {
+ *         ids: ["ids"],
  *         q: "q",
  *         webhookId: "webhook_id",
  *         limit: 1000000,

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

@@ -0,0 +1,18 @@
+export declare const AccountMemberPermission: {
+    readonly BillingCreditsEdit: "billing_credits_edit";
+    readonly CompaniesEdit: "companies_edit";
+    readonly CompanyUsersEdit: "company_users_edit";
+    readonly ComponentsEdit: "components_edit";
+    readonly DataExportsEdit: "data_exports_edit";
+    readonly FeaturesEdit: "features_edit";
+    readonly FlagRulesEdit: "flag_rules_edit";
+    readonly FlagsEdit: "flags_edit";
+    readonly OverridesEdit: "overrides_edit";
+    readonly PlanBillingEdit: "plan_billing_edit";
+    readonly PlanEntitlementsEdit: "plan_entitlements_edit";
+    readonly PlanVersionsEdit: "plan_versions_edit";
+    readonly PlansEdit: "plans_edit";
+    readonly WebhooksEdit: "webhooks_edit";
+    readonly WebhooksRevealSecret: "webhooks_reveal_secret";
+};
+export type AccountMemberPermission = (typeof AccountMemberPermission)[keyof typeof AccountMemberPermission];

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

@@ -0,0 +1,11 @@
+import type * as Schematic from "../index";
+export interface AccountMemberResponseData {
+    createdAt: Date;
+    email?: string;
+    id: string;
+    imageUrl?: string;
+    name?: string;
+    permissions: Record<string, Schematic.AccountMemberPermission[]>;
+    role?: Schematic.AccountMemberRole;
+    updatedAt: Date;
+}

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

@@ -0,0 +1,5 @@
+export declare const AccountMemberRole: {
+    readonly Admin: "admin";
+    readonly Member: "member";
+};
+export type AccountMemberRole = (typeof AccountMemberRole)[keyof typeof AccountMemberRole];

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

@@ -0,0 +1,8 @@
+export interface ActivityEntryResponseData {
+    actorName: string;
+    method: string;
+    resourceName: string;
+    resourceType: string;
+    timestamp: Date;
+    title: string;
+}

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

@@ -0,0 +1,4 @@
+import type * as Schematic from "../index";
+export interface ActivityResponseResponseData {
+    entries: Schematic.ActivityEntryResponseData[];
+}

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

@@ -2,8 +2,10 @@ import type * as Schematic from "../index";
 export interface ApiKeyCreateResponseData {
     createdAt: Date;
     description?: string;
+    environment?: Schematic.EnvironmentResponseData;
     environmentId?: string;
     id: string;
+    integration?: Schematic.ApiKeyIntegrationResponseData;
     lastUsedAt?: Date;
     name: string;
     readonly: boolean;

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

@@ -0,0 +1,6 @@
+import type * as Schematic from "../index";
+export interface ApiKeyIntegrationResponseData {
+    id: string;
+    state: Schematic.IntegrationState;
+    type: Schematic.IntegrationType;
+}

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

@@ -2,8 +2,10 @@ import type * as Schematic from "../index";
 export interface ApiKeyResponseData {
     createdAt: Date;
     description?: string;
+    environment?: Schematic.EnvironmentResponseData;
     environmentId?: string;
     id: string;
+    integration?: Schematic.ApiKeyIntegrationResponseData;
     lastUsedAt?: Date;
     name: string;
     readonly: boolean;

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

@@ -1,8 +1,10 @@
 import type * as Schematic from "../index";
 export interface AuditLogListResponseData {
     actorType: Schematic.ActorType;
+    apiKey?: Schematic.ApiKeyResponseData;
     apiKeyId?: string;
     endedAt?: Date;
+    environment?: Schematic.EnvironmentResponseData;
     environmentId?: string;
     id: string;
     method: string;

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

@@ -1,8 +1,10 @@
 import type * as Schematic from "../index";
 export interface AuditLogResponseData {
     actorType: Schematic.ActorType;
+    apiKey?: Schematic.ApiKeyResponseData;
     apiKeyId?: string;
     endedAt?: Date;
+    environment?: Schematic.EnvironmentResponseData;
     environmentId?: string;
     id: string;
     method: string;

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

@@ -1,11 +1,13 @@
 import type * as Schematic from "../index";
 export interface BillingCreditBundleResponseData {
+    billingInvoiceId?: string;
     bundleType: Schematic.BillingCreditBundleType;
     createdAt: Date;
     creditDescription?: string;
     creditIcon?: string;
     creditId: string;
     creditName: string;
+    currencyPrices: Schematic.CreditBundleCurrencyPriceResponseData[];
     expiryType: Schematic.BillingCreditExpiryType;
     expiryUnit: Schematic.BillingCreditExpiryUnit;
     expiryUnitCount?: number;

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

@@ -6,6 +6,7 @@ export interface BillingCreditBundleView {
     creditIcon?: string;
     creditId: string;
     creditName: string;
+    currencyPrices: Schematic.CreditBundleCurrencyPrice[];
     expiryType: Schematic.BillingCreditExpiryType;
     expiryUnit: Schematic.BillingCreditExpiryUnit;
     expiryUnitCount?: number;

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

@@ -1,4 +1,5 @@
 export declare const BillingCreditGrantReason: {
+    readonly Adjustment: "adjustment";
     readonly BillingCreditAutoTopup: "billing_credit_auto_topup";
     readonly Free: "free";
     readonly Plan: "plan";

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

@@ -6,6 +6,7 @@ export interface BillingCreditGrantResponseData {
     creditIcon?: string;
     creditId: string;
     creditName: string;
+    currency?: string;
     expiresAt?: Date;
     grantReason: Schematic.BillingCreditGrantReason;
     id: string;

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

@@ -3,6 +3,7 @@ export interface BillingCreditResponseData {
     burnStrategy: Schematic.BillingCreditBurnStrategy;
     costEditable: boolean;
     createdAt: Date;
+    currencyPrices: Schematic.CreditCurrencyPriceResponseData[];
     defaultExpiryUnit: Schematic.BillingCreditExpiryUnit;
     defaultExpiryUnitCount?: number;
     defaultRolloverPolicy: Schematic.BillingCreditRolloverPolicy;

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

@@ -4,6 +4,7 @@ export interface BillingCreditView {
     burnStrategy: Schematic.BillingCreditBurnStrategy;
     costEditable: boolean;
     createdAt: Date;
+    currencyPrices: Schematic.CreditCurrencyPrice[];
     defaultExpiryUnit: Schematic.BillingCreditExpiryUnit;
     defaultExpiryUnitCount?: number;
     defaultRolloverPolicy: Schematic.BillingCreditRolloverPolicy;

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

@@ -0,0 +1,6 @@
+import type * as Schematic from "../index";
+export interface BillingLinkedResourceResponseData {
+    billingProvider: Schematic.BillingProviderType;
+    externalResourceId: string;
+    originator: Schematic.BillingProviderType;
+}

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

@@ -6,6 +6,8 @@ export interface BillingPlanCreditGrantResponseData {
     autoTopupExpiryType?: Schematic.BillingCreditExpiryType;
     autoTopupExpiryUnit?: Schematic.BillingCreditExpiryUnit;
     autoTopupExpiryUnitCount?: number;
+    autoTopupSelfService: boolean;
+    autoTopupThresholdCredits?: number;
     autoTopupThresholdPercent?: number;
     createdAt: Date;
     credit?: Schematic.BillingCreditResponseData;

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

@@ -4,6 +4,8 @@ export interface BillingPriceResponseData {
     externalPriceId: string;
     id: string;
     interval: Schematic.BillingProductPriceInterval;
+    intervalCount: number;
+    nickname?: string;
     price: number;
     priceDecimal?: string;
     providerType: Schematic.BillingProviderType;

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

@@ -5,10 +5,12 @@ export interface BillingPriceView {
     currency: string;
     id: string;
     interval: Schematic.BillingProductPriceInterval;
+    intervalCount: number;
     isActive: boolean;
     meterEventName?: string;
     meterEventPayloadKey?: string;
     meterId?: string;
+    nickname?: string;
     packageSize: number;
     price: number;
     priceDecimal?: string;

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

@@ -8,6 +8,7 @@ export interface BillingProductForSubscriptionResponseData {
     externalId: string;
     id: string;
     interval: string;
+    intervalCount?: number;
     meterId?: string;
     name: string;
     packageSize: number;

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

@@ -2,8 +2,9 @@ import type * as Schematic from "../index";
 export interface BillingProductPlanResponseData {
     accountId: string;
     billingProductId: string;
+    billingStrategy: Schematic.BillingStrategy;
     chargeType: Schematic.ChargeType;
-    controlledBy: Schematic.PlanControlledByType;
+    controlledBy: Schematic.BillingProviderType;
     environmentId: string;
     isTrialable: boolean;
     monthlyPriceId?: string;

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

@@ -5,8 +5,10 @@ export interface BillingProductPriceResponseData {
     currency: string;
     id: string;
     interval: Schematic.BillingProductPriceInterval;
+    intervalCount: number;
     isActive: boolean;
     meterId?: string;
+    nickname?: string;
     packageSize: number;
     price: number;
     priceDecimal?: string;

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

@@ -1,4 +1,5 @@
 export declare const BillingProviderType: {
+    readonly Orb: "orb";
     readonly Schematic: "schematic";
     readonly Stripe: "stripe";
 };

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

@@ -0,0 +1,6 @@
+export declare const BillingStrategy: {
+    readonly SchematicManaged: "schematic_managed";
+    readonly ProviderManaged: "provider_managed";
+    readonly NoBilling: "no_billing";
+};
+export type BillingStrategy = (typeof BillingStrategy)[keyof typeof BillingStrategy];

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

@@ -1,6 +1,7 @@
 import type * as Schematic from "../index";
 export interface ChangeSubscriptionInternalRequestBody {
     addOnIds: Schematic.UpdateAddOnRequestBody[];
+    autoTopupOverrides: Schematic.UpdateAutoTopupOverrideRequestBody[];
     companyId: string;
     couponExternalId?: string;
     creditBundles: Schematic.UpdateCreditBundleRequestBody[];

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

@@ -1,6 +1,7 @@
 import type * as Schematic from "../index";
 export interface ChangeSubscriptionRequestBody {
     addOnIds: Schematic.UpdateAddOnRequestBody[];
+    autoTopupOverrides: Schematic.UpdateAutoTopupOverrideRequestBody[];
     couponExternalId?: string;
     creditBundles: Schematic.UpdateCreditBundleRequestBody[];
     newPlanId: string;

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

@@ -1,5 +1,6 @@
 export declare const ChargeType: {
     readonly Free: "free";
+    readonly None: "none";
     readonly OneTime: "one_time";
     readonly Recurring: "recurring";
 };

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

@@ -13,7 +13,7 @@ export interface CheckFlagResponseData {
     /** Deprecated: Use Entitlement.EventName instead. */
     featureUsageEvent?: string;
     /** Deprecated: Use Entitlement.MetricPeriod instead. */
-    featureUsagePeriod?: string;
+    featureUsagePeriod?: Schematic.MetricPeriod;
     /** Deprecated: Use Entitlement.MetricResetAt instead. */
     featureUsageResetAt?: Date;
     /** The key used to check the flag */
@@ -25,7 +25,7 @@ export interface CheckFlagResponseData {
     /** If a rule was found, its ID */
     ruleId?: string;
     /** If a rule was found, its type */
-    ruleType?: string;
+    ruleType?: Schematic.RuleType;
     /** If user keys were provided and matched a user, its ID */
     userId?: string;
     /** A boolean flag check result; for feature entitlements, this represents whether further consumption of the feature is permitted */

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

@@ -13,6 +13,8 @@ export interface CheckoutSubscription {
     expiredAt?: Date;
     id: string;
     interval: string;
+    invoiceId?: string;
+    invoiceUrl?: string;
     metadata?: Record<string, unknown>;
     periodEnd: number;
     periodStart: number;

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

@@ -0,0 +1,6 @@
+export interface ClerkIntegrationConfig {
+    /** Whether Schematic has received the first webhook event from Clerk after install */
+    firstEventsReceived?: boolean;
+    /** URL configured on the Clerk webhook endpoint that delivers events to Schematic */
+    webhookUrl?: string;
+}

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

@@ -0,0 +1,7 @@
+import type * as Schematic from "../index";
+export interface CompanyCreditBalanceResponseData {
+    creditId: string;
+    remaining: number;
+    source: Schematic.BillingProviderType;
+    total?: number;
+}

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

@@ -5,6 +5,7 @@ export interface CompanyDetailResponseData {
     billingSubscription?: Schematic.BillingSubscriptionView;
     billingSubscriptions: Schematic.BillingSubscriptionView[];
     createdAt: Date;
+    customPlanBillings: Schematic.CustomPlanBillingResponseData[];
     defaultPaymentMethod?: Schematic.PaymentMethodResponseData;
     entitlements: Schematic.FeatureEntitlement[];
     entityTraits: Schematic.EntityTraitDetailResponseData[];

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

@@ -1,3 +1,4 @@
+import type * as Schematic from "../index";
 export interface CompanyEventPeriodMetricsResponseData {
     accountId: string;
     capturedAtMax: Date;
@@ -6,8 +7,8 @@ export interface CompanyEventPeriodMetricsResponseData {
     createdAt: Date;
     environmentId: string;
     eventSubtype: string;
-    monthReset: string;
-    period: string;
+    monthReset: Schematic.MetricPeriodMonthReset;
+    period: Schematic.MetricPeriod;
     validUntil?: Date;
     value: number;
 }

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

@@ -0,0 +1,5 @@
+export declare const CompanyMatchingCriteria: {
+    readonly BillingMetaObject: "billing_meta_object";
+    readonly ManualUpsert: "manual_upsert";
+};
+export type CompanyMatchingCriteria = (typeof CompanyMatchingCriteria)[keyof typeof CompanyMatchingCriteria];

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

@@ -9,8 +9,8 @@ export interface CompanyOverrideResponseData {
     feature?: Schematic.FeatureResponseData;
     featureId: string;
     id: string;
-    metricPeriod?: string;
-    metricPeriodMonthReset?: string;
+    metricPeriod?: Schematic.MetricPeriod;
+    metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
     notes: Schematic.CompanyOverrideNoteResponseData[];
     ruleId?: string;
     ruleIdUsageExceeded?: string;

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

@@ -0,0 +1,40 @@
+import type * as Schematic from "../index";
+export interface CompanyPlanCreditGrantView {
+    billingCreditAutoTopupAmount?: number;
+    billingCreditAutoTopupAmountType?: string;
+    billingCreditAutoTopupEnabled: boolean;
+    billingCreditAutoTopupExpiryType?: Schematic.BillingCreditExpiryType;
+    billingCreditAutoTopupExpiryUnit?: Schematic.BillingCreditExpiryUnit;
+    billingCreditAutoTopupExpiryUnitCount?: number;
+    billingCreditAutoTopupSelfService: boolean;
+    billingCreditAutoTopupThresholdCredits?: number;
+    billingCreditAutoTopupThresholdPercent?: number;
+    companyAutoTopupAmount?: number;
+    companyAutoTopupEnabled?: boolean;
+    companyAutoTopupThresholdCredits?: number;
+    createdAt: Date;
+    credit?: Schematic.BillingCreditView;
+    creditAmount: number;
+    /** Deprecated field, will be removed in the future. Use Credit.Description instead. */
+    creditDescription: string;
+    /** Deprecated field, will be removed in the future. Use Credit.Icon instead. */
+    creditIcon?: string;
+    creditId: string;
+    /** Deprecated field, will be removed in the future. Use Credit.Name instead. */
+    creditName: string;
+    expiryType?: Schematic.BillingCreditExpiryType;
+    expiryUnit?: Schematic.BillingCreditExpiryUnit;
+    expiryUnitCount?: number;
+    id: string;
+    plan?: Schematic.GenericPreviewObject;
+    planId: string;
+    planVersionId?: string;
+    /** Deprecated field, will be removed in the future. Use Credit.PluralName instead. */
+    pluralName?: string;
+    resetCadence?: Schematic.BillingPlanCreditGrantResetCadence;
+    resetStart?: Schematic.BillingPlanCreditGrantResetStart;
+    resetType: Schematic.BillingPlanCreditGrantResetType;
+    /** Deprecated field, will be removed in the future. Use Credit.SingularName instead. */
+    singularName?: string;
+    updatedAt: Date;
+}