@schematichq/schematic-typescript-node 1.1.9 → 1.1.11

package/dist/api/resources/accounts/types/CreateEnvironmentRequestBodyEnvironmentType.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type CreateEnvironmentRequestBodyEnvironmentType = "development" | "staging" | "production";
+export type CreateEnvironmentRequestBodyEnvironmentType = "development" | "staging" | "production";
 export declare const CreateEnvironmentRequestBodyEnvironmentType: {
     readonly Development: "development";
     readonly Staging: "staging";

package/dist/api/resources/accounts/types/QuickstartResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../../../index";
+export interface QuickstartResponse {
+    data: Schematic.QuickstartResp;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/accounts/types/QuickstartResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/accounts/types/UpdateEnvironmentRequestBodyEnvironmentType.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type UpdateEnvironmentRequestBodyEnvironmentType = "development" | "staging" | "production";
+export type UpdateEnvironmentRequestBodyEnvironmentType = "development" | "staging" | "production";
 export declare const UpdateEnvironmentRequestBodyEnvironmentType: {
     readonly Development: "development";
     readonly Staging: "staging";

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

@@ -19,3 +19,4 @@ export * from "./GetEnvironmentResponse";
 export * from "./UpdateEnvironmentRequestBodyEnvironmentType";
 export * from "./UpdateEnvironmentResponse";
 export * from "./DeleteEnvironmentResponse";
+export * from "./QuickstartResponse";

package/dist/api/resources/accounts/types/index.js

@@ -35,3 +35,4 @@ __exportStar(require("./GetEnvironmentResponse"), exports);
 __exportStar(require("./UpdateEnvironmentRequestBodyEnvironmentType"), exports);
 __exportStar(require("./UpdateEnvironmentResponse"), exports);
 __exportStar(require("./DeleteEnvironmentResponse"), exports);
+__exportStar(require("./QuickstartResponse"), exports);

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

@@ -7,6 +7,8 @@ import * as Schematic from "../../../index";
 export declare namespace Billing {
     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,11 +19,28 @@ export declare namespace Billing {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class Billing {
     protected readonly _options: Billing.Options;
     constructor(_options: Billing.Options);
+    /**
+     * @param {Schematic.ListCouponsRequest} request
+     * @param {Billing.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.billing.listCoupons()
+     */
+    listCoupons(request?: Schematic.ListCouponsRequest, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.ListCouponsResponse>;
+    private __listCoupons;
     /**
      * @param {Schematic.CreateCouponRequestBody} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -29,6 +48,7 @@ export declare class Billing {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -43,7 +63,8 @@ export declare class Billing {
      *         timesRedeemed: 1
      *     })
      */
-    upsertBillingCoupon(request: Schematic.CreateCouponRequestBody, requestOptions?: Billing.RequestOptions): Promise<Schematic.UpsertBillingCouponResponse>;
+    upsertBillingCoupon(request: Schematic.CreateCouponRequestBody, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.UpsertBillingCouponResponse>;
+    private __upsertBillingCoupon;
     /**
      * @param {Schematic.CreateBillingCustomerRequestBody} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -51,6 +72,7 @@ export declare class Billing {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -64,20 +86,23 @@ export declare class Billing {
      *         name: "name"
      *     })
      */
-    upsertBillingCustomer(request: Schematic.CreateBillingCustomerRequestBody, requestOptions?: Billing.RequestOptions): Promise<Schematic.UpsertBillingCustomerResponse>;
+    upsertBillingCustomer(request: Schematic.CreateBillingCustomerRequestBody, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.UpsertBillingCustomerResponse>;
+    private __upsertBillingCustomer;
     /**
-     * @param {Schematic.ListCustomersRequest} request
+     * @param {Schematic.ListCustomersWithSubscriptionsRequest} request
      * @param {Billing.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.billing.listCustomers()
+     *     await client.billing.listCustomersWithSubscriptions()
      */
-    listCustomers(request?: Schematic.ListCustomersRequest, requestOptions?: Billing.RequestOptions): Promise<Schematic.ListCustomersResponse>;
+    listCustomersWithSubscriptions(request?: Schematic.ListCustomersWithSubscriptionsRequest, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.ListCustomersWithSubscriptionsResponse>;
+    private __listCustomersWithSubscriptions;
     /**
      * @param {Schematic.CountCustomersRequest} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -85,12 +110,14 @@ export declare class Billing {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.billing.countCustomers()
      */
-    countCustomers(request?: Schematic.CountCustomersRequest, requestOptions?: Billing.RequestOptions): Promise<Schematic.CountCustomersResponse>;
+    countCustomers(request?: Schematic.CountCustomersRequest, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.CountCustomersResponse>;
+    private __countCustomers;
     /**
      * @param {Schematic.ListInvoicesRequest} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -98,6 +125,7 @@ export declare class Billing {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -105,7 +133,8 @@ export declare class Billing {
      *         customerExternalId: "customer_external_id"
      *     })
      */
-    listInvoices(request: Schematic.ListInvoicesRequest, requestOptions?: Billing.RequestOptions): Promise<Schematic.ListInvoicesResponse>;
+    listInvoices(request: Schematic.ListInvoicesRequest, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.ListInvoicesResponse>;
+    private __listInvoices;
     /**
      * @param {Schematic.CreateInvoiceRequestBody} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -113,6 +142,7 @@ export declare class Billing {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -126,7 +156,8 @@ export declare class Billing {
      *         subtotal: 1
      *     })
      */
-    upsertInvoice(request: Schematic.CreateInvoiceRequestBody, requestOptions?: Billing.RequestOptions): Promise<Schematic.UpsertInvoiceResponse>;
+    upsertInvoice(request: Schematic.CreateInvoiceRequestBody, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.UpsertInvoiceResponse>;
+    private __upsertInvoice;
     /**
      * @param {Schematic.ListMetersRequest} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -134,12 +165,14 @@ export declare class Billing {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.billing.listMeters()
      */
-    listMeters(request?: Schematic.ListMetersRequest, requestOptions?: Billing.RequestOptions): Promise<Schematic.ListMetersResponse>;
+    listMeters(request?: Schematic.ListMetersRequest, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.ListMetersResponse>;
+    private __listMeters;
     /**
      * @param {Schematic.CreateMeterRequestBody} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -147,6 +180,7 @@ export declare class Billing {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -157,7 +191,8 @@ export declare class Billing {
      *         externalId: "external_id"
      *     })
      */
-    upsertBillingMeter(request: Schematic.CreateMeterRequestBody, requestOptions?: Billing.RequestOptions): Promise<Schematic.UpsertBillingMeterResponse>;
+    upsertBillingMeter(request: Schematic.CreateMeterRequestBody, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.UpsertBillingMeterResponse>;
+    private __upsertBillingMeter;
     /**
      * @param {Schematic.ListPaymentMethodsRequest} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -165,6 +200,7 @@ export declare class Billing {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -172,7 +208,8 @@ export declare class Billing {
      *         customerExternalId: "customer_external_id"
      *     })
      */
-    listPaymentMethods(request: Schematic.ListPaymentMethodsRequest, requestOptions?: Billing.RequestOptions): Promise<Schematic.ListPaymentMethodsResponse>;
+    listPaymentMethods(request: Schematic.ListPaymentMethodsRequest, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.ListPaymentMethodsResponse>;
+    private __listPaymentMethods;
     /**
      * @param {Schematic.CreatePaymentMethodRequestBody} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -180,6 +217,7 @@ export declare class Billing {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -189,7 +227,8 @@ export declare class Billing {
      *         paymentMethodType: "payment_method_type"
      *     })
      */
-    upsertPaymentMethod(request: Schematic.CreatePaymentMethodRequestBody, requestOptions?: Billing.RequestOptions): Promise<Schematic.UpsertPaymentMethodResponse>;
+    upsertPaymentMethod(request: Schematic.CreatePaymentMethodRequestBody, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.UpsertPaymentMethodResponse>;
+    private __upsertPaymentMethod;
     /**
      * @param {Schematic.SearchBillingPricesRequest} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -197,12 +236,14 @@ export declare class Billing {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.billing.searchBillingPrices()
      */
-    searchBillingPrices(request?: Schematic.SearchBillingPricesRequest, requestOptions?: Billing.RequestOptions): Promise<Schematic.SearchBillingPricesResponse>;
+    searchBillingPrices(request?: Schematic.SearchBillingPricesRequest, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.SearchBillingPricesResponse>;
+    private __searchBillingPrices;
     /**
      * @param {Schematic.CreateBillingPriceRequestBody} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -210,20 +251,42 @@ export declare class Billing {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.billing.upsertBillingPrice({
+     *         billingScheme: "per_unit",
      *         currency: "currency",
+     *         externalAccountId: "external_account_id",
      *         interval: "interval",
      *         isActive: true,
      *         price: 1,
      *         priceExternalId: "price_external_id",
+     *         priceTiers: [{
+     *                 priceExternalId: "price_external_id"
+     *             }],
      *         productExternalId: "product_external_id",
-     *         usageType: "usage_type"
+     *         usageType: "licensed"
      *     })
      */
-    upsertBillingPrice(request: Schematic.CreateBillingPriceRequestBody, requestOptions?: Billing.RequestOptions): Promise<Schematic.UpsertBillingPriceResponse>;
+    upsertBillingPrice(request: Schematic.CreateBillingPriceRequestBody, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.UpsertBillingPriceResponse>;
+    private __upsertBillingPrice;
+    /**
+     * @param {string} billingId - billing_id
+     * @param {Billing.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.billing.deleteBillingProduct("billing_id")
+     */
+    deleteBillingProduct(billingId: string, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.DeleteBillingProductResponse>;
+    private __deleteBillingProduct;
     /**
      * @param {Schematic.ListProductPricesRequest} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -231,12 +294,14 @@ export declare class Billing {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.billing.listProductPrices()
      */
-    listProductPrices(request?: Schematic.ListProductPricesRequest, requestOptions?: Billing.RequestOptions): Promise<Schematic.ListProductPricesResponse>;
+    listProductPrices(request?: Schematic.ListProductPricesRequest, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.ListProductPricesResponse>;
+    private __listProductPrices;
     /**
      * @param {string} billingId - billing_id
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -244,12 +309,14 @@ export declare class Billing {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.billing.deleteProductPrice("billing_id")
      */
-    deleteProductPrice(billingId: string, requestOptions?: Billing.RequestOptions): Promise<Schematic.DeleteProductPriceResponse>;
+    deleteProductPrice(billingId: string, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.DeleteProductPriceResponse>;
+    private __deleteProductPrice;
     /**
      * @param {Schematic.CreateBillingProductRequestBody} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -257,18 +324,18 @@ export declare class Billing {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.billing.upsertBillingProduct({
-     *         currency: "currency",
      *         externalId: "external_id",
      *         name: "name",
-     *         price: 1.1,
-     *         quantity: 1
+     *         price: 1.1
      *     })
      */
-    upsertBillingProduct(request: Schematic.CreateBillingProductRequestBody, requestOptions?: Billing.RequestOptions): Promise<Schematic.UpsertBillingProductResponse>;
+    upsertBillingProduct(request: Schematic.CreateBillingProductRequestBody, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.UpsertBillingProductResponse>;
+    private __upsertBillingProduct;
     /**
      * @param {Schematic.ListBillingProductsRequest} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -276,12 +343,14 @@ export declare class Billing {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.billing.listBillingProducts()
      */
-    listBillingProducts(request?: Schematic.ListBillingProductsRequest, requestOptions?: Billing.RequestOptions): Promise<Schematic.ListBillingProductsResponse>;
+    listBillingProducts(request?: Schematic.ListBillingProductsRequest, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.ListBillingProductsResponse>;
+    private __listBillingProducts;
     /**
      * @param {Schematic.CountBillingProductsRequest} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -289,12 +358,14 @@ export declare class Billing {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.billing.countBillingProducts()
      */
-    countBillingProducts(request?: Schematic.CountBillingProductsRequest, requestOptions?: Billing.RequestOptions): Promise<Schematic.CountBillingProductsResponse>;
+    countBillingProducts(request?: Schematic.CountBillingProductsRequest, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.CountBillingProductsResponse>;
+    private __countBillingProducts;
     /**
      * @param {Schematic.CreateBillingSubscriptionsRequestBody} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -302,10 +373,12 @@ export declare class Billing {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.billing.upsertBillingSubscription({
+     *         cancelAtPeriodEnd: true,
      *         currency: "currency",
      *         customerExternalId: "customer_external_id",
      *         discounts: [{
@@ -322,13 +395,14 @@ export declare class Billing {
      *                 priceExternalId: "price_external_id",
      *                 productExternalId: "product_external_id",
      *                 quantity: 1,
-     *                 usageType: "usage_type"
+     *                 usageType: "licensed"
      *             }],
      *         subscriptionExternalId: "subscription_external_id",
      *         totalPrice: 1
      *     })
      */
-    upsertBillingSubscription(request: Schematic.CreateBillingSubscriptionsRequestBody, requestOptions?: Billing.RequestOptions): Promise<Schematic.UpsertBillingSubscriptionResponse>;
+    upsertBillingSubscription(request: Schematic.CreateBillingSubscriptionsRequestBody, requestOptions?: Billing.RequestOptions): core.HttpResponsePromise<Schematic.UpsertBillingSubscriptionResponse>;
+    private __upsertBillingSubscription;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-Schematic-Api-Key": string;
     }>;