@flexprice/sdk 2.0.10 → 2.0.11

package/esm/sdk/webhook-events.d.ts

@@ -0,0 +1,306 @@
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "./models/index.js";
+export declare class WebhookEvents extends ClientSDK {
+    /**
+     * credit_note.created
+     *
+     * @remarks
+     * Fired when a new credit note is created. Doc-only for parsing.
+     */
+    postWebhookEventsCreditNoteCreated(options?: RequestOptions): Promise<models.WebhookDtoCreditNoteWebhookPayload>;
+    /**
+     * credit_note.updated
+     *
+     * @remarks
+     * Fired when a credit note is updated. Doc-only for parsing.
+     */
+    postWebhookEventsCreditNoteUpdated(options?: RequestOptions): Promise<models.WebhookDtoCreditNoteWebhookPayload>;
+    /**
+     * customer.created
+     *
+     * @remarks
+     * Fired when a new customer is created. Doc-only for parsing.
+     */
+    postWebhookEventsCustomerCreated(options?: RequestOptions): Promise<models.WebhookDtoCustomerWebhookPayload>;
+    /**
+     * customer.deleted
+     *
+     * @remarks
+     * Fired when a customer is deleted. Doc-only for parsing.
+     */
+    postWebhookEventsCustomerDeleted(options?: RequestOptions): Promise<models.WebhookDtoCustomerWebhookPayload>;
+    /**
+     * customer.updated
+     *
+     * @remarks
+     * Fired when a customer is updated. Doc-only for parsing.
+     */
+    postWebhookEventsCustomerUpdated(options?: RequestOptions): Promise<models.WebhookDtoCustomerWebhookPayload>;
+    /**
+     * entitlement.created
+     *
+     * @remarks
+     * Fired when a new entitlement is created. Doc-only for parsing.
+     */
+    postWebhookEventsEntitlementCreated(options?: RequestOptions): Promise<models.WebhookDtoEntitlementWebhookPayload>;
+    /**
+     * entitlement.deleted
+     *
+     * @remarks
+     * Fired when an entitlement is deleted. Doc-only for parsing.
+     */
+    postWebhookEventsEntitlementDeleted(options?: RequestOptions): Promise<models.WebhookDtoEntitlementWebhookPayload>;
+    /**
+     * entitlement.updated
+     *
+     * @remarks
+     * Fired when an entitlement is updated. Doc-only for parsing.
+     */
+    postWebhookEventsEntitlementUpdated(options?: RequestOptions): Promise<models.WebhookDtoEntitlementWebhookPayload>;
+    /**
+     * feature.created
+     *
+     * @remarks
+     * Fired when a new feature is created. Doc-only for parsing.
+     */
+    postWebhookEventsFeatureCreated(options?: RequestOptions): Promise<models.WebhookDtoFeatureWebhookPayload>;
+    /**
+     * feature.deleted
+     *
+     * @remarks
+     * Fired when a feature is deleted. Doc-only for parsing.
+     */
+    postWebhookEventsFeatureDeleted(options?: RequestOptions): Promise<models.WebhookDtoFeatureWebhookPayload>;
+    /**
+     * feature.updated
+     *
+     * @remarks
+     * Fired when a feature is updated. Doc-only for parsing.
+     */
+    postWebhookEventsFeatureUpdated(options?: RequestOptions): Promise<models.WebhookDtoFeatureWebhookPayload>;
+    /**
+     * feature.wallet_balance.alert
+     *
+     * @remarks
+     * Fired when a feature's associated wallet balance crosses an alert threshold. Doc-only for parsing.
+     */
+    postWebhookEventsFeatureWalletBalanceAlert(options?: RequestOptions): Promise<models.WebhookDtoAlertWebhookPayload>;
+    /**
+     * invoice.communication.triggered
+     *
+     * @remarks
+     * Fired when an invoice communication (e.g. email notification) is triggered. Doc-only for parsing.
+     */
+    postWebhookEventsInvoiceCommunicationTriggered(options?: RequestOptions): Promise<models.WebhookDtoCommunicationWebhookPayload>;
+    /**
+     * invoice.create.drafted
+     *
+     * @remarks
+     * Fired when a new invoice is created in draft status. Doc-only for parsing.
+     */
+    postWebhookEventsInvoiceCreateDrafted(options?: RequestOptions): Promise<models.WebhookDtoInvoiceWebhookPayload>;
+    /**
+     * invoice.payment.overdue
+     *
+     * @remarks
+     * Fired when an invoice payment is overdue past the due date. Doc-only for parsing.
+     */
+    postWebhookEventsInvoicePaymentOverdue(options?: RequestOptions): Promise<models.WebhookDtoInvoiceWebhookPayload>;
+    /**
+     * invoice.update
+     *
+     * @remarks
+     * Fired when an invoice is updated. Doc-only for parsing.
+     */
+    postWebhookEventsInvoiceUpdate(options?: RequestOptions): Promise<models.WebhookDtoInvoiceWebhookPayload>;
+    /**
+     * invoice.update.finalized
+     *
+     * @remarks
+     * Fired when an invoice is finalized and locked for payment. Doc-only for parsing.
+     */
+    postWebhookEventsInvoiceUpdateFinalized(options?: RequestOptions): Promise<models.WebhookDtoInvoiceWebhookPayload>;
+    /**
+     * invoice.update.payment
+     *
+     * @remarks
+     * Fired when an invoice payment status changes. Doc-only for parsing.
+     */
+    postWebhookEventsInvoiceUpdatePayment(options?: RequestOptions): Promise<models.WebhookDtoInvoiceWebhookPayload>;
+    /**
+     * invoice.update.voided
+     *
+     * @remarks
+     * Fired when an invoice is voided (e.g. order cancelled or duplicate). Doc-only for parsing.
+     */
+    postWebhookEventsInvoiceUpdateVoided(options?: RequestOptions): Promise<models.WebhookDtoInvoiceWebhookPayload>;
+    /**
+     * payment.created
+     *
+     * @remarks
+     * Fired when a new payment is created. Doc-only for parsing.
+     */
+    postWebhookEventsPaymentCreated(options?: RequestOptions): Promise<models.WebhookDtoPaymentWebhookPayload>;
+    /**
+     * payment.failed
+     *
+     * @remarks
+     * Fired when a payment fails. Doc-only for parsing.
+     */
+    postWebhookEventsPaymentFailed(options?: RequestOptions): Promise<models.WebhookDtoPaymentWebhookPayload>;
+    /**
+     * payment.pending
+     *
+     * @remarks
+     * Fired when a payment is pending processing. Doc-only for parsing.
+     */
+    postWebhookEventsPaymentPending(options?: RequestOptions): Promise<models.WebhookDtoPaymentWebhookPayload>;
+    /**
+     * payment.success
+     *
+     * @remarks
+     * Fired when a payment succeeds. Doc-only for parsing.
+     */
+    postWebhookEventsPaymentSuccess(options?: RequestOptions): Promise<models.WebhookDtoPaymentWebhookPayload>;
+    /**
+     * payment.updated
+     *
+     * @remarks
+     * Fired when a payment is updated. Doc-only for parsing.
+     */
+    postWebhookEventsPaymentUpdated(options?: RequestOptions): Promise<models.WebhookDtoPaymentWebhookPayload>;
+    /**
+     * subscription.activated
+     *
+     * @remarks
+     * Fired when a draft subscription is activated. Doc-only for parsing.
+     */
+    postWebhookEventsSubscriptionActivated(options?: RequestOptions): Promise<models.WebhookDtoSubscriptionWebhookPayload>;
+    /**
+     * subscription.cancelled
+     *
+     * @remarks
+     * Fired when a subscription is cancelled (immediately or end-of-period). Doc-only for parsing.
+     */
+    postWebhookEventsSubscriptionCancelled(options?: RequestOptions): Promise<models.WebhookDtoSubscriptionWebhookPayload>;
+    /**
+     * subscription.created
+     *
+     * @remarks
+     * Fired when a new subscription is created. Doc-only for parsing.
+     */
+    postWebhookEventsSubscriptionCreated(options?: RequestOptions): Promise<models.WebhookDtoSubscriptionWebhookPayload>;
+    /**
+     * subscription.draft.created
+     *
+     * @remarks
+     * Fired when a new draft subscription is created (not yet activated). Doc-only for parsing.
+     */
+    postWebhookEventsSubscriptionDraftCreated(options?: RequestOptions): Promise<models.WebhookDtoSubscriptionWebhookPayload>;
+    /**
+     * subscription.paused
+     *
+     * @remarks
+     * Fired when a subscription is paused. Doc-only for parsing.
+     */
+    postWebhookEventsSubscriptionPaused(options?: RequestOptions): Promise<models.WebhookDtoSubscriptionWebhookPayload>;
+    /**
+     * subscription.phase.created
+     *
+     * @remarks
+     * Fired when a new subscription phase is created. Doc-only for parsing.
+     */
+    postWebhookEventsSubscriptionPhaseCreated(options?: RequestOptions): Promise<models.WebhookDtoSubscriptionPhaseWebhookPayload>;
+    /**
+     * subscription.phase.deleted
+     *
+     * @remarks
+     * Fired when a subscription phase is deleted. Doc-only for parsing.
+     */
+    postWebhookEventsSubscriptionPhaseDeleted(options?: RequestOptions): Promise<models.WebhookDtoSubscriptionPhaseWebhookPayload>;
+    /**
+     * subscription.phase.updated
+     *
+     * @remarks
+     * Fired when a subscription phase is updated. Doc-only for parsing.
+     */
+    postWebhookEventsSubscriptionPhaseUpdated(options?: RequestOptions): Promise<models.WebhookDtoSubscriptionPhaseWebhookPayload>;
+    /**
+     * subscription.renewal.due
+     *
+     * @remarks
+     * Fired when a subscription renewal is upcoming (cron-driven). Doc-only for parsing.
+     */
+    postWebhookEventsSubscriptionRenewalDue(options?: RequestOptions): Promise<models.WebhookDtoSubscriptionWebhookPayload>;
+    /**
+     * subscription.resumed
+     *
+     * @remarks
+     * Fired when a paused subscription is resumed. Doc-only for parsing.
+     */
+    postWebhookEventsSubscriptionResumed(options?: RequestOptions): Promise<models.WebhookDtoSubscriptionWebhookPayload>;
+    /**
+     * subscription.updated
+     *
+     * @remarks
+     * Fired when a subscription is updated (e.g. quantity, billing anchor, or metadata changes). Doc-only for parsing.
+     */
+    postWebhookEventsSubscriptionUpdated(options?: RequestOptions): Promise<models.WebhookDtoSubscriptionWebhookPayload>;
+    /**
+     * wallet.created
+     *
+     * @remarks
+     * Fired when a new wallet is created. Doc-only for parsing.
+     */
+    postWebhookEventsWalletCreated(options?: RequestOptions): Promise<models.WebhookDtoWalletWebhookPayload>;
+    /**
+     * wallet.credit_balance.dropped
+     *
+     * @remarks
+     * Fired when a wallet's credit balance drops below an alert threshold. Doc-only for parsing.
+     */
+    postWebhookEventsWalletCreditBalanceDropped(options?: RequestOptions): Promise<models.WebhookDtoWalletWebhookPayload>;
+    /**
+     * wallet.credit_balance.recovered
+     *
+     * @remarks
+     * Fired when a wallet's credit balance recovers above an alert threshold. Doc-only for parsing.
+     */
+    postWebhookEventsWalletCreditBalanceRecovered(options?: RequestOptions): Promise<models.WebhookDtoWalletWebhookPayload>;
+    /**
+     * wallet.ongoing_balance.dropped
+     *
+     * @remarks
+     * Fired when a wallet's ongoing balance drops below an alert threshold. Doc-only for parsing.
+     */
+    postWebhookEventsWalletOngoingBalanceDropped(options?: RequestOptions): Promise<models.WebhookDtoWalletWebhookPayload>;
+    /**
+     * wallet.ongoing_balance.recovered
+     *
+     * @remarks
+     * Fired when a wallet's ongoing balance recovers above an alert threshold. Doc-only for parsing.
+     */
+    postWebhookEventsWalletOngoingBalanceRecovered(options?: RequestOptions): Promise<models.WebhookDtoWalletWebhookPayload>;
+    /**
+     * wallet.terminated
+     *
+     * @remarks
+     * Fired when a wallet is terminated. Doc-only for parsing.
+     */
+    postWebhookEventsWalletTerminated(options?: RequestOptions): Promise<models.WebhookDtoWalletWebhookPayload>;
+    /**
+     * wallet.transaction.created
+     *
+     * @remarks
+     * Fired when a new wallet transaction is created (top-up, deduction, etc.). Doc-only for parsing.
+     */
+    postWebhookEventsWalletTransactionCreated(options?: RequestOptions): Promise<models.WebhookDtoTransactionWebhookPayload>;
+    /**
+     * wallet.updated
+     *
+     * @remarks
+     * Fired when a wallet is updated. Doc-only for parsing.
+     */
+    postWebhookEventsWalletUpdated(options?: RequestOptions): Promise<models.WebhookDtoWalletWebhookPayload>;
+}
+//# sourceMappingURL=webhook-events.d.ts.map

package/esm/sdk/webhook-events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook-events.d.ts","sourceRoot":"","sources":["../../src/sdk/webhook-events.ts"],"names":[],"mappings":"AA+CA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAE3D,OAAO,KAAK,MAAM,MAAM,mBAAmB,CAAC;AAE5C,qBAAa,aAAc,SAAQ,SAAS;IAC1C;;;;;OAKG;IACG,kCAAkC,CACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,kCAAkC,CAAC,CAKpD;IAED;;;;;OAKG;IACG,kCAAkC,CACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,kCAAkC,CAAC,CAKpD;IAED;;;;;OAKG;IACG,gCAAgC,CACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,gCAAgC,CAAC,CAKlD;IAED;;;;;OAKG;IACG,gCAAgC,CACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,gCAAgC,CAAC,CAKlD;IAED;;;;;OAKG;IACG,gCAAgC,CACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,gCAAgC,CAAC,CAKlD;IAED;;;;;OAKG;IACG,mCAAmC,CACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,mCAAmC,CAAC,CAKrD;IAED;;;;;OAKG;IACG,mCAAmC,CACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,mCAAmC,CAAC,CAKrD;IAED;;;;;OAKG;IACG,mCAAmC,CACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,mCAAmC,CAAC,CAKrD;IAED;;;;;OAKG;IACG,+BAA+B,CACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAKjD;IAED;;;;;OAKG;IACG,+BAA+B,CACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAKjD;IAED;;;;;OAKG;IACG,+BAA+B,CACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAKjD;IAED;;;;;OAKG;IACG,0CAA0C,CAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,6BAA6B,CAAC,CAK/C;IAED;;;;;OAKG;IACG,8CAA8C,CAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,qCAAqC,CAAC,CAOvD;IAED;;;;;OAKG;IACG,qCAAqC,CACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAKjD;IAED;;;;;OAKG;IACG,sCAAsC,CAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAKjD;IAED;;;;;OAKG;IACG,8BAA8B,CAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAKjD;IAED;;;;;OAKG;IACG,uCAAuC,CAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAKjD;IAED;;;;;OAKG;IACG,qCAAqC,CACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAKjD;IAED;;;;;OAKG;IACG,oCAAoC,CACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAKjD;IAED;;;;;OAKG;IACG,+BAA+B,CACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAKjD;IAED;;;;;OAKG;IACG,8BAA8B,CAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAKjD;IAED;;;;;OAKG;IACG,+BAA+B,CACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAKjD;IAED;;;;;OAKG;IACG,+BAA+B,CACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAKjD;IAED;;;;;OAKG;IACG,+BAA+B,CACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAKjD;IAED;;;;;OAKG;IACG,sCAAsC,CAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,oCAAoC,CAAC,CAKtD;IAED;;;;;OAKG;IACG,sCAAsC,CAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,oCAAoC,CAAC,CAKtD;IAED;;;;;OAKG;IACG,oCAAoC,CACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,oCAAoC,CAAC,CAKtD;IAED;;;;;OAKG;IACG,yCAAyC,CAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,oCAAoC,CAAC,CAKtD;IAED;;;;;OAKG;IACG,mCAAmC,CACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,oCAAoC,CAAC,CAKtD;IAED;;;;;OAKG;IACG,yCAAyC,CAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,yCAAyC,CAAC,CAK3D;IAED;;;;;OAKG;IACG,yCAAyC,CAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,yCAAyC,CAAC,CAK3D;IAED;;;;;OAKG;IACG,yCAAyC,CAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,yCAAyC,CAAC,CAK3D;IAED;;;;;OAKG;IACG,uCAAuC,CAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,oCAAoC,CAAC,CAKtD;IAED;;;;;OAKG;IACG,oCAAoC,CACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,oCAAoC,CAAC,CAKtD;IAED;;;;;OAKG;IACG,oCAAoC,CACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,oCAAoC,CAAC,CAKtD;IAED;;;;;OAKG;IACG,8BAA8B,CAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,8BAA8B,CAAC,CAKhD;IAED;;;;;OAKG;IACG,2CAA2C,CAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,8BAA8B,CAAC,CAKhD;IAED;;;;;OAKG;IACG,6CAA6C,CACjD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,8BAA8B,CAAC,CAOhD;IAED;;;;;OAKG;IACG,4CAA4C,CAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,8BAA8B,CAAC,CAOhD;IAED;;;;;OAKG;IACG,8CAA8C,CAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,8BAA8B,CAAC,CAOhD;IAED;;;;;OAKG;IACG,iCAAiC,CACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,8BAA8B,CAAC,CAKhD;IAED;;;;;OAKG;IACG,yCAAyC,CAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,mCAAmC,CAAC,CAKrD;IAED;;;;;OAKG;IACG,8BAA8B,CAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,8BAA8B,CAAC,CAKhD;CACF"}