@schematichq/schematic-typescript-node 1.1.11 → 1.1.12

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

@@ -0,0 +1,338 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Schematic from "../../../index";
+export declare namespace Credits {
+    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;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Credits {
+    protected readonly _options: Credits.Options;
+    constructor(_options: Credits.Options);
+    /**
+     * @param {Schematic.ListBillingCreditsRequest} 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.listBillingCredits()
+     */
+    listBillingCredits(request?: Schematic.ListBillingCreditsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ListBillingCreditsResponse>;
+    private __listBillingCredits;
+    /**
+     * @param {Schematic.CreateBillingCreditRequestBody} 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.createBillingCredit({
+     *         currency: "currency",
+     *         description: "description",
+     *         name: "name"
+     *     })
+     */
+    createBillingCredit(request: Schematic.CreateBillingCreditRequestBody, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CreateBillingCreditResponse>;
+    private __createBillingCredit;
+    /**
+     * @param {string} billingId - billing_id
+     * @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.credits.getSingleBillingCredit("billing_id")
+     */
+    getSingleBillingCredit(billingId: string, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.GetSingleBillingCreditResponse>;
+    private __getSingleBillingCredit;
+    /**
+     * @param {string} billingId - billing_id
+     * @param {Schematic.UpdateBillingCreditRequestBody} 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.updateBillingCredit("billing_id", {
+     *         description: "description",
+     *         name: "name"
+     *     })
+     */
+    updateBillingCredit(billingId: string, request: Schematic.UpdateBillingCreditRequestBody, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.UpdateBillingCreditResponse>;
+    private __updateBillingCredit;
+    /**
+     * @param {Schematic.ListCreditBundlesRequest} 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.listCreditBundles()
+     */
+    listCreditBundles(request?: Schematic.ListCreditBundlesRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ListCreditBundlesResponse>;
+    private __listCreditBundles;
+    /**
+     * @param {Schematic.CreateCreditBundleRequestBody} 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.createCreditBundle({
+     *         creditId: "credit_id",
+     *         currency: "currency",
+     *         pricePerUnit: 1
+     *     })
+     */
+    createCreditBundle(request: Schematic.CreateCreditBundleRequestBody, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CreateCreditBundleResponse>;
+    private __createCreditBundle;
+    /**
+     * @param {string} billingId - billing_id
+     * @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.credits.getCreditBundle("billing_id")
+     */
+    getCreditBundle(billingId: string, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.GetCreditBundleResponse>;
+    private __getCreditBundle;
+    /**
+     * @param {string} billingId - billing_id
+     * @param {Schematic.UpdateCreditBundleRequestBody} 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.updateCreditBundle("billing_id", {
+     *         bundleId: "bundle_id",
+     *         quantity: 1
+     *     })
+     */
+    updateCreditBundle(billingId: string, request: Schematic.UpdateCreditBundleRequestBody, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.UpdateCreditBundleResponse>;
+    private __updateCreditBundle;
+    /**
+     * @param {string} billingId - billing_id
+     * @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.deleteCreditBundle("billing_id")
+     */
+    deleteCreditBundle(billingId: string, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.DeleteCreditBundleResponse>;
+    private __deleteCreditBundle;
+    /**
+     * @param {Schematic.CountCreditBundlesRequest} 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.countCreditBundles()
+     */
+    countCreditBundles(request?: Schematic.CountCreditBundlesRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CountCreditBundlesResponse>;
+    private __countCreditBundles;
+    /**
+     * @param {Schematic.CountBillingCreditsRequest} 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.countBillingCredits()
+     */
+    countBillingCredits(request?: Schematic.CountBillingCreditsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CountBillingCreditsResponse>;
+    private __countBillingCredits;
+    /**
+     * @param {string} billingId - billing_id
+     * @param {Schematic.ZeroOutGrantRequestBody} 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.zeroOutGrant("billing_id")
+     */
+    zeroOutGrant(billingId: string, request?: Schematic.ZeroOutGrantRequestBody, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ZeroOutGrantResponse>;
+    private __zeroOutGrant;
+    /**
+     * @param {Schematic.ListCompanyGrantsRequest} 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.listCompanyGrants()
+     */
+    listCompanyGrants(request?: Schematic.ListCompanyGrantsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyGrantsResponse>;
+    private __listCompanyGrants;
+    /**
+     * @param {Schematic.CountBillingCreditsGrantsRequest} 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.countBillingCreditsGrants()
+     */
+    countBillingCreditsGrants(request?: Schematic.CountBillingCreditsGrantsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CountBillingCreditsGrantsResponse>;
+    private __countBillingCreditsGrants;
+    /**
+     * @param {Schematic.ListGrantsForCreditRequest} 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.listGrantsForCredit()
+     */
+    listGrantsForCredit(request?: Schematic.ListGrantsForCreditRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ListGrantsForCreditResponse>;
+    private __listGrantsForCredit;
+    /**
+     * @param {Schematic.ListBillingPlanCreditGrantsRequest} 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.listBillingPlanCreditGrants()
+     */
+    listBillingPlanCreditGrants(request?: Schematic.ListBillingPlanCreditGrantsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ListBillingPlanCreditGrantsResponse>;
+    private __listBillingPlanCreditGrants;
+    /**
+     * @param {Schematic.CreateBillingPlanCreditGrantRequestBody} 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.createBillingPlanCreditGrant({
+     *         creditAmount: 1,
+     *         creditId: "credit_id",
+     *         planId: "plan_id",
+     *         resetCadence: "monthly",
+     *         resetStart: "billing_period"
+     *     })
+     */
+    createBillingPlanCreditGrant(request: Schematic.CreateBillingPlanCreditGrantRequestBody, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CreateBillingPlanCreditGrantResponse>;
+    private __createBillingPlanCreditGrant;
+    /**
+     * @param {string} billingId - billing_id
+     * @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("billing_id")
+     */
+    deleteBillingPlanCreditGrant(billingId: string, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.DeleteBillingPlanCreditGrantResponse>;
+    private __deleteBillingPlanCreditGrant;
+    /**
+     * @param {Schematic.CountBillingPlanCreditGrantsRequest} 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.countBillingPlanCreditGrants()
+     */
+    countBillingPlanCreditGrants(request?: Schematic.CountBillingPlanCreditGrantsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CountBillingPlanCreditGrantsResponse>;
+    private __countBillingPlanCreditGrants;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "X-Schematic-Api-Key": string;
+    }>;
+}