@paid-ai/paid-node 1.2.1 → 1.5.0
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/dist/cjs/Client.d.ts +9 -0
- package/dist/cjs/Client.js +33 -18
- package/dist/cjs/api/errors/ConflictError.d.ts +6 -0
- package/dist/cjs/api/errors/ConflictError.js +50 -0
- package/dist/cjs/api/errors/index.d.ts +1 -0
- package/dist/cjs/api/errors/index.js +1 -0
- package/dist/cjs/api/resources/checkouts/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/cost/client/Client.d.ts +38 -0
- package/dist/cjs/api/resources/cost/client/Client.js +139 -0
- package/dist/cjs/api/resources/cost/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/cost/client/index.js +17 -0
- package/dist/cjs/api/resources/cost/client/requests/CostIngestRequest.d.ts +17 -0
- package/dist/cjs/api/resources/cost/client/requests/CostIngestRequest.js +3 -0
- package/dist/cjs/api/resources/cost/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/cost/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/cost/index.d.ts +1 -0
- package/dist/cjs/api/resources/cost/index.js +17 -0
- package/dist/cjs/api/resources/customers/client/Client.d.ts +19 -0
- package/dist/cjs/api/resources/customers/client/Client.js +86 -0
- package/dist/cjs/api/resources/customers/client/requests/UpsertCustomerUserRequest.d.ts +16 -0
- package/dist/cjs/api/resources/customers/client/requests/UpsertCustomerUserRequest.js +3 -0
- package/dist/cjs/api/resources/customers/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/index.d.ts +9 -0
- package/dist/cjs/api/resources/index.js +10 -1
- package/dist/cjs/api/resources/orders/client/Client.d.ts +60 -0
- package/dist/cjs/api/resources/orders/client/Client.js +242 -0
- package/dist/cjs/api/resources/orders/client/requests/BatchSeatAssignmentsRequest.d.ts +22 -0
- package/dist/cjs/api/resources/orders/client/requests/BatchSeatAssignmentsRequest.js +3 -0
- package/dist/cjs/api/resources/orders/client/requests/CreateOrderRequest.d.ts +1 -0
- package/dist/cjs/api/resources/orders/client/requests/ListOrderSeatsRequest.d.ts +14 -0
- package/dist/cjs/api/resources/orders/client/requests/ListOrderSeatsRequest.js +3 -0
- package/dist/cjs/api/resources/orders/client/requests/UpdateSeatAssignmentRequest.d.ts +12 -0
- package/dist/cjs/api/resources/orders/client/requests/UpdateSeatAssignmentRequest.js +3 -0
- package/dist/cjs/api/resources/orders/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/orders/index.d.ts +1 -0
- package/dist/cjs/api/resources/orders/index.js +1 -0
- package/dist/cjs/api/resources/orders/types/ListOrderSeatsRequestStatus.d.ts +5 -0
- package/dist/cjs/api/resources/orders/types/ListOrderSeatsRequestStatus.js +8 -0
- package/dist/cjs/api/resources/orders/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/orders/types/index.js +17 -0
- package/dist/cjs/api/resources/pricing/client/Client.d.ts +71 -0
- package/dist/cjs/api/resources/pricing/client/Client.js +284 -0
- package/dist/cjs/api/resources/pricing/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/pricing/client/index.js +17 -0
- package/dist/cjs/api/resources/pricing/client/requests/GetPricingRequest.d.ts +9 -0
- package/dist/cjs/api/resources/pricing/client/requests/GetPricingRequest.js +3 -0
- package/dist/cjs/api/resources/pricing/client/requests/ListPricingRequest.d.ts +10 -0
- package/dist/cjs/api/resources/pricing/client/requests/ListPricingRequest.js +3 -0
- package/dist/cjs/api/resources/pricing/client/requests/UpdatePricingRequest.d.ts +20 -0
- package/dist/cjs/api/resources/pricing/client/requests/UpdatePricingRequest.js +3 -0
- package/dist/cjs/api/resources/pricing/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/pricing/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/pricing/index.d.ts +1 -0
- package/dist/cjs/api/resources/pricing/index.js +17 -0
- package/dist/cjs/api/resources/valueReceipts/client/Client.d.ts +85 -0
- package/dist/cjs/api/resources/valueReceipts/client/Client.js +362 -1
- package/dist/cjs/api/resources/valueReceipts/client/requests/ArchiveValueReceiptRequest.d.ts +9 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/ArchiveValueReceiptRequest.js +3 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/ListValueReceiptsRequest.d.ts +7 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/RefreshValueReceiptRequest.d.ts +9 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/RefreshValueReceiptRequest.js +3 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/SealValueReceiptRequest.d.ts +9 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/SealValueReceiptRequest.js +3 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/SyncValueReceiptRequest.d.ts +28 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/SyncValueReceiptRequest.js +3 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/UnarchiveValueReceiptRequest.d.ts +9 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/UnarchiveValueReceiptRequest.js +3 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/index.d.ts +5 -0
- package/dist/cjs/api/resources/valueReceipts/index.d.ts +1 -0
- package/dist/cjs/api/resources/valueReceipts/index.js +1 -0
- package/dist/cjs/api/resources/valueReceipts/types/ListValueReceiptsRequestArchived.d.ts +5 -0
- package/dist/cjs/api/resources/valueReceipts/types/ListValueReceiptsRequestArchived.js +8 -0
- package/dist/cjs/api/resources/valueReceipts/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/valueReceipts/types/index.js +17 -0
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +63 -0
- package/dist/cjs/api/resources/webhooks/client/Client.js +282 -0
- package/dist/cjs/api/resources/webhooks/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/webhooks/client/index.js +17 -0
- package/dist/cjs/api/resources/webhooks/client/requests/TestWebhookRequest.d.ts +10 -0
- package/dist/cjs/api/resources/webhooks/client/requests/TestWebhookRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhookRequest.d.ts +14 -0
- package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhookRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/webhooks/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/webhooks/index.d.ts +2 -0
- package/dist/cjs/api/resources/webhooks/index.js +18 -0
- package/dist/cjs/api/resources/webhooks/types/TestWebhookRequestWebhookName.d.ts +12 -0
- package/dist/cjs/api/resources/webhooks/types/TestWebhookRequestWebhookName.js +15 -0
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhookRequestWebhookName.d.ts +12 -0
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhookRequestWebhookName.js +15 -0
- package/dist/cjs/api/resources/webhooks/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/webhooks/types/index.js +18 -0
- package/dist/cjs/api/types/BatchSeatAssignmentsResponse.d.ts +4 -0
- package/dist/cjs/api/types/BatchSeatAssignmentsResponse.js +3 -0
- package/dist/cjs/api/types/CheckoutDetails.d.ts +21 -0
- package/dist/cjs/api/types/CheckoutDetails.js +3 -0
- package/dist/cjs/api/types/Cost.d.ts +10 -0
- package/dist/cjs/api/types/Cost.js +3 -0
- package/dist/cjs/api/types/CostIngestResponse.d.ts +6 -0
- package/dist/cjs/api/types/CostIngestResponse.js +3 -0
- package/dist/cjs/api/types/CostOverride.d.ts +8 -0
- package/dist/cjs/api/types/CostOverride.js +3 -0
- package/dist/cjs/api/types/CreateOrderLineAttributeRequest.d.ts +1 -0
- package/dist/cjs/api/types/CreditBalance.d.ts +6 -0
- package/dist/cjs/api/types/CreditBenefitInput.d.ts +30 -0
- package/dist/cjs/api/types/CreditBenefitInput.js +20 -0
- package/dist/cjs/api/types/CreditBenefitOutput.d.ts +13 -0
- package/dist/cjs/api/types/CreditBenefitOutput.js +3 -0
- package/dist/cjs/api/types/CreditGrant.d.ts +11 -0
- package/dist/cjs/api/types/CreditGrant.js +3 -0
- package/dist/cjs/api/types/CustomerUser.d.ts +13 -0
- package/dist/cjs/api/types/CustomerUser.js +3 -0
- package/dist/cjs/api/types/CustomerUserStatus.d.ts +5 -0
- package/dist/cjs/api/types/CustomerUserStatus.js +8 -0
- package/dist/cjs/api/types/OneTimePerUnitInput.d.ts +21 -0
- package/dist/cjs/api/types/OneTimePerUnitInput.js +18 -0
- package/dist/cjs/api/types/Order.d.ts +2 -0
- package/dist/cjs/api/types/OrderBillingFrequencyOverride.d.ts +14 -0
- package/dist/cjs/api/types/OrderBillingFrequencyOverride.js +14 -0
- package/dist/cjs/api/types/OrderSeat.d.ts +10 -0
- package/dist/cjs/api/types/OrderSeat.js +3 -0
- package/dist/cjs/api/types/OrderSeatListResponse.d.ts +5 -0
- package/dist/cjs/api/types/OrderSeatListResponse.js +3 -0
- package/dist/cjs/api/types/PrecomputedCost.d.ts +17 -0
- package/dist/cjs/api/types/PrecomputedCost.js +3 -0
- package/dist/cjs/api/types/PricingInput.d.ts +46 -0
- package/dist/cjs/api/types/PricingInput.js +3 -0
- package/dist/cjs/api/types/PricingListResponse.d.ts +4 -0
- package/dist/cjs/api/types/PricingListResponse.js +3 -0
- package/dist/cjs/api/types/PricingOutput.d.ts +36 -0
- package/dist/cjs/api/types/PricingOutput.js +23 -0
- package/dist/cjs/api/types/PricingPricePointOutput.d.ts +29 -0
- package/dist/cjs/api/types/PricingPricePointOutput.js +17 -0
- package/dist/cjs/api/types/PricingResponse.d.ts +7 -0
- package/dist/cjs/api/types/PricingResponse.js +3 -0
- package/dist/cjs/api/types/ProductAttribution.d.ts +2 -0
- package/dist/cjs/api/types/ProductAttribution.js +3 -0
- package/dist/cjs/api/types/RecurringGraduatedInput.d.ts +22 -0
- package/dist/cjs/api/types/RecurringGraduatedInput.js +18 -0
- package/dist/cjs/api/types/RecurringPerUnitInput.d.ts +22 -0
- package/dist/cjs/api/types/RecurringPerUnitInput.js +18 -0
- package/dist/cjs/api/types/RecurringPercentOfTotalInput.d.ts +23 -0
- package/dist/cjs/api/types/RecurringPercentOfTotalInput.js +18 -0
- package/dist/cjs/api/types/RecurringVolumeInput.d.ts +22 -0
- package/dist/cjs/api/types/RecurringVolumeInput.js +18 -0
- package/dist/cjs/api/types/SeatAssignee.d.ts +5 -0
- package/dist/cjs/api/types/SeatAssignee.js +3 -0
- package/dist/cjs/api/types/SeatAssignmentStatus.d.ts +5 -0
- package/dist/cjs/api/types/SeatAssignmentStatus.js +8 -0
- package/dist/cjs/api/types/SeatBasedGraduatedInput.d.ts +22 -0
- package/dist/cjs/api/types/SeatBasedGraduatedInput.js +18 -0
- package/dist/cjs/api/types/SeatBasedPerUnitInput.d.ts +22 -0
- package/dist/cjs/api/types/SeatBasedPerUnitInput.js +18 -0
- package/dist/cjs/api/types/SeatBasedPrepaidCreditsInput.d.ts +25 -0
- package/dist/cjs/api/types/SeatBasedPrepaidCreditsInput.js +18 -0
- package/dist/cjs/api/types/SeatBasedVolumeInput.d.ts +22 -0
- package/dist/cjs/api/types/SeatBasedVolumeInput.js +18 -0
- package/dist/cjs/api/types/SimplePricePoint.d.ts +29 -0
- package/dist/cjs/api/types/SimplePricePoint.js +17 -0
- package/dist/cjs/api/types/SuccessResponse.d.ts +3 -0
- package/dist/cjs/api/types/SuccessResponse.js +3 -0
- package/dist/cjs/api/types/TieredPricePoint.d.ts +29 -0
- package/dist/cjs/api/types/TieredPricePoint.js +17 -0
- package/dist/cjs/api/types/TokenUsage.d.ts +12 -0
- package/dist/cjs/api/types/TokenUsage.js +3 -0
- package/dist/cjs/api/types/UsageCost.d.ts +15 -0
- package/dist/cjs/api/types/UsageCost.js +3 -0
- package/dist/cjs/api/types/UsageCostPlusInput.d.ts +23 -0
- package/dist/cjs/api/types/UsageCostPlusInput.js +18 -0
- package/dist/cjs/api/types/UsageGraduatedInput.d.ts +23 -0
- package/dist/cjs/api/types/UsageGraduatedInput.js +18 -0
- package/dist/cjs/api/types/UsagePerUnitInput.d.ts +23 -0
- package/dist/cjs/api/types/UsagePerUnitInput.js +18 -0
- package/dist/cjs/api/types/UsagePrepaidCreditsInput.d.ts +26 -0
- package/dist/cjs/api/types/UsagePrepaidCreditsInput.js +18 -0
- package/dist/cjs/api/types/UsageVolumeInput.d.ts +23 -0
- package/dist/cjs/api/types/UsageVolumeInput.js +18 -0
- package/dist/cjs/api/types/ValueReceiptDetail.d.ts +2 -0
- package/dist/cjs/api/types/ValueReceiptSummary.d.ts +2 -0
- package/dist/cjs/api/types/ValueReceiptSyncResponse.d.ts +6 -0
- package/dist/cjs/api/types/ValueReceiptSyncResponse.js +3 -0
- package/dist/cjs/api/types/Webhook.d.ts +24 -0
- package/dist/cjs/api/types/Webhook.js +18 -0
- package/dist/cjs/api/types/WebhookDeliveryStatus.d.ts +5 -0
- package/dist/cjs/api/types/WebhookDeliveryStatus.js +8 -0
- package/dist/cjs/api/types/WebhookListResponse.d.ts +4 -0
- package/dist/cjs/api/types/WebhookListResponse.js +3 -0
- package/dist/cjs/api/types/WebhookTestResponse.d.ts +3 -0
- package/dist/cjs/api/types/WebhookTestResponse.js +3 -0
- package/dist/cjs/api/types/index.d.ts +46 -0
- package/dist/cjs/api/types/index.js +46 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +9 -0
- package/dist/esm/Client.mjs +17 -2
- package/dist/esm/api/errors/ConflictError.d.mts +6 -0
- package/dist/esm/api/errors/ConflictError.mjs +13 -0
- package/dist/esm/api/errors/index.d.mts +1 -0
- package/dist/esm/api/errors/index.mjs +1 -0
- package/dist/esm/api/resources/checkouts/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/cost/client/Client.d.mts +38 -0
- package/dist/esm/api/resources/cost/client/Client.mjs +102 -0
- package/dist/esm/api/resources/cost/client/index.d.mts +1 -0
- package/dist/esm/api/resources/cost/client/index.mjs +1 -0
- package/dist/esm/api/resources/cost/client/requests/CostIngestRequest.d.mts +17 -0
- package/dist/esm/api/resources/cost/client/requests/CostIngestRequest.mjs +2 -0
- package/dist/esm/api/resources/cost/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/cost/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/cost/index.d.mts +1 -0
- package/dist/esm/api/resources/cost/index.mjs +1 -0
- package/dist/esm/api/resources/customers/client/Client.d.mts +19 -0
- package/dist/esm/api/resources/customers/client/Client.mjs +86 -0
- package/dist/esm/api/resources/customers/client/requests/UpsertCustomerUserRequest.d.mts +16 -0
- package/dist/esm/api/resources/customers/client/requests/UpsertCustomerUserRequest.mjs +2 -0
- package/dist/esm/api/resources/customers/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/index.d.mts +9 -0
- package/dist/esm/api/resources/index.mjs +9 -0
- package/dist/esm/api/resources/orders/client/Client.d.mts +60 -0
- package/dist/esm/api/resources/orders/client/Client.mjs +242 -0
- package/dist/esm/api/resources/orders/client/requests/BatchSeatAssignmentsRequest.d.mts +22 -0
- package/dist/esm/api/resources/orders/client/requests/BatchSeatAssignmentsRequest.mjs +2 -0
- package/dist/esm/api/resources/orders/client/requests/CreateOrderRequest.d.mts +1 -0
- package/dist/esm/api/resources/orders/client/requests/ListOrderSeatsRequest.d.mts +14 -0
- package/dist/esm/api/resources/orders/client/requests/ListOrderSeatsRequest.mjs +2 -0
- package/dist/esm/api/resources/orders/client/requests/UpdateSeatAssignmentRequest.d.mts +12 -0
- package/dist/esm/api/resources/orders/client/requests/UpdateSeatAssignmentRequest.mjs +2 -0
- package/dist/esm/api/resources/orders/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/orders/index.d.mts +1 -0
- package/dist/esm/api/resources/orders/index.mjs +1 -0
- package/dist/esm/api/resources/orders/types/ListOrderSeatsRequestStatus.d.mts +5 -0
- package/dist/esm/api/resources/orders/types/ListOrderSeatsRequestStatus.mjs +5 -0
- package/dist/esm/api/resources/orders/types/index.d.mts +1 -0
- package/dist/esm/api/resources/orders/types/index.mjs +1 -0
- package/dist/esm/api/resources/pricing/client/Client.d.mts +71 -0
- package/dist/esm/api/resources/pricing/client/Client.mjs +247 -0
- package/dist/esm/api/resources/pricing/client/index.d.mts +1 -0
- package/dist/esm/api/resources/pricing/client/index.mjs +1 -0
- package/dist/esm/api/resources/pricing/client/requests/GetPricingRequest.d.mts +9 -0
- package/dist/esm/api/resources/pricing/client/requests/GetPricingRequest.mjs +2 -0
- package/dist/esm/api/resources/pricing/client/requests/ListPricingRequest.d.mts +10 -0
- package/dist/esm/api/resources/pricing/client/requests/ListPricingRequest.mjs +2 -0
- package/dist/esm/api/resources/pricing/client/requests/UpdatePricingRequest.d.mts +20 -0
- package/dist/esm/api/resources/pricing/client/requests/UpdatePricingRequest.mjs +2 -0
- package/dist/esm/api/resources/pricing/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/pricing/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/pricing/index.d.mts +1 -0
- package/dist/esm/api/resources/pricing/index.mjs +1 -0
- package/dist/esm/api/resources/valueReceipts/client/Client.d.mts +85 -0
- package/dist/esm/api/resources/valueReceipts/client/Client.mjs +362 -1
- package/dist/esm/api/resources/valueReceipts/client/requests/ArchiveValueReceiptRequest.d.mts +9 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/ArchiveValueReceiptRequest.mjs +2 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/ListValueReceiptsRequest.d.mts +7 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/RefreshValueReceiptRequest.d.mts +9 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/RefreshValueReceiptRequest.mjs +2 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/SealValueReceiptRequest.d.mts +9 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/SealValueReceiptRequest.mjs +2 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/SyncValueReceiptRequest.d.mts +28 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/SyncValueReceiptRequest.mjs +2 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/UnarchiveValueReceiptRequest.d.mts +9 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/UnarchiveValueReceiptRequest.mjs +2 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/index.d.mts +5 -0
- package/dist/esm/api/resources/valueReceipts/index.d.mts +1 -0
- package/dist/esm/api/resources/valueReceipts/index.mjs +1 -0
- package/dist/esm/api/resources/valueReceipts/types/ListValueReceiptsRequestArchived.d.mts +5 -0
- package/dist/esm/api/resources/valueReceipts/types/ListValueReceiptsRequestArchived.mjs +5 -0
- package/dist/esm/api/resources/valueReceipts/types/index.d.mts +1 -0
- package/dist/esm/api/resources/valueReceipts/types/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +63 -0
- package/dist/esm/api/resources/webhooks/client/Client.mjs +245 -0
- package/dist/esm/api/resources/webhooks/client/index.d.mts +1 -0
- package/dist/esm/api/resources/webhooks/client/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/client/requests/TestWebhookRequest.d.mts +10 -0
- package/dist/esm/api/resources/webhooks/client/requests/TestWebhookRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhookRequest.d.mts +14 -0
- package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhookRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/index.d.mts +2 -0
- package/dist/esm/api/resources/webhooks/index.mjs +2 -0
- package/dist/esm/api/resources/webhooks/types/TestWebhookRequestWebhookName.d.mts +12 -0
- package/dist/esm/api/resources/webhooks/types/TestWebhookRequestWebhookName.mjs +12 -0
- package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequestWebhookName.d.mts +12 -0
- package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequestWebhookName.mjs +12 -0
- package/dist/esm/api/resources/webhooks/types/index.d.mts +2 -0
- package/dist/esm/api/resources/webhooks/types/index.mjs +2 -0
- package/dist/esm/api/types/BatchSeatAssignmentsResponse.d.mts +4 -0
- package/dist/esm/api/types/BatchSeatAssignmentsResponse.mjs +2 -0
- package/dist/esm/api/types/CheckoutDetails.d.mts +21 -0
- package/dist/esm/api/types/CheckoutDetails.mjs +2 -0
- package/dist/esm/api/types/Cost.d.mts +10 -0
- package/dist/esm/api/types/Cost.mjs +2 -0
- package/dist/esm/api/types/CostIngestResponse.d.mts +6 -0
- package/dist/esm/api/types/CostIngestResponse.mjs +2 -0
- package/dist/esm/api/types/CostOverride.d.mts +8 -0
- package/dist/esm/api/types/CostOverride.mjs +2 -0
- package/dist/esm/api/types/CreateOrderLineAttributeRequest.d.mts +1 -0
- package/dist/esm/api/types/CreditBalance.d.mts +6 -0
- package/dist/esm/api/types/CreditBenefitInput.d.mts +30 -0
- package/dist/esm/api/types/CreditBenefitInput.mjs +17 -0
- package/dist/esm/api/types/CreditBenefitOutput.d.mts +13 -0
- package/dist/esm/api/types/CreditBenefitOutput.mjs +2 -0
- package/dist/esm/api/types/CreditGrant.d.mts +11 -0
- package/dist/esm/api/types/CreditGrant.mjs +2 -0
- package/dist/esm/api/types/CustomerUser.d.mts +13 -0
- package/dist/esm/api/types/CustomerUser.mjs +2 -0
- package/dist/esm/api/types/CustomerUserStatus.d.mts +5 -0
- package/dist/esm/api/types/CustomerUserStatus.mjs +5 -0
- package/dist/esm/api/types/OneTimePerUnitInput.d.mts +21 -0
- package/dist/esm/api/types/OneTimePerUnitInput.mjs +15 -0
- package/dist/esm/api/types/Order.d.mts +2 -0
- package/dist/esm/api/types/OrderBillingFrequencyOverride.d.mts +14 -0
- package/dist/esm/api/types/OrderBillingFrequencyOverride.mjs +11 -0
- package/dist/esm/api/types/OrderSeat.d.mts +10 -0
- package/dist/esm/api/types/OrderSeat.mjs +2 -0
- package/dist/esm/api/types/OrderSeatListResponse.d.mts +5 -0
- package/dist/esm/api/types/OrderSeatListResponse.mjs +2 -0
- package/dist/esm/api/types/PrecomputedCost.d.mts +17 -0
- package/dist/esm/api/types/PrecomputedCost.mjs +2 -0
- package/dist/esm/api/types/PricingInput.d.mts +46 -0
- package/dist/esm/api/types/PricingInput.mjs +2 -0
- package/dist/esm/api/types/PricingListResponse.d.mts +4 -0
- package/dist/esm/api/types/PricingListResponse.mjs +2 -0
- package/dist/esm/api/types/PricingOutput.d.mts +36 -0
- package/dist/esm/api/types/PricingOutput.mjs +20 -0
- package/dist/esm/api/types/PricingPricePointOutput.d.mts +29 -0
- package/dist/esm/api/types/PricingPricePointOutput.mjs +14 -0
- package/dist/esm/api/types/PricingResponse.d.mts +7 -0
- package/dist/esm/api/types/PricingResponse.mjs +2 -0
- package/dist/esm/api/types/ProductAttribution.d.mts +2 -0
- package/dist/esm/api/types/ProductAttribution.mjs +2 -0
- package/dist/esm/api/types/RecurringGraduatedInput.d.mts +22 -0
- package/dist/esm/api/types/RecurringGraduatedInput.mjs +15 -0
- package/dist/esm/api/types/RecurringPerUnitInput.d.mts +22 -0
- package/dist/esm/api/types/RecurringPerUnitInput.mjs +15 -0
- package/dist/esm/api/types/RecurringPercentOfTotalInput.d.mts +23 -0
- package/dist/esm/api/types/RecurringPercentOfTotalInput.mjs +15 -0
- package/dist/esm/api/types/RecurringVolumeInput.d.mts +22 -0
- package/dist/esm/api/types/RecurringVolumeInput.mjs +15 -0
- package/dist/esm/api/types/SeatAssignee.d.mts +5 -0
- package/dist/esm/api/types/SeatAssignee.mjs +2 -0
- package/dist/esm/api/types/SeatAssignmentStatus.d.mts +5 -0
- package/dist/esm/api/types/SeatAssignmentStatus.mjs +5 -0
- package/dist/esm/api/types/SeatBasedGraduatedInput.d.mts +22 -0
- package/dist/esm/api/types/SeatBasedGraduatedInput.mjs +15 -0
- package/dist/esm/api/types/SeatBasedPerUnitInput.d.mts +22 -0
- package/dist/esm/api/types/SeatBasedPerUnitInput.mjs +15 -0
- package/dist/esm/api/types/SeatBasedPrepaidCreditsInput.d.mts +25 -0
- package/dist/esm/api/types/SeatBasedPrepaidCreditsInput.mjs +15 -0
- package/dist/esm/api/types/SeatBasedVolumeInput.d.mts +22 -0
- package/dist/esm/api/types/SeatBasedVolumeInput.mjs +15 -0
- package/dist/esm/api/types/SimplePricePoint.d.mts +29 -0
- package/dist/esm/api/types/SimplePricePoint.mjs +14 -0
- package/dist/esm/api/types/SuccessResponse.d.mts +3 -0
- package/dist/esm/api/types/SuccessResponse.mjs +2 -0
- package/dist/esm/api/types/TieredPricePoint.d.mts +29 -0
- package/dist/esm/api/types/TieredPricePoint.mjs +14 -0
- package/dist/esm/api/types/TokenUsage.d.mts +12 -0
- package/dist/esm/api/types/TokenUsage.mjs +2 -0
- package/dist/esm/api/types/UsageCost.d.mts +15 -0
- package/dist/esm/api/types/UsageCost.mjs +2 -0
- package/dist/esm/api/types/UsageCostPlusInput.d.mts +23 -0
- package/dist/esm/api/types/UsageCostPlusInput.mjs +15 -0
- package/dist/esm/api/types/UsageGraduatedInput.d.mts +23 -0
- package/dist/esm/api/types/UsageGraduatedInput.mjs +15 -0
- package/dist/esm/api/types/UsagePerUnitInput.d.mts +23 -0
- package/dist/esm/api/types/UsagePerUnitInput.mjs +15 -0
- package/dist/esm/api/types/UsagePrepaidCreditsInput.d.mts +26 -0
- package/dist/esm/api/types/UsagePrepaidCreditsInput.mjs +15 -0
- package/dist/esm/api/types/UsageVolumeInput.d.mts +23 -0
- package/dist/esm/api/types/UsageVolumeInput.mjs +15 -0
- package/dist/esm/api/types/ValueReceiptDetail.d.mts +2 -0
- package/dist/esm/api/types/ValueReceiptSummary.d.mts +2 -0
- package/dist/esm/api/types/ValueReceiptSyncResponse.d.mts +6 -0
- package/dist/esm/api/types/ValueReceiptSyncResponse.mjs +2 -0
- package/dist/esm/api/types/Webhook.d.mts +24 -0
- package/dist/esm/api/types/Webhook.mjs +15 -0
- package/dist/esm/api/types/WebhookDeliveryStatus.d.mts +5 -0
- package/dist/esm/api/types/WebhookDeliveryStatus.mjs +5 -0
- package/dist/esm/api/types/WebhookListResponse.d.mts +4 -0
- package/dist/esm/api/types/WebhookListResponse.mjs +2 -0
- package/dist/esm/api/types/WebhookTestResponse.d.mts +3 -0
- package/dist/esm/api/types/WebhookTestResponse.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +46 -0
- package/dist/esm/api/types/index.mjs +46 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +1159 -105
package/reference.md
CHANGED
|
@@ -1037,6 +1037,72 @@ await client.customers.getCustomerCreditBalancesByExternalId({
|
|
|
1037
1037
|
</dl>
|
|
1038
1038
|
|
|
1039
1039
|
|
|
1040
|
+
</dd>
|
|
1041
|
+
</dl>
|
|
1042
|
+
</details>
|
|
1043
|
+
|
|
1044
|
+
<details><summary><code>client.customers.<a href="/src/api/resources/customers/client/Client.ts">upsertCustomerUserByExternalId</a>({ ...params }) -> Paid.CustomerUser</code></summary>
|
|
1045
|
+
<dl>
|
|
1046
|
+
<dd>
|
|
1047
|
+
|
|
1048
|
+
#### 📝 Description
|
|
1049
|
+
|
|
1050
|
+
<dl>
|
|
1051
|
+
<dd>
|
|
1052
|
+
|
|
1053
|
+
<dl>
|
|
1054
|
+
<dd>
|
|
1055
|
+
|
|
1056
|
+
Create or update a customer user using customer and user external IDs
|
|
1057
|
+
</dd>
|
|
1058
|
+
</dl>
|
|
1059
|
+
</dd>
|
|
1060
|
+
</dl>
|
|
1061
|
+
|
|
1062
|
+
#### 🔌 Usage
|
|
1063
|
+
|
|
1064
|
+
<dl>
|
|
1065
|
+
<dd>
|
|
1066
|
+
|
|
1067
|
+
<dl>
|
|
1068
|
+
<dd>
|
|
1069
|
+
|
|
1070
|
+
```typescript
|
|
1071
|
+
await client.customers.upsertCustomerUserByExternalId({
|
|
1072
|
+
customerExternalId: "customerExternalId",
|
|
1073
|
+
userExternalId: "userExternalId"
|
|
1074
|
+
});
|
|
1075
|
+
|
|
1076
|
+
```
|
|
1077
|
+
</dd>
|
|
1078
|
+
</dl>
|
|
1079
|
+
</dd>
|
|
1080
|
+
</dl>
|
|
1081
|
+
|
|
1082
|
+
#### ⚙️ Parameters
|
|
1083
|
+
|
|
1084
|
+
<dl>
|
|
1085
|
+
<dd>
|
|
1086
|
+
|
|
1087
|
+
<dl>
|
|
1088
|
+
<dd>
|
|
1089
|
+
|
|
1090
|
+
**request:** `Paid.UpsertCustomerUserRequest`
|
|
1091
|
+
|
|
1092
|
+
</dd>
|
|
1093
|
+
</dl>
|
|
1094
|
+
|
|
1095
|
+
<dl>
|
|
1096
|
+
<dd>
|
|
1097
|
+
|
|
1098
|
+
**requestOptions:** `Customers.RequestOptions`
|
|
1099
|
+
|
|
1100
|
+
</dd>
|
|
1101
|
+
</dl>
|
|
1102
|
+
</dd>
|
|
1103
|
+
</dl>
|
|
1104
|
+
|
|
1105
|
+
|
|
1040
1106
|
</dd>
|
|
1041
1107
|
</dl>
|
|
1042
1108
|
</details>
|
|
@@ -1952,8 +2018,7 @@ await client.orders.getOrderLines({
|
|
|
1952
2018
|
</dl>
|
|
1953
2019
|
</details>
|
|
1954
2020
|
|
|
1955
|
-
|
|
1956
|
-
<details><summary><code>client.invoices.<a href="/src/api/resources/invoices/client/Client.ts">listInvoices</a>({ ...params }) -> Paid.InvoiceListResponse</code></summary>
|
|
2021
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">listOrderSeats</a>({ ...params }) -> Paid.OrderSeatListResponse</code></summary>
|
|
1957
2022
|
<dl>
|
|
1958
2023
|
<dd>
|
|
1959
2024
|
|
|
@@ -1965,7 +2030,7 @@ await client.orders.getOrderLines({
|
|
|
1965
2030
|
<dl>
|
|
1966
2031
|
<dd>
|
|
1967
2032
|
|
|
1968
|
-
|
|
2033
|
+
List seats for an order
|
|
1969
2034
|
</dd>
|
|
1970
2035
|
</dl>
|
|
1971
2036
|
</dd>
|
|
@@ -1980,7 +2045,9 @@ Get a list of invoices for the organization
|
|
|
1980
2045
|
<dd>
|
|
1981
2046
|
|
|
1982
2047
|
```typescript
|
|
1983
|
-
await client.
|
|
2048
|
+
await client.orders.listOrderSeats({
|
|
2049
|
+
id: "id"
|
|
2050
|
+
});
|
|
1984
2051
|
|
|
1985
2052
|
```
|
|
1986
2053
|
</dd>
|
|
@@ -1996,7 +2063,7 @@ await client.invoices.listInvoices();
|
|
|
1996
2063
|
<dl>
|
|
1997
2064
|
<dd>
|
|
1998
2065
|
|
|
1999
|
-
**request:** `Paid.
|
|
2066
|
+
**request:** `Paid.ListOrderSeatsRequest`
|
|
2000
2067
|
|
|
2001
2068
|
</dd>
|
|
2002
2069
|
</dl>
|
|
@@ -2004,7 +2071,7 @@ await client.invoices.listInvoices();
|
|
|
2004
2071
|
<dl>
|
|
2005
2072
|
<dd>
|
|
2006
2073
|
|
|
2007
|
-
**requestOptions:** `
|
|
2074
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
2008
2075
|
|
|
2009
2076
|
</dd>
|
|
2010
2077
|
</dl>
|
|
@@ -2016,7 +2083,7 @@ await client.invoices.listInvoices();
|
|
|
2016
2083
|
</dl>
|
|
2017
2084
|
</details>
|
|
2018
2085
|
|
|
2019
|
-
<details><summary><code>client.
|
|
2086
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">updateOrderSeatAssignment</a>({ ...params }) -> Paid.OrderSeat</code></summary>
|
|
2020
2087
|
<dl>
|
|
2021
2088
|
<dd>
|
|
2022
2089
|
|
|
@@ -2028,7 +2095,7 @@ await client.invoices.listInvoices();
|
|
|
2028
2095
|
<dl>
|
|
2029
2096
|
<dd>
|
|
2030
2097
|
|
|
2031
|
-
|
|
2098
|
+
Assign or unassign a single seat on an order
|
|
2032
2099
|
</dd>
|
|
2033
2100
|
</dl>
|
|
2034
2101
|
</dd>
|
|
@@ -2043,8 +2110,9 @@ Get an invoice by ID
|
|
|
2043
2110
|
<dd>
|
|
2044
2111
|
|
|
2045
2112
|
```typescript
|
|
2046
|
-
await client.
|
|
2047
|
-
id: "id"
|
|
2113
|
+
await client.orders.updateOrderSeatAssignment({
|
|
2114
|
+
id: "id",
|
|
2115
|
+
seatId: "seatId"
|
|
2048
2116
|
});
|
|
2049
2117
|
|
|
2050
2118
|
```
|
|
@@ -2061,7 +2129,7 @@ await client.invoices.getInvoiceById({
|
|
|
2061
2129
|
<dl>
|
|
2062
2130
|
<dd>
|
|
2063
2131
|
|
|
2064
|
-
**request:** `Paid.
|
|
2132
|
+
**request:** `Paid.UpdateSeatAssignmentRequest`
|
|
2065
2133
|
|
|
2066
2134
|
</dd>
|
|
2067
2135
|
</dl>
|
|
@@ -2069,7 +2137,7 @@ await client.invoices.getInvoiceById({
|
|
|
2069
2137
|
<dl>
|
|
2070
2138
|
<dd>
|
|
2071
2139
|
|
|
2072
|
-
**requestOptions:** `
|
|
2140
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
2073
2141
|
|
|
2074
2142
|
</dd>
|
|
2075
2143
|
</dl>
|
|
@@ -2081,7 +2149,7 @@ await client.invoices.getInvoiceById({
|
|
|
2081
2149
|
</dl>
|
|
2082
2150
|
</details>
|
|
2083
2151
|
|
|
2084
|
-
<details><summary><code>client.
|
|
2152
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">batchOrderSeatAssignments</a>({ ...params }) -> Paid.BatchSeatAssignmentsResponse</code></summary>
|
|
2085
2153
|
<dl>
|
|
2086
2154
|
<dd>
|
|
2087
2155
|
|
|
@@ -2093,7 +2161,7 @@ await client.invoices.getInvoiceById({
|
|
|
2093
2161
|
<dl>
|
|
2094
2162
|
<dd>
|
|
2095
2163
|
|
|
2096
|
-
|
|
2164
|
+
Assign or unassign seats in batch for an order
|
|
2097
2165
|
</dd>
|
|
2098
2166
|
</dl>
|
|
2099
2167
|
</dd>
|
|
@@ -2108,8 +2176,11 @@ Update an invoice by ID
|
|
|
2108
2176
|
<dd>
|
|
2109
2177
|
|
|
2110
2178
|
```typescript
|
|
2111
|
-
await client.
|
|
2112
|
-
id: "id"
|
|
2179
|
+
await client.orders.batchOrderSeatAssignments({
|
|
2180
|
+
id: "id",
|
|
2181
|
+
assignments: [{
|
|
2182
|
+
seatId: "seatId"
|
|
2183
|
+
}]
|
|
2113
2184
|
});
|
|
2114
2185
|
|
|
2115
2186
|
```
|
|
@@ -2126,7 +2197,7 @@ await client.invoices.updateInvoiceById({
|
|
|
2126
2197
|
<dl>
|
|
2127
2198
|
<dd>
|
|
2128
2199
|
|
|
2129
|
-
**request:** `Paid.
|
|
2200
|
+
**request:** `Paid.BatchSeatAssignmentsRequest`
|
|
2130
2201
|
|
|
2131
2202
|
</dd>
|
|
2132
2203
|
</dl>
|
|
@@ -2134,7 +2205,7 @@ await client.invoices.updateInvoiceById({
|
|
|
2134
2205
|
<dl>
|
|
2135
2206
|
<dd>
|
|
2136
2207
|
|
|
2137
|
-
**requestOptions:** `
|
|
2208
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
2138
2209
|
|
|
2139
2210
|
</dd>
|
|
2140
2211
|
</dl>
|
|
@@ -2146,7 +2217,8 @@ await client.invoices.updateInvoiceById({
|
|
|
2146
2217
|
</dl>
|
|
2147
2218
|
</details>
|
|
2148
2219
|
|
|
2149
|
-
|
|
2220
|
+
## Invoices
|
|
2221
|
+
<details><summary><code>client.invoices.<a href="/src/api/resources/invoices/client/Client.ts">listInvoices</a>({ ...params }) -> Paid.InvoiceListResponse</code></summary>
|
|
2150
2222
|
<dl>
|
|
2151
2223
|
<dd>
|
|
2152
2224
|
|
|
@@ -2158,7 +2230,7 @@ await client.invoices.updateInvoiceById({
|
|
|
2158
2230
|
<dl>
|
|
2159
2231
|
<dd>
|
|
2160
2232
|
|
|
2161
|
-
Get
|
|
2233
|
+
Get a list of invoices for the organization
|
|
2162
2234
|
</dd>
|
|
2163
2235
|
</dl>
|
|
2164
2236
|
</dd>
|
|
@@ -2173,9 +2245,7 @@ Get the invoice lines for an invoice by ID
|
|
|
2173
2245
|
<dd>
|
|
2174
2246
|
|
|
2175
2247
|
```typescript
|
|
2176
|
-
await client.invoices.
|
|
2177
|
-
id: "id"
|
|
2178
|
-
});
|
|
2248
|
+
await client.invoices.listInvoices();
|
|
2179
2249
|
|
|
2180
2250
|
```
|
|
2181
2251
|
</dd>
|
|
@@ -2191,7 +2261,7 @@ await client.invoices.getInvoiceLines({
|
|
|
2191
2261
|
<dl>
|
|
2192
2262
|
<dd>
|
|
2193
2263
|
|
|
2194
|
-
**request:** `Paid.
|
|
2264
|
+
**request:** `Paid.ListInvoicesRequest`
|
|
2195
2265
|
|
|
2196
2266
|
</dd>
|
|
2197
2267
|
</dl>
|
|
@@ -2211,8 +2281,7 @@ await client.invoices.getInvoiceLines({
|
|
|
2211
2281
|
</dl>
|
|
2212
2282
|
</details>
|
|
2213
2283
|
|
|
2214
|
-
|
|
2215
|
-
<details><summary><code>client.signals.<a href="/src/api/resources/signals/client/Client.ts">createSignals</a>({ ...params }) -> Paid.BulkSignalsResponse</code></summary>
|
|
2284
|
+
<details><summary><code>client.invoices.<a href="/src/api/resources/invoices/client/Client.ts">getInvoiceById</a>({ ...params }) -> Paid.Invoice</code></summary>
|
|
2216
2285
|
<dl>
|
|
2217
2286
|
<dd>
|
|
2218
2287
|
|
|
@@ -2224,7 +2293,7 @@ await client.invoices.getInvoiceLines({
|
|
|
2224
2293
|
<dl>
|
|
2225
2294
|
<dd>
|
|
2226
2295
|
|
|
2227
|
-
|
|
2296
|
+
Get an invoice by ID
|
|
2228
2297
|
</dd>
|
|
2229
2298
|
</dl>
|
|
2230
2299
|
</dd>
|
|
@@ -2239,13 +2308,8 @@ Create multiple signals (usage events) in a single request. Each signal must inc
|
|
|
2239
2308
|
<dd>
|
|
2240
2309
|
|
|
2241
2310
|
```typescript
|
|
2242
|
-
await client.
|
|
2243
|
-
|
|
2244
|
-
eventName: "eventName",
|
|
2245
|
-
customer: {
|
|
2246
|
-
customerId: "customerId"
|
|
2247
|
-
}
|
|
2248
|
-
}]
|
|
2311
|
+
await client.invoices.getInvoiceById({
|
|
2312
|
+
id: "id"
|
|
2249
2313
|
});
|
|
2250
2314
|
|
|
2251
2315
|
```
|
|
@@ -2262,7 +2326,7 @@ await client.signals.createSignals({
|
|
|
2262
2326
|
<dl>
|
|
2263
2327
|
<dd>
|
|
2264
2328
|
|
|
2265
|
-
**request:** `Paid.
|
|
2329
|
+
**request:** `Paid.GetInvoiceByIdRequest`
|
|
2266
2330
|
|
|
2267
2331
|
</dd>
|
|
2268
2332
|
</dl>
|
|
@@ -2270,7 +2334,7 @@ await client.signals.createSignals({
|
|
|
2270
2334
|
<dl>
|
|
2271
2335
|
<dd>
|
|
2272
2336
|
|
|
2273
|
-
**requestOptions:** `
|
|
2337
|
+
**requestOptions:** `Invoices.RequestOptions`
|
|
2274
2338
|
|
|
2275
2339
|
</dd>
|
|
2276
2340
|
</dl>
|
|
@@ -2282,8 +2346,7 @@ await client.signals.createSignals({
|
|
|
2282
2346
|
</dl>
|
|
2283
2347
|
</details>
|
|
2284
2348
|
|
|
2285
|
-
|
|
2286
|
-
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">listCreditCurrencies</a>() -> Paid.CreditCurrencyListResponse</code></summary>
|
|
2349
|
+
<details><summary><code>client.invoices.<a href="/src/api/resources/invoices/client/Client.ts">updateInvoiceById</a>({ ...params }) -> Paid.Invoice</code></summary>
|
|
2287
2350
|
<dl>
|
|
2288
2351
|
<dd>
|
|
2289
2352
|
|
|
@@ -2295,7 +2358,7 @@ await client.signals.createSignals({
|
|
|
2295
2358
|
<dl>
|
|
2296
2359
|
<dd>
|
|
2297
2360
|
|
|
2298
|
-
|
|
2361
|
+
Update an invoice by ID
|
|
2299
2362
|
</dd>
|
|
2300
2363
|
</dl>
|
|
2301
2364
|
</dd>
|
|
@@ -2310,7 +2373,9 @@ List credit currencies for the organization
|
|
|
2310
2373
|
<dd>
|
|
2311
2374
|
|
|
2312
2375
|
```typescript
|
|
2313
|
-
await client.
|
|
2376
|
+
await client.invoices.updateInvoiceById({
|
|
2377
|
+
id: "id"
|
|
2378
|
+
});
|
|
2314
2379
|
|
|
2315
2380
|
```
|
|
2316
2381
|
</dd>
|
|
@@ -2326,7 +2391,15 @@ await client.credits.listCreditCurrencies();
|
|
|
2326
2391
|
<dl>
|
|
2327
2392
|
<dd>
|
|
2328
2393
|
|
|
2329
|
-
**
|
|
2394
|
+
**request:** `Paid.UpdateInvoiceRequest`
|
|
2395
|
+
|
|
2396
|
+
</dd>
|
|
2397
|
+
</dl>
|
|
2398
|
+
|
|
2399
|
+
<dl>
|
|
2400
|
+
<dd>
|
|
2401
|
+
|
|
2402
|
+
**requestOptions:** `Invoices.RequestOptions`
|
|
2330
2403
|
|
|
2331
2404
|
</dd>
|
|
2332
2405
|
</dl>
|
|
@@ -2338,8 +2411,7 @@ await client.credits.listCreditCurrencies();
|
|
|
2338
2411
|
</dl>
|
|
2339
2412
|
</details>
|
|
2340
2413
|
|
|
2341
|
-
|
|
2342
|
-
<details><summary><code>client.checkouts.<a href="/src/api/resources/checkouts/client/Client.ts">listCheckouts</a>({ ...params }) -> Paid.CheckoutListResponse</code></summary>
|
|
2414
|
+
<details><summary><code>client.invoices.<a href="/src/api/resources/invoices/client/Client.ts">getInvoiceLines</a>({ ...params }) -> Paid.InvoiceLinesResponse</code></summary>
|
|
2343
2415
|
<dl>
|
|
2344
2416
|
<dd>
|
|
2345
2417
|
|
|
@@ -2351,7 +2423,7 @@ await client.credits.listCreditCurrencies();
|
|
|
2351
2423
|
<dl>
|
|
2352
2424
|
<dd>
|
|
2353
2425
|
|
|
2354
|
-
Get
|
|
2426
|
+
Get the invoice lines for an invoice by ID
|
|
2355
2427
|
</dd>
|
|
2356
2428
|
</dl>
|
|
2357
2429
|
</dd>
|
|
@@ -2366,7 +2438,9 @@ Get a list of checkouts for the organization
|
|
|
2366
2438
|
<dd>
|
|
2367
2439
|
|
|
2368
2440
|
```typescript
|
|
2369
|
-
await client.
|
|
2441
|
+
await client.invoices.getInvoiceLines({
|
|
2442
|
+
id: "id"
|
|
2443
|
+
});
|
|
2370
2444
|
|
|
2371
2445
|
```
|
|
2372
2446
|
</dd>
|
|
@@ -2382,7 +2456,7 @@ await client.checkouts.listCheckouts();
|
|
|
2382
2456
|
<dl>
|
|
2383
2457
|
<dd>
|
|
2384
2458
|
|
|
2385
|
-
**request:** `Paid.
|
|
2459
|
+
**request:** `Paid.GetInvoiceLinesRequest`
|
|
2386
2460
|
|
|
2387
2461
|
</dd>
|
|
2388
2462
|
</dl>
|
|
@@ -2390,7 +2464,7 @@ await client.checkouts.listCheckouts();
|
|
|
2390
2464
|
<dl>
|
|
2391
2465
|
<dd>
|
|
2392
2466
|
|
|
2393
|
-
**requestOptions:** `
|
|
2467
|
+
**requestOptions:** `Invoices.RequestOptions`
|
|
2394
2468
|
|
|
2395
2469
|
</dd>
|
|
2396
2470
|
</dl>
|
|
@@ -2402,7 +2476,8 @@ await client.checkouts.listCheckouts();
|
|
|
2402
2476
|
</dl>
|
|
2403
2477
|
</details>
|
|
2404
2478
|
|
|
2405
|
-
|
|
2479
|
+
## Signals
|
|
2480
|
+
<details><summary><code>client.signals.<a href="/src/api/resources/signals/client/Client.ts">createSignals</a>({ ...params }) -> Paid.BulkSignalsResponse</code></summary>
|
|
2406
2481
|
<dl>
|
|
2407
2482
|
<dd>
|
|
2408
2483
|
|
|
@@ -2414,7 +2489,7 @@ await client.checkouts.listCheckouts();
|
|
|
2414
2489
|
<dl>
|
|
2415
2490
|
<dd>
|
|
2416
2491
|
|
|
2417
|
-
|
|
2492
|
+
Create multiple signals (usage events) in a single request. Each signal must include a customer attribution (either customerId or externalCustomerId) and a product attribution (either productId or externalProductId).
|
|
2418
2493
|
</dd>
|
|
2419
2494
|
</dl>
|
|
2420
2495
|
</dd>
|
|
@@ -2429,11 +2504,13 @@ Creates a checkout link that generates a URL for a customer to complete a purcha
|
|
|
2429
2504
|
<dd>
|
|
2430
2505
|
|
|
2431
2506
|
```typescript
|
|
2432
|
-
await client.
|
|
2433
|
-
|
|
2434
|
-
|
|
2435
|
-
|
|
2436
|
-
|
|
2507
|
+
await client.signals.createSignals({
|
|
2508
|
+
signals: [{
|
|
2509
|
+
eventName: "eventName",
|
|
2510
|
+
customer: {
|
|
2511
|
+
customerId: "customerId"
|
|
2512
|
+
}
|
|
2513
|
+
}]
|
|
2437
2514
|
});
|
|
2438
2515
|
|
|
2439
2516
|
```
|
|
@@ -2450,7 +2527,7 @@ await client.checkouts.createCheckout({
|
|
|
2450
2527
|
<dl>
|
|
2451
2528
|
<dd>
|
|
2452
2529
|
|
|
2453
|
-
**request:** `Paid.
|
|
2530
|
+
**request:** `Paid.BulkSignalsRequest`
|
|
2454
2531
|
|
|
2455
2532
|
</dd>
|
|
2456
2533
|
</dl>
|
|
@@ -2458,7 +2535,7 @@ await client.checkouts.createCheckout({
|
|
|
2458
2535
|
<dl>
|
|
2459
2536
|
<dd>
|
|
2460
2537
|
|
|
2461
|
-
**requestOptions:** `
|
|
2538
|
+
**requestOptions:** `Signals.RequestOptions`
|
|
2462
2539
|
|
|
2463
2540
|
</dd>
|
|
2464
2541
|
</dl>
|
|
@@ -2470,7 +2547,8 @@ await client.checkouts.createCheckout({
|
|
|
2470
2547
|
</dl>
|
|
2471
2548
|
</details>
|
|
2472
2549
|
|
|
2473
|
-
|
|
2550
|
+
## Credits
|
|
2551
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">listCreditCurrencies</a>() -> Paid.CreditCurrencyListResponse</code></summary>
|
|
2474
2552
|
<dl>
|
|
2475
2553
|
<dd>
|
|
2476
2554
|
|
|
@@ -2482,7 +2560,7 @@ await client.checkouts.createCheckout({
|
|
|
2482
2560
|
<dl>
|
|
2483
2561
|
<dd>
|
|
2484
2562
|
|
|
2485
|
-
|
|
2563
|
+
List credit currencies for the organization
|
|
2486
2564
|
</dd>
|
|
2487
2565
|
</dl>
|
|
2488
2566
|
</dd>
|
|
@@ -2497,9 +2575,7 @@ Get a checkout by ID
|
|
|
2497
2575
|
<dd>
|
|
2498
2576
|
|
|
2499
2577
|
```typescript
|
|
2500
|
-
await client.
|
|
2501
|
-
id: "id"
|
|
2502
|
-
});
|
|
2578
|
+
await client.credits.listCreditCurrencies();
|
|
2503
2579
|
|
|
2504
2580
|
```
|
|
2505
2581
|
</dd>
|
|
@@ -2515,15 +2591,7 @@ await client.checkouts.getCheckout({
|
|
|
2515
2591
|
<dl>
|
|
2516
2592
|
<dd>
|
|
2517
2593
|
|
|
2518
|
-
**
|
|
2519
|
-
|
|
2520
|
-
</dd>
|
|
2521
|
-
</dl>
|
|
2522
|
-
|
|
2523
|
-
<dl>
|
|
2524
|
-
<dd>
|
|
2525
|
-
|
|
2526
|
-
**requestOptions:** `Checkouts.RequestOptions`
|
|
2594
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
2527
2595
|
|
|
2528
2596
|
</dd>
|
|
2529
2597
|
</dl>
|
|
@@ -2535,7 +2603,8 @@ await client.checkouts.getCheckout({
|
|
|
2535
2603
|
</dl>
|
|
2536
2604
|
</details>
|
|
2537
2605
|
|
|
2538
|
-
|
|
2606
|
+
## Checkouts
|
|
2607
|
+
<details><summary><code>client.checkouts.<a href="/src/api/resources/checkouts/client/Client.ts">listCheckouts</a>({ ...params }) -> Paid.CheckoutListResponse</code></summary>
|
|
2539
2608
|
<dl>
|
|
2540
2609
|
<dd>
|
|
2541
2610
|
|
|
@@ -2547,7 +2616,7 @@ await client.checkouts.getCheckout({
|
|
|
2547
2616
|
<dl>
|
|
2548
2617
|
<dd>
|
|
2549
2618
|
|
|
2550
|
-
|
|
2619
|
+
Get a list of checkouts for the organization
|
|
2551
2620
|
</dd>
|
|
2552
2621
|
</dl>
|
|
2553
2622
|
</dd>
|
|
@@ -2562,9 +2631,7 @@ Archive a checkout by ID
|
|
|
2562
2631
|
<dd>
|
|
2563
2632
|
|
|
2564
2633
|
```typescript
|
|
2565
|
-
await client.checkouts.
|
|
2566
|
-
id: "id"
|
|
2567
|
-
});
|
|
2634
|
+
await client.checkouts.listCheckouts();
|
|
2568
2635
|
|
|
2569
2636
|
```
|
|
2570
2637
|
</dd>
|
|
@@ -2580,7 +2647,7 @@ await client.checkouts.archiveCheckout({
|
|
|
2580
2647
|
<dl>
|
|
2581
2648
|
<dd>
|
|
2582
2649
|
|
|
2583
|
-
**request:** `Paid.
|
|
2650
|
+
**request:** `Paid.ListCheckoutsRequest`
|
|
2584
2651
|
|
|
2585
2652
|
</dd>
|
|
2586
2653
|
</dl>
|
|
@@ -2600,8 +2667,7 @@ await client.checkouts.archiveCheckout({
|
|
|
2600
2667
|
</dl>
|
|
2601
2668
|
</details>
|
|
2602
2669
|
|
|
2603
|
-
|
|
2604
|
-
<details><summary><code>client.customerPortals.<a href="/src/api/resources/customerPortals/client/Client.ts">createCustomerPortal</a>({ ...params }) -> Paid.CustomerPortal</code></summary>
|
|
2670
|
+
<details><summary><code>client.checkouts.<a href="/src/api/resources/checkouts/client/Client.ts">createCheckout</a>({ ...params }) -> Paid.Checkout</code></summary>
|
|
2605
2671
|
<dl>
|
|
2606
2672
|
<dd>
|
|
2607
2673
|
|
|
@@ -2613,7 +2679,7 @@ await client.checkouts.archiveCheckout({
|
|
|
2613
2679
|
<dl>
|
|
2614
2680
|
<dd>
|
|
2615
2681
|
|
|
2616
|
-
Creates a
|
|
2682
|
+
Creates a checkout link that generates a URL for a customer to complete a purchase
|
|
2617
2683
|
</dd>
|
|
2618
2684
|
</dl>
|
|
2619
2685
|
</dd>
|
|
@@ -2628,7 +2694,12 @@ Creates a portal session for the customer. Returns a short-lived URL to the cust
|
|
|
2628
2694
|
<dd>
|
|
2629
2695
|
|
|
2630
2696
|
```typescript
|
|
2631
|
-
await client.
|
|
2697
|
+
await client.checkouts.createCheckout({
|
|
2698
|
+
products: [{
|
|
2699
|
+
id: "id"
|
|
2700
|
+
}],
|
|
2701
|
+
successUrl: "successUrl"
|
|
2702
|
+
});
|
|
2632
2703
|
|
|
2633
2704
|
```
|
|
2634
2705
|
</dd>
|
|
@@ -2644,7 +2715,7 @@ await client.customerPortals.createCustomerPortal();
|
|
|
2644
2715
|
<dl>
|
|
2645
2716
|
<dd>
|
|
2646
2717
|
|
|
2647
|
-
**request:** `Paid.
|
|
2718
|
+
**request:** `Paid.CreateCheckoutRequest`
|
|
2648
2719
|
|
|
2649
2720
|
</dd>
|
|
2650
2721
|
</dl>
|
|
@@ -2652,7 +2723,7 @@ await client.customerPortals.createCustomerPortal();
|
|
|
2652
2723
|
<dl>
|
|
2653
2724
|
<dd>
|
|
2654
2725
|
|
|
2655
|
-
**requestOptions:** `
|
|
2726
|
+
**requestOptions:** `Checkouts.RequestOptions`
|
|
2656
2727
|
|
|
2657
2728
|
</dd>
|
|
2658
2729
|
</dl>
|
|
@@ -2664,8 +2735,7 @@ await client.customerPortals.createCustomerPortal();
|
|
|
2664
2735
|
</dl>
|
|
2665
2736
|
</details>
|
|
2666
2737
|
|
|
2667
|
-
|
|
2668
|
-
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">listValueReceipts</a>({ ...params }) -> Paid.ValueReceiptListResponse</code></summary>
|
|
2738
|
+
<details><summary><code>client.checkouts.<a href="/src/api/resources/checkouts/client/Client.ts">getCheckout</a>({ ...params }) -> Paid.CheckoutDetails</code></summary>
|
|
2669
2739
|
<dl>
|
|
2670
2740
|
<dd>
|
|
2671
2741
|
|
|
@@ -2677,7 +2747,7 @@ await client.customerPortals.createCustomerPortal();
|
|
|
2677
2747
|
<dl>
|
|
2678
2748
|
<dd>
|
|
2679
2749
|
|
|
2680
|
-
|
|
2750
|
+
Get a checkout by ID
|
|
2681
2751
|
</dd>
|
|
2682
2752
|
</dl>
|
|
2683
2753
|
</dd>
|
|
@@ -2692,7 +2762,9 @@ List value receipts for the organization
|
|
|
2692
2762
|
<dd>
|
|
2693
2763
|
|
|
2694
2764
|
```typescript
|
|
2695
|
-
await client.
|
|
2765
|
+
await client.checkouts.getCheckout({
|
|
2766
|
+
id: "id"
|
|
2767
|
+
});
|
|
2696
2768
|
|
|
2697
2769
|
```
|
|
2698
2770
|
</dd>
|
|
@@ -2708,7 +2780,7 @@ await client.valueReceipts.listValueReceipts();
|
|
|
2708
2780
|
<dl>
|
|
2709
2781
|
<dd>
|
|
2710
2782
|
|
|
2711
|
-
**request:** `Paid.
|
|
2783
|
+
**request:** `Paid.GetCheckoutRequest`
|
|
2712
2784
|
|
|
2713
2785
|
</dd>
|
|
2714
2786
|
</dl>
|
|
@@ -2716,7 +2788,7 @@ await client.valueReceipts.listValueReceipts();
|
|
|
2716
2788
|
<dl>
|
|
2717
2789
|
<dd>
|
|
2718
2790
|
|
|
2719
|
-
**requestOptions:** `
|
|
2791
|
+
**requestOptions:** `Checkouts.RequestOptions`
|
|
2720
2792
|
|
|
2721
2793
|
</dd>
|
|
2722
2794
|
</dl>
|
|
@@ -2728,7 +2800,7 @@ await client.valueReceipts.listValueReceipts();
|
|
|
2728
2800
|
</dl>
|
|
2729
2801
|
</details>
|
|
2730
2802
|
|
|
2731
|
-
<details><summary><code>client.
|
|
2803
|
+
<details><summary><code>client.checkouts.<a href="/src/api/resources/checkouts/client/Client.ts">archiveCheckout</a>({ ...params }) -> Paid.EmptyResponse</code></summary>
|
|
2732
2804
|
<dl>
|
|
2733
2805
|
<dd>
|
|
2734
2806
|
|
|
@@ -2740,7 +2812,7 @@ await client.valueReceipts.listValueReceipts();
|
|
|
2740
2812
|
<dl>
|
|
2741
2813
|
<dd>
|
|
2742
2814
|
|
|
2743
|
-
|
|
2815
|
+
Archive a checkout by ID
|
|
2744
2816
|
</dd>
|
|
2745
2817
|
</dl>
|
|
2746
2818
|
</dd>
|
|
@@ -2755,7 +2827,7 @@ Get a value receipt by ID, including its publish/share state.
|
|
|
2755
2827
|
<dd>
|
|
2756
2828
|
|
|
2757
2829
|
```typescript
|
|
2758
|
-
await client.
|
|
2830
|
+
await client.checkouts.archiveCheckout({
|
|
2759
2831
|
id: "id"
|
|
2760
2832
|
});
|
|
2761
2833
|
|
|
@@ -2773,7 +2845,7 @@ await client.valueReceipts.getValueReceiptById({
|
|
|
2773
2845
|
<dl>
|
|
2774
2846
|
<dd>
|
|
2775
2847
|
|
|
2776
|
-
**request:** `Paid.
|
|
2848
|
+
**request:** `Paid.ArchiveCheckoutRequest`
|
|
2777
2849
|
|
|
2778
2850
|
</dd>
|
|
2779
2851
|
</dl>
|
|
@@ -2781,7 +2853,7 @@ await client.valueReceipts.getValueReceiptById({
|
|
|
2781
2853
|
<dl>
|
|
2782
2854
|
<dd>
|
|
2783
2855
|
|
|
2784
|
-
**requestOptions:** `
|
|
2856
|
+
**requestOptions:** `Checkouts.RequestOptions`
|
|
2785
2857
|
|
|
2786
2858
|
</dd>
|
|
2787
2859
|
</dl>
|
|
@@ -2793,7 +2865,8 @@ await client.valueReceipts.getValueReceiptById({
|
|
|
2793
2865
|
</dl>
|
|
2794
2866
|
</details>
|
|
2795
2867
|
|
|
2796
|
-
|
|
2868
|
+
## CustomerPortals
|
|
2869
|
+
<details><summary><code>client.customerPortals.<a href="/src/api/resources/customerPortals/client/Client.ts">createCustomerPortal</a>({ ...params }) -> Paid.CustomerPortal</code></summary>
|
|
2797
2870
|
<dl>
|
|
2798
2871
|
<dd>
|
|
2799
2872
|
|
|
@@ -2805,7 +2878,7 @@ await client.valueReceipts.getValueReceiptById({
|
|
|
2805
2878
|
<dl>
|
|
2806
2879
|
<dd>
|
|
2807
2880
|
|
|
2808
|
-
|
|
2881
|
+
Creates a portal session for the customer. Returns a short-lived URL to the customer portal.
|
|
2809
2882
|
</dd>
|
|
2810
2883
|
</dl>
|
|
2811
2884
|
</dd>
|
|
@@ -2820,9 +2893,7 @@ Make a value receipt publicly accessible via URL.
|
|
|
2820
2893
|
<dd>
|
|
2821
2894
|
|
|
2822
2895
|
```typescript
|
|
2823
|
-
await client.
|
|
2824
|
-
id: "id"
|
|
2825
|
-
});
|
|
2896
|
+
await client.customerPortals.createCustomerPortal();
|
|
2826
2897
|
|
|
2827
2898
|
```
|
|
2828
2899
|
</dd>
|
|
@@ -2838,7 +2909,7 @@ await client.valueReceipts.publishValueReceipt({
|
|
|
2838
2909
|
<dl>
|
|
2839
2910
|
<dd>
|
|
2840
2911
|
|
|
2841
|
-
**request:** `Paid.
|
|
2912
|
+
**request:** `Paid.CreateCustomerPortalRequest`
|
|
2842
2913
|
|
|
2843
2914
|
</dd>
|
|
2844
2915
|
</dl>
|
|
@@ -2846,7 +2917,7 @@ await client.valueReceipts.publishValueReceipt({
|
|
|
2846
2917
|
<dl>
|
|
2847
2918
|
<dd>
|
|
2848
2919
|
|
|
2849
|
-
**requestOptions:** `
|
|
2920
|
+
**requestOptions:** `CustomerPortals.RequestOptions`
|
|
2850
2921
|
|
|
2851
2922
|
</dd>
|
|
2852
2923
|
</dl>
|
|
@@ -2858,7 +2929,8 @@ await client.valueReceipts.publishValueReceipt({
|
|
|
2858
2929
|
</dl>
|
|
2859
2930
|
</details>
|
|
2860
2931
|
|
|
2861
|
-
|
|
2932
|
+
## ValueReceipts
|
|
2933
|
+
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">syncValueReceipt</a>({ ...params }) -> Paid.ValueReceiptSyncResponse</code></summary>
|
|
2862
2934
|
<dl>
|
|
2863
2935
|
<dd>
|
|
2864
2936
|
|
|
@@ -2870,7 +2942,7 @@ await client.valueReceipts.publishValueReceipt({
|
|
|
2870
2942
|
<dl>
|
|
2871
2943
|
<dd>
|
|
2872
2944
|
|
|
2873
|
-
|
|
2945
|
+
Find or create a value receipt by natural key (customer + product/order + dates), then populate it with current data inline. Returns the ID, status, and public URL. Posted (sealed) VRs are returned as-is without re-populating.
|
|
2874
2946
|
</dd>
|
|
2875
2947
|
</dl>
|
|
2876
2948
|
</dd>
|
|
@@ -2885,8 +2957,9 @@ Revoke public access to a value receipt.
|
|
|
2885
2957
|
<dd>
|
|
2886
2958
|
|
|
2887
2959
|
```typescript
|
|
2888
|
-
await client.valueReceipts.
|
|
2889
|
-
|
|
2960
|
+
await client.valueReceipts.syncValueReceipt({
|
|
2961
|
+
startDate: "2024-01-15T09:30:00Z",
|
|
2962
|
+
endDate: "2024-01-15T09:30:00Z"
|
|
2890
2963
|
});
|
|
2891
2964
|
|
|
2892
2965
|
```
|
|
@@ -2903,7 +2976,7 @@ await client.valueReceipts.unpublishValueReceipt({
|
|
|
2903
2976
|
<dl>
|
|
2904
2977
|
<dd>
|
|
2905
2978
|
|
|
2906
|
-
**request:** `Paid.
|
|
2979
|
+
**request:** `Paid.SyncValueReceiptRequest`
|
|
2907
2980
|
|
|
2908
2981
|
</dd>
|
|
2909
2982
|
</dl>
|
|
@@ -2919,6 +2992,987 @@ await client.valueReceipts.unpublishValueReceipt({
|
|
|
2919
2992
|
</dl>
|
|
2920
2993
|
|
|
2921
2994
|
|
|
2995
|
+
</dd>
|
|
2996
|
+
</dl>
|
|
2997
|
+
</details>
|
|
2998
|
+
|
|
2999
|
+
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">listValueReceipts</a>({ ...params }) -> Paid.ValueReceiptListResponse</code></summary>
|
|
3000
|
+
<dl>
|
|
3001
|
+
<dd>
|
|
3002
|
+
|
|
3003
|
+
#### 📝 Description
|
|
3004
|
+
|
|
3005
|
+
<dl>
|
|
3006
|
+
<dd>
|
|
3007
|
+
|
|
3008
|
+
<dl>
|
|
3009
|
+
<dd>
|
|
3010
|
+
|
|
3011
|
+
List value receipts for the organization
|
|
3012
|
+
</dd>
|
|
3013
|
+
</dl>
|
|
3014
|
+
</dd>
|
|
3015
|
+
</dl>
|
|
3016
|
+
|
|
3017
|
+
#### 🔌 Usage
|
|
3018
|
+
|
|
3019
|
+
<dl>
|
|
3020
|
+
<dd>
|
|
3021
|
+
|
|
3022
|
+
<dl>
|
|
3023
|
+
<dd>
|
|
3024
|
+
|
|
3025
|
+
```typescript
|
|
3026
|
+
await client.valueReceipts.listValueReceipts();
|
|
3027
|
+
|
|
3028
|
+
```
|
|
3029
|
+
</dd>
|
|
3030
|
+
</dl>
|
|
3031
|
+
</dd>
|
|
3032
|
+
</dl>
|
|
3033
|
+
|
|
3034
|
+
#### ⚙️ Parameters
|
|
3035
|
+
|
|
3036
|
+
<dl>
|
|
3037
|
+
<dd>
|
|
3038
|
+
|
|
3039
|
+
<dl>
|
|
3040
|
+
<dd>
|
|
3041
|
+
|
|
3042
|
+
**request:** `Paid.ListValueReceiptsRequest`
|
|
3043
|
+
|
|
3044
|
+
</dd>
|
|
3045
|
+
</dl>
|
|
3046
|
+
|
|
3047
|
+
<dl>
|
|
3048
|
+
<dd>
|
|
3049
|
+
|
|
3050
|
+
**requestOptions:** `ValueReceipts.RequestOptions`
|
|
3051
|
+
|
|
3052
|
+
</dd>
|
|
3053
|
+
</dl>
|
|
3054
|
+
</dd>
|
|
3055
|
+
</dl>
|
|
3056
|
+
|
|
3057
|
+
|
|
3058
|
+
</dd>
|
|
3059
|
+
</dl>
|
|
3060
|
+
</details>
|
|
3061
|
+
|
|
3062
|
+
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">getValueReceiptById</a>({ ...params }) -> Paid.ValueReceiptDetail</code></summary>
|
|
3063
|
+
<dl>
|
|
3064
|
+
<dd>
|
|
3065
|
+
|
|
3066
|
+
#### 📝 Description
|
|
3067
|
+
|
|
3068
|
+
<dl>
|
|
3069
|
+
<dd>
|
|
3070
|
+
|
|
3071
|
+
<dl>
|
|
3072
|
+
<dd>
|
|
3073
|
+
|
|
3074
|
+
Get a value receipt by ID, including its publish/share state.
|
|
3075
|
+
</dd>
|
|
3076
|
+
</dl>
|
|
3077
|
+
</dd>
|
|
3078
|
+
</dl>
|
|
3079
|
+
|
|
3080
|
+
#### 🔌 Usage
|
|
3081
|
+
|
|
3082
|
+
<dl>
|
|
3083
|
+
<dd>
|
|
3084
|
+
|
|
3085
|
+
<dl>
|
|
3086
|
+
<dd>
|
|
3087
|
+
|
|
3088
|
+
```typescript
|
|
3089
|
+
await client.valueReceipts.getValueReceiptById({
|
|
3090
|
+
id: "id"
|
|
3091
|
+
});
|
|
3092
|
+
|
|
3093
|
+
```
|
|
3094
|
+
</dd>
|
|
3095
|
+
</dl>
|
|
3096
|
+
</dd>
|
|
3097
|
+
</dl>
|
|
3098
|
+
|
|
3099
|
+
#### ⚙️ Parameters
|
|
3100
|
+
|
|
3101
|
+
<dl>
|
|
3102
|
+
<dd>
|
|
3103
|
+
|
|
3104
|
+
<dl>
|
|
3105
|
+
<dd>
|
|
3106
|
+
|
|
3107
|
+
**request:** `Paid.GetValueReceiptByIdRequest`
|
|
3108
|
+
|
|
3109
|
+
</dd>
|
|
3110
|
+
</dl>
|
|
3111
|
+
|
|
3112
|
+
<dl>
|
|
3113
|
+
<dd>
|
|
3114
|
+
|
|
3115
|
+
**requestOptions:** `ValueReceipts.RequestOptions`
|
|
3116
|
+
|
|
3117
|
+
</dd>
|
|
3118
|
+
</dl>
|
|
3119
|
+
</dd>
|
|
3120
|
+
</dl>
|
|
3121
|
+
|
|
3122
|
+
|
|
3123
|
+
</dd>
|
|
3124
|
+
</dl>
|
|
3125
|
+
</details>
|
|
3126
|
+
|
|
3127
|
+
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">refreshValueReceipt</a>({ ...params }) -> Paid.ValueReceiptSyncResponse</code></summary>
|
|
3128
|
+
<dl>
|
|
3129
|
+
<dd>
|
|
3130
|
+
|
|
3131
|
+
#### 📝 Description
|
|
3132
|
+
|
|
3133
|
+
<dl>
|
|
3134
|
+
<dd>
|
|
3135
|
+
|
|
3136
|
+
<dl>
|
|
3137
|
+
<dd>
|
|
3138
|
+
|
|
3139
|
+
Re-populate an existing draft value receipt with current data inline. Returns the slim sync response. Sealed VRs cannot be refreshed.
|
|
3140
|
+
</dd>
|
|
3141
|
+
</dl>
|
|
3142
|
+
</dd>
|
|
3143
|
+
</dl>
|
|
3144
|
+
|
|
3145
|
+
#### 🔌 Usage
|
|
3146
|
+
|
|
3147
|
+
<dl>
|
|
3148
|
+
<dd>
|
|
3149
|
+
|
|
3150
|
+
<dl>
|
|
3151
|
+
<dd>
|
|
3152
|
+
|
|
3153
|
+
```typescript
|
|
3154
|
+
await client.valueReceipts.refreshValueReceipt({
|
|
3155
|
+
id: "id"
|
|
3156
|
+
});
|
|
3157
|
+
|
|
3158
|
+
```
|
|
3159
|
+
</dd>
|
|
3160
|
+
</dl>
|
|
3161
|
+
</dd>
|
|
3162
|
+
</dl>
|
|
3163
|
+
|
|
3164
|
+
#### ⚙️ Parameters
|
|
3165
|
+
|
|
3166
|
+
<dl>
|
|
3167
|
+
<dd>
|
|
3168
|
+
|
|
3169
|
+
<dl>
|
|
3170
|
+
<dd>
|
|
3171
|
+
|
|
3172
|
+
**request:** `Paid.RefreshValueReceiptRequest`
|
|
3173
|
+
|
|
3174
|
+
</dd>
|
|
3175
|
+
</dl>
|
|
3176
|
+
|
|
3177
|
+
<dl>
|
|
3178
|
+
<dd>
|
|
3179
|
+
|
|
3180
|
+
**requestOptions:** `ValueReceipts.RequestOptions`
|
|
3181
|
+
|
|
3182
|
+
</dd>
|
|
3183
|
+
</dl>
|
|
3184
|
+
</dd>
|
|
3185
|
+
</dl>
|
|
3186
|
+
|
|
3187
|
+
|
|
3188
|
+
</dd>
|
|
3189
|
+
</dl>
|
|
3190
|
+
</details>
|
|
3191
|
+
|
|
3192
|
+
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">sealValueReceipt</a>({ ...params }) -> Paid.SuccessResponse</code></summary>
|
|
3193
|
+
<dl>
|
|
3194
|
+
<dd>
|
|
3195
|
+
|
|
3196
|
+
#### 📝 Description
|
|
3197
|
+
|
|
3198
|
+
<dl>
|
|
3199
|
+
<dd>
|
|
3200
|
+
|
|
3201
|
+
<dl>
|
|
3202
|
+
<dd>
|
|
3203
|
+
|
|
3204
|
+
Transition a draft value receipt to sealed (posted) status. Sealed VRs are immutable — they cannot be updated or re-populated.
|
|
3205
|
+
</dd>
|
|
3206
|
+
</dl>
|
|
3207
|
+
</dd>
|
|
3208
|
+
</dl>
|
|
3209
|
+
|
|
3210
|
+
#### 🔌 Usage
|
|
3211
|
+
|
|
3212
|
+
<dl>
|
|
3213
|
+
<dd>
|
|
3214
|
+
|
|
3215
|
+
<dl>
|
|
3216
|
+
<dd>
|
|
3217
|
+
|
|
3218
|
+
```typescript
|
|
3219
|
+
await client.valueReceipts.sealValueReceipt({
|
|
3220
|
+
id: "id"
|
|
3221
|
+
});
|
|
3222
|
+
|
|
3223
|
+
```
|
|
3224
|
+
</dd>
|
|
3225
|
+
</dl>
|
|
3226
|
+
</dd>
|
|
3227
|
+
</dl>
|
|
3228
|
+
|
|
3229
|
+
#### ⚙️ Parameters
|
|
3230
|
+
|
|
3231
|
+
<dl>
|
|
3232
|
+
<dd>
|
|
3233
|
+
|
|
3234
|
+
<dl>
|
|
3235
|
+
<dd>
|
|
3236
|
+
|
|
3237
|
+
**request:** `Paid.SealValueReceiptRequest`
|
|
3238
|
+
|
|
3239
|
+
</dd>
|
|
3240
|
+
</dl>
|
|
3241
|
+
|
|
3242
|
+
<dl>
|
|
3243
|
+
<dd>
|
|
3244
|
+
|
|
3245
|
+
**requestOptions:** `ValueReceipts.RequestOptions`
|
|
3246
|
+
|
|
3247
|
+
</dd>
|
|
3248
|
+
</dl>
|
|
3249
|
+
</dd>
|
|
3250
|
+
</dl>
|
|
3251
|
+
|
|
3252
|
+
|
|
3253
|
+
</dd>
|
|
3254
|
+
</dl>
|
|
3255
|
+
</details>
|
|
3256
|
+
|
|
3257
|
+
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">archiveValueReceipt</a>({ ...params }) -> Paid.SuccessResponse</code></summary>
|
|
3258
|
+
<dl>
|
|
3259
|
+
<dd>
|
|
3260
|
+
|
|
3261
|
+
#### 📝 Description
|
|
3262
|
+
|
|
3263
|
+
<dl>
|
|
3264
|
+
<dd>
|
|
3265
|
+
|
|
3266
|
+
<dl>
|
|
3267
|
+
<dd>
|
|
3268
|
+
|
|
3269
|
+
Soft-archive a value receipt. Archived VRs are hidden from list by default.
|
|
3270
|
+
</dd>
|
|
3271
|
+
</dl>
|
|
3272
|
+
</dd>
|
|
3273
|
+
</dl>
|
|
3274
|
+
|
|
3275
|
+
#### 🔌 Usage
|
|
3276
|
+
|
|
3277
|
+
<dl>
|
|
3278
|
+
<dd>
|
|
3279
|
+
|
|
3280
|
+
<dl>
|
|
3281
|
+
<dd>
|
|
3282
|
+
|
|
3283
|
+
```typescript
|
|
3284
|
+
await client.valueReceipts.archiveValueReceipt({
|
|
3285
|
+
id: "id"
|
|
3286
|
+
});
|
|
3287
|
+
|
|
3288
|
+
```
|
|
3289
|
+
</dd>
|
|
3290
|
+
</dl>
|
|
3291
|
+
</dd>
|
|
3292
|
+
</dl>
|
|
3293
|
+
|
|
3294
|
+
#### ⚙️ Parameters
|
|
3295
|
+
|
|
3296
|
+
<dl>
|
|
3297
|
+
<dd>
|
|
3298
|
+
|
|
3299
|
+
<dl>
|
|
3300
|
+
<dd>
|
|
3301
|
+
|
|
3302
|
+
**request:** `Paid.ArchiveValueReceiptRequest`
|
|
3303
|
+
|
|
3304
|
+
</dd>
|
|
3305
|
+
</dl>
|
|
3306
|
+
|
|
3307
|
+
<dl>
|
|
3308
|
+
<dd>
|
|
3309
|
+
|
|
3310
|
+
**requestOptions:** `ValueReceipts.RequestOptions`
|
|
3311
|
+
|
|
3312
|
+
</dd>
|
|
3313
|
+
</dl>
|
|
3314
|
+
</dd>
|
|
3315
|
+
</dl>
|
|
3316
|
+
|
|
3317
|
+
|
|
3318
|
+
</dd>
|
|
3319
|
+
</dl>
|
|
3320
|
+
</details>
|
|
3321
|
+
|
|
3322
|
+
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">unarchiveValueReceipt</a>({ ...params }) -> Paid.SuccessResponse</code></summary>
|
|
3323
|
+
<dl>
|
|
3324
|
+
<dd>
|
|
3325
|
+
|
|
3326
|
+
#### 📝 Description
|
|
3327
|
+
|
|
3328
|
+
<dl>
|
|
3329
|
+
<dd>
|
|
3330
|
+
|
|
3331
|
+
<dl>
|
|
3332
|
+
<dd>
|
|
3333
|
+
|
|
3334
|
+
Restore an archived value receipt.
|
|
3335
|
+
</dd>
|
|
3336
|
+
</dl>
|
|
3337
|
+
</dd>
|
|
3338
|
+
</dl>
|
|
3339
|
+
|
|
3340
|
+
#### 🔌 Usage
|
|
3341
|
+
|
|
3342
|
+
<dl>
|
|
3343
|
+
<dd>
|
|
3344
|
+
|
|
3345
|
+
<dl>
|
|
3346
|
+
<dd>
|
|
3347
|
+
|
|
3348
|
+
```typescript
|
|
3349
|
+
await client.valueReceipts.unarchiveValueReceipt({
|
|
3350
|
+
id: "id"
|
|
3351
|
+
});
|
|
3352
|
+
|
|
3353
|
+
```
|
|
3354
|
+
</dd>
|
|
3355
|
+
</dl>
|
|
3356
|
+
</dd>
|
|
3357
|
+
</dl>
|
|
3358
|
+
|
|
3359
|
+
#### ⚙️ Parameters
|
|
3360
|
+
|
|
3361
|
+
<dl>
|
|
3362
|
+
<dd>
|
|
3363
|
+
|
|
3364
|
+
<dl>
|
|
3365
|
+
<dd>
|
|
3366
|
+
|
|
3367
|
+
**request:** `Paid.UnarchiveValueReceiptRequest`
|
|
3368
|
+
|
|
3369
|
+
</dd>
|
|
3370
|
+
</dl>
|
|
3371
|
+
|
|
3372
|
+
<dl>
|
|
3373
|
+
<dd>
|
|
3374
|
+
|
|
3375
|
+
**requestOptions:** `ValueReceipts.RequestOptions`
|
|
3376
|
+
|
|
3377
|
+
</dd>
|
|
3378
|
+
</dl>
|
|
3379
|
+
</dd>
|
|
3380
|
+
</dl>
|
|
3381
|
+
|
|
3382
|
+
|
|
3383
|
+
</dd>
|
|
3384
|
+
</dl>
|
|
3385
|
+
</details>
|
|
3386
|
+
|
|
3387
|
+
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">publishValueReceipt</a>({ ...params }) -> Paid.ValueReceiptDetail</code></summary>
|
|
3388
|
+
<dl>
|
|
3389
|
+
<dd>
|
|
3390
|
+
|
|
3391
|
+
#### 📝 Description
|
|
3392
|
+
|
|
3393
|
+
<dl>
|
|
3394
|
+
<dd>
|
|
3395
|
+
|
|
3396
|
+
<dl>
|
|
3397
|
+
<dd>
|
|
3398
|
+
|
|
3399
|
+
Make a value receipt publicly accessible via URL.
|
|
3400
|
+
</dd>
|
|
3401
|
+
</dl>
|
|
3402
|
+
</dd>
|
|
3403
|
+
</dl>
|
|
3404
|
+
|
|
3405
|
+
#### 🔌 Usage
|
|
3406
|
+
|
|
3407
|
+
<dl>
|
|
3408
|
+
<dd>
|
|
3409
|
+
|
|
3410
|
+
<dl>
|
|
3411
|
+
<dd>
|
|
3412
|
+
|
|
3413
|
+
```typescript
|
|
3414
|
+
await client.valueReceipts.publishValueReceipt({
|
|
3415
|
+
id: "id"
|
|
3416
|
+
});
|
|
3417
|
+
|
|
3418
|
+
```
|
|
3419
|
+
</dd>
|
|
3420
|
+
</dl>
|
|
3421
|
+
</dd>
|
|
3422
|
+
</dl>
|
|
3423
|
+
|
|
3424
|
+
#### ⚙️ Parameters
|
|
3425
|
+
|
|
3426
|
+
<dl>
|
|
3427
|
+
<dd>
|
|
3428
|
+
|
|
3429
|
+
<dl>
|
|
3430
|
+
<dd>
|
|
3431
|
+
|
|
3432
|
+
**request:** `Paid.PublishValueReceiptBody`
|
|
3433
|
+
|
|
3434
|
+
</dd>
|
|
3435
|
+
</dl>
|
|
3436
|
+
|
|
3437
|
+
<dl>
|
|
3438
|
+
<dd>
|
|
3439
|
+
|
|
3440
|
+
**requestOptions:** `ValueReceipts.RequestOptions`
|
|
3441
|
+
|
|
3442
|
+
</dd>
|
|
3443
|
+
</dl>
|
|
3444
|
+
</dd>
|
|
3445
|
+
</dl>
|
|
3446
|
+
|
|
3447
|
+
|
|
3448
|
+
</dd>
|
|
3449
|
+
</dl>
|
|
3450
|
+
</details>
|
|
3451
|
+
|
|
3452
|
+
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">unpublishValueReceipt</a>({ ...params }) -> Paid.ValueReceiptDetail</code></summary>
|
|
3453
|
+
<dl>
|
|
3454
|
+
<dd>
|
|
3455
|
+
|
|
3456
|
+
#### 📝 Description
|
|
3457
|
+
|
|
3458
|
+
<dl>
|
|
3459
|
+
<dd>
|
|
3460
|
+
|
|
3461
|
+
<dl>
|
|
3462
|
+
<dd>
|
|
3463
|
+
|
|
3464
|
+
Revoke public access to a value receipt.
|
|
3465
|
+
</dd>
|
|
3466
|
+
</dl>
|
|
3467
|
+
</dd>
|
|
3468
|
+
</dl>
|
|
3469
|
+
|
|
3470
|
+
#### 🔌 Usage
|
|
3471
|
+
|
|
3472
|
+
<dl>
|
|
3473
|
+
<dd>
|
|
3474
|
+
|
|
3475
|
+
<dl>
|
|
3476
|
+
<dd>
|
|
3477
|
+
|
|
3478
|
+
```typescript
|
|
3479
|
+
await client.valueReceipts.unpublishValueReceipt({
|
|
3480
|
+
id: "id"
|
|
3481
|
+
});
|
|
3482
|
+
|
|
3483
|
+
```
|
|
3484
|
+
</dd>
|
|
3485
|
+
</dl>
|
|
3486
|
+
</dd>
|
|
3487
|
+
</dl>
|
|
3488
|
+
|
|
3489
|
+
#### ⚙️ Parameters
|
|
3490
|
+
|
|
3491
|
+
<dl>
|
|
3492
|
+
<dd>
|
|
3493
|
+
|
|
3494
|
+
<dl>
|
|
3495
|
+
<dd>
|
|
3496
|
+
|
|
3497
|
+
**request:** `Paid.UnpublishValueReceiptRequest`
|
|
3498
|
+
|
|
3499
|
+
</dd>
|
|
3500
|
+
</dl>
|
|
3501
|
+
|
|
3502
|
+
<dl>
|
|
3503
|
+
<dd>
|
|
3504
|
+
|
|
3505
|
+
**requestOptions:** `ValueReceipts.RequestOptions`
|
|
3506
|
+
|
|
3507
|
+
</dd>
|
|
3508
|
+
</dl>
|
|
3509
|
+
</dd>
|
|
3510
|
+
</dl>
|
|
3511
|
+
|
|
3512
|
+
|
|
3513
|
+
</dd>
|
|
3514
|
+
</dl>
|
|
3515
|
+
</details>
|
|
3516
|
+
|
|
3517
|
+
## Webhooks
|
|
3518
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">listWebhooks</a>() -> Paid.WebhookListResponse</code></summary>
|
|
3519
|
+
<dl>
|
|
3520
|
+
<dd>
|
|
3521
|
+
|
|
3522
|
+
#### 📝 Description
|
|
3523
|
+
|
|
3524
|
+
<dl>
|
|
3525
|
+
<dd>
|
|
3526
|
+
|
|
3527
|
+
<dl>
|
|
3528
|
+
<dd>
|
|
3529
|
+
|
|
3530
|
+
List customer-facing billing webhooks for the authenticated organization.
|
|
3531
|
+
</dd>
|
|
3532
|
+
</dl>
|
|
3533
|
+
</dd>
|
|
3534
|
+
</dl>
|
|
3535
|
+
|
|
3536
|
+
#### 🔌 Usage
|
|
3537
|
+
|
|
3538
|
+
<dl>
|
|
3539
|
+
<dd>
|
|
3540
|
+
|
|
3541
|
+
<dl>
|
|
3542
|
+
<dd>
|
|
3543
|
+
|
|
3544
|
+
```typescript
|
|
3545
|
+
await client.webhooks.listWebhooks();
|
|
3546
|
+
|
|
3547
|
+
```
|
|
3548
|
+
</dd>
|
|
3549
|
+
</dl>
|
|
3550
|
+
</dd>
|
|
3551
|
+
</dl>
|
|
3552
|
+
|
|
3553
|
+
#### ⚙️ Parameters
|
|
3554
|
+
|
|
3555
|
+
<dl>
|
|
3556
|
+
<dd>
|
|
3557
|
+
|
|
3558
|
+
<dl>
|
|
3559
|
+
<dd>
|
|
3560
|
+
|
|
3561
|
+
**requestOptions:** `Webhooks.RequestOptions`
|
|
3562
|
+
|
|
3563
|
+
</dd>
|
|
3564
|
+
</dl>
|
|
3565
|
+
</dd>
|
|
3566
|
+
</dl>
|
|
3567
|
+
|
|
3568
|
+
|
|
3569
|
+
</dd>
|
|
3570
|
+
</dl>
|
|
3571
|
+
</details>
|
|
3572
|
+
|
|
3573
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">updateWebhook</a>({ ...params }) -> Paid.Webhook</code></summary>
|
|
3574
|
+
<dl>
|
|
3575
|
+
<dd>
|
|
3576
|
+
|
|
3577
|
+
#### 📝 Description
|
|
3578
|
+
|
|
3579
|
+
<dl>
|
|
3580
|
+
<dd>
|
|
3581
|
+
|
|
3582
|
+
<dl>
|
|
3583
|
+
<dd>
|
|
3584
|
+
|
|
3585
|
+
Enable or disable a webhook and configure the destination URL for the authenticated organization.
|
|
3586
|
+
</dd>
|
|
3587
|
+
</dl>
|
|
3588
|
+
</dd>
|
|
3589
|
+
</dl>
|
|
3590
|
+
|
|
3591
|
+
#### 🔌 Usage
|
|
3592
|
+
|
|
3593
|
+
<dl>
|
|
3594
|
+
<dd>
|
|
3595
|
+
|
|
3596
|
+
<dl>
|
|
3597
|
+
<dd>
|
|
3598
|
+
|
|
3599
|
+
```typescript
|
|
3600
|
+
await client.webhooks.updateWebhook({
|
|
3601
|
+
webhookName: "billing-invoice-created"
|
|
3602
|
+
});
|
|
3603
|
+
|
|
3604
|
+
```
|
|
3605
|
+
</dd>
|
|
3606
|
+
</dl>
|
|
3607
|
+
</dd>
|
|
3608
|
+
</dl>
|
|
3609
|
+
|
|
3610
|
+
#### ⚙️ Parameters
|
|
3611
|
+
|
|
3612
|
+
<dl>
|
|
3613
|
+
<dd>
|
|
3614
|
+
|
|
3615
|
+
<dl>
|
|
3616
|
+
<dd>
|
|
3617
|
+
|
|
3618
|
+
**request:** `Paid.UpdateWebhookRequest`
|
|
3619
|
+
|
|
3620
|
+
</dd>
|
|
3621
|
+
</dl>
|
|
3622
|
+
|
|
3623
|
+
<dl>
|
|
3624
|
+
<dd>
|
|
3625
|
+
|
|
3626
|
+
**requestOptions:** `Webhooks.RequestOptions`
|
|
3627
|
+
|
|
3628
|
+
</dd>
|
|
3629
|
+
</dl>
|
|
3630
|
+
</dd>
|
|
3631
|
+
</dl>
|
|
3632
|
+
|
|
3633
|
+
|
|
3634
|
+
</dd>
|
|
3635
|
+
</dl>
|
|
3636
|
+
</details>
|
|
3637
|
+
|
|
3638
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">testWebhook</a>({ ...params }) -> Paid.WebhookTestResponse</code></summary>
|
|
3639
|
+
<dl>
|
|
3640
|
+
<dd>
|
|
3641
|
+
|
|
3642
|
+
#### 📝 Description
|
|
3643
|
+
|
|
3644
|
+
<dl>
|
|
3645
|
+
<dd>
|
|
3646
|
+
|
|
3647
|
+
<dl>
|
|
3648
|
+
<dd>
|
|
3649
|
+
|
|
3650
|
+
Send a synthetic webhook delivery to the configured destination for this webhook.
|
|
3651
|
+
</dd>
|
|
3652
|
+
</dl>
|
|
3653
|
+
</dd>
|
|
3654
|
+
</dl>
|
|
3655
|
+
|
|
3656
|
+
#### 🔌 Usage
|
|
3657
|
+
|
|
3658
|
+
<dl>
|
|
3659
|
+
<dd>
|
|
3660
|
+
|
|
3661
|
+
<dl>
|
|
3662
|
+
<dd>
|
|
3663
|
+
|
|
3664
|
+
```typescript
|
|
3665
|
+
await client.webhooks.testWebhook({
|
|
3666
|
+
webhookName: "billing-invoice-created"
|
|
3667
|
+
});
|
|
3668
|
+
|
|
3669
|
+
```
|
|
3670
|
+
</dd>
|
|
3671
|
+
</dl>
|
|
3672
|
+
</dd>
|
|
3673
|
+
</dl>
|
|
3674
|
+
|
|
3675
|
+
#### ⚙️ Parameters
|
|
3676
|
+
|
|
3677
|
+
<dl>
|
|
3678
|
+
<dd>
|
|
3679
|
+
|
|
3680
|
+
<dl>
|
|
3681
|
+
<dd>
|
|
3682
|
+
|
|
3683
|
+
**request:** `Paid.TestWebhookRequest`
|
|
3684
|
+
|
|
3685
|
+
</dd>
|
|
3686
|
+
</dl>
|
|
3687
|
+
|
|
3688
|
+
<dl>
|
|
3689
|
+
<dd>
|
|
3690
|
+
|
|
3691
|
+
**requestOptions:** `Webhooks.RequestOptions`
|
|
3692
|
+
|
|
3693
|
+
</dd>
|
|
3694
|
+
</dl>
|
|
3695
|
+
</dd>
|
|
3696
|
+
</dl>
|
|
3697
|
+
|
|
3698
|
+
|
|
3699
|
+
</dd>
|
|
3700
|
+
</dl>
|
|
3701
|
+
</details>
|
|
3702
|
+
|
|
3703
|
+
## Pricing
|
|
3704
|
+
<details><summary><code>client.pricing.<a href="/src/api/resources/pricing/client/Client.ts">listPricing</a>({ ...params }) -> Paid.PricingListResponse</code></summary>
|
|
3705
|
+
<dl>
|
|
3706
|
+
<dd>
|
|
3707
|
+
|
|
3708
|
+
#### 📝 Description
|
|
3709
|
+
|
|
3710
|
+
<dl>
|
|
3711
|
+
<dd>
|
|
3712
|
+
|
|
3713
|
+
<dl>
|
|
3714
|
+
<dd>
|
|
3715
|
+
|
|
3716
|
+
Returns pricing for all product attributes of a product. Each entry includes the attribute's pricing configuration and credit benefits.
|
|
3717
|
+
</dd>
|
|
3718
|
+
</dl>
|
|
3719
|
+
</dd>
|
|
3720
|
+
</dl>
|
|
3721
|
+
|
|
3722
|
+
#### 🔌 Usage
|
|
3723
|
+
|
|
3724
|
+
<dl>
|
|
3725
|
+
<dd>
|
|
3726
|
+
|
|
3727
|
+
<dl>
|
|
3728
|
+
<dd>
|
|
3729
|
+
|
|
3730
|
+
```typescript
|
|
3731
|
+
await client.pricing.listPricing({
|
|
3732
|
+
productId: "productId"
|
|
3733
|
+
});
|
|
3734
|
+
|
|
3735
|
+
```
|
|
3736
|
+
</dd>
|
|
3737
|
+
</dl>
|
|
3738
|
+
</dd>
|
|
3739
|
+
</dl>
|
|
3740
|
+
|
|
3741
|
+
#### ⚙️ Parameters
|
|
3742
|
+
|
|
3743
|
+
<dl>
|
|
3744
|
+
<dd>
|
|
3745
|
+
|
|
3746
|
+
<dl>
|
|
3747
|
+
<dd>
|
|
3748
|
+
|
|
3749
|
+
**request:** `Paid.ListPricingRequest`
|
|
3750
|
+
|
|
3751
|
+
</dd>
|
|
3752
|
+
</dl>
|
|
3753
|
+
|
|
3754
|
+
<dl>
|
|
3755
|
+
<dd>
|
|
3756
|
+
|
|
3757
|
+
**requestOptions:** `Pricing.RequestOptions`
|
|
3758
|
+
|
|
3759
|
+
</dd>
|
|
3760
|
+
</dl>
|
|
3761
|
+
</dd>
|
|
3762
|
+
</dl>
|
|
3763
|
+
|
|
3764
|
+
|
|
3765
|
+
</dd>
|
|
3766
|
+
</dl>
|
|
3767
|
+
</details>
|
|
3768
|
+
|
|
3769
|
+
<details><summary><code>client.pricing.<a href="/src/api/resources/pricing/client/Client.ts">getPricing</a>({ ...params }) -> Paid.PricingResponse</code></summary>
|
|
3770
|
+
<dl>
|
|
3771
|
+
<dd>
|
|
3772
|
+
|
|
3773
|
+
#### 📝 Description
|
|
3774
|
+
|
|
3775
|
+
<dl>
|
|
3776
|
+
<dd>
|
|
3777
|
+
|
|
3778
|
+
<dl>
|
|
3779
|
+
<dd>
|
|
3780
|
+
|
|
3781
|
+
Returns pricing and credit benefits for a single product attribute.
|
|
3782
|
+
</dd>
|
|
3783
|
+
</dl>
|
|
3784
|
+
</dd>
|
|
3785
|
+
</dl>
|
|
3786
|
+
|
|
3787
|
+
#### 🔌 Usage
|
|
3788
|
+
|
|
3789
|
+
<dl>
|
|
3790
|
+
<dd>
|
|
3791
|
+
|
|
3792
|
+
<dl>
|
|
3793
|
+
<dd>
|
|
3794
|
+
|
|
3795
|
+
```typescript
|
|
3796
|
+
await client.pricing.getPricing({
|
|
3797
|
+
productAttributeId: "productAttributeId"
|
|
3798
|
+
});
|
|
3799
|
+
|
|
3800
|
+
```
|
|
3801
|
+
</dd>
|
|
3802
|
+
</dl>
|
|
3803
|
+
</dd>
|
|
3804
|
+
</dl>
|
|
3805
|
+
|
|
3806
|
+
#### ⚙️ Parameters
|
|
3807
|
+
|
|
3808
|
+
<dl>
|
|
3809
|
+
<dd>
|
|
3810
|
+
|
|
3811
|
+
<dl>
|
|
3812
|
+
<dd>
|
|
3813
|
+
|
|
3814
|
+
**request:** `Paid.GetPricingRequest`
|
|
3815
|
+
|
|
3816
|
+
</dd>
|
|
3817
|
+
</dl>
|
|
3818
|
+
|
|
3819
|
+
<dl>
|
|
3820
|
+
<dd>
|
|
3821
|
+
|
|
3822
|
+
**requestOptions:** `Pricing.RequestOptions`
|
|
3823
|
+
|
|
3824
|
+
</dd>
|
|
3825
|
+
</dl>
|
|
3826
|
+
</dd>
|
|
3827
|
+
</dl>
|
|
3828
|
+
|
|
3829
|
+
|
|
3830
|
+
</dd>
|
|
3831
|
+
</dl>
|
|
3832
|
+
</details>
|
|
3833
|
+
|
|
3834
|
+
<details><summary><code>client.pricing.<a href="/src/api/resources/pricing/client/Client.ts">updatePricing</a>({ ...params }) -> Paid.PricingResponse</code></summary>
|
|
3835
|
+
<dl>
|
|
3836
|
+
<dd>
|
|
3837
|
+
|
|
3838
|
+
#### 📝 Description
|
|
3839
|
+
|
|
3840
|
+
<dl>
|
|
3841
|
+
<dd>
|
|
3842
|
+
|
|
3843
|
+
<dl>
|
|
3844
|
+
<dd>
|
|
3845
|
+
|
|
3846
|
+
Updates pricing on an existing product attribute. If creditBenefits is provided, it fully replaces existing benefits. If omitted, existing benefits are preserved.
|
|
3847
|
+
</dd>
|
|
3848
|
+
</dl>
|
|
3849
|
+
</dd>
|
|
3850
|
+
</dl>
|
|
3851
|
+
|
|
3852
|
+
#### 🔌 Usage
|
|
3853
|
+
|
|
3854
|
+
<dl>
|
|
3855
|
+
<dd>
|
|
3856
|
+
|
|
3857
|
+
<dl>
|
|
3858
|
+
<dd>
|
|
3859
|
+
|
|
3860
|
+
```typescript
|
|
3861
|
+
await client.pricing.updatePricing({
|
|
3862
|
+
productAttributeId: "productAttributeId",
|
|
3863
|
+
pricing: {
|
|
3864
|
+
pricingType: "RecurringPerUnit",
|
|
3865
|
+
billingFrequency: "Monthly",
|
|
3866
|
+
pricePoints: [{
|
|
3867
|
+
currency: "currency",
|
|
3868
|
+
unitPrice: 1.1
|
|
3869
|
+
}]
|
|
3870
|
+
}
|
|
3871
|
+
});
|
|
3872
|
+
|
|
3873
|
+
```
|
|
3874
|
+
</dd>
|
|
3875
|
+
</dl>
|
|
3876
|
+
</dd>
|
|
3877
|
+
</dl>
|
|
3878
|
+
|
|
3879
|
+
#### ⚙️ Parameters
|
|
3880
|
+
|
|
3881
|
+
<dl>
|
|
3882
|
+
<dd>
|
|
3883
|
+
|
|
3884
|
+
<dl>
|
|
3885
|
+
<dd>
|
|
3886
|
+
|
|
3887
|
+
**request:** `Paid.UpdatePricingRequest`
|
|
3888
|
+
|
|
3889
|
+
</dd>
|
|
3890
|
+
</dl>
|
|
3891
|
+
|
|
3892
|
+
<dl>
|
|
3893
|
+
<dd>
|
|
3894
|
+
|
|
3895
|
+
**requestOptions:** `Pricing.RequestOptions`
|
|
3896
|
+
|
|
3897
|
+
</dd>
|
|
3898
|
+
</dl>
|
|
3899
|
+
</dd>
|
|
3900
|
+
</dl>
|
|
3901
|
+
|
|
3902
|
+
|
|
3903
|
+
</dd>
|
|
3904
|
+
</dl>
|
|
3905
|
+
</details>
|
|
3906
|
+
|
|
3907
|
+
## Cost
|
|
3908
|
+
<details><summary><code>client.cost.<a href="/src/api/resources/cost/client/Client.ts">ingestCost</a>({ ...params }) -> Paid.CostIngestResponse</code></summary>
|
|
3909
|
+
<dl>
|
|
3910
|
+
<dd>
|
|
3911
|
+
|
|
3912
|
+
#### 📝 Description
|
|
3913
|
+
|
|
3914
|
+
<dl>
|
|
3915
|
+
<dd>
|
|
3916
|
+
|
|
3917
|
+
<dl>
|
|
3918
|
+
<dd>
|
|
3919
|
+
|
|
3920
|
+
Ingests a batch of cost records. Each record is either a pre-computed `cost` (caller supplies amount + currency) or a `usage` record (caller supplies vendor/model/token counts and Paid prices it server-side). The batch is all-or-nothing: if any record fails validation, the entire request is rejected with a 400 and nothing is persisted. Records may carry an optional `idempotencyKey`; matches against previously ingested records are skipped and reported in the `duplicates` count.
|
|
3921
|
+
</dd>
|
|
3922
|
+
</dl>
|
|
3923
|
+
</dd>
|
|
3924
|
+
</dl>
|
|
3925
|
+
|
|
3926
|
+
#### 🔌 Usage
|
|
3927
|
+
|
|
3928
|
+
<dl>
|
|
3929
|
+
<dd>
|
|
3930
|
+
|
|
3931
|
+
<dl>
|
|
3932
|
+
<dd>
|
|
3933
|
+
|
|
3934
|
+
```typescript
|
|
3935
|
+
await client.cost.ingestCost({
|
|
3936
|
+
costs: [{
|
|
3937
|
+
type: "cost",
|
|
3938
|
+
customer: {
|
|
3939
|
+
customerId: "customerId"
|
|
3940
|
+
},
|
|
3941
|
+
amount: 1.1,
|
|
3942
|
+
currency: "currency"
|
|
3943
|
+
}]
|
|
3944
|
+
});
|
|
3945
|
+
|
|
3946
|
+
```
|
|
3947
|
+
</dd>
|
|
3948
|
+
</dl>
|
|
3949
|
+
</dd>
|
|
3950
|
+
</dl>
|
|
3951
|
+
|
|
3952
|
+
#### ⚙️ Parameters
|
|
3953
|
+
|
|
3954
|
+
<dl>
|
|
3955
|
+
<dd>
|
|
3956
|
+
|
|
3957
|
+
<dl>
|
|
3958
|
+
<dd>
|
|
3959
|
+
|
|
3960
|
+
**request:** `Paid.CostIngestRequest`
|
|
3961
|
+
|
|
3962
|
+
</dd>
|
|
3963
|
+
</dl>
|
|
3964
|
+
|
|
3965
|
+
<dl>
|
|
3966
|
+
<dd>
|
|
3967
|
+
|
|
3968
|
+
**requestOptions:** `Cost.RequestOptions`
|
|
3969
|
+
|
|
3970
|
+
</dd>
|
|
3971
|
+
</dl>
|
|
3972
|
+
</dd>
|
|
3973
|
+
</dl>
|
|
3974
|
+
|
|
3975
|
+
|
|
2922
3976
|
</dd>
|
|
2923
3977
|
</dl>
|
|
2924
3978
|
</details>
|