@schematichq/schematic-typescript-node 1.5.7 → 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.
Files changed (199) hide show
  1. package/README.md +1 -1
  2. package/dist/api/resources/accounts/client/Client.d.ts +28 -0
  3. package/dist/api/resources/accounts/client/requests/UpdateOnboardingStateRequestBody.d.ts +11 -0
  4. package/dist/api/resources/accounts/client/requests/index.d.ts +1 -0
  5. package/dist/api/resources/accounts/types/GetOnboardingStateResponse.d.ts +6 -0
  6. package/dist/api/resources/accounts/types/UpdateOnboardingStateResponse.d.ts +6 -0
  7. package/dist/api/resources/accounts/types/index.d.ts +2 -0
  8. package/dist/api/resources/companies/client/Client.d.ts +88 -3
  9. package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +3 -0
  10. package/dist/api/resources/companies/client/requests/CountEntityKeysRequest.d.ts +18 -0
  11. package/dist/api/resources/companies/client/requests/CountEntityTraitsRequest.d.ts +18 -0
  12. package/dist/api/resources/companies/client/requests/GetBillingEntityChildSubscriptionsRequest.d.ts +1 -1
  13. package/dist/api/resources/companies/client/requests/GetCompanyBillingEntityRequest.d.ts +1 -1
  14. package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +3 -0
  15. package/dist/api/resources/companies/client/requests/ListPlanChangesRequest.d.ts +0 -2
  16. package/dist/api/resources/companies/client/requests/index.d.ts +2 -0
  17. package/dist/api/resources/companies/types/CountCompaniesParams.d.ts +2 -0
  18. package/dist/api/resources/companies/types/CountEntityKeysParams.d.ts +12 -0
  19. package/dist/api/resources/companies/types/CountEntityKeysResponse.d.ts +6 -0
  20. package/dist/api/resources/companies/types/CountEntityTraitsParams.d.ts +12 -0
  21. package/dist/api/resources/companies/types/CountEntityTraitsResponse.d.ts +6 -0
  22. package/dist/api/resources/companies/types/DeleteEntityKeyDefinitionResponse.d.ts +6 -0
  23. package/dist/api/resources/companies/types/DeleteEntityTraitDefinitionResponse.d.ts +6 -0
  24. package/dist/api/resources/companies/types/GetEntityTraitDefinitionUsageResponse.d.ts +6 -0
  25. package/dist/api/resources/companies/types/ListCompaniesParams.d.ts +2 -0
  26. package/dist/api/resources/companies/types/ListPlanChangesParams.d.ts +0 -1
  27. package/dist/api/resources/companies/types/index.d.ts +7 -0
  28. package/dist/api/resources/credits/client/Client.d.ts +2 -2
  29. package/dist/api/resources/credits/client/requests/CountCompanyGrantsRequest.d.ts +1 -1
  30. package/dist/api/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +2 -0
  31. package/dist/api/resources/credits/client/requests/ListCompanyGrantsRequest.d.ts +1 -1
  32. package/dist/api/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +2 -0
  33. package/dist/api/resources/entitlements/client/Client.d.ts +23 -0
  34. package/dist/api/resources/entitlements/client/requests/ListFeatureUsageHistoryRequest.d.ts +29 -0
  35. package/dist/api/resources/entitlements/client/requests/index.d.ts +1 -0
  36. package/dist/api/resources/entitlements/types/ListFeatureUsageHistoryParams.d.ts +20 -0
  37. package/dist/api/resources/entitlements/types/ListFeatureUsageHistoryResponse.d.ts +6 -0
  38. package/dist/api/resources/entitlements/types/index.d.ts +2 -0
  39. package/dist/api/resources/planbundle/client/Client.d.ts +23 -6
  40. package/dist/api/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +12 -3
  41. package/dist/api/resources/planbundle/client/requests/CreatePlanBundleRequestBody.d.ts +7 -2
  42. package/dist/api/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +5 -2
  43. package/dist/api/resources/plangroups/client/Client.d.ts +2 -0
  44. package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +3 -0
  45. package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +3 -0
  46. package/dist/api/resources/planmigrations/client/Client.d.ts +4 -8
  47. package/dist/api/resources/planmigrations/client/requests/CountCompanyMigrationsRequest.d.ts +1 -1
  48. package/dist/api/resources/planmigrations/client/requests/CountMigrationsRequest.d.ts +1 -1
  49. package/dist/api/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +4 -6
  50. package/dist/api/resources/planmigrations/client/requests/ListCompanyMigrationsRequest.d.ts +1 -1
  51. package/dist/api/resources/planmigrations/client/requests/ListMigrationsRequest.d.ts +1 -1
  52. package/dist/api/resources/planmigrations/client/requests/PreviewMigrationRequestBody.d.ts +2 -2
  53. package/dist/api/resources/plans/client/Client.d.ts +10 -9
  54. package/dist/api/resources/plans/client/requests/CreateCustomPlanRequestBody.d.ts +1 -0
  55. package/dist/api/resources/plans/client/requests/ListCustomPlanBillingsRequest.d.ts +3 -0
  56. package/dist/api/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +3 -0
  57. package/dist/api/resources/plans/types/ListCustomPlanBillingsParams.d.ts +2 -0
  58. package/dist/api/types/BillingCollectionMethod.d.ts +5 -0
  59. package/dist/api/types/BillingCreditBundleResponseData.d.ts +2 -0
  60. package/dist/api/types/BillingCreditBundleView.d.ts +1 -0
  61. package/dist/api/types/BillingCreditGrantResponseData.d.ts +4 -0
  62. package/dist/api/types/BillingCreditView.d.ts +1 -1
  63. package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +2 -0
  64. package/dist/api/types/BillingProductRecordResponseData.d.ts +12 -0
  65. package/dist/api/types/CheckFlagRequestBody.d.ts +3 -0
  66. package/dist/api/types/CheckoutBundlePurchaseBehavior.d.ts +5 -0
  67. package/dist/api/types/CheckoutSettingsResponseData.d.ts +3 -0
  68. package/dist/api/types/CompanyBillingCheckoutSettings.d.ts +1 -0
  69. package/dist/api/types/CompanyFeatureUsageExportMetadata.d.ts +15 -2
  70. package/dist/api/types/CompanyFeatureUsageExportMetadataSortOrderDirection.d.ts +6 -0
  71. package/dist/api/types/CompanyFeatureUsageExportMetadataVisibleColumnsItem.d.ts +7 -0
  72. package/dist/api/types/CompanyPlanCreditGrantView.d.ts +1 -0
  73. package/dist/api/types/ComponentCheckoutSettings.d.ts +2 -0
  74. package/dist/api/types/CreateBillingPlanCreditGrantRequestBody.d.ts +2 -0
  75. package/dist/api/types/CreditCompanyGrantView.d.ts +2 -0
  76. package/dist/api/types/CustomPlanBillingResponseData.d.ts +4 -0
  77. package/dist/api/types/DataExportMetadata.d.ts +4 -1
  78. package/dist/api/types/DataExportType.d.ts +1 -0
  79. package/dist/api/types/EntityTraitDefinitionUsage.d.ts +8 -0
  80. package/dist/api/types/EventBodyFlagCheck.d.ts +2 -0
  81. package/dist/api/types/EventExportMetadata.d.ts +19 -0
  82. package/dist/api/types/EventExportMetadataEventTypesItem.d.ts +7 -0
  83. package/dist/api/types/FeatureUsageHistoryResponseData.d.ts +12 -0
  84. package/dist/api/types/FeatureView.d.ts +1 -1
  85. package/dist/api/types/GetOnboardingStateResp.d.ts +9 -0
  86. package/dist/api/types/ManagePlanRequest.d.ts +14 -0
  87. package/dist/api/types/MigrationProrationBehavior.d.ts +6 -0
  88. package/dist/api/types/OnboardingMilestone.d.ts +5 -0
  89. package/dist/api/types/OnboardingMilestoneView.d.ts +7 -0
  90. package/dist/api/types/OnboardingPath.d.ts +5 -0
  91. package/dist/api/types/OnboardingRequirement.d.ts +9 -0
  92. package/dist/api/types/OnboardingRequirementStatus.d.ts +6 -0
  93. package/dist/api/types/OnboardingRequirementView.d.ts +7 -0
  94. package/dist/api/types/OnboardingTrack.d.ts +5 -0
  95. package/dist/api/types/PlanBillingSource.d.ts +5 -0
  96. package/dist/api/types/PlanBundleResponseData.d.ts +1 -0
  97. package/dist/api/types/PlanCreditGrantView.d.ts +1 -0
  98. package/dist/api/types/PlanVersionMigrationPreviewCompanyResponseData.d.ts +1 -0
  99. package/dist/api/types/PlanVersionMigrationPreviewResponseData.d.ts +1 -0
  100. package/dist/api/types/PlanVersionMigrationResponseData.d.ts +1 -0
  101. package/dist/api/types/PreflightEventUsageRequestBody.d.ts +6 -0
  102. package/dist/api/types/PreflightRequestBody.d.ts +9 -0
  103. package/dist/api/types/PreviewSubscriptionFinanceResponseData.d.ts +1 -0
  104. package/dist/api/types/RulesEngineSchemaVersion.d.ts +1 -1
  105. package/dist/api/types/TestWebhookResponseData.d.ts +1 -0
  106. package/dist/api/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +4 -2
  107. package/dist/api/types/UpsertCompanyRequestBody.d.ts +2 -0
  108. package/dist/api/types/UpsertUserRequestBody.d.ts +2 -0
  109. package/dist/api/types/UpsertUserSubRequestBody.d.ts +2 -0
  110. package/dist/api/types/WhoAmIResponseData.d.ts +1 -0
  111. package/dist/api/types/index.d.ts +21 -0
  112. package/dist/index.js +9 -9
  113. package/dist/serialization/resources/accounts/client/requests/UpdateOnboardingStateRequestBody.d.ts +14 -0
  114. package/dist/serialization/resources/accounts/client/requests/index.d.ts +1 -0
  115. package/dist/serialization/resources/accounts/types/GetOnboardingStateResponse.d.ts +11 -0
  116. package/dist/serialization/resources/accounts/types/UpdateOnboardingStateResponse.d.ts +11 -0
  117. package/dist/serialization/resources/accounts/types/index.d.ts +2 -0
  118. package/dist/serialization/resources/companies/types/CountCompaniesParams.d.ts +1 -0
  119. package/dist/serialization/resources/companies/types/CountEntityKeysParams.d.ts +13 -0
  120. package/dist/serialization/resources/companies/types/CountEntityKeysResponse.d.ts +12 -0
  121. package/dist/serialization/resources/companies/types/CountEntityTraitsParams.d.ts +13 -0
  122. package/dist/serialization/resources/companies/types/CountEntityTraitsResponse.d.ts +12 -0
  123. package/dist/serialization/resources/companies/types/DeleteEntityKeyDefinitionResponse.d.ts +11 -0
  124. package/dist/serialization/resources/companies/types/DeleteEntityTraitDefinitionResponse.d.ts +11 -0
  125. package/dist/serialization/resources/companies/types/GetEntityTraitDefinitionUsageResponse.d.ts +11 -0
  126. package/dist/serialization/resources/companies/types/ListCompaniesParams.d.ts +1 -0
  127. package/dist/serialization/resources/companies/types/ListPlanChangesParams.d.ts +0 -1
  128. package/dist/serialization/resources/companies/types/index.d.ts +7 -0
  129. package/dist/serialization/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +1 -0
  130. package/dist/serialization/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +1 -0
  131. package/dist/serialization/resources/entitlements/types/ListFeatureUsageHistoryParams.d.ts +16 -0
  132. package/dist/serialization/resources/entitlements/types/ListFeatureUsageHistoryResponse.d.ts +12 -0
  133. package/dist/serialization/resources/entitlements/types/index.d.ts +2 -0
  134. package/dist/serialization/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +2 -2
  135. package/dist/serialization/resources/planbundle/client/requests/CreatePlanBundleRequestBody.d.ts +1 -1
  136. package/dist/serialization/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +1 -1
  137. package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +3 -0
  138. package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +3 -0
  139. package/dist/serialization/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +5 -3
  140. package/dist/serialization/resources/planmigrations/client/requests/PreviewMigrationRequestBody.d.ts +2 -1
  141. package/dist/serialization/resources/plans/client/requests/CreateCustomPlanRequestBody.d.ts +1 -0
  142. package/dist/serialization/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +3 -0
  143. package/dist/serialization/resources/plans/types/ListCustomPlanBillingsParams.d.ts +2 -0
  144. package/dist/serialization/types/BillingCollectionMethod.d.ts +7 -0
  145. package/dist/serialization/types/BillingCreditBundleResponseData.d.ts +1 -0
  146. package/dist/serialization/types/BillingCreditBundleView.d.ts +1 -0
  147. package/dist/serialization/types/BillingCreditGrantResponseData.d.ts +2 -0
  148. package/dist/serialization/types/BillingCreditView.d.ts +2 -2
  149. package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +1 -0
  150. package/dist/serialization/types/BillingProductRecordResponseData.d.ts +18 -0
  151. package/dist/serialization/types/CheckFlagRequestBody.d.ts +2 -0
  152. package/dist/serialization/types/CheckoutBundlePurchaseBehavior.d.ts +7 -0
  153. package/dist/serialization/types/CheckoutSettingsResponseData.d.ts +3 -0
  154. package/dist/serialization/types/CompanyBillingCheckoutSettings.d.ts +1 -0
  155. package/dist/serialization/types/CompanyFeatureUsageExportMetadata.d.ts +9 -1
  156. package/dist/serialization/types/CompanyFeatureUsageExportMetadataSortOrderDirection.d.ts +7 -0
  157. package/dist/serialization/types/CompanyFeatureUsageExportMetadataVisibleColumnsItem.d.ts +7 -0
  158. package/dist/serialization/types/CompanyPlanCreditGrantView.d.ts +1 -0
  159. package/dist/serialization/types/ComponentCheckoutSettings.d.ts +3 -0
  160. package/dist/serialization/types/CreateBillingPlanCreditGrantRequestBody.d.ts +1 -0
  161. package/dist/serialization/types/CreditCompanyGrantView.d.ts +2 -0
  162. package/dist/serialization/types/CustomPlanBillingResponseData.d.ts +3 -0
  163. package/dist/serialization/types/DataExportMetadata.d.ts +5 -1
  164. package/dist/serialization/types/DataExportType.d.ts +1 -1
  165. package/dist/serialization/types/EntityTraitDefinitionUsage.d.ts +14 -0
  166. package/dist/serialization/types/EventBodyFlagCheck.d.ts +1 -0
  167. package/dist/serialization/types/EventExportMetadata.d.ts +17 -0
  168. package/dist/serialization/types/EventExportMetadataEventTypesItem.d.ts +7 -0
  169. package/dist/serialization/types/FeatureUsageHistoryResponseData.d.ts +14 -0
  170. package/dist/serialization/types/FeatureView.d.ts +2 -2
  171. package/dist/serialization/types/GetOnboardingStateResp.d.ts +19 -0
  172. package/dist/serialization/types/ManagePlanRequest.d.ts +8 -0
  173. package/dist/serialization/types/MigrationProrationBehavior.d.ts +7 -0
  174. package/dist/serialization/types/OnboardingMilestone.d.ts +7 -0
  175. package/dist/serialization/types/OnboardingMilestoneView.d.ts +14 -0
  176. package/dist/serialization/types/OnboardingPath.d.ts +7 -0
  177. package/dist/serialization/types/OnboardingRequirement.d.ts +7 -0
  178. package/dist/serialization/types/OnboardingRequirementStatus.d.ts +7 -0
  179. package/dist/serialization/types/OnboardingRequirementView.d.ts +14 -0
  180. package/dist/serialization/types/OnboardingTrack.d.ts +7 -0
  181. package/dist/serialization/types/PlanBillingSource.d.ts +7 -0
  182. package/dist/serialization/types/PlanBundleResponseData.d.ts +2 -0
  183. package/dist/serialization/types/PlanCreditGrantView.d.ts +1 -0
  184. package/dist/serialization/types/PlanVersionMigrationPreviewCompanyResponseData.d.ts +1 -0
  185. package/dist/serialization/types/PlanVersionMigrationPreviewResponseData.d.ts +1 -0
  186. package/dist/serialization/types/PlanVersionMigrationResponseData.d.ts +2 -0
  187. package/dist/serialization/types/PreflightEventUsageRequestBody.d.ts +10 -0
  188. package/dist/serialization/types/PreflightRequestBody.d.ts +12 -0
  189. package/dist/serialization/types/PreviewSubscriptionFinanceResponseData.d.ts +1 -0
  190. package/dist/serialization/types/RulesEngineSchemaVersion.d.ts +1 -1
  191. package/dist/serialization/types/TestWebhookResponseData.d.ts +1 -0
  192. package/dist/serialization/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +1 -0
  193. package/dist/serialization/types/UpsertCompanyRequestBody.d.ts +1 -0
  194. package/dist/serialization/types/UpsertUserRequestBody.d.ts +1 -0
  195. package/dist/serialization/types/UpsertUserSubRequestBody.d.ts +1 -0
  196. package/dist/serialization/types/WhoAmIResponseData.d.ts +1 -0
  197. package/dist/serialization/types/index.d.ts +21 -0
  198. package/dist/wasm/rulesengine.js +4 -4
  199. package/package.json +4 -1
@@ -0,0 +1,6 @@
1
+ import type * as Schematic from "../../../index";
2
+ export interface ListFeatureUsageHistoryResponse {
3
+ data: Schematic.FeatureUsageHistoryResponseData[];
4
+ /** Input parameters */
5
+ params: Schematic.ListFeatureUsageHistoryParams;
6
+ }
@@ -27,6 +27,8 @@ export * from "./ListCompanyOverridesParams";
27
27
  export * from "./ListCompanyOverridesResponse";
28
28
  export * from "./ListFeatureCompaniesParams";
29
29
  export * from "./ListFeatureCompaniesResponse";
30
+ export * from "./ListFeatureUsageHistoryParams";
31
+ export * from "./ListFeatureUsageHistoryResponse";
30
32
  export * from "./ListFeatureUsageParams";
31
33
  export * from "./ListFeatureUsageResponse";
32
34
  export * from "./ListFeatureUsersParams";
@@ -22,9 +22,18 @@ export declare class PlanbundleClient {
22
22
  *
23
23
  * @example
24
24
  * await client.planbundle.createCustomPlanBundle({
25
+ * billingProduct: {
26
+ * chargeType: "free",
27
+ * isTrialable: true
28
+ * },
25
29
  * entitlements: [{
26
30
  * action: "create"
27
- * }]
31
+ * }],
32
+ * plan: {
33
+ * companyId: "company_id",
34
+ * description: "description",
35
+ * name: "name"
36
+ * }
28
37
  * })
29
38
  */
30
39
  createCustomPlanBundle(request: Schematic.CreateCustomPlanBundleRequestBody, requestOptions?: PlanbundleClient.RequestOptions): core.HttpResponsePromise<Schematic.CreateCustomPlanBundleResponse>;
@@ -43,13 +52,18 @@ export declare class PlanbundleClient {
43
52
  * await client.planbundle.createPlanBundle({
44
53
  * entitlements: [{
45
54
  * action: "create"
46
- * }]
55
+ * }],
56
+ * plan: {
57
+ * description: "description",
58
+ * name: "name",
59
+ * planType: "plan"
60
+ * }
47
61
  * })
48
62
  */
49
63
  createPlanBundle(request: Schematic.CreatePlanBundleRequestBody, requestOptions?: PlanbundleClient.RequestOptions): core.HttpResponsePromise<Schematic.CreatePlanBundleResponse>;
50
64
  private __createPlanBundle;
51
65
  /**
52
- * @param {string} plan_bundle_id - plan_bundle_id
66
+ * @param {string} plan_id - plan_id
53
67
  * @param {Schematic.UpdatePlanBundleRequestBody} request
54
68
  * @param {PlanbundleClient.RequestOptions} requestOptions - Request-specific configuration.
55
69
  *
@@ -60,12 +74,15 @@ export declare class PlanbundleClient {
60
74
  * @throws {@link Schematic.InternalServerError}
61
75
  *
62
76
  * @example
63
- * await client.planbundle.updatePlanBundle("plan_bundle_id", {
77
+ * await client.planbundle.updatePlanBundle("plan_id", {
64
78
  * entitlements: [{
65
79
  * action: "create"
66
- * }]
80
+ * }],
81
+ * plan: {
82
+ * name: "name"
83
+ * }
67
84
  * })
68
85
  */
69
- updatePlanBundle(plan_bundle_id: string, request: Schematic.UpdatePlanBundleRequestBody, requestOptions?: PlanbundleClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdatePlanBundleResponse>;
86
+ updatePlanBundle(plan_id: string, request: Schematic.UpdatePlanBundleRequestBody, requestOptions?: PlanbundleClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdatePlanBundleResponse>;
70
87
  private __updatePlanBundle;
71
88
  }
@@ -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?: Schematic.UpsertBillingProductRequestBody;
20
+ billingProduct: Schematic.UpsertBillingProductRequestBody;
12
21
  creditGrants?: Schematic.PlanBundleCreditGrantRequestBody[];
13
22
  entitlements: Schematic.PlanBundleEntitlementRequestBody[];
14
- plan?: Schematic.CreateCustomPlanBundlePlanRequestBody;
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?: Schematic.CreatePlanRequestBody;
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?: Schematic.UpdatePlanRequestBody;
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?: Schematic.ListCompanyMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyMigrationsResponse>;
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?: Schematic.CountCompanyMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCompanyMigrationsResponse>;
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?: Schematic.ListMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListMigrationsResponse>;
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?: Schematic.CountMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountMigrationsResponse>;
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"
@@ -10,7 +10,7 @@ import type * as Schematic from "../../../../index";
10
10
  * }
11
11
  */
12
12
  export interface CountCompanyMigrationsRequest {
13
- migrationId?: string;
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?: string;
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: string[];
16
- excludedCompanyIds: string[];
12
+ companyIds?: string[];
13
+ excludedCompanyIds?: string[];
17
14
  planId: string;
18
15
  planVersionIdTo: string;
19
- planVersionIdsFrom: string[];
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?: string;
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?: string;
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: string[];
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} company_plan_id - company_plan_id
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("company_plan_id", {
25
+ * await client.plans.updateCompanyPlans("company_id", {
26
26
  * addOnIds: ["add_on_ids"]
27
27
  * })
28
28
  */
29
- updateCompanyPlans(company_plan_id: string, request: Schematic.UpdateCompanyPlansRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdateCompanyPlansResponse>;
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} plan_id - plan_id
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("plan_id", {
354
+ * await client.plans.deletePlanVersion("plan_version_id", {
354
355
  * promoteArchivedVersion: true
355
356
  * })
356
357
  */
357
- deletePlanVersion(plan_id: string, request?: Schematic.DeletePlanVersionRequest, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.DeletePlanVersionResponse>;
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} plan_id - plan_id
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("plan_id", {
372
+ * await client.plans.publishPlanVersion("plan_version_id", {
372
373
  * excludedCompanyIds: ["excluded_company_ids"],
373
374
  * migrationStrategy: "immediate"
374
375
  * })
375
376
  */
376
- publishPlanVersion(plan_id: string, request: Schematic.PublishPlanVersionRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.PublishPlanVersionResponse>;
377
+ publishPlanVersion(plan_version_id: string, request: Schematic.PublishPlanVersionRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.PublishPlanVersionResponse>;
377
378
  private __publishPlanVersion;
378
379
  }
@@ -10,6 +10,7 @@ import type * as Schematic from "../../../../index";
10
10
  export interface CreateCustomPlanRequestBody {
11
11
  companyId: string;
12
12
  copiedFromPlanId?: string;
13
+ copiedPriceId?: string;
13
14
  description: string;
14
15
  icon?: Schematic.PlanIcon;
15
16
  name: string;
@@ -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 */
@@ -0,0 +1,5 @@
1
+ export declare const BillingCollectionMethod: {
2
+ readonly ChargeAutomatically: "charge_automatically";
3
+ readonly SendInvoice: "send_invoice";
4
+ };
5
+ export type BillingCollectionMethod = (typeof BillingCollectionMethod)[keyof typeof BillingCollectionMethod];
@@ -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,7 @@
1
1
  import type * as Schematic from "../index";
2
2
  export interface BillingCreditBundleView {
3
3
  bundleType: Schematic.BillingCreditBundleType;
4
+ compatiblePlanIds: string[];
4
5
  createdAt: Date;
5
6
  creditDescription?: string;
6
7
  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;
@@ -18,7 +18,7 @@ export interface BillingCreditView {
18
18
  price?: Schematic.BillingPriceView;
19
19
  pricePerUnit?: number;
20
20
  pricePerUnitDecimal?: string;
21
- product?: Schematic.BillingProductResponseData;
21
+ product?: Schematic.BillingProductRecordResponseData;
22
22
  singularName?: string;
23
23
  updatedAt: Date;
24
24
  }
@@ -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;
@@ -0,0 +1,12 @@
1
+ import type * as Schematic from "../index";
2
+ export interface BillingProductRecordResponseData {
3
+ accountId: string;
4
+ createdAt: Date;
5
+ environmentId: string;
6
+ externalId: string;
7
+ id: string;
8
+ isActive: boolean;
9
+ name: string;
10
+ providerType: Schematic.BillingProviderType;
11
+ updatedAt: Date;
12
+ }
@@ -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
  }
@@ -0,0 +1,5 @@
1
+ export declare const CheckoutBundlePurchaseBehavior: {
2
+ readonly Individual: "individual";
3
+ readonly Quantity: "quantity";
4
+ };
5
+ export type CheckoutBundlePurchaseBehavior = (typeof CheckoutBundlePurchaseBehavior)[keyof typeof CheckoutBundlePurchaseBehavior];
@@ -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;
@@ -2,4 +2,5 @@ export interface CompanyBillingCheckoutSettings {
2
2
  collectAddress: boolean;
3
3
  collectEmail: boolean;
4
4
  collectPhone: boolean;
5
+ collectTaxId: boolean;
5
6
  }
@@ -1,10 +1,15 @@
1
+ import type * as Schematic from "../index";
1
2
  export interface CompanyFeatureUsageExportMetadata {
2
3
  /** Restrict the export to these Schematic company IDs (starting with 'comp_') */
3
4
  companyIds?: string[];
4
5
  /** Restrict the export to companies with these billing credit type IDs */
5
6
  creditTypeIds?: string[];
6
- /** Schematic feature IDs (starting with 'feat_') to include as usage columns; at least one is required */
7
- featureIds: 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[];
11
+ /** Schematic feature IDs (starting with 'feat_') to include as usage columns; empty means no usage columns */
12
+ featureIds?: string[];
8
13
  /** Restrict the export to companies that do (or do not) have a scheduled downgrade */
9
14
  hasScheduledDowngrade?: boolean;
10
15
  /** Restrict the export to companies with (or without) a monetized subscription */
@@ -17,12 +22,20 @@ export interface CompanyFeatureUsageExportMetadata {
17
22
  planIds?: string[];
18
23
  /** Restrict the export to companies on this plan version ID */
19
24
  planVersionId?: string;
25
+ /** Restrict the export to companies on a plan version that is no longer published */
26
+ planVersionUnpublished?: boolean;
20
27
  /** Free-text search over company name and keys */
21
28
  q?: string;
29
+ /** Column to sort the exported rows by (e.g. name, created_at, plan); defaults to name */
30
+ sortOrderColumn?: string;
31
+ /** Direction to sort the exported rows by; defaults to asc */
32
+ sortOrderDirection?: Schematic.CompanyFeatureUsageExportMetadataSortOrderDirection;
22
33
  /** Restrict the export to companies whose subscription has one of these statuses */
23
34
  subscriptionStatuses?: string[];
24
35
  /** Restrict the export to companies whose subscription has one of these types */
25
36
  subscriptionTypes?: string[];
37
+ /** Company columns to include, mirroring the companies list; omit to include the plan column only */
38
+ visibleColumns?: Schematic.CompanyFeatureUsageExportMetadataVisibleColumnsItem[];
26
39
  /** Restrict the export to companies that have an entitlement for this feature ID */
27
40
  withEntitlementFor?: string;
28
41
  /** Restrict the export to companies with a subscription */
@@ -0,0 +1,6 @@
1
+ /** Direction to sort the exported rows by; defaults to asc */
2
+ export declare const CompanyFeatureUsageExportMetadataSortOrderDirection: {
3
+ readonly Asc: "asc";
4
+ readonly Desc: "desc";
5
+ };
6
+ export type CompanyFeatureUsageExportMetadataSortOrderDirection = (typeof CompanyFeatureUsageExportMetadataSortOrderDirection)[keyof typeof CompanyFeatureUsageExportMetadataSortOrderDirection];
@@ -0,0 +1,7 @@
1
+ export declare const CompanyFeatureUsageExportMetadataVisibleColumnsItem: {
2
+ readonly Plan: "plan";
3
+ readonly Subscription: "subscription";
4
+ readonly Users: "users";
5
+ readonly LastSeenAt: "last_seen_at";
6
+ };
7
+ export type CompanyFeatureUsageExportMetadataVisibleColumnsItem = (typeof CompanyFeatureUsageExportMetadataVisibleColumnsItem)[keyof typeof CompanyFeatureUsageExportMetadataVisibleColumnsItem];