@paygentic/sdk 0.6.19 → 0.6.21
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/README.md +18 -5
- package/dist/commonjs/funcs/customersList.d.ts +1 -1
- package/dist/commonjs/funcs/customersList.d.ts.map +1 -1
- package/dist/commonjs/funcs/customersList.js +2 -2
- package/dist/commonjs/funcs/customersList.js.map +1 -1
- package/dist/commonjs/funcs/entitlementsGrantsCreate.d.ts +19 -0
- package/dist/commonjs/funcs/entitlementsGrantsCreate.d.ts.map +1 -0
- package/dist/commonjs/funcs/entitlementsGrantsCreate.js +127 -0
- package/dist/commonjs/funcs/entitlementsGrantsCreate.js.map +1 -0
- package/dist/commonjs/funcs/entitlementsGrantsGet.d.ts +19 -0
- package/dist/commonjs/funcs/entitlementsGrantsGet.d.ts.map +1 -0
- package/dist/commonjs/funcs/entitlementsGrantsGet.js +128 -0
- package/dist/commonjs/funcs/entitlementsGrantsGet.js.map +1 -0
- package/dist/commonjs/funcs/entitlementsGrantsList.d.ts +18 -0
- package/dist/commonjs/funcs/entitlementsGrantsList.d.ts.map +1 -0
- package/dist/commonjs/funcs/entitlementsGrantsList.js +129 -0
- package/dist/commonjs/funcs/entitlementsGrantsList.js.map +1 -0
- package/dist/commonjs/funcs/entitlementsGrantsPurchase.d.ts +21 -0
- package/dist/commonjs/funcs/entitlementsGrantsPurchase.d.ts.map +1 -0
- package/dist/commonjs/funcs/entitlementsGrantsPurchase.js +129 -0
- package/dist/commonjs/funcs/entitlementsGrantsPurchase.js.map +1 -0
- package/dist/commonjs/funcs/entitlementsGrantsVoid.d.ts +19 -0
- package/dist/commonjs/funcs/entitlementsGrantsVoid.d.ts.map +1 -0
- package/dist/commonjs/funcs/entitlementsGrantsVoid.js +128 -0
- package/dist/commonjs/funcs/entitlementsGrantsVoid.js.map +1 -0
- package/dist/commonjs/funcs/revenueGet.d.ts +3 -3
- package/dist/commonjs/funcs/revenueGet.d.ts.map +1 -1
- package/dist/commonjs/funcs/revenueGet.js +4 -4
- package/dist/commonjs/funcs/revenueGet.js.map +1 -1
- package/dist/commonjs/funcs/subscriptionsList.js +2 -0
- package/dist/commonjs/funcs/subscriptionsList.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +3 -3
- package/dist/commonjs/lib/config.js +3 -3
- package/dist/commonjs/models/creategrantrequest.d.ts +30 -0
- package/dist/commonjs/models/creategrantrequest.d.ts.map +1 -0
- package/dist/commonjs/models/creategrantrequest.js +52 -0
- package/dist/commonjs/models/creategrantrequest.js.map +1 -0
- package/dist/commonjs/models/grant.d.ts +45 -0
- package/dist/commonjs/models/grant.d.ts.map +1 -0
- package/dist/commonjs/models/grant.js +64 -0
- package/dist/commonjs/models/grant.js.map +1 -0
- package/dist/commonjs/models/groupinvoicesummary.d.ts +21 -0
- package/dist/commonjs/models/groupinvoicesummary.d.ts.map +1 -0
- package/dist/commonjs/models/groupinvoicesummary.js +55 -0
- package/dist/commonjs/models/groupinvoicesummary.js.map +1 -0
- package/dist/commonjs/models/grouptrendentry.d.ts +21 -0
- package/dist/commonjs/models/grouptrendentry.d.ts.map +1 -0
- package/dist/commonjs/models/{revenuetimeseriesresponse.js → grouptrendentry.js} +9 -9
- package/dist/commonjs/models/grouptrendentry.js.map +1 -0
- package/dist/commonjs/models/index.d.ts +11 -3
- package/dist/commonjs/models/index.d.ts.map +1 -1
- package/dist/commonjs/models/index.js +11 -3
- package/dist/commonjs/models/index.js.map +1 -1
- package/dist/commonjs/models/invoicecategorysummary.d.ts +17 -0
- package/dist/commonjs/models/invoicecategorysummary.d.ts.map +1 -0
- package/dist/commonjs/models/{revenuestats.js → invoicecategorysummary.js} +8 -14
- package/dist/commonjs/models/invoicecategorysummary.js.map +1 -0
- package/dist/commonjs/models/invoicesummary.d.ts +14 -0
- package/dist/commonjs/models/invoicesummary.d.ts.map +1 -0
- package/dist/commonjs/models/invoicesummary.js +54 -0
- package/dist/commonjs/models/invoicesummary.js.map +1 -0
- package/dist/commonjs/models/operations/createentitlementgrant.d.ts +18 -0
- package/dist/commonjs/models/operations/createentitlementgrant.d.ts.map +1 -0
- package/dist/commonjs/models/operations/createentitlementgrant.js +56 -0
- package/dist/commonjs/models/operations/createentitlementgrant.js.map +1 -0
- package/dist/commonjs/models/operations/getentitlementgrant.d.ts +20 -0
- package/dist/commonjs/models/operations/getentitlementgrant.d.ts.map +1 -0
- package/dist/commonjs/models/operations/getentitlementgrant.js +50 -0
- package/dist/commonjs/models/operations/getentitlementgrant.js.map +1 -0
- package/dist/commonjs/models/operations/getrevenue.d.ts +19 -7
- package/dist/commonjs/models/operations/getrevenue.d.ts.map +1 -1
- package/dist/commonjs/models/operations/getrevenue.js +14 -5
- package/dist/commonjs/models/operations/getrevenue.js.map +1 -1
- package/dist/commonjs/models/operations/index.d.ts +5 -0
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +5 -0
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/listcustomers.d.ts +2 -2
- package/dist/commonjs/models/operations/listentitlementgrants.d.ts +54 -0
- package/dist/commonjs/models/operations/listentitlementgrants.d.ts.map +1 -0
- package/dist/commonjs/models/operations/listentitlementgrants.js +69 -0
- package/dist/commonjs/models/operations/listentitlementgrants.js.map +1 -0
- package/dist/commonjs/models/operations/listsubscriptions.d.ts +23 -0
- package/dist/commonjs/models/operations/listsubscriptions.d.ts.map +1 -1
- package/dist/commonjs/models/operations/listsubscriptions.js +13 -1
- package/dist/commonjs/models/operations/listsubscriptions.js.map +1 -1
- package/dist/commonjs/models/operations/purchaseentitlementgrant.d.ts +18 -0
- package/dist/commonjs/models/operations/purchaseentitlementgrant.d.ts.map +1 -0
- package/dist/commonjs/models/operations/purchaseentitlementgrant.js +56 -0
- package/dist/commonjs/models/operations/purchaseentitlementgrant.js.map +1 -0
- package/dist/commonjs/models/operations/voidentitlementgrant.d.ts +20 -0
- package/dist/commonjs/models/operations/voidentitlementgrant.d.ts.map +1 -0
- package/dist/commonjs/models/operations/voidentitlementgrant.js +50 -0
- package/dist/commonjs/models/operations/voidentitlementgrant.js.map +1 -0
- package/dist/commonjs/models/paymentsummary.d.ts +33 -0
- package/dist/commonjs/models/paymentsummary.d.ts.map +1 -0
- package/dist/commonjs/models/paymentsummary.js +55 -0
- package/dist/commonjs/models/paymentsummary.js.map +1 -0
- package/dist/commonjs/models/purchasegrantrequest.d.ts +50 -0
- package/dist/commonjs/models/purchasegrantrequest.d.ts.map +1 -0
- package/dist/commonjs/models/purchasegrantrequest.js +56 -0
- package/dist/commonjs/models/purchasegrantrequest.js.map +1 -0
- package/dist/commonjs/models/purchasegrantresponse.d.ts +58 -0
- package/dist/commonjs/models/purchasegrantresponse.d.ts.map +1 -0
- package/dist/commonjs/models/purchasegrantresponse.js +71 -0
- package/dist/commonjs/models/purchasegrantresponse.js.map +1 -0
- package/dist/commonjs/models/revenuesummaryresponse.d.ts +31 -0
- package/dist/commonjs/models/revenuesummaryresponse.d.ts.map +1 -0
- package/dist/commonjs/models/revenuesummaryresponse.js +59 -0
- package/dist/commonjs/models/revenuesummaryresponse.js.map +1 -0
- package/dist/commonjs/models/revenuetrendbucket.d.ts +30 -0
- package/dist/commonjs/models/revenuetrendbucket.d.ts.map +1 -0
- package/dist/commonjs/models/{revenuetimebucket.js → revenuetrendbucket.js} +11 -9
- package/dist/commonjs/models/revenuetrendbucket.js.map +1 -0
- package/dist/commonjs/models/subscription.d.ts +38 -0
- package/dist/commonjs/models/subscription.d.ts.map +1 -1
- package/dist/commonjs/models/subscription.js +33 -1
- package/dist/commonjs/models/subscription.js.map +1 -1
- package/dist/commonjs/sdk/entitlements.d.ts +3 -0
- package/dist/commonjs/sdk/entitlements.d.ts.map +1 -1
- package/dist/commonjs/sdk/entitlements.js +4 -0
- package/dist/commonjs/sdk/entitlements.js.map +1 -1
- package/dist/commonjs/sdk/grants.d.ts +43 -0
- package/dist/commonjs/sdk/grants.d.ts.map +1 -0
- package/dist/commonjs/sdk/grants.js +64 -0
- package/dist/commonjs/sdk/grants.js.map +1 -0
- package/dist/commonjs/sdk/revenue.d.ts +3 -3
- package/dist/commonjs/sdk/revenue.d.ts.map +1 -1
- package/dist/commonjs/sdk/revenue.js +2 -2
- package/dist/esm/funcs/customersList.d.ts +1 -1
- package/dist/esm/funcs/customersList.d.ts.map +1 -1
- package/dist/esm/funcs/customersList.js +2 -2
- package/dist/esm/funcs/customersList.js.map +1 -1
- package/dist/esm/funcs/entitlementsGrantsCreate.d.ts +19 -0
- package/dist/esm/funcs/entitlementsGrantsCreate.d.ts.map +1 -0
- package/dist/esm/funcs/entitlementsGrantsCreate.js +91 -0
- package/dist/esm/funcs/entitlementsGrantsCreate.js.map +1 -0
- package/dist/esm/funcs/entitlementsGrantsGet.d.ts +19 -0
- package/dist/esm/funcs/entitlementsGrantsGet.d.ts.map +1 -0
- package/dist/esm/funcs/entitlementsGrantsGet.js +92 -0
- package/dist/esm/funcs/entitlementsGrantsGet.js.map +1 -0
- package/dist/esm/funcs/entitlementsGrantsList.d.ts +18 -0
- package/dist/esm/funcs/entitlementsGrantsList.d.ts.map +1 -0
- package/dist/esm/funcs/entitlementsGrantsList.js +93 -0
- package/dist/esm/funcs/entitlementsGrantsList.js.map +1 -0
- package/dist/esm/funcs/entitlementsGrantsPurchase.d.ts +21 -0
- package/dist/esm/funcs/entitlementsGrantsPurchase.d.ts.map +1 -0
- package/dist/esm/funcs/entitlementsGrantsPurchase.js +93 -0
- package/dist/esm/funcs/entitlementsGrantsPurchase.js.map +1 -0
- package/dist/esm/funcs/entitlementsGrantsVoid.d.ts +19 -0
- package/dist/esm/funcs/entitlementsGrantsVoid.d.ts.map +1 -0
- package/dist/esm/funcs/entitlementsGrantsVoid.js +92 -0
- package/dist/esm/funcs/entitlementsGrantsVoid.js.map +1 -0
- package/dist/esm/funcs/revenueGet.d.ts +3 -3
- package/dist/esm/funcs/revenueGet.d.ts.map +1 -1
- package/dist/esm/funcs/revenueGet.js +4 -4
- package/dist/esm/funcs/revenueGet.js.map +1 -1
- package/dist/esm/funcs/subscriptionsList.js +2 -0
- package/dist/esm/funcs/subscriptionsList.js.map +1 -1
- package/dist/esm/lib/config.d.ts +3 -3
- package/dist/esm/lib/config.js +3 -3
- package/dist/esm/models/creategrantrequest.d.ts +30 -0
- package/dist/esm/models/creategrantrequest.d.ts.map +1 -0
- package/dist/esm/models/creategrantrequest.js +15 -0
- package/dist/esm/models/creategrantrequest.js.map +1 -0
- package/dist/esm/models/grant.d.ts +45 -0
- package/dist/esm/models/grant.d.ts.map +1 -0
- package/dist/esm/models/grant.js +27 -0
- package/dist/esm/models/grant.js.map +1 -0
- package/dist/esm/models/groupinvoicesummary.d.ts +21 -0
- package/dist/esm/models/groupinvoicesummary.d.ts.map +1 -0
- package/dist/esm/models/groupinvoicesummary.js +18 -0
- package/dist/esm/models/groupinvoicesummary.js.map +1 -0
- package/dist/esm/models/grouptrendentry.d.ts +21 -0
- package/dist/esm/models/grouptrendentry.d.ts.map +1 -0
- package/dist/esm/models/grouptrendentry.js +15 -0
- package/dist/esm/models/grouptrendentry.js.map +1 -0
- package/dist/esm/models/index.d.ts +11 -3
- package/dist/esm/models/index.d.ts.map +1 -1
- package/dist/esm/models/index.js +11 -3
- package/dist/esm/models/index.js.map +1 -1
- package/dist/esm/models/invoicecategorysummary.d.ts +17 -0
- package/dist/esm/models/invoicecategorysummary.d.ts.map +1 -0
- package/dist/esm/models/invoicecategorysummary.js +14 -0
- package/dist/esm/models/invoicecategorysummary.js.map +1 -0
- package/dist/esm/models/invoicesummary.d.ts +14 -0
- package/dist/esm/models/invoicesummary.d.ts.map +1 -0
- package/dist/esm/models/invoicesummary.js +17 -0
- package/dist/esm/models/invoicesummary.js.map +1 -0
- package/dist/esm/models/operations/createentitlementgrant.d.ts +18 -0
- package/dist/esm/models/operations/createentitlementgrant.d.ts.map +1 -0
- package/dist/esm/models/operations/createentitlementgrant.js +19 -0
- package/dist/esm/models/operations/createentitlementgrant.js.map +1 -0
- package/dist/esm/models/operations/getentitlementgrant.d.ts +20 -0
- package/dist/esm/models/operations/getentitlementgrant.d.ts.map +1 -0
- package/dist/esm/models/operations/getentitlementgrant.js +13 -0
- package/dist/esm/models/operations/getentitlementgrant.js.map +1 -0
- package/dist/esm/models/operations/getrevenue.d.ts +19 -7
- package/dist/esm/models/operations/getrevenue.d.ts.map +1 -1
- package/dist/esm/models/operations/getrevenue.js +13 -4
- package/dist/esm/models/operations/getrevenue.js.map +1 -1
- package/dist/esm/models/operations/index.d.ts +5 -0
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +5 -0
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/listcustomers.d.ts +2 -2
- package/dist/esm/models/operations/listentitlementgrants.d.ts +54 -0
- package/dist/esm/models/operations/listentitlementgrants.d.ts.map +1 -0
- package/dist/esm/models/operations/listentitlementgrants.js +31 -0
- package/dist/esm/models/operations/listentitlementgrants.js.map +1 -0
- package/dist/esm/models/operations/listsubscriptions.d.ts +23 -0
- package/dist/esm/models/operations/listsubscriptions.d.ts.map +1 -1
- package/dist/esm/models/operations/listsubscriptions.js +12 -0
- package/dist/esm/models/operations/listsubscriptions.js.map +1 -1
- package/dist/esm/models/operations/purchaseentitlementgrant.d.ts +18 -0
- package/dist/esm/models/operations/purchaseentitlementgrant.d.ts.map +1 -0
- package/dist/esm/models/operations/purchaseentitlementgrant.js +19 -0
- package/dist/esm/models/operations/purchaseentitlementgrant.js.map +1 -0
- package/dist/esm/models/operations/voidentitlementgrant.d.ts +20 -0
- package/dist/esm/models/operations/voidentitlementgrant.d.ts.map +1 -0
- package/dist/esm/models/operations/voidentitlementgrant.js +13 -0
- package/dist/esm/models/operations/voidentitlementgrant.js.map +1 -0
- package/dist/esm/models/paymentsummary.d.ts +33 -0
- package/dist/esm/models/paymentsummary.d.ts.map +1 -0
- package/dist/esm/models/paymentsummary.js +18 -0
- package/dist/esm/models/paymentsummary.js.map +1 -0
- package/dist/esm/models/purchasegrantrequest.d.ts +50 -0
- package/dist/esm/models/purchasegrantrequest.d.ts.map +1 -0
- package/dist/esm/models/purchasegrantrequest.js +19 -0
- package/dist/esm/models/purchasegrantrequest.js.map +1 -0
- package/dist/esm/models/purchasegrantresponse.d.ts +58 -0
- package/dist/esm/models/purchasegrantresponse.d.ts.map +1 -0
- package/dist/esm/models/purchasegrantresponse.js +33 -0
- package/dist/esm/models/purchasegrantresponse.js.map +1 -0
- package/dist/esm/models/revenuesummaryresponse.d.ts +31 -0
- package/dist/esm/models/revenuesummaryresponse.d.ts.map +1 -0
- package/dist/esm/models/revenuesummaryresponse.js +22 -0
- package/dist/esm/models/revenuesummaryresponse.js.map +1 -0
- package/dist/esm/models/revenuetrendbucket.d.ts +30 -0
- package/dist/esm/models/revenuetrendbucket.d.ts.map +1 -0
- package/dist/esm/models/revenuetrendbucket.js +18 -0
- package/dist/esm/models/revenuetrendbucket.js.map +1 -0
- package/dist/esm/models/subscription.d.ts +38 -0
- package/dist/esm/models/subscription.d.ts.map +1 -1
- package/dist/esm/models/subscription.js +29 -0
- package/dist/esm/models/subscription.js.map +1 -1
- package/dist/esm/sdk/entitlements.d.ts +3 -0
- package/dist/esm/sdk/entitlements.d.ts.map +1 -1
- package/dist/esm/sdk/entitlements.js +4 -0
- package/dist/esm/sdk/entitlements.js.map +1 -1
- package/dist/esm/sdk/grants.d.ts +43 -0
- package/dist/esm/sdk/grants.d.ts.map +1 -0
- package/dist/esm/sdk/grants.js +60 -0
- package/dist/esm/sdk/grants.js.map +1 -0
- package/dist/esm/sdk/revenue.d.ts +3 -3
- package/dist/esm/sdk/revenue.d.ts.map +1 -1
- package/dist/esm/sdk/revenue.js +2 -2
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/customersList.ts +5 -1
- package/src/funcs/entitlementsGrantsCreate.ts +187 -0
- package/src/funcs/entitlementsGrantsGet.ts +188 -0
- package/src/funcs/entitlementsGrantsList.ts +190 -0
- package/src/funcs/entitlementsGrantsPurchase.ts +189 -0
- package/src/funcs/entitlementsGrantsVoid.ts +188 -0
- package/src/funcs/revenueGet.ts +7 -7
- package/src/funcs/subscriptionsList.ts +2 -0
- package/src/lib/config.ts +3 -3
- package/src/models/creategrantrequest.ts +52 -0
- package/src/models/grant.ts +81 -0
- package/src/models/groupinvoicesummary.ts +49 -0
- package/src/models/grouptrendentry.ts +44 -0
- package/src/models/index.ts +11 -3
- package/src/models/invoicecategorysummary.ts +39 -0
- package/src/models/invoicesummary.ts +41 -0
- package/src/models/operations/createentitlementgrant.ts +45 -0
- package/src/models/operations/getentitlementgrant.ts +40 -0
- package/src/models/operations/getrevenue.ts +24 -9
- package/src/models/operations/index.ts +5 -0
- package/src/models/operations/listcustomers.ts +2 -2
- package/src/models/operations/listentitlementgrants.ts +104 -0
- package/src/models/operations/listsubscriptions.ts +28 -0
- package/src/models/operations/purchaseentitlementgrant.ts +45 -0
- package/src/models/operations/voidentitlementgrant.ts +42 -0
- package/src/models/paymentsummary.ts +59 -0
- package/src/models/purchasegrantrequest.ts +76 -0
- package/src/models/purchasegrantresponse.ts +112 -0
- package/src/models/revenuesummaryresponse.ts +69 -0
- package/src/models/revenuetrendbucket.ts +58 -0
- package/src/models/subscription.ts +97 -0
- package/src/sdk/entitlements.ts +6 -0
- package/src/sdk/grants.ts +102 -0
- package/src/sdk/revenue.ts +3 -3
- package/dist/commonjs/models/revenuestats.d.ts +0 -41
- package/dist/commonjs/models/revenuestats.d.ts.map +0 -1
- package/dist/commonjs/models/revenuestats.js.map +0 -1
- package/dist/commonjs/models/revenuetimebucket.d.ts +0 -21
- package/dist/commonjs/models/revenuetimebucket.d.ts.map +0 -1
- package/dist/commonjs/models/revenuetimebucket.js.map +0 -1
- package/dist/commonjs/models/revenuetimeseriesresponse.d.ts +0 -18
- package/dist/commonjs/models/revenuetimeseriesresponse.d.ts.map +0 -1
- package/dist/commonjs/models/revenuetimeseriesresponse.js.map +0 -1
- package/dist/esm/models/revenuestats.d.ts +0 -41
- package/dist/esm/models/revenuestats.d.ts.map +0 -1
- package/dist/esm/models/revenuestats.js +0 -20
- package/dist/esm/models/revenuestats.js.map +0 -1
- package/dist/esm/models/revenuetimebucket.d.ts +0 -21
- package/dist/esm/models/revenuetimebucket.d.ts.map +0 -1
- package/dist/esm/models/revenuetimebucket.js +0 -16
- package/dist/esm/models/revenuetimebucket.js.map +0 -1
- package/dist/esm/models/revenuetimeseriesresponse.d.ts +0 -18
- package/dist/esm/models/revenuetimeseriesresponse.d.ts.map +0 -1
- package/dist/esm/models/revenuetimeseriesresponse.js +0 -15
- package/dist/esm/models/revenuetimeseriesresponse.js.map +0 -1
- package/src/models/revenuestats.ts +0 -69
- package/src/models/revenuetimebucket.ts +0 -42
- package/src/models/revenuetimeseriesresponse.ts +0 -43
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
|
|
7
|
+
export type PurchaseGrantRequest = {
|
|
8
|
+
/**
|
|
9
|
+
* The number of credits to grant upon payment completion.
|
|
10
|
+
*/
|
|
11
|
+
amount: number;
|
|
12
|
+
/**
|
|
13
|
+
* The price in decimal format (e.g., '5.00' for $5.00 USD). Must be at least $0.50.
|
|
14
|
+
*/
|
|
15
|
+
price: string;
|
|
16
|
+
/**
|
|
17
|
+
* Caller-provided deduplication key. Retrying with the same key returns the existing invoice.
|
|
18
|
+
*/
|
|
19
|
+
idempotencyKey: string;
|
|
20
|
+
/**
|
|
21
|
+
* When the grant becomes effective. Defaults to now.
|
|
22
|
+
*/
|
|
23
|
+
effectiveAt?: Date | undefined;
|
|
24
|
+
/**
|
|
25
|
+
* When the grant expires. If omitted, the grant does not expire.
|
|
26
|
+
*/
|
|
27
|
+
expiresAt?: Date | null | undefined;
|
|
28
|
+
/**
|
|
29
|
+
* URL to redirect the customer to after successful payment.
|
|
30
|
+
*/
|
|
31
|
+
successUrl?: string | undefined;
|
|
32
|
+
/**
|
|
33
|
+
* URL to redirect the customer to if payment is cancelled.
|
|
34
|
+
*/
|
|
35
|
+
cancelUrl?: string | undefined;
|
|
36
|
+
/**
|
|
37
|
+
* When the payment session expires. If omitted, uses the default expiry.
|
|
38
|
+
*/
|
|
39
|
+
paymentExpiresAt?: Date | undefined;
|
|
40
|
+
};
|
|
41
|
+
|
|
42
|
+
/** @internal */
|
|
43
|
+
export type PurchaseGrantRequest$Outbound = {
|
|
44
|
+
amount: number;
|
|
45
|
+
price: string;
|
|
46
|
+
idempotencyKey: string;
|
|
47
|
+
effectiveAt?: string | undefined;
|
|
48
|
+
expiresAt?: string | null | undefined;
|
|
49
|
+
successUrl?: string | undefined;
|
|
50
|
+
cancelUrl?: string | undefined;
|
|
51
|
+
paymentExpiresAt?: string | undefined;
|
|
52
|
+
};
|
|
53
|
+
|
|
54
|
+
/** @internal */
|
|
55
|
+
export const PurchaseGrantRequest$outboundSchema: z.ZodType<
|
|
56
|
+
PurchaseGrantRequest$Outbound,
|
|
57
|
+
z.ZodTypeDef,
|
|
58
|
+
PurchaseGrantRequest
|
|
59
|
+
> = z.object({
|
|
60
|
+
amount: z.number(),
|
|
61
|
+
price: z.string(),
|
|
62
|
+
idempotencyKey: z.string(),
|
|
63
|
+
effectiveAt: z.date().transform(v => v.toISOString()).optional(),
|
|
64
|
+
expiresAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
|
|
65
|
+
successUrl: z.string().optional(),
|
|
66
|
+
cancelUrl: z.string().optional(),
|
|
67
|
+
paymentExpiresAt: z.date().transform(v => v.toISOString()).optional(),
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
export function purchaseGrantRequestToJSON(
|
|
71
|
+
purchaseGrantRequest: PurchaseGrantRequest,
|
|
72
|
+
): string {
|
|
73
|
+
return JSON.stringify(
|
|
74
|
+
PurchaseGrantRequest$outboundSchema.parse(purchaseGrantRequest),
|
|
75
|
+
);
|
|
76
|
+
}
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import { safeParse } from "../lib/schemas.js";
|
|
7
|
+
import { ClosedEnum } from "../types/enums.js";
|
|
8
|
+
import { Result as SafeParseResult } from "../types/fp.js";
|
|
9
|
+
import { SDKValidationError } from "./errors/sdkvalidationerror.js";
|
|
10
|
+
|
|
11
|
+
export const PurchaseGrantResponseObject = {
|
|
12
|
+
GrantPurchase: "grant_purchase",
|
|
13
|
+
} as const;
|
|
14
|
+
export type PurchaseGrantResponseObject = ClosedEnum<
|
|
15
|
+
typeof PurchaseGrantResponseObject
|
|
16
|
+
>;
|
|
17
|
+
|
|
18
|
+
export type PaymentSession = {
|
|
19
|
+
/**
|
|
20
|
+
* The Stripe checkout URL for the customer to complete payment.
|
|
21
|
+
*/
|
|
22
|
+
url: string;
|
|
23
|
+
/**
|
|
24
|
+
* When the payment session expires.
|
|
25
|
+
*/
|
|
26
|
+
expiresAt?: Date | null | undefined;
|
|
27
|
+
/**
|
|
28
|
+
* The payment amount in the currency's minor unit (e.g., cents).
|
|
29
|
+
*/
|
|
30
|
+
amount?: number | undefined;
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
export type PurchaseGrantResponse = {
|
|
34
|
+
object: PurchaseGrantResponseObject;
|
|
35
|
+
/**
|
|
36
|
+
* The invoice ID for this grant purchase.
|
|
37
|
+
*/
|
|
38
|
+
invoiceId: string;
|
|
39
|
+
/**
|
|
40
|
+
* The entitlement that will receive the grant.
|
|
41
|
+
*/
|
|
42
|
+
entitlementId: string;
|
|
43
|
+
/**
|
|
44
|
+
* The number of credits that will be granted on payment.
|
|
45
|
+
*/
|
|
46
|
+
grantAmount: number;
|
|
47
|
+
/**
|
|
48
|
+
* The price in decimal format (e.g., '5.00').
|
|
49
|
+
*/
|
|
50
|
+
price: string;
|
|
51
|
+
/**
|
|
52
|
+
* The three-letter ISO 4217 currency code (e.g., 'usd').
|
|
53
|
+
*/
|
|
54
|
+
currency: string;
|
|
55
|
+
/**
|
|
56
|
+
* Payment session(s) for the customer to complete the purchase.
|
|
57
|
+
*/
|
|
58
|
+
paymentSessions: Array<PaymentSession>;
|
|
59
|
+
};
|
|
60
|
+
|
|
61
|
+
/** @internal */
|
|
62
|
+
export const PurchaseGrantResponseObject$inboundSchema: z.ZodNativeEnum<
|
|
63
|
+
typeof PurchaseGrantResponseObject
|
|
64
|
+
> = z.nativeEnum(PurchaseGrantResponseObject);
|
|
65
|
+
|
|
66
|
+
/** @internal */
|
|
67
|
+
export const PaymentSession$inboundSchema: z.ZodType<
|
|
68
|
+
PaymentSession,
|
|
69
|
+
z.ZodTypeDef,
|
|
70
|
+
unknown
|
|
71
|
+
> = z.object({
|
|
72
|
+
url: z.string(),
|
|
73
|
+
expiresAt: z.nullable(
|
|
74
|
+
z.string().datetime({ offset: true }).transform(v => new Date(v)),
|
|
75
|
+
).optional(),
|
|
76
|
+
amount: z.number().optional(),
|
|
77
|
+
});
|
|
78
|
+
|
|
79
|
+
export function paymentSessionFromJSON(
|
|
80
|
+
jsonString: string,
|
|
81
|
+
): SafeParseResult<PaymentSession, SDKValidationError> {
|
|
82
|
+
return safeParse(
|
|
83
|
+
jsonString,
|
|
84
|
+
(x) => PaymentSession$inboundSchema.parse(JSON.parse(x)),
|
|
85
|
+
`Failed to parse 'PaymentSession' from JSON`,
|
|
86
|
+
);
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
/** @internal */
|
|
90
|
+
export const PurchaseGrantResponse$inboundSchema: z.ZodType<
|
|
91
|
+
PurchaseGrantResponse,
|
|
92
|
+
z.ZodTypeDef,
|
|
93
|
+
unknown
|
|
94
|
+
> = z.object({
|
|
95
|
+
object: PurchaseGrantResponseObject$inboundSchema.default("grant_purchase"),
|
|
96
|
+
invoiceId: z.string(),
|
|
97
|
+
entitlementId: z.string(),
|
|
98
|
+
grantAmount: z.number().int(),
|
|
99
|
+
price: z.string(),
|
|
100
|
+
currency: z.string(),
|
|
101
|
+
paymentSessions: z.array(z.lazy(() => PaymentSession$inboundSchema)),
|
|
102
|
+
});
|
|
103
|
+
|
|
104
|
+
export function purchaseGrantResponseFromJSON(
|
|
105
|
+
jsonString: string,
|
|
106
|
+
): SafeParseResult<PurchaseGrantResponse, SDKValidationError> {
|
|
107
|
+
return safeParse(
|
|
108
|
+
jsonString,
|
|
109
|
+
(x) => PurchaseGrantResponse$inboundSchema.parse(JSON.parse(x)),
|
|
110
|
+
`Failed to parse 'PurchaseGrantResponse' from JSON`,
|
|
111
|
+
);
|
|
112
|
+
}
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import { safeParse } from "../lib/schemas.js";
|
|
7
|
+
import { Result as SafeParseResult } from "../types/fp.js";
|
|
8
|
+
import { SDKValidationError } from "./errors/sdkvalidationerror.js";
|
|
9
|
+
import {
|
|
10
|
+
GroupInvoiceSummary,
|
|
11
|
+
GroupInvoiceSummary$inboundSchema,
|
|
12
|
+
} from "./groupinvoicesummary.js";
|
|
13
|
+
import {
|
|
14
|
+
InvoiceSummary,
|
|
15
|
+
InvoiceSummary$inboundSchema,
|
|
16
|
+
} from "./invoicesummary.js";
|
|
17
|
+
import {
|
|
18
|
+
PaymentSummary,
|
|
19
|
+
PaymentSummary$inboundSchema,
|
|
20
|
+
} from "./paymentsummary.js";
|
|
21
|
+
import {
|
|
22
|
+
RevenueTrendBucket,
|
|
23
|
+
RevenueTrendBucket$inboundSchema,
|
|
24
|
+
} from "./revenuetrendbucket.js";
|
|
25
|
+
|
|
26
|
+
export type RevenueSummaryResponse = {
|
|
27
|
+
/**
|
|
28
|
+
* Object type identifier
|
|
29
|
+
*/
|
|
30
|
+
object: "revenue_summary";
|
|
31
|
+
/**
|
|
32
|
+
* Net collected revenue in dollars (paid invoices + completed payments)
|
|
33
|
+
*/
|
|
34
|
+
netRevenue: string;
|
|
35
|
+
invoices: InvoiceSummary;
|
|
36
|
+
payments: PaymentSummary;
|
|
37
|
+
/**
|
|
38
|
+
* Time-bucketed revenue trend data
|
|
39
|
+
*/
|
|
40
|
+
trend: Array<RevenueTrendBucket>;
|
|
41
|
+
/**
|
|
42
|
+
* Invoice breakdown by group dimension (only present when groupBy is specified)
|
|
43
|
+
*/
|
|
44
|
+
groupBreakdown?: Array<GroupInvoiceSummary> | undefined;
|
|
45
|
+
};
|
|
46
|
+
|
|
47
|
+
/** @internal */
|
|
48
|
+
export const RevenueSummaryResponse$inboundSchema: z.ZodType<
|
|
49
|
+
RevenueSummaryResponse,
|
|
50
|
+
z.ZodTypeDef,
|
|
51
|
+
unknown
|
|
52
|
+
> = z.object({
|
|
53
|
+
object: z.literal("revenue_summary"),
|
|
54
|
+
netRevenue: z.string(),
|
|
55
|
+
invoices: InvoiceSummary$inboundSchema,
|
|
56
|
+
payments: PaymentSummary$inboundSchema,
|
|
57
|
+
trend: z.array(RevenueTrendBucket$inboundSchema),
|
|
58
|
+
groupBreakdown: z.array(GroupInvoiceSummary$inboundSchema).optional(),
|
|
59
|
+
});
|
|
60
|
+
|
|
61
|
+
export function revenueSummaryResponseFromJSON(
|
|
62
|
+
jsonString: string,
|
|
63
|
+
): SafeParseResult<RevenueSummaryResponse, SDKValidationError> {
|
|
64
|
+
return safeParse(
|
|
65
|
+
jsonString,
|
|
66
|
+
(x) => RevenueSummaryResponse$inboundSchema.parse(JSON.parse(x)),
|
|
67
|
+
`Failed to parse 'RevenueSummaryResponse' from JSON`,
|
|
68
|
+
);
|
|
69
|
+
}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import { safeParse } from "../lib/schemas.js";
|
|
7
|
+
import { Result as SafeParseResult } from "../types/fp.js";
|
|
8
|
+
import { SDKValidationError } from "./errors/sdkvalidationerror.js";
|
|
9
|
+
import {
|
|
10
|
+
GroupTrendEntry,
|
|
11
|
+
GroupTrendEntry$inboundSchema,
|
|
12
|
+
} from "./grouptrendentry.js";
|
|
13
|
+
|
|
14
|
+
export type RevenueTrendBucket = {
|
|
15
|
+
/**
|
|
16
|
+
* Start time of this bucket
|
|
17
|
+
*/
|
|
18
|
+
timestamp: Date;
|
|
19
|
+
/**
|
|
20
|
+
* Total amount of all invoices issued in this bucket (all statuses, by issuedAt)
|
|
21
|
+
*/
|
|
22
|
+
issuedInvoices: string;
|
|
23
|
+
/**
|
|
24
|
+
* Amount of written-off invoices in dollars for this bucket (by writtenOffAt)
|
|
25
|
+
*/
|
|
26
|
+
writtenOffInvoices: string;
|
|
27
|
+
/**
|
|
28
|
+
* Revenue from completed payments in dollars for this bucket
|
|
29
|
+
*/
|
|
30
|
+
completedPayments: string;
|
|
31
|
+
/**
|
|
32
|
+
* Per-group trend entries (only present when groupBy is specified)
|
|
33
|
+
*/
|
|
34
|
+
groupBreakdown?: Array<GroupTrendEntry> | undefined;
|
|
35
|
+
};
|
|
36
|
+
|
|
37
|
+
/** @internal */
|
|
38
|
+
export const RevenueTrendBucket$inboundSchema: z.ZodType<
|
|
39
|
+
RevenueTrendBucket,
|
|
40
|
+
z.ZodTypeDef,
|
|
41
|
+
unknown
|
|
42
|
+
> = z.object({
|
|
43
|
+
timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v)),
|
|
44
|
+
issuedInvoices: z.string(),
|
|
45
|
+
writtenOffInvoices: z.string(),
|
|
46
|
+
completedPayments: z.string(),
|
|
47
|
+
groupBreakdown: z.array(GroupTrendEntry$inboundSchema).optional(),
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
export function revenueTrendBucketFromJSON(
|
|
51
|
+
jsonString: string,
|
|
52
|
+
): SafeParseResult<RevenueTrendBucket, SDKValidationError> {
|
|
53
|
+
return safeParse(
|
|
54
|
+
jsonString,
|
|
55
|
+
(x) => RevenueTrendBucket$inboundSchema.parse(JSON.parse(x)),
|
|
56
|
+
`Failed to parse 'RevenueTrendBucket' from JSON`,
|
|
57
|
+
);
|
|
58
|
+
}
|
|
@@ -84,6 +84,34 @@ export const SubscriptionStatusEnum = {
|
|
|
84
84
|
} as const;
|
|
85
85
|
export type SubscriptionStatusEnum = ClosedEnum<typeof SubscriptionStatusEnum>;
|
|
86
86
|
|
|
87
|
+
export type Merchant = {
|
|
88
|
+
id: string;
|
|
89
|
+
name: string;
|
|
90
|
+
email: string;
|
|
91
|
+
};
|
|
92
|
+
|
|
93
|
+
export type Consumer = {
|
|
94
|
+
id: string;
|
|
95
|
+
name: string;
|
|
96
|
+
email: string;
|
|
97
|
+
};
|
|
98
|
+
|
|
99
|
+
/**
|
|
100
|
+
* Customer details with merchant and consumer information. Only included when include=customer is specified in the list query.
|
|
101
|
+
*/
|
|
102
|
+
export type SubscriptionCustomer = {
|
|
103
|
+
/**
|
|
104
|
+
* Customer ID
|
|
105
|
+
*/
|
|
106
|
+
id?: string | undefined;
|
|
107
|
+
/**
|
|
108
|
+
* Merchant organization ID
|
|
109
|
+
*/
|
|
110
|
+
merchantId?: string | undefined;
|
|
111
|
+
merchant?: Merchant | undefined;
|
|
112
|
+
consumer?: Consumer | undefined;
|
|
113
|
+
};
|
|
114
|
+
|
|
87
115
|
export type Subscription = {
|
|
88
116
|
id: string;
|
|
89
117
|
object: SubscriptionObject;
|
|
@@ -144,6 +172,10 @@ export type Subscription = {
|
|
|
144
172
|
* Number of days before renewal to send the reminder. Null means use plan default.
|
|
145
173
|
*/
|
|
146
174
|
renewalReminderDays?: number | null | undefined;
|
|
175
|
+
/**
|
|
176
|
+
* Customer details with merchant and consumer information. Only included when include=customer is specified in the list query.
|
|
177
|
+
*/
|
|
178
|
+
customer?: SubscriptionCustomer | undefined;
|
|
147
179
|
};
|
|
148
180
|
|
|
149
181
|
/** @internal */
|
|
@@ -241,6 +273,70 @@ export const SubscriptionStatusEnum$inboundSchema: z.ZodNativeEnum<
|
|
|
241
273
|
typeof SubscriptionStatusEnum
|
|
242
274
|
> = z.nativeEnum(SubscriptionStatusEnum);
|
|
243
275
|
|
|
276
|
+
/** @internal */
|
|
277
|
+
export const Merchant$inboundSchema: z.ZodType<
|
|
278
|
+
Merchant,
|
|
279
|
+
z.ZodTypeDef,
|
|
280
|
+
unknown
|
|
281
|
+
> = z.object({
|
|
282
|
+
id: z.string(),
|
|
283
|
+
name: z.string(),
|
|
284
|
+
email: z.string(),
|
|
285
|
+
});
|
|
286
|
+
|
|
287
|
+
export function merchantFromJSON(
|
|
288
|
+
jsonString: string,
|
|
289
|
+
): SafeParseResult<Merchant, SDKValidationError> {
|
|
290
|
+
return safeParse(
|
|
291
|
+
jsonString,
|
|
292
|
+
(x) => Merchant$inboundSchema.parse(JSON.parse(x)),
|
|
293
|
+
`Failed to parse 'Merchant' from JSON`,
|
|
294
|
+
);
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
/** @internal */
|
|
298
|
+
export const Consumer$inboundSchema: z.ZodType<
|
|
299
|
+
Consumer,
|
|
300
|
+
z.ZodTypeDef,
|
|
301
|
+
unknown
|
|
302
|
+
> = z.object({
|
|
303
|
+
id: z.string(),
|
|
304
|
+
name: z.string(),
|
|
305
|
+
email: z.string(),
|
|
306
|
+
});
|
|
307
|
+
|
|
308
|
+
export function consumerFromJSON(
|
|
309
|
+
jsonString: string,
|
|
310
|
+
): SafeParseResult<Consumer, SDKValidationError> {
|
|
311
|
+
return safeParse(
|
|
312
|
+
jsonString,
|
|
313
|
+
(x) => Consumer$inboundSchema.parse(JSON.parse(x)),
|
|
314
|
+
`Failed to parse 'Consumer' from JSON`,
|
|
315
|
+
);
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
/** @internal */
|
|
319
|
+
export const SubscriptionCustomer$inboundSchema: z.ZodType<
|
|
320
|
+
SubscriptionCustomer,
|
|
321
|
+
z.ZodTypeDef,
|
|
322
|
+
unknown
|
|
323
|
+
> = z.object({
|
|
324
|
+
id: z.string().optional(),
|
|
325
|
+
merchantId: z.string().optional(),
|
|
326
|
+
merchant: z.lazy(() => Merchant$inboundSchema).optional(),
|
|
327
|
+
consumer: z.lazy(() => Consumer$inboundSchema).optional(),
|
|
328
|
+
});
|
|
329
|
+
|
|
330
|
+
export function subscriptionCustomerFromJSON(
|
|
331
|
+
jsonString: string,
|
|
332
|
+
): SafeParseResult<SubscriptionCustomer, SDKValidationError> {
|
|
333
|
+
return safeParse(
|
|
334
|
+
jsonString,
|
|
335
|
+
(x) => SubscriptionCustomer$inboundSchema.parse(JSON.parse(x)),
|
|
336
|
+
`Failed to parse 'SubscriptionCustomer' from JSON`,
|
|
337
|
+
);
|
|
338
|
+
}
|
|
339
|
+
|
|
244
340
|
/** @internal */
|
|
245
341
|
export const Subscription$inboundSchema: z.ZodType<
|
|
246
342
|
Subscription,
|
|
@@ -276,6 +372,7 @@ export const Subscription$inboundSchema: z.ZodType<
|
|
|
276
372
|
walletId: z.string().optional(),
|
|
277
373
|
renewalReminderEnabled: z.nullable(z.boolean()).optional(),
|
|
278
374
|
renewalReminderDays: z.nullable(z.number().int()).optional(),
|
|
375
|
+
customer: z.lazy(() => SubscriptionCustomer$inboundSchema).optional(),
|
|
279
376
|
});
|
|
280
377
|
|
|
281
378
|
export function subscriptionFromJSON(
|
package/src/sdk/entitlements.ts
CHANGED
|
@@ -9,8 +9,14 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
|
|
|
9
9
|
import * as models from "../models/index.js";
|
|
10
10
|
import * as operations from "../models/operations/index.js";
|
|
11
11
|
import { unwrapAsync } from "../types/fp.js";
|
|
12
|
+
import { Grants } from "./grants.js";
|
|
12
13
|
|
|
13
14
|
export class Entitlements extends ClientSDK {
|
|
15
|
+
private _grants?: Grants;
|
|
16
|
+
get grants(): Grants {
|
|
17
|
+
return (this._grants ??= new Grants(this._options));
|
|
18
|
+
}
|
|
19
|
+
|
|
14
20
|
/**
|
|
15
21
|
* List Entitlements
|
|
16
22
|
*
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { entitlementsGrantsCreate } from "../funcs/entitlementsGrantsCreate.js";
|
|
6
|
+
import { entitlementsGrantsGet } from "../funcs/entitlementsGrantsGet.js";
|
|
7
|
+
import { entitlementsGrantsList } from "../funcs/entitlementsGrantsList.js";
|
|
8
|
+
import { entitlementsGrantsPurchase } from "../funcs/entitlementsGrantsPurchase.js";
|
|
9
|
+
import { entitlementsGrantsVoid } from "../funcs/entitlementsGrantsVoid.js";
|
|
10
|
+
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
|
|
11
|
+
import * as models from "../models/index.js";
|
|
12
|
+
import * as operations from "../models/operations/index.js";
|
|
13
|
+
import { unwrapAsync } from "../types/fp.js";
|
|
14
|
+
|
|
15
|
+
export class Grants extends ClientSDK {
|
|
16
|
+
/**
|
|
17
|
+
* List Grants
|
|
18
|
+
*
|
|
19
|
+
* @remarks
|
|
20
|
+
* List grants for a metered entitlement. Active grants are returned by default; pass `includeVoided=true` to include voided grants.
|
|
21
|
+
*/
|
|
22
|
+
async list(
|
|
23
|
+
request: operations.ListEntitlementGrantsRequest,
|
|
24
|
+
options?: RequestOptions,
|
|
25
|
+
): Promise<operations.ListEntitlementGrantsResponse> {
|
|
26
|
+
return unwrapAsync(entitlementsGrantsList(
|
|
27
|
+
this,
|
|
28
|
+
request,
|
|
29
|
+
options,
|
|
30
|
+
));
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Create Grant
|
|
35
|
+
*
|
|
36
|
+
* @remarks
|
|
37
|
+
* Create a grant directly for a metered entitlement, crediting the customer's balance immediately. The entitlement must belong to an active v1 subscription.
|
|
38
|
+
*/
|
|
39
|
+
async create(
|
|
40
|
+
request: operations.CreateEntitlementGrantRequest,
|
|
41
|
+
options?: RequestOptions,
|
|
42
|
+
): Promise<models.Grant> {
|
|
43
|
+
return unwrapAsync(entitlementsGrantsCreate(
|
|
44
|
+
this,
|
|
45
|
+
request,
|
|
46
|
+
options,
|
|
47
|
+
));
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Purchase Grant
|
|
52
|
+
*
|
|
53
|
+
* @remarks
|
|
54
|
+
* Create an ad-hoc invoice with a payment session for a grant purchase. The customer pays via the returned payment URL; the grant is created automatically on payment completion. If payment expires, the invoice is cancelled and no grant is created.
|
|
55
|
+
*
|
|
56
|
+
* After the consumer completes payment, the grant is created automatically. To confirm payment completion, poll `GET /v2/invoices/{invoiceId}` using the `invoiceId` from the response and check for `status === "PAID"`. Recommended polling interval: 2 seconds, timeout: 60 seconds.
|
|
57
|
+
*/
|
|
58
|
+
async purchase(
|
|
59
|
+
request: operations.PurchaseEntitlementGrantRequest,
|
|
60
|
+
options?: RequestOptions,
|
|
61
|
+
): Promise<models.PurchaseGrantResponse> {
|
|
62
|
+
return unwrapAsync(entitlementsGrantsPurchase(
|
|
63
|
+
this,
|
|
64
|
+
request,
|
|
65
|
+
options,
|
|
66
|
+
));
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
/**
|
|
70
|
+
* Get Grant
|
|
71
|
+
*
|
|
72
|
+
* @remarks
|
|
73
|
+
* Retrieve a specific grant by ID.
|
|
74
|
+
*/
|
|
75
|
+
async get(
|
|
76
|
+
request: operations.GetEntitlementGrantRequest,
|
|
77
|
+
options?: RequestOptions,
|
|
78
|
+
): Promise<models.Grant> {
|
|
79
|
+
return unwrapAsync(entitlementsGrantsGet(
|
|
80
|
+
this,
|
|
81
|
+
request,
|
|
82
|
+
options,
|
|
83
|
+
));
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* Void Grant
|
|
88
|
+
*
|
|
89
|
+
* @remarks
|
|
90
|
+
* Void a grant, removing it from the customer's balance. This operation is idempotent — voiding an already-voided grant returns the voided grant without error.
|
|
91
|
+
*/
|
|
92
|
+
async void(
|
|
93
|
+
request: operations.VoidEntitlementGrantRequest,
|
|
94
|
+
options?: RequestOptions,
|
|
95
|
+
): Promise<models.Grant> {
|
|
96
|
+
return unwrapAsync(entitlementsGrantsVoid(
|
|
97
|
+
this,
|
|
98
|
+
request,
|
|
99
|
+
options,
|
|
100
|
+
));
|
|
101
|
+
}
|
|
102
|
+
}
|
package/src/sdk/revenue.ts
CHANGED
|
@@ -10,15 +10,15 @@ import { unwrapAsync } from "../types/fp.js";
|
|
|
10
10
|
|
|
11
11
|
export class Revenue extends ClientSDK {
|
|
12
12
|
/**
|
|
13
|
-
* Get revenue
|
|
13
|
+
* Get revenue summary
|
|
14
14
|
*
|
|
15
15
|
* @remarks
|
|
16
|
-
* Returns
|
|
16
|
+
* Returns revenue summary with invoice and payment breakdowns (outstanding/paid/writtenOff), plus a time-series trend. Revenue is sourced from all issued invoices (v0 + v1) and completed payments.
|
|
17
17
|
*/
|
|
18
18
|
async get(
|
|
19
19
|
request: operations.GetRevenueRequest,
|
|
20
20
|
options?: RequestOptions,
|
|
21
|
-
): Promise<models.
|
|
21
|
+
): Promise<models.RevenueSummaryResponse> {
|
|
22
22
|
return unwrapAsync(revenueGet(
|
|
23
23
|
this,
|
|
24
24
|
request,
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
import * as z from "zod/v3";
|
|
2
|
-
import { Result as SafeParseResult } from "../types/fp.js";
|
|
3
|
-
import { SDKValidationError } from "./errors/sdkvalidationerror.js";
|
|
4
|
-
export type RevenueStats = {
|
|
5
|
-
/**
|
|
6
|
-
* Revenue from usage charges in dollars
|
|
7
|
-
*/
|
|
8
|
-
usageRevenue?: string | undefined;
|
|
9
|
-
/**
|
|
10
|
-
* Revenue from fee charges in dollars
|
|
11
|
-
*/
|
|
12
|
-
feeRevenue?: string | undefined;
|
|
13
|
-
/**
|
|
14
|
-
* Total refund amount in dollars
|
|
15
|
-
*/
|
|
16
|
-
refundAmount?: string | undefined;
|
|
17
|
-
/**
|
|
18
|
-
* Net revenue in dollars (usage + fees - refunds)
|
|
19
|
-
*/
|
|
20
|
-
netRevenue?: string | undefined;
|
|
21
|
-
/**
|
|
22
|
-
* Number of usage charge events
|
|
23
|
-
*/
|
|
24
|
-
usageCount?: number | undefined;
|
|
25
|
-
/**
|
|
26
|
-
* Number of fee charge events
|
|
27
|
-
*/
|
|
28
|
-
feeCount?: number | undefined;
|
|
29
|
-
/**
|
|
30
|
-
* Number of usage refund events
|
|
31
|
-
*/
|
|
32
|
-
usageRefundCount?: number | undefined;
|
|
33
|
-
/**
|
|
34
|
-
* Number of fee refund events
|
|
35
|
-
*/
|
|
36
|
-
feeRefundCount?: number | undefined;
|
|
37
|
-
};
|
|
38
|
-
/** @internal */
|
|
39
|
-
export declare const RevenueStats$inboundSchema: z.ZodType<RevenueStats, z.ZodTypeDef, unknown>;
|
|
40
|
-
export declare function revenueStatsFromJSON(jsonString: string): SafeParseResult<RevenueStats, SDKValidationError>;
|
|
41
|
-
//# sourceMappingURL=revenuestats.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"revenuestats.d.ts","sourceRoot":"","sources":["../../../src/models/revenuestats.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACrC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAChD,YAAY,EACZ,CAAC,CAAC,UAAU,EACZ,OAAO,CAUP,CAAC;AAEH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAMnD"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"revenuestats.js","sourceRoot":"","sources":["../../../src/models/revenuestats.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DH,oDAQC;AAhED,0CAA4B;AAC5B,kDAA8C;AAuC9C,gBAAgB;AACH,QAAA,0BAA0B,GAInC,CAAC,CAAC,MAAM,CAAC;IACX,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACvC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACrC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC7C,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAEH,SAAgB,oBAAoB,CAClC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,kCAA0B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACtD,0CAA0C,CAC3C,CAAC;AACJ,CAAC"}
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
import * as z from "zod/v3";
|
|
2
|
-
import { Result as SafeParseResult } from "../types/fp.js";
|
|
3
|
-
import { SDKValidationError } from "./errors/sdkvalidationerror.js";
|
|
4
|
-
import { RevenueStats } from "./revenuestats.js";
|
|
5
|
-
export type RevenueTimeBucket = {
|
|
6
|
-
/**
|
|
7
|
-
* Start time of this bucket
|
|
8
|
-
*/
|
|
9
|
-
timestamp: Date;
|
|
10
|
-
/**
|
|
11
|
-
* Revenue stats per subscription ID. May include 'other' for subscriptions outside top N.
|
|
12
|
-
*/
|
|
13
|
-
subscriptionStats?: {
|
|
14
|
-
[k: string]: RevenueStats;
|
|
15
|
-
} | undefined;
|
|
16
|
-
totalStats?: RevenueStats | undefined;
|
|
17
|
-
};
|
|
18
|
-
/** @internal */
|
|
19
|
-
export declare const RevenueTimeBucket$inboundSchema: z.ZodType<RevenueTimeBucket, z.ZodTypeDef, unknown>;
|
|
20
|
-
export declare function revenueTimeBucketFromJSON(jsonString: string): SafeParseResult<RevenueTimeBucket, SDKValidationError>;
|
|
21
|
-
//# sourceMappingURL=revenuetimebucket.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"revenuetimebucket.d.ts","sourceRoot":"","sources":["../../../src/models/revenuetimebucket.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,YAAY,EAA8B,MAAM,mBAAmB,CAAC;AAE7E,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,SAAS,EAAE,IAAI,CAAC;IAChB;;OAEG;IACH,iBAAiB,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,YAAY,CAAA;KAAE,GAAG,SAAS,CAAC;IAC9D,UAAU,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,OAAO,CACrD,iBAAiB,EACjB,CAAC,CAAC,UAAU,EACZ,OAAO,CAKP,CAAC;AAEH,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAMxD"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"revenuetimebucket.js","sourceRoot":"","sources":["../../../src/models/revenuetimebucket.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BH,8DAQC;AArCD,0CAA4B;AAC5B,kDAA8C;AAG9C,uDAA6E;AAc7E,gBAAgB;AACH,QAAA,+BAA+B,GAIxC,CAAC,CAAC,MAAM,CAAC;IACX,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;IAC5E,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC,4CAA0B,CAAC,CAAC,QAAQ,EAAE;IAClE,UAAU,EAAE,4CAA0B,CAAC,QAAQ,EAAE;CAClD,CAAC,CAAC;AAEH,SAAgB,yBAAyB,CACvC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,uCAA+B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC3D,+CAA+C,CAChD,CAAC;AACJ,CAAC"}
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
import * as z from "zod/v3";
|
|
2
|
-
import { Result as SafeParseResult } from "../types/fp.js";
|
|
3
|
-
import { SDKValidationError } from "./errors/sdkvalidationerror.js";
|
|
4
|
-
import { RevenueTimeBucket } from "./revenuetimebucket.js";
|
|
5
|
-
export type RevenueTimeSeriesResponse = {
|
|
6
|
-
/**
|
|
7
|
-
* Object type identifier
|
|
8
|
-
*/
|
|
9
|
-
object: "revenue_time_series";
|
|
10
|
-
/**
|
|
11
|
-
* Time-bucketed revenue data
|
|
12
|
-
*/
|
|
13
|
-
buckets: Array<RevenueTimeBucket>;
|
|
14
|
-
};
|
|
15
|
-
/** @internal */
|
|
16
|
-
export declare const RevenueTimeSeriesResponse$inboundSchema: z.ZodType<RevenueTimeSeriesResponse, z.ZodTypeDef, unknown>;
|
|
17
|
-
export declare function revenueTimeSeriesResponseFromJSON(jsonString: string): SafeParseResult<RevenueTimeSeriesResponse, SDKValidationError>;
|
|
18
|
-
//# sourceMappingURL=revenuetimeseriesresponse.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"revenuetimeseriesresponse.d.ts","sourceRoot":"","sources":["../../../src/models/revenuetimeseriesresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EACL,iBAAiB,EAElB,MAAM,wBAAwB,CAAC;AAEhC,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC;IAC9B;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;CACnC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,OAAO,CAC7D,yBAAyB,EACzB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,iCAAiC,CAC/C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,yBAAyB,EAAE,kBAAkB,CAAC,CAMhE"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"revenuetimeseriesresponse.js","sourceRoot":"","sources":["../../../src/models/revenuetimeseriesresponse.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCH,8EAQC;AAtCD,0CAA4B;AAC5B,kDAA8C;AAG9C,iEAGgC;AAahC,gBAAgB;AACH,QAAA,uCAAuC,GAIhD,CAAC,CAAC,MAAM,CAAC;IACX,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAAC;IACxC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,sDAA+B,CAAC;CAClD,CAAC,CAAC;AAEH,SAAgB,iCAAiC,CAC/C,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,+CAAuC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACnE,uDAAuD,CACxD,CAAC;AACJ,CAAC"}
|