@schematichq/schematic-typescript-node 1.5.8 → 1.5.9
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 +1 -1
- package/dist/api/resources/accounts/client/Client.d.ts +28 -0
- package/dist/api/resources/accounts/client/requests/UpdateOnboardingStateRequestBody.d.ts +11 -0
- package/dist/api/resources/accounts/client/requests/index.d.ts +1 -0
- package/dist/api/resources/accounts/types/GetOnboardingStateResponse.d.ts +6 -0
- package/dist/api/resources/accounts/types/UpdateOnboardingStateResponse.d.ts +6 -0
- package/dist/api/resources/accounts/types/index.d.ts +2 -0
- package/dist/api/resources/companies/client/Client.d.ts +53 -3
- package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +3 -0
- package/dist/api/resources/companies/client/requests/CountEntityTraitsRequest.d.ts +18 -0
- package/dist/api/resources/companies/client/requests/GetBillingEntityChildSubscriptionsRequest.d.ts +1 -1
- package/dist/api/resources/companies/client/requests/GetCompanyBillingEntityRequest.d.ts +1 -1
- package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +3 -0
- package/dist/api/resources/companies/client/requests/ListPlanChangesRequest.d.ts +0 -2
- package/dist/api/resources/companies/client/requests/index.d.ts +1 -0
- package/dist/api/resources/companies/types/CountCompaniesParams.d.ts +2 -0
- package/dist/api/resources/companies/types/CountEntityTraitsParams.d.ts +12 -0
- package/dist/api/resources/companies/types/CountEntityTraitsResponse.d.ts +6 -0
- package/dist/api/resources/companies/types/DeleteEntityTraitDefinitionResponse.d.ts +6 -0
- package/dist/api/resources/companies/types/GetEntityTraitDefinitionUsageResponse.d.ts +6 -0
- package/dist/api/resources/companies/types/ListCompaniesParams.d.ts +2 -0
- package/dist/api/resources/companies/types/ListPlanChangesParams.d.ts +0 -1
- package/dist/api/resources/companies/types/index.d.ts +4 -0
- package/dist/api/resources/credits/client/Client.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/CountCompanyGrantsRequest.d.ts +1 -1
- package/dist/api/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +2 -0
- package/dist/api/resources/credits/client/requests/ListCompanyGrantsRequest.d.ts +1 -1
- package/dist/api/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +2 -0
- package/dist/api/resources/entitlements/client/Client.d.ts +23 -0
- package/dist/api/resources/entitlements/client/requests/ListFeatureUsageHistoryRequest.d.ts +29 -0
- package/dist/api/resources/entitlements/client/requests/index.d.ts +1 -0
- package/dist/api/resources/entitlements/types/ListFeatureUsageHistoryParams.d.ts +20 -0
- package/dist/api/resources/entitlements/types/ListFeatureUsageHistoryResponse.d.ts +6 -0
- package/dist/api/resources/entitlements/types/index.d.ts +2 -0
- package/dist/api/resources/planbundle/client/Client.d.ts +23 -6
- package/dist/api/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +12 -3
- package/dist/api/resources/planbundle/client/requests/CreatePlanBundleRequestBody.d.ts +7 -2
- package/dist/api/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +5 -2
- package/dist/api/resources/plangroups/client/Client.d.ts +2 -0
- package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +3 -0
- package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +3 -0
- package/dist/api/resources/planmigrations/client/Client.d.ts +4 -8
- package/dist/api/resources/planmigrations/client/requests/CountCompanyMigrationsRequest.d.ts +1 -1
- package/dist/api/resources/planmigrations/client/requests/CountMigrationsRequest.d.ts +1 -1
- package/dist/api/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +4 -6
- package/dist/api/resources/planmigrations/client/requests/ListCompanyMigrationsRequest.d.ts +1 -1
- package/dist/api/resources/planmigrations/client/requests/ListMigrationsRequest.d.ts +1 -1
- package/dist/api/resources/planmigrations/client/requests/PreviewMigrationRequestBody.d.ts +2 -2
- package/dist/api/resources/plans/client/Client.d.ts +10 -9
- package/dist/api/resources/plans/client/requests/CreateCustomPlanRequestBody.d.ts +1 -0
- package/dist/api/resources/plans/client/requests/ListCustomPlanBillingsRequest.d.ts +3 -0
- package/dist/api/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +3 -0
- package/dist/api/resources/plans/types/ListCustomPlanBillingsParams.d.ts +2 -0
- package/dist/api/types/BillingCollectionMethod.d.ts +5 -0
- package/dist/api/types/BillingCreditBundleResponseData.d.ts +2 -0
- package/dist/api/types/BillingCreditBundleView.d.ts +1 -0
- package/dist/api/types/BillingCreditGrantResponseData.d.ts +4 -0
- package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +2 -0
- package/dist/api/types/CheckFlagRequestBody.d.ts +3 -0
- package/dist/api/types/CheckoutBundlePurchaseBehavior.d.ts +5 -0
- package/dist/api/types/CheckoutSettingsResponseData.d.ts +3 -0
- package/dist/api/types/CompanyBillingCheckoutSettings.d.ts +1 -0
- package/dist/api/types/CompanyFeatureUsageExportMetadata.d.ts +6 -0
- package/dist/api/types/CompanyPlanCreditGrantView.d.ts +1 -0
- package/dist/api/types/ComponentCheckoutSettings.d.ts +2 -0
- package/dist/api/types/CreateBillingPlanCreditGrantRequestBody.d.ts +2 -0
- package/dist/api/types/CreditCompanyGrantView.d.ts +2 -0
- package/dist/api/types/CustomPlanBillingResponseData.d.ts +4 -0
- package/dist/api/types/EntityTraitDefinitionUsage.d.ts +8 -0
- package/dist/api/types/EventBodyFlagCheck.d.ts +2 -0
- package/dist/api/types/FeatureUsageHistoryResponseData.d.ts +12 -0
- package/dist/api/types/GetOnboardingStateResp.d.ts +9 -0
- package/dist/api/types/ManagePlanRequest.d.ts +14 -0
- package/dist/api/types/MigrationProrationBehavior.d.ts +6 -0
- package/dist/api/types/OnboardingMilestone.d.ts +5 -0
- package/dist/api/types/OnboardingMilestoneView.d.ts +7 -0
- package/dist/api/types/OnboardingPath.d.ts +5 -0
- package/dist/api/types/OnboardingRequirement.d.ts +9 -0
- package/dist/api/types/OnboardingRequirementStatus.d.ts +6 -0
- package/dist/api/types/OnboardingRequirementView.d.ts +7 -0
- package/dist/api/types/OnboardingTrack.d.ts +5 -0
- package/dist/api/types/PlanBillingSource.d.ts +5 -0
- package/dist/api/types/PlanBundleResponseData.d.ts +1 -0
- package/dist/api/types/PlanCreditGrantView.d.ts +1 -0
- package/dist/api/types/PlanVersionMigrationPreviewCompanyResponseData.d.ts +1 -0
- package/dist/api/types/PlanVersionMigrationPreviewResponseData.d.ts +1 -0
- package/dist/api/types/PlanVersionMigrationResponseData.d.ts +1 -0
- package/dist/api/types/PreflightEventUsageRequestBody.d.ts +6 -0
- package/dist/api/types/PreflightRequestBody.d.ts +9 -0
- package/dist/api/types/PreviewSubscriptionFinanceResponseData.d.ts +1 -0
- package/dist/api/types/RulesEngineSchemaVersion.d.ts +1 -1
- package/dist/api/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +4 -2
- package/dist/api/types/UpsertCompanyRequestBody.d.ts +2 -0
- package/dist/api/types/UpsertUserRequestBody.d.ts +2 -0
- package/dist/api/types/UpsertUserSubRequestBody.d.ts +2 -0
- package/dist/api/types/WhoAmIResponseData.d.ts +1 -0
- package/dist/api/types/index.d.ts +16 -0
- package/dist/index.js +9 -9
- package/dist/serialization/resources/accounts/client/requests/UpdateOnboardingStateRequestBody.d.ts +14 -0
- package/dist/serialization/resources/accounts/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/accounts/types/GetOnboardingStateResponse.d.ts +11 -0
- package/dist/serialization/resources/accounts/types/UpdateOnboardingStateResponse.d.ts +11 -0
- package/dist/serialization/resources/accounts/types/index.d.ts +2 -0
- package/dist/serialization/resources/companies/types/CountCompaniesParams.d.ts +1 -0
- package/dist/serialization/resources/companies/types/CountEntityTraitsParams.d.ts +13 -0
- package/dist/serialization/resources/companies/types/CountEntityTraitsResponse.d.ts +12 -0
- package/dist/serialization/resources/companies/types/DeleteEntityTraitDefinitionResponse.d.ts +11 -0
- package/dist/serialization/resources/companies/types/GetEntityTraitDefinitionUsageResponse.d.ts +11 -0
- package/dist/serialization/resources/companies/types/ListCompaniesParams.d.ts +1 -0
- package/dist/serialization/resources/companies/types/ListPlanChangesParams.d.ts +0 -1
- package/dist/serialization/resources/companies/types/index.d.ts +4 -0
- package/dist/serialization/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +1 -0
- package/dist/serialization/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +1 -0
- package/dist/serialization/resources/entitlements/types/ListFeatureUsageHistoryParams.d.ts +16 -0
- package/dist/serialization/resources/entitlements/types/ListFeatureUsageHistoryResponse.d.ts +12 -0
- package/dist/serialization/resources/entitlements/types/index.d.ts +2 -0
- package/dist/serialization/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +2 -2
- package/dist/serialization/resources/planbundle/client/requests/CreatePlanBundleRequestBody.d.ts +1 -1
- package/dist/serialization/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +1 -1
- package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +3 -0
- package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +3 -0
- package/dist/serialization/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +5 -3
- package/dist/serialization/resources/planmigrations/client/requests/PreviewMigrationRequestBody.d.ts +2 -1
- package/dist/serialization/resources/plans/client/requests/CreateCustomPlanRequestBody.d.ts +1 -0
- package/dist/serialization/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +3 -0
- package/dist/serialization/resources/plans/types/ListCustomPlanBillingsParams.d.ts +2 -0
- package/dist/serialization/types/BillingCollectionMethod.d.ts +7 -0
- package/dist/serialization/types/BillingCreditBundleResponseData.d.ts +1 -0
- package/dist/serialization/types/BillingCreditBundleView.d.ts +1 -0
- package/dist/serialization/types/BillingCreditGrantResponseData.d.ts +2 -0
- package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +1 -0
- package/dist/serialization/types/CheckFlagRequestBody.d.ts +2 -0
- package/dist/serialization/types/CheckoutBundlePurchaseBehavior.d.ts +7 -0
- package/dist/serialization/types/CheckoutSettingsResponseData.d.ts +3 -0
- package/dist/serialization/types/CompanyBillingCheckoutSettings.d.ts +1 -0
- package/dist/serialization/types/CompanyFeatureUsageExportMetadata.d.ts +3 -0
- package/dist/serialization/types/CompanyPlanCreditGrantView.d.ts +1 -0
- package/dist/serialization/types/ComponentCheckoutSettings.d.ts +3 -0
- package/dist/serialization/types/CreateBillingPlanCreditGrantRequestBody.d.ts +1 -0
- package/dist/serialization/types/CreditCompanyGrantView.d.ts +2 -0
- package/dist/serialization/types/CustomPlanBillingResponseData.d.ts +3 -0
- package/dist/serialization/types/EntityTraitDefinitionUsage.d.ts +14 -0
- package/dist/serialization/types/EventBodyFlagCheck.d.ts +1 -0
- package/dist/serialization/types/FeatureUsageHistoryResponseData.d.ts +14 -0
- package/dist/serialization/types/GetOnboardingStateResp.d.ts +19 -0
- package/dist/serialization/types/ManagePlanRequest.d.ts +8 -0
- package/dist/serialization/types/MigrationProrationBehavior.d.ts +7 -0
- package/dist/serialization/types/OnboardingMilestone.d.ts +7 -0
- package/dist/serialization/types/OnboardingMilestoneView.d.ts +14 -0
- package/dist/serialization/types/OnboardingPath.d.ts +7 -0
- package/dist/serialization/types/OnboardingRequirement.d.ts +7 -0
- package/dist/serialization/types/OnboardingRequirementStatus.d.ts +7 -0
- package/dist/serialization/types/OnboardingRequirementView.d.ts +14 -0
- package/dist/serialization/types/OnboardingTrack.d.ts +7 -0
- package/dist/serialization/types/PlanBillingSource.d.ts +7 -0
- package/dist/serialization/types/PlanBundleResponseData.d.ts +2 -0
- package/dist/serialization/types/PlanCreditGrantView.d.ts +1 -0
- package/dist/serialization/types/PlanVersionMigrationPreviewCompanyResponseData.d.ts +1 -0
- package/dist/serialization/types/PlanVersionMigrationPreviewResponseData.d.ts +1 -0
- package/dist/serialization/types/PlanVersionMigrationResponseData.d.ts +2 -0
- package/dist/serialization/types/PreflightEventUsageRequestBody.d.ts +10 -0
- package/dist/serialization/types/PreflightRequestBody.d.ts +12 -0
- package/dist/serialization/types/PreviewSubscriptionFinanceResponseData.d.ts +1 -0
- package/dist/serialization/types/RulesEngineSchemaVersion.d.ts +1 -1
- package/dist/serialization/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +1 -0
- package/dist/serialization/types/UpsertCompanyRequestBody.d.ts +1 -0
- package/dist/serialization/types/UpsertUserRequestBody.d.ts +1 -0
- package/dist/serialization/types/UpsertUserSubRequestBody.d.ts +1 -0
- package/dist/serialization/types/WhoAmIResponseData.d.ts +1 -0
- package/dist/serialization/types/index.d.ts +16 -0
- package/dist/wasm/rulesengine.js +4 -4
- package/package.json +4 -1
package/dist/api/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts
CHANGED
|
@@ -2,14 +2,23 @@ import type * as Schematic from "../../../../index";
|
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
|
+
* billingProduct: {
|
|
6
|
+
* chargeType: "free",
|
|
7
|
+
* isTrialable: true
|
|
8
|
+
* },
|
|
5
9
|
* entitlements: [{
|
|
6
10
|
* action: "create"
|
|
7
|
-
* }]
|
|
11
|
+
* }],
|
|
12
|
+
* plan: {
|
|
13
|
+
* companyId: "company_id",
|
|
14
|
+
* description: "description",
|
|
15
|
+
* name: "name"
|
|
16
|
+
* }
|
|
8
17
|
* }
|
|
9
18
|
*/
|
|
10
19
|
export interface CreateCustomPlanBundleRequestBody {
|
|
11
|
-
billingProduct
|
|
20
|
+
billingProduct: Schematic.UpsertBillingProductRequestBody;
|
|
12
21
|
creditGrants?: Schematic.PlanBundleCreditGrantRequestBody[];
|
|
13
22
|
entitlements: Schematic.PlanBundleEntitlementRequestBody[];
|
|
14
|
-
plan
|
|
23
|
+
plan: Schematic.CreateCustomPlanBundlePlanRequestBody;
|
|
15
24
|
}
|
|
@@ -4,12 +4,17 @@ import type * as Schematic from "../../../../index";
|
|
|
4
4
|
* {
|
|
5
5
|
* entitlements: [{
|
|
6
6
|
* action: "create"
|
|
7
|
-
* }]
|
|
7
|
+
* }],
|
|
8
|
+
* plan: {
|
|
9
|
+
* description: "description",
|
|
10
|
+
* name: "name",
|
|
11
|
+
* planType: "plan"
|
|
12
|
+
* }
|
|
8
13
|
* }
|
|
9
14
|
*/
|
|
10
15
|
export interface CreatePlanBundleRequestBody {
|
|
11
16
|
billingProduct?: Schematic.UpsertBillingProductRequestBody;
|
|
12
17
|
creditGrants?: Schematic.PlanBundleCreditGrantRequestBody[];
|
|
13
18
|
entitlements: Schematic.PlanBundleEntitlementRequestBody[];
|
|
14
|
-
plan
|
|
19
|
+
plan: Schematic.CreatePlanRequestBody;
|
|
15
20
|
}
|
|
@@ -4,13 +4,16 @@ import type * as Schematic from "../../../../index";
|
|
|
4
4
|
* {
|
|
5
5
|
* entitlements: [{
|
|
6
6
|
* action: "create"
|
|
7
|
-
* }]
|
|
7
|
+
* }],
|
|
8
|
+
* plan: {
|
|
9
|
+
* name: "name"
|
|
10
|
+
* }
|
|
8
11
|
* }
|
|
9
12
|
*/
|
|
10
13
|
export interface UpdatePlanBundleRequestBody {
|
|
11
14
|
billingProduct?: Schematic.UpsertBillingProductRequestBody;
|
|
12
15
|
creditGrants?: Schematic.PlanBundleCreditGrantRequestBody[];
|
|
13
16
|
entitlements: Schematic.PlanBundleEntitlementRequestBody[];
|
|
14
|
-
plan
|
|
17
|
+
plan: Schematic.UpdatePlanRequestBody;
|
|
15
18
|
planVersionId?: string;
|
|
16
19
|
}
|
|
@@ -42,6 +42,7 @@ export declare class PlangroupsClient {
|
|
|
42
42
|
* checkoutCollectAddress: true,
|
|
43
43
|
* checkoutCollectEmail: true,
|
|
44
44
|
* checkoutCollectPhone: true,
|
|
45
|
+
* checkoutCollectTaxId: true,
|
|
45
46
|
* enableTaxCollection: true,
|
|
46
47
|
* optInEnabled: true,
|
|
47
48
|
* orderedAddOns: [{
|
|
@@ -84,6 +85,7 @@ export declare class PlangroupsClient {
|
|
|
84
85
|
* checkoutCollectAddress: true,
|
|
85
86
|
* checkoutCollectEmail: true,
|
|
86
87
|
* checkoutCollectPhone: true,
|
|
88
|
+
* checkoutCollectTaxId: true,
|
|
87
89
|
* enableTaxCollection: true,
|
|
88
90
|
* optInEnabled: true,
|
|
89
91
|
* orderedAddOns: [{
|
|
@@ -6,6 +6,7 @@ import type * as Schematic from "../../../../index";
|
|
|
6
6
|
* checkoutCollectAddress: true,
|
|
7
7
|
* checkoutCollectEmail: true,
|
|
8
8
|
* checkoutCollectPhone: true,
|
|
9
|
+
* checkoutCollectTaxId: true,
|
|
9
10
|
* enableTaxCollection: true,
|
|
10
11
|
* optInEnabled: true,
|
|
11
12
|
* orderedAddOns: [{
|
|
@@ -33,9 +34,11 @@ export interface CreatePlanGroupRequestBody {
|
|
|
33
34
|
addOnCompatibilities?: Schematic.CompatiblePlans[];
|
|
34
35
|
/** Use OrderedAddOns instead */
|
|
35
36
|
addOnIds: string[];
|
|
37
|
+
checkoutBundlePurchaseBehavior?: Schematic.CheckoutBundlePurchaseBehavior;
|
|
36
38
|
checkoutCollectAddress: boolean;
|
|
37
39
|
checkoutCollectEmail: boolean;
|
|
38
40
|
checkoutCollectPhone: boolean;
|
|
41
|
+
checkoutCollectTaxId: boolean;
|
|
39
42
|
customCheckoutFields?: Schematic.CheckoutFieldInput[];
|
|
40
43
|
customPlanConfig?: Schematic.CustomPlanConfig;
|
|
41
44
|
customPlanId?: string;
|
|
@@ -6,6 +6,7 @@ import type * as Schematic from "../../../../index";
|
|
|
6
6
|
* checkoutCollectAddress: true,
|
|
7
7
|
* checkoutCollectEmail: true,
|
|
8
8
|
* checkoutCollectPhone: true,
|
|
9
|
+
* checkoutCollectTaxId: true,
|
|
9
10
|
* enableTaxCollection: true,
|
|
10
11
|
* optInEnabled: true,
|
|
11
12
|
* orderedAddOns: [{
|
|
@@ -33,9 +34,11 @@ export interface UpdatePlanGroupRequestBody {
|
|
|
33
34
|
addOnCompatibilities?: Schematic.CompatiblePlans[];
|
|
34
35
|
/** Use OrderedAddOns instead */
|
|
35
36
|
addOnIds: string[];
|
|
37
|
+
checkoutBundlePurchaseBehavior?: Schematic.CheckoutBundlePurchaseBehavior;
|
|
36
38
|
checkoutCollectAddress: boolean;
|
|
37
39
|
checkoutCollectEmail: boolean;
|
|
38
40
|
checkoutCollectPhone: boolean;
|
|
41
|
+
checkoutCollectTaxId: boolean;
|
|
39
42
|
customCheckoutFields?: Schematic.CheckoutFieldInput[];
|
|
40
43
|
customPlanConfig?: Schematic.CustomPlanConfig;
|
|
41
44
|
customPlanId?: string;
|
|
@@ -29,7 +29,7 @@ export declare class PlanmigrationsClient {
|
|
|
29
29
|
* offset: 1000000
|
|
30
30
|
* })
|
|
31
31
|
*/
|
|
32
|
-
listCompanyMigrations(request
|
|
32
|
+
listCompanyMigrations(request: Schematic.ListCompanyMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyMigrationsResponse>;
|
|
33
33
|
private __listCompanyMigrations;
|
|
34
34
|
/**
|
|
35
35
|
* @param {string} plan_version_company_migration_id - plan_version_company_migration_id
|
|
@@ -65,7 +65,7 @@ export declare class PlanmigrationsClient {
|
|
|
65
65
|
* offset: 1000000
|
|
66
66
|
* })
|
|
67
67
|
*/
|
|
68
|
-
countCompanyMigrations(request
|
|
68
|
+
countCompanyMigrations(request: Schematic.CountCompanyMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCompanyMigrationsResponse>;
|
|
69
69
|
private __countCompanyMigrations;
|
|
70
70
|
/**
|
|
71
71
|
* @param {Schematic.ListMigrationsRequest} request
|
|
@@ -85,7 +85,7 @@ export declare class PlanmigrationsClient {
|
|
|
85
85
|
* offset: 1000000
|
|
86
86
|
* })
|
|
87
87
|
*/
|
|
88
|
-
listMigrations(request
|
|
88
|
+
listMigrations(request: Schematic.ListMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListMigrationsResponse>;
|
|
89
89
|
private __listMigrations;
|
|
90
90
|
/**
|
|
91
91
|
* @param {Schematic.CreateMigrationInput} request
|
|
@@ -99,11 +99,8 @@ export declare class PlanmigrationsClient {
|
|
|
99
99
|
*
|
|
100
100
|
* @example
|
|
101
101
|
* await client.planmigrations.createMigration({
|
|
102
|
-
* companyIds: ["company_ids"],
|
|
103
|
-
* excludedCompanyIds: ["excluded_company_ids"],
|
|
104
102
|
* planId: "plan_id",
|
|
105
103
|
* planVersionIdTo: "plan_version_id_to",
|
|
106
|
-
* planVersionIdsFrom: ["plan_version_ids_from"],
|
|
107
104
|
* strategy: "immediate",
|
|
108
105
|
* targetPlanType: "plan"
|
|
109
106
|
* })
|
|
@@ -160,7 +157,7 @@ export declare class PlanmigrationsClient {
|
|
|
160
157
|
* offset: 1000000
|
|
161
158
|
* })
|
|
162
159
|
*/
|
|
163
|
-
countMigrations(request
|
|
160
|
+
countMigrations(request: Schematic.CountMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountMigrationsResponse>;
|
|
164
161
|
private __countMigrations;
|
|
165
162
|
/**
|
|
166
163
|
* @param {Schematic.PreviewMigrationRequestBody} request
|
|
@@ -174,7 +171,6 @@ export declare class PlanmigrationsClient {
|
|
|
174
171
|
*
|
|
175
172
|
* @example
|
|
176
173
|
* await client.planmigrations.previewMigration({
|
|
177
|
-
* companyIds: ["company_ids"],
|
|
178
174
|
* planId: "plan_id",
|
|
179
175
|
* planVersionIdTo: "plan_version_id_to",
|
|
180
176
|
* targetPlanType: "plan"
|
package/dist/api/resources/planmigrations/client/requests/CountCompanyMigrationsRequest.d.ts
CHANGED
|
@@ -10,7 +10,7 @@ import type * as Schematic from "../../../../index";
|
|
|
10
10
|
* }
|
|
11
11
|
*/
|
|
12
12
|
export interface CountCompanyMigrationsRequest {
|
|
13
|
-
migrationId
|
|
13
|
+
migrationId: string;
|
|
14
14
|
q?: string;
|
|
15
15
|
status?: Schematic.PlanVersionCompanyMigrationStatus;
|
|
16
16
|
/** Page limit (default 100) */
|
|
@@ -9,7 +9,7 @@ import type * as Schematic from "../../../../index";
|
|
|
9
9
|
* }
|
|
10
10
|
*/
|
|
11
11
|
export interface CountMigrationsRequest {
|
|
12
|
-
planVersionId
|
|
12
|
+
planVersionId: string;
|
|
13
13
|
status?: Schematic.PlanVersionMigrationStatus;
|
|
14
14
|
/** Page limit (default 100) */
|
|
15
15
|
limit?: number;
|
|
@@ -2,21 +2,19 @@ import type * as Schematic from "../../../../index";
|
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
|
-
* companyIds: ["company_ids"],
|
|
6
|
-
* excludedCompanyIds: ["excluded_company_ids"],
|
|
7
5
|
* planId: "plan_id",
|
|
8
6
|
* planVersionIdTo: "plan_version_id_to",
|
|
9
|
-
* planVersionIdsFrom: ["plan_version_ids_from"],
|
|
10
7
|
* strategy: "immediate",
|
|
11
8
|
* targetPlanType: "plan"
|
|
12
9
|
* }
|
|
13
10
|
*/
|
|
14
11
|
export interface CreateMigrationInput {
|
|
15
|
-
companyIds
|
|
16
|
-
excludedCompanyIds
|
|
12
|
+
companyIds?: string[];
|
|
13
|
+
excludedCompanyIds?: string[];
|
|
17
14
|
planId: string;
|
|
18
15
|
planVersionIdTo: string;
|
|
19
|
-
planVersionIdsFrom
|
|
16
|
+
planVersionIdsFrom?: string[];
|
|
17
|
+
prorationBehavior?: Schematic.MigrationProrationBehavior;
|
|
20
18
|
strategy: Schematic.PlanVersionMigrationStrategy;
|
|
21
19
|
targetPlanType: Schematic.PlanType;
|
|
22
20
|
}
|
|
@@ -10,7 +10,7 @@ import type * as Schematic from "../../../../index";
|
|
|
10
10
|
* }
|
|
11
11
|
*/
|
|
12
12
|
export interface ListCompanyMigrationsRequest {
|
|
13
|
-
migrationId
|
|
13
|
+
migrationId: string;
|
|
14
14
|
q?: string;
|
|
15
15
|
status?: Schematic.PlanVersionCompanyMigrationStatus;
|
|
16
16
|
/** Page limit (default 100) */
|
|
@@ -9,7 +9,7 @@ import type * as Schematic from "../../../../index";
|
|
|
9
9
|
* }
|
|
10
10
|
*/
|
|
11
11
|
export interface ListMigrationsRequest {
|
|
12
|
-
planVersionId
|
|
12
|
+
planVersionId: string;
|
|
13
13
|
status?: Schematic.PlanVersionMigrationStatus;
|
|
14
14
|
/** Page limit (default 100) */
|
|
15
15
|
limit?: number;
|
|
@@ -2,15 +2,15 @@ import type * as Schematic from "../../../../index";
|
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
|
-
* companyIds: ["company_ids"],
|
|
6
5
|
* planId: "plan_id",
|
|
7
6
|
* planVersionIdTo: "plan_version_id_to",
|
|
8
7
|
* targetPlanType: "plan"
|
|
9
8
|
* }
|
|
10
9
|
*/
|
|
11
10
|
export interface PreviewMigrationRequestBody {
|
|
12
|
-
companyIds
|
|
11
|
+
companyIds?: string[];
|
|
13
12
|
planId: string;
|
|
14
13
|
planVersionIdTo: string;
|
|
14
|
+
planVersionIdsFrom?: string[];
|
|
15
15
|
targetPlanType: Schematic.PlanType;
|
|
16
16
|
}
|
|
@@ -11,7 +11,7 @@ export declare class PlansClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<PlansClient.Options>;
|
|
12
12
|
constructor(options: PlansClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* @param {string}
|
|
14
|
+
* @param {string} company_id - company_id
|
|
15
15
|
* @param {Schematic.UpdateCompanyPlansRequestBody} request
|
|
16
16
|
* @param {PlansClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
17
17
|
*
|
|
@@ -22,11 +22,11 @@ export declare class PlansClient {
|
|
|
22
22
|
* @throws {@link Schematic.InternalServerError}
|
|
23
23
|
*
|
|
24
24
|
* @example
|
|
25
|
-
* await client.plans.updateCompanyPlans("
|
|
25
|
+
* await client.plans.updateCompanyPlans("company_id", {
|
|
26
26
|
* addOnIds: ["add_on_ids"]
|
|
27
27
|
* })
|
|
28
28
|
*/
|
|
29
|
-
updateCompanyPlans(
|
|
29
|
+
updateCompanyPlans(company_id: string, request: Schematic.UpdateCompanyPlansRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdateCompanyPlansResponse>;
|
|
30
30
|
private __updateCompanyPlans;
|
|
31
31
|
/**
|
|
32
32
|
* @param {Schematic.ListCustomPlanBillingsRequest} request
|
|
@@ -42,6 +42,7 @@ export declare class PlansClient {
|
|
|
42
42
|
* await client.plans.listCustomPlanBillings({
|
|
43
43
|
* companyId: "company_id",
|
|
44
44
|
* planId: "plan_id",
|
|
45
|
+
* planBillingSource: "custom_plan",
|
|
45
46
|
* status: "active",
|
|
46
47
|
* statuses: ["active"],
|
|
47
48
|
* limit: 1000000,
|
|
@@ -339,7 +340,7 @@ export declare class PlansClient {
|
|
|
339
340
|
listPlanIssues(request: Schematic.ListPlanIssuesRequest, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.ListPlanIssuesResponse>;
|
|
340
341
|
private __listPlanIssues;
|
|
341
342
|
/**
|
|
342
|
-
* @param {string}
|
|
343
|
+
* @param {string} plan_version_id - plan_version_id
|
|
343
344
|
* @param {Schematic.DeletePlanVersionRequest} request
|
|
344
345
|
* @param {PlansClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
345
346
|
*
|
|
@@ -350,14 +351,14 @@ export declare class PlansClient {
|
|
|
350
351
|
* @throws {@link Schematic.InternalServerError}
|
|
351
352
|
*
|
|
352
353
|
* @example
|
|
353
|
-
* await client.plans.deletePlanVersion("
|
|
354
|
+
* await client.plans.deletePlanVersion("plan_version_id", {
|
|
354
355
|
* promoteArchivedVersion: true
|
|
355
356
|
* })
|
|
356
357
|
*/
|
|
357
|
-
deletePlanVersion(
|
|
358
|
+
deletePlanVersion(plan_version_id: string, request?: Schematic.DeletePlanVersionRequest, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.DeletePlanVersionResponse>;
|
|
358
359
|
private __deletePlanVersion;
|
|
359
360
|
/**
|
|
360
|
-
* @param {string}
|
|
361
|
+
* @param {string} plan_version_id - plan_version_id
|
|
361
362
|
* @param {Schematic.PublishPlanVersionRequestBody} request
|
|
362
363
|
* @param {PlansClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
363
364
|
*
|
|
@@ -368,11 +369,11 @@ export declare class PlansClient {
|
|
|
368
369
|
* @throws {@link Schematic.InternalServerError}
|
|
369
370
|
*
|
|
370
371
|
* @example
|
|
371
|
-
* await client.plans.publishPlanVersion("
|
|
372
|
+
* await client.plans.publishPlanVersion("plan_version_id", {
|
|
372
373
|
* excludedCompanyIds: ["excluded_company_ids"],
|
|
373
374
|
* migrationStrategy: "immediate"
|
|
374
375
|
* })
|
|
375
376
|
*/
|
|
376
|
-
publishPlanVersion(
|
|
377
|
+
publishPlanVersion(plan_version_id: string, request: Schematic.PublishPlanVersionRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.PublishPlanVersionResponse>;
|
|
377
378
|
private __publishPlanVersion;
|
|
378
379
|
}
|
|
@@ -4,6 +4,7 @@ import type * as Schematic from "../../../../index";
|
|
|
4
4
|
* {
|
|
5
5
|
* companyId: "company_id",
|
|
6
6
|
* planId: "plan_id",
|
|
7
|
+
* planBillingSource: "custom_plan",
|
|
7
8
|
* status: "active",
|
|
8
9
|
* statuses: ["active"],
|
|
9
10
|
* limit: 1000000,
|
|
@@ -15,6 +16,8 @@ export interface ListCustomPlanBillingsRequest {
|
|
|
15
16
|
companyId?: string;
|
|
16
17
|
/** Filter by plan ID */
|
|
17
18
|
planId?: string;
|
|
19
|
+
/** Filter by the flow that created the billing record. Defaults to custom_plan. */
|
|
20
|
+
planBillingSource?: Schematic.PlanBillingSource;
|
|
18
21
|
/** Filter by billing status */
|
|
19
22
|
status?: Schematic.CustomPlanBillingStatus;
|
|
20
23
|
/** Filter by multiple billing statuses */
|
|
@@ -16,6 +16,9 @@ export interface PublishPlanVersionRequestBody {
|
|
|
16
16
|
excludedCompanyIds: string[];
|
|
17
17
|
migrationStrategy: Schematic.PlanVersionMigrationStrategy;
|
|
18
18
|
phone?: string;
|
|
19
|
+
prorationBehavior?: Schematic.MigrationProrationBehavior;
|
|
20
|
+
/** Refuse the publish if any company would be migrated onto the new version */
|
|
21
|
+
requireNoMigration?: boolean;
|
|
19
22
|
/** Whether Stripe emails the invoice when it is finalized. Defaults to true. */
|
|
20
23
|
sendInvoice?: boolean;
|
|
21
24
|
taxId?: Schematic.TaxIdInput;
|
|
@@ -9,6 +9,8 @@ export interface ListCustomPlanBillingsParams {
|
|
|
9
9
|
limit?: number;
|
|
10
10
|
/** Page offset (default 0) */
|
|
11
11
|
offset?: number;
|
|
12
|
+
/** Filter by the flow that created the billing record. Defaults to custom_plan. */
|
|
13
|
+
planBillingSource?: Schematic.PlanBillingSource;
|
|
12
14
|
/** Filter by plan ID */
|
|
13
15
|
planId?: string;
|
|
14
16
|
/** Filter by billing status */
|
|
@@ -2,6 +2,8 @@ import type * as Schematic from "../index";
|
|
|
2
2
|
export interface BillingCreditBundleResponseData {
|
|
3
3
|
billingInvoiceId?: string;
|
|
4
4
|
bundleType: Schematic.BillingCreditBundleType;
|
|
5
|
+
/** Plans whose companies may purchase this bundle. Empty means the bundle is purchasable on every plan. */
|
|
6
|
+
compatiblePlanIds: string[];
|
|
5
7
|
createdAt: Date;
|
|
6
8
|
creditDescription?: string;
|
|
7
9
|
creditIcon?: string;
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import type * as Schematic from "../index";
|
|
2
2
|
export interface BillingCreditGrantResponseData {
|
|
3
3
|
companyId: string;
|
|
4
|
+
/** The license instance this grant was issued for. Set only when a per-license plan grant issued it; null on a plan's own grant. */
|
|
5
|
+
companyLicenseId?: string;
|
|
4
6
|
companyName: string;
|
|
5
7
|
createdAt: Date;
|
|
6
8
|
creditIcon?: string;
|
|
@@ -10,6 +12,8 @@ export interface BillingCreditGrantResponseData {
|
|
|
10
12
|
expiresAt?: Date;
|
|
11
13
|
grantReason: Schematic.BillingCreditGrantReason;
|
|
12
14
|
id: string;
|
|
15
|
+
/** Name of the license this grant was issued for, when it came from a per-license plan grant. */
|
|
16
|
+
licenseName?: string;
|
|
13
17
|
planId?: string;
|
|
14
18
|
planName?: string;
|
|
15
19
|
price?: Schematic.BillingPriceResponseData;
|
|
@@ -14,6 +14,8 @@ export interface BillingPlanCreditGrantResponseData {
|
|
|
14
14
|
autoTopupThresholdPercent?: number;
|
|
15
15
|
/** Whether buyers can purchase one-time credit bundles on this grant, independent of auto top-up availability. */
|
|
16
16
|
canBuyBundles: boolean;
|
|
17
|
+
/** Credits granted once per company on top of the per-license amount. Always 0 when scaling is fixed. */
|
|
18
|
+
companyCreditAmount: number;
|
|
17
19
|
createdAt: Date;
|
|
18
20
|
credit?: Schematic.BillingCreditResponseData;
|
|
19
21
|
creditAmount: number;
|
|
@@ -1,4 +1,7 @@
|
|
|
1
|
+
import type * as Schematic from "../index";
|
|
1
2
|
export interface CheckFlagRequestBody {
|
|
2
3
|
company?: Record<string, string>;
|
|
4
|
+
/** Hypothetical usage to evaluate the flag against, for answering "would this action be allowed?" before performing it. Only supported when checking a single flag. Values are caller-asserted and can widen a verdict as well as narrow it, so do not forward untrusted input here when the result gates access. Only the flag value reflects the preflight; the entitlement and usage figures in the response are the company's current, unsimulated ones */
|
|
5
|
+
preflight?: Schematic.PreflightRequestBody;
|
|
3
6
|
user?: Record<string, string>;
|
|
4
7
|
}
|
|
@@ -1,7 +1,10 @@
|
|
|
1
|
+
import type * as Schematic from "../index";
|
|
1
2
|
export interface CheckoutSettingsResponseData {
|
|
3
|
+
bundlePurchaseBehavior: Schematic.CheckoutBundlePurchaseBehavior;
|
|
2
4
|
collectAddress: boolean;
|
|
3
5
|
collectEmail: boolean;
|
|
4
6
|
collectPhone: boolean;
|
|
7
|
+
collectTaxId: boolean;
|
|
5
8
|
optInEnabled: boolean;
|
|
6
9
|
optInText?: string;
|
|
7
10
|
optInTitle?: string;
|
|
@@ -4,6 +4,10 @@ export interface CompanyFeatureUsageExportMetadata {
|
|
|
4
4
|
companyIds?: string[];
|
|
5
5
|
/** Restrict the export to companies with these billing credit type IDs */
|
|
6
6
|
creditTypeIds?: string[];
|
|
7
|
+
/** Company key definition IDs to include as columns, one column per definition, mirroring the companies list */
|
|
8
|
+
entityKeyDefinitionIds?: string[];
|
|
9
|
+
/** Company trait definition IDs to include as columns, one column per definition, mirroring the companies list */
|
|
10
|
+
entityTraitDefinitionIds?: string[];
|
|
7
11
|
/** Schematic feature IDs (starting with 'feat_') to include as usage columns; empty means no usage columns */
|
|
8
12
|
featureIds?: string[];
|
|
9
13
|
/** Restrict the export to companies that do (or do not) have a scheduled downgrade */
|
|
@@ -18,6 +22,8 @@ export interface CompanyFeatureUsageExportMetadata {
|
|
|
18
22
|
planIds?: string[];
|
|
19
23
|
/** Restrict the export to companies on this plan version ID */
|
|
20
24
|
planVersionId?: string;
|
|
25
|
+
/** Restrict the export to companies on a plan version that is no longer published */
|
|
26
|
+
planVersionUnpublished?: boolean;
|
|
21
27
|
/** Free-text search over company name and keys */
|
|
22
28
|
q?: string;
|
|
23
29
|
/** Column to sort the exported rows by (e.g. name, created_at, plan); defaults to name */
|
|
@@ -14,6 +14,7 @@ export interface CompanyPlanCreditGrantView {
|
|
|
14
14
|
companyAutoTopupAmount?: number;
|
|
15
15
|
companyAutoTopupEnabled?: boolean;
|
|
16
16
|
companyAutoTopupThresholdCredits?: number;
|
|
17
|
+
companyCreditAmount: number;
|
|
17
18
|
createdAt: Date;
|
|
18
19
|
credit?: Schematic.BillingCreditView;
|
|
19
20
|
creditAmount: number;
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
import type * as Schematic from "../index";
|
|
2
2
|
export interface ComponentCheckoutSettings {
|
|
3
|
+
bundlePurchaseBehavior: Schematic.CheckoutBundlePurchaseBehavior;
|
|
3
4
|
collectAddress: boolean;
|
|
4
5
|
collectEmail: boolean;
|
|
5
6
|
collectPhone: boolean;
|
|
7
|
+
collectTaxId: boolean;
|
|
6
8
|
prorationBehavior: Schematic.ProrationBehavior;
|
|
7
9
|
taxCollectionEnabled: boolean;
|
|
8
10
|
}
|
|
@@ -12,6 +12,8 @@ export interface CreateBillingPlanCreditGrantRequestBody {
|
|
|
12
12
|
autoTopupThresholdCredits?: number;
|
|
13
13
|
autoTopupThresholdPercent?: number;
|
|
14
14
|
canBuyBundles?: boolean;
|
|
15
|
+
/** Credits granted once per company on top of the per-license amount. Only valid when scaling is per_license. Defaults to 0. */
|
|
16
|
+
companyCreditAmount?: number;
|
|
15
17
|
creditAmount: number;
|
|
16
18
|
creditId: string;
|
|
17
19
|
expiryType?: Schematic.BillingCreditExpiryType;
|
|
@@ -3,6 +3,7 @@ export interface CreditCompanyGrantView {
|
|
|
3
3
|
billingCreditBundleId?: string;
|
|
4
4
|
billingCreditId: string;
|
|
5
5
|
companyId: string;
|
|
6
|
+
companyLicenseId?: string;
|
|
6
7
|
companyName: string;
|
|
7
8
|
createdAt: Date;
|
|
8
9
|
creditDescription: string;
|
|
@@ -16,6 +17,7 @@ export interface CreditCompanyGrantView {
|
|
|
16
17
|
expiryUnitCount?: number;
|
|
17
18
|
grantReason: Schematic.BillingCreditGrantReason;
|
|
18
19
|
id: string;
|
|
20
|
+
licenseName?: string;
|
|
19
21
|
planId?: string;
|
|
20
22
|
planName?: string;
|
|
21
23
|
pluralName?: string;
|
|
@@ -1,12 +1,16 @@
|
|
|
1
1
|
import type * as Schematic from "../index";
|
|
2
2
|
export interface CustomPlanBillingResponseData {
|
|
3
3
|
activationStrategy: Schematic.CustomPlanActivationStrategy;
|
|
4
|
+
/** The billing period renewal date pinned when the subscription started, when one was set. When no invoice exists yet, the first invoice is raised on this date. */
|
|
5
|
+
billingCycleAnchor?: Date;
|
|
4
6
|
companyId: string;
|
|
5
7
|
createdAt: Date;
|
|
6
8
|
daysUntilDue: number;
|
|
7
9
|
externalInvoiceId?: string;
|
|
8
10
|
id: string;
|
|
9
11
|
paidAt?: Date;
|
|
12
|
+
/** The flow that created this billing record: a custom plan, or a standard plan assigned by invoice through Manage Plan. */
|
|
13
|
+
planBillingSource: Schematic.PlanBillingSource;
|
|
10
14
|
planId: string;
|
|
11
15
|
publishedAt?: Date;
|
|
12
16
|
sendInvoice: boolean;
|
|
@@ -7,6 +7,8 @@ export interface EventBodyFlagCheck {
|
|
|
7
7
|
flagId?: string;
|
|
8
8
|
/** The key of the flag being checked */
|
|
9
9
|
flagKey: string;
|
|
10
|
+
/** Whether the check was a preflight, asking whether an action would be allowed rather than reporting one that happened. Absent on ordinary checks */
|
|
11
|
+
preflight?: boolean;
|
|
10
12
|
/** The reason why the value was returned */
|
|
11
13
|
reason: string;
|
|
12
14
|
/** Key-value pairs used to to identify company for which the flag was checked */
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export interface FeatureUsageHistoryResponseData {
|
|
2
|
+
/** Companies are identified by ID only. To report against your own identifiers, resolve them once via the companies API and cache the mapping; keys are not repeated on every row. */
|
|
3
|
+
companyId: string;
|
|
4
|
+
eventSubtype: string;
|
|
5
|
+
featureId: string;
|
|
6
|
+
/** Exclusive end of the period this usage covers */
|
|
7
|
+
periodEnd: Date;
|
|
8
|
+
/** Inclusive start of the period this usage covers */
|
|
9
|
+
periodStart: Date;
|
|
10
|
+
/** Usage recorded within this period; an incremental total, not a running one */
|
|
11
|
+
usage: number;
|
|
12
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type * as Schematic from "../index";
|
|
2
|
+
export interface GetOnboardingStateResp {
|
|
3
|
+
environmentId?: string;
|
|
4
|
+
milestones: Schematic.OnboardingMilestoneView[];
|
|
5
|
+
path?: Schematic.OnboardingPath;
|
|
6
|
+
requirements: Schematic.OnboardingRequirementView[];
|
|
7
|
+
suggestedNext: Schematic.OnboardingRequirement[];
|
|
8
|
+
track?: Schematic.OnboardingTrack;
|
|
9
|
+
}
|