@flexprice/sdk 2.1.37 → 2.1.39
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/FUNCTIONS.md +3 -6
- package/USAGE.md +1 -4
- package/docs/sdk/models/activity-actor.md +17 -0
- package/docs/sdk/models/activity-entity.md +17 -0
- package/docs/sdk/models/activity-pagination.md +17 -0
- package/docs/sdk/models/activity-response.md +25 -0
- package/docs/sdk/models/add-addon-to-subscription-response.md +22 -21
- package/docs/sdk/models/addon-association-response.md +22 -21
- package/docs/sdk/models/addon-price-sync-status-response.md +17 -0
- package/docs/sdk/models/addon-response.md +1 -0
- package/docs/sdk/models/cancel-subscription-request.md +1 -1
- package/docs/sdk/models/changed-addon-association.md +2 -1
- package/docs/sdk/models/changed-line-item.md +2 -1
- package/docs/sdk/models/checkout-configuration.md +1 -0
- package/docs/sdk/models/create-addon-response.md +1 -0
- package/docs/sdk/models/create-customer-request.md +1 -6
- package/docs/sdk/models/get-activity-request.md +17 -0
- package/docs/sdk/models/grouped-invoicing-action.md +2 -2
- package/docs/sdk/models/grouped-invoicing-change.md +16 -0
- package/docs/sdk/models/invoice-billing-reason.md +2 -2
- package/docs/sdk/models/list-activity-request.md +26 -0
- package/docs/sdk/models/list-activity-response.md +16 -0
- package/docs/sdk/models/pause-subscription-request-request.md +19 -0
- package/docs/sdk/models/pause-subscription-request.md +19 -0
- package/docs/sdk/models/pause-subscription-response.md +127 -0
- package/docs/sdk/models/payment-terms.md +1 -1
- package/docs/sdk/models/resume-subscription-request-request.md +19 -0
- package/docs/sdk/models/resume-subscription-request.md +18 -0
- package/docs/sdk/models/resume-subscription-response.md +127 -0
- package/docs/sdk/models/state.md +14 -0
- package/docs/sdk/models/sub-modify-grouped-invoicing-params.md +7 -6
- package/docs/sdk/models/subscription-pause-response.md +35 -0
- package/docs/sdk/models/sync-addon-prices-request.md +17 -0
- package/docs/sdk/models/update-customer-request-request.md +1 -7
- package/docs/sdk/models/update-customer-request.md +2 -4
- package/docs/sdks/activity/README.md +150 -0
- package/docs/sdks/addons/README.md +72 -0
- package/docs/sdks/customers/README.md +2 -8
- package/docs/sdks/subscriptions/README.md +146 -0
- package/esm/funcs/activity-get-activity.d.ts +17 -0
- package/esm/funcs/activity-get-activity.d.ts.map +1 -0
- package/esm/funcs/activity-get-activity.js +91 -0
- package/esm/funcs/activity-get-activity.js.map +1 -0
- package/esm/funcs/activity-list-activity.d.ts +17 -0
- package/esm/funcs/activity-list-activity.d.ts.map +1 -0
- package/esm/funcs/activity-list-activity.js +83 -0
- package/esm/funcs/activity-list-activity.js.map +1 -0
- package/esm/funcs/addons-sync-addon-prices.d.ts +17 -0
- package/esm/funcs/addons-sync-addon-prices.d.ts.map +1 -0
- package/esm/funcs/addons-sync-addon-prices.js +91 -0
- package/esm/funcs/addons-sync-addon-prices.js.map +1 -0
- package/esm/funcs/subscriptions-pause-subscription.d.ts +17 -0
- package/esm/funcs/subscriptions-pause-subscription.d.ts.map +1 -0
- package/esm/funcs/subscriptions-pause-subscription.js +93 -0
- package/esm/funcs/subscriptions-pause-subscription.js.map +1 -0
- package/esm/funcs/subscriptions-resume-subscription.d.ts +17 -0
- package/esm/funcs/subscriptions-resume-subscription.d.ts.map +1 -0
- package/esm/funcs/subscriptions-resume-subscription.js +93 -0
- package/esm/funcs/subscriptions-resume-subscription.js.map +1 -0
- package/esm/lib/config.d.ts +2 -2
- package/esm/lib/config.js +2 -2
- package/esm/sdk/activity.d.ts +19 -0
- package/esm/sdk/activity.d.ts.map +1 -0
- package/esm/sdk/activity.js +28 -0
- package/esm/sdk/activity.js.map +1 -0
- package/esm/sdk/addons.d.ts +7 -0
- package/esm/sdk/addons.d.ts.map +1 -1
- package/esm/sdk/addons.js +10 -0
- package/esm/sdk/addons.js.map +1 -1
- package/esm/sdk/models/activity-actor.d.ts +12 -0
- package/esm/sdk/models/activity-actor.d.ts.map +1 -0
- package/esm/sdk/models/activity-actor.js +16 -0
- package/esm/sdk/models/activity-actor.js.map +1 -0
- package/esm/sdk/models/activity-entity.d.ts +12 -0
- package/esm/sdk/models/activity-entity.d.ts.map +1 -0
- package/esm/sdk/models/activity-entity.js +16 -0
- package/esm/sdk/models/activity-entity.js.map +1 -0
- package/esm/sdk/models/activity-pagination.d.ts +12 -0
- package/esm/sdk/models/activity-pagination.d.ts.map +1 -0
- package/esm/sdk/models/activity-pagination.js +22 -0
- package/esm/sdk/models/activity-pagination.js.map +1 -0
- package/esm/sdk/models/activity-response.d.ts +26 -0
- package/esm/sdk/models/activity-response.d.ts.map +1 -0
- package/esm/sdk/models/activity-response.js +39 -0
- package/esm/sdk/models/activity-response.js.map +1 -0
- package/esm/sdk/models/add-addon-to-subscription-response.d.ts +7 -0
- package/esm/sdk/models/add-addon-to-subscription-response.d.ts.map +1 -1
- package/esm/sdk/models/add-addon-to-subscription-response.js +2 -0
- package/esm/sdk/models/add-addon-to-subscription-response.js.map +1 -1
- package/esm/sdk/models/addon-association-response.d.ts +7 -0
- package/esm/sdk/models/addon-association-response.d.ts.map +1 -1
- package/esm/sdk/models/addon-association-response.js +2 -0
- package/esm/sdk/models/addon-association-response.js.map +1 -1
- package/esm/sdk/models/addon-price-sync-status-response.d.ts +12 -0
- package/esm/sdk/models/addon-price-sync-status-response.d.ts.map +1 -0
- package/esm/sdk/models/addon-price-sync-status-response.js +22 -0
- package/esm/sdk/models/addon-price-sync-status-response.js.map +1 -0
- package/esm/sdk/models/addon-response.d.ts +2 -0
- package/esm/sdk/models/addon-response.d.ts.map +1 -1
- package/esm/sdk/models/addon-response.js +3 -0
- package/esm/sdk/models/addon-response.js.map +1 -1
- package/esm/sdk/models/cancel-subscription-request.d.ts +2 -2
- package/esm/sdk/models/cancel-subscription-request.js +2 -2
- package/esm/sdk/models/changed-addon-association.d.ts +1 -0
- package/esm/sdk/models/changed-addon-association.d.ts.map +1 -1
- package/esm/sdk/models/changed-addon-association.js +2 -0
- package/esm/sdk/models/changed-addon-association.js.map +1 -1
- package/esm/sdk/models/changed-line-item.d.ts +1 -0
- package/esm/sdk/models/changed-line-item.d.ts.map +1 -1
- package/esm/sdk/models/changed-line-item.js +2 -0
- package/esm/sdk/models/changed-line-item.js.map +1 -1
- package/esm/sdk/models/checkout-configuration.d.ts +2 -0
- package/esm/sdk/models/checkout-configuration.d.ts.map +1 -1
- package/esm/sdk/models/checkout-configuration.js +2 -0
- package/esm/sdk/models/checkout-configuration.js.map +1 -1
- package/esm/sdk/models/create-addon-response.d.ts +2 -0
- package/esm/sdk/models/create-addon-response.d.ts.map +1 -1
- package/esm/sdk/models/create-addon-response.js +3 -0
- package/esm/sdk/models/create-addon-response.js.map +1 -1
- package/esm/sdk/models/create-customer-request.d.ts +2 -2
- package/esm/sdk/models/create-customer-request.d.ts.map +1 -1
- package/esm/sdk/models/create-customer-request.js +1 -1
- package/esm/sdk/models/create-customer-request.js.map +1 -1
- package/esm/sdk/models/get-activity-op.d.ts +15 -0
- package/esm/sdk/models/get-activity-op.d.ts.map +1 -0
- package/esm/sdk/models/get-activity-op.js +12 -0
- package/esm/sdk/models/get-activity-op.js.map +1 -0
- package/esm/sdk/models/grouped-invoicing-action.d.ts +1 -0
- package/esm/sdk/models/grouped-invoicing-action.d.ts.map +1 -1
- package/esm/sdk/models/grouped-invoicing-action.js +1 -0
- package/esm/sdk/models/grouped-invoicing-action.js.map +1 -1
- package/esm/sdk/models/grouped-invoicing-change.d.ts +15 -0
- package/esm/sdk/models/grouped-invoicing-change.d.ts.map +1 -0
- package/esm/sdk/models/grouped-invoicing-change.js +20 -0
- package/esm/sdk/models/grouped-invoicing-change.js.map +1 -0
- package/esm/sdk/models/index.d.ts +17 -0
- package/esm/sdk/models/index.d.ts.map +1 -1
- package/esm/sdk/models/index.js +17 -0
- package/esm/sdk/models/index.js.map +1 -1
- package/esm/sdk/models/invoice-billing-reason.d.ts +2 -0
- package/esm/sdk/models/invoice-billing-reason.d.ts.map +1 -1
- package/esm/sdk/models/invoice-billing-reason.js +2 -0
- package/esm/sdk/models/invoice-billing-reason.js.map +1 -1
- package/esm/sdk/models/list-activity-request.d.ts +34 -0
- package/esm/sdk/models/list-activity-request.d.ts.map +1 -0
- package/esm/sdk/models/list-activity-request.js +35 -0
- package/esm/sdk/models/list-activity-request.js.map +1 -0
- package/esm/sdk/models/list-activity-response.d.ts +13 -0
- package/esm/sdk/models/list-activity-response.d.ts.map +1 -0
- package/esm/sdk/models/list-activity-response.js +17 -0
- package/esm/sdk/models/list-activity-response.js.map +1 -0
- package/esm/sdk/models/pause-subscription-op.d.ts +21 -0
- package/esm/sdk/models/pause-subscription-op.d.ts.map +1 -0
- package/esm/sdk/models/pause-subscription-op.js +14 -0
- package/esm/sdk/models/pause-subscription-op.js.map +1 -0
- package/esm/sdk/models/pause-subscription-request.d.ts +37 -0
- package/esm/sdk/models/pause-subscription-request.d.ts.map +1 -0
- package/esm/sdk/models/pause-subscription-request.js +20 -0
- package/esm/sdk/models/pause-subscription-request.js.map +1 -0
- package/esm/sdk/models/pause-subscription-response.d.ts +19 -0
- package/esm/sdk/models/pause-subscription-response.d.ts.map +1 -0
- package/esm/sdk/models/pause-subscription-response.js +17 -0
- package/esm/sdk/models/pause-subscription-response.js.map +1 -0
- package/esm/sdk/models/payment-terms.d.ts +2 -0
- package/esm/sdk/models/payment-terms.d.ts.map +1 -1
- package/esm/sdk/models/payment-terms.js +2 -0
- package/esm/sdk/models/payment-terms.js.map +1 -1
- package/esm/sdk/models/resume-subscription-op.d.ts +21 -0
- package/esm/sdk/models/resume-subscription-op.d.ts.map +1 -0
- package/esm/sdk/models/resume-subscription-op.js +14 -0
- package/esm/sdk/models/resume-subscription-op.js.map +1 -0
- package/esm/sdk/models/resume-subscription-request.d.ts +28 -0
- package/esm/sdk/models/resume-subscription-request.d.ts.map +1 -0
- package/esm/sdk/models/resume-subscription-request.js +19 -0
- package/esm/sdk/models/resume-subscription-request.js.map +1 -0
- package/esm/sdk/models/resume-subscription-response.d.ts +19 -0
- package/esm/sdk/models/resume-subscription-response.d.ts.map +1 -0
- package/esm/sdk/models/resume-subscription-response.js +17 -0
- package/esm/sdk/models/resume-subscription-response.js.map +1 -0
- package/esm/sdk/models/sub-modify-grouped-invoicing-params.d.ts +6 -0
- package/esm/sdk/models/sub-modify-grouped-invoicing-params.d.ts.map +1 -1
- package/esm/sdk/models/sub-modify-grouped-invoicing-params.js +2 -0
- package/esm/sdk/models/sub-modify-grouped-invoicing-params.js.map +1 -1
- package/esm/sdk/models/subscription-pause-response.d.ts +64 -0
- package/esm/sdk/models/subscription-pause-response.d.ts.map +1 -0
- package/esm/sdk/models/subscription-pause-response.js +55 -0
- package/esm/sdk/models/subscription-pause-response.js.map +1 -0
- package/esm/sdk/models/sync-addon-prices-op.d.ts +15 -0
- package/esm/sdk/models/sync-addon-prices-op.d.ts.map +1 -0
- package/esm/sdk/models/sync-addon-prices-op.js +12 -0
- package/esm/sdk/models/sync-addon-prices-op.js.map +1 -0
- package/esm/sdk/models/update-customer-request.d.ts +2 -2
- package/esm/sdk/models/update-customer-request.d.ts.map +1 -1
- package/esm/sdk/models/update-customer-request.js +1 -1
- package/esm/sdk/models/update-customer-request.js.map +1 -1
- package/esm/sdk/sdk.d.ts +3 -0
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +5 -0
- package/esm/sdk/sdk.js.map +1 -1
- package/esm/sdk/subscriptions.d.ts +14 -0
- package/esm/sdk/subscriptions.d.ts.map +1 -1
- package/esm/sdk/subscriptions.js +20 -0
- package/esm/sdk/subscriptions.js.map +1 -1
- package/examples/{addonsCreateAddon.example.ts → activityListActivity.example.ts} +2 -5
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/activity-get-activity.ts +181 -0
- package/src/funcs/activity-list-activity.ts +172 -0
- package/src/funcs/addons-sync-addon-prices.ts +181 -0
- package/src/funcs/subscriptions-pause-subscription.ts +187 -0
- package/src/funcs/subscriptions-resume-subscription.ts +187 -0
- package/src/lib/config.ts +2 -2
- package/src/sdk/activity.ts +45 -0
- package/src/sdk/addons.ts +18 -0
- package/src/sdk/models/activity-actor.ts +35 -0
- package/src/sdk/models/activity-entity.ts +35 -0
- package/src/sdk/models/activity-pagination.ts +44 -0
- package/src/sdk/models/activity-response.ts +85 -0
- package/src/sdk/models/add-addon-to-subscription-response.ts +9 -0
- package/src/sdk/models/addon-association-response.ts +9 -0
- package/src/sdk/models/addon-price-sync-status-response.ts +44 -0
- package/src/sdk/models/addon-response.ts +9 -0
- package/src/sdk/models/cancel-subscription-request.ts +4 -4
- package/src/sdk/models/changed-addon-association.ts +3 -0
- package/src/sdk/models/changed-line-item.ts +3 -0
- package/src/sdk/models/checkout-configuration.ts +4 -0
- package/src/sdk/models/create-addon-response.ts +9 -0
- package/src/sdk/models/create-customer-request.ts +3 -3
- package/src/sdk/models/get-activity-op.ts +33 -0
- package/src/sdk/models/grouped-invoicing-action.ts +1 -0
- package/src/sdk/models/grouped-invoicing-change.ts +47 -0
- package/src/sdk/models/index.ts +17 -0
- package/src/sdk/models/invoice-billing-reason.ts +2 -0
- package/src/sdk/models/list-activity-request.ts +78 -0
- package/src/sdk/models/list-activity-response.ts +41 -0
- package/src/sdk/models/pause-subscription-op.ts +46 -0
- package/src/sdk/models/pause-subscription-request.ts +64 -0
- package/src/sdk/models/pause-subscription-response.ts +47 -0
- package/src/sdk/models/payment-terms.ts +2 -0
- package/src/sdk/models/resume-subscription-op.ts +46 -0
- package/src/sdk/models/resume-subscription-request.ts +54 -0
- package/src/sdk/models/resume-subscription-response.ts +47 -0
- package/src/sdk/models/sub-modify-grouped-invoicing-params.ts +11 -0
- package/src/sdk/models/subscription-pause-response.ts +123 -0
- package/src/sdk/models/sync-addon-prices-op.ts +33 -0
- package/src/sdk/models/update-customer-request.ts +3 -3
- package/src/sdk/sdk.ts +6 -0
- package/src/sdk/subscriptions.ts +40 -0
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v4-mini";
|
|
6
|
+
import { remap as remap$ } from "../../lib/primitives.js";
|
|
7
|
+
import {
|
|
8
|
+
ProrationBehavior,
|
|
9
|
+
ProrationBehavior$outboundSchema,
|
|
10
|
+
} from "./proration-behavior.js";
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* Resumes a paused subscription now. The billing anchor is kept, so the first period runs from the resume time to the next billing date.
|
|
14
|
+
*/
|
|
15
|
+
export type ResumeSubscriptionRequest = {
|
|
16
|
+
/**
|
|
17
|
+
* Metadata merged into the pause
|
|
18
|
+
*
|
|
19
|
+
* @remarks
|
|
20
|
+
* @Example {"resumed_by": "admin"}
|
|
21
|
+
*/
|
|
22
|
+
metadata?: { [k: string]: string } | undefined;
|
|
23
|
+
prorationBehavior?: ProrationBehavior | undefined;
|
|
24
|
+
};
|
|
25
|
+
|
|
26
|
+
/** @internal */
|
|
27
|
+
export type ResumeSubscriptionRequest$Outbound = {
|
|
28
|
+
metadata?: { [k: string]: string } | undefined;
|
|
29
|
+
proration_behavior?: string | undefined;
|
|
30
|
+
};
|
|
31
|
+
|
|
32
|
+
/** @internal */
|
|
33
|
+
export const ResumeSubscriptionRequest$outboundSchema: z.ZodMiniType<
|
|
34
|
+
ResumeSubscriptionRequest$Outbound,
|
|
35
|
+
ResumeSubscriptionRequest
|
|
36
|
+
> = z.pipe(
|
|
37
|
+
z.object({
|
|
38
|
+
metadata: z.optional(z.record(z.string(), z.string())),
|
|
39
|
+
prorationBehavior: z.optional(ProrationBehavior$outboundSchema),
|
|
40
|
+
}),
|
|
41
|
+
z.transform((v) => {
|
|
42
|
+
return remap$(v, {
|
|
43
|
+
prorationBehavior: "proration_behavior",
|
|
44
|
+
});
|
|
45
|
+
}),
|
|
46
|
+
);
|
|
47
|
+
|
|
48
|
+
export function resumeSubscriptionRequestToJSON(
|
|
49
|
+
resumeSubscriptionRequest: ResumeSubscriptionRequest,
|
|
50
|
+
): string {
|
|
51
|
+
return JSON.stringify(
|
|
52
|
+
ResumeSubscriptionRequest$outboundSchema.parse(resumeSubscriptionRequest),
|
|
53
|
+
);
|
|
54
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v4-mini";
|
|
6
|
+
import { safeParse } from "../../lib/schemas.js";
|
|
7
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
8
|
+
import * as types from "../../types/primitives.js";
|
|
9
|
+
import { SDKValidationError } from "./sdk-validation-error.js";
|
|
10
|
+
import {
|
|
11
|
+
SubscriptionPauseResponse,
|
|
12
|
+
SubscriptionPauseResponse$inboundSchema,
|
|
13
|
+
} from "./subscription-pause-response.js";
|
|
14
|
+
import {
|
|
15
|
+
SubscriptionResponse,
|
|
16
|
+
SubscriptionResponse$inboundSchema,
|
|
17
|
+
} from "./subscription-response.js";
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* The resumed subscription and the pause it ended
|
|
21
|
+
*/
|
|
22
|
+
export type ResumeSubscriptionResponse = {
|
|
23
|
+
/**
|
|
24
|
+
* Response object containing subscription pause information
|
|
25
|
+
*/
|
|
26
|
+
pause?: SubscriptionPauseResponse | undefined;
|
|
27
|
+
subscription?: SubscriptionResponse | undefined;
|
|
28
|
+
};
|
|
29
|
+
|
|
30
|
+
/** @internal */
|
|
31
|
+
export const ResumeSubscriptionResponse$inboundSchema: z.ZodMiniType<
|
|
32
|
+
ResumeSubscriptionResponse,
|
|
33
|
+
unknown
|
|
34
|
+
> = z.object({
|
|
35
|
+
pause: types.optional(SubscriptionPauseResponse$inboundSchema),
|
|
36
|
+
subscription: types.optional(SubscriptionResponse$inboundSchema),
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
export function resumeSubscriptionResponseFromJSON(
|
|
40
|
+
jsonString: string,
|
|
41
|
+
): SafeParseResult<ResumeSubscriptionResponse, SDKValidationError> {
|
|
42
|
+
return safeParse(
|
|
43
|
+
jsonString,
|
|
44
|
+
(x) => ResumeSubscriptionResponse$inboundSchema.parse(JSON.parse(x)),
|
|
45
|
+
`Failed to parse 'ResumeSubscriptionResponse' from JSON`,
|
|
46
|
+
);
|
|
47
|
+
}
|
|
@@ -8,9 +8,18 @@ import {
|
|
|
8
8
|
GroupedInvoicingAction,
|
|
9
9
|
GroupedInvoicingAction$outboundSchema,
|
|
10
10
|
} from "./grouped-invoicing-action.js";
|
|
11
|
+
import {
|
|
12
|
+
GroupedInvoicingChange,
|
|
13
|
+
GroupedInvoicingChange$Outbound,
|
|
14
|
+
GroupedInvoicingChange$outboundSchema,
|
|
15
|
+
} from "./grouped-invoicing-change.js";
|
|
11
16
|
|
|
12
17
|
export type SubModifyGroupedInvoicingParams = {
|
|
13
18
|
action: GroupedInvoicingAction;
|
|
19
|
+
/**
|
|
20
|
+
* Changes is required for action 'modify'; the path subscription is the parent.
|
|
21
|
+
*/
|
|
22
|
+
changes?: Array<GroupedInvoicingChange> | undefined;
|
|
14
23
|
childSubscriptionIds?: Array<string> | undefined;
|
|
15
24
|
/**
|
|
16
25
|
* ParentSubscriptionID is required for action 'add'.
|
|
@@ -21,6 +30,7 @@ export type SubModifyGroupedInvoicingParams = {
|
|
|
21
30
|
/** @internal */
|
|
22
31
|
export type SubModifyGroupedInvoicingParams$Outbound = {
|
|
23
32
|
action: string;
|
|
33
|
+
changes?: Array<GroupedInvoicingChange$Outbound> | undefined;
|
|
24
34
|
child_subscription_ids?: Array<string> | undefined;
|
|
25
35
|
parent_subscription_id?: string | undefined;
|
|
26
36
|
};
|
|
@@ -32,6 +42,7 @@ export const SubModifyGroupedInvoicingParams$outboundSchema: z.ZodMiniType<
|
|
|
32
42
|
> = z.pipe(
|
|
33
43
|
z.object({
|
|
34
44
|
action: GroupedInvoicingAction$outboundSchema,
|
|
45
|
+
changes: z.optional(z.array(GroupedInvoicingChange$outboundSchema)),
|
|
35
46
|
childSubscriptionIds: z.optional(z.array(z.string())),
|
|
36
47
|
parentSubscriptionId: z.optional(z.string()),
|
|
37
48
|
}),
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v4-mini";
|
|
6
|
+
import { remap as remap$ } from "../../lib/primitives.js";
|
|
7
|
+
import { safeParse } from "../../lib/schemas.js";
|
|
8
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
9
|
+
import * as types from "../../types/primitives.js";
|
|
10
|
+
import { PauseMode, PauseMode$inboundSchema } from "./pause-mode.js";
|
|
11
|
+
import { PauseStatus, PauseStatus$inboundSchema } from "./pause-status.js";
|
|
12
|
+
import { ResumeMode, ResumeMode$inboundSchema } from "./resume-mode.js";
|
|
13
|
+
import { SDKValidationError } from "./sdk-validation-error.js";
|
|
14
|
+
import { Status, Status$inboundSchema } from "./status.js";
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Response object containing subscription pause information
|
|
18
|
+
*/
|
|
19
|
+
export type SubscriptionPauseResponse = {
|
|
20
|
+
createdAt?: Date | undefined;
|
|
21
|
+
createdBy?: string | undefined;
|
|
22
|
+
/**
|
|
23
|
+
* EnvironmentID is the environment identifier for the pause
|
|
24
|
+
*/
|
|
25
|
+
environmentId?: string | undefined;
|
|
26
|
+
/**
|
|
27
|
+
* ID is the unique identifier for the subscription pause
|
|
28
|
+
*/
|
|
29
|
+
id?: string | undefined;
|
|
30
|
+
metadata?: { [k: string]: string } | undefined;
|
|
31
|
+
/**
|
|
32
|
+
* OriginalPeriodEnd is the end of the billing period when the pause was created
|
|
33
|
+
*/
|
|
34
|
+
originalPeriodEnd?: Date | undefined;
|
|
35
|
+
/**
|
|
36
|
+
* OriginalPeriodStart is the start of the billing period when the pause was created
|
|
37
|
+
*/
|
|
38
|
+
originalPeriodStart?: Date | undefined;
|
|
39
|
+
/**
|
|
40
|
+
* PauseEnd is when the pause will end (null for indefinite)
|
|
41
|
+
*/
|
|
42
|
+
pauseEnd?: Date | undefined;
|
|
43
|
+
pauseMode?: PauseMode | undefined;
|
|
44
|
+
/**
|
|
45
|
+
* PauseStart is when the pause actually started
|
|
46
|
+
*/
|
|
47
|
+
pauseStart?: Date | undefined;
|
|
48
|
+
pauseStatus?: PauseStatus | undefined;
|
|
49
|
+
/**
|
|
50
|
+
* Reason is the reason for pausing
|
|
51
|
+
*/
|
|
52
|
+
reason?: string | undefined;
|
|
53
|
+
resumeMode?: ResumeMode | undefined;
|
|
54
|
+
/**
|
|
55
|
+
* ResumedAt is when the pause was actually ended (if manually resumed)
|
|
56
|
+
*/
|
|
57
|
+
resumedAt?: Date | undefined;
|
|
58
|
+
status?: Status | undefined;
|
|
59
|
+
/**
|
|
60
|
+
* SubscriptionID is the identifier for the subscription
|
|
61
|
+
*/
|
|
62
|
+
subscriptionId?: string | undefined;
|
|
63
|
+
tenantId?: string | undefined;
|
|
64
|
+
updatedAt?: Date | undefined;
|
|
65
|
+
updatedBy?: string | undefined;
|
|
66
|
+
};
|
|
67
|
+
|
|
68
|
+
/** @internal */
|
|
69
|
+
export const SubscriptionPauseResponse$inboundSchema: z.ZodMiniType<
|
|
70
|
+
SubscriptionPauseResponse,
|
|
71
|
+
unknown
|
|
72
|
+
> = z.pipe(
|
|
73
|
+
z.object({
|
|
74
|
+
created_at: types.optional(types.date()),
|
|
75
|
+
created_by: types.optional(types.string()),
|
|
76
|
+
environment_id: types.optional(types.string()),
|
|
77
|
+
id: types.optional(types.string()),
|
|
78
|
+
metadata: types.optional(z.record(z.string(), types.string())),
|
|
79
|
+
original_period_end: types.optional(types.date()),
|
|
80
|
+
original_period_start: types.optional(types.date()),
|
|
81
|
+
pause_end: types.optional(types.date()),
|
|
82
|
+
pause_mode: types.optional(PauseMode$inboundSchema),
|
|
83
|
+
pause_start: types.optional(types.date()),
|
|
84
|
+
pause_status: types.optional(PauseStatus$inboundSchema),
|
|
85
|
+
reason: types.optional(types.string()),
|
|
86
|
+
resume_mode: types.optional(ResumeMode$inboundSchema),
|
|
87
|
+
resumed_at: types.optional(types.date()),
|
|
88
|
+
status: types.optional(Status$inboundSchema),
|
|
89
|
+
subscription_id: types.optional(types.string()),
|
|
90
|
+
tenant_id: types.optional(types.string()),
|
|
91
|
+
updated_at: types.optional(types.date()),
|
|
92
|
+
updated_by: types.optional(types.string()),
|
|
93
|
+
}),
|
|
94
|
+
z.transform((v) => {
|
|
95
|
+
return remap$(v, {
|
|
96
|
+
"created_at": "createdAt",
|
|
97
|
+
"created_by": "createdBy",
|
|
98
|
+
"environment_id": "environmentId",
|
|
99
|
+
"original_period_end": "originalPeriodEnd",
|
|
100
|
+
"original_period_start": "originalPeriodStart",
|
|
101
|
+
"pause_end": "pauseEnd",
|
|
102
|
+
"pause_mode": "pauseMode",
|
|
103
|
+
"pause_start": "pauseStart",
|
|
104
|
+
"pause_status": "pauseStatus",
|
|
105
|
+
"resume_mode": "resumeMode",
|
|
106
|
+
"resumed_at": "resumedAt",
|
|
107
|
+
"subscription_id": "subscriptionId",
|
|
108
|
+
"tenant_id": "tenantId",
|
|
109
|
+
"updated_at": "updatedAt",
|
|
110
|
+
"updated_by": "updatedBy",
|
|
111
|
+
});
|
|
112
|
+
}),
|
|
113
|
+
);
|
|
114
|
+
|
|
115
|
+
export function subscriptionPauseResponseFromJSON(
|
|
116
|
+
jsonString: string,
|
|
117
|
+
): SafeParseResult<SubscriptionPauseResponse, SDKValidationError> {
|
|
118
|
+
return safeParse(
|
|
119
|
+
jsonString,
|
|
120
|
+
(x) => SubscriptionPauseResponse$inboundSchema.parse(JSON.parse(x)),
|
|
121
|
+
`Failed to parse 'SubscriptionPauseResponse' from JSON`,
|
|
122
|
+
);
|
|
123
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v4-mini";
|
|
6
|
+
|
|
7
|
+
export type SyncAddonPricesRequest = {
|
|
8
|
+
/**
|
|
9
|
+
* Addon ID
|
|
10
|
+
*/
|
|
11
|
+
id: string;
|
|
12
|
+
};
|
|
13
|
+
|
|
14
|
+
/** @internal */
|
|
15
|
+
export type SyncAddonPricesRequest$Outbound = {
|
|
16
|
+
id: string;
|
|
17
|
+
};
|
|
18
|
+
|
|
19
|
+
/** @internal */
|
|
20
|
+
export const SyncAddonPricesRequest$outboundSchema: z.ZodMiniType<
|
|
21
|
+
SyncAddonPricesRequest$Outbound,
|
|
22
|
+
SyncAddonPricesRequest
|
|
23
|
+
> = z.object({
|
|
24
|
+
id: z.string(),
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
export function syncAddonPricesRequestToJSON(
|
|
28
|
+
syncAddonPricesRequest: SyncAddonPricesRequest,
|
|
29
|
+
): string {
|
|
30
|
+
return JSON.stringify(
|
|
31
|
+
SyncAddonPricesRequest$outboundSchema.parse(syncAddonPricesRequest),
|
|
32
|
+
);
|
|
33
|
+
}
|
|
@@ -55,7 +55,7 @@ export type UpdateCustomerRequest = {
|
|
|
55
55
|
/**
|
|
56
56
|
* contact_persons replaces the customer's contact persons when provided; at most one may be primary
|
|
57
57
|
*/
|
|
58
|
-
contactPersons
|
|
58
|
+
contactPersons?: Array<CustomerContactPerson> | undefined;
|
|
59
59
|
/**
|
|
60
60
|
* email is the updated email address and must be a valid email format if provided
|
|
61
61
|
*/
|
|
@@ -95,7 +95,7 @@ export type UpdateCustomerRequest$Outbound = {
|
|
|
95
95
|
address_state?: string | undefined;
|
|
96
96
|
billing_currency?: string | undefined;
|
|
97
97
|
contact?: string | undefined;
|
|
98
|
-
contact_persons
|
|
98
|
+
contact_persons?: Array<CustomerContactPerson$Outbound> | undefined;
|
|
99
99
|
email?: string | undefined;
|
|
100
100
|
external_id?: string | undefined;
|
|
101
101
|
integration_entity_mapping?:
|
|
@@ -121,7 +121,7 @@ export const UpdateCustomerRequest$outboundSchema: z.ZodMiniType<
|
|
|
121
121
|
addressState: z.optional(z.string()),
|
|
122
122
|
billingCurrency: z.optional(z.string()),
|
|
123
123
|
contact: z.optional(z.string()),
|
|
124
|
-
contactPersons: z.array(CustomerContactPerson$outboundSchema),
|
|
124
|
+
contactPersons: z.optional(z.array(CustomerContactPerson$outboundSchema)),
|
|
125
125
|
email: z.optional(z.string()),
|
|
126
126
|
externalId: z.optional(z.string()),
|
|
127
127
|
integrationEntityMapping: z.optional(
|
package/src/sdk/sdk.ts
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
|
|
5
5
|
import { ClientSDK } from "../lib/sdks.js";
|
|
6
|
+
import { Activity } from "./activity.js";
|
|
6
7
|
import { Addons } from "./addons.js";
|
|
7
8
|
import { AlertSettings } from "./alert-settings.js";
|
|
8
9
|
import { Alerts } from "./alerts.js";
|
|
@@ -43,6 +44,11 @@ import { WebhookEvents } from "./webhook-events.js";
|
|
|
43
44
|
import { Workflows } from "./workflows.js";
|
|
44
45
|
|
|
45
46
|
export class Flexprice extends ClientSDK {
|
|
47
|
+
private _activity?: Activity;
|
|
48
|
+
get activity(): Activity {
|
|
49
|
+
return (this._activity ??= new Activity(this._options));
|
|
50
|
+
}
|
|
51
|
+
|
|
46
52
|
private _addons?: Addons;
|
|
47
53
|
get addons(): Addons {
|
|
48
54
|
return (this._addons ??= new Addons(this._options));
|
package/src/sdk/subscriptions.ts
CHANGED
|
@@ -21,12 +21,14 @@ import { subscriptionsGetSubscriptionV2 } from "../funcs/subscriptions-get-subsc
|
|
|
21
21
|
import { subscriptionsGetSubscription } from "../funcs/subscriptions-get-subscription.js";
|
|
22
22
|
import { subscriptionsListAllSubscriptionSchedules } from "../funcs/subscriptions-list-all-subscription-schedules.js";
|
|
23
23
|
import { subscriptionsListSubscriptionSchedules } from "../funcs/subscriptions-list-subscription-schedules.js";
|
|
24
|
+
import { subscriptionsPauseSubscription } from "../funcs/subscriptions-pause-subscription.js";
|
|
24
25
|
import { subscriptionsPreviewSubscriptionChange } from "../funcs/subscriptions-preview-subscription-change.js";
|
|
25
26
|
import { subscriptionsPreviewSubscriptionModify } from "../funcs/subscriptions-preview-subscription-modify.js";
|
|
26
27
|
import { subscriptionsPreviewSubscriptionPlanChangeV2 } from "../funcs/subscriptions-preview-subscription-plan-change-v2.js";
|
|
27
28
|
import { subscriptionsQuerySubscriptionLineItems } from "../funcs/subscriptions-query-subscription-line-items.js";
|
|
28
29
|
import { subscriptionsQuerySubscription } from "../funcs/subscriptions-query-subscription.js";
|
|
29
30
|
import { subscriptionsRemoveSubscriptionAddon } from "../funcs/subscriptions-remove-subscription-addon.js";
|
|
31
|
+
import { subscriptionsResumeSubscription } from "../funcs/subscriptions-resume-subscription.js";
|
|
30
32
|
import { subscriptionsUpdateSubscriptionLineItem } from "../funcs/subscriptions-update-subscription-line-item.js";
|
|
31
33
|
import { subscriptionsUpdateSubscription } from "../funcs/subscriptions-update-subscription.js";
|
|
32
34
|
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
|
|
@@ -503,6 +505,44 @@ export class Subscriptions extends ClientSDK {
|
|
|
503
505
|
));
|
|
504
506
|
}
|
|
505
507
|
|
|
508
|
+
/**
|
|
509
|
+
* Pause subscription
|
|
510
|
+
*
|
|
511
|
+
* @remarks
|
|
512
|
+
* Use when a customer stops temporarily. Pauses an active subscription now: usage and arrear fixed charges up to the pause are billed on a closing invoice, and every paused period after it gets a $0 skipped invoice.
|
|
513
|
+
*/
|
|
514
|
+
async pauseSubscription(
|
|
515
|
+
id: string,
|
|
516
|
+
body: models.PauseSubscriptionRequest,
|
|
517
|
+
options?: RequestOptions,
|
|
518
|
+
): Promise<models.PauseSubscriptionResponse> {
|
|
519
|
+
return unwrapAsync(subscriptionsPauseSubscription(
|
|
520
|
+
this,
|
|
521
|
+
id,
|
|
522
|
+
body,
|
|
523
|
+
options,
|
|
524
|
+
));
|
|
525
|
+
}
|
|
526
|
+
|
|
527
|
+
/**
|
|
528
|
+
* Resume subscription
|
|
529
|
+
*
|
|
530
|
+
* @remarks
|
|
531
|
+
* Use when a paused customer comes back. Resumes a paused subscription now on its existing billing anchor: the first period runs from the resume to the next billing date and its advance charges are invoiced at once.
|
|
532
|
+
*/
|
|
533
|
+
async resumeSubscription(
|
|
534
|
+
id: string,
|
|
535
|
+
body: models.ResumeSubscriptionRequest,
|
|
536
|
+
options?: RequestOptions,
|
|
537
|
+
): Promise<models.ResumeSubscriptionResponse> {
|
|
538
|
+
return unwrapAsync(subscriptionsResumeSubscription(
|
|
539
|
+
this,
|
|
540
|
+
id,
|
|
541
|
+
body,
|
|
542
|
+
options,
|
|
543
|
+
));
|
|
544
|
+
}
|
|
545
|
+
|
|
506
546
|
/**
|
|
507
547
|
* List subscription schedules
|
|
508
548
|
*
|