integrateledger 0.1.0 → 0.1.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 +76 -72
- package/dist/commonjs/funcs/publish-catalog.js +1 -1
- package/dist/commonjs/funcs/publish-catalog.js.map +1 -1
- package/dist/commonjs/funcs/set-customer-overage-cap.d.ts +16 -0
- package/dist/commonjs/funcs/set-customer-overage-cap.d.ts.map +1 -0
- package/dist/commonjs/funcs/set-customer-overage-cap.js +122 -0
- package/dist/commonjs/funcs/set-customer-overage-cap.js.map +1 -0
- package/dist/commonjs/funcs/set-customer-overage-override.d.ts +16 -0
- package/dist/commonjs/funcs/set-customer-overage-override.d.ts.map +1 -0
- package/dist/commonjs/funcs/set-customer-overage-override.js +122 -0
- package/dist/commonjs/funcs/set-customer-overage-override.js.map +1 -0
- package/dist/commonjs/funcs/set-subscription-cancellation.js +1 -1
- package/dist/commonjs/funcs/set-subscription-cancellation.js.map +1 -1
- package/dist/commonjs/funcs/update-add-on.js +1 -1
- package/dist/commonjs/funcs/update-add-on.js.map +1 -1
- package/dist/commonjs/funcs/update-feature.js +1 -1
- package/dist/commonjs/funcs/update-feature.js.map +1 -1
- package/dist/commonjs/funcs/update-plan.js +1 -1
- package/dist/commonjs/funcs/update-plan.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/models/catalog-input.d.ts +15 -0
- package/dist/commonjs/models/catalog-input.d.ts.map +1 -1
- package/dist/commonjs/models/catalog-input.js +3 -0
- package/dist/commonjs/models/catalog-input.js.map +1 -1
- package/dist/commonjs/models/check-response.d.ts +3 -0
- package/dist/commonjs/models/check-response.d.ts.map +1 -1
- package/dist/commonjs/models/check-response.js.map +1 -1
- package/dist/commonjs/models/create-plan-input.d.ts +15 -0
- package/dist/commonjs/models/create-plan-input.d.ts.map +1 -1
- package/dist/commonjs/models/create-plan-input.js +3 -0
- package/dist/commonjs/models/create-plan-input.js.map +1 -1
- package/dist/commonjs/models/customer-detail.d.ts +6 -0
- package/dist/commonjs/models/customer-detail.d.ts.map +1 -1
- package/dist/commonjs/models/customer-detail.js +3 -0
- package/dist/commonjs/models/customer-detail.js.map +1 -1
- package/dist/commonjs/models/customer-overage-cap.d.ts +13 -0
- package/dist/commonjs/models/customer-overage-cap.d.ts.map +1 -0
- package/dist/commonjs/models/customer-overage-cap.js +54 -0
- package/dist/commonjs/models/customer-overage-cap.js.map +1 -0
- package/dist/commonjs/models/customer-overage-override-result.d.ts +18 -0
- package/dist/commonjs/models/customer-overage-override-result.d.ts.map +1 -0
- package/dist/commonjs/models/customer-overage-override-result.js +56 -0
- package/dist/commonjs/models/customer-overage-override-result.js.map +1 -0
- package/dist/commonjs/models/customer-overage-override.d.ts +23 -0
- package/dist/commonjs/models/customer-overage-override.d.ts.map +1 -0
- package/dist/commonjs/models/customer-overage-override.js +55 -0
- package/dist/commonjs/models/customer-overage-override.js.map +1 -0
- package/dist/commonjs/models/customer-overage.d.ts +67 -0
- package/dist/commonjs/models/customer-overage.d.ts.map +1 -0
- package/dist/commonjs/models/customer-overage.js +83 -0
- package/dist/commonjs/models/customer-overage.js.map +1 -0
- package/dist/commonjs/models/errors/track-error.d.ts +2 -0
- package/dist/commonjs/models/errors/track-error.d.ts.map +1 -1
- package/dist/commonjs/models/errors/track-error.js +5 -0
- package/dist/commonjs/models/errors/track-error.js.map +1 -1
- package/dist/commonjs/models/index.d.ts +6 -0
- package/dist/commonjs/models/index.d.ts.map +1 -1
- package/dist/commonjs/models/index.js +6 -0
- package/dist/commonjs/models/index.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/set-customer-overage-cap.d.ts +15 -0
- package/dist/commonjs/models/operations/set-customer-overage-cap.d.ts.map +1 -0
- package/dist/commonjs/models/operations/set-customer-overage-cap.js +51 -0
- package/dist/commonjs/models/operations/set-customer-overage-cap.js.map +1 -0
- package/dist/commonjs/models/operations/set-customer-overage-override.d.ts +15 -0
- package/dist/commonjs/models/operations/set-customer-overage-override.d.ts.map +1 -0
- package/dist/commonjs/models/operations/set-customer-overage-override.js +51 -0
- package/dist/commonjs/models/operations/set-customer-overage-override.js.map +1 -0
- package/dist/commonjs/models/plan-item.d.ts +12 -0
- package/dist/commonjs/models/plan-item.d.ts.map +1 -1
- package/dist/commonjs/models/plan-item.js +3 -0
- package/dist/commonjs/models/plan-item.js.map +1 -1
- package/dist/commonjs/models/set-customer-overage-cap-input.d.ts +15 -0
- package/dist/commonjs/models/set-customer-overage-cap-input.d.ts.map +1 -0
- package/dist/commonjs/models/set-customer-overage-cap-input.js +49 -0
- package/dist/commonjs/models/set-customer-overage-cap-input.js.map +1 -0
- package/dist/commonjs/models/set-customer-overage-override-input.d.ts +30 -0
- package/dist/commonjs/models/set-customer-overage-override-input.d.ts.map +1 -0
- package/dist/commonjs/models/set-customer-overage-override-input.js +52 -0
- package/dist/commonjs/models/set-customer-overage-override-input.js.map +1 -0
- package/dist/commonjs/models/track-response.d.ts +11 -0
- package/dist/commonjs/models/track-response.d.ts.map +1 -1
- package/dist/commonjs/models/track-response.js +2 -0
- package/dist/commonjs/models/track-response.js.map +1 -1
- package/dist/commonjs/models/update-plan-input.d.ts +15 -0
- package/dist/commonjs/models/update-plan-input.d.ts.map +1 -1
- package/dist/commonjs/models/update-plan-input.js +3 -0
- package/dist/commonjs/models/update-plan-input.js.map +1 -1
- package/dist/commonjs/sdk/sdk.d.ts +8 -0
- package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
- package/dist/commonjs/sdk/sdk.js +14 -0
- package/dist/commonjs/sdk/sdk.js.map +1 -1
- package/dist/esm/funcs/publish-catalog.js +1 -1
- package/dist/esm/funcs/publish-catalog.js.map +1 -1
- package/dist/esm/funcs/set-customer-overage-cap.d.ts +16 -0
- package/dist/esm/funcs/set-customer-overage-cap.d.ts.map +1 -0
- package/dist/esm/funcs/set-customer-overage-cap.js +86 -0
- package/dist/esm/funcs/set-customer-overage-cap.js.map +1 -0
- package/dist/esm/funcs/set-customer-overage-override.d.ts +16 -0
- package/dist/esm/funcs/set-customer-overage-override.d.ts.map +1 -0
- package/dist/esm/funcs/set-customer-overage-override.js +86 -0
- package/dist/esm/funcs/set-customer-overage-override.js.map +1 -0
- package/dist/esm/funcs/set-subscription-cancellation.js +1 -1
- package/dist/esm/funcs/set-subscription-cancellation.js.map +1 -1
- package/dist/esm/funcs/update-add-on.js +1 -1
- package/dist/esm/funcs/update-add-on.js.map +1 -1
- package/dist/esm/funcs/update-feature.js +1 -1
- package/dist/esm/funcs/update-feature.js.map +1 -1
- package/dist/esm/funcs/update-plan.js +1 -1
- package/dist/esm/funcs/update-plan.js.map +1 -1
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/models/catalog-input.d.ts +15 -0
- package/dist/esm/models/catalog-input.d.ts.map +1 -1
- package/dist/esm/models/catalog-input.js +3 -0
- package/dist/esm/models/catalog-input.js.map +1 -1
- package/dist/esm/models/check-response.d.ts +3 -0
- package/dist/esm/models/check-response.d.ts.map +1 -1
- package/dist/esm/models/check-response.js.map +1 -1
- package/dist/esm/models/create-plan-input.d.ts +15 -0
- package/dist/esm/models/create-plan-input.d.ts.map +1 -1
- package/dist/esm/models/create-plan-input.js +3 -0
- package/dist/esm/models/create-plan-input.js.map +1 -1
- package/dist/esm/models/customer-detail.d.ts +6 -0
- package/dist/esm/models/customer-detail.d.ts.map +1 -1
- package/dist/esm/models/customer-detail.js +3 -0
- package/dist/esm/models/customer-detail.js.map +1 -1
- package/dist/esm/models/customer-overage-cap.d.ts +13 -0
- package/dist/esm/models/customer-overage-cap.d.ts.map +1 -0
- package/dist/esm/models/customer-overage-cap.js +17 -0
- package/dist/esm/models/customer-overage-cap.js.map +1 -0
- package/dist/esm/models/customer-overage-override-result.d.ts +18 -0
- package/dist/esm/models/customer-overage-override-result.d.ts.map +1 -0
- package/dist/esm/models/customer-overage-override-result.js +19 -0
- package/dist/esm/models/customer-overage-override-result.js.map +1 -0
- package/dist/esm/models/customer-overage-override.d.ts +23 -0
- package/dist/esm/models/customer-overage-override.d.ts.map +1 -0
- package/dist/esm/models/customer-overage-override.js +18 -0
- package/dist/esm/models/customer-overage-override.js.map +1 -0
- package/dist/esm/models/customer-overage.d.ts +67 -0
- package/dist/esm/models/customer-overage.d.ts.map +1 -0
- package/dist/esm/models/customer-overage.js +46 -0
- package/dist/esm/models/customer-overage.js.map +1 -0
- package/dist/esm/models/errors/track-error.d.ts +2 -0
- package/dist/esm/models/errors/track-error.d.ts.map +1 -1
- package/dist/esm/models/errors/track-error.js +5 -0
- package/dist/esm/models/errors/track-error.js.map +1 -1
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/esm/models/index.d.ts.map +1 -1
- package/dist/esm/models/index.js +6 -0
- package/dist/esm/models/index.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/set-customer-overage-cap.d.ts +15 -0
- package/dist/esm/models/operations/set-customer-overage-cap.d.ts.map +1 -0
- package/dist/esm/models/operations/set-customer-overage-cap.js +14 -0
- package/dist/esm/models/operations/set-customer-overage-cap.js.map +1 -0
- package/dist/esm/models/operations/set-customer-overage-override.d.ts +15 -0
- package/dist/esm/models/operations/set-customer-overage-override.d.ts.map +1 -0
- package/dist/esm/models/operations/set-customer-overage-override.js +14 -0
- package/dist/esm/models/operations/set-customer-overage-override.js.map +1 -0
- package/dist/esm/models/plan-item.d.ts +12 -0
- package/dist/esm/models/plan-item.d.ts.map +1 -1
- package/dist/esm/models/plan-item.js +3 -0
- package/dist/esm/models/plan-item.js.map +1 -1
- package/dist/esm/models/set-customer-overage-cap-input.d.ts +15 -0
- package/dist/esm/models/set-customer-overage-cap-input.d.ts.map +1 -0
- package/dist/esm/models/set-customer-overage-cap-input.js +12 -0
- package/dist/esm/models/set-customer-overage-cap-input.js.map +1 -0
- package/dist/esm/models/set-customer-overage-override-input.d.ts +30 -0
- package/dist/esm/models/set-customer-overage-override-input.d.ts.map +1 -0
- package/dist/esm/models/set-customer-overage-override-input.js +15 -0
- package/dist/esm/models/set-customer-overage-override-input.js.map +1 -0
- package/dist/esm/models/track-response.d.ts +11 -0
- package/dist/esm/models/track-response.d.ts.map +1 -1
- package/dist/esm/models/track-response.js +2 -0
- package/dist/esm/models/track-response.js.map +1 -1
- package/dist/esm/models/update-plan-input.d.ts +15 -0
- package/dist/esm/models/update-plan-input.d.ts.map +1 -1
- package/dist/esm/models/update-plan-input.js +3 -0
- package/dist/esm/models/update-plan-input.js.map +1 -1
- package/dist/esm/sdk/sdk.d.ts +8 -0
- package/dist/esm/sdk/sdk.d.ts.map +1 -1
- package/dist/esm/sdk/sdk.js +14 -0
- package/dist/esm/sdk/sdk.js.map +1 -1
- package/docs/models/cap-source.md +19 -0
- package/docs/models/check-response.md +5 -5
- package/docs/models/create-plan-input.md +9 -6
- package/docs/models/customer-detail.md +28 -6
- package/docs/models/customer-overage-cap.md +39 -0
- package/docs/models/customer-overage-override-result.md +47 -0
- package/docs/models/customer-overage-override.md +27 -0
- package/docs/models/customer-overage.md +37 -0
- package/docs/models/errors/track-error.md +6 -5
- package/docs/models/operations/set-customer-overage-cap-request.md +21 -0
- package/docs/models/operations/set-customer-overage-override-request.md +21 -0
- package/docs/models/plan-item.md +10 -7
- package/docs/models/plan.md +9 -6
- package/docs/models/set-customer-overage-cap-input.md +17 -0
- package/docs/models/set-customer-overage-override-input.md +20 -0
- package/docs/models/source.md +19 -0
- package/docs/models/track-response.md +12 -8
- package/docs/models/update-plan-input.md +8 -5
- package/docs/sdks/ledger/README.md +167 -5
- package/package.json +2 -2
- package/src/funcs/publish-catalog.ts +1 -1
- package/src/funcs/set-customer-overage-cap.ts +176 -0
- package/src/funcs/set-customer-overage-override.ts +179 -0
- package/src/funcs/set-subscription-cancellation.ts +1 -1
- package/src/funcs/update-add-on.ts +1 -1
- package/src/funcs/update-feature.ts +1 -1
- package/src/funcs/update-plan.ts +1 -1
- package/src/lib/config.ts +2 -2
- package/src/models/catalog-input.ts +18 -0
- package/src/models/check-response.ts +3 -0
- package/src/models/create-plan-input.ts +18 -0
- package/src/models/customer-detail.ts +11 -0
- package/src/models/customer-overage-cap.ts +39 -0
- package/src/models/customer-overage-override-result.ts +48 -0
- package/src/models/customer-overage-override.ts +48 -0
- package/src/models/customer-overage.ts +108 -0
- package/src/models/errors/track-error.ts +6 -0
- package/src/models/index.ts +6 -0
- package/src/models/operations/index.ts +2 -0
- package/src/models/operations/set-customer-overage-cap.ts +36 -0
- package/src/models/operations/set-customer-overage-override.ts +36 -0
- package/src/models/plan-item.ts +15 -0
- package/src/models/set-customer-overage-cap-input.ts +33 -0
- package/src/models/set-customer-overage-override-input.ts +53 -0
- package/src/models/track-response.ts +13 -0
- package/src/models/update-plan-input.ts +18 -0
- package/src/sdk/sdk.ts +30 -0
|
@@ -8,6 +8,18 @@ export type UpdatePlanInput = {
|
|
|
8
8
|
name: string;
|
|
9
9
|
monthlyCredits: number;
|
|
10
10
|
monthlyPriceCents: number;
|
|
11
|
+
/**
|
|
12
|
+
* Price in cents per overageBillingUnits credits used after the plan's credits and packs run out. Null or omitted: no overage.
|
|
13
|
+
*/
|
|
14
|
+
overageUnitAmountCents?: number | null | undefined;
|
|
15
|
+
/**
|
|
16
|
+
* Credits billed per overageUnitAmountCents. Defaults to 1.
|
|
17
|
+
*/
|
|
18
|
+
overageBillingUnits?: number | undefined;
|
|
19
|
+
/**
|
|
20
|
+
* Default monthly overage spend cap in cents. A customer's own cap replaces it. Null or omitted: no cap.
|
|
21
|
+
*/
|
|
22
|
+
overageCapCents?: number | null | undefined;
|
|
11
23
|
};
|
|
12
24
|
|
|
13
25
|
/** @internal */
|
|
@@ -15,6 +27,9 @@ export type UpdatePlanInput$Outbound = {
|
|
|
15
27
|
name: string;
|
|
16
28
|
monthlyCredits: number;
|
|
17
29
|
monthlyPriceCents: number;
|
|
30
|
+
overageUnitAmountCents?: number | null | undefined;
|
|
31
|
+
overageBillingUnits?: number | undefined;
|
|
32
|
+
overageCapCents?: number | null | undefined;
|
|
18
33
|
};
|
|
19
34
|
|
|
20
35
|
/** @internal */
|
|
@@ -25,6 +40,9 @@ export const UpdatePlanInput$outboundSchema: z.ZodMiniType<
|
|
|
25
40
|
name: z.string(),
|
|
26
41
|
monthlyCredits: z.int(),
|
|
27
42
|
monthlyPriceCents: z.int(),
|
|
43
|
+
overageUnitAmountCents: z.optional(z.nullable(z.int())),
|
|
44
|
+
overageBillingUnits: z.optional(z.int()),
|
|
45
|
+
overageCapCents: z.optional(z.nullable(z.int())),
|
|
28
46
|
});
|
|
29
47
|
|
|
30
48
|
export function updatePlanInputToJSON(
|
package/src/sdk/sdk.ts
CHANGED
|
@@ -21,6 +21,8 @@ import { listCustomerSubscriptions } from "../funcs/list-customer-subscriptions.
|
|
|
21
21
|
import { listFeatures } from "../funcs/list-features.js";
|
|
22
22
|
import { listPlans } from "../funcs/list-plans.js";
|
|
23
23
|
import { publishCatalog } from "../funcs/publish-catalog.js";
|
|
24
|
+
import { setCustomerOverageCap } from "../funcs/set-customer-overage-cap.js";
|
|
25
|
+
import { setCustomerOverageOverride } from "../funcs/set-customer-overage-override.js";
|
|
24
26
|
import { setSubscriptionCancellation } from "../funcs/set-subscription-cancellation.js";
|
|
25
27
|
import { trackUsage } from "../funcs/track-usage.js";
|
|
26
28
|
import { updateAddOn } from "../funcs/update-add-on.js";
|
|
@@ -307,6 +309,34 @@ export class Ledger extends ClientSDK {
|
|
|
307
309
|
));
|
|
308
310
|
}
|
|
309
311
|
|
|
312
|
+
/**
|
|
313
|
+
* Set or clear a customer's overage cap
|
|
314
|
+
*/
|
|
315
|
+
async setCustomerOverageCap(
|
|
316
|
+
request: operations.SetCustomerOverageCapRequest,
|
|
317
|
+
options?: RequestOptions,
|
|
318
|
+
): Promise<models.CustomerOverageCap> {
|
|
319
|
+
return unwrapAsync(setCustomerOverageCap(
|
|
320
|
+
this,
|
|
321
|
+
request,
|
|
322
|
+
options,
|
|
323
|
+
));
|
|
324
|
+
}
|
|
325
|
+
|
|
326
|
+
/**
|
|
327
|
+
* Set or clear a customer's negotiated overage rate
|
|
328
|
+
*/
|
|
329
|
+
async setCustomerOverageOverride(
|
|
330
|
+
request: operations.SetCustomerOverageOverrideRequest,
|
|
331
|
+
options?: RequestOptions,
|
|
332
|
+
): Promise<models.CustomerOverageOverrideResult> {
|
|
333
|
+
return unwrapAsync(setCustomerOverageOverride(
|
|
334
|
+
this,
|
|
335
|
+
request,
|
|
336
|
+
options,
|
|
337
|
+
));
|
|
338
|
+
}
|
|
339
|
+
|
|
310
340
|
/**
|
|
311
341
|
* Get a customer and current balance
|
|
312
342
|
*/
|