@schematichq/schematic-typescript-node 1.5.12 → 1.5.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api/resources/billing/client/requests/CreateBillingSubscriptionRequestBody.d.ts +1 -0
- package/dist/api/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +1 -0
- package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +1 -0
- package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +1 -0
- package/dist/api/resources/plans/client/Client.d.ts +2 -0
- package/dist/api/resources/plans/client/requests/CountPlansRequest.d.ts +3 -0
- package/dist/api/resources/plans/client/requests/ListPlansRequest.d.ts +3 -0
- package/dist/api/resources/plans/types/CountPlansParams.d.ts +2 -0
- package/dist/api/resources/plans/types/ListPlansParams.d.ts +2 -0
- package/dist/api/types/BillingArrearsAnchor.d.ts +5 -0
- package/dist/api/types/BillingArrearsCadence.d.ts +5 -0
- package/dist/api/types/BillingCreditGrantResponseData.d.ts +7 -0
- package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +12 -0
- package/dist/api/types/CheckoutDataResponseData.d.ts +2 -0
- package/dist/api/types/CompanyPlanCreditGrantView.d.ts +6 -0
- package/dist/api/types/CreateBillingPlanCreditGrantRequestBody.d.ts +12 -0
- package/dist/api/types/CreditCompanyGrantView.d.ts +7 -0
- package/dist/api/types/GetOnboardingStateResp.d.ts +2 -0
- package/dist/api/types/IssueTemporaryAccessTokenResponseData.d.ts +2 -1
- package/dist/api/types/OnboardingRequirement.d.ts +1 -0
- package/dist/api/types/OnboardingRoadmapView.d.ts +4 -0
- package/dist/api/types/PlanCreditGrantView.d.ts +6 -0
- package/dist/api/types/PlanGroupDetailResponseData.d.ts +1 -0
- package/dist/api/types/PlanGroupResponseData.d.ts +1 -0
- package/dist/api/types/RulesEngineSchemaVersion.d.ts +1 -1
- package/dist/api/types/RulesengineCompany.d.ts +1 -0
- package/dist/api/types/RulesengineCreditPostpaidConfig.d.ts +3 -0
- package/dist/api/types/SlackConnectInviteStatus.d.ts +8 -0
- package/dist/api/types/SlackConnectInviteView.d.ts +7 -0
- package/dist/api/types/TemporaryAccessTokenIssuerType.d.ts +5 -0
- package/dist/api/types/TemporaryAccessTokenResponseData.d.ts +2 -1
- package/dist/api/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +12 -0
- package/dist/api/types/WebhookEventDetailResponseData.d.ts +1 -0
- package/dist/api/types/WebhookEventResponseData.d.ts +1 -0
- package/dist/api/types/index.d.ts +7 -0
- package/dist/index.js +9 -9
- package/dist/serialization/resources/billing/client/requests/CreateBillingSubscriptionRequestBody.d.ts +1 -0
- package/dist/serialization/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +1 -0
- package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +1 -0
- package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +1 -0
- package/dist/serialization/resources/plans/types/CountPlansParams.d.ts +1 -0
- package/dist/serialization/resources/plans/types/ListPlansParams.d.ts +1 -0
- package/dist/serialization/types/BillingArrearsAnchor.d.ts +7 -0
- package/dist/serialization/types/BillingArrearsCadence.d.ts +7 -0
- package/dist/serialization/types/BillingCreditGrantResponseData.d.ts +4 -0
- package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +8 -0
- package/dist/serialization/types/CheckoutDataResponseData.d.ts +2 -0
- package/dist/serialization/types/CompanyPlanCreditGrantView.d.ts +8 -0
- package/dist/serialization/types/CreateBillingPlanCreditGrantRequestBody.d.ts +8 -0
- package/dist/serialization/types/CreditCompanyGrantView.d.ts +8 -0
- package/dist/serialization/types/GetOnboardingStateResp.d.ts +4 -0
- package/dist/serialization/types/IssueTemporaryAccessTokenResponseData.d.ts +3 -1
- package/dist/serialization/types/OnboardingRequirement.d.ts +1 -1
- package/dist/serialization/types/OnboardingRoadmapView.d.ts +10 -0
- package/dist/serialization/types/PlanCreditGrantView.d.ts +8 -0
- package/dist/serialization/types/PlanGroupDetailResponseData.d.ts +1 -0
- package/dist/serialization/types/PlanGroupResponseData.d.ts +1 -0
- package/dist/serialization/types/RulesEngineSchemaVersion.d.ts +1 -1
- package/dist/serialization/types/RulesengineCompany.d.ts +2 -0
- package/dist/serialization/types/RulesengineCreditPostpaidConfig.d.ts +9 -0
- package/dist/serialization/types/SlackConnectInviteStatus.d.ts +7 -0
- package/dist/serialization/types/SlackConnectInviteView.d.ts +13 -0
- package/dist/serialization/types/TemporaryAccessTokenIssuerType.d.ts +7 -0
- package/dist/serialization/types/TemporaryAccessTokenResponseData.d.ts +3 -1
- package/dist/serialization/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +8 -0
- package/dist/serialization/types/WebhookEventDetailResponseData.d.ts +1 -0
- package/dist/serialization/types/WebhookEventResponseData.d.ts +1 -0
- package/dist/serialization/types/index.d.ts +7 -0
- package/dist/wasm/rulesengine.js +1 -1
- package/package.json +1 -4
package/dist/api/resources/billing/client/requests/CreateBillingSubscriptionRequestBody.d.ts
CHANGED
|
@@ -42,6 +42,7 @@ export interface CreateBillingSubscriptionRequestBody {
|
|
|
42
42
|
periodStart?: number;
|
|
43
43
|
productExternalIds: Schematic.BillingProductPricing[];
|
|
44
44
|
providerType?: Schematic.BillingProviderType;
|
|
45
|
+
startedAt?: Date;
|
|
45
46
|
status?: string;
|
|
46
47
|
subscriptionExternalId: string;
|
|
47
48
|
totalPrice: number;
|
|
@@ -67,6 +67,7 @@ export interface CreatePlanGroupRequestBody {
|
|
|
67
67
|
showZeroPriceAsFree: boolean;
|
|
68
68
|
syncCustomerBillingDetails: boolean;
|
|
69
69
|
trialDays?: number;
|
|
70
|
+
trialEligibilityPerPlan?: boolean;
|
|
70
71
|
trialExpiryPlanId?: string;
|
|
71
72
|
trialExpiryPlanPriceId?: string;
|
|
72
73
|
trialPaymentMethodRequired?: boolean;
|
|
@@ -67,6 +67,7 @@ export interface UpdatePlanGroupRequestBody {
|
|
|
67
67
|
showZeroPriceAsFree: boolean;
|
|
68
68
|
syncCustomerBillingDetails: boolean;
|
|
69
69
|
trialDays?: number;
|
|
70
|
+
trialEligibilityPerPlan?: boolean;
|
|
70
71
|
trialExpiryPlanId?: string;
|
|
71
72
|
trialExpiryPlanPriceId?: string;
|
|
72
73
|
trialPaymentMethodRequired?: boolean;
|
|
@@ -132,6 +132,7 @@ export declare class PlansClient {
|
|
|
132
132
|
* companyId: "company_id",
|
|
133
133
|
* companyScopedOnly: true,
|
|
134
134
|
* excludeCompanyScoped: true,
|
|
135
|
+
* excludeUnused: true,
|
|
135
136
|
* forFallbackPlan: true,
|
|
136
137
|
* forInitialPlan: true,
|
|
137
138
|
* forTrialExpiryPlan: true,
|
|
@@ -330,6 +331,7 @@ export declare class PlansClient {
|
|
|
330
331
|
* companyId: "company_id",
|
|
331
332
|
* companyScopedOnly: true,
|
|
332
333
|
* excludeCompanyScoped: true,
|
|
334
|
+
* excludeUnused: true,
|
|
333
335
|
* forFallbackPlan: true,
|
|
334
336
|
* forInitialPlan: true,
|
|
335
337
|
* forTrialExpiryPlan: true,
|
|
@@ -5,6 +5,7 @@ import type * as Schematic from "../../../../index";
|
|
|
5
5
|
* companyId: "company_id",
|
|
6
6
|
* companyScopedOnly: true,
|
|
7
7
|
* excludeCompanyScoped: true,
|
|
8
|
+
* excludeUnused: true,
|
|
8
9
|
* forFallbackPlan: true,
|
|
9
10
|
* forInitialPlan: true,
|
|
10
11
|
* forTrialExpiryPlan: true,
|
|
@@ -27,6 +28,8 @@ export interface CountPlansRequest {
|
|
|
27
28
|
companyScopedOnly?: boolean;
|
|
28
29
|
/** Exclude plans that are scoped to a company (custom plans assigned to a company) */
|
|
29
30
|
excludeCompanyScoped?: boolean;
|
|
31
|
+
/** Exclude plans that nothing is using: no company is on the plan and it has no draft version */
|
|
32
|
+
excludeUnused?: boolean;
|
|
30
33
|
/** Filter for plans valid as fallback plans (not linked to billing) */
|
|
31
34
|
forFallbackPlan?: boolean;
|
|
32
35
|
/** Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial) */
|
|
@@ -5,6 +5,7 @@ import type * as Schematic from "../../../../index";
|
|
|
5
5
|
* companyId: "company_id",
|
|
6
6
|
* companyScopedOnly: true,
|
|
7
7
|
* excludeCompanyScoped: true,
|
|
8
|
+
* excludeUnused: true,
|
|
8
9
|
* forFallbackPlan: true,
|
|
9
10
|
* forInitialPlan: true,
|
|
10
11
|
* forTrialExpiryPlan: true,
|
|
@@ -27,6 +28,8 @@ export interface ListPlansRequest {
|
|
|
27
28
|
companyScopedOnly?: boolean;
|
|
28
29
|
/** Exclude plans that are scoped to a company (custom plans assigned to a company) */
|
|
29
30
|
excludeCompanyScoped?: boolean;
|
|
31
|
+
/** Exclude plans that nothing is using: no company is on the plan and it has no draft version */
|
|
32
|
+
excludeUnused?: boolean;
|
|
30
33
|
/** Filter for plans valid as fallback plans (not linked to billing) */
|
|
31
34
|
forFallbackPlan?: boolean;
|
|
32
35
|
/** Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial) */
|
|
@@ -8,6 +8,8 @@ export interface CountPlansParams {
|
|
|
8
8
|
companyScopedOnly?: boolean;
|
|
9
9
|
/** Exclude plans that are scoped to a company (custom plans assigned to a company) */
|
|
10
10
|
excludeCompanyScoped?: boolean;
|
|
11
|
+
/** Exclude plans that nothing is using: no company is on the plan and it has no draft version */
|
|
12
|
+
excludeUnused?: boolean;
|
|
11
13
|
/** Filter for plans valid as fallback plans (not linked to billing) */
|
|
12
14
|
forFallbackPlan?: boolean;
|
|
13
15
|
/** Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial) */
|
|
@@ -8,6 +8,8 @@ export interface ListPlansParams {
|
|
|
8
8
|
companyScopedOnly?: boolean;
|
|
9
9
|
/** Exclude plans that are scoped to a company (custom plans assigned to a company) */
|
|
10
10
|
excludeCompanyScoped?: boolean;
|
|
11
|
+
/** Exclude plans that nothing is using: no company is on the plan and it has no draft version */
|
|
12
|
+
excludeUnused?: boolean;
|
|
11
13
|
/** Filter for plans valid as fallback plans (not linked to billing) */
|
|
12
14
|
forFallbackPlan?: boolean;
|
|
13
15
|
/** Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial) */
|
|
@@ -5,6 +5,8 @@ export interface BillingCreditGrantResponseData {
|
|
|
5
5
|
companyLicenseId?: string;
|
|
6
6
|
companyName: string;
|
|
7
7
|
createdAt: Date;
|
|
8
|
+
/** The catalog bundle this grant was issued from, when the company bought one. */
|
|
9
|
+
creditBundleId?: string;
|
|
8
10
|
creditIcon?: string;
|
|
9
11
|
creditId: string;
|
|
10
12
|
creditName: string;
|
|
@@ -16,6 +18,11 @@ export interface BillingCreditGrantResponseData {
|
|
|
16
18
|
licenseName?: string;
|
|
17
19
|
planId?: string;
|
|
18
20
|
planName?: string;
|
|
21
|
+
/** What the postpaid charges costs, in the currency's minor unit. */
|
|
22
|
+
postpaidChargeAmount?: number;
|
|
23
|
+
postpaidChargeCurrency?: string;
|
|
24
|
+
/** Credits consumed past a zero balance in the window still open. */
|
|
25
|
+
postpaidChargedCredits?: number;
|
|
19
26
|
price?: Schematic.BillingPriceResponseData;
|
|
20
27
|
quantity: number;
|
|
21
28
|
quantityRemaining: number;
|
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
import type * as Schematic from "../index";
|
|
2
2
|
export interface BillingPlanCreditGrantResponseData {
|
|
3
|
+
/** Which boundary closes a monthly arrears window. Only meaningful when arrears_cadence is monthly. */
|
|
4
|
+
arrearsAnchor?: Schematic.BillingArrearsAnchor;
|
|
5
|
+
/** How often postpaid charges are closed and invoiced. Defaults to end_of_billing_period. */
|
|
6
|
+
arrearsCadence?: Schematic.BillingArrearsCadence;
|
|
3
7
|
autoTopupAmount?: number;
|
|
4
8
|
autoTopupAmountType?: string;
|
|
5
9
|
autoTopupAvailability: Schematic.BillingCreditAutoTopupAvailability;
|
|
@@ -32,11 +36,19 @@ export interface BillingPlanCreditGrantResponseData {
|
|
|
32
36
|
id: string;
|
|
33
37
|
/** The license whose quantity scales this grant. Set only when scaling is per_license. */
|
|
34
38
|
licenseId?: string;
|
|
39
|
+
/** Optional limit on how far the balance may go below zero, in credits. A floor on the balance, not an allowance per invoice window: consumption is denied once the balance would fall below minus this figure, and stays denied until a new grant lands or the negative balance is settled. Absent means no limit. */
|
|
40
|
+
overdraftLimit?: number;
|
|
35
41
|
plan?: Schematic.PreviewObjectResponseData;
|
|
36
42
|
planId: string;
|
|
37
43
|
/** Use plan.name from the nested plan object instead */
|
|
38
44
|
planName: string;
|
|
39
45
|
planVersionId?: string;
|
|
46
|
+
/** Whether consumption may continue past a zero balance, accruing at postpaid_rate_per_unit rather than being denied. */
|
|
47
|
+
postpaidEnabled: boolean;
|
|
48
|
+
/** Amount charged per credit consumed past zero, in the currency's minor unit. Defaults to the credit's own cost basis when postpaid is enabled without one. */
|
|
49
|
+
postpaidRatePerUnit?: number;
|
|
50
|
+
/** Decimal form of postpaid_rate_per_unit, for rates finer than one minor unit. */
|
|
51
|
+
postpaidRatePerUnitDecimal?: string;
|
|
40
52
|
resetCadence?: Schematic.BillingPlanCreditGrantResetCadence;
|
|
41
53
|
resetStart?: Schematic.BillingPlanCreditGrantResetStart;
|
|
42
54
|
resetType?: Schematic.BillingPlanCreditGrantResetType;
|
|
@@ -5,10 +5,12 @@ export interface CheckoutDataResponseData {
|
|
|
5
5
|
activeUsageBasedEntitlements: Schematic.UsageBasedEntitlementResponseData[];
|
|
6
6
|
availableCreditBundles: Schematic.BillingCreditBundleResponseData[];
|
|
7
7
|
company?: Schematic.CompanyDetailResponseData;
|
|
8
|
+
companyCanTrialSelectedPlan: boolean;
|
|
8
9
|
customCheckoutFields: Schematic.CheckoutFieldWithValue[];
|
|
9
10
|
featureUsage?: Schematic.FeatureUsageDetailResponseData;
|
|
10
11
|
selectedCreditBundles: Schematic.CreditBundlePurchaseResponseData[];
|
|
11
12
|
selectedPlan?: Schematic.PlanDetailResponseData;
|
|
13
|
+
selectedPlanAlreadyTrialed: boolean;
|
|
12
14
|
selectedUsageBasedEntitlements: Schematic.UsageBasedEntitlementResponseData[];
|
|
13
15
|
subscription?: Schematic.CompanySubscriptionResponseData;
|
|
14
16
|
}
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
import type * as Schematic from "../index";
|
|
2
2
|
export interface CompanyPlanCreditGrantView {
|
|
3
|
+
billingCreditArrearsAnchor?: Schematic.BillingArrearsAnchor;
|
|
4
|
+
billingCreditArrearsCadence?: Schematic.BillingArrearsCadence;
|
|
3
5
|
billingCreditAutoTopupAmount?: number;
|
|
4
6
|
billingCreditAutoTopupAmountType?: string;
|
|
5
7
|
billingCreditAutoTopupAvailability?: Schematic.BillingCreditAutoTopupAvailability;
|
|
@@ -11,6 +13,10 @@ export interface CompanyPlanCreditGrantView {
|
|
|
11
13
|
billingCreditAutoTopupThresholdCredits?: number;
|
|
12
14
|
billingCreditAutoTopupThresholdPercent?: number;
|
|
13
15
|
billingCreditCanBuyBundles: boolean;
|
|
16
|
+
billingCreditOverdraftLimit?: number;
|
|
17
|
+
billingCreditPostpaidEnabled: boolean;
|
|
18
|
+
billingCreditPostpaidRatePerUnit?: number;
|
|
19
|
+
billingCreditPostpaidRatePerUnitDecimal?: string;
|
|
14
20
|
companyAutoTopupAmount?: number;
|
|
15
21
|
companyAutoTopupEnabled?: boolean;
|
|
16
22
|
companyAutoTopupThresholdCredits?: number;
|
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
import type * as Schematic from "../index";
|
|
2
2
|
export interface CreateBillingPlanCreditGrantRequestBody {
|
|
3
3
|
applyToExisting?: boolean;
|
|
4
|
+
/** Which boundary closes a monthly arrears window: the subscription's own recurrence (billing_period_start) or the calendar month (month_end). Only applies when arrears_cadence is monthly; defaults to billing_period_start. */
|
|
5
|
+
arrearsAnchor?: Schematic.BillingArrearsAnchor;
|
|
6
|
+
/** How often postpaid charges are closed and invoiced: end_of_billing_period (the default) or monthly. */
|
|
7
|
+
arrearsCadence?: Schematic.BillingArrearsCadence;
|
|
4
8
|
autoTopupAmount?: number;
|
|
5
9
|
autoTopupAmountType?: Schematic.CreditAutoTopupAmountType;
|
|
6
10
|
autoTopupAvailability?: Schematic.BillingCreditAutoTopupAvailability;
|
|
@@ -22,8 +26,16 @@ export interface CreateBillingPlanCreditGrantRequestBody {
|
|
|
22
26
|
expiryUnitCount?: number;
|
|
23
27
|
/** The license whose quantity scales this grant. Required when scaling is per_license. */
|
|
24
28
|
licenseId?: string;
|
|
29
|
+
/** Optional limit on how far the balance may go below zero, in credits. It is a floor on the balance rather than an allowance per invoice window: the balance may run down to minus this figure, and beyond it the flag check denies the same way an exhausted balance does with postpaid off. Nothing resets when an invoice window rolls, so a company that reaches the limit stays denied until a new grant lands or the negative balance is settled. Omit for no limit. */
|
|
30
|
+
overdraftLimit?: number;
|
|
25
31
|
planId: string;
|
|
26
32
|
planVersionId?: string;
|
|
33
|
+
/** Whether consumption may continue past a zero balance. When false (the default) the flag check denies once the balance is exhausted, which is the existing behavior. When true, consumption continues and accrues at postpaid_rate_per_unit, settled on arrears_cadence. Intended for invoice-billed customers on net terms, who have no card for auto top-up to charge. */
|
|
34
|
+
postpaidEnabled?: boolean;
|
|
35
|
+
/** Amount charged per credit consumed past a zero balance, in the currency's minor unit. Optional: defaults to the credit's own cost basis (price_per_unit) when postpaid_enabled is true. */
|
|
36
|
+
postpaidRatePerUnit?: number;
|
|
37
|
+
/** Decimal string form of postpaid_rate_per_unit, for rates finer than one minor unit (for example 0.0002). Takes precedence over postpaid_rate_per_unit when both are set, matching how the credit's own price_per_unit_decimal behaves. */
|
|
38
|
+
postpaidRatePerUnitDecimal?: string;
|
|
27
39
|
resetCadence: Schematic.BillingPlanCreditGrantResetCadence;
|
|
28
40
|
resetStart: Schematic.BillingPlanCreditGrantResetStart;
|
|
29
41
|
resetType?: Schematic.BillingPlanCreditGrantResetType;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type * as Schematic from "../index";
|
|
2
2
|
export interface CreditCompanyGrantView {
|
|
3
|
+
arrearsCadence?: Schematic.BillingArrearsCadence;
|
|
3
4
|
billingCreditBundleId?: string;
|
|
4
5
|
billingCreditId: string;
|
|
5
6
|
companyId: string;
|
|
@@ -21,6 +22,12 @@ export interface CreditCompanyGrantView {
|
|
|
21
22
|
planId?: string;
|
|
22
23
|
planName?: string;
|
|
23
24
|
pluralName?: string;
|
|
25
|
+
postpaidChargeAmount?: number;
|
|
26
|
+
postpaidChargeCurrency?: string;
|
|
27
|
+
postpaidChargedCredits?: number;
|
|
28
|
+
postpaidPeriodEnd?: Date;
|
|
29
|
+
postpaidRate?: number;
|
|
30
|
+
postpaidRateDecimal?: string;
|
|
24
31
|
price?: Schematic.BillingProductPriceResponseData;
|
|
25
32
|
quantity: number;
|
|
26
33
|
quantityRemaining: number;
|
|
@@ -8,6 +8,8 @@ export interface GetOnboardingStateResp {
|
|
|
8
8
|
path?: Schematic.OnboardingPath;
|
|
9
9
|
pricingPageUrl?: string;
|
|
10
10
|
requirements: Schematic.OnboardingRequirementView[];
|
|
11
|
+
roadmap?: Schematic.OnboardingRoadmapView;
|
|
12
|
+
slackConnect?: Schematic.SlackConnectInviteView;
|
|
11
13
|
stripeImport?: Schematic.OnboardingStripeImport;
|
|
12
14
|
suggestedNext: Schematic.OnboardingRequirement[];
|
|
13
15
|
track?: Schematic.OnboardingTrack;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import type * as Schematic from "../index";
|
|
2
2
|
export interface IssueTemporaryAccessTokenResponseData {
|
|
3
|
-
apiKeyId
|
|
3
|
+
apiKeyId?: string;
|
|
4
4
|
createdAt: Date;
|
|
5
5
|
environmentId: string;
|
|
6
6
|
expiredAt: Date;
|
|
7
7
|
id: string;
|
|
8
|
+
issuerType: Schematic.TemporaryAccessTokenIssuerType;
|
|
8
9
|
resourceType: Schematic.TemporaryAccessTokenResourceType;
|
|
9
10
|
token: string;
|
|
10
11
|
updatedAt: Date;
|
|
@@ -3,6 +3,7 @@ export declare const OnboardingRequirement: {
|
|
|
3
3
|
readonly ConnectBilling: "connect_billing";
|
|
4
4
|
readonly CreateApiKey: "create_api_key";
|
|
5
5
|
readonly FirstFlagCheck: "first_flag_check";
|
|
6
|
+
readonly GenerateRoadmap: "generate_roadmap";
|
|
6
7
|
readonly ImportCompanies: "import_companies";
|
|
7
8
|
readonly ModelPackaging: "model_packaging";
|
|
8
9
|
readonly SendEvents: "send_events";
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
import type * as Schematic from "../index";
|
|
2
2
|
export interface PlanCreditGrantView {
|
|
3
|
+
billingCreditArrearsAnchor?: Schematic.BillingArrearsAnchor;
|
|
4
|
+
billingCreditArrearsCadence?: Schematic.BillingArrearsCadence;
|
|
3
5
|
billingCreditAutoTopupAmount?: number;
|
|
4
6
|
billingCreditAutoTopupAmountType?: string;
|
|
5
7
|
billingCreditAutoTopupAvailability?: Schematic.BillingCreditAutoTopupAvailability;
|
|
@@ -11,6 +13,10 @@ export interface PlanCreditGrantView {
|
|
|
11
13
|
billingCreditAutoTopupThresholdCredits?: number;
|
|
12
14
|
billingCreditAutoTopupThresholdPercent?: number;
|
|
13
15
|
billingCreditCanBuyBundles: boolean;
|
|
16
|
+
billingCreditOverdraftLimit?: number;
|
|
17
|
+
billingCreditPostpaidEnabled: boolean;
|
|
18
|
+
billingCreditPostpaidRatePerUnit?: number;
|
|
19
|
+
billingCreditPostpaidRatePerUnitDecimal?: string;
|
|
14
20
|
companyCreditAmount: number;
|
|
15
21
|
createdAt: Date;
|
|
16
22
|
credit?: Schematic.BillingCreditView;
|
|
@@ -33,6 +33,7 @@ export interface PlanGroupDetailResponseData {
|
|
|
33
33
|
syncCustomerBillingDetails: boolean;
|
|
34
34
|
taxCollectionEnabled: boolean;
|
|
35
35
|
trialDays?: number;
|
|
36
|
+
trialEligibilityPerPlan: boolean;
|
|
36
37
|
trialExpiryPlan?: Schematic.PlanGroupPlanDetailResponseData;
|
|
37
38
|
trialExpiryPlanId?: string;
|
|
38
39
|
trialExpiryPlanPrice?: Schematic.BillingPriceView;
|
|
@@ -25,6 +25,7 @@ export interface PlanGroupResponseData {
|
|
|
25
25
|
syncCustomerBillingDetails: boolean;
|
|
26
26
|
taxCollectionEnabled: boolean;
|
|
27
27
|
trialDays?: number;
|
|
28
|
+
trialEligibilityPerPlan: boolean;
|
|
28
29
|
trialExpiryPlanId?: string;
|
|
29
30
|
trialExpiryPlanPriceId?: string;
|
|
30
31
|
trialPaymentMethodRequired?: boolean;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/** The current schema version hash for rules engine types. The first enum value is always the current version. */
|
|
2
2
|
export declare const RulesEngineSchemaVersion: {
|
|
3
|
-
readonly
|
|
3
|
+
readonly V94B8F7A7: "v94b8f7a7";
|
|
4
4
|
readonly PlaceholderForFernCompatibility: "placeholder-for-fern-compatibility";
|
|
5
5
|
};
|
|
6
6
|
export type RulesEngineSchemaVersion = (typeof RulesEngineSchemaVersion)[keyof typeof RulesEngineSchemaVersion];
|
|
@@ -4,6 +4,7 @@ export interface RulesengineCompany {
|
|
|
4
4
|
basePlanId?: string;
|
|
5
5
|
billingProductIds: string[];
|
|
6
6
|
creditBalances: Record<string, number>;
|
|
7
|
+
creditPostpaid?: Record<string, Schematic.RulesengineCreditPostpaidConfig>;
|
|
7
8
|
entitlements?: Schematic.RulesengineFeatureEntitlement[];
|
|
8
9
|
environmentId: string;
|
|
9
10
|
id: string;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export declare const SlackConnectInviteStatus: {
|
|
2
|
+
readonly Accepted: "accepted";
|
|
3
|
+
readonly Declined: "declined";
|
|
4
|
+
readonly Dismissed: "dismissed";
|
|
5
|
+
readonly Expired: "expired";
|
|
6
|
+
readonly Pending: "pending";
|
|
7
|
+
};
|
|
8
|
+
export type SlackConnectInviteStatus = (typeof SlackConnectInviteStatus)[keyof typeof SlackConnectInviteStatus];
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import type * as Schematic from "../index";
|
|
2
2
|
export interface TemporaryAccessTokenResponseData {
|
|
3
|
-
apiKeyId
|
|
3
|
+
apiKeyId?: string;
|
|
4
4
|
createdAt: Date;
|
|
5
5
|
environmentId: string;
|
|
6
6
|
expiredAt: Date;
|
|
7
7
|
id: string;
|
|
8
|
+
issuerType: Schematic.TemporaryAccessTokenIssuerType;
|
|
8
9
|
resourceType: Schematic.TemporaryAccessTokenResourceType;
|
|
9
10
|
updatedAt: Date;
|
|
10
11
|
}
|
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
import type * as Schematic from "../index";
|
|
2
2
|
export interface UpdateBillingPlanCreditGrantRequestBody {
|
|
3
3
|
applyToExisting?: boolean;
|
|
4
|
+
/** Which boundary closes a monthly arrears window: the subscription's own recurrence (billing_period_start) or the calendar month (month_end). Only applies when arrears_cadence is monthly; defaults to billing_period_start. Send null to fall back to the default. */
|
|
5
|
+
arrearsAnchor?: Schematic.BillingArrearsAnchor;
|
|
6
|
+
/** How often postpaid charges are closed and invoiced: end_of_billing_period (the default) or monthly. Send null to fall back to the default. */
|
|
7
|
+
arrearsCadence?: Schematic.BillingArrearsCadence;
|
|
4
8
|
autoTopupAmount?: number;
|
|
5
9
|
autoTopupAmountType?: Schematic.CreditAutoTopupAmountType;
|
|
6
10
|
autoTopupAvailability?: Schematic.BillingCreditAutoTopupAvailability;
|
|
@@ -21,6 +25,14 @@ export interface UpdateBillingPlanCreditGrantRequestBody {
|
|
|
21
25
|
expiryUnitCount?: number;
|
|
22
26
|
/** The license whose quantity scales this grant. Cleared when the grant moves off per-license scaling. */
|
|
23
27
|
licenseId?: string;
|
|
28
|
+
/** Optional limit on how far the balance may go below zero, in credits. It is a floor on the balance rather than an allowance per invoice window: the balance may run down to minus this figure, and beyond it the flag check denies the same way an exhausted balance does with postpaid off. Nothing resets when an invoice window rolls, so a company that reaches the limit stays denied until a new grant lands or the negative balance is settled. Send null to remove the limit. */
|
|
29
|
+
overdraftLimit?: number;
|
|
30
|
+
/** Whether consumption may continue past a zero balance. When false (the default) the flag check denies once the balance is exhausted, which is the existing behavior. When true, consumption continues and accrues at postpaid_rate_per_unit, settled on arrears_cadence. Intended for invoice-billed customers on net terms, who have no card for auto top-up to charge. */
|
|
31
|
+
postpaidEnabled?: boolean;
|
|
32
|
+
/** Amount charged per credit consumed past a zero balance, in the currency's minor unit. Send null to clear it, in which case an enabled grant falls back to the credit's own cost basis (price_per_unit). */
|
|
33
|
+
postpaidRatePerUnit?: number;
|
|
34
|
+
/** Decimal string form of postpaid_rate_per_unit, for rates finer than one minor unit (for example 0.0002). Takes precedence over postpaid_rate_per_unit when both are set, matching how the credit's own price_per_unit_decimal behaves. Send null to clear it. */
|
|
35
|
+
postpaidRatePerUnitDecimal?: string;
|
|
24
36
|
resetCadence: Schematic.BillingPlanCreditGrantResetCadence;
|
|
25
37
|
resetStart: Schematic.BillingPlanCreditGrantResetStart;
|
|
26
38
|
resetType?: Schematic.BillingPlanCreditGrantResetType;
|
|
@@ -12,6 +12,8 @@ export * from "./ApiKeyScope";
|
|
|
12
12
|
export * from "./AuditLogExportMetadata";
|
|
13
13
|
export * from "./AuditLogListResponseData";
|
|
14
14
|
export * from "./AuditLogResponseData";
|
|
15
|
+
export * from "./BillingArrearsAnchor";
|
|
16
|
+
export * from "./BillingArrearsCadence";
|
|
15
17
|
export * from "./BillingCollectionMethod";
|
|
16
18
|
export * from "./BillingCouponResponseData";
|
|
17
19
|
export * from "./BillingCreditAutoTopupAvailability";
|
|
@@ -293,6 +295,7 @@ export * from "./OnboardingPath";
|
|
|
293
295
|
export * from "./OnboardingRequirement";
|
|
294
296
|
export * from "./OnboardingRequirementStatus";
|
|
295
297
|
export * from "./OnboardingRequirementView";
|
|
298
|
+
export * from "./OnboardingRoadmapView";
|
|
296
299
|
export * from "./OnboardingStripeImport";
|
|
297
300
|
export * from "./OnboardingTrack";
|
|
298
301
|
export * from "./OrbIntegrationConfig";
|
|
@@ -374,6 +377,7 @@ export * from "./RulesengineCompanyMetric";
|
|
|
374
377
|
export * from "./RulesengineCondition";
|
|
375
378
|
export * from "./RulesengineConditionGroup";
|
|
376
379
|
export * from "./RulesengineConditionType";
|
|
380
|
+
export * from "./RulesengineCreditPostpaidConfig";
|
|
377
381
|
export * from "./RulesengineEntitlementValueType";
|
|
378
382
|
export * from "./RulesengineEntityType";
|
|
379
383
|
export * from "./RulesengineFeatureEntitlement";
|
|
@@ -397,6 +401,8 @@ export * from "./ScheduledDowngradeResponseData";
|
|
|
397
401
|
export * from "./SegmentStatusResp";
|
|
398
402
|
export * from "./SkippedEntitlementErrorResponseData";
|
|
399
403
|
export * from "./SkippedEntitlementResponseData";
|
|
404
|
+
export * from "./SlackConnectInviteStatus";
|
|
405
|
+
export * from "./SlackConnectInviteView";
|
|
400
406
|
export * from "./SortDirection";
|
|
401
407
|
export * from "./StripeEmbedInfo";
|
|
402
408
|
export * from "./StripeIntegrationConfig";
|
|
@@ -409,6 +415,7 @@ export * from "./SubscriptionTraitUpdate";
|
|
|
409
415
|
export * from "./SubscriptionType";
|
|
410
416
|
export * from "./TaxIdInput";
|
|
411
417
|
export * from "./TaxIdType";
|
|
418
|
+
export * from "./TemporaryAccessTokenIssuerType";
|
|
412
419
|
export * from "./TemporaryAccessTokenResourceType";
|
|
413
420
|
export * from "./TemporaryAccessTokenResponseData";
|
|
414
421
|
export * from "./TestWebhookResponseData";
|