@flexprice/sdk 2.0.10 → 2.0.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/sdk/models/cancellation-type.md +2 -2
- package/docs/sdk/models/dto-cancel-subscription-request.md +8 -7
- package/docs/sdk/models/dto-create-customer-request.md +17 -17
- package/docs/sdk/models/dto-create-subscription-request.md +41 -39
- package/docs/sdk/models/dto-customer-response.md +22 -22
- package/docs/sdk/models/dto-update-customer-request.md +15 -15
- package/docs/sdk/models/github-com-flexprice-flexprice-internal-domain-customer-customer.md +21 -21
- package/docs/sdk/models/webhook-dto-alert-webhook-payload.md +32 -0
- package/docs/sdk/models/webhook-dto-communication-webhook-payload.md +27 -0
- package/docs/sdk/models/webhook-dto-credit-note-webhook-payload.md +37 -0
- package/docs/sdk/models/webhook-dto-customer-webhook-payload.md +16 -0
- package/docs/sdk/models/webhook-dto-entitlement-webhook-payload.md +48 -0
- package/docs/sdk/models/webhook-dto-feature-webhook-payload.md +28 -0
- package/docs/sdk/models/webhook-dto-invoice-webhook-payload.md +27 -0
- package/docs/sdk/models/webhook-dto-payment-webhook-payload.md +16 -0
- package/docs/sdk/models/webhook-dto-subscription-phase-webhook-payload.md +16 -0
- package/docs/sdk/models/webhook-dto-subscription-webhook-payload.md +25 -0
- package/docs/sdk/models/webhook-dto-transaction-webhook-payload.md +17 -0
- package/docs/sdk/models/webhook-dto-wallet-alert-info.md +19 -0
- package/docs/sdk/models/webhook-dto-wallet-webhook-payload.md +18 -0
- package/docs/sdk/models/window-size.md +2 -2
- package/docs/sdks/webhookevents/README.md +2973 -0
- package/esm/funcs/addons-delete-addon.js.map +1 -1
- package/esm/funcs/addons-get-addon-by-lookup-key.js.map +1 -1
- package/esm/funcs/addons-get-addon.js.map +1 -1
- package/esm/funcs/addons-update-addon.js.map +1 -1
- package/esm/funcs/costs-delete-costsheet.js.map +1 -1
- package/esm/funcs/costs-get-costsheet.js.map +1 -1
- package/esm/funcs/costs-update-costsheet.js.map +1 -1
- package/esm/funcs/coupons-delete-coupon.js.map +1 -1
- package/esm/funcs/coupons-get-coupon.js.map +1 -1
- package/esm/funcs/coupons-update-coupon.js.map +1 -1
- package/esm/funcs/credit-grants-delete-credit-grant.js.map +1 -1
- package/esm/funcs/credit-grants-get-credit-grant.js.map +1 -1
- package/esm/funcs/credit-grants-get-plan-credit-grants.js.map +1 -1
- package/esm/funcs/credit-grants-update-credit-grant.js.map +1 -1
- package/esm/funcs/credit-notes-get-credit-note.js.map +1 -1
- package/esm/funcs/credit-notes-process-credit-note.js.map +1 -1
- package/esm/funcs/credit-notes-void-credit-note.js.map +1 -1
- package/esm/funcs/customers-delete-customer.js.map +1 -1
- package/esm/funcs/customers-get-customer-by-external-id.js.map +1 -1
- package/esm/funcs/customers-get-customer-entitlements.js.map +1 -1
- package/esm/funcs/customers-get-customer-upcoming-grants.js.map +1 -1
- package/esm/funcs/customers-get-customer.js.map +1 -1
- package/esm/funcs/entitlements-delete-entitlement.js.map +1 -1
- package/esm/funcs/entitlements-get-addon-entitlements.js.map +1 -1
- package/esm/funcs/entitlements-get-entitlement.js.map +1 -1
- package/esm/funcs/entitlements-get-plan-entitlements.js.map +1 -1
- package/esm/funcs/entitlements-update-entitlement.js.map +1 -1
- package/esm/funcs/entity-integration-mappings-delete-entity-integration-mapping.js.map +1 -1
- package/esm/funcs/events-get-event.js.map +1 -1
- package/esm/funcs/features-delete-feature.js.map +1 -1
- package/esm/funcs/features-update-feature.js.map +1 -1
- package/esm/funcs/groups-delete-group.js.map +1 -1
- package/esm/funcs/groups-get-group.js.map +1 -1
- package/esm/funcs/integrations-create-or-update-integration.js.map +1 -1
- package/esm/funcs/integrations-delete-integration.js.map +1 -1
- package/esm/funcs/integrations-get-integration.js.map +1 -1
- package/esm/funcs/invoices-attempt-invoice-payment.js.map +1 -1
- package/esm/funcs/invoices-finalize-invoice.js.map +1 -1
- package/esm/funcs/invoices-get-customer-invoice-summary.js.map +1 -1
- package/esm/funcs/invoices-get-invoice-pdf.js.map +1 -1
- package/esm/funcs/invoices-get-invoice.js.map +1 -1
- package/esm/funcs/invoices-recalculate-invoice-v2.js.map +1 -1
- package/esm/funcs/invoices-recalculate-invoice.js.map +1 -1
- package/esm/funcs/invoices-trigger-invoice-comms-webhook.js.map +1 -1
- package/esm/funcs/invoices-update-invoice-payment-status.js.map +1 -1
- package/esm/funcs/invoices-update-invoice.js.map +1 -1
- package/esm/funcs/invoices-void-invoice.js.map +1 -1
- package/esm/funcs/payments-delete-payment.js.map +1 -1
- package/esm/funcs/payments-get-payment.js.map +1 -1
- package/esm/funcs/payments-process-payment.js.map +1 -1
- package/esm/funcs/payments-update-payment.js.map +1 -1
- package/esm/funcs/plans-delete-plan.js.map +1 -1
- package/esm/funcs/plans-get-plan.js.map +1 -1
- package/esm/funcs/plans-post-plans-id-clone.js.map +1 -1
- package/esm/funcs/plans-sync-plan-prices.js.map +1 -1
- package/esm/funcs/plans-update-plan.js.map +1 -1
- package/esm/funcs/price-units-delete-price-unit.js.map +1 -1
- package/esm/funcs/price-units-get-price-unit-by-code.js.map +1 -1
- package/esm/funcs/price-units-get-price-unit.js.map +1 -1
- package/esm/funcs/price-units-update-price-unit.js.map +1 -1
- package/esm/funcs/prices-delete-price.js.map +1 -1
- package/esm/funcs/prices-get-price-by-lookup-key.js.map +1 -1
- package/esm/funcs/prices-get-price.js.map +1 -1
- package/esm/funcs/prices-update-price.js.map +1 -1
- package/esm/funcs/rbac-get-rbac-role.js.map +1 -1
- package/esm/funcs/scheduled-tasks-delete-scheduled-task.js.map +1 -1
- package/esm/funcs/scheduled-tasks-get-scheduled-task.js.map +1 -1
- package/esm/funcs/scheduled-tasks-trigger-scheduled-task-run.js.map +1 -1
- package/esm/funcs/scheduled-tasks-update-scheduled-task.js.map +1 -1
- package/esm/funcs/secrets-delete-api-key.js.map +1 -1
- package/esm/funcs/subscriptions-activate-subscription.js.map +1 -1
- package/esm/funcs/subscriptions-cancel-subscription-schedule.js.map +1 -1
- package/esm/funcs/subscriptions-cancel-subscription.js.map +1 -1
- package/esm/funcs/subscriptions-create-subscription-line-item.js.map +1 -1
- package/esm/funcs/subscriptions-delete-subscription-line-item.js.map +1 -1
- package/esm/funcs/subscriptions-execute-subscription-change.js.map +1 -1
- package/esm/funcs/subscriptions-get-subscription-addon-associations.js.map +1 -1
- package/esm/funcs/subscriptions-get-subscription-entitlements.js.map +1 -1
- package/esm/funcs/subscriptions-get-subscription-schedule.js.map +1 -1
- package/esm/funcs/subscriptions-get-subscription-upcoming-grants.js.map +1 -1
- package/esm/funcs/subscriptions-get-subscription-v2.js.map +1 -1
- package/esm/funcs/subscriptions-get-subscription.js.map +1 -1
- package/esm/funcs/subscriptions-list-subscription-pauses.js.map +1 -1
- package/esm/funcs/subscriptions-list-subscription-schedules.js.map +1 -1
- package/esm/funcs/subscriptions-pause-subscription.js.map +1 -1
- package/esm/funcs/subscriptions-preview-subscription-change.js.map +1 -1
- package/esm/funcs/subscriptions-resume-subscription.js.map +1 -1
- package/esm/funcs/subscriptions-update-subscription-line-item.js.map +1 -1
- package/esm/funcs/subscriptions-update-subscription.js.map +1 -1
- package/esm/funcs/tasks-download-task-export.js.map +1 -1
- package/esm/funcs/tasks-get-task.js.map +1 -1
- package/esm/funcs/tasks-update-task-status.js.map +1 -1
- package/esm/funcs/tax-associations-delete-tax-association.js.map +1 -1
- package/esm/funcs/tax-associations-get-tax-association.js.map +1 -1
- package/esm/funcs/tax-associations-update-tax-association.js.map +1 -1
- package/esm/funcs/tax-rates-delete-tax-rate.js.map +1 -1
- package/esm/funcs/tax-rates-get-tax-rate.js.map +1 -1
- package/esm/funcs/tax-rates-update-tax-rate.js.map +1 -1
- package/esm/funcs/tenants-get-tenant-by-id.js.map +1 -1
- package/esm/funcs/wallets-get-wallet-balance.js.map +1 -1
- package/esm/funcs/wallets-get-wallet-transactions.js.map +1 -1
- package/esm/funcs/wallets-get-wallet.js.map +1 -1
- package/esm/funcs/wallets-get-wallets-by-customer-id.js.map +1 -1
- package/esm/funcs/wallets-terminate-wallet.js.map +1 -1
- package/esm/funcs/wallets-top-up-wallet.js.map +1 -1
- package/esm/funcs/wallets-update-wallet.js.map +1 -1
- package/esm/funcs/webhook-events-post-webhook-events-credit-note-created.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-credit-note-created.d.ts.map +1 -0
- package/esm/funcs/{webhooks-handle-chargebee-webhook.js → webhook-events-post-webhook-events-credit-note-created.js} +10 -34
- package/esm/funcs/webhook-events-post-webhook-events-credit-note-created.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-credit-note-updated.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-credit-note-updated.d.ts.map +1 -0
- package/esm/funcs/{webhooks-handle-paddle-webhook.js → webhook-events-post-webhook-events-credit-note-updated.js} +9 -35
- package/esm/funcs/webhook-events-post-webhook-events-credit-note-updated.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-customer-created.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-customer-created.d.ts.map +1 -0
- package/esm/funcs/{webhooks-handle-moyasar-webhook.js → webhook-events-post-webhook-events-customer-created.js} +9 -35
- package/esm/funcs/webhook-events-post-webhook-events-customer-created.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-customer-deleted.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-customer-deleted.d.ts.map +1 -0
- package/esm/funcs/{webhooks-handle-nomod-webhook.js → webhook-events-post-webhook-events-customer-deleted.js} +10 -39
- package/esm/funcs/webhook-events-post-webhook-events-customer-deleted.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-customer-updated.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-customer-updated.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-customer-updated.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-customer-updated.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-entitlement-created.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-entitlement-created.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-entitlement-created.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-entitlement-created.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-entitlement-deleted.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-entitlement-deleted.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-entitlement-deleted.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-entitlement-deleted.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-entitlement-updated.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-entitlement-updated.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-entitlement-updated.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-entitlement-updated.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-feature-created.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-feature-created.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-feature-created.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-feature-created.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-feature-deleted.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-feature-deleted.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-feature-deleted.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-feature-deleted.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-feature-updated.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-feature-updated.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-feature-updated.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-feature-updated.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-feature-wallet-balance-alert.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-feature-wallet-balance-alert.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-feature-wallet-balance-alert.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-feature-wallet-balance-alert.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-communication-triggered.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-communication-triggered.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-communication-triggered.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-communication-triggered.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-create-drafted.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-create-drafted.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-create-drafted.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-create-drafted.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-payment-overdue.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-payment-overdue.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-payment-overdue.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-payment-overdue.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-finalized.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-finalized.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-finalized.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-finalized.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-payment.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-payment.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-payment.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-payment.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-voided.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-voided.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-voided.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-voided.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-created.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-created.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-created.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-created.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-failed.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-failed.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-failed.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-failed.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-pending.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-pending.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-pending.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-pending.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-success.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-success.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-success.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-success.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-updated.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-updated.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-updated.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-payment-updated.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-activated.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-activated.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-activated.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-activated.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-cancelled.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-cancelled.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-cancelled.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-cancelled.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-created.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-created.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-created.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-created.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-draft-created.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-draft-created.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-draft-created.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-draft-created.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-paused.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-paused.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-paused.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-paused.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-phase-created.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-phase-created.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-phase-created.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-phase-created.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-phase-deleted.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-phase-deleted.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-phase-deleted.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-phase-deleted.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-phase-updated.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-phase-updated.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-phase-updated.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-phase-updated.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-renewal-due.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-renewal-due.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-renewal-due.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-renewal-due.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-resumed.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-resumed.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-resumed.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-resumed.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-updated.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-updated.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-updated.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-subscription-updated.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-created.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-created.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-created.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-created.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-credit-balance-dropped.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-credit-balance-dropped.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-credit-balance-dropped.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-credit-balance-dropped.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-credit-balance-recovered.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-credit-balance-recovered.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-credit-balance-recovered.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-credit-balance-recovered.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-ongoing-balance-dropped.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-ongoing-balance-dropped.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-ongoing-balance-dropped.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-ongoing-balance-dropped.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-ongoing-balance-recovered.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-ongoing-balance-recovered.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-ongoing-balance-recovered.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-ongoing-balance-recovered.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-terminated.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-terminated.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-terminated.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-terminated.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-transaction-created.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-transaction-created.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-transaction-created.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-transaction-created.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-updated.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-updated.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-updated.js +68 -0
- package/esm/funcs/webhook-events-post-webhook-events-wallet-updated.js.map +1 -0
- package/esm/lib/config.d.ts +3 -3
- package/esm/lib/config.js +3 -3
- package/esm/lib/config.js.map +1 -1
- package/esm/lib/encodings.d.ts.map +1 -1
- package/esm/lib/encodings.js +20 -5
- package/esm/lib/encodings.js.map +1 -1
- package/esm/lib/sdks.d.ts.map +1 -1
- package/esm/lib/sdks.js +8 -4
- package/esm/lib/sdks.js.map +1 -1
- package/esm/lib/url.d.ts.map +1 -1
- package/esm/lib/url.js +4 -2
- package/esm/lib/url.js.map +1 -1
- package/esm/sdk/models/cancellation-type.d.ts +1 -0
- package/esm/sdk/models/cancellation-type.d.ts.map +1 -1
- package/esm/sdk/models/cancellation-type.js +1 -0
- package/esm/sdk/models/cancellation-type.js.map +1 -1
- package/esm/sdk/models/dto-cancel-subscription-request.d.ts +8 -0
- package/esm/sdk/models/dto-cancel-subscription-request.d.ts.map +1 -1
- package/esm/sdk/models/dto-cancel-subscription-request.js +2 -0
- package/esm/sdk/models/dto-cancel-subscription-request.js.map +1 -1
- package/esm/sdk/models/dto-create-customer-request.d.ts +8 -3
- package/esm/sdk/models/dto-create-customer-request.d.ts.map +1 -1
- package/esm/sdk/models/dto-create-customer-request.js.map +1 -1
- package/esm/sdk/models/dto-create-subscription-request.d.ts +18 -0
- package/esm/sdk/models/dto-create-subscription-request.d.ts.map +1 -1
- package/esm/sdk/models/dto-create-subscription-request.js +4 -0
- package/esm/sdk/models/dto-create-subscription-request.js.map +1 -1
- package/esm/sdk/models/dto-customer-response.d.ts +5 -1
- package/esm/sdk/models/dto-customer-response.d.ts.map +1 -1
- package/esm/sdk/models/dto-customer-response.js.map +1 -1
- package/esm/sdk/models/dto-update-customer-request.d.ts +9 -4
- package/esm/sdk/models/dto-update-customer-request.d.ts.map +1 -1
- package/esm/sdk/models/dto-update-customer-request.js.map +1 -1
- package/esm/sdk/models/github-com-flexprice-flexprice-internal-domain-customer-customer.d.ts +5 -1
- package/esm/sdk/models/github-com-flexprice-flexprice-internal-domain-customer-customer.d.ts.map +1 -1
- package/esm/sdk/models/github-com-flexprice-flexprice-internal-domain-customer-customer.js.map +1 -1
- package/esm/sdk/models/index.d.ts +13 -8
- package/esm/sdk/models/index.d.ts.map +1 -1
- package/esm/sdk/models/index.js +13 -8
- package/esm/sdk/models/index.js.map +1 -1
- package/esm/sdk/models/webhook-dto-alert-webhook-payload.d.ts +21 -0
- package/esm/sdk/models/webhook-dto-alert-webhook-payload.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-alert-webhook-payload.js +29 -0
- package/esm/sdk/models/webhook-dto-alert-webhook-payload.js.map +1 -0
- package/esm/sdk/models/webhook-dto-communication-webhook-payload.d.ts +12 -0
- package/esm/sdk/models/webhook-dto-communication-webhook-payload.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-communication-webhook-payload.js +21 -0
- package/esm/sdk/models/webhook-dto-communication-webhook-payload.js.map +1 -0
- package/esm/sdk/models/webhook-dto-credit-note-webhook-payload.d.ts +12 -0
- package/esm/sdk/models/webhook-dto-credit-note-webhook-payload.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-credit-note-webhook-payload.js +22 -0
- package/esm/sdk/models/webhook-dto-credit-note-webhook-payload.js.map +1 -0
- package/esm/sdk/models/webhook-dto-customer-webhook-payload.d.ts +15 -0
- package/esm/sdk/models/webhook-dto-customer-webhook-payload.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-customer-webhook-payload.js +21 -0
- package/esm/sdk/models/webhook-dto-customer-webhook-payload.js.map +1 -0
- package/esm/sdk/models/webhook-dto-entitlement-webhook-payload.d.ts +12 -0
- package/esm/sdk/models/webhook-dto-entitlement-webhook-payload.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-entitlement-webhook-payload.js +21 -0
- package/esm/sdk/models/webhook-dto-entitlement-webhook-payload.js.map +1 -0
- package/esm/sdk/models/webhook-dto-feature-webhook-payload.d.ts +12 -0
- package/esm/sdk/models/webhook-dto-feature-webhook-payload.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-feature-webhook-payload.js +21 -0
- package/esm/sdk/models/webhook-dto-feature-webhook-payload.js.map +1 -0
- package/esm/sdk/models/webhook-dto-invoice-webhook-payload.d.ts +12 -0
- package/esm/sdk/models/webhook-dto-invoice-webhook-payload.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-invoice-webhook-payload.js +21 -0
- package/esm/sdk/models/webhook-dto-invoice-webhook-payload.js.map +1 -0
- package/esm/sdk/models/webhook-dto-payment-webhook-payload.d.ts +12 -0
- package/esm/sdk/models/webhook-dto-payment-webhook-payload.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-payment-webhook-payload.js +21 -0
- package/esm/sdk/models/webhook-dto-payment-webhook-payload.js.map +1 -0
- package/esm/sdk/models/webhook-dto-subscription-phase-webhook-payload.d.ts +12 -0
- package/esm/sdk/models/webhook-dto-subscription-phase-webhook-payload.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-subscription-phase-webhook-payload.js +21 -0
- package/esm/sdk/models/webhook-dto-subscription-phase-webhook-payload.js.map +1 -0
- package/esm/sdk/models/webhook-dto-subscription-webhook-payload.d.ts +12 -0
- package/esm/sdk/models/webhook-dto-subscription-webhook-payload.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-subscription-webhook-payload.js +21 -0
- package/esm/sdk/models/webhook-dto-subscription-webhook-payload.js.map +1 -0
- package/esm/sdk/models/webhook-dto-transaction-webhook-payload.d.ts +14 -0
- package/esm/sdk/models/webhook-dto-transaction-webhook-payload.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-transaction-webhook-payload.js +23 -0
- package/esm/sdk/models/webhook-dto-transaction-webhook-payload.js.map +1 -0
- package/esm/sdk/models/webhook-dto-wallet-alert-info.d.ts +15 -0
- package/esm/sdk/models/webhook-dto-wallet-alert-info.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-wallet-alert-info.js +27 -0
- package/esm/sdk/models/webhook-dto-wallet-alert-info.js.map +1 -0
- package/esm/sdk/models/webhook-dto-wallet-webhook-payload.d.ts +19 -0
- package/esm/sdk/models/webhook-dto-wallet-webhook-payload.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-wallet-webhook-payload.js +25 -0
- package/esm/sdk/models/webhook-dto-wallet-webhook-payload.js.map +1 -0
- package/esm/sdk/models/window-size.d.ts +1 -1
- package/esm/sdk/models/window-size.js +1 -1
- package/esm/sdk/models/window-size.js.map +1 -1
- package/esm/sdk/sdk.d.ts +3 -3
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +4 -4
- package/esm/sdk/sdk.js.map +1 -1
- package/esm/sdk/webhook-events.d.ts +306 -0
- package/esm/sdk/webhook-events.d.ts.map +1 -0
- package/esm/sdk/webhook-events.js +438 -0
- package/esm/sdk/webhook-events.js.map +1 -0
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/addons-delete-addon.ts +0 -1
- package/src/funcs/addons-get-addon-by-lookup-key.ts +0 -1
- package/src/funcs/addons-get-addon.ts +0 -1
- package/src/funcs/addons-update-addon.ts +0 -1
- package/src/funcs/costs-delete-costsheet.ts +0 -1
- package/src/funcs/costs-get-costsheet.ts +0 -1
- package/src/funcs/costs-update-costsheet.ts +0 -1
- package/src/funcs/coupons-delete-coupon.ts +0 -1
- package/src/funcs/coupons-get-coupon.ts +0 -1
- package/src/funcs/coupons-update-coupon.ts +0 -1
- package/src/funcs/credit-grants-delete-credit-grant.ts +0 -1
- package/src/funcs/credit-grants-get-credit-grant.ts +0 -1
- package/src/funcs/credit-grants-get-plan-credit-grants.ts +0 -1
- package/src/funcs/credit-grants-update-credit-grant.ts +0 -1
- package/src/funcs/credit-notes-get-credit-note.ts +0 -1
- package/src/funcs/credit-notes-process-credit-note.ts +0 -1
- package/src/funcs/credit-notes-void-credit-note.ts +0 -1
- package/src/funcs/customers-delete-customer.ts +0 -1
- package/src/funcs/customers-get-customer-by-external-id.ts +0 -1
- package/src/funcs/customers-get-customer-entitlements.ts +0 -1
- package/src/funcs/customers-get-customer-upcoming-grants.ts +0 -1
- package/src/funcs/customers-get-customer.ts +0 -1
- package/src/funcs/entitlements-delete-entitlement.ts +0 -1
- package/src/funcs/entitlements-get-addon-entitlements.ts +0 -1
- package/src/funcs/entitlements-get-entitlement.ts +0 -1
- package/src/funcs/entitlements-get-plan-entitlements.ts +0 -1
- package/src/funcs/entitlements-update-entitlement.ts +0 -1
- package/src/funcs/entity-integration-mappings-delete-entity-integration-mapping.ts +0 -1
- package/src/funcs/events-get-event.ts +0 -1
- package/src/funcs/features-delete-feature.ts +0 -1
- package/src/funcs/features-update-feature.ts +0 -1
- package/src/funcs/groups-delete-group.ts +0 -1
- package/src/funcs/groups-get-group.ts +0 -1
- package/src/funcs/integrations-create-or-update-integration.ts +0 -1
- package/src/funcs/integrations-delete-integration.ts +0 -1
- package/src/funcs/integrations-get-integration.ts +0 -1
- package/src/funcs/invoices-attempt-invoice-payment.ts +0 -1
- package/src/funcs/invoices-finalize-invoice.ts +0 -1
- package/src/funcs/invoices-get-customer-invoice-summary.ts +0 -1
- package/src/funcs/invoices-get-invoice-pdf.ts +0 -1
- package/src/funcs/invoices-get-invoice.ts +0 -1
- package/src/funcs/invoices-recalculate-invoice-v2.ts +0 -1
- package/src/funcs/invoices-recalculate-invoice.ts +0 -1
- package/src/funcs/invoices-trigger-invoice-comms-webhook.ts +0 -1
- package/src/funcs/invoices-update-invoice-payment-status.ts +0 -1
- package/src/funcs/invoices-update-invoice.ts +0 -1
- package/src/funcs/invoices-void-invoice.ts +0 -1
- package/src/funcs/payments-delete-payment.ts +0 -1
- package/src/funcs/payments-get-payment.ts +0 -1
- package/src/funcs/payments-process-payment.ts +0 -1
- package/src/funcs/payments-update-payment.ts +0 -1
- package/src/funcs/plans-delete-plan.ts +0 -1
- package/src/funcs/plans-get-plan.ts +0 -1
- package/src/funcs/plans-post-plans-id-clone.ts +0 -1
- package/src/funcs/plans-sync-plan-prices.ts +0 -1
- package/src/funcs/plans-update-plan.ts +0 -1
- package/src/funcs/price-units-delete-price-unit.ts +0 -1
- package/src/funcs/price-units-get-price-unit-by-code.ts +0 -1
- package/src/funcs/price-units-get-price-unit.ts +0 -1
- package/src/funcs/price-units-update-price-unit.ts +0 -1
- package/src/funcs/prices-delete-price.ts +0 -1
- package/src/funcs/prices-get-price-by-lookup-key.ts +0 -1
- package/src/funcs/prices-get-price.ts +0 -1
- package/src/funcs/prices-update-price.ts +0 -1
- package/src/funcs/rbac-get-rbac-role.ts +0 -1
- package/src/funcs/scheduled-tasks-delete-scheduled-task.ts +0 -1
- package/src/funcs/scheduled-tasks-get-scheduled-task.ts +0 -1
- package/src/funcs/scheduled-tasks-trigger-scheduled-task-run.ts +0 -1
- package/src/funcs/scheduled-tasks-update-scheduled-task.ts +0 -1
- package/src/funcs/secrets-delete-api-key.ts +0 -1
- package/src/funcs/subscriptions-activate-subscription.ts +0 -1
- package/src/funcs/subscriptions-cancel-subscription-schedule.ts +0 -1
- package/src/funcs/subscriptions-cancel-subscription.ts +0 -1
- package/src/funcs/subscriptions-create-subscription-line-item.ts +0 -1
- package/src/funcs/subscriptions-delete-subscription-line-item.ts +0 -1
- package/src/funcs/subscriptions-execute-subscription-change.ts +0 -1
- package/src/funcs/subscriptions-get-subscription-addon-associations.ts +0 -1
- package/src/funcs/subscriptions-get-subscription-entitlements.ts +0 -1
- package/src/funcs/subscriptions-get-subscription-schedule.ts +0 -1
- package/src/funcs/subscriptions-get-subscription-upcoming-grants.ts +0 -1
- package/src/funcs/subscriptions-get-subscription-v2.ts +0 -1
- package/src/funcs/subscriptions-get-subscription.ts +0 -1
- package/src/funcs/subscriptions-list-subscription-pauses.ts +0 -1
- package/src/funcs/subscriptions-list-subscription-schedules.ts +0 -1
- package/src/funcs/subscriptions-pause-subscription.ts +0 -1
- package/src/funcs/subscriptions-preview-subscription-change.ts +0 -1
- package/src/funcs/subscriptions-resume-subscription.ts +0 -1
- package/src/funcs/subscriptions-update-subscription-line-item.ts +0 -1
- package/src/funcs/subscriptions-update-subscription.ts +0 -1
- package/src/funcs/tasks-download-task-export.ts +0 -1
- package/src/funcs/tasks-get-task.ts +0 -1
- package/src/funcs/tasks-update-task-status.ts +0 -1
- package/src/funcs/tax-associations-delete-tax-association.ts +0 -1
- package/src/funcs/tax-associations-get-tax-association.ts +0 -1
- package/src/funcs/tax-associations-update-tax-association.ts +0 -1
- package/src/funcs/tax-rates-delete-tax-rate.ts +0 -1
- package/src/funcs/tax-rates-get-tax-rate.ts +0 -1
- package/src/funcs/tax-rates-update-tax-rate.ts +0 -1
- package/src/funcs/tenants-get-tenant-by-id.ts +0 -1
- package/src/funcs/wallets-get-wallet-balance.ts +0 -1
- package/src/funcs/wallets-get-wallet-transactions.ts +0 -1
- package/src/funcs/wallets-get-wallet.ts +0 -1
- package/src/funcs/wallets-get-wallets-by-customer-id.ts +0 -1
- package/src/funcs/wallets-terminate-wallet.ts +0 -1
- package/src/funcs/wallets-top-up-wallet.ts +0 -1
- package/src/funcs/wallets-update-wallet.ts +0 -1
- package/src/funcs/{webhooks-handle-chargebee-webhook.ts → webhook-events-post-webhook-events-credit-note-created.ts} +12 -52
- package/src/funcs/{webhooks-handle-paddle-webhook.ts → webhook-events-post-webhook-events-credit-note-updated.ts} +9 -57
- package/src/funcs/{webhooks-handle-nomod-webhook.ts → webhook-events-post-webhook-events-customer-created.ts} +11 -58
- package/src/funcs/{webhooks-handle-moyasar-webhook.ts → webhook-events-post-webhook-events-customer-deleted.ts} +9 -58
- package/src/funcs/webhook-events-post-webhook-events-customer-updated.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-entitlement-created.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-entitlement-deleted.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-entitlement-updated.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-feature-created.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-feature-deleted.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-feature-updated.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-feature-wallet-balance-alert.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-invoice-communication-triggered.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-invoice-create-drafted.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-invoice-payment-overdue.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-invoice-update-finalized.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-invoice-update-payment.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-invoice-update-voided.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-invoice-update.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-payment-created.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-payment-failed.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-payment-pending.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-payment-success.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-payment-updated.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-subscription-activated.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-subscription-cancelled.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-subscription-created.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-subscription-draft-created.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-subscription-paused.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-subscription-phase-created.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-subscription-phase-deleted.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-subscription-phase-updated.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-subscription-renewal-due.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-subscription-resumed.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-subscription-updated.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-wallet-created.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-wallet-credit-balance-dropped.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-wallet-credit-balance-recovered.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-wallet-ongoing-balance-dropped.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-wallet-ongoing-balance-recovered.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-wallet-terminated.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-wallet-transaction-created.ts +142 -0
- package/src/funcs/webhook-events-post-webhook-events-wallet-updated.ts +142 -0
- package/src/lib/config.ts +3 -3
- package/src/lib/encodings.ts +23 -4
- package/src/lib/sdks.ts +7 -5
- package/src/lib/url.ts +16 -14
- package/src/sdk/models/cancellation-type.ts +1 -0
- package/src/sdk/models/dto-cancel-subscription-request.ts +10 -0
- package/src/sdk/models/dto-create-customer-request.ts +8 -3
- package/src/sdk/models/dto-create-subscription-request.ts +22 -0
- package/src/sdk/models/dto-customer-response.ts +5 -1
- package/src/sdk/models/dto-update-customer-request.ts +9 -4
- package/src/sdk/models/github-com-flexprice-flexprice-internal-domain-customer-customer.ts +5 -1
- package/src/sdk/models/index.ts +13 -8
- package/src/sdk/models/webhook-dto-alert-webhook-payload.ts +66 -0
- package/src/sdk/models/webhook-dto-communication-webhook-payload.ts +46 -0
- package/src/sdk/models/webhook-dto-credit-note-webhook-payload.ts +47 -0
- package/src/sdk/models/webhook-dto-customer-webhook-payload.ts +48 -0
- package/src/sdk/models/webhook-dto-entitlement-webhook-payload.ts +46 -0
- package/src/sdk/models/webhook-dto-feature-webhook-payload.ts +45 -0
- package/src/sdk/models/webhook-dto-invoice-webhook-payload.ts +45 -0
- package/src/sdk/models/webhook-dto-payment-webhook-payload.ts +45 -0
- package/src/sdk/models/webhook-dto-subscription-phase-webhook-payload.ts +49 -0
- package/src/sdk/models/webhook-dto-subscription-webhook-payload.ts +46 -0
- package/src/sdk/models/webhook-dto-transaction-webhook-payload.ts +52 -0
- package/src/sdk/models/webhook-dto-wallet-alert-info.ts +54 -0
- package/src/sdk/models/webhook-dto-wallet-webhook-payload.ts +60 -0
- package/src/sdk/models/window-size.ts +1 -1
- package/src/sdk/sdk.ts +4 -4
- package/src/sdk/webhook-events.ts +705 -0
- package/docs/sdk/models/handle-chargebee-webhook-request.md +0 -19
- package/docs/sdk/models/handle-hubspot-webhook-request.md +0 -21
- package/docs/sdk/models/handle-moyasar-webhook-request.md +0 -20
- package/docs/sdk/models/handle-nomod-webhook-request.md +0 -20
- package/docs/sdk/models/handle-paddle-webhook-request.md +0 -21
- package/docs/sdk/models/handle-quickbooks-webhook-request.md +0 -20
- package/docs/sdk/models/handle-razorpay-webhook-request.md +0 -21
- package/docs/sdk/models/handle-stripe-webhook-request.md +0 -21
- package/docs/sdks/webhooks/README.md +0 -581
- package/esm/funcs/webhooks-handle-chargebee-webhook.d.ts +0 -18
- package/esm/funcs/webhooks-handle-chargebee-webhook.d.ts.map +0 -1
- package/esm/funcs/webhooks-handle-chargebee-webhook.js.map +0 -1
- package/esm/funcs/webhooks-handle-hubspot-webhook.d.ts +0 -18
- package/esm/funcs/webhooks-handle-hubspot-webhook.d.ts.map +0 -1
- package/esm/funcs/webhooks-handle-hubspot-webhook.js +0 -94
- package/esm/funcs/webhooks-handle-hubspot-webhook.js.map +0 -1
- package/esm/funcs/webhooks-handle-moyasar-webhook.d.ts +0 -18
- package/esm/funcs/webhooks-handle-moyasar-webhook.d.ts.map +0 -1
- package/esm/funcs/webhooks-handle-moyasar-webhook.js.map +0 -1
- package/esm/funcs/webhooks-handle-nomod-webhook.d.ts +0 -18
- package/esm/funcs/webhooks-handle-nomod-webhook.d.ts.map +0 -1
- package/esm/funcs/webhooks-handle-nomod-webhook.js.map +0 -1
- package/esm/funcs/webhooks-handle-paddle-webhook.d.ts +0 -18
- package/esm/funcs/webhooks-handle-paddle-webhook.d.ts.map +0 -1
- package/esm/funcs/webhooks-handle-paddle-webhook.js.map +0 -1
- package/esm/funcs/webhooks-handle-quickbooks-webhook.d.ts +0 -18
- package/esm/funcs/webhooks-handle-quickbooks-webhook.d.ts.map +0 -1
- package/esm/funcs/webhooks-handle-quickbooks-webhook.js +0 -94
- package/esm/funcs/webhooks-handle-quickbooks-webhook.js.map +0 -1
- package/esm/funcs/webhooks-handle-razorpay-webhook.d.ts +0 -18
- package/esm/funcs/webhooks-handle-razorpay-webhook.d.ts.map +0 -1
- package/esm/funcs/webhooks-handle-razorpay-webhook.js +0 -94
- package/esm/funcs/webhooks-handle-razorpay-webhook.js.map +0 -1
- package/esm/funcs/webhooks-handle-stripe-webhook.d.ts +0 -18
- package/esm/funcs/webhooks-handle-stripe-webhook.d.ts.map +0 -1
- package/esm/funcs/webhooks-handle-stripe-webhook.js +0 -94
- package/esm/funcs/webhooks-handle-stripe-webhook.js.map +0 -1
- package/esm/sdk/models/handle-chargebee-webhook-op.d.ts +0 -20
- package/esm/sdk/models/handle-chargebee-webhook-op.d.ts.map +0 -1
- package/esm/sdk/models/handle-chargebee-webhook-op.js +0 -19
- package/esm/sdk/models/handle-chargebee-webhook-op.js.map +0 -1
- package/esm/sdk/models/handle-hubspot-webhook-op.d.ts +0 -25
- package/esm/sdk/models/handle-hubspot-webhook-op.d.ts.map +0 -1
- package/esm/sdk/models/handle-hubspot-webhook-op.js +0 -21
- package/esm/sdk/models/handle-hubspot-webhook-op.js.map +0 -1
- package/esm/sdk/models/handle-moyasar-webhook-op.d.ts +0 -25
- package/esm/sdk/models/handle-moyasar-webhook-op.d.ts.map +0 -1
- package/esm/sdk/models/handle-moyasar-webhook-op.js +0 -21
- package/esm/sdk/models/handle-moyasar-webhook-op.js.map +0 -1
- package/esm/sdk/models/handle-nomod-webhook-op.d.ts +0 -25
- package/esm/sdk/models/handle-nomod-webhook-op.d.ts.map +0 -1
- package/esm/sdk/models/handle-nomod-webhook-op.js +0 -21
- package/esm/sdk/models/handle-nomod-webhook-op.js.map +0 -1
- package/esm/sdk/models/handle-paddle-webhook-op.d.ts +0 -25
- package/esm/sdk/models/handle-paddle-webhook-op.d.ts.map +0 -1
- package/esm/sdk/models/handle-paddle-webhook-op.js +0 -21
- package/esm/sdk/models/handle-paddle-webhook-op.js.map +0 -1
- package/esm/sdk/models/handle-quickbooks-webhook-op.d.ts +0 -25
- package/esm/sdk/models/handle-quickbooks-webhook-op.d.ts.map +0 -1
- package/esm/sdk/models/handle-quickbooks-webhook-op.js +0 -21
- package/esm/sdk/models/handle-quickbooks-webhook-op.js.map +0 -1
- package/esm/sdk/models/handle-razorpay-webhook-op.d.ts +0 -25
- package/esm/sdk/models/handle-razorpay-webhook-op.d.ts.map +0 -1
- package/esm/sdk/models/handle-razorpay-webhook-op.js +0 -21
- package/esm/sdk/models/handle-razorpay-webhook-op.js.map +0 -1
- package/esm/sdk/models/handle-stripe-webhook-op.d.ts +0 -25
- package/esm/sdk/models/handle-stripe-webhook-op.d.ts.map +0 -1
- package/esm/sdk/models/handle-stripe-webhook-op.js +0 -21
- package/esm/sdk/models/handle-stripe-webhook-op.js.map +0 -1
- package/esm/sdk/webhooks.d.ts +0 -76
- package/esm/sdk/webhooks.d.ts.map +0 -1
- package/esm/sdk/webhooks.js +0 -88
- package/esm/sdk/webhooks.js.map +0 -1
- package/src/funcs/webhooks-handle-hubspot-webhook.ts +0 -191
- package/src/funcs/webhooks-handle-quickbooks-webhook.ts +0 -191
- package/src/funcs/webhooks-handle-razorpay-webhook.ts +0 -191
- package/src/funcs/webhooks-handle-stripe-webhook.ts +0 -190
- package/src/sdk/models/handle-chargebee-webhook-op.ts +0 -50
- package/src/sdk/models/handle-hubspot-webhook-op.ts +0 -57
- package/src/sdk/models/handle-moyasar-webhook-op.ts +0 -57
- package/src/sdk/models/handle-nomod-webhook-op.ts +0 -55
- package/src/sdk/models/handle-paddle-webhook-op.ts +0 -55
- package/src/sdk/models/handle-quickbooks-webhook-op.ts +0 -57
- package/src/sdk/models/handle-razorpay-webhook-op.ts +0 -57
- package/src/sdk/models/handle-stripe-webhook-op.ts +0 -55
- package/src/sdk/webhooks.ts +0 -182
|
@@ -0,0 +1,2973 @@
|
|
|
1
|
+
# WebhookEvents
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
### Available Operations
|
|
6
|
+
|
|
7
|
+
* [postWebhookEventsCreditNoteCreated](#postwebhookeventscreditnotecreated) - credit_note.created
|
|
8
|
+
* [postWebhookEventsCreditNoteUpdated](#postwebhookeventscreditnoteupdated) - credit_note.updated
|
|
9
|
+
* [postWebhookEventsCustomerCreated](#postwebhookeventscustomercreated) - customer.created
|
|
10
|
+
* [postWebhookEventsCustomerDeleted](#postwebhookeventscustomerdeleted) - customer.deleted
|
|
11
|
+
* [postWebhookEventsCustomerUpdated](#postwebhookeventscustomerupdated) - customer.updated
|
|
12
|
+
* [postWebhookEventsEntitlementCreated](#postwebhookeventsentitlementcreated) - entitlement.created
|
|
13
|
+
* [postWebhookEventsEntitlementDeleted](#postwebhookeventsentitlementdeleted) - entitlement.deleted
|
|
14
|
+
* [postWebhookEventsEntitlementUpdated](#postwebhookeventsentitlementupdated) - entitlement.updated
|
|
15
|
+
* [postWebhookEventsFeatureCreated](#postwebhookeventsfeaturecreated) - feature.created
|
|
16
|
+
* [postWebhookEventsFeatureDeleted](#postwebhookeventsfeaturedeleted) - feature.deleted
|
|
17
|
+
* [postWebhookEventsFeatureUpdated](#postwebhookeventsfeatureupdated) - feature.updated
|
|
18
|
+
* [postWebhookEventsFeatureWalletBalanceAlert](#postwebhookeventsfeaturewalletbalancealert) - feature.wallet_balance.alert
|
|
19
|
+
* [postWebhookEventsInvoiceCommunicationTriggered](#postwebhookeventsinvoicecommunicationtriggered) - invoice.communication.triggered
|
|
20
|
+
* [postWebhookEventsInvoiceCreateDrafted](#postwebhookeventsinvoicecreatedrafted) - invoice.create.drafted
|
|
21
|
+
* [postWebhookEventsInvoicePaymentOverdue](#postwebhookeventsinvoicepaymentoverdue) - invoice.payment.overdue
|
|
22
|
+
* [postWebhookEventsInvoiceUpdate](#postwebhookeventsinvoiceupdate) - invoice.update
|
|
23
|
+
* [postWebhookEventsInvoiceUpdateFinalized](#postwebhookeventsinvoiceupdatefinalized) - invoice.update.finalized
|
|
24
|
+
* [postWebhookEventsInvoiceUpdatePayment](#postwebhookeventsinvoiceupdatepayment) - invoice.update.payment
|
|
25
|
+
* [postWebhookEventsInvoiceUpdateVoided](#postwebhookeventsinvoiceupdatevoided) - invoice.update.voided
|
|
26
|
+
* [postWebhookEventsPaymentCreated](#postwebhookeventspaymentcreated) - payment.created
|
|
27
|
+
* [postWebhookEventsPaymentFailed](#postwebhookeventspaymentfailed) - payment.failed
|
|
28
|
+
* [postWebhookEventsPaymentPending](#postwebhookeventspaymentpending) - payment.pending
|
|
29
|
+
* [postWebhookEventsPaymentSuccess](#postwebhookeventspaymentsuccess) - payment.success
|
|
30
|
+
* [postWebhookEventsPaymentUpdated](#postwebhookeventspaymentupdated) - payment.updated
|
|
31
|
+
* [postWebhookEventsSubscriptionActivated](#postwebhookeventssubscriptionactivated) - subscription.activated
|
|
32
|
+
* [postWebhookEventsSubscriptionCancelled](#postwebhookeventssubscriptioncancelled) - subscription.cancelled
|
|
33
|
+
* [postWebhookEventsSubscriptionCreated](#postwebhookeventssubscriptioncreated) - subscription.created
|
|
34
|
+
* [postWebhookEventsSubscriptionDraftCreated](#postwebhookeventssubscriptiondraftcreated) - subscription.draft.created
|
|
35
|
+
* [postWebhookEventsSubscriptionPaused](#postwebhookeventssubscriptionpaused) - subscription.paused
|
|
36
|
+
* [postWebhookEventsSubscriptionPhaseCreated](#postwebhookeventssubscriptionphasecreated) - subscription.phase.created
|
|
37
|
+
* [postWebhookEventsSubscriptionPhaseDeleted](#postwebhookeventssubscriptionphasedeleted) - subscription.phase.deleted
|
|
38
|
+
* [postWebhookEventsSubscriptionPhaseUpdated](#postwebhookeventssubscriptionphaseupdated) - subscription.phase.updated
|
|
39
|
+
* [postWebhookEventsSubscriptionRenewalDue](#postwebhookeventssubscriptionrenewaldue) - subscription.renewal.due
|
|
40
|
+
* [postWebhookEventsSubscriptionResumed](#postwebhookeventssubscriptionresumed) - subscription.resumed
|
|
41
|
+
* [postWebhookEventsSubscriptionUpdated](#postwebhookeventssubscriptionupdated) - subscription.updated
|
|
42
|
+
* [postWebhookEventsWalletCreated](#postwebhookeventswalletcreated) - wallet.created
|
|
43
|
+
* [postWebhookEventsWalletCreditBalanceDropped](#postwebhookeventswalletcreditbalancedropped) - wallet.credit_balance.dropped
|
|
44
|
+
* [postWebhookEventsWalletCreditBalanceRecovered](#postwebhookeventswalletcreditbalancerecovered) - wallet.credit_balance.recovered
|
|
45
|
+
* [postWebhookEventsWalletOngoingBalanceDropped](#postwebhookeventswalletongoingbalancedropped) - wallet.ongoing_balance.dropped
|
|
46
|
+
* [postWebhookEventsWalletOngoingBalanceRecovered](#postwebhookeventswalletongoingbalancerecovered) - wallet.ongoing_balance.recovered
|
|
47
|
+
* [postWebhookEventsWalletTerminated](#postwebhookeventswalletterminated) - wallet.terminated
|
|
48
|
+
* [postWebhookEventsWalletTransactionCreated](#postwebhookeventswallettransactioncreated) - wallet.transaction.created
|
|
49
|
+
* [postWebhookEventsWalletUpdated](#postwebhookeventswalletupdated) - wallet.updated
|
|
50
|
+
|
|
51
|
+
## postWebhookEventsCreditNoteCreated
|
|
52
|
+
|
|
53
|
+
Fired when a new credit note is created. Doc-only for parsing.
|
|
54
|
+
|
|
55
|
+
### Example Usage
|
|
56
|
+
|
|
57
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/credit_note.created" method="post" path="/webhook-events/credit_note.created" -->
|
|
58
|
+
```typescript
|
|
59
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
60
|
+
|
|
61
|
+
const flexprice = new Flexprice({
|
|
62
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
async function run() {
|
|
66
|
+
const result = await flexprice.webhookEvents.postWebhookEventsCreditNoteCreated();
|
|
67
|
+
|
|
68
|
+
console.log(result);
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
run();
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Standalone function
|
|
75
|
+
|
|
76
|
+
The standalone function version of this method:
|
|
77
|
+
|
|
78
|
+
```typescript
|
|
79
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
80
|
+
import { webhookEventsPostWebhookEventsCreditNoteCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-credit-note-created.js";
|
|
81
|
+
|
|
82
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
83
|
+
// You can create one instance of it to use across an application.
|
|
84
|
+
const flexprice = new FlexpriceCore({
|
|
85
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
86
|
+
});
|
|
87
|
+
|
|
88
|
+
async function run() {
|
|
89
|
+
const res = await webhookEventsPostWebhookEventsCreditNoteCreated(flexprice);
|
|
90
|
+
if (res.ok) {
|
|
91
|
+
const { value: result } = res;
|
|
92
|
+
console.log(result);
|
|
93
|
+
} else {
|
|
94
|
+
console.log("webhookEventsPostWebhookEventsCreditNoteCreated failed:", res.error);
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
run();
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Parameters
|
|
102
|
+
|
|
103
|
+
| Parameter | Type | Required | Description |
|
|
104
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
105
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
106
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
107
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
108
|
+
|
|
109
|
+
### Response
|
|
110
|
+
|
|
111
|
+
**Promise\<[models.WebhookDtoCreditNoteWebhookPayload](../../sdk/models/webhook-dto-credit-note-webhook-payload.md)\>**
|
|
112
|
+
|
|
113
|
+
### Errors
|
|
114
|
+
|
|
115
|
+
| Error Type | Status Code | Content Type |
|
|
116
|
+
| --------------- | --------------- | --------------- |
|
|
117
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
118
|
+
|
|
119
|
+
## postWebhookEventsCreditNoteUpdated
|
|
120
|
+
|
|
121
|
+
Fired when a credit note is updated. Doc-only for parsing.
|
|
122
|
+
|
|
123
|
+
### Example Usage
|
|
124
|
+
|
|
125
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/credit_note.updated" method="post" path="/webhook-events/credit_note.updated" -->
|
|
126
|
+
```typescript
|
|
127
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
128
|
+
|
|
129
|
+
const flexprice = new Flexprice({
|
|
130
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
131
|
+
});
|
|
132
|
+
|
|
133
|
+
async function run() {
|
|
134
|
+
const result = await flexprice.webhookEvents.postWebhookEventsCreditNoteUpdated();
|
|
135
|
+
|
|
136
|
+
console.log(result);
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
run();
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Standalone function
|
|
143
|
+
|
|
144
|
+
The standalone function version of this method:
|
|
145
|
+
|
|
146
|
+
```typescript
|
|
147
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
148
|
+
import { webhookEventsPostWebhookEventsCreditNoteUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-credit-note-updated.js";
|
|
149
|
+
|
|
150
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
151
|
+
// You can create one instance of it to use across an application.
|
|
152
|
+
const flexprice = new FlexpriceCore({
|
|
153
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
154
|
+
});
|
|
155
|
+
|
|
156
|
+
async function run() {
|
|
157
|
+
const res = await webhookEventsPostWebhookEventsCreditNoteUpdated(flexprice);
|
|
158
|
+
if (res.ok) {
|
|
159
|
+
const { value: result } = res;
|
|
160
|
+
console.log(result);
|
|
161
|
+
} else {
|
|
162
|
+
console.log("webhookEventsPostWebhookEventsCreditNoteUpdated failed:", res.error);
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
run();
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
### Parameters
|
|
170
|
+
|
|
171
|
+
| Parameter | Type | Required | Description |
|
|
172
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
173
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
174
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
175
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
176
|
+
|
|
177
|
+
### Response
|
|
178
|
+
|
|
179
|
+
**Promise\<[models.WebhookDtoCreditNoteWebhookPayload](../../sdk/models/webhook-dto-credit-note-webhook-payload.md)\>**
|
|
180
|
+
|
|
181
|
+
### Errors
|
|
182
|
+
|
|
183
|
+
| Error Type | Status Code | Content Type |
|
|
184
|
+
| --------------- | --------------- | --------------- |
|
|
185
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
186
|
+
|
|
187
|
+
## postWebhookEventsCustomerCreated
|
|
188
|
+
|
|
189
|
+
Fired when a new customer is created. Doc-only for parsing.
|
|
190
|
+
|
|
191
|
+
### Example Usage
|
|
192
|
+
|
|
193
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/customer.created" method="post" path="/webhook-events/customer.created" -->
|
|
194
|
+
```typescript
|
|
195
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
196
|
+
|
|
197
|
+
const flexprice = new Flexprice({
|
|
198
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
199
|
+
});
|
|
200
|
+
|
|
201
|
+
async function run() {
|
|
202
|
+
const result = await flexprice.webhookEvents.postWebhookEventsCustomerCreated();
|
|
203
|
+
|
|
204
|
+
console.log(result);
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
run();
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### Standalone function
|
|
211
|
+
|
|
212
|
+
The standalone function version of this method:
|
|
213
|
+
|
|
214
|
+
```typescript
|
|
215
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
216
|
+
import { webhookEventsPostWebhookEventsCustomerCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-customer-created.js";
|
|
217
|
+
|
|
218
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
219
|
+
// You can create one instance of it to use across an application.
|
|
220
|
+
const flexprice = new FlexpriceCore({
|
|
221
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
222
|
+
});
|
|
223
|
+
|
|
224
|
+
async function run() {
|
|
225
|
+
const res = await webhookEventsPostWebhookEventsCustomerCreated(flexprice);
|
|
226
|
+
if (res.ok) {
|
|
227
|
+
const { value: result } = res;
|
|
228
|
+
console.log(result);
|
|
229
|
+
} else {
|
|
230
|
+
console.log("webhookEventsPostWebhookEventsCustomerCreated failed:", res.error);
|
|
231
|
+
}
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
run();
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
### Parameters
|
|
238
|
+
|
|
239
|
+
| Parameter | Type | Required | Description |
|
|
240
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
241
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
242
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
243
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
244
|
+
|
|
245
|
+
### Response
|
|
246
|
+
|
|
247
|
+
**Promise\<[models.WebhookDtoCustomerWebhookPayload](../../sdk/models/webhook-dto-customer-webhook-payload.md)\>**
|
|
248
|
+
|
|
249
|
+
### Errors
|
|
250
|
+
|
|
251
|
+
| Error Type | Status Code | Content Type |
|
|
252
|
+
| --------------- | --------------- | --------------- |
|
|
253
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
254
|
+
|
|
255
|
+
## postWebhookEventsCustomerDeleted
|
|
256
|
+
|
|
257
|
+
Fired when a customer is deleted. Doc-only for parsing.
|
|
258
|
+
|
|
259
|
+
### Example Usage
|
|
260
|
+
|
|
261
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/customer.deleted" method="post" path="/webhook-events/customer.deleted" -->
|
|
262
|
+
```typescript
|
|
263
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
264
|
+
|
|
265
|
+
const flexprice = new Flexprice({
|
|
266
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
267
|
+
});
|
|
268
|
+
|
|
269
|
+
async function run() {
|
|
270
|
+
const result = await flexprice.webhookEvents.postWebhookEventsCustomerDeleted();
|
|
271
|
+
|
|
272
|
+
console.log(result);
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
run();
|
|
276
|
+
```
|
|
277
|
+
|
|
278
|
+
### Standalone function
|
|
279
|
+
|
|
280
|
+
The standalone function version of this method:
|
|
281
|
+
|
|
282
|
+
```typescript
|
|
283
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
284
|
+
import { webhookEventsPostWebhookEventsCustomerDeleted } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-customer-deleted.js";
|
|
285
|
+
|
|
286
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
287
|
+
// You can create one instance of it to use across an application.
|
|
288
|
+
const flexprice = new FlexpriceCore({
|
|
289
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
290
|
+
});
|
|
291
|
+
|
|
292
|
+
async function run() {
|
|
293
|
+
const res = await webhookEventsPostWebhookEventsCustomerDeleted(flexprice);
|
|
294
|
+
if (res.ok) {
|
|
295
|
+
const { value: result } = res;
|
|
296
|
+
console.log(result);
|
|
297
|
+
} else {
|
|
298
|
+
console.log("webhookEventsPostWebhookEventsCustomerDeleted failed:", res.error);
|
|
299
|
+
}
|
|
300
|
+
}
|
|
301
|
+
|
|
302
|
+
run();
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
### Parameters
|
|
306
|
+
|
|
307
|
+
| Parameter | Type | Required | Description |
|
|
308
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
309
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
310
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
311
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
312
|
+
|
|
313
|
+
### Response
|
|
314
|
+
|
|
315
|
+
**Promise\<[models.WebhookDtoCustomerWebhookPayload](../../sdk/models/webhook-dto-customer-webhook-payload.md)\>**
|
|
316
|
+
|
|
317
|
+
### Errors
|
|
318
|
+
|
|
319
|
+
| Error Type | Status Code | Content Type |
|
|
320
|
+
| --------------- | --------------- | --------------- |
|
|
321
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
322
|
+
|
|
323
|
+
## postWebhookEventsCustomerUpdated
|
|
324
|
+
|
|
325
|
+
Fired when a customer is updated. Doc-only for parsing.
|
|
326
|
+
|
|
327
|
+
### Example Usage
|
|
328
|
+
|
|
329
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/customer.updated" method="post" path="/webhook-events/customer.updated" -->
|
|
330
|
+
```typescript
|
|
331
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
332
|
+
|
|
333
|
+
const flexprice = new Flexprice({
|
|
334
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
335
|
+
});
|
|
336
|
+
|
|
337
|
+
async function run() {
|
|
338
|
+
const result = await flexprice.webhookEvents.postWebhookEventsCustomerUpdated();
|
|
339
|
+
|
|
340
|
+
console.log(result);
|
|
341
|
+
}
|
|
342
|
+
|
|
343
|
+
run();
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
### Standalone function
|
|
347
|
+
|
|
348
|
+
The standalone function version of this method:
|
|
349
|
+
|
|
350
|
+
```typescript
|
|
351
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
352
|
+
import { webhookEventsPostWebhookEventsCustomerUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-customer-updated.js";
|
|
353
|
+
|
|
354
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
355
|
+
// You can create one instance of it to use across an application.
|
|
356
|
+
const flexprice = new FlexpriceCore({
|
|
357
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
358
|
+
});
|
|
359
|
+
|
|
360
|
+
async function run() {
|
|
361
|
+
const res = await webhookEventsPostWebhookEventsCustomerUpdated(flexprice);
|
|
362
|
+
if (res.ok) {
|
|
363
|
+
const { value: result } = res;
|
|
364
|
+
console.log(result);
|
|
365
|
+
} else {
|
|
366
|
+
console.log("webhookEventsPostWebhookEventsCustomerUpdated failed:", res.error);
|
|
367
|
+
}
|
|
368
|
+
}
|
|
369
|
+
|
|
370
|
+
run();
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
### Parameters
|
|
374
|
+
|
|
375
|
+
| Parameter | Type | Required | Description |
|
|
376
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
377
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
378
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
379
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
380
|
+
|
|
381
|
+
### Response
|
|
382
|
+
|
|
383
|
+
**Promise\<[models.WebhookDtoCustomerWebhookPayload](../../sdk/models/webhook-dto-customer-webhook-payload.md)\>**
|
|
384
|
+
|
|
385
|
+
### Errors
|
|
386
|
+
|
|
387
|
+
| Error Type | Status Code | Content Type |
|
|
388
|
+
| --------------- | --------------- | --------------- |
|
|
389
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
390
|
+
|
|
391
|
+
## postWebhookEventsEntitlementCreated
|
|
392
|
+
|
|
393
|
+
Fired when a new entitlement is created. Doc-only for parsing.
|
|
394
|
+
|
|
395
|
+
### Example Usage
|
|
396
|
+
|
|
397
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/entitlement.created" method="post" path="/webhook-events/entitlement.created" -->
|
|
398
|
+
```typescript
|
|
399
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
400
|
+
|
|
401
|
+
const flexprice = new Flexprice({
|
|
402
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
403
|
+
});
|
|
404
|
+
|
|
405
|
+
async function run() {
|
|
406
|
+
const result = await flexprice.webhookEvents.postWebhookEventsEntitlementCreated();
|
|
407
|
+
|
|
408
|
+
console.log(result);
|
|
409
|
+
}
|
|
410
|
+
|
|
411
|
+
run();
|
|
412
|
+
```
|
|
413
|
+
|
|
414
|
+
### Standalone function
|
|
415
|
+
|
|
416
|
+
The standalone function version of this method:
|
|
417
|
+
|
|
418
|
+
```typescript
|
|
419
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
420
|
+
import { webhookEventsPostWebhookEventsEntitlementCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-entitlement-created.js";
|
|
421
|
+
|
|
422
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
423
|
+
// You can create one instance of it to use across an application.
|
|
424
|
+
const flexprice = new FlexpriceCore({
|
|
425
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
426
|
+
});
|
|
427
|
+
|
|
428
|
+
async function run() {
|
|
429
|
+
const res = await webhookEventsPostWebhookEventsEntitlementCreated(flexprice);
|
|
430
|
+
if (res.ok) {
|
|
431
|
+
const { value: result } = res;
|
|
432
|
+
console.log(result);
|
|
433
|
+
} else {
|
|
434
|
+
console.log("webhookEventsPostWebhookEventsEntitlementCreated failed:", res.error);
|
|
435
|
+
}
|
|
436
|
+
}
|
|
437
|
+
|
|
438
|
+
run();
|
|
439
|
+
```
|
|
440
|
+
|
|
441
|
+
### Parameters
|
|
442
|
+
|
|
443
|
+
| Parameter | Type | Required | Description |
|
|
444
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
445
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
446
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
447
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
448
|
+
|
|
449
|
+
### Response
|
|
450
|
+
|
|
451
|
+
**Promise\<[models.WebhookDtoEntitlementWebhookPayload](../../sdk/models/webhook-dto-entitlement-webhook-payload.md)\>**
|
|
452
|
+
|
|
453
|
+
### Errors
|
|
454
|
+
|
|
455
|
+
| Error Type | Status Code | Content Type |
|
|
456
|
+
| --------------- | --------------- | --------------- |
|
|
457
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
458
|
+
|
|
459
|
+
## postWebhookEventsEntitlementDeleted
|
|
460
|
+
|
|
461
|
+
Fired when an entitlement is deleted. Doc-only for parsing.
|
|
462
|
+
|
|
463
|
+
### Example Usage
|
|
464
|
+
|
|
465
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/entitlement.deleted" method="post" path="/webhook-events/entitlement.deleted" -->
|
|
466
|
+
```typescript
|
|
467
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
468
|
+
|
|
469
|
+
const flexprice = new Flexprice({
|
|
470
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
471
|
+
});
|
|
472
|
+
|
|
473
|
+
async function run() {
|
|
474
|
+
const result = await flexprice.webhookEvents.postWebhookEventsEntitlementDeleted();
|
|
475
|
+
|
|
476
|
+
console.log(result);
|
|
477
|
+
}
|
|
478
|
+
|
|
479
|
+
run();
|
|
480
|
+
```
|
|
481
|
+
|
|
482
|
+
### Standalone function
|
|
483
|
+
|
|
484
|
+
The standalone function version of this method:
|
|
485
|
+
|
|
486
|
+
```typescript
|
|
487
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
488
|
+
import { webhookEventsPostWebhookEventsEntitlementDeleted } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-entitlement-deleted.js";
|
|
489
|
+
|
|
490
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
491
|
+
// You can create one instance of it to use across an application.
|
|
492
|
+
const flexprice = new FlexpriceCore({
|
|
493
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
494
|
+
});
|
|
495
|
+
|
|
496
|
+
async function run() {
|
|
497
|
+
const res = await webhookEventsPostWebhookEventsEntitlementDeleted(flexprice);
|
|
498
|
+
if (res.ok) {
|
|
499
|
+
const { value: result } = res;
|
|
500
|
+
console.log(result);
|
|
501
|
+
} else {
|
|
502
|
+
console.log("webhookEventsPostWebhookEventsEntitlementDeleted failed:", res.error);
|
|
503
|
+
}
|
|
504
|
+
}
|
|
505
|
+
|
|
506
|
+
run();
|
|
507
|
+
```
|
|
508
|
+
|
|
509
|
+
### Parameters
|
|
510
|
+
|
|
511
|
+
| Parameter | Type | Required | Description |
|
|
512
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
513
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
514
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
515
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
516
|
+
|
|
517
|
+
### Response
|
|
518
|
+
|
|
519
|
+
**Promise\<[models.WebhookDtoEntitlementWebhookPayload](../../sdk/models/webhook-dto-entitlement-webhook-payload.md)\>**
|
|
520
|
+
|
|
521
|
+
### Errors
|
|
522
|
+
|
|
523
|
+
| Error Type | Status Code | Content Type |
|
|
524
|
+
| --------------- | --------------- | --------------- |
|
|
525
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
526
|
+
|
|
527
|
+
## postWebhookEventsEntitlementUpdated
|
|
528
|
+
|
|
529
|
+
Fired when an entitlement is updated. Doc-only for parsing.
|
|
530
|
+
|
|
531
|
+
### Example Usage
|
|
532
|
+
|
|
533
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/entitlement.updated" method="post" path="/webhook-events/entitlement.updated" -->
|
|
534
|
+
```typescript
|
|
535
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
536
|
+
|
|
537
|
+
const flexprice = new Flexprice({
|
|
538
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
539
|
+
});
|
|
540
|
+
|
|
541
|
+
async function run() {
|
|
542
|
+
const result = await flexprice.webhookEvents.postWebhookEventsEntitlementUpdated();
|
|
543
|
+
|
|
544
|
+
console.log(result);
|
|
545
|
+
}
|
|
546
|
+
|
|
547
|
+
run();
|
|
548
|
+
```
|
|
549
|
+
|
|
550
|
+
### Standalone function
|
|
551
|
+
|
|
552
|
+
The standalone function version of this method:
|
|
553
|
+
|
|
554
|
+
```typescript
|
|
555
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
556
|
+
import { webhookEventsPostWebhookEventsEntitlementUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-entitlement-updated.js";
|
|
557
|
+
|
|
558
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
559
|
+
// You can create one instance of it to use across an application.
|
|
560
|
+
const flexprice = new FlexpriceCore({
|
|
561
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
562
|
+
});
|
|
563
|
+
|
|
564
|
+
async function run() {
|
|
565
|
+
const res = await webhookEventsPostWebhookEventsEntitlementUpdated(flexprice);
|
|
566
|
+
if (res.ok) {
|
|
567
|
+
const { value: result } = res;
|
|
568
|
+
console.log(result);
|
|
569
|
+
} else {
|
|
570
|
+
console.log("webhookEventsPostWebhookEventsEntitlementUpdated failed:", res.error);
|
|
571
|
+
}
|
|
572
|
+
}
|
|
573
|
+
|
|
574
|
+
run();
|
|
575
|
+
```
|
|
576
|
+
|
|
577
|
+
### Parameters
|
|
578
|
+
|
|
579
|
+
| Parameter | Type | Required | Description |
|
|
580
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
581
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
582
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
583
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
584
|
+
|
|
585
|
+
### Response
|
|
586
|
+
|
|
587
|
+
**Promise\<[models.WebhookDtoEntitlementWebhookPayload](../../sdk/models/webhook-dto-entitlement-webhook-payload.md)\>**
|
|
588
|
+
|
|
589
|
+
### Errors
|
|
590
|
+
|
|
591
|
+
| Error Type | Status Code | Content Type |
|
|
592
|
+
| --------------- | --------------- | --------------- |
|
|
593
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
594
|
+
|
|
595
|
+
## postWebhookEventsFeatureCreated
|
|
596
|
+
|
|
597
|
+
Fired when a new feature is created. Doc-only for parsing.
|
|
598
|
+
|
|
599
|
+
### Example Usage
|
|
600
|
+
|
|
601
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/feature.created" method="post" path="/webhook-events/feature.created" -->
|
|
602
|
+
```typescript
|
|
603
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
604
|
+
|
|
605
|
+
const flexprice = new Flexprice({
|
|
606
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
607
|
+
});
|
|
608
|
+
|
|
609
|
+
async function run() {
|
|
610
|
+
const result = await flexprice.webhookEvents.postWebhookEventsFeatureCreated();
|
|
611
|
+
|
|
612
|
+
console.log(result);
|
|
613
|
+
}
|
|
614
|
+
|
|
615
|
+
run();
|
|
616
|
+
```
|
|
617
|
+
|
|
618
|
+
### Standalone function
|
|
619
|
+
|
|
620
|
+
The standalone function version of this method:
|
|
621
|
+
|
|
622
|
+
```typescript
|
|
623
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
624
|
+
import { webhookEventsPostWebhookEventsFeatureCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-feature-created.js";
|
|
625
|
+
|
|
626
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
627
|
+
// You can create one instance of it to use across an application.
|
|
628
|
+
const flexprice = new FlexpriceCore({
|
|
629
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
630
|
+
});
|
|
631
|
+
|
|
632
|
+
async function run() {
|
|
633
|
+
const res = await webhookEventsPostWebhookEventsFeatureCreated(flexprice);
|
|
634
|
+
if (res.ok) {
|
|
635
|
+
const { value: result } = res;
|
|
636
|
+
console.log(result);
|
|
637
|
+
} else {
|
|
638
|
+
console.log("webhookEventsPostWebhookEventsFeatureCreated failed:", res.error);
|
|
639
|
+
}
|
|
640
|
+
}
|
|
641
|
+
|
|
642
|
+
run();
|
|
643
|
+
```
|
|
644
|
+
|
|
645
|
+
### Parameters
|
|
646
|
+
|
|
647
|
+
| Parameter | Type | Required | Description |
|
|
648
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
649
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
650
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
651
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
652
|
+
|
|
653
|
+
### Response
|
|
654
|
+
|
|
655
|
+
**Promise\<[models.WebhookDtoFeatureWebhookPayload](../../sdk/models/webhook-dto-feature-webhook-payload.md)\>**
|
|
656
|
+
|
|
657
|
+
### Errors
|
|
658
|
+
|
|
659
|
+
| Error Type | Status Code | Content Type |
|
|
660
|
+
| --------------- | --------------- | --------------- |
|
|
661
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
662
|
+
|
|
663
|
+
## postWebhookEventsFeatureDeleted
|
|
664
|
+
|
|
665
|
+
Fired when a feature is deleted. Doc-only for parsing.
|
|
666
|
+
|
|
667
|
+
### Example Usage
|
|
668
|
+
|
|
669
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/feature.deleted" method="post" path="/webhook-events/feature.deleted" -->
|
|
670
|
+
```typescript
|
|
671
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
672
|
+
|
|
673
|
+
const flexprice = new Flexprice({
|
|
674
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
675
|
+
});
|
|
676
|
+
|
|
677
|
+
async function run() {
|
|
678
|
+
const result = await flexprice.webhookEvents.postWebhookEventsFeatureDeleted();
|
|
679
|
+
|
|
680
|
+
console.log(result);
|
|
681
|
+
}
|
|
682
|
+
|
|
683
|
+
run();
|
|
684
|
+
```
|
|
685
|
+
|
|
686
|
+
### Standalone function
|
|
687
|
+
|
|
688
|
+
The standalone function version of this method:
|
|
689
|
+
|
|
690
|
+
```typescript
|
|
691
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
692
|
+
import { webhookEventsPostWebhookEventsFeatureDeleted } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-feature-deleted.js";
|
|
693
|
+
|
|
694
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
695
|
+
// You can create one instance of it to use across an application.
|
|
696
|
+
const flexprice = new FlexpriceCore({
|
|
697
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
698
|
+
});
|
|
699
|
+
|
|
700
|
+
async function run() {
|
|
701
|
+
const res = await webhookEventsPostWebhookEventsFeatureDeleted(flexprice);
|
|
702
|
+
if (res.ok) {
|
|
703
|
+
const { value: result } = res;
|
|
704
|
+
console.log(result);
|
|
705
|
+
} else {
|
|
706
|
+
console.log("webhookEventsPostWebhookEventsFeatureDeleted failed:", res.error);
|
|
707
|
+
}
|
|
708
|
+
}
|
|
709
|
+
|
|
710
|
+
run();
|
|
711
|
+
```
|
|
712
|
+
|
|
713
|
+
### Parameters
|
|
714
|
+
|
|
715
|
+
| Parameter | Type | Required | Description |
|
|
716
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
717
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
718
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
719
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
720
|
+
|
|
721
|
+
### Response
|
|
722
|
+
|
|
723
|
+
**Promise\<[models.WebhookDtoFeatureWebhookPayload](../../sdk/models/webhook-dto-feature-webhook-payload.md)\>**
|
|
724
|
+
|
|
725
|
+
### Errors
|
|
726
|
+
|
|
727
|
+
| Error Type | Status Code | Content Type |
|
|
728
|
+
| --------------- | --------------- | --------------- |
|
|
729
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
730
|
+
|
|
731
|
+
## postWebhookEventsFeatureUpdated
|
|
732
|
+
|
|
733
|
+
Fired when a feature is updated. Doc-only for parsing.
|
|
734
|
+
|
|
735
|
+
### Example Usage
|
|
736
|
+
|
|
737
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/feature.updated" method="post" path="/webhook-events/feature.updated" -->
|
|
738
|
+
```typescript
|
|
739
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
740
|
+
|
|
741
|
+
const flexprice = new Flexprice({
|
|
742
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
743
|
+
});
|
|
744
|
+
|
|
745
|
+
async function run() {
|
|
746
|
+
const result = await flexprice.webhookEvents.postWebhookEventsFeatureUpdated();
|
|
747
|
+
|
|
748
|
+
console.log(result);
|
|
749
|
+
}
|
|
750
|
+
|
|
751
|
+
run();
|
|
752
|
+
```
|
|
753
|
+
|
|
754
|
+
### Standalone function
|
|
755
|
+
|
|
756
|
+
The standalone function version of this method:
|
|
757
|
+
|
|
758
|
+
```typescript
|
|
759
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
760
|
+
import { webhookEventsPostWebhookEventsFeatureUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-feature-updated.js";
|
|
761
|
+
|
|
762
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
763
|
+
// You can create one instance of it to use across an application.
|
|
764
|
+
const flexprice = new FlexpriceCore({
|
|
765
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
766
|
+
});
|
|
767
|
+
|
|
768
|
+
async function run() {
|
|
769
|
+
const res = await webhookEventsPostWebhookEventsFeatureUpdated(flexprice);
|
|
770
|
+
if (res.ok) {
|
|
771
|
+
const { value: result } = res;
|
|
772
|
+
console.log(result);
|
|
773
|
+
} else {
|
|
774
|
+
console.log("webhookEventsPostWebhookEventsFeatureUpdated failed:", res.error);
|
|
775
|
+
}
|
|
776
|
+
}
|
|
777
|
+
|
|
778
|
+
run();
|
|
779
|
+
```
|
|
780
|
+
|
|
781
|
+
### Parameters
|
|
782
|
+
|
|
783
|
+
| Parameter | Type | Required | Description |
|
|
784
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
785
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
786
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
787
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
788
|
+
|
|
789
|
+
### Response
|
|
790
|
+
|
|
791
|
+
**Promise\<[models.WebhookDtoFeatureWebhookPayload](../../sdk/models/webhook-dto-feature-webhook-payload.md)\>**
|
|
792
|
+
|
|
793
|
+
### Errors
|
|
794
|
+
|
|
795
|
+
| Error Type | Status Code | Content Type |
|
|
796
|
+
| --------------- | --------------- | --------------- |
|
|
797
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
798
|
+
|
|
799
|
+
## postWebhookEventsFeatureWalletBalanceAlert
|
|
800
|
+
|
|
801
|
+
Fired when a feature's associated wallet balance crosses an alert threshold. Doc-only for parsing.
|
|
802
|
+
|
|
803
|
+
### Example Usage
|
|
804
|
+
|
|
805
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/feature.wallet_balance.alert" method="post" path="/webhook-events/feature.wallet_balance.alert" -->
|
|
806
|
+
```typescript
|
|
807
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
808
|
+
|
|
809
|
+
const flexprice = new Flexprice({
|
|
810
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
811
|
+
});
|
|
812
|
+
|
|
813
|
+
async function run() {
|
|
814
|
+
const result = await flexprice.webhookEvents.postWebhookEventsFeatureWalletBalanceAlert();
|
|
815
|
+
|
|
816
|
+
console.log(result);
|
|
817
|
+
}
|
|
818
|
+
|
|
819
|
+
run();
|
|
820
|
+
```
|
|
821
|
+
|
|
822
|
+
### Standalone function
|
|
823
|
+
|
|
824
|
+
The standalone function version of this method:
|
|
825
|
+
|
|
826
|
+
```typescript
|
|
827
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
828
|
+
import { webhookEventsPostWebhookEventsFeatureWalletBalanceAlert } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-feature-wallet-balance-alert.js";
|
|
829
|
+
|
|
830
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
831
|
+
// You can create one instance of it to use across an application.
|
|
832
|
+
const flexprice = new FlexpriceCore({
|
|
833
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
834
|
+
});
|
|
835
|
+
|
|
836
|
+
async function run() {
|
|
837
|
+
const res = await webhookEventsPostWebhookEventsFeatureWalletBalanceAlert(flexprice);
|
|
838
|
+
if (res.ok) {
|
|
839
|
+
const { value: result } = res;
|
|
840
|
+
console.log(result);
|
|
841
|
+
} else {
|
|
842
|
+
console.log("webhookEventsPostWebhookEventsFeatureWalletBalanceAlert failed:", res.error);
|
|
843
|
+
}
|
|
844
|
+
}
|
|
845
|
+
|
|
846
|
+
run();
|
|
847
|
+
```
|
|
848
|
+
|
|
849
|
+
### Parameters
|
|
850
|
+
|
|
851
|
+
| Parameter | Type | Required | Description |
|
|
852
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
853
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
854
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
855
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
856
|
+
|
|
857
|
+
### Response
|
|
858
|
+
|
|
859
|
+
**Promise\<[models.WebhookDtoAlertWebhookPayload](../../sdk/models/webhook-dto-alert-webhook-payload.md)\>**
|
|
860
|
+
|
|
861
|
+
### Errors
|
|
862
|
+
|
|
863
|
+
| Error Type | Status Code | Content Type |
|
|
864
|
+
| --------------- | --------------- | --------------- |
|
|
865
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
866
|
+
|
|
867
|
+
## postWebhookEventsInvoiceCommunicationTriggered
|
|
868
|
+
|
|
869
|
+
Fired when an invoice communication (e.g. email notification) is triggered. Doc-only for parsing.
|
|
870
|
+
|
|
871
|
+
### Example Usage
|
|
872
|
+
|
|
873
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/invoice.communication.triggered" method="post" path="/webhook-events/invoice.communication.triggered" -->
|
|
874
|
+
```typescript
|
|
875
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
876
|
+
|
|
877
|
+
const flexprice = new Flexprice({
|
|
878
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
879
|
+
});
|
|
880
|
+
|
|
881
|
+
async function run() {
|
|
882
|
+
const result = await flexprice.webhookEvents.postWebhookEventsInvoiceCommunicationTriggered();
|
|
883
|
+
|
|
884
|
+
console.log(result);
|
|
885
|
+
}
|
|
886
|
+
|
|
887
|
+
run();
|
|
888
|
+
```
|
|
889
|
+
|
|
890
|
+
### Standalone function
|
|
891
|
+
|
|
892
|
+
The standalone function version of this method:
|
|
893
|
+
|
|
894
|
+
```typescript
|
|
895
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
896
|
+
import { webhookEventsPostWebhookEventsInvoiceCommunicationTriggered } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-invoice-communication-triggered.js";
|
|
897
|
+
|
|
898
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
899
|
+
// You can create one instance of it to use across an application.
|
|
900
|
+
const flexprice = new FlexpriceCore({
|
|
901
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
902
|
+
});
|
|
903
|
+
|
|
904
|
+
async function run() {
|
|
905
|
+
const res = await webhookEventsPostWebhookEventsInvoiceCommunicationTriggered(flexprice);
|
|
906
|
+
if (res.ok) {
|
|
907
|
+
const { value: result } = res;
|
|
908
|
+
console.log(result);
|
|
909
|
+
} else {
|
|
910
|
+
console.log("webhookEventsPostWebhookEventsInvoiceCommunicationTriggered failed:", res.error);
|
|
911
|
+
}
|
|
912
|
+
}
|
|
913
|
+
|
|
914
|
+
run();
|
|
915
|
+
```
|
|
916
|
+
|
|
917
|
+
### Parameters
|
|
918
|
+
|
|
919
|
+
| Parameter | Type | Required | Description |
|
|
920
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
921
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
922
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
923
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
924
|
+
|
|
925
|
+
### Response
|
|
926
|
+
|
|
927
|
+
**Promise\<[models.WebhookDtoCommunicationWebhookPayload](../../sdk/models/webhook-dto-communication-webhook-payload.md)\>**
|
|
928
|
+
|
|
929
|
+
### Errors
|
|
930
|
+
|
|
931
|
+
| Error Type | Status Code | Content Type |
|
|
932
|
+
| --------------- | --------------- | --------------- |
|
|
933
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
934
|
+
|
|
935
|
+
## postWebhookEventsInvoiceCreateDrafted
|
|
936
|
+
|
|
937
|
+
Fired when a new invoice is created in draft status. Doc-only for parsing.
|
|
938
|
+
|
|
939
|
+
### Example Usage
|
|
940
|
+
|
|
941
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/invoice.create.drafted" method="post" path="/webhook-events/invoice.create.drafted" -->
|
|
942
|
+
```typescript
|
|
943
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
944
|
+
|
|
945
|
+
const flexprice = new Flexprice({
|
|
946
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
947
|
+
});
|
|
948
|
+
|
|
949
|
+
async function run() {
|
|
950
|
+
const result = await flexprice.webhookEvents.postWebhookEventsInvoiceCreateDrafted();
|
|
951
|
+
|
|
952
|
+
console.log(result);
|
|
953
|
+
}
|
|
954
|
+
|
|
955
|
+
run();
|
|
956
|
+
```
|
|
957
|
+
|
|
958
|
+
### Standalone function
|
|
959
|
+
|
|
960
|
+
The standalone function version of this method:
|
|
961
|
+
|
|
962
|
+
```typescript
|
|
963
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
964
|
+
import { webhookEventsPostWebhookEventsInvoiceCreateDrafted } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-invoice-create-drafted.js";
|
|
965
|
+
|
|
966
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
967
|
+
// You can create one instance of it to use across an application.
|
|
968
|
+
const flexprice = new FlexpriceCore({
|
|
969
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
970
|
+
});
|
|
971
|
+
|
|
972
|
+
async function run() {
|
|
973
|
+
const res = await webhookEventsPostWebhookEventsInvoiceCreateDrafted(flexprice);
|
|
974
|
+
if (res.ok) {
|
|
975
|
+
const { value: result } = res;
|
|
976
|
+
console.log(result);
|
|
977
|
+
} else {
|
|
978
|
+
console.log("webhookEventsPostWebhookEventsInvoiceCreateDrafted failed:", res.error);
|
|
979
|
+
}
|
|
980
|
+
}
|
|
981
|
+
|
|
982
|
+
run();
|
|
983
|
+
```
|
|
984
|
+
|
|
985
|
+
### Parameters
|
|
986
|
+
|
|
987
|
+
| Parameter | Type | Required | Description |
|
|
988
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
989
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
990
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
991
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
992
|
+
|
|
993
|
+
### Response
|
|
994
|
+
|
|
995
|
+
**Promise\<[models.WebhookDtoInvoiceWebhookPayload](../../sdk/models/webhook-dto-invoice-webhook-payload.md)\>**
|
|
996
|
+
|
|
997
|
+
### Errors
|
|
998
|
+
|
|
999
|
+
| Error Type | Status Code | Content Type |
|
|
1000
|
+
| --------------- | --------------- | --------------- |
|
|
1001
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1002
|
+
|
|
1003
|
+
## postWebhookEventsInvoicePaymentOverdue
|
|
1004
|
+
|
|
1005
|
+
Fired when an invoice payment is overdue past the due date. Doc-only for parsing.
|
|
1006
|
+
|
|
1007
|
+
### Example Usage
|
|
1008
|
+
|
|
1009
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/invoice.payment.overdue" method="post" path="/webhook-events/invoice.payment.overdue" -->
|
|
1010
|
+
```typescript
|
|
1011
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1012
|
+
|
|
1013
|
+
const flexprice = new Flexprice({
|
|
1014
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1015
|
+
});
|
|
1016
|
+
|
|
1017
|
+
async function run() {
|
|
1018
|
+
const result = await flexprice.webhookEvents.postWebhookEventsInvoicePaymentOverdue();
|
|
1019
|
+
|
|
1020
|
+
console.log(result);
|
|
1021
|
+
}
|
|
1022
|
+
|
|
1023
|
+
run();
|
|
1024
|
+
```
|
|
1025
|
+
|
|
1026
|
+
### Standalone function
|
|
1027
|
+
|
|
1028
|
+
The standalone function version of this method:
|
|
1029
|
+
|
|
1030
|
+
```typescript
|
|
1031
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1032
|
+
import { webhookEventsPostWebhookEventsInvoicePaymentOverdue } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-invoice-payment-overdue.js";
|
|
1033
|
+
|
|
1034
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1035
|
+
// You can create one instance of it to use across an application.
|
|
1036
|
+
const flexprice = new FlexpriceCore({
|
|
1037
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1038
|
+
});
|
|
1039
|
+
|
|
1040
|
+
async function run() {
|
|
1041
|
+
const res = await webhookEventsPostWebhookEventsInvoicePaymentOverdue(flexprice);
|
|
1042
|
+
if (res.ok) {
|
|
1043
|
+
const { value: result } = res;
|
|
1044
|
+
console.log(result);
|
|
1045
|
+
} else {
|
|
1046
|
+
console.log("webhookEventsPostWebhookEventsInvoicePaymentOverdue failed:", res.error);
|
|
1047
|
+
}
|
|
1048
|
+
}
|
|
1049
|
+
|
|
1050
|
+
run();
|
|
1051
|
+
```
|
|
1052
|
+
|
|
1053
|
+
### Parameters
|
|
1054
|
+
|
|
1055
|
+
| Parameter | Type | Required | Description |
|
|
1056
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1057
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1058
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1059
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1060
|
+
|
|
1061
|
+
### Response
|
|
1062
|
+
|
|
1063
|
+
**Promise\<[models.WebhookDtoInvoiceWebhookPayload](../../sdk/models/webhook-dto-invoice-webhook-payload.md)\>**
|
|
1064
|
+
|
|
1065
|
+
### Errors
|
|
1066
|
+
|
|
1067
|
+
| Error Type | Status Code | Content Type |
|
|
1068
|
+
| --------------- | --------------- | --------------- |
|
|
1069
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1070
|
+
|
|
1071
|
+
## postWebhookEventsInvoiceUpdate
|
|
1072
|
+
|
|
1073
|
+
Fired when an invoice is updated. Doc-only for parsing.
|
|
1074
|
+
|
|
1075
|
+
### Example Usage
|
|
1076
|
+
|
|
1077
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/invoice.update" method="post" path="/webhook-events/invoice.update" -->
|
|
1078
|
+
```typescript
|
|
1079
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1080
|
+
|
|
1081
|
+
const flexprice = new Flexprice({
|
|
1082
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1083
|
+
});
|
|
1084
|
+
|
|
1085
|
+
async function run() {
|
|
1086
|
+
const result = await flexprice.webhookEvents.postWebhookEventsInvoiceUpdate();
|
|
1087
|
+
|
|
1088
|
+
console.log(result);
|
|
1089
|
+
}
|
|
1090
|
+
|
|
1091
|
+
run();
|
|
1092
|
+
```
|
|
1093
|
+
|
|
1094
|
+
### Standalone function
|
|
1095
|
+
|
|
1096
|
+
The standalone function version of this method:
|
|
1097
|
+
|
|
1098
|
+
```typescript
|
|
1099
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1100
|
+
import { webhookEventsPostWebhookEventsInvoiceUpdate } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-invoice-update.js";
|
|
1101
|
+
|
|
1102
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1103
|
+
// You can create one instance of it to use across an application.
|
|
1104
|
+
const flexprice = new FlexpriceCore({
|
|
1105
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1106
|
+
});
|
|
1107
|
+
|
|
1108
|
+
async function run() {
|
|
1109
|
+
const res = await webhookEventsPostWebhookEventsInvoiceUpdate(flexprice);
|
|
1110
|
+
if (res.ok) {
|
|
1111
|
+
const { value: result } = res;
|
|
1112
|
+
console.log(result);
|
|
1113
|
+
} else {
|
|
1114
|
+
console.log("webhookEventsPostWebhookEventsInvoiceUpdate failed:", res.error);
|
|
1115
|
+
}
|
|
1116
|
+
}
|
|
1117
|
+
|
|
1118
|
+
run();
|
|
1119
|
+
```
|
|
1120
|
+
|
|
1121
|
+
### Parameters
|
|
1122
|
+
|
|
1123
|
+
| Parameter | Type | Required | Description |
|
|
1124
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1125
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1126
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1127
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1128
|
+
|
|
1129
|
+
### Response
|
|
1130
|
+
|
|
1131
|
+
**Promise\<[models.WebhookDtoInvoiceWebhookPayload](../../sdk/models/webhook-dto-invoice-webhook-payload.md)\>**
|
|
1132
|
+
|
|
1133
|
+
### Errors
|
|
1134
|
+
|
|
1135
|
+
| Error Type | Status Code | Content Type |
|
|
1136
|
+
| --------------- | --------------- | --------------- |
|
|
1137
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1138
|
+
|
|
1139
|
+
## postWebhookEventsInvoiceUpdateFinalized
|
|
1140
|
+
|
|
1141
|
+
Fired when an invoice is finalized and locked for payment. Doc-only for parsing.
|
|
1142
|
+
|
|
1143
|
+
### Example Usage
|
|
1144
|
+
|
|
1145
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/invoice.update.finalized" method="post" path="/webhook-events/invoice.update.finalized" -->
|
|
1146
|
+
```typescript
|
|
1147
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1148
|
+
|
|
1149
|
+
const flexprice = new Flexprice({
|
|
1150
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1151
|
+
});
|
|
1152
|
+
|
|
1153
|
+
async function run() {
|
|
1154
|
+
const result = await flexprice.webhookEvents.postWebhookEventsInvoiceUpdateFinalized();
|
|
1155
|
+
|
|
1156
|
+
console.log(result);
|
|
1157
|
+
}
|
|
1158
|
+
|
|
1159
|
+
run();
|
|
1160
|
+
```
|
|
1161
|
+
|
|
1162
|
+
### Standalone function
|
|
1163
|
+
|
|
1164
|
+
The standalone function version of this method:
|
|
1165
|
+
|
|
1166
|
+
```typescript
|
|
1167
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1168
|
+
import { webhookEventsPostWebhookEventsInvoiceUpdateFinalized } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-invoice-update-finalized.js";
|
|
1169
|
+
|
|
1170
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1171
|
+
// You can create one instance of it to use across an application.
|
|
1172
|
+
const flexprice = new FlexpriceCore({
|
|
1173
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1174
|
+
});
|
|
1175
|
+
|
|
1176
|
+
async function run() {
|
|
1177
|
+
const res = await webhookEventsPostWebhookEventsInvoiceUpdateFinalized(flexprice);
|
|
1178
|
+
if (res.ok) {
|
|
1179
|
+
const { value: result } = res;
|
|
1180
|
+
console.log(result);
|
|
1181
|
+
} else {
|
|
1182
|
+
console.log("webhookEventsPostWebhookEventsInvoiceUpdateFinalized failed:", res.error);
|
|
1183
|
+
}
|
|
1184
|
+
}
|
|
1185
|
+
|
|
1186
|
+
run();
|
|
1187
|
+
```
|
|
1188
|
+
|
|
1189
|
+
### Parameters
|
|
1190
|
+
|
|
1191
|
+
| Parameter | Type | Required | Description |
|
|
1192
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1193
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1194
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1195
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1196
|
+
|
|
1197
|
+
### Response
|
|
1198
|
+
|
|
1199
|
+
**Promise\<[models.WebhookDtoInvoiceWebhookPayload](../../sdk/models/webhook-dto-invoice-webhook-payload.md)\>**
|
|
1200
|
+
|
|
1201
|
+
### Errors
|
|
1202
|
+
|
|
1203
|
+
| Error Type | Status Code | Content Type |
|
|
1204
|
+
| --------------- | --------------- | --------------- |
|
|
1205
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1206
|
+
|
|
1207
|
+
## postWebhookEventsInvoiceUpdatePayment
|
|
1208
|
+
|
|
1209
|
+
Fired when an invoice payment status changes. Doc-only for parsing.
|
|
1210
|
+
|
|
1211
|
+
### Example Usage
|
|
1212
|
+
|
|
1213
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/invoice.update.payment" method="post" path="/webhook-events/invoice.update.payment" -->
|
|
1214
|
+
```typescript
|
|
1215
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1216
|
+
|
|
1217
|
+
const flexprice = new Flexprice({
|
|
1218
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1219
|
+
});
|
|
1220
|
+
|
|
1221
|
+
async function run() {
|
|
1222
|
+
const result = await flexprice.webhookEvents.postWebhookEventsInvoiceUpdatePayment();
|
|
1223
|
+
|
|
1224
|
+
console.log(result);
|
|
1225
|
+
}
|
|
1226
|
+
|
|
1227
|
+
run();
|
|
1228
|
+
```
|
|
1229
|
+
|
|
1230
|
+
### Standalone function
|
|
1231
|
+
|
|
1232
|
+
The standalone function version of this method:
|
|
1233
|
+
|
|
1234
|
+
```typescript
|
|
1235
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1236
|
+
import { webhookEventsPostWebhookEventsInvoiceUpdatePayment } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-invoice-update-payment.js";
|
|
1237
|
+
|
|
1238
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1239
|
+
// You can create one instance of it to use across an application.
|
|
1240
|
+
const flexprice = new FlexpriceCore({
|
|
1241
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1242
|
+
});
|
|
1243
|
+
|
|
1244
|
+
async function run() {
|
|
1245
|
+
const res = await webhookEventsPostWebhookEventsInvoiceUpdatePayment(flexprice);
|
|
1246
|
+
if (res.ok) {
|
|
1247
|
+
const { value: result } = res;
|
|
1248
|
+
console.log(result);
|
|
1249
|
+
} else {
|
|
1250
|
+
console.log("webhookEventsPostWebhookEventsInvoiceUpdatePayment failed:", res.error);
|
|
1251
|
+
}
|
|
1252
|
+
}
|
|
1253
|
+
|
|
1254
|
+
run();
|
|
1255
|
+
```
|
|
1256
|
+
|
|
1257
|
+
### Parameters
|
|
1258
|
+
|
|
1259
|
+
| Parameter | Type | Required | Description |
|
|
1260
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1261
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1262
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1263
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1264
|
+
|
|
1265
|
+
### Response
|
|
1266
|
+
|
|
1267
|
+
**Promise\<[models.WebhookDtoInvoiceWebhookPayload](../../sdk/models/webhook-dto-invoice-webhook-payload.md)\>**
|
|
1268
|
+
|
|
1269
|
+
### Errors
|
|
1270
|
+
|
|
1271
|
+
| Error Type | Status Code | Content Type |
|
|
1272
|
+
| --------------- | --------------- | --------------- |
|
|
1273
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1274
|
+
|
|
1275
|
+
## postWebhookEventsInvoiceUpdateVoided
|
|
1276
|
+
|
|
1277
|
+
Fired when an invoice is voided (e.g. order cancelled or duplicate). Doc-only for parsing.
|
|
1278
|
+
|
|
1279
|
+
### Example Usage
|
|
1280
|
+
|
|
1281
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/invoice.update.voided" method="post" path="/webhook-events/invoice.update.voided" -->
|
|
1282
|
+
```typescript
|
|
1283
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1284
|
+
|
|
1285
|
+
const flexprice = new Flexprice({
|
|
1286
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1287
|
+
});
|
|
1288
|
+
|
|
1289
|
+
async function run() {
|
|
1290
|
+
const result = await flexprice.webhookEvents.postWebhookEventsInvoiceUpdateVoided();
|
|
1291
|
+
|
|
1292
|
+
console.log(result);
|
|
1293
|
+
}
|
|
1294
|
+
|
|
1295
|
+
run();
|
|
1296
|
+
```
|
|
1297
|
+
|
|
1298
|
+
### Standalone function
|
|
1299
|
+
|
|
1300
|
+
The standalone function version of this method:
|
|
1301
|
+
|
|
1302
|
+
```typescript
|
|
1303
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1304
|
+
import { webhookEventsPostWebhookEventsInvoiceUpdateVoided } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-invoice-update-voided.js";
|
|
1305
|
+
|
|
1306
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1307
|
+
// You can create one instance of it to use across an application.
|
|
1308
|
+
const flexprice = new FlexpriceCore({
|
|
1309
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1310
|
+
});
|
|
1311
|
+
|
|
1312
|
+
async function run() {
|
|
1313
|
+
const res = await webhookEventsPostWebhookEventsInvoiceUpdateVoided(flexprice);
|
|
1314
|
+
if (res.ok) {
|
|
1315
|
+
const { value: result } = res;
|
|
1316
|
+
console.log(result);
|
|
1317
|
+
} else {
|
|
1318
|
+
console.log("webhookEventsPostWebhookEventsInvoiceUpdateVoided failed:", res.error);
|
|
1319
|
+
}
|
|
1320
|
+
}
|
|
1321
|
+
|
|
1322
|
+
run();
|
|
1323
|
+
```
|
|
1324
|
+
|
|
1325
|
+
### Parameters
|
|
1326
|
+
|
|
1327
|
+
| Parameter | Type | Required | Description |
|
|
1328
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1329
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1330
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1331
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1332
|
+
|
|
1333
|
+
### Response
|
|
1334
|
+
|
|
1335
|
+
**Promise\<[models.WebhookDtoInvoiceWebhookPayload](../../sdk/models/webhook-dto-invoice-webhook-payload.md)\>**
|
|
1336
|
+
|
|
1337
|
+
### Errors
|
|
1338
|
+
|
|
1339
|
+
| Error Type | Status Code | Content Type |
|
|
1340
|
+
| --------------- | --------------- | --------------- |
|
|
1341
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1342
|
+
|
|
1343
|
+
## postWebhookEventsPaymentCreated
|
|
1344
|
+
|
|
1345
|
+
Fired when a new payment is created. Doc-only for parsing.
|
|
1346
|
+
|
|
1347
|
+
### Example Usage
|
|
1348
|
+
|
|
1349
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/payment.created" method="post" path="/webhook-events/payment.created" -->
|
|
1350
|
+
```typescript
|
|
1351
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1352
|
+
|
|
1353
|
+
const flexprice = new Flexprice({
|
|
1354
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1355
|
+
});
|
|
1356
|
+
|
|
1357
|
+
async function run() {
|
|
1358
|
+
const result = await flexprice.webhookEvents.postWebhookEventsPaymentCreated();
|
|
1359
|
+
|
|
1360
|
+
console.log(result);
|
|
1361
|
+
}
|
|
1362
|
+
|
|
1363
|
+
run();
|
|
1364
|
+
```
|
|
1365
|
+
|
|
1366
|
+
### Standalone function
|
|
1367
|
+
|
|
1368
|
+
The standalone function version of this method:
|
|
1369
|
+
|
|
1370
|
+
```typescript
|
|
1371
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1372
|
+
import { webhookEventsPostWebhookEventsPaymentCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-payment-created.js";
|
|
1373
|
+
|
|
1374
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1375
|
+
// You can create one instance of it to use across an application.
|
|
1376
|
+
const flexprice = new FlexpriceCore({
|
|
1377
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1378
|
+
});
|
|
1379
|
+
|
|
1380
|
+
async function run() {
|
|
1381
|
+
const res = await webhookEventsPostWebhookEventsPaymentCreated(flexprice);
|
|
1382
|
+
if (res.ok) {
|
|
1383
|
+
const { value: result } = res;
|
|
1384
|
+
console.log(result);
|
|
1385
|
+
} else {
|
|
1386
|
+
console.log("webhookEventsPostWebhookEventsPaymentCreated failed:", res.error);
|
|
1387
|
+
}
|
|
1388
|
+
}
|
|
1389
|
+
|
|
1390
|
+
run();
|
|
1391
|
+
```
|
|
1392
|
+
|
|
1393
|
+
### Parameters
|
|
1394
|
+
|
|
1395
|
+
| Parameter | Type | Required | Description |
|
|
1396
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1397
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1398
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1399
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1400
|
+
|
|
1401
|
+
### Response
|
|
1402
|
+
|
|
1403
|
+
**Promise\<[models.WebhookDtoPaymentWebhookPayload](../../sdk/models/webhook-dto-payment-webhook-payload.md)\>**
|
|
1404
|
+
|
|
1405
|
+
### Errors
|
|
1406
|
+
|
|
1407
|
+
| Error Type | Status Code | Content Type |
|
|
1408
|
+
| --------------- | --------------- | --------------- |
|
|
1409
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1410
|
+
|
|
1411
|
+
## postWebhookEventsPaymentFailed
|
|
1412
|
+
|
|
1413
|
+
Fired when a payment fails. Doc-only for parsing.
|
|
1414
|
+
|
|
1415
|
+
### Example Usage
|
|
1416
|
+
|
|
1417
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/payment.failed" method="post" path="/webhook-events/payment.failed" -->
|
|
1418
|
+
```typescript
|
|
1419
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1420
|
+
|
|
1421
|
+
const flexprice = new Flexprice({
|
|
1422
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1423
|
+
});
|
|
1424
|
+
|
|
1425
|
+
async function run() {
|
|
1426
|
+
const result = await flexprice.webhookEvents.postWebhookEventsPaymentFailed();
|
|
1427
|
+
|
|
1428
|
+
console.log(result);
|
|
1429
|
+
}
|
|
1430
|
+
|
|
1431
|
+
run();
|
|
1432
|
+
```
|
|
1433
|
+
|
|
1434
|
+
### Standalone function
|
|
1435
|
+
|
|
1436
|
+
The standalone function version of this method:
|
|
1437
|
+
|
|
1438
|
+
```typescript
|
|
1439
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1440
|
+
import { webhookEventsPostWebhookEventsPaymentFailed } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-payment-failed.js";
|
|
1441
|
+
|
|
1442
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1443
|
+
// You can create one instance of it to use across an application.
|
|
1444
|
+
const flexprice = new FlexpriceCore({
|
|
1445
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1446
|
+
});
|
|
1447
|
+
|
|
1448
|
+
async function run() {
|
|
1449
|
+
const res = await webhookEventsPostWebhookEventsPaymentFailed(flexprice);
|
|
1450
|
+
if (res.ok) {
|
|
1451
|
+
const { value: result } = res;
|
|
1452
|
+
console.log(result);
|
|
1453
|
+
} else {
|
|
1454
|
+
console.log("webhookEventsPostWebhookEventsPaymentFailed failed:", res.error);
|
|
1455
|
+
}
|
|
1456
|
+
}
|
|
1457
|
+
|
|
1458
|
+
run();
|
|
1459
|
+
```
|
|
1460
|
+
|
|
1461
|
+
### Parameters
|
|
1462
|
+
|
|
1463
|
+
| Parameter | Type | Required | Description |
|
|
1464
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1465
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1466
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1467
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1468
|
+
|
|
1469
|
+
### Response
|
|
1470
|
+
|
|
1471
|
+
**Promise\<[models.WebhookDtoPaymentWebhookPayload](../../sdk/models/webhook-dto-payment-webhook-payload.md)\>**
|
|
1472
|
+
|
|
1473
|
+
### Errors
|
|
1474
|
+
|
|
1475
|
+
| Error Type | Status Code | Content Type |
|
|
1476
|
+
| --------------- | --------------- | --------------- |
|
|
1477
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1478
|
+
|
|
1479
|
+
## postWebhookEventsPaymentPending
|
|
1480
|
+
|
|
1481
|
+
Fired when a payment is pending processing. Doc-only for parsing.
|
|
1482
|
+
|
|
1483
|
+
### Example Usage
|
|
1484
|
+
|
|
1485
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/payment.pending" method="post" path="/webhook-events/payment.pending" -->
|
|
1486
|
+
```typescript
|
|
1487
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1488
|
+
|
|
1489
|
+
const flexprice = new Flexprice({
|
|
1490
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1491
|
+
});
|
|
1492
|
+
|
|
1493
|
+
async function run() {
|
|
1494
|
+
const result = await flexprice.webhookEvents.postWebhookEventsPaymentPending();
|
|
1495
|
+
|
|
1496
|
+
console.log(result);
|
|
1497
|
+
}
|
|
1498
|
+
|
|
1499
|
+
run();
|
|
1500
|
+
```
|
|
1501
|
+
|
|
1502
|
+
### Standalone function
|
|
1503
|
+
|
|
1504
|
+
The standalone function version of this method:
|
|
1505
|
+
|
|
1506
|
+
```typescript
|
|
1507
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1508
|
+
import { webhookEventsPostWebhookEventsPaymentPending } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-payment-pending.js";
|
|
1509
|
+
|
|
1510
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1511
|
+
// You can create one instance of it to use across an application.
|
|
1512
|
+
const flexprice = new FlexpriceCore({
|
|
1513
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1514
|
+
});
|
|
1515
|
+
|
|
1516
|
+
async function run() {
|
|
1517
|
+
const res = await webhookEventsPostWebhookEventsPaymentPending(flexprice);
|
|
1518
|
+
if (res.ok) {
|
|
1519
|
+
const { value: result } = res;
|
|
1520
|
+
console.log(result);
|
|
1521
|
+
} else {
|
|
1522
|
+
console.log("webhookEventsPostWebhookEventsPaymentPending failed:", res.error);
|
|
1523
|
+
}
|
|
1524
|
+
}
|
|
1525
|
+
|
|
1526
|
+
run();
|
|
1527
|
+
```
|
|
1528
|
+
|
|
1529
|
+
### Parameters
|
|
1530
|
+
|
|
1531
|
+
| Parameter | Type | Required | Description |
|
|
1532
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1533
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1534
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1535
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1536
|
+
|
|
1537
|
+
### Response
|
|
1538
|
+
|
|
1539
|
+
**Promise\<[models.WebhookDtoPaymentWebhookPayload](../../sdk/models/webhook-dto-payment-webhook-payload.md)\>**
|
|
1540
|
+
|
|
1541
|
+
### Errors
|
|
1542
|
+
|
|
1543
|
+
| Error Type | Status Code | Content Type |
|
|
1544
|
+
| --------------- | --------------- | --------------- |
|
|
1545
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1546
|
+
|
|
1547
|
+
## postWebhookEventsPaymentSuccess
|
|
1548
|
+
|
|
1549
|
+
Fired when a payment succeeds. Doc-only for parsing.
|
|
1550
|
+
|
|
1551
|
+
### Example Usage
|
|
1552
|
+
|
|
1553
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/payment.success" method="post" path="/webhook-events/payment.success" -->
|
|
1554
|
+
```typescript
|
|
1555
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1556
|
+
|
|
1557
|
+
const flexprice = new Flexprice({
|
|
1558
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1559
|
+
});
|
|
1560
|
+
|
|
1561
|
+
async function run() {
|
|
1562
|
+
const result = await flexprice.webhookEvents.postWebhookEventsPaymentSuccess();
|
|
1563
|
+
|
|
1564
|
+
console.log(result);
|
|
1565
|
+
}
|
|
1566
|
+
|
|
1567
|
+
run();
|
|
1568
|
+
```
|
|
1569
|
+
|
|
1570
|
+
### Standalone function
|
|
1571
|
+
|
|
1572
|
+
The standalone function version of this method:
|
|
1573
|
+
|
|
1574
|
+
```typescript
|
|
1575
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1576
|
+
import { webhookEventsPostWebhookEventsPaymentSuccess } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-payment-success.js";
|
|
1577
|
+
|
|
1578
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1579
|
+
// You can create one instance of it to use across an application.
|
|
1580
|
+
const flexprice = new FlexpriceCore({
|
|
1581
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1582
|
+
});
|
|
1583
|
+
|
|
1584
|
+
async function run() {
|
|
1585
|
+
const res = await webhookEventsPostWebhookEventsPaymentSuccess(flexprice);
|
|
1586
|
+
if (res.ok) {
|
|
1587
|
+
const { value: result } = res;
|
|
1588
|
+
console.log(result);
|
|
1589
|
+
} else {
|
|
1590
|
+
console.log("webhookEventsPostWebhookEventsPaymentSuccess failed:", res.error);
|
|
1591
|
+
}
|
|
1592
|
+
}
|
|
1593
|
+
|
|
1594
|
+
run();
|
|
1595
|
+
```
|
|
1596
|
+
|
|
1597
|
+
### Parameters
|
|
1598
|
+
|
|
1599
|
+
| Parameter | Type | Required | Description |
|
|
1600
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1601
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1602
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1603
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1604
|
+
|
|
1605
|
+
### Response
|
|
1606
|
+
|
|
1607
|
+
**Promise\<[models.WebhookDtoPaymentWebhookPayload](../../sdk/models/webhook-dto-payment-webhook-payload.md)\>**
|
|
1608
|
+
|
|
1609
|
+
### Errors
|
|
1610
|
+
|
|
1611
|
+
| Error Type | Status Code | Content Type |
|
|
1612
|
+
| --------------- | --------------- | --------------- |
|
|
1613
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1614
|
+
|
|
1615
|
+
## postWebhookEventsPaymentUpdated
|
|
1616
|
+
|
|
1617
|
+
Fired when a payment is updated. Doc-only for parsing.
|
|
1618
|
+
|
|
1619
|
+
### Example Usage
|
|
1620
|
+
|
|
1621
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/payment.updated" method="post" path="/webhook-events/payment.updated" -->
|
|
1622
|
+
```typescript
|
|
1623
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1624
|
+
|
|
1625
|
+
const flexprice = new Flexprice({
|
|
1626
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1627
|
+
});
|
|
1628
|
+
|
|
1629
|
+
async function run() {
|
|
1630
|
+
const result = await flexprice.webhookEvents.postWebhookEventsPaymentUpdated();
|
|
1631
|
+
|
|
1632
|
+
console.log(result);
|
|
1633
|
+
}
|
|
1634
|
+
|
|
1635
|
+
run();
|
|
1636
|
+
```
|
|
1637
|
+
|
|
1638
|
+
### Standalone function
|
|
1639
|
+
|
|
1640
|
+
The standalone function version of this method:
|
|
1641
|
+
|
|
1642
|
+
```typescript
|
|
1643
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1644
|
+
import { webhookEventsPostWebhookEventsPaymentUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-payment-updated.js";
|
|
1645
|
+
|
|
1646
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1647
|
+
// You can create one instance of it to use across an application.
|
|
1648
|
+
const flexprice = new FlexpriceCore({
|
|
1649
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1650
|
+
});
|
|
1651
|
+
|
|
1652
|
+
async function run() {
|
|
1653
|
+
const res = await webhookEventsPostWebhookEventsPaymentUpdated(flexprice);
|
|
1654
|
+
if (res.ok) {
|
|
1655
|
+
const { value: result } = res;
|
|
1656
|
+
console.log(result);
|
|
1657
|
+
} else {
|
|
1658
|
+
console.log("webhookEventsPostWebhookEventsPaymentUpdated failed:", res.error);
|
|
1659
|
+
}
|
|
1660
|
+
}
|
|
1661
|
+
|
|
1662
|
+
run();
|
|
1663
|
+
```
|
|
1664
|
+
|
|
1665
|
+
### Parameters
|
|
1666
|
+
|
|
1667
|
+
| Parameter | Type | Required | Description |
|
|
1668
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1669
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1670
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1671
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1672
|
+
|
|
1673
|
+
### Response
|
|
1674
|
+
|
|
1675
|
+
**Promise\<[models.WebhookDtoPaymentWebhookPayload](../../sdk/models/webhook-dto-payment-webhook-payload.md)\>**
|
|
1676
|
+
|
|
1677
|
+
### Errors
|
|
1678
|
+
|
|
1679
|
+
| Error Type | Status Code | Content Type |
|
|
1680
|
+
| --------------- | --------------- | --------------- |
|
|
1681
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1682
|
+
|
|
1683
|
+
## postWebhookEventsSubscriptionActivated
|
|
1684
|
+
|
|
1685
|
+
Fired when a draft subscription is activated. Doc-only for parsing.
|
|
1686
|
+
|
|
1687
|
+
### Example Usage
|
|
1688
|
+
|
|
1689
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/subscription.activated" method="post" path="/webhook-events/subscription.activated" -->
|
|
1690
|
+
```typescript
|
|
1691
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1692
|
+
|
|
1693
|
+
const flexprice = new Flexprice({
|
|
1694
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1695
|
+
});
|
|
1696
|
+
|
|
1697
|
+
async function run() {
|
|
1698
|
+
const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionActivated();
|
|
1699
|
+
|
|
1700
|
+
console.log(result);
|
|
1701
|
+
}
|
|
1702
|
+
|
|
1703
|
+
run();
|
|
1704
|
+
```
|
|
1705
|
+
|
|
1706
|
+
### Standalone function
|
|
1707
|
+
|
|
1708
|
+
The standalone function version of this method:
|
|
1709
|
+
|
|
1710
|
+
```typescript
|
|
1711
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1712
|
+
import { webhookEventsPostWebhookEventsSubscriptionActivated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-activated.js";
|
|
1713
|
+
|
|
1714
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1715
|
+
// You can create one instance of it to use across an application.
|
|
1716
|
+
const flexprice = new FlexpriceCore({
|
|
1717
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1718
|
+
});
|
|
1719
|
+
|
|
1720
|
+
async function run() {
|
|
1721
|
+
const res = await webhookEventsPostWebhookEventsSubscriptionActivated(flexprice);
|
|
1722
|
+
if (res.ok) {
|
|
1723
|
+
const { value: result } = res;
|
|
1724
|
+
console.log(result);
|
|
1725
|
+
} else {
|
|
1726
|
+
console.log("webhookEventsPostWebhookEventsSubscriptionActivated failed:", res.error);
|
|
1727
|
+
}
|
|
1728
|
+
}
|
|
1729
|
+
|
|
1730
|
+
run();
|
|
1731
|
+
```
|
|
1732
|
+
|
|
1733
|
+
### Parameters
|
|
1734
|
+
|
|
1735
|
+
| Parameter | Type | Required | Description |
|
|
1736
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1737
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1738
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1739
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1740
|
+
|
|
1741
|
+
### Response
|
|
1742
|
+
|
|
1743
|
+
**Promise\<[models.WebhookDtoSubscriptionWebhookPayload](../../sdk/models/webhook-dto-subscription-webhook-payload.md)\>**
|
|
1744
|
+
|
|
1745
|
+
### Errors
|
|
1746
|
+
|
|
1747
|
+
| Error Type | Status Code | Content Type |
|
|
1748
|
+
| --------------- | --------------- | --------------- |
|
|
1749
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1750
|
+
|
|
1751
|
+
## postWebhookEventsSubscriptionCancelled
|
|
1752
|
+
|
|
1753
|
+
Fired when a subscription is cancelled (immediately or end-of-period). Doc-only for parsing.
|
|
1754
|
+
|
|
1755
|
+
### Example Usage
|
|
1756
|
+
|
|
1757
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/subscription.cancelled" method="post" path="/webhook-events/subscription.cancelled" -->
|
|
1758
|
+
```typescript
|
|
1759
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1760
|
+
|
|
1761
|
+
const flexprice = new Flexprice({
|
|
1762
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1763
|
+
});
|
|
1764
|
+
|
|
1765
|
+
async function run() {
|
|
1766
|
+
const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionCancelled();
|
|
1767
|
+
|
|
1768
|
+
console.log(result);
|
|
1769
|
+
}
|
|
1770
|
+
|
|
1771
|
+
run();
|
|
1772
|
+
```
|
|
1773
|
+
|
|
1774
|
+
### Standalone function
|
|
1775
|
+
|
|
1776
|
+
The standalone function version of this method:
|
|
1777
|
+
|
|
1778
|
+
```typescript
|
|
1779
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1780
|
+
import { webhookEventsPostWebhookEventsSubscriptionCancelled } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-cancelled.js";
|
|
1781
|
+
|
|
1782
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1783
|
+
// You can create one instance of it to use across an application.
|
|
1784
|
+
const flexprice = new FlexpriceCore({
|
|
1785
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1786
|
+
});
|
|
1787
|
+
|
|
1788
|
+
async function run() {
|
|
1789
|
+
const res = await webhookEventsPostWebhookEventsSubscriptionCancelled(flexprice);
|
|
1790
|
+
if (res.ok) {
|
|
1791
|
+
const { value: result } = res;
|
|
1792
|
+
console.log(result);
|
|
1793
|
+
} else {
|
|
1794
|
+
console.log("webhookEventsPostWebhookEventsSubscriptionCancelled failed:", res.error);
|
|
1795
|
+
}
|
|
1796
|
+
}
|
|
1797
|
+
|
|
1798
|
+
run();
|
|
1799
|
+
```
|
|
1800
|
+
|
|
1801
|
+
### Parameters
|
|
1802
|
+
|
|
1803
|
+
| Parameter | Type | Required | Description |
|
|
1804
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1805
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1806
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1807
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1808
|
+
|
|
1809
|
+
### Response
|
|
1810
|
+
|
|
1811
|
+
**Promise\<[models.WebhookDtoSubscriptionWebhookPayload](../../sdk/models/webhook-dto-subscription-webhook-payload.md)\>**
|
|
1812
|
+
|
|
1813
|
+
### Errors
|
|
1814
|
+
|
|
1815
|
+
| Error Type | Status Code | Content Type |
|
|
1816
|
+
| --------------- | --------------- | --------------- |
|
|
1817
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1818
|
+
|
|
1819
|
+
## postWebhookEventsSubscriptionCreated
|
|
1820
|
+
|
|
1821
|
+
Fired when a new subscription is created. Doc-only for parsing.
|
|
1822
|
+
|
|
1823
|
+
### Example Usage
|
|
1824
|
+
|
|
1825
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/subscription.created" method="post" path="/webhook-events/subscription.created" -->
|
|
1826
|
+
```typescript
|
|
1827
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1828
|
+
|
|
1829
|
+
const flexprice = new Flexprice({
|
|
1830
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1831
|
+
});
|
|
1832
|
+
|
|
1833
|
+
async function run() {
|
|
1834
|
+
const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionCreated();
|
|
1835
|
+
|
|
1836
|
+
console.log(result);
|
|
1837
|
+
}
|
|
1838
|
+
|
|
1839
|
+
run();
|
|
1840
|
+
```
|
|
1841
|
+
|
|
1842
|
+
### Standalone function
|
|
1843
|
+
|
|
1844
|
+
The standalone function version of this method:
|
|
1845
|
+
|
|
1846
|
+
```typescript
|
|
1847
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1848
|
+
import { webhookEventsPostWebhookEventsSubscriptionCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-created.js";
|
|
1849
|
+
|
|
1850
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1851
|
+
// You can create one instance of it to use across an application.
|
|
1852
|
+
const flexprice = new FlexpriceCore({
|
|
1853
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1854
|
+
});
|
|
1855
|
+
|
|
1856
|
+
async function run() {
|
|
1857
|
+
const res = await webhookEventsPostWebhookEventsSubscriptionCreated(flexprice);
|
|
1858
|
+
if (res.ok) {
|
|
1859
|
+
const { value: result } = res;
|
|
1860
|
+
console.log(result);
|
|
1861
|
+
} else {
|
|
1862
|
+
console.log("webhookEventsPostWebhookEventsSubscriptionCreated failed:", res.error);
|
|
1863
|
+
}
|
|
1864
|
+
}
|
|
1865
|
+
|
|
1866
|
+
run();
|
|
1867
|
+
```
|
|
1868
|
+
|
|
1869
|
+
### Parameters
|
|
1870
|
+
|
|
1871
|
+
| Parameter | Type | Required | Description |
|
|
1872
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1873
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1874
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1875
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1876
|
+
|
|
1877
|
+
### Response
|
|
1878
|
+
|
|
1879
|
+
**Promise\<[models.WebhookDtoSubscriptionWebhookPayload](../../sdk/models/webhook-dto-subscription-webhook-payload.md)\>**
|
|
1880
|
+
|
|
1881
|
+
### Errors
|
|
1882
|
+
|
|
1883
|
+
| Error Type | Status Code | Content Type |
|
|
1884
|
+
| --------------- | --------------- | --------------- |
|
|
1885
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1886
|
+
|
|
1887
|
+
## postWebhookEventsSubscriptionDraftCreated
|
|
1888
|
+
|
|
1889
|
+
Fired when a new draft subscription is created (not yet activated). Doc-only for parsing.
|
|
1890
|
+
|
|
1891
|
+
### Example Usage
|
|
1892
|
+
|
|
1893
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/subscription.draft.created" method="post" path="/webhook-events/subscription.draft.created" -->
|
|
1894
|
+
```typescript
|
|
1895
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1896
|
+
|
|
1897
|
+
const flexprice = new Flexprice({
|
|
1898
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1899
|
+
});
|
|
1900
|
+
|
|
1901
|
+
async function run() {
|
|
1902
|
+
const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionDraftCreated();
|
|
1903
|
+
|
|
1904
|
+
console.log(result);
|
|
1905
|
+
}
|
|
1906
|
+
|
|
1907
|
+
run();
|
|
1908
|
+
```
|
|
1909
|
+
|
|
1910
|
+
### Standalone function
|
|
1911
|
+
|
|
1912
|
+
The standalone function version of this method:
|
|
1913
|
+
|
|
1914
|
+
```typescript
|
|
1915
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1916
|
+
import { webhookEventsPostWebhookEventsSubscriptionDraftCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-draft-created.js";
|
|
1917
|
+
|
|
1918
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1919
|
+
// You can create one instance of it to use across an application.
|
|
1920
|
+
const flexprice = new FlexpriceCore({
|
|
1921
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1922
|
+
});
|
|
1923
|
+
|
|
1924
|
+
async function run() {
|
|
1925
|
+
const res = await webhookEventsPostWebhookEventsSubscriptionDraftCreated(flexprice);
|
|
1926
|
+
if (res.ok) {
|
|
1927
|
+
const { value: result } = res;
|
|
1928
|
+
console.log(result);
|
|
1929
|
+
} else {
|
|
1930
|
+
console.log("webhookEventsPostWebhookEventsSubscriptionDraftCreated failed:", res.error);
|
|
1931
|
+
}
|
|
1932
|
+
}
|
|
1933
|
+
|
|
1934
|
+
run();
|
|
1935
|
+
```
|
|
1936
|
+
|
|
1937
|
+
### Parameters
|
|
1938
|
+
|
|
1939
|
+
| Parameter | Type | Required | Description |
|
|
1940
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1941
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1942
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1943
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1944
|
+
|
|
1945
|
+
### Response
|
|
1946
|
+
|
|
1947
|
+
**Promise\<[models.WebhookDtoSubscriptionWebhookPayload](../../sdk/models/webhook-dto-subscription-webhook-payload.md)\>**
|
|
1948
|
+
|
|
1949
|
+
### Errors
|
|
1950
|
+
|
|
1951
|
+
| Error Type | Status Code | Content Type |
|
|
1952
|
+
| --------------- | --------------- | --------------- |
|
|
1953
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1954
|
+
|
|
1955
|
+
## postWebhookEventsSubscriptionPaused
|
|
1956
|
+
|
|
1957
|
+
Fired when a subscription is paused. Doc-only for parsing.
|
|
1958
|
+
|
|
1959
|
+
### Example Usage
|
|
1960
|
+
|
|
1961
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/subscription.paused" method="post" path="/webhook-events/subscription.paused" -->
|
|
1962
|
+
```typescript
|
|
1963
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1964
|
+
|
|
1965
|
+
const flexprice = new Flexprice({
|
|
1966
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1967
|
+
});
|
|
1968
|
+
|
|
1969
|
+
async function run() {
|
|
1970
|
+
const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionPaused();
|
|
1971
|
+
|
|
1972
|
+
console.log(result);
|
|
1973
|
+
}
|
|
1974
|
+
|
|
1975
|
+
run();
|
|
1976
|
+
```
|
|
1977
|
+
|
|
1978
|
+
### Standalone function
|
|
1979
|
+
|
|
1980
|
+
The standalone function version of this method:
|
|
1981
|
+
|
|
1982
|
+
```typescript
|
|
1983
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1984
|
+
import { webhookEventsPostWebhookEventsSubscriptionPaused } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-paused.js";
|
|
1985
|
+
|
|
1986
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1987
|
+
// You can create one instance of it to use across an application.
|
|
1988
|
+
const flexprice = new FlexpriceCore({
|
|
1989
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1990
|
+
});
|
|
1991
|
+
|
|
1992
|
+
async function run() {
|
|
1993
|
+
const res = await webhookEventsPostWebhookEventsSubscriptionPaused(flexprice);
|
|
1994
|
+
if (res.ok) {
|
|
1995
|
+
const { value: result } = res;
|
|
1996
|
+
console.log(result);
|
|
1997
|
+
} else {
|
|
1998
|
+
console.log("webhookEventsPostWebhookEventsSubscriptionPaused failed:", res.error);
|
|
1999
|
+
}
|
|
2000
|
+
}
|
|
2001
|
+
|
|
2002
|
+
run();
|
|
2003
|
+
```
|
|
2004
|
+
|
|
2005
|
+
### Parameters
|
|
2006
|
+
|
|
2007
|
+
| Parameter | Type | Required | Description |
|
|
2008
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2009
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2010
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2011
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2012
|
+
|
|
2013
|
+
### Response
|
|
2014
|
+
|
|
2015
|
+
**Promise\<[models.WebhookDtoSubscriptionWebhookPayload](../../sdk/models/webhook-dto-subscription-webhook-payload.md)\>**
|
|
2016
|
+
|
|
2017
|
+
### Errors
|
|
2018
|
+
|
|
2019
|
+
| Error Type | Status Code | Content Type |
|
|
2020
|
+
| --------------- | --------------- | --------------- |
|
|
2021
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
2022
|
+
|
|
2023
|
+
## postWebhookEventsSubscriptionPhaseCreated
|
|
2024
|
+
|
|
2025
|
+
Fired when a new subscription phase is created. Doc-only for parsing.
|
|
2026
|
+
|
|
2027
|
+
### Example Usage
|
|
2028
|
+
|
|
2029
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/subscription.phase.created" method="post" path="/webhook-events/subscription.phase.created" -->
|
|
2030
|
+
```typescript
|
|
2031
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
2032
|
+
|
|
2033
|
+
const flexprice = new Flexprice({
|
|
2034
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2035
|
+
});
|
|
2036
|
+
|
|
2037
|
+
async function run() {
|
|
2038
|
+
const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionPhaseCreated();
|
|
2039
|
+
|
|
2040
|
+
console.log(result);
|
|
2041
|
+
}
|
|
2042
|
+
|
|
2043
|
+
run();
|
|
2044
|
+
```
|
|
2045
|
+
|
|
2046
|
+
### Standalone function
|
|
2047
|
+
|
|
2048
|
+
The standalone function version of this method:
|
|
2049
|
+
|
|
2050
|
+
```typescript
|
|
2051
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
2052
|
+
import { webhookEventsPostWebhookEventsSubscriptionPhaseCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-phase-created.js";
|
|
2053
|
+
|
|
2054
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
2055
|
+
// You can create one instance of it to use across an application.
|
|
2056
|
+
const flexprice = new FlexpriceCore({
|
|
2057
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2058
|
+
});
|
|
2059
|
+
|
|
2060
|
+
async function run() {
|
|
2061
|
+
const res = await webhookEventsPostWebhookEventsSubscriptionPhaseCreated(flexprice);
|
|
2062
|
+
if (res.ok) {
|
|
2063
|
+
const { value: result } = res;
|
|
2064
|
+
console.log(result);
|
|
2065
|
+
} else {
|
|
2066
|
+
console.log("webhookEventsPostWebhookEventsSubscriptionPhaseCreated failed:", res.error);
|
|
2067
|
+
}
|
|
2068
|
+
}
|
|
2069
|
+
|
|
2070
|
+
run();
|
|
2071
|
+
```
|
|
2072
|
+
|
|
2073
|
+
### Parameters
|
|
2074
|
+
|
|
2075
|
+
| Parameter | Type | Required | Description |
|
|
2076
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2077
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2078
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2079
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2080
|
+
|
|
2081
|
+
### Response
|
|
2082
|
+
|
|
2083
|
+
**Promise\<[models.WebhookDtoSubscriptionPhaseWebhookPayload](../../sdk/models/webhook-dto-subscription-phase-webhook-payload.md)\>**
|
|
2084
|
+
|
|
2085
|
+
### Errors
|
|
2086
|
+
|
|
2087
|
+
| Error Type | Status Code | Content Type |
|
|
2088
|
+
| --------------- | --------------- | --------------- |
|
|
2089
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
2090
|
+
|
|
2091
|
+
## postWebhookEventsSubscriptionPhaseDeleted
|
|
2092
|
+
|
|
2093
|
+
Fired when a subscription phase is deleted. Doc-only for parsing.
|
|
2094
|
+
|
|
2095
|
+
### Example Usage
|
|
2096
|
+
|
|
2097
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/subscription.phase.deleted" method="post" path="/webhook-events/subscription.phase.deleted" -->
|
|
2098
|
+
```typescript
|
|
2099
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
2100
|
+
|
|
2101
|
+
const flexprice = new Flexprice({
|
|
2102
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2103
|
+
});
|
|
2104
|
+
|
|
2105
|
+
async function run() {
|
|
2106
|
+
const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionPhaseDeleted();
|
|
2107
|
+
|
|
2108
|
+
console.log(result);
|
|
2109
|
+
}
|
|
2110
|
+
|
|
2111
|
+
run();
|
|
2112
|
+
```
|
|
2113
|
+
|
|
2114
|
+
### Standalone function
|
|
2115
|
+
|
|
2116
|
+
The standalone function version of this method:
|
|
2117
|
+
|
|
2118
|
+
```typescript
|
|
2119
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
2120
|
+
import { webhookEventsPostWebhookEventsSubscriptionPhaseDeleted } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-phase-deleted.js";
|
|
2121
|
+
|
|
2122
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
2123
|
+
// You can create one instance of it to use across an application.
|
|
2124
|
+
const flexprice = new FlexpriceCore({
|
|
2125
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2126
|
+
});
|
|
2127
|
+
|
|
2128
|
+
async function run() {
|
|
2129
|
+
const res = await webhookEventsPostWebhookEventsSubscriptionPhaseDeleted(flexprice);
|
|
2130
|
+
if (res.ok) {
|
|
2131
|
+
const { value: result } = res;
|
|
2132
|
+
console.log(result);
|
|
2133
|
+
} else {
|
|
2134
|
+
console.log("webhookEventsPostWebhookEventsSubscriptionPhaseDeleted failed:", res.error);
|
|
2135
|
+
}
|
|
2136
|
+
}
|
|
2137
|
+
|
|
2138
|
+
run();
|
|
2139
|
+
```
|
|
2140
|
+
|
|
2141
|
+
### Parameters
|
|
2142
|
+
|
|
2143
|
+
| Parameter | Type | Required | Description |
|
|
2144
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2145
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2146
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2147
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2148
|
+
|
|
2149
|
+
### Response
|
|
2150
|
+
|
|
2151
|
+
**Promise\<[models.WebhookDtoSubscriptionPhaseWebhookPayload](../../sdk/models/webhook-dto-subscription-phase-webhook-payload.md)\>**
|
|
2152
|
+
|
|
2153
|
+
### Errors
|
|
2154
|
+
|
|
2155
|
+
| Error Type | Status Code | Content Type |
|
|
2156
|
+
| --------------- | --------------- | --------------- |
|
|
2157
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
2158
|
+
|
|
2159
|
+
## postWebhookEventsSubscriptionPhaseUpdated
|
|
2160
|
+
|
|
2161
|
+
Fired when a subscription phase is updated. Doc-only for parsing.
|
|
2162
|
+
|
|
2163
|
+
### Example Usage
|
|
2164
|
+
|
|
2165
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/subscription.phase.updated" method="post" path="/webhook-events/subscription.phase.updated" -->
|
|
2166
|
+
```typescript
|
|
2167
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
2168
|
+
|
|
2169
|
+
const flexprice = new Flexprice({
|
|
2170
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2171
|
+
});
|
|
2172
|
+
|
|
2173
|
+
async function run() {
|
|
2174
|
+
const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionPhaseUpdated();
|
|
2175
|
+
|
|
2176
|
+
console.log(result);
|
|
2177
|
+
}
|
|
2178
|
+
|
|
2179
|
+
run();
|
|
2180
|
+
```
|
|
2181
|
+
|
|
2182
|
+
### Standalone function
|
|
2183
|
+
|
|
2184
|
+
The standalone function version of this method:
|
|
2185
|
+
|
|
2186
|
+
```typescript
|
|
2187
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
2188
|
+
import { webhookEventsPostWebhookEventsSubscriptionPhaseUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-phase-updated.js";
|
|
2189
|
+
|
|
2190
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
2191
|
+
// You can create one instance of it to use across an application.
|
|
2192
|
+
const flexprice = new FlexpriceCore({
|
|
2193
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2194
|
+
});
|
|
2195
|
+
|
|
2196
|
+
async function run() {
|
|
2197
|
+
const res = await webhookEventsPostWebhookEventsSubscriptionPhaseUpdated(flexprice);
|
|
2198
|
+
if (res.ok) {
|
|
2199
|
+
const { value: result } = res;
|
|
2200
|
+
console.log(result);
|
|
2201
|
+
} else {
|
|
2202
|
+
console.log("webhookEventsPostWebhookEventsSubscriptionPhaseUpdated failed:", res.error);
|
|
2203
|
+
}
|
|
2204
|
+
}
|
|
2205
|
+
|
|
2206
|
+
run();
|
|
2207
|
+
```
|
|
2208
|
+
|
|
2209
|
+
### Parameters
|
|
2210
|
+
|
|
2211
|
+
| Parameter | Type | Required | Description |
|
|
2212
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2213
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2214
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2215
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2216
|
+
|
|
2217
|
+
### Response
|
|
2218
|
+
|
|
2219
|
+
**Promise\<[models.WebhookDtoSubscriptionPhaseWebhookPayload](../../sdk/models/webhook-dto-subscription-phase-webhook-payload.md)\>**
|
|
2220
|
+
|
|
2221
|
+
### Errors
|
|
2222
|
+
|
|
2223
|
+
| Error Type | Status Code | Content Type |
|
|
2224
|
+
| --------------- | --------------- | --------------- |
|
|
2225
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
2226
|
+
|
|
2227
|
+
## postWebhookEventsSubscriptionRenewalDue
|
|
2228
|
+
|
|
2229
|
+
Fired when a subscription renewal is upcoming (cron-driven). Doc-only for parsing.
|
|
2230
|
+
|
|
2231
|
+
### Example Usage
|
|
2232
|
+
|
|
2233
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/subscription.renewal.due" method="post" path="/webhook-events/subscription.renewal.due" -->
|
|
2234
|
+
```typescript
|
|
2235
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
2236
|
+
|
|
2237
|
+
const flexprice = new Flexprice({
|
|
2238
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2239
|
+
});
|
|
2240
|
+
|
|
2241
|
+
async function run() {
|
|
2242
|
+
const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionRenewalDue();
|
|
2243
|
+
|
|
2244
|
+
console.log(result);
|
|
2245
|
+
}
|
|
2246
|
+
|
|
2247
|
+
run();
|
|
2248
|
+
```
|
|
2249
|
+
|
|
2250
|
+
### Standalone function
|
|
2251
|
+
|
|
2252
|
+
The standalone function version of this method:
|
|
2253
|
+
|
|
2254
|
+
```typescript
|
|
2255
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
2256
|
+
import { webhookEventsPostWebhookEventsSubscriptionRenewalDue } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-renewal-due.js";
|
|
2257
|
+
|
|
2258
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
2259
|
+
// You can create one instance of it to use across an application.
|
|
2260
|
+
const flexprice = new FlexpriceCore({
|
|
2261
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2262
|
+
});
|
|
2263
|
+
|
|
2264
|
+
async function run() {
|
|
2265
|
+
const res = await webhookEventsPostWebhookEventsSubscriptionRenewalDue(flexprice);
|
|
2266
|
+
if (res.ok) {
|
|
2267
|
+
const { value: result } = res;
|
|
2268
|
+
console.log(result);
|
|
2269
|
+
} else {
|
|
2270
|
+
console.log("webhookEventsPostWebhookEventsSubscriptionRenewalDue failed:", res.error);
|
|
2271
|
+
}
|
|
2272
|
+
}
|
|
2273
|
+
|
|
2274
|
+
run();
|
|
2275
|
+
```
|
|
2276
|
+
|
|
2277
|
+
### Parameters
|
|
2278
|
+
|
|
2279
|
+
| Parameter | Type | Required | Description |
|
|
2280
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2281
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2282
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2283
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2284
|
+
|
|
2285
|
+
### Response
|
|
2286
|
+
|
|
2287
|
+
**Promise\<[models.WebhookDtoSubscriptionWebhookPayload](../../sdk/models/webhook-dto-subscription-webhook-payload.md)\>**
|
|
2288
|
+
|
|
2289
|
+
### Errors
|
|
2290
|
+
|
|
2291
|
+
| Error Type | Status Code | Content Type |
|
|
2292
|
+
| --------------- | --------------- | --------------- |
|
|
2293
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
2294
|
+
|
|
2295
|
+
## postWebhookEventsSubscriptionResumed
|
|
2296
|
+
|
|
2297
|
+
Fired when a paused subscription is resumed. Doc-only for parsing.
|
|
2298
|
+
|
|
2299
|
+
### Example Usage
|
|
2300
|
+
|
|
2301
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/subscription.resumed" method="post" path="/webhook-events/subscription.resumed" -->
|
|
2302
|
+
```typescript
|
|
2303
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
2304
|
+
|
|
2305
|
+
const flexprice = new Flexprice({
|
|
2306
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2307
|
+
});
|
|
2308
|
+
|
|
2309
|
+
async function run() {
|
|
2310
|
+
const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionResumed();
|
|
2311
|
+
|
|
2312
|
+
console.log(result);
|
|
2313
|
+
}
|
|
2314
|
+
|
|
2315
|
+
run();
|
|
2316
|
+
```
|
|
2317
|
+
|
|
2318
|
+
### Standalone function
|
|
2319
|
+
|
|
2320
|
+
The standalone function version of this method:
|
|
2321
|
+
|
|
2322
|
+
```typescript
|
|
2323
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
2324
|
+
import { webhookEventsPostWebhookEventsSubscriptionResumed } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-resumed.js";
|
|
2325
|
+
|
|
2326
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
2327
|
+
// You can create one instance of it to use across an application.
|
|
2328
|
+
const flexprice = new FlexpriceCore({
|
|
2329
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2330
|
+
});
|
|
2331
|
+
|
|
2332
|
+
async function run() {
|
|
2333
|
+
const res = await webhookEventsPostWebhookEventsSubscriptionResumed(flexprice);
|
|
2334
|
+
if (res.ok) {
|
|
2335
|
+
const { value: result } = res;
|
|
2336
|
+
console.log(result);
|
|
2337
|
+
} else {
|
|
2338
|
+
console.log("webhookEventsPostWebhookEventsSubscriptionResumed failed:", res.error);
|
|
2339
|
+
}
|
|
2340
|
+
}
|
|
2341
|
+
|
|
2342
|
+
run();
|
|
2343
|
+
```
|
|
2344
|
+
|
|
2345
|
+
### Parameters
|
|
2346
|
+
|
|
2347
|
+
| Parameter | Type | Required | Description |
|
|
2348
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2349
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2350
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2351
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2352
|
+
|
|
2353
|
+
### Response
|
|
2354
|
+
|
|
2355
|
+
**Promise\<[models.WebhookDtoSubscriptionWebhookPayload](../../sdk/models/webhook-dto-subscription-webhook-payload.md)\>**
|
|
2356
|
+
|
|
2357
|
+
### Errors
|
|
2358
|
+
|
|
2359
|
+
| Error Type | Status Code | Content Type |
|
|
2360
|
+
| --------------- | --------------- | --------------- |
|
|
2361
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
2362
|
+
|
|
2363
|
+
## postWebhookEventsSubscriptionUpdated
|
|
2364
|
+
|
|
2365
|
+
Fired when a subscription is updated (e.g. quantity, billing anchor, or metadata changes). Doc-only for parsing.
|
|
2366
|
+
|
|
2367
|
+
### Example Usage
|
|
2368
|
+
|
|
2369
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/subscription.updated" method="post" path="/webhook-events/subscription.updated" -->
|
|
2370
|
+
```typescript
|
|
2371
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
2372
|
+
|
|
2373
|
+
const flexprice = new Flexprice({
|
|
2374
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2375
|
+
});
|
|
2376
|
+
|
|
2377
|
+
async function run() {
|
|
2378
|
+
const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionUpdated();
|
|
2379
|
+
|
|
2380
|
+
console.log(result);
|
|
2381
|
+
}
|
|
2382
|
+
|
|
2383
|
+
run();
|
|
2384
|
+
```
|
|
2385
|
+
|
|
2386
|
+
### Standalone function
|
|
2387
|
+
|
|
2388
|
+
The standalone function version of this method:
|
|
2389
|
+
|
|
2390
|
+
```typescript
|
|
2391
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
2392
|
+
import { webhookEventsPostWebhookEventsSubscriptionUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-updated.js";
|
|
2393
|
+
|
|
2394
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
2395
|
+
// You can create one instance of it to use across an application.
|
|
2396
|
+
const flexprice = new FlexpriceCore({
|
|
2397
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2398
|
+
});
|
|
2399
|
+
|
|
2400
|
+
async function run() {
|
|
2401
|
+
const res = await webhookEventsPostWebhookEventsSubscriptionUpdated(flexprice);
|
|
2402
|
+
if (res.ok) {
|
|
2403
|
+
const { value: result } = res;
|
|
2404
|
+
console.log(result);
|
|
2405
|
+
} else {
|
|
2406
|
+
console.log("webhookEventsPostWebhookEventsSubscriptionUpdated failed:", res.error);
|
|
2407
|
+
}
|
|
2408
|
+
}
|
|
2409
|
+
|
|
2410
|
+
run();
|
|
2411
|
+
```
|
|
2412
|
+
|
|
2413
|
+
### Parameters
|
|
2414
|
+
|
|
2415
|
+
| Parameter | Type | Required | Description |
|
|
2416
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2417
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2418
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2419
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2420
|
+
|
|
2421
|
+
### Response
|
|
2422
|
+
|
|
2423
|
+
**Promise\<[models.WebhookDtoSubscriptionWebhookPayload](../../sdk/models/webhook-dto-subscription-webhook-payload.md)\>**
|
|
2424
|
+
|
|
2425
|
+
### Errors
|
|
2426
|
+
|
|
2427
|
+
| Error Type | Status Code | Content Type |
|
|
2428
|
+
| --------------- | --------------- | --------------- |
|
|
2429
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
2430
|
+
|
|
2431
|
+
## postWebhookEventsWalletCreated
|
|
2432
|
+
|
|
2433
|
+
Fired when a new wallet is created. Doc-only for parsing.
|
|
2434
|
+
|
|
2435
|
+
### Example Usage
|
|
2436
|
+
|
|
2437
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/wallet.created" method="post" path="/webhook-events/wallet.created" -->
|
|
2438
|
+
```typescript
|
|
2439
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
2440
|
+
|
|
2441
|
+
const flexprice = new Flexprice({
|
|
2442
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2443
|
+
});
|
|
2444
|
+
|
|
2445
|
+
async function run() {
|
|
2446
|
+
const result = await flexprice.webhookEvents.postWebhookEventsWalletCreated();
|
|
2447
|
+
|
|
2448
|
+
console.log(result);
|
|
2449
|
+
}
|
|
2450
|
+
|
|
2451
|
+
run();
|
|
2452
|
+
```
|
|
2453
|
+
|
|
2454
|
+
### Standalone function
|
|
2455
|
+
|
|
2456
|
+
The standalone function version of this method:
|
|
2457
|
+
|
|
2458
|
+
```typescript
|
|
2459
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
2460
|
+
import { webhookEventsPostWebhookEventsWalletCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-created.js";
|
|
2461
|
+
|
|
2462
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
2463
|
+
// You can create one instance of it to use across an application.
|
|
2464
|
+
const flexprice = new FlexpriceCore({
|
|
2465
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2466
|
+
});
|
|
2467
|
+
|
|
2468
|
+
async function run() {
|
|
2469
|
+
const res = await webhookEventsPostWebhookEventsWalletCreated(flexprice);
|
|
2470
|
+
if (res.ok) {
|
|
2471
|
+
const { value: result } = res;
|
|
2472
|
+
console.log(result);
|
|
2473
|
+
} else {
|
|
2474
|
+
console.log("webhookEventsPostWebhookEventsWalletCreated failed:", res.error);
|
|
2475
|
+
}
|
|
2476
|
+
}
|
|
2477
|
+
|
|
2478
|
+
run();
|
|
2479
|
+
```
|
|
2480
|
+
|
|
2481
|
+
### Parameters
|
|
2482
|
+
|
|
2483
|
+
| Parameter | Type | Required | Description |
|
|
2484
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2485
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2486
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2487
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2488
|
+
|
|
2489
|
+
### Response
|
|
2490
|
+
|
|
2491
|
+
**Promise\<[models.WebhookDtoWalletWebhookPayload](../../sdk/models/webhook-dto-wallet-webhook-payload.md)\>**
|
|
2492
|
+
|
|
2493
|
+
### Errors
|
|
2494
|
+
|
|
2495
|
+
| Error Type | Status Code | Content Type |
|
|
2496
|
+
| --------------- | --------------- | --------------- |
|
|
2497
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
2498
|
+
|
|
2499
|
+
## postWebhookEventsWalletCreditBalanceDropped
|
|
2500
|
+
|
|
2501
|
+
Fired when a wallet's credit balance drops below an alert threshold. Doc-only for parsing.
|
|
2502
|
+
|
|
2503
|
+
### Example Usage
|
|
2504
|
+
|
|
2505
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/wallet.credit_balance.dropped" method="post" path="/webhook-events/wallet.credit_balance.dropped" -->
|
|
2506
|
+
```typescript
|
|
2507
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
2508
|
+
|
|
2509
|
+
const flexprice = new Flexprice({
|
|
2510
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2511
|
+
});
|
|
2512
|
+
|
|
2513
|
+
async function run() {
|
|
2514
|
+
const result = await flexprice.webhookEvents.postWebhookEventsWalletCreditBalanceDropped();
|
|
2515
|
+
|
|
2516
|
+
console.log(result);
|
|
2517
|
+
}
|
|
2518
|
+
|
|
2519
|
+
run();
|
|
2520
|
+
```
|
|
2521
|
+
|
|
2522
|
+
### Standalone function
|
|
2523
|
+
|
|
2524
|
+
The standalone function version of this method:
|
|
2525
|
+
|
|
2526
|
+
```typescript
|
|
2527
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
2528
|
+
import { webhookEventsPostWebhookEventsWalletCreditBalanceDropped } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-credit-balance-dropped.js";
|
|
2529
|
+
|
|
2530
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
2531
|
+
// You can create one instance of it to use across an application.
|
|
2532
|
+
const flexprice = new FlexpriceCore({
|
|
2533
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2534
|
+
});
|
|
2535
|
+
|
|
2536
|
+
async function run() {
|
|
2537
|
+
const res = await webhookEventsPostWebhookEventsWalletCreditBalanceDropped(flexprice);
|
|
2538
|
+
if (res.ok) {
|
|
2539
|
+
const { value: result } = res;
|
|
2540
|
+
console.log(result);
|
|
2541
|
+
} else {
|
|
2542
|
+
console.log("webhookEventsPostWebhookEventsWalletCreditBalanceDropped failed:", res.error);
|
|
2543
|
+
}
|
|
2544
|
+
}
|
|
2545
|
+
|
|
2546
|
+
run();
|
|
2547
|
+
```
|
|
2548
|
+
|
|
2549
|
+
### Parameters
|
|
2550
|
+
|
|
2551
|
+
| Parameter | Type | Required | Description |
|
|
2552
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2553
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2554
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2555
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2556
|
+
|
|
2557
|
+
### Response
|
|
2558
|
+
|
|
2559
|
+
**Promise\<[models.WebhookDtoWalletWebhookPayload](../../sdk/models/webhook-dto-wallet-webhook-payload.md)\>**
|
|
2560
|
+
|
|
2561
|
+
### Errors
|
|
2562
|
+
|
|
2563
|
+
| Error Type | Status Code | Content Type |
|
|
2564
|
+
| --------------- | --------------- | --------------- |
|
|
2565
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
2566
|
+
|
|
2567
|
+
## postWebhookEventsWalletCreditBalanceRecovered
|
|
2568
|
+
|
|
2569
|
+
Fired when a wallet's credit balance recovers above an alert threshold. Doc-only for parsing.
|
|
2570
|
+
|
|
2571
|
+
### Example Usage
|
|
2572
|
+
|
|
2573
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/wallet.credit_balance.recovered" method="post" path="/webhook-events/wallet.credit_balance.recovered" -->
|
|
2574
|
+
```typescript
|
|
2575
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
2576
|
+
|
|
2577
|
+
const flexprice = new Flexprice({
|
|
2578
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2579
|
+
});
|
|
2580
|
+
|
|
2581
|
+
async function run() {
|
|
2582
|
+
const result = await flexprice.webhookEvents.postWebhookEventsWalletCreditBalanceRecovered();
|
|
2583
|
+
|
|
2584
|
+
console.log(result);
|
|
2585
|
+
}
|
|
2586
|
+
|
|
2587
|
+
run();
|
|
2588
|
+
```
|
|
2589
|
+
|
|
2590
|
+
### Standalone function
|
|
2591
|
+
|
|
2592
|
+
The standalone function version of this method:
|
|
2593
|
+
|
|
2594
|
+
```typescript
|
|
2595
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
2596
|
+
import { webhookEventsPostWebhookEventsWalletCreditBalanceRecovered } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-credit-balance-recovered.js";
|
|
2597
|
+
|
|
2598
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
2599
|
+
// You can create one instance of it to use across an application.
|
|
2600
|
+
const flexprice = new FlexpriceCore({
|
|
2601
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2602
|
+
});
|
|
2603
|
+
|
|
2604
|
+
async function run() {
|
|
2605
|
+
const res = await webhookEventsPostWebhookEventsWalletCreditBalanceRecovered(flexprice);
|
|
2606
|
+
if (res.ok) {
|
|
2607
|
+
const { value: result } = res;
|
|
2608
|
+
console.log(result);
|
|
2609
|
+
} else {
|
|
2610
|
+
console.log("webhookEventsPostWebhookEventsWalletCreditBalanceRecovered failed:", res.error);
|
|
2611
|
+
}
|
|
2612
|
+
}
|
|
2613
|
+
|
|
2614
|
+
run();
|
|
2615
|
+
```
|
|
2616
|
+
|
|
2617
|
+
### Parameters
|
|
2618
|
+
|
|
2619
|
+
| Parameter | Type | Required | Description |
|
|
2620
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2621
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2622
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2623
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2624
|
+
|
|
2625
|
+
### Response
|
|
2626
|
+
|
|
2627
|
+
**Promise\<[models.WebhookDtoWalletWebhookPayload](../../sdk/models/webhook-dto-wallet-webhook-payload.md)\>**
|
|
2628
|
+
|
|
2629
|
+
### Errors
|
|
2630
|
+
|
|
2631
|
+
| Error Type | Status Code | Content Type |
|
|
2632
|
+
| --------------- | --------------- | --------------- |
|
|
2633
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
2634
|
+
|
|
2635
|
+
## postWebhookEventsWalletOngoingBalanceDropped
|
|
2636
|
+
|
|
2637
|
+
Fired when a wallet's ongoing balance drops below an alert threshold. Doc-only for parsing.
|
|
2638
|
+
|
|
2639
|
+
### Example Usage
|
|
2640
|
+
|
|
2641
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/wallet.ongoing_balance.dropped" method="post" path="/webhook-events/wallet.ongoing_balance.dropped" -->
|
|
2642
|
+
```typescript
|
|
2643
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
2644
|
+
|
|
2645
|
+
const flexprice = new Flexprice({
|
|
2646
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2647
|
+
});
|
|
2648
|
+
|
|
2649
|
+
async function run() {
|
|
2650
|
+
const result = await flexprice.webhookEvents.postWebhookEventsWalletOngoingBalanceDropped();
|
|
2651
|
+
|
|
2652
|
+
console.log(result);
|
|
2653
|
+
}
|
|
2654
|
+
|
|
2655
|
+
run();
|
|
2656
|
+
```
|
|
2657
|
+
|
|
2658
|
+
### Standalone function
|
|
2659
|
+
|
|
2660
|
+
The standalone function version of this method:
|
|
2661
|
+
|
|
2662
|
+
```typescript
|
|
2663
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
2664
|
+
import { webhookEventsPostWebhookEventsWalletOngoingBalanceDropped } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-ongoing-balance-dropped.js";
|
|
2665
|
+
|
|
2666
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
2667
|
+
// You can create one instance of it to use across an application.
|
|
2668
|
+
const flexprice = new FlexpriceCore({
|
|
2669
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2670
|
+
});
|
|
2671
|
+
|
|
2672
|
+
async function run() {
|
|
2673
|
+
const res = await webhookEventsPostWebhookEventsWalletOngoingBalanceDropped(flexprice);
|
|
2674
|
+
if (res.ok) {
|
|
2675
|
+
const { value: result } = res;
|
|
2676
|
+
console.log(result);
|
|
2677
|
+
} else {
|
|
2678
|
+
console.log("webhookEventsPostWebhookEventsWalletOngoingBalanceDropped failed:", res.error);
|
|
2679
|
+
}
|
|
2680
|
+
}
|
|
2681
|
+
|
|
2682
|
+
run();
|
|
2683
|
+
```
|
|
2684
|
+
|
|
2685
|
+
### Parameters
|
|
2686
|
+
|
|
2687
|
+
| Parameter | Type | Required | Description |
|
|
2688
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2689
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2690
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2691
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2692
|
+
|
|
2693
|
+
### Response
|
|
2694
|
+
|
|
2695
|
+
**Promise\<[models.WebhookDtoWalletWebhookPayload](../../sdk/models/webhook-dto-wallet-webhook-payload.md)\>**
|
|
2696
|
+
|
|
2697
|
+
### Errors
|
|
2698
|
+
|
|
2699
|
+
| Error Type | Status Code | Content Type |
|
|
2700
|
+
| --------------- | --------------- | --------------- |
|
|
2701
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
2702
|
+
|
|
2703
|
+
## postWebhookEventsWalletOngoingBalanceRecovered
|
|
2704
|
+
|
|
2705
|
+
Fired when a wallet's ongoing balance recovers above an alert threshold. Doc-only for parsing.
|
|
2706
|
+
|
|
2707
|
+
### Example Usage
|
|
2708
|
+
|
|
2709
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/wallet.ongoing_balance.recovered" method="post" path="/webhook-events/wallet.ongoing_balance.recovered" -->
|
|
2710
|
+
```typescript
|
|
2711
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
2712
|
+
|
|
2713
|
+
const flexprice = new Flexprice({
|
|
2714
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2715
|
+
});
|
|
2716
|
+
|
|
2717
|
+
async function run() {
|
|
2718
|
+
const result = await flexprice.webhookEvents.postWebhookEventsWalletOngoingBalanceRecovered();
|
|
2719
|
+
|
|
2720
|
+
console.log(result);
|
|
2721
|
+
}
|
|
2722
|
+
|
|
2723
|
+
run();
|
|
2724
|
+
```
|
|
2725
|
+
|
|
2726
|
+
### Standalone function
|
|
2727
|
+
|
|
2728
|
+
The standalone function version of this method:
|
|
2729
|
+
|
|
2730
|
+
```typescript
|
|
2731
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
2732
|
+
import { webhookEventsPostWebhookEventsWalletOngoingBalanceRecovered } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-ongoing-balance-recovered.js";
|
|
2733
|
+
|
|
2734
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
2735
|
+
// You can create one instance of it to use across an application.
|
|
2736
|
+
const flexprice = new FlexpriceCore({
|
|
2737
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2738
|
+
});
|
|
2739
|
+
|
|
2740
|
+
async function run() {
|
|
2741
|
+
const res = await webhookEventsPostWebhookEventsWalletOngoingBalanceRecovered(flexprice);
|
|
2742
|
+
if (res.ok) {
|
|
2743
|
+
const { value: result } = res;
|
|
2744
|
+
console.log(result);
|
|
2745
|
+
} else {
|
|
2746
|
+
console.log("webhookEventsPostWebhookEventsWalletOngoingBalanceRecovered failed:", res.error);
|
|
2747
|
+
}
|
|
2748
|
+
}
|
|
2749
|
+
|
|
2750
|
+
run();
|
|
2751
|
+
```
|
|
2752
|
+
|
|
2753
|
+
### Parameters
|
|
2754
|
+
|
|
2755
|
+
| Parameter | Type | Required | Description |
|
|
2756
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2757
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2758
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2759
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2760
|
+
|
|
2761
|
+
### Response
|
|
2762
|
+
|
|
2763
|
+
**Promise\<[models.WebhookDtoWalletWebhookPayload](../../sdk/models/webhook-dto-wallet-webhook-payload.md)\>**
|
|
2764
|
+
|
|
2765
|
+
### Errors
|
|
2766
|
+
|
|
2767
|
+
| Error Type | Status Code | Content Type |
|
|
2768
|
+
| --------------- | --------------- | --------------- |
|
|
2769
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
2770
|
+
|
|
2771
|
+
## postWebhookEventsWalletTerminated
|
|
2772
|
+
|
|
2773
|
+
Fired when a wallet is terminated. Doc-only for parsing.
|
|
2774
|
+
|
|
2775
|
+
### Example Usage
|
|
2776
|
+
|
|
2777
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/wallet.terminated" method="post" path="/webhook-events/wallet.terminated" -->
|
|
2778
|
+
```typescript
|
|
2779
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
2780
|
+
|
|
2781
|
+
const flexprice = new Flexprice({
|
|
2782
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2783
|
+
});
|
|
2784
|
+
|
|
2785
|
+
async function run() {
|
|
2786
|
+
const result = await flexprice.webhookEvents.postWebhookEventsWalletTerminated();
|
|
2787
|
+
|
|
2788
|
+
console.log(result);
|
|
2789
|
+
}
|
|
2790
|
+
|
|
2791
|
+
run();
|
|
2792
|
+
```
|
|
2793
|
+
|
|
2794
|
+
### Standalone function
|
|
2795
|
+
|
|
2796
|
+
The standalone function version of this method:
|
|
2797
|
+
|
|
2798
|
+
```typescript
|
|
2799
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
2800
|
+
import { webhookEventsPostWebhookEventsWalletTerminated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-terminated.js";
|
|
2801
|
+
|
|
2802
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
2803
|
+
// You can create one instance of it to use across an application.
|
|
2804
|
+
const flexprice = new FlexpriceCore({
|
|
2805
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2806
|
+
});
|
|
2807
|
+
|
|
2808
|
+
async function run() {
|
|
2809
|
+
const res = await webhookEventsPostWebhookEventsWalletTerminated(flexprice);
|
|
2810
|
+
if (res.ok) {
|
|
2811
|
+
const { value: result } = res;
|
|
2812
|
+
console.log(result);
|
|
2813
|
+
} else {
|
|
2814
|
+
console.log("webhookEventsPostWebhookEventsWalletTerminated failed:", res.error);
|
|
2815
|
+
}
|
|
2816
|
+
}
|
|
2817
|
+
|
|
2818
|
+
run();
|
|
2819
|
+
```
|
|
2820
|
+
|
|
2821
|
+
### Parameters
|
|
2822
|
+
|
|
2823
|
+
| Parameter | Type | Required | Description |
|
|
2824
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2825
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2826
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2827
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2828
|
+
|
|
2829
|
+
### Response
|
|
2830
|
+
|
|
2831
|
+
**Promise\<[models.WebhookDtoWalletWebhookPayload](../../sdk/models/webhook-dto-wallet-webhook-payload.md)\>**
|
|
2832
|
+
|
|
2833
|
+
### Errors
|
|
2834
|
+
|
|
2835
|
+
| Error Type | Status Code | Content Type |
|
|
2836
|
+
| --------------- | --------------- | --------------- |
|
|
2837
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
2838
|
+
|
|
2839
|
+
## postWebhookEventsWalletTransactionCreated
|
|
2840
|
+
|
|
2841
|
+
Fired when a new wallet transaction is created (top-up, deduction, etc.). Doc-only for parsing.
|
|
2842
|
+
|
|
2843
|
+
### Example Usage
|
|
2844
|
+
|
|
2845
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/wallet.transaction.created" method="post" path="/webhook-events/wallet.transaction.created" -->
|
|
2846
|
+
```typescript
|
|
2847
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
2848
|
+
|
|
2849
|
+
const flexprice = new Flexprice({
|
|
2850
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2851
|
+
});
|
|
2852
|
+
|
|
2853
|
+
async function run() {
|
|
2854
|
+
const result = await flexprice.webhookEvents.postWebhookEventsWalletTransactionCreated();
|
|
2855
|
+
|
|
2856
|
+
console.log(result);
|
|
2857
|
+
}
|
|
2858
|
+
|
|
2859
|
+
run();
|
|
2860
|
+
```
|
|
2861
|
+
|
|
2862
|
+
### Standalone function
|
|
2863
|
+
|
|
2864
|
+
The standalone function version of this method:
|
|
2865
|
+
|
|
2866
|
+
```typescript
|
|
2867
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
2868
|
+
import { webhookEventsPostWebhookEventsWalletTransactionCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-transaction-created.js";
|
|
2869
|
+
|
|
2870
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
2871
|
+
// You can create one instance of it to use across an application.
|
|
2872
|
+
const flexprice = new FlexpriceCore({
|
|
2873
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2874
|
+
});
|
|
2875
|
+
|
|
2876
|
+
async function run() {
|
|
2877
|
+
const res = await webhookEventsPostWebhookEventsWalletTransactionCreated(flexprice);
|
|
2878
|
+
if (res.ok) {
|
|
2879
|
+
const { value: result } = res;
|
|
2880
|
+
console.log(result);
|
|
2881
|
+
} else {
|
|
2882
|
+
console.log("webhookEventsPostWebhookEventsWalletTransactionCreated failed:", res.error);
|
|
2883
|
+
}
|
|
2884
|
+
}
|
|
2885
|
+
|
|
2886
|
+
run();
|
|
2887
|
+
```
|
|
2888
|
+
|
|
2889
|
+
### Parameters
|
|
2890
|
+
|
|
2891
|
+
| Parameter | Type | Required | Description |
|
|
2892
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2893
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2894
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2895
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2896
|
+
|
|
2897
|
+
### Response
|
|
2898
|
+
|
|
2899
|
+
**Promise\<[models.WebhookDtoTransactionWebhookPayload](../../sdk/models/webhook-dto-transaction-webhook-payload.md)\>**
|
|
2900
|
+
|
|
2901
|
+
### Errors
|
|
2902
|
+
|
|
2903
|
+
| Error Type | Status Code | Content Type |
|
|
2904
|
+
| --------------- | --------------- | --------------- |
|
|
2905
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
2906
|
+
|
|
2907
|
+
## postWebhookEventsWalletUpdated
|
|
2908
|
+
|
|
2909
|
+
Fired when a wallet is updated. Doc-only for parsing.
|
|
2910
|
+
|
|
2911
|
+
### Example Usage
|
|
2912
|
+
|
|
2913
|
+
<!-- UsageSnippet language="typescript" operationID="post_/webhook-events/wallet.updated" method="post" path="/webhook-events/wallet.updated" -->
|
|
2914
|
+
```typescript
|
|
2915
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
2916
|
+
|
|
2917
|
+
const flexprice = new Flexprice({
|
|
2918
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2919
|
+
});
|
|
2920
|
+
|
|
2921
|
+
async function run() {
|
|
2922
|
+
const result = await flexprice.webhookEvents.postWebhookEventsWalletUpdated();
|
|
2923
|
+
|
|
2924
|
+
console.log(result);
|
|
2925
|
+
}
|
|
2926
|
+
|
|
2927
|
+
run();
|
|
2928
|
+
```
|
|
2929
|
+
|
|
2930
|
+
### Standalone function
|
|
2931
|
+
|
|
2932
|
+
The standalone function version of this method:
|
|
2933
|
+
|
|
2934
|
+
```typescript
|
|
2935
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
2936
|
+
import { webhookEventsPostWebhookEventsWalletUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-updated.js";
|
|
2937
|
+
|
|
2938
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
2939
|
+
// You can create one instance of it to use across an application.
|
|
2940
|
+
const flexprice = new FlexpriceCore({
|
|
2941
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2942
|
+
});
|
|
2943
|
+
|
|
2944
|
+
async function run() {
|
|
2945
|
+
const res = await webhookEventsPostWebhookEventsWalletUpdated(flexprice);
|
|
2946
|
+
if (res.ok) {
|
|
2947
|
+
const { value: result } = res;
|
|
2948
|
+
console.log(result);
|
|
2949
|
+
} else {
|
|
2950
|
+
console.log("webhookEventsPostWebhookEventsWalletUpdated failed:", res.error);
|
|
2951
|
+
}
|
|
2952
|
+
}
|
|
2953
|
+
|
|
2954
|
+
run();
|
|
2955
|
+
```
|
|
2956
|
+
|
|
2957
|
+
### Parameters
|
|
2958
|
+
|
|
2959
|
+
| Parameter | Type | Required | Description |
|
|
2960
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2961
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2962
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2963
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2964
|
+
|
|
2965
|
+
### Response
|
|
2966
|
+
|
|
2967
|
+
**Promise\<[models.WebhookDtoWalletWebhookPayload](../../sdk/models/webhook-dto-wallet-webhook-payload.md)\>**
|
|
2968
|
+
|
|
2969
|
+
### Errors
|
|
2970
|
+
|
|
2971
|
+
| Error Type | Status Code | Content Type |
|
|
2972
|
+
| --------------- | --------------- | --------------- |
|
|
2973
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|