@paygentic/sdk 0.7.0 → 0.7.2
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 +13 -3
- package/dist/commonjs/funcs/billableMetricsListEvents.js +1 -0
- package/dist/commonjs/funcs/billableMetricsListEvents.js.map +1 -1
- package/dist/commonjs/funcs/invoicesV2List.js +1 -0
- package/dist/commonjs/funcs/invoicesV2List.js.map +1 -1
- package/dist/commonjs/funcs/paymentSessionsListPaymentSessions.d.ts +18 -0
- package/dist/commonjs/funcs/paymentSessionsListPaymentSessions.d.ts.map +1 -0
- package/dist/commonjs/funcs/paymentSessionsListPaymentSessions.js +127 -0
- package/dist/commonjs/funcs/paymentSessionsListPaymentSessions.js.map +1 -0
- package/dist/commonjs/funcs/profitabilityGetProfitability.d.ts +19 -0
- package/dist/commonjs/funcs/profitabilityGetProfitability.d.ts.map +1 -0
- package/dist/commonjs/funcs/profitabilityGetProfitability.js +127 -0
- package/dist/commonjs/funcs/profitabilityGetProfitability.js.map +1 -0
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/models/index.d.ts +4 -0
- package/dist/commonjs/models/index.d.ts.map +1 -1
- package/dist/commonjs/models/index.js +4 -0
- package/dist/commonjs/models/index.js.map +1 -1
- package/dist/commonjs/models/meterevent.d.ts +4 -0
- package/dist/commonjs/models/meterevent.d.ts.map +1 -1
- package/dist/commonjs/models/meterevent.js +1 -0
- package/dist/commonjs/models/meterevent.js.map +1 -1
- package/dist/commonjs/models/offsetpagination.d.ts +4 -4
- package/dist/commonjs/models/offsetpagination.d.ts.map +1 -1
- package/dist/commonjs/models/offsetpagination.js +3 -3
- package/dist/commonjs/models/offsetpagination.js.map +1 -1
- package/dist/commonjs/models/operations/createplan.d.ts +5 -0
- package/dist/commonjs/models/operations/createplan.d.ts.map +1 -1
- package/dist/commonjs/models/operations/createplan.js +2 -0
- package/dist/commonjs/models/operations/createplan.js.map +1 -1
- package/dist/commonjs/models/operations/getprofitability.d.ts +55 -0
- package/dist/commonjs/models/operations/getprofitability.d.ts.map +1 -0
- package/dist/commonjs/models/operations/getprofitability.js +64 -0
- package/dist/commonjs/models/operations/getprofitability.js.map +1 -0
- package/dist/commonjs/models/operations/getrevenue.d.ts +4 -4
- package/dist/commonjs/models/operations/getrevenue.d.ts.map +1 -1
- package/dist/commonjs/models/operations/getrevenue.js +4 -5
- package/dist/commonjs/models/operations/getrevenue.js.map +1 -1
- package/dist/commonjs/models/operations/index.d.ts +2 -0
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +2 -0
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/listbillablemetricevents.d.ts +5 -0
- package/dist/commonjs/models/operations/listbillablemetricevents.d.ts.map +1 -1
- package/dist/commonjs/models/operations/listbillablemetricevents.js +1 -0
- package/dist/commonjs/models/operations/listbillablemetricevents.js.map +1 -1
- package/dist/commonjs/models/operations/listinvoices.d.ts +9 -0
- package/dist/commonjs/models/operations/listinvoices.d.ts.map +1 -1
- package/dist/commonjs/models/operations/listinvoices.js +2 -0
- package/dist/commonjs/models/operations/listinvoices.js.map +1 -1
- package/dist/commonjs/models/operations/listpaymentsessions.d.ts +36 -10
- package/dist/commonjs/models/operations/listpaymentsessions.d.ts.map +1 -1
- package/dist/commonjs/models/operations/listpaymentsessions.js +19 -4
- package/dist/commonjs/models/operations/listpaymentsessions.js.map +1 -1
- package/dist/commonjs/models/operations/updateplan.d.ts +5 -0
- package/dist/commonjs/models/operations/updateplan.d.ts.map +1 -1
- package/dist/commonjs/models/operations/updateplan.js +2 -0
- package/dist/commonjs/models/operations/updateplan.js.map +1 -1
- package/dist/commonjs/models/paymentsession.d.ts +68 -0
- package/dist/commonjs/models/paymentsession.d.ts.map +1 -0
- package/dist/commonjs/models/paymentsession.js +78 -0
- package/dist/commonjs/models/paymentsession.js.map +1 -0
- package/dist/commonjs/models/plan.d.ts +4 -0
- package/dist/commonjs/models/plan.d.ts.map +1 -1
- package/dist/commonjs/models/plan.js +1 -0
- package/dist/commonjs/models/plan.js.map +1 -1
- package/dist/commonjs/models/profitabilityrow.d.ts +38 -0
- package/dist/commonjs/models/profitabilityrow.d.ts.map +1 -0
- package/dist/commonjs/models/profitabilityrow.js +57 -0
- package/dist/commonjs/models/profitabilityrow.js.map +1 -0
- package/dist/commonjs/models/profitabilitysummaryresponse.d.ts +26 -0
- package/dist/commonjs/models/profitabilitysummaryresponse.d.ts.map +1 -0
- package/dist/commonjs/models/profitabilitysummaryresponse.js +54 -0
- package/dist/commonjs/models/profitabilitysummaryresponse.js.map +1 -0
- package/dist/commonjs/models/profitabilitytrend.d.ts +17 -0
- package/dist/commonjs/models/profitabilitytrend.d.ts.map +1 -0
- package/dist/commonjs/models/profitabilitytrend.js +51 -0
- package/dist/commonjs/models/profitabilitytrend.js.map +1 -0
- package/dist/commonjs/models/purchasegrantresponse.d.ts +4 -4
- package/dist/commonjs/models/purchasegrantresponse.d.ts.map +1 -1
- package/dist/commonjs/models/purchasegrantresponse.js +6 -6
- package/dist/commonjs/models/purchasegrantresponse.js.map +1 -1
- package/dist/commonjs/sdk/paymentsessions.d.ts +12 -0
- package/dist/commonjs/sdk/paymentsessions.d.ts.map +1 -0
- package/dist/commonjs/sdk/paymentsessions.js +22 -0
- package/dist/commonjs/sdk/paymentsessions.js.map +1 -0
- package/dist/commonjs/sdk/profitability.d.ts +13 -0
- package/dist/commonjs/sdk/profitability.d.ts.map +1 -0
- package/dist/commonjs/sdk/profitability.js +22 -0
- package/dist/commonjs/sdk/profitability.js.map +1 -0
- package/dist/commonjs/sdk/sdk.d.ts +6 -0
- package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
- package/dist/commonjs/sdk/sdk.js +8 -0
- package/dist/commonjs/sdk/sdk.js.map +1 -1
- package/dist/esm/funcs/billableMetricsListEvents.js +1 -0
- package/dist/esm/funcs/billableMetricsListEvents.js.map +1 -1
- package/dist/esm/funcs/invoicesV2List.js +1 -0
- package/dist/esm/funcs/invoicesV2List.js.map +1 -1
- package/dist/esm/funcs/paymentSessionsListPaymentSessions.d.ts +18 -0
- package/dist/esm/funcs/paymentSessionsListPaymentSessions.d.ts.map +1 -0
- package/dist/esm/funcs/paymentSessionsListPaymentSessions.js +91 -0
- package/dist/esm/funcs/paymentSessionsListPaymentSessions.js.map +1 -0
- package/dist/esm/funcs/profitabilityGetProfitability.d.ts +19 -0
- package/dist/esm/funcs/profitabilityGetProfitability.d.ts.map +1 -0
- package/dist/esm/funcs/profitabilityGetProfitability.js +91 -0
- package/dist/esm/funcs/profitabilityGetProfitability.js.map +1 -0
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/models/index.d.ts +4 -0
- package/dist/esm/models/index.d.ts.map +1 -1
- package/dist/esm/models/index.js +4 -0
- package/dist/esm/models/index.js.map +1 -1
- package/dist/esm/models/meterevent.d.ts +4 -0
- package/dist/esm/models/meterevent.d.ts.map +1 -1
- package/dist/esm/models/meterevent.js +1 -0
- package/dist/esm/models/meterevent.js.map +1 -1
- package/dist/esm/models/offsetpagination.d.ts +4 -4
- package/dist/esm/models/offsetpagination.d.ts.map +1 -1
- package/dist/esm/models/offsetpagination.js +3 -3
- package/dist/esm/models/offsetpagination.js.map +1 -1
- package/dist/esm/models/operations/createplan.d.ts +5 -0
- package/dist/esm/models/operations/createplan.d.ts.map +1 -1
- package/dist/esm/models/operations/createplan.js +2 -0
- package/dist/esm/models/operations/createplan.js.map +1 -1
- package/dist/esm/models/operations/getprofitability.d.ts +55 -0
- package/dist/esm/models/operations/getprofitability.d.ts.map +1 -0
- package/dist/esm/models/operations/getprofitability.js +27 -0
- package/dist/esm/models/operations/getprofitability.js.map +1 -0
- package/dist/esm/models/operations/getrevenue.d.ts +4 -4
- package/dist/esm/models/operations/getrevenue.d.ts.map +1 -1
- package/dist/esm/models/operations/getrevenue.js +3 -4
- package/dist/esm/models/operations/getrevenue.js.map +1 -1
- package/dist/esm/models/operations/index.d.ts +2 -0
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +2 -0
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/listbillablemetricevents.d.ts +5 -0
- package/dist/esm/models/operations/listbillablemetricevents.d.ts.map +1 -1
- package/dist/esm/models/operations/listbillablemetricevents.js +1 -0
- package/dist/esm/models/operations/listbillablemetricevents.js.map +1 -1
- package/dist/esm/models/operations/listinvoices.d.ts +9 -0
- package/dist/esm/models/operations/listinvoices.d.ts.map +1 -1
- package/dist/esm/models/operations/listinvoices.js +2 -0
- package/dist/esm/models/operations/listinvoices.js.map +1 -1
- package/dist/esm/models/operations/listpaymentsessions.d.ts +36 -10
- package/dist/esm/models/operations/listpaymentsessions.d.ts.map +1 -1
- package/dist/esm/models/operations/listpaymentsessions.js +18 -3
- package/dist/esm/models/operations/listpaymentsessions.js.map +1 -1
- package/dist/esm/models/operations/updateplan.d.ts +5 -0
- package/dist/esm/models/operations/updateplan.d.ts.map +1 -1
- package/dist/esm/models/operations/updateplan.js +2 -0
- package/dist/esm/models/operations/updateplan.js.map +1 -1
- package/dist/esm/models/paymentsession.d.ts +68 -0
- package/dist/esm/models/paymentsession.d.ts.map +1 -0
- package/dist/esm/models/paymentsession.js +41 -0
- package/dist/esm/models/paymentsession.js.map +1 -0
- package/dist/esm/models/plan.d.ts +4 -0
- package/dist/esm/models/plan.d.ts.map +1 -1
- package/dist/esm/models/plan.js +1 -0
- package/dist/esm/models/plan.js.map +1 -1
- package/dist/esm/models/profitabilityrow.d.ts +38 -0
- package/dist/esm/models/profitabilityrow.d.ts.map +1 -0
- package/dist/esm/models/profitabilityrow.js +20 -0
- package/dist/esm/models/profitabilityrow.js.map +1 -0
- package/dist/esm/models/profitabilitysummaryresponse.d.ts +26 -0
- package/dist/esm/models/profitabilitysummaryresponse.d.ts.map +1 -0
- package/dist/esm/models/profitabilitysummaryresponse.js +17 -0
- package/dist/esm/models/profitabilitysummaryresponse.js.map +1 -0
- package/dist/esm/models/profitabilitytrend.d.ts +17 -0
- package/dist/esm/models/profitabilitytrend.d.ts.map +1 -0
- package/dist/esm/models/profitabilitytrend.js +14 -0
- package/dist/esm/models/profitabilitytrend.js.map +1 -0
- package/dist/esm/models/purchasegrantresponse.d.ts +4 -4
- package/dist/esm/models/purchasegrantresponse.d.ts.map +1 -1
- package/dist/esm/models/purchasegrantresponse.js +4 -4
- package/dist/esm/models/purchasegrantresponse.js.map +1 -1
- package/dist/esm/sdk/paymentsessions.d.ts +12 -0
- package/dist/esm/sdk/paymentsessions.d.ts.map +1 -0
- package/dist/esm/sdk/paymentsessions.js +18 -0
- package/dist/esm/sdk/paymentsessions.js.map +1 -0
- package/dist/esm/sdk/profitability.d.ts +13 -0
- package/dist/esm/sdk/profitability.d.ts.map +1 -0
- package/dist/esm/sdk/profitability.js +18 -0
- package/dist/esm/sdk/profitability.js.map +1 -0
- package/dist/esm/sdk/sdk.d.ts +6 -0
- package/dist/esm/sdk/sdk.d.ts.map +1 -1
- package/dist/esm/sdk/sdk.js +8 -0
- package/dist/esm/sdk/sdk.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/billableMetricsListEvents.ts +1 -0
- package/src/funcs/invoicesV2List.ts +1 -0
- package/src/funcs/paymentSessionsListPaymentSessions.ts +183 -0
- package/src/funcs/profitabilityGetProfitability.ts +184 -0
- package/src/lib/config.ts +2 -2
- package/src/models/index.ts +4 -0
- package/src/models/meterevent.ts +5 -0
- package/src/models/offsetpagination.ts +7 -7
- package/src/models/operations/createplan.ts +7 -0
- package/src/models/operations/getprofitability.ts +85 -0
- package/src/models/operations/getrevenue.ts +7 -6
- package/src/models/operations/index.ts +2 -0
- package/src/models/operations/listbillablemetricevents.ts +6 -0
- package/src/models/operations/listinvoices.ts +11 -0
- package/src/models/operations/listpaymentsessions.ts +43 -12
- package/src/models/operations/updateplan.ts +7 -0
- package/src/models/paymentsession.ts +109 -0
- package/src/models/plan.ts +7 -0
- package/src/models/profitabilityrow.ts +68 -0
- package/src/models/profitabilitysummaryresponse.ts +53 -0
- package/src/models/profitabilitytrend.ts +39 -0
- package/src/models/purchasegrantresponse.ts +12 -9
- package/src/sdk/paymentsessions.ts +27 -0
- package/src/sdk/profitability.ts +28 -0
- package/src/sdk/sdk.ts +12 -0
|
@@ -15,7 +15,7 @@ export type PurchaseGrantResponseObject = ClosedEnum<
|
|
|
15
15
|
typeof PurchaseGrantResponseObject
|
|
16
16
|
>;
|
|
17
17
|
|
|
18
|
-
export type
|
|
18
|
+
export type PurchaseGrantResponsePaymentSession = {
|
|
19
19
|
/**
|
|
20
20
|
* The Stripe checkout URL for the customer to complete payment.
|
|
21
21
|
*/
|
|
@@ -55,7 +55,7 @@ export type PurchaseGrantResponse = {
|
|
|
55
55
|
/**
|
|
56
56
|
* Payment session(s) for the customer to complete the purchase.
|
|
57
57
|
*/
|
|
58
|
-
paymentSessions: Array<
|
|
58
|
+
paymentSessions: Array<PurchaseGrantResponsePaymentSession>;
|
|
59
59
|
};
|
|
60
60
|
|
|
61
61
|
/** @internal */
|
|
@@ -64,8 +64,8 @@ export const PurchaseGrantResponseObject$inboundSchema: z.ZodNativeEnum<
|
|
|
64
64
|
> = z.nativeEnum(PurchaseGrantResponseObject);
|
|
65
65
|
|
|
66
66
|
/** @internal */
|
|
67
|
-
export const
|
|
68
|
-
|
|
67
|
+
export const PurchaseGrantResponsePaymentSession$inboundSchema: z.ZodType<
|
|
68
|
+
PurchaseGrantResponsePaymentSession,
|
|
69
69
|
z.ZodTypeDef,
|
|
70
70
|
unknown
|
|
71
71
|
> = z.object({
|
|
@@ -76,13 +76,14 @@ export const PaymentSession$inboundSchema: z.ZodType<
|
|
|
76
76
|
amount: z.number().optional(),
|
|
77
77
|
});
|
|
78
78
|
|
|
79
|
-
export function
|
|
79
|
+
export function purchaseGrantResponsePaymentSessionFromJSON(
|
|
80
80
|
jsonString: string,
|
|
81
|
-
): SafeParseResult<
|
|
81
|
+
): SafeParseResult<PurchaseGrantResponsePaymentSession, SDKValidationError> {
|
|
82
82
|
return safeParse(
|
|
83
83
|
jsonString,
|
|
84
|
-
(x) =>
|
|
85
|
-
|
|
84
|
+
(x) =>
|
|
85
|
+
PurchaseGrantResponsePaymentSession$inboundSchema.parse(JSON.parse(x)),
|
|
86
|
+
`Failed to parse 'PurchaseGrantResponsePaymentSession' from JSON`,
|
|
86
87
|
);
|
|
87
88
|
}
|
|
88
89
|
|
|
@@ -98,7 +99,9 @@ export const PurchaseGrantResponse$inboundSchema: z.ZodType<
|
|
|
98
99
|
grantAmount: z.number().int(),
|
|
99
100
|
price: z.string(),
|
|
100
101
|
currency: z.string(),
|
|
101
|
-
paymentSessions: z.array(
|
|
102
|
+
paymentSessions: z.array(
|
|
103
|
+
z.lazy(() => PurchaseGrantResponsePaymentSession$inboundSchema),
|
|
104
|
+
),
|
|
102
105
|
});
|
|
103
106
|
|
|
104
107
|
export function purchaseGrantResponseFromJSON(
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { paymentSessionsListPaymentSessions } from "../funcs/paymentSessionsListPaymentSessions.js";
|
|
6
|
+
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
|
|
7
|
+
import * as operations from "../models/operations/index.js";
|
|
8
|
+
import { unwrapAsync } from "../types/fp.js";
|
|
9
|
+
|
|
10
|
+
export class PaymentSessions extends ClientSDK {
|
|
11
|
+
/**
|
|
12
|
+
* List
|
|
13
|
+
*
|
|
14
|
+
* @remarks
|
|
15
|
+
* List payment sessions for the authenticated merchant with optional filters. Supports filtering by subscriptionId, customerId, status, and entityType. When subscriptionId is provided the result includes both the subscription's own activation session (entityType='subscription') and any session attached to invoices for that subscription (entityType='invoice').
|
|
16
|
+
*/
|
|
17
|
+
async listPaymentSessions(
|
|
18
|
+
request?: operations.ListPaymentSessionsRequest | undefined,
|
|
19
|
+
options?: RequestOptions,
|
|
20
|
+
): Promise<operations.ListPaymentSessionsResponse> {
|
|
21
|
+
return unwrapAsync(paymentSessionsListPaymentSessions(
|
|
22
|
+
this,
|
|
23
|
+
request,
|
|
24
|
+
options,
|
|
25
|
+
));
|
|
26
|
+
}
|
|
27
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { profitabilityGetProfitability } from "../funcs/profitabilityGetProfitability.js";
|
|
6
|
+
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
|
|
7
|
+
import * as models from "../models/index.js";
|
|
8
|
+
import * as operations from "../models/operations/index.js";
|
|
9
|
+
import { unwrapAsync } from "../types/fp.js";
|
|
10
|
+
|
|
11
|
+
export class Profitability extends ClientSDK {
|
|
12
|
+
/**
|
|
13
|
+
* Get profitability summary
|
|
14
|
+
*
|
|
15
|
+
* @remarks
|
|
16
|
+
* Returns a per-customer profitability summary for a merchant over a date range. Each row aggregates revenue (from issued + paid invoices), cost (from metered cost discovery), profit, and margin. Customers are ranked by profit descending and capped at topN; the remainder is rolled into a single self-consistent 'Other' row whose revenue, cost, and profit reflect the same set of customers. Rows are inner-joined against the merchant's customer list, so orphaned meter subjects from deleted or unknown customers are dropped.
|
|
17
|
+
*/
|
|
18
|
+
async getProfitability(
|
|
19
|
+
request: operations.GetProfitabilityRequest,
|
|
20
|
+
options?: RequestOptions,
|
|
21
|
+
): Promise<models.ProfitabilitySummaryResponse> {
|
|
22
|
+
return unwrapAsync(profitabilityGetProfitability(
|
|
23
|
+
this,
|
|
24
|
+
request,
|
|
25
|
+
options,
|
|
26
|
+
));
|
|
27
|
+
}
|
|
28
|
+
}
|
package/src/sdk/sdk.ts
CHANGED
|
@@ -12,9 +12,11 @@ import { Features } from "./features.js";
|
|
|
12
12
|
import { Fees } from "./fees.js";
|
|
13
13
|
import { InvoicesV2 } from "./invoicesv2.js";
|
|
14
14
|
import { Payments } from "./payments.js";
|
|
15
|
+
import { PaymentSessions } from "./paymentsessions.js";
|
|
15
16
|
import { Plans } from "./plans.js";
|
|
16
17
|
import { Prices } from "./prices.js";
|
|
17
18
|
import { Products } from "./products.js";
|
|
19
|
+
import { Profitability } from "./profitability.js";
|
|
18
20
|
import { Revenue } from "./revenue.js";
|
|
19
21
|
import { Sources } from "./sources.js";
|
|
20
22
|
import { Subscriptions } from "./subscriptions.js";
|
|
@@ -87,6 +89,11 @@ export class Paygentic extends ClientSDK {
|
|
|
87
89
|
return (this._payments ??= new Payments(this._options));
|
|
88
90
|
}
|
|
89
91
|
|
|
92
|
+
private _paymentSessions?: PaymentSessions;
|
|
93
|
+
get paymentSessions(): PaymentSessions {
|
|
94
|
+
return (this._paymentSessions ??= new PaymentSessions(this._options));
|
|
95
|
+
}
|
|
96
|
+
|
|
90
97
|
private _events?: Events;
|
|
91
98
|
get events(): Events {
|
|
92
99
|
return (this._events ??= new Events(this._options));
|
|
@@ -102,6 +109,11 @@ export class Paygentic extends ClientSDK {
|
|
|
102
109
|
return (this._revenue ??= new Revenue(this._options));
|
|
103
110
|
}
|
|
104
111
|
|
|
112
|
+
private _profitability?: Profitability;
|
|
113
|
+
get profitability(): Profitability {
|
|
114
|
+
return (this._profitability ??= new Profitability(this._options));
|
|
115
|
+
}
|
|
116
|
+
|
|
105
117
|
private _testClocks?: TestClocks;
|
|
106
118
|
get testClocks(): TestClocks {
|
|
107
119
|
return (this._testClocks ??= new TestClocks(this._options));
|