@schematichq/schematic-typescript-node 1.1.9 → 1.1.11

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

@@ -7,6 +7,8 @@ import * as Schematic from "../../../index";
 export declare namespace Plans {
     interface Options {
         environment?: core.Supplier<environments.SchematicEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         apiKey: core.Supplier<string>;
         fetcher?: core.FetchFunction;
     }
@@ -17,6 +19,8 @@ export declare namespace Plans {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class Plans {
@@ -38,7 +42,8 @@ export declare class Plans {
      *         addOnIds: ["add_on_ids"]
      *     })
      */
-    updateCompanyPlans(companyPlanId: string, request: Schematic.UpdateCompanyPlansRequestBody, requestOptions?: Plans.RequestOptions): Promise<Schematic.UpdateCompanyPlansResponse>;
+    updateCompanyPlans(companyPlanId: string, request: Schematic.UpdateCompanyPlansRequestBody, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.UpdateCompanyPlansResponse>;
+    private __updateCompanyPlans;
     /**
      * @param {string} planAudienceId - plan_audience_id
      * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
@@ -51,7 +56,8 @@ export declare class Plans {
      * @example
      *     await client.plans.getAudience("plan_audience_id")
      */
-    getAudience(planAudienceId: string, requestOptions?: Plans.RequestOptions): Promise<Schematic.GetAudienceResponse>;
+    getAudience(planAudienceId: string, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.GetAudienceResponse>;
+    private __getAudience;
     /**
      * @param {string} planAudienceId - plan_audience_id
      * @param {Schematic.UpdateAudienceRequestBody} request
@@ -79,7 +85,8 @@ export declare class Plans {
      *             }]
      *     })
      */
-    updateAudience(planAudienceId: string, request: Schematic.UpdateAudienceRequestBody, requestOptions?: Plans.RequestOptions): Promise<Schematic.UpdateAudienceResponse>;
+    updateAudience(planAudienceId: string, request: Schematic.UpdateAudienceRequestBody, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.UpdateAudienceResponse>;
+    private __updateAudience;
     /**
      * @param {string} planAudienceId - plan_audience_id
      * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
@@ -87,12 +94,111 @@ export declare class Plans {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.plans.deleteAudience("plan_audience_id")
      */
-    deleteAudience(planAudienceId: string, requestOptions?: Plans.RequestOptions): Promise<Schematic.DeleteAudienceResponse>;
+    deleteAudience(planAudienceId: string, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.DeleteAudienceResponse>;
+    private __deleteAudience;
+    /**
+     * @param {Schematic.ListPlanTraitsRequest} request
+     * @param {Plans.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.plans.listPlanTraits()
+     */
+    listPlanTraits(request?: Schematic.ListPlanTraitsRequest, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.ListPlanTraitsResponse>;
+    private __listPlanTraits;
+    /**
+     * @param {Schematic.CreatePlanTraitRequestBody} request
+     * @param {Plans.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.plans.createPlanTrait({
+     *         planId: "plan_id",
+     *         traitId: "trait_id",
+     *         traitValue: "trait_value"
+     *     })
+     */
+    createPlanTrait(request: Schematic.CreatePlanTraitRequestBody, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.CreatePlanTraitResponse>;
+    private __createPlanTrait;
+    /**
+     * @param {string} planTraitId - plan_trait_id
+     * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.plans.getPlanTrait("plan_trait_id")
+     */
+    getPlanTrait(planTraitId: string, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.GetPlanTraitResponse>;
+    private __getPlanTrait;
+    /**
+     * @param {string} planTraitId - plan_trait_id
+     * @param {Schematic.UpdatePlanTraitRequestBody} request
+     * @param {Plans.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.plans.updatePlanTrait("plan_trait_id", {
+     *         planId: "plan_id",
+     *         traitValue: "trait_value"
+     *     })
+     */
+    updatePlanTrait(planTraitId: string, request: Schematic.UpdatePlanTraitRequestBody, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.UpdatePlanTraitResponse>;
+    private __updatePlanTrait;
+    /**
+     * @param {string} planTraitId - plan_trait_id
+     * @param {Plans.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.plans.deletePlanTrait("plan_trait_id")
+     */
+    deletePlanTrait(planTraitId: string, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.DeletePlanTraitResponse>;
+    private __deletePlanTrait;
+    /**
+     * @param {Schematic.CountPlanTraitsRequest} request
+     * @param {Plans.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.plans.countPlanTraits()
+     */
+    countPlanTraits(request?: Schematic.CountPlanTraitsRequest, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.CountPlanTraitsResponse>;
+    private __countPlanTraits;
     /**
      * @param {Schematic.ListPlansRequest} request
      * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
@@ -100,12 +206,14 @@ export declare class Plans {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.plans.listPlans()
      */
-    listPlans(request?: Schematic.ListPlansRequest, requestOptions?: Plans.RequestOptions): Promise<Schematic.ListPlansResponse>;
+    listPlans(request?: Schematic.ListPlansRequest, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.ListPlansResponse>;
+    private __listPlans;
     /**
      * @param {Schematic.CreatePlanRequestBody} request
      * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
@@ -113,6 +221,7 @@ export declare class Plans {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -122,7 +231,8 @@ export declare class Plans {
      *         planType: "plan"
      *     })
      */
-    createPlan(request: Schematic.CreatePlanRequestBody, requestOptions?: Plans.RequestOptions): Promise<Schematic.CreatePlanResponse>;
+    createPlan(request: Schematic.CreatePlanRequestBody, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.CreatePlanResponse>;
+    private __createPlan;
     /**
      * @param {string} planId - plan_id
      * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
@@ -135,7 +245,8 @@ export declare class Plans {
      * @example
      *     await client.plans.getPlan("plan_id")
      */
-    getPlan(planId: string, requestOptions?: Plans.RequestOptions): Promise<Schematic.GetPlanResponse>;
+    getPlan(planId: string, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.GetPlanResponse>;
+    private __getPlan;
     /**
      * @param {string} planId - plan_id
      * @param {Schematic.UpdatePlanRequestBody} request
@@ -152,7 +263,8 @@ export declare class Plans {
      *         name: "name"
      *     })
      */
-    updatePlan(planId: string, request: Schematic.UpdatePlanRequestBody, requestOptions?: Plans.RequestOptions): Promise<Schematic.UpdatePlanResponse>;
+    updatePlan(planId: string, request: Schematic.UpdatePlanRequestBody, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.UpdatePlanResponse>;
+    private __updatePlan;
     /**
      * @param {string} planId - plan_id
      * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
@@ -160,12 +272,14 @@ export declare class Plans {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.plans.deletePlan("plan_id")
      */
-    deletePlan(planId: string, requestOptions?: Plans.RequestOptions): Promise<Schematic.DeletePlanResponse>;
+    deletePlan(planId: string, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.DeletePlanResponse>;
+    private __deletePlan;
     /**
      * @param {string} planId - plan_id
      * @param {Schematic.UpsertBillingProductRequestBody} request
@@ -183,7 +297,8 @@ export declare class Plans {
      *         isTrialable: true
      *     })
      */
-    upsertBillingProductPlan(planId: string, request: Schematic.UpsertBillingProductRequestBody, requestOptions?: Plans.RequestOptions): Promise<Schematic.UpsertBillingProductPlanResponse>;
+    upsertBillingProductPlan(planId: string, request: Schematic.UpsertBillingProductRequestBody, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.UpsertBillingProductPlanResponse>;
+    private __upsertBillingProductPlan;
     /**
      * @param {Schematic.CountPlansRequest} request
      * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
@@ -191,12 +306,14 @@ export declare class Plans {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.plans.countPlans()
      */
-    countPlans(request?: Schematic.CountPlansRequest, requestOptions?: Plans.RequestOptions): Promise<Schematic.CountPlansResponse>;
+    countPlans(request?: Schematic.CountPlansRequest, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Schematic.CountPlansResponse>;
+    private __countPlans;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-Schematic-Api-Key": string;
     }>;