@schematichq/schematic-typescript-node 1.1.4 → 1.1.6

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

@@ -70,19 +70,22 @@ export declare class Billing {
      */
     countCustomers(request?: Schematic.CountCustomersRequest, requestOptions?: Billing.RequestOptions): Promise<Schematic.CountCustomersResponse>;
     /**
+     * @param {Schematic.ListInvoicesRequest} 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.getBillingPlanGroupByAccountId()
+     *     await client.billing.listInvoices({
+     *         customerExternalId: "customer_external_id"
+     *     })
      */
-    getBillingPlanGroupByAccountId(requestOptions?: Billing.RequestOptions): Promise<Schematic.GetBillingPlanGroupByAccountIdResponse>;
+    listInvoices(request: Schematic.ListInvoicesRequest, requestOptions?: Billing.RequestOptions): Promise<Schematic.ListInvoicesResponse>;
     /**
-     * @param {Schematic.CreateBillingPlanGroupRequestBody} request
+     * @param {Schematic.CreateInvoiceRequestBody} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Schematic.BadRequestError}
@@ -91,28 +94,93 @@ export declare class Billing {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.billing.createBillingPlanGroup({
-     *         planIds: ["plan_ids"]
+     *     await client.billing.upsertInvoice({
+     *         amountDue: 1,
+     *         amountPaid: 1,
+     *         amountRemaining: 1,
+     *         collectionMethod: "collection_method",
+     *         currency: "currency",
+     *         customerExternalId: "customer_external_id",
+     *         subtotal: 1
      *     })
      */
-    createBillingPlanGroup(request: Schematic.CreateBillingPlanGroupRequestBody, requestOptions?: Billing.RequestOptions): Promise<Schematic.CreateBillingPlanGroupResponse>;
+    upsertInvoice(request: Schematic.CreateInvoiceRequestBody, requestOptions?: Billing.RequestOptions): Promise<Schematic.UpsertInvoiceResponse>;
     /**
-     * @param {string} billingId - billing_id
-     * @param {Schematic.UpdateBillingPlanGroupRequestBody} request
+     * @param {Schematic.ListMetersRequest} 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.updateBillingPlanGroup("billing_id", {
-     *         planIds: ["plan_ids"]
+     *     await client.billing.listMeters()
+     */
+    listMeters(request?: Schematic.ListMetersRequest, requestOptions?: Billing.RequestOptions): Promise<Schematic.ListMetersResponse>;
+    /**
+     * @param {Schematic.CreateMeterRequestBody} request
+     * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.BadRequestError}
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.billing.upsertBillingMeter({
+     *         displayName: "display_name",
+     *         eventName: "event_name",
+     *         eventPayloadKey: "event_payload_key",
+     *         externalId: "external_id"
      *     })
      */
-    updateBillingPlanGroup(billingId: string, request: Schematic.UpdateBillingPlanGroupRequestBody, requestOptions?: Billing.RequestOptions): Promise<Schematic.UpdateBillingPlanGroupResponse>;
+    upsertBillingMeter(request: Schematic.CreateMeterRequestBody, requestOptions?: Billing.RequestOptions): Promise<Schematic.UpsertBillingMeterResponse>;
+    /**
+     * @param {Schematic.ListPaymentMethodsRequest} request
+     * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.BadRequestError}
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.billing.listPaymentMethods({
+     *         customerExternalId: "customer_external_id"
+     *     })
+     */
+    listPaymentMethods(request: Schematic.ListPaymentMethodsRequest, requestOptions?: Billing.RequestOptions): Promise<Schematic.ListPaymentMethodsResponse>;
+    /**
+     * @param {Schematic.CreatePaymentMethodRequestBody} request
+     * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.BadRequestError}
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.billing.upsertPaymentMethod({
+     *         customerExternalId: "customer_external_id",
+     *         externalId: "external_id",
+     *         paymentMethodType: "payment_method_type"
+     *     })
+     */
+    upsertPaymentMethod(request: Schematic.CreatePaymentMethodRequestBody, requestOptions?: Billing.RequestOptions): Promise<Schematic.UpsertPaymentMethodResponse>;
+    /**
+     * @param {Schematic.SearchBillingPricesRequest} request
+     * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.BadRequestError}
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.billing.searchBillingPrices()
+     */
+    searchBillingPrices(request?: Schematic.SearchBillingPricesRequest, requestOptions?: Billing.RequestOptions): Promise<Schematic.SearchBillingPricesResponse>;
     /**
      * @param {Schematic.CreateBillingPriceRequestBody} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -124,10 +192,12 @@ export declare class Billing {
      *
      * @example
      *     await client.billing.upsertBillingPrice({
+     *         currency: "currency",
      *         interval: "interval",
      *         price: 1,
      *         priceExternalId: "price_external_id",
-     *         productExternalId: "product_external_id"
+     *         productExternalId: "product_external_id",
+     *         usageType: "usage_type"
      *     })
      */
     upsertBillingPrice(request: Schematic.CreateBillingPriceRequestBody, requestOptions?: Billing.RequestOptions): Promise<Schematic.UpsertBillingPriceResponse>;
@@ -144,6 +214,19 @@ export declare class Billing {
      *     await client.billing.listProductPrices()
      */
     listProductPrices(request?: Schematic.ListProductPricesRequest, requestOptions?: Billing.RequestOptions): Promise<Schematic.ListProductPricesResponse>;
+    /**
+     * @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.InternalServerError}
+     *
+     * @example
+     *     await client.billing.deleteProductPrice("billing_id")
+     */
+    deleteProductPrice(billingId: string, requestOptions?: Billing.RequestOptions): Promise<Schematic.DeleteProductPriceResponse>;
     /**
      * @param {Schematic.CreateBillingProductRequestBody} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
@@ -177,7 +260,7 @@ export declare class Billing {
      */
     listBillingProducts(request?: Schematic.ListBillingProductsRequest, requestOptions?: Billing.RequestOptions): Promise<Schematic.ListBillingProductsResponse>;
     /**
-     * @param {Schematic.CreateBillingSubscriptionsRequestBody} request
+     * @param {Schematic.CountBillingProductsRequest} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Schematic.BadRequestError}
@@ -186,20 +269,11 @@ export declare class Billing {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.billing.upsertBillingSubscription({
-     *         customerExternalId: "customer_external_id",
-     *         expiredAt: new Date("2024-01-15T09:30:00.000Z"),
-     *         productExternalIds: [{
-     *                 price: 1,
-     *                 productExternalId: "product_external_id"
-     *             }],
-     *         subscriptionExternalId: "subscription_external_id",
-     *         totalPrice: 1
-     *     })
+     *     await client.billing.countBillingProducts()
      */
-    upsertBillingSubscription(request: Schematic.CreateBillingSubscriptionsRequestBody, requestOptions?: Billing.RequestOptions): Promise<Schematic.UpsertBillingSubscriptionResponse>;
+    countBillingProducts(request?: Schematic.CountBillingProductsRequest, requestOptions?: Billing.RequestOptions): Promise<Schematic.CountBillingProductsResponse>;
     /**
-     * @param {Schematic.ChangeSubscriptionRequestBody} request
+     * @param {Schematic.CreateBillingSubscriptionsRequestBody} request
      * @param {Billing.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Schematic.BadRequestError}
@@ -208,13 +282,24 @@ export declare class Billing {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.billing.changeSubscriptionWeb({
-     *         action: "action",
-     *         newPlanId: "new_plan_id",
-     *         newPriceId: "new_price_id"
+     *     await client.billing.upsertBillingSubscription({
+     *         currency: "currency",
+     *         customerExternalId: "customer_external_id",
+     *         expiredAt: "2024-01-15T09:30:00Z",
+     *         productExternalIds: [{
+     *                 currency: "currency",
+     *                 interval: "interval",
+     *                 price: 1,
+     *                 priceExternalId: "price_external_id",
+     *                 productExternalId: "product_external_id",
+     *                 quantity: 1,
+     *                 usageType: "usage_type"
+     *             }],
+     *         subscriptionExternalId: "subscription_external_id",
+     *         totalPrice: 1
      *     })
      */
-    changeSubscriptionWeb(request: Schematic.ChangeSubscriptionRequestBody, requestOptions?: Billing.RequestOptions): Promise<Schematic.ChangeSubscriptionWebResponse>;
+    upsertBillingSubscription(request: Schematic.CreateBillingSubscriptionsRequestBody, requestOptions?: Billing.RequestOptions): Promise<Schematic.UpsertBillingSubscriptionResponse>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-Schematic-Api-Key": string;
     }>;