@schematichq/schematic-typescript-node 1.2.4 → 1.2.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-2025 Schematic, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/Client.d.ts

@@ -4,7 +4,6 @@
 import * as environments from "./environments";
 import * as core from "./core";
 import { Accounts } from "./api/resources/accounts/client/Client";
-import { Features } from "./api/resources/features/client/Client";
 import { Billing } from "./api/resources/billing/client/Client";
 import { Credits } from "./api/resources/credits/client/Client";
 import { Checkout } from "./api/resources/checkout/client/Client";
@@ -15,6 +14,7 @@ import { Components } from "./api/resources/components/client/Client";
 import { Crm } from "./api/resources/crm/client/Client";
 import { Dataexports } from "./api/resources/dataexports/client/Client";
 import { Events } from "./api/resources/events/client/Client";
+import { Features } from "./api/resources/features/client/Client";
 import { Plangroups } from "./api/resources/plangroups/client/Client";
 import { Accesstokens } from "./api/resources/accesstokens/client/Client";
 import { Webhooks } from "./api/resources/webhooks/client/Client";
@@ -40,7 +40,6 @@ export declare namespace SchematicClient {
 export declare class SchematicClient {
     protected readonly _options: SchematicClient.Options;
     protected _accounts: Accounts | undefined;
-    protected _features: Features | undefined;
     protected _billing: Billing | undefined;
     protected _credits: Credits | undefined;
     protected _checkout: Checkout | undefined;
@@ -51,12 +50,12 @@ export declare class SchematicClient {
     protected _crm: Crm | undefined;
     protected _dataexports: Dataexports | undefined;
     protected _events: Events | undefined;
+    protected _features: Features | undefined;
     protected _plangroups: Plangroups | undefined;
     protected _accesstokens: Accesstokens | undefined;
     protected _webhooks: Webhooks | undefined;
     constructor(_options?: SchematicClient.Options);
     get accounts(): Accounts;
-    get features(): Features;
     get billing(): Billing;
     get credits(): Credits;
     get checkout(): Checkout;
@@ -67,73 +66,28 @@ export declare class SchematicClient {
     get crm(): Crm;
     get dataexports(): Dataexports;
     get events(): Events;
+    get features(): Features;
     get plangroups(): Plangroups;
     get accesstokens(): Accesstokens;
     get webhooks(): Webhooks;
     /**
+     * @param {string} planAudienceId
      * @param {SchematicClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.getCredit()
-     */
-    getCredit(requestOptions?: SchematicClient.RequestOptions): core.HttpResponsePromise<void>;
-    private __getCredit;
-    /**
-     * @param {SchematicClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.updateCredit()
-     */
-    updateCredit(requestOptions?: SchematicClient.RequestOptions): core.HttpResponsePromise<void>;
-    private __updateCredit;
-    /**
-     * @param {SchematicClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.deleteCredit()
-     */
-    deleteCredit(requestOptions?: SchematicClient.RequestOptions): core.HttpResponsePromise<void>;
-    private __deleteCredit;
-    /**
-     * @param {SchematicClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.getCreditBundle()
-     */
-    getCreditBundle(requestOptions?: SchematicClient.RequestOptions): core.HttpResponsePromise<void>;
-    private __getCreditBundle;
-    /**
-     * @param {SchematicClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.purchaseCreditBundle()
-     */
-    purchaseCreditBundle(requestOptions?: SchematicClient.RequestOptions): core.HttpResponsePromise<void>;
-    private __purchaseCreditBundle;
-    /**
-     * @param {SchematicClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.updateCreditBundle()
-     */
-    updateCreditBundle(requestOptions?: SchematicClient.RequestOptions): core.HttpResponsePromise<void>;
-    private __updateCreditBundle;
-    /**
-     * @param {SchematicClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.zeroOutCreditGrant()
+     *     await client.putPlanAudiencesPlanAudienceId("plan_audience_id")
      */
-    zeroOutCreditGrant(requestOptions?: SchematicClient.RequestOptions): core.HttpResponsePromise<void>;
-    private __zeroOutCreditGrant;
+    putPlanAudiencesPlanAudienceId(planAudienceId: string, requestOptions?: SchematicClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __putPlanAudiencesPlanAudienceId;
     /**
+     * @param {string} planAudienceId
      * @param {SchematicClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.deletePlanCreditGrant()
+     *     await client.deletePlanAudiencesPlanAudienceId("plan_audience_id")
      */
-    deletePlanCreditGrant(requestOptions?: SchematicClient.RequestOptions): core.HttpResponsePromise<void>;
-    private __deletePlanCreditGrant;
+    deletePlanAudiencesPlanAudienceId(planAudienceId: string, requestOptions?: SchematicClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __deletePlanAudiencesPlanAudienceId;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-Schematic-Api-Key": string | undefined;
     }>;

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

@@ -84,6 +84,7 @@ export declare class Companies {
     private __getCompany;
     /**
      * @param {string} companyId - company_id
+     * @param {Schematic.DeleteCompanyRequest} request
      * @param {Companies.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Schematic.BadRequestError}
@@ -93,9 +94,12 @@ export declare class Companies {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.companies.deleteCompany("company_id")
+     *     await client.companies.deleteCompany("company_id", {
+     *         cancelSubscription: true,
+     *         prorate: true
+     *     })
      */
-    deleteCompany(companyId: string, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.DeleteCompanyResponse>;
+    deleteCompany(companyId: string, request?: Schematic.DeleteCompanyRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.DeleteCompanyResponse>;
     private __deleteCompany;
     /**
      * @param {Schematic.CountCompaniesRequest} request
@@ -489,6 +493,41 @@ export declare class Companies {
      */
     getEntityTraitValues(request: Schematic.GetEntityTraitValuesRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.GetEntityTraitValuesResponse>;
     private __getEntityTraitValues;
+    /**
+     * @param {Schematic.ListPlanChangesRequest} request
+     * @param {Companies.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.companies.listPlanChanges({
+     *         action: "action",
+     *         basePlanAction: "base_plan_action",
+     *         companyId: "company_id",
+     *         limit: 1,
+     *         offset: 1
+     *     })
+     */
+    listPlanChanges(request?: Schematic.ListPlanChangesRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.ListPlanChangesResponse>;
+    private __listPlanChanges;
+    /**
+     * @param {string} planChangeId - plan_change_id
+     * @param {Companies.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.companies.getPlanChange("plan_change_id")
+     */
+    getPlanChange(planChangeId: string, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.GetPlanChangeResponse>;
+    private __getPlanChange;
     /**
      * @param {Schematic.ListPlanTraitsRequest} request
      * @param {Companies.RequestOptions} requestOptions - Request-specific configuration.

package/dist/api/resources/companies/client/requests/DeleteCompanyRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         cancelSubscription: true,
+ *         prorate: true
+ *     }
+ */
+export interface DeleteCompanyRequest {
+    cancelSubscription?: boolean;
+    prorate?: boolean;
+}

package/dist/api/resources/companies/client/requests/ListPlanChangesRequest.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         action: "action",
+ *         basePlanAction: "base_plan_action",
+ *         companyId: "company_id",
+ *         limit: 1,
+ *         offset: 1
+ *     }
+ */
+export interface ListPlanChangesRequest {
+    action?: string;
+    basePlanAction?: string;
+    companyId?: string;
+    companyIds?: string | string[];
+    planIds?: string | string[];
+    /**
+     * Page limit (default 100)
+     */
+    limit?: number;
+    /**
+     * Page offset (default 0)
+     */
+    offset?: number;
+}

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

@@ -1,4 +1,5 @@
 export { type ListCompaniesRequest } from "./ListCompaniesRequest";
+export { type DeleteCompanyRequest } from "./DeleteCompanyRequest";
 export { type CountCompaniesRequest } from "./CountCompaniesRequest";
 export { type CountCompaniesForAdvancedFilterRequest } from "./CountCompaniesForAdvancedFilterRequest";
 export { type ListCompaniesForAdvancedFilterRequest } from "./ListCompaniesForAdvancedFilterRequest";
@@ -14,6 +15,7 @@ export { type CreateEntityTraitDefinitionRequestBody } from "./CreateEntityTrait
 export { type UpdateEntityTraitDefinitionRequestBody } from "./UpdateEntityTraitDefinitionRequestBody";
 export { type CountEntityTraitDefinitionsRequest } from "./CountEntityTraitDefinitionsRequest";
 export { type GetEntityTraitValuesRequest } from "./GetEntityTraitValuesRequest";
+export { type ListPlanChangesRequest } from "./ListPlanChangesRequest";
 export { type ListPlanTraitsRequest } from "./ListPlanTraitsRequest";
 export { type CreatePlanTraitRequestBody } from "./CreatePlanTraitRequestBody";
 export { type UpdatePlanTraitRequestBody } from "./UpdatePlanTraitRequestBody";

package/dist/api/resources/companies/types/DeleteCompanyParams.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Input parameters
+ */
+export interface DeleteCompanyParams {
+    cancelSubscription?: boolean;
+    prorate?: boolean;
+}

package/dist/api/resources/companies/types/DeleteCompanyResponse.d.ts

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

package/dist/api/resources/{features/types/CountAudienceCompaniesResponse.d.ts → companies/types/GetPlanChangeResponse.d.ts}

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Schematic from "../../../index";
-export interface CountAudienceCompaniesResponse {
-    data: Schematic.CountResponse;
+export interface GetPlanChangeResponse {
+    data: Schematic.PlanChangeResponseData;
     /** Input parameters */
     params: Record<string, unknown>;
 }

package/dist/api/resources/companies/types/ListPlanChangesParams.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Input parameters
+ */
+export interface ListPlanChangesParams {
+    action?: string;
+    basePlanAction?: string;
+    companyId?: string;
+    companyIds?: string[];
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+    planIds?: string[];
+}

package/dist/api/resources/{plans/types/DeleteAudienceResponse.d.ts → companies/types/ListPlanChangesResponse.d.ts}

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Schematic from "../../../index";
-export interface DeleteAudienceResponse {
-    data: Schematic.DeleteResponse;
+export interface ListPlanChangesResponse {
+    data: Schematic.PlanChangeResponseData[];
     /** Input parameters */
-    params: Record<string, unknown>;
+    params: Schematic.ListPlanChangesParams;
 }

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

@@ -2,6 +2,7 @@ export * from "./ListCompaniesParams";
 export * from "./ListCompaniesResponse";
 export * from "./UpsertCompanyResponse";
 export * from "./GetCompanyResponse";
+export * from "./DeleteCompanyParams";
 export * from "./DeleteCompanyResponse";
 export * from "./CountCompaniesParams";
 export * from "./CountCompaniesResponse";
@@ -54,6 +55,9 @@ export * from "./CountEntityTraitDefinitionsParams";
 export * from "./CountEntityTraitDefinitionsResponse";
 export * from "./GetEntityTraitValuesParams";
 export * from "./GetEntityTraitValuesResponse";
+export * from "./ListPlanChangesParams";
+export * from "./ListPlanChangesResponse";
+export * from "./GetPlanChangeResponse";
 export * from "./ListPlanTraitsParams";
 export * from "./ListPlanTraitsResponse";
 export * from "./CreatePlanTraitResponse";

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

@@ -65,7 +65,7 @@ export declare class Credits {
     createBillingCredit(request: Schematic.CreateBillingCreditRequestBody, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CreateBillingCreditResponse>;
     private __createBillingCredit;
     /**
-     * @param {string} billingId - billing_id
+     * @param {string} creditId - credit_id
      * @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Schematic.UnauthorizedError}
@@ -74,12 +74,12 @@ export declare class Credits {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.credits.getSingleBillingCredit("billing_id")
+     *     await client.credits.getSingleBillingCredit("credit_id")
      */
-    getSingleBillingCredit(billingId: string, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.GetSingleBillingCreditResponse>;
+    getSingleBillingCredit(creditId: string, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.GetSingleBillingCreditResponse>;
     private __getSingleBillingCredit;
     /**
-     * @param {string} billingId - billing_id
+     * @param {string} creditId - credit_id
      * @param {Schematic.UpdateBillingCreditRequestBody} request
      * @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -90,15 +90,15 @@ export declare class Credits {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.credits.updateBillingCredit("billing_id", {
+     *     await client.credits.updateBillingCredit("credit_id", {
      *         description: "description",
      *         name: "name"
      *     })
      */
-    updateBillingCredit(billingId: string, request: Schematic.UpdateBillingCreditRequestBody, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.UpdateBillingCreditResponse>;
+    updateBillingCredit(creditId: string, request: Schematic.UpdateBillingCreditRequestBody, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.UpdateBillingCreditResponse>;
     private __updateBillingCredit;
     /**
-     * @param {string} billingId - billing_id
+     * @param {string} creditId - credit_id
      * @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Schematic.BadRequestError}
@@ -108,9 +108,9 @@ export declare class Credits {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.credits.softDeleteBillingCredit("billing_id")
+     *     await client.credits.softDeleteBillingCredit("credit_id")
      */
-    softDeleteBillingCredit(billingId: string, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.SoftDeleteBillingCreditResponse>;
+    softDeleteBillingCredit(creditId: string, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.SoftDeleteBillingCreditResponse>;
     private __softDeleteBillingCredit;
     /**
      * @param {Schematic.ListCreditBundlesRequest} request
@@ -154,7 +154,7 @@ export declare class Credits {
     createCreditBundle(request: Schematic.CreateCreditBundleRequestBody, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CreateCreditBundleResponse>;
     private __createCreditBundle;
     /**
-     * @param {string} billingId - billing_id
+     * @param {string} bundleId - bundle_id
      * @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Schematic.UnauthorizedError}
@@ -163,12 +163,12 @@ export declare class Credits {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.credits.getCreditBundle("billing_id")
+     *     await client.credits.getCreditBundle("bundle_id")
      */
-    getCreditBundle(billingId: string, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.GetCreditBundleResponse>;
+    getCreditBundle(bundleId: string, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.GetCreditBundleResponse>;
     private __getCreditBundle;
     /**
-     * @param {string} billingId - billing_id
+     * @param {string} bundleId - bundle_id
      * @param {Schematic.UpdateCreditBundleDetailsRequestBody} request
      * @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -179,15 +179,15 @@ export declare class Credits {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.credits.updateCreditBundleDetails("billing_id", {
+     *     await client.credits.updateCreditBundleDetails("bundle_id", {
      *         bundleName: "bundle_name",
      *         pricePerUnit: 1
      *     })
      */
-    updateCreditBundleDetails(billingId: string, request: Schematic.UpdateCreditBundleDetailsRequestBody, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.UpdateCreditBundleDetailsResponse>;
+    updateCreditBundleDetails(bundleId: string, request: Schematic.UpdateCreditBundleDetailsRequestBody, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.UpdateCreditBundleDetailsResponse>;
     private __updateCreditBundleDetails;
     /**
-     * @param {string} billingId - billing_id
+     * @param {string} bundleId - bundle_id
      * @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Schematic.BadRequestError}
@@ -197,9 +197,9 @@ export declare class Credits {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.credits.deleteCreditBundle("billing_id")
+     *     await client.credits.deleteCreditBundle("bundle_id")
      */
-    deleteCreditBundle(billingId: string, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.DeleteCreditBundleResponse>;
+    deleteCreditBundle(bundleId: string, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.DeleteCreditBundleResponse>;
     private __deleteCreditBundle;
     /**
      * @param {Schematic.CountCreditBundlesRequest} request
@@ -242,7 +242,7 @@ export declare class Credits {
     countBillingCredits(request?: Schematic.CountBillingCreditsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CountBillingCreditsResponse>;
     private __countBillingCredits;
     /**
-     * @param {string} billingId - billing_id
+     * @param {string} grantId - grant_id
      * @param {Schematic.ZeroOutGrantRequestBody} request
      * @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -253,9 +253,9 @@ export declare class Credits {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.credits.zeroOutGrant("billing_id")
+     *     await client.credits.zeroOutGrant("grant_id")
      */
-    zeroOutGrant(billingId: string, request?: Schematic.ZeroOutGrantRequestBody, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ZeroOutGrantResponse>;
+    zeroOutGrant(grantId: string, request?: Schematic.ZeroOutGrantRequestBody, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ZeroOutGrantResponse>;
     private __zeroOutGrant;
     /**
      * @param {Schematic.CreateCompanyCreditGrant} request
@@ -426,7 +426,8 @@ export declare class Credits {
     createBillingPlanCreditGrant(request: Schematic.CreateBillingPlanCreditGrantRequestBody, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CreateBillingPlanCreditGrantResponse>;
     private __createBillingPlanCreditGrant;
     /**
-     * @param {string} billingId - billing_id
+     * @param {string} planGrantId - plan_grant_id
+     * @param {Schematic.UpdateBillingPlanCreditGrantRequestBody} request
      * @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Schematic.BadRequestError}
@@ -436,9 +437,30 @@ export declare class Credits {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.credits.deleteBillingPlanCreditGrant("billing_id")
+     *     await client.credits.updateBillingPlanCreditGrant("plan_grant_id", {
+     *         resetCadence: "monthly",
+     *         resetStart: "billing_period"
+     *     })
+     */
+    updateBillingPlanCreditGrant(planGrantId: string, request: Schematic.UpdateBillingPlanCreditGrantRequestBody, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.UpdateBillingPlanCreditGrantResponse>;
+    private __updateBillingPlanCreditGrant;
+    /**
+     * @param {string} planGrantId - plan_grant_id
+     * @param {Schematic.DeleteBillingPlanCreditGrantRequest} request
+     * @param {Credits.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.deleteBillingPlanCreditGrant("plan_grant_id", {
+     *         applyToExisting: true
+     *     })
      */
-    deleteBillingPlanCreditGrant(billingId: string, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.DeleteBillingPlanCreditGrantResponse>;
+    deleteBillingPlanCreditGrant(planGrantId: string, request?: Schematic.DeleteBillingPlanCreditGrantRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.DeleteBillingPlanCreditGrantResponse>;
     private __deleteBillingPlanCreditGrant;
     /**
      * @param {Schematic.CountBillingPlanCreditGrantsRequest} request

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

@@ -13,6 +13,14 @@ import * as Schematic from "../../../../index";
  *     }
  */
 export interface CreateBillingPlanCreditGrantRequestBody {
+    applyToExisting?: boolean;
+    autoTopupAmount?: number;
+    autoTopupAmountType?: "credit";
+    autoTopupEnabled?: boolean;
+    autoTopupExpiryType?: Schematic.CreateBillingPlanCreditGrantRequestBodyAutoTopupExpiryType;
+    autoTopupExpiryUnit?: Schematic.CreateBillingPlanCreditGrantRequestBodyAutoTopupExpiryUnit;
+    autoTopupExpiryUnitCount?: number;
+    autoTopupThresholdPercent?: number;
     creditAmount: number;
     creditId: string;
     expiryType?: Schematic.CreateBillingPlanCreditGrantRequestBodyExpiryType;

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         applyToExisting: true
+ *     }
+ */
+export interface DeleteBillingPlanCreditGrantRequest {
+    applyToExisting?: boolean;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         resetCadence: "monthly",
+ *         resetStart: "billing_period"
+ *     }
+ */
+export interface UpdateBillingPlanCreditGrantRequestBody {
+    applyToExisting?: boolean;
+    creditAmount?: number;
+    expiryType?: Schematic.UpdateBillingPlanCreditGrantRequestBodyExpiryType;
+    expiryUnit?: Schematic.UpdateBillingPlanCreditGrantRequestBodyExpiryUnit;
+    expiryUnitCount?: number;
+    resetCadence: Schematic.UpdateBillingPlanCreditGrantRequestBodyResetCadence;
+    resetStart: Schematic.UpdateBillingPlanCreditGrantRequestBodyResetStart;
+    resetType?: Schematic.UpdateBillingPlanCreditGrantRequestBodyResetType;
+}

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

@@ -15,4 +15,6 @@ export { type GetEnrichedCreditLedgerRequest } from "./GetEnrichedCreditLedgerRe
 export { type CountCreditLedgerRequest } from "./CountCreditLedgerRequest";
 export { type ListBillingPlanCreditGrantsRequest } from "./ListBillingPlanCreditGrantsRequest";
 export { type CreateBillingPlanCreditGrantRequestBody } from "./CreateBillingPlanCreditGrantRequestBody";
+export { type UpdateBillingPlanCreditGrantRequestBody } from "./UpdateBillingPlanCreditGrantRequestBody";
+export { type DeleteBillingPlanCreditGrantRequest } from "./DeleteBillingPlanCreditGrantRequest";
 export { type CountBillingPlanCreditGrantsRequest } from "./CountBillingPlanCreditGrantsRequest";

package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyAutoTopupExpiryType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type CreateBillingPlanCreditGrantRequestBodyAutoTopupExpiryType = "duration" | "no_expiry" | "end_of_trial" | "end_of_billing_period" | "end_of_next_billing_period";
+export declare const CreateBillingPlanCreditGrantRequestBodyAutoTopupExpiryType: {
+    readonly Duration: "duration";
+    readonly NoExpiry: "no_expiry";
+    readonly EndOfTrial: "end_of_trial";
+    readonly EndOfBillingPeriod: "end_of_billing_period";
+    readonly EndOfNextBillingPeriod: "end_of_next_billing_period";
+};

package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyAutoTopupExpiryUnit.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type CreateBillingPlanCreditGrantRequestBodyAutoTopupExpiryUnit = "days" | "billing_periods";
+export declare const CreateBillingPlanCreditGrantRequestBodyAutoTopupExpiryUnit: {
+    readonly Days: "days";
+    readonly BillingPeriods: "billing_periods";
+};

package/dist/api/resources/credits/types/DeleteBillingPlanCreditGrantParams.d.ts

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

package/dist/api/resources/credits/types/DeleteBillingPlanCreditGrantResponse.d.ts

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

package/dist/api/resources/credits/types/UpdateBillingPlanCreditGrantRequestBodyExpiryType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type UpdateBillingPlanCreditGrantRequestBodyExpiryType = "duration" | "no_expiry" | "end_of_trial" | "end_of_billing_period" | "end_of_next_billing_period";
+export declare const UpdateBillingPlanCreditGrantRequestBodyExpiryType: {
+    readonly Duration: "duration";
+    readonly NoExpiry: "no_expiry";
+    readonly EndOfTrial: "end_of_trial";
+    readonly EndOfBillingPeriod: "end_of_billing_period";
+    readonly EndOfNextBillingPeriod: "end_of_next_billing_period";
+};

package/dist/api/resources/credits/types/UpdateBillingPlanCreditGrantRequestBodyExpiryUnit.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type UpdateBillingPlanCreditGrantRequestBodyExpiryUnit = "days" | "billing_periods";
+export declare const UpdateBillingPlanCreditGrantRequestBodyExpiryUnit: {
+    readonly Days: "days";
+    readonly BillingPeriods: "billing_periods";
+};