@schematichq/schematic-typescript-node 1.5.8 → 1.5.10

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 (218) hide show
  1. package/README.md +1 -1
  2. package/dist/BaseClient.d.ts +12 -0
  3. package/dist/Client.d.ts +3 -0
  4. package/dist/api/errors/BadRequestError.d.ts +1 -0
  5. package/dist/api/errors/ForbiddenError.d.ts +1 -0
  6. package/dist/api/errors/InternalServerError.d.ts +1 -0
  7. package/dist/api/errors/NotFoundError.d.ts +1 -0
  8. package/dist/api/errors/UnauthorizedError.d.ts +1 -0
  9. package/dist/api/resources/accesstokens/client/Client.d.ts +2 -0
  10. package/dist/api/resources/accounts/client/Client.d.ts +70 -0
  11. package/dist/api/resources/accounts/client/requests/UpdateOnboardingStateRequestBody.d.ts +11 -0
  12. package/dist/api/resources/accounts/client/requests/index.d.ts +1 -0
  13. package/dist/api/resources/accounts/types/GetOnboardingStateResponse.d.ts +6 -0
  14. package/dist/api/resources/accounts/types/UpdateOnboardingStateResponse.d.ts +6 -0
  15. package/dist/api/resources/accounts/types/index.d.ts +2 -0
  16. package/dist/api/resources/billing/client/Client.d.ts +48 -0
  17. package/dist/api/resources/catalogs/client/Client.d.ts +28 -0
  18. package/dist/api/resources/checkout/client/Client.d.ts +18 -0
  19. package/dist/api/resources/companies/client/Client.d.ts +139 -3
  20. package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +3 -0
  21. package/dist/api/resources/companies/client/requests/CountEntityTraitsRequest.d.ts +18 -0
  22. package/dist/api/resources/companies/client/requests/GetBillingEntityChildSubscriptionsRequest.d.ts +1 -1
  23. package/dist/api/resources/companies/client/requests/GetCompanyBillingEntityRequest.d.ts +1 -1
  24. package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +3 -0
  25. package/dist/api/resources/companies/client/requests/ListPlanChangesRequest.d.ts +0 -2
  26. package/dist/api/resources/companies/client/requests/index.d.ts +1 -0
  27. package/dist/api/resources/companies/types/CountCompaniesParams.d.ts +2 -0
  28. package/dist/api/resources/companies/types/CountEntityTraitsParams.d.ts +12 -0
  29. package/dist/api/resources/companies/types/CountEntityTraitsResponse.d.ts +6 -0
  30. package/dist/api/resources/companies/types/DeleteEntityTraitDefinitionResponse.d.ts +6 -0
  31. package/dist/api/resources/companies/types/GetEntityTraitDefinitionUsageResponse.d.ts +6 -0
  32. package/dist/api/resources/companies/types/ListCompaniesParams.d.ts +2 -0
  33. package/dist/api/resources/companies/types/ListPlanChangesParams.d.ts +0 -1
  34. package/dist/api/resources/companies/types/index.d.ts +4 -0
  35. package/dist/api/resources/components/client/Client.d.ts +16 -0
  36. package/dist/api/resources/componentspublic/client/Client.d.ts +2 -0
  37. package/dist/api/resources/credits/client/Client.d.ts +62 -2
  38. package/dist/api/resources/credits/client/requests/CountCompanyGrantsRequest.d.ts +1 -1
  39. package/dist/api/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +2 -0
  40. package/dist/api/resources/credits/client/requests/ListCompanyGrantsRequest.d.ts +1 -1
  41. package/dist/api/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +2 -0
  42. package/dist/api/resources/dataexports/client/Client.d.ts +8 -0
  43. package/dist/api/resources/entitlements/client/Client.d.ts +73 -0
  44. package/dist/api/resources/entitlements/client/requests/ListFeatureUsageHistoryRequest.d.ts +29 -0
  45. package/dist/api/resources/entitlements/client/requests/index.d.ts +1 -0
  46. package/dist/api/resources/entitlements/types/ListFeatureUsageHistoryParams.d.ts +20 -0
  47. package/dist/api/resources/entitlements/types/ListFeatureUsageHistoryResponse.d.ts +6 -0
  48. package/dist/api/resources/entitlements/types/index.d.ts +2 -0
  49. package/dist/api/resources/events/client/Client.d.ts +12 -0
  50. package/dist/api/resources/features/client/Client.d.ts +34 -0
  51. package/dist/api/resources/insights/client/Client.d.ts +12 -0
  52. package/dist/api/resources/integrationsapi/client/Client.d.ts +18 -0
  53. package/dist/api/resources/licenses/client/Client.d.ts +6 -0
  54. package/dist/api/resources/planbundle/client/Client.d.ts +27 -6
  55. package/dist/api/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +11 -3
  56. package/dist/api/resources/planbundle/client/requests/CreatePlanBundleRequestBody.d.ts +6 -2
  57. package/dist/api/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +5 -2
  58. package/dist/api/resources/plangroups/client/Client.d.ts +8 -0
  59. package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +3 -0
  60. package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +3 -0
  61. package/dist/api/resources/planmigrations/client/Client.d.ts +22 -8
  62. package/dist/api/resources/planmigrations/client/requests/CountCompanyMigrationsRequest.d.ts +1 -1
  63. package/dist/api/resources/planmigrations/client/requests/CountMigrationsRequest.d.ts +1 -1
  64. package/dist/api/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +4 -6
  65. package/dist/api/resources/planmigrations/client/requests/ListCompanyMigrationsRequest.d.ts +1 -1
  66. package/dist/api/resources/planmigrations/client/requests/ListMigrationsRequest.d.ts +1 -1
  67. package/dist/api/resources/planmigrations/client/requests/PreviewMigrationRequestBody.d.ts +2 -2
  68. package/dist/api/resources/plans/client/Client.d.ts +46 -12
  69. package/dist/api/resources/plans/client/requests/CreateBillingLinkedPlanRequestBody.d.ts +1 -2
  70. package/dist/api/resources/plans/client/requests/CreateCustomPlanRequestBody.d.ts +2 -2
  71. package/dist/api/resources/plans/client/requests/ListCustomPlanBillingsRequest.d.ts +3 -0
  72. package/dist/api/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +3 -0
  73. package/dist/api/resources/plans/types/ListCustomPlanBillingsParams.d.ts +2 -0
  74. package/dist/api/resources/scheduledcheckout/client/Client.d.ts +8 -0
  75. package/dist/api/resources/webhooks/client/Client.d.ts +20 -0
  76. package/dist/api/types/AuditLogResponseData.d.ts +1 -0
  77. package/dist/api/types/BillingCollectionMethod.d.ts +5 -0
  78. package/dist/api/types/BillingCreditBundleResponseData.d.ts +2 -0
  79. package/dist/api/types/BillingCreditBundleView.d.ts +1 -0
  80. package/dist/api/types/BillingCreditGrantResponseData.d.ts +4 -0
  81. package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +3 -1
  82. package/dist/api/types/CheckFlagRequestBody.d.ts +3 -0
  83. package/dist/api/types/CheckoutBundlePurchaseBehavior.d.ts +5 -0
  84. package/dist/api/types/CheckoutSettingsResponseData.d.ts +3 -0
  85. package/dist/api/types/CompanyBillingCheckoutSettings.d.ts +1 -0
  86. package/dist/api/types/CompanyFeatureUsageExportMetadata.d.ts +6 -0
  87. package/dist/api/types/CompanyPlanCreditGrantView.d.ts +1 -0
  88. package/dist/api/types/ComponentCheckoutSettings.d.ts +2 -0
  89. package/dist/api/types/ComponentHydrateResponseData.d.ts +1 -1
  90. package/dist/api/types/ComponentPreviewResponseData.d.ts +1 -1
  91. package/dist/api/types/CreateBillingPlanCreditGrantRequestBody.d.ts +3 -0
  92. package/dist/api/types/CreateCustomPlanBundlePlanRequestBody.d.ts +1 -1
  93. package/dist/api/types/CreatePlanRequestBody.d.ts +1 -1
  94. package/dist/api/types/CreditCompanyGrantView.d.ts +2 -0
  95. package/dist/api/types/CustomPlanBillingResponseData.d.ts +4 -0
  96. package/dist/api/types/EntityTraitDefinitionUsage.d.ts +8 -0
  97. package/dist/api/types/EventBodyFlagCheck.d.ts +2 -0
  98. package/dist/api/types/FeatureUsageHistoryResponseData.d.ts +12 -0
  99. package/dist/api/types/GetOnboardingStateResp.d.ts +9 -0
  100. package/dist/api/types/ManagePlanRequest.d.ts +14 -0
  101. package/dist/api/types/MigrationProrationBehavior.d.ts +6 -0
  102. package/dist/api/types/OnboardingMilestone.d.ts +5 -0
  103. package/dist/api/types/OnboardingMilestoneView.d.ts +7 -0
  104. package/dist/api/types/OnboardingPath.d.ts +5 -0
  105. package/dist/api/types/OnboardingRequirement.d.ts +9 -0
  106. package/dist/api/types/OnboardingRequirementStatus.d.ts +6 -0
  107. package/dist/api/types/OnboardingRequirementView.d.ts +8 -0
  108. package/dist/api/types/OnboardingTrack.d.ts +5 -0
  109. package/dist/api/types/PlanBillingSource.d.ts +5 -0
  110. package/dist/api/types/PlanBundleResponseData.d.ts +1 -0
  111. package/dist/api/types/PlanChangeResponseData.d.ts +6 -0
  112. package/dist/api/types/PlanCreditGrantView.d.ts +1 -0
  113. package/dist/api/types/PlanVersionMigrationPreviewCompanyResponseData.d.ts +1 -0
  114. package/dist/api/types/PlanVersionMigrationPreviewResponseData.d.ts +1 -0
  115. package/dist/api/types/PlanVersionMigrationResponseData.d.ts +1 -0
  116. package/dist/api/types/PreflightEventUsageRequestBody.d.ts +6 -0
  117. package/dist/api/types/PreflightRequestBody.d.ts +9 -0
  118. package/dist/api/types/PreviewSubscriptionFinanceResponseData.d.ts +2 -0
  119. package/dist/api/types/RulesEngineSchemaVersion.d.ts +1 -1
  120. package/dist/api/types/StripeIntegrationConfig.d.ts +2 -0
  121. package/dist/api/types/UpcomingInvoiceResponseData.d.ts +23 -0
  122. package/dist/api/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +5 -2
  123. package/dist/api/types/UpsertCompanyRequestBody.d.ts +2 -0
  124. package/dist/api/types/UpsertUserRequestBody.d.ts +2 -0
  125. package/dist/api/types/UpsertUserSubRequestBody.d.ts +2 -0
  126. package/dist/api/types/WhoAmIResponseData.d.ts +1 -0
  127. package/dist/api/types/index.d.ts +17 -0
  128. package/dist/core/fetcher/redactUrl.d.ts +2 -0
  129. package/dist/core/requestBody.d.ts +12 -0
  130. package/dist/core/runtime/index.d.ts +1 -1
  131. package/dist/core/runtime/runtime.d.ts +19 -0
  132. package/dist/errors/SchematicError.d.ts +1 -0
  133. package/dist/errors/SchematicTimeoutError.d.ts +2 -2
  134. package/dist/events.d.ts +6 -0
  135. package/dist/index.js +9 -9
  136. package/dist/serialization/resources/accounts/client/requests/UpdateOnboardingStateRequestBody.d.ts +14 -0
  137. package/dist/serialization/resources/accounts/client/requests/index.d.ts +1 -0
  138. package/dist/serialization/resources/accounts/types/GetOnboardingStateResponse.d.ts +11 -0
  139. package/dist/serialization/resources/accounts/types/UpdateOnboardingStateResponse.d.ts +11 -0
  140. package/dist/serialization/resources/accounts/types/index.d.ts +2 -0
  141. package/dist/serialization/resources/companies/types/CountCompaniesParams.d.ts +1 -0
  142. package/dist/serialization/resources/companies/types/CountEntityTraitsParams.d.ts +13 -0
  143. package/dist/serialization/resources/companies/types/CountEntityTraitsResponse.d.ts +12 -0
  144. package/dist/serialization/resources/companies/types/DeleteEntityTraitDefinitionResponse.d.ts +11 -0
  145. package/dist/serialization/resources/companies/types/GetEntityTraitDefinitionUsageResponse.d.ts +11 -0
  146. package/dist/serialization/resources/companies/types/ListCompaniesParams.d.ts +1 -0
  147. package/dist/serialization/resources/companies/types/ListPlanChangesParams.d.ts +0 -1
  148. package/dist/serialization/resources/companies/types/index.d.ts +4 -0
  149. package/dist/serialization/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +1 -0
  150. package/dist/serialization/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +1 -0
  151. package/dist/serialization/resources/entitlements/types/ListFeatureUsageHistoryParams.d.ts +16 -0
  152. package/dist/serialization/resources/entitlements/types/ListFeatureUsageHistoryResponse.d.ts +12 -0
  153. package/dist/serialization/resources/entitlements/types/index.d.ts +2 -0
  154. package/dist/serialization/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +2 -2
  155. package/dist/serialization/resources/planbundle/client/requests/CreatePlanBundleRequestBody.d.ts +1 -1
  156. package/dist/serialization/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +1 -1
  157. package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +3 -0
  158. package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +3 -0
  159. package/dist/serialization/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +5 -3
  160. package/dist/serialization/resources/planmigrations/client/requests/PreviewMigrationRequestBody.d.ts +2 -1
  161. package/dist/serialization/resources/plans/client/requests/CreateBillingLinkedPlanRequestBody.d.ts +1 -1
  162. package/dist/serialization/resources/plans/client/requests/CreateCustomPlanRequestBody.d.ts +2 -1
  163. package/dist/serialization/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +3 -0
  164. package/dist/serialization/resources/plans/types/ListCustomPlanBillingsParams.d.ts +2 -0
  165. package/dist/serialization/types/AuditLogResponseData.d.ts +1 -0
  166. package/dist/serialization/types/BillingCollectionMethod.d.ts +7 -0
  167. package/dist/serialization/types/BillingCreditBundleResponseData.d.ts +1 -0
  168. package/dist/serialization/types/BillingCreditBundleView.d.ts +1 -0
  169. package/dist/serialization/types/BillingCreditGrantResponseData.d.ts +2 -0
  170. package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +1 -0
  171. package/dist/serialization/types/CheckFlagRequestBody.d.ts +2 -0
  172. package/dist/serialization/types/CheckoutBundlePurchaseBehavior.d.ts +7 -0
  173. package/dist/serialization/types/CheckoutSettingsResponseData.d.ts +3 -0
  174. package/dist/serialization/types/CompanyBillingCheckoutSettings.d.ts +1 -0
  175. package/dist/serialization/types/CompanyFeatureUsageExportMetadata.d.ts +3 -0
  176. package/dist/serialization/types/CompanyPlanCreditGrantView.d.ts +1 -0
  177. package/dist/serialization/types/ComponentCheckoutSettings.d.ts +3 -0
  178. package/dist/serialization/types/ComponentHydrateResponseData.d.ts +2 -2
  179. package/dist/serialization/types/ComponentPreviewResponseData.d.ts +2 -1
  180. package/dist/serialization/types/CreateBillingPlanCreditGrantRequestBody.d.ts +1 -0
  181. package/dist/serialization/types/CreateCustomPlanBundlePlanRequestBody.d.ts +1 -1
  182. package/dist/serialization/types/CreatePlanRequestBody.d.ts +1 -1
  183. package/dist/serialization/types/CreditCompanyGrantView.d.ts +2 -0
  184. package/dist/serialization/types/CustomPlanBillingResponseData.d.ts +3 -0
  185. package/dist/serialization/types/EntityTraitDefinitionUsage.d.ts +14 -0
  186. package/dist/serialization/types/EventBodyFlagCheck.d.ts +1 -0
  187. package/dist/serialization/types/FeatureUsageHistoryResponseData.d.ts +14 -0
  188. package/dist/serialization/types/GetOnboardingStateResp.d.ts +19 -0
  189. package/dist/serialization/types/ManagePlanRequest.d.ts +8 -0
  190. package/dist/serialization/types/MigrationProrationBehavior.d.ts +7 -0
  191. package/dist/serialization/types/OnboardingMilestone.d.ts +7 -0
  192. package/dist/serialization/types/OnboardingMilestoneView.d.ts +14 -0
  193. package/dist/serialization/types/OnboardingPath.d.ts +7 -0
  194. package/dist/serialization/types/OnboardingRequirement.d.ts +7 -0
  195. package/dist/serialization/types/OnboardingRequirementStatus.d.ts +7 -0
  196. package/dist/serialization/types/OnboardingRequirementView.d.ts +15 -0
  197. package/dist/serialization/types/OnboardingTrack.d.ts +7 -0
  198. package/dist/serialization/types/PlanBillingSource.d.ts +7 -0
  199. package/dist/serialization/types/PlanBundleResponseData.d.ts +2 -0
  200. package/dist/serialization/types/PlanChangeResponseData.d.ts +4 -0
  201. package/dist/serialization/types/PlanCreditGrantView.d.ts +1 -0
  202. package/dist/serialization/types/PlanVersionMigrationPreviewCompanyResponseData.d.ts +1 -0
  203. package/dist/serialization/types/PlanVersionMigrationPreviewResponseData.d.ts +1 -0
  204. package/dist/serialization/types/PlanVersionMigrationResponseData.d.ts +2 -0
  205. package/dist/serialization/types/PreflightEventUsageRequestBody.d.ts +10 -0
  206. package/dist/serialization/types/PreflightRequestBody.d.ts +12 -0
  207. package/dist/serialization/types/PreviewSubscriptionFinanceResponseData.d.ts +2 -0
  208. package/dist/serialization/types/RulesEngineSchemaVersion.d.ts +1 -1
  209. package/dist/serialization/types/StripeIntegrationConfig.d.ts +1 -0
  210. package/dist/serialization/types/UpcomingInvoiceResponseData.d.ts +30 -0
  211. package/dist/serialization/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +1 -0
  212. package/dist/serialization/types/UpsertCompanyRequestBody.d.ts +1 -0
  213. package/dist/serialization/types/UpsertUserRequestBody.d.ts +1 -0
  214. package/dist/serialization/types/UpsertUserSubRequestBody.d.ts +1 -0
  215. package/dist/serialization/types/WhoAmIResponseData.d.ts +1 -0
  216. package/dist/serialization/types/index.d.ts +17 -0
  217. package/dist/wasm/rulesengine.js +4 -4
  218. package/package.json +4 -1
@@ -14,6 +14,7 @@ export declare namespace CreditCompanyGrantView {
14
14
  billing_credit_bundle_id?: string | null;
15
15
  billing_credit_id: string;
16
16
  company_id: string;
17
+ company_license_id?: string | null;
17
18
  company_name: string;
18
19
  created_at: string;
19
20
  credit_description: string;
@@ -27,6 +28,7 @@ export declare namespace CreditCompanyGrantView {
27
28
  expiry_unit_count?: number | null;
28
29
  grant_reason: BillingCreditGrantReason.Raw;
29
30
  id: string;
31
+ license_name?: string | null;
30
32
  plan_id?: string | null;
31
33
  plan_name?: string | null;
32
34
  plural_name?: string | null;
@@ -3,16 +3,19 @@ import * as core from "../../core";
3
3
  import type * as serializers from "../index";
4
4
  import { CustomPlanActivationStrategy } from "./CustomPlanActivationStrategy";
5
5
  import { CustomPlanBillingStatus } from "./CustomPlanBillingStatus";
6
+ import { PlanBillingSource } from "./PlanBillingSource";
6
7
  export declare const CustomPlanBillingResponseData: core.serialization.ObjectSchema<serializers.CustomPlanBillingResponseData.Raw, Schematic.CustomPlanBillingResponseData>;
7
8
  export declare namespace CustomPlanBillingResponseData {
8
9
  interface Raw {
9
10
  activation_strategy: CustomPlanActivationStrategy.Raw;
11
+ billing_cycle_anchor?: string | null;
10
12
  company_id: string;
11
13
  created_at: string;
12
14
  days_until_due: number;
13
15
  external_invoice_id?: string | null;
14
16
  id: string;
15
17
  paid_at?: string | null;
18
+ plan_billing_source: PlanBillingSource.Raw;
16
19
  plan_id: string;
17
20
  published_at?: string | null;
18
21
  send_invoice: boolean;
@@ -0,0 +1,14 @@
1
+ import type * as Schematic from "../../api/index";
2
+ import * as core from "../../core";
3
+ import type * as serializers from "../index";
4
+ export declare const EntityTraitDefinitionUsage: core.serialization.ObjectSchema<serializers.EntityTraitDefinitionUsage.Raw, Schematic.EntityTraitDefinitionUsage>;
5
+ export declare namespace EntityTraitDefinitionUsage {
6
+ interface Raw {
7
+ checkout_field_config_count: number;
8
+ company_override_count: number;
9
+ feature_count: number;
10
+ plan_entitlement_count: number;
11
+ plan_trait_count: number;
12
+ rule_condition_count: number;
13
+ }
14
+ }
@@ -8,6 +8,7 @@ export declare namespace EventBodyFlagCheck {
8
8
  error?: string | null;
9
9
  flag_id?: string | null;
10
10
  flag_key: string;
11
+ preflight?: boolean | null;
11
12
  reason: string;
12
13
  req_company?: Record<string, string> | null;
13
14
  req_user?: Record<string, string> | null;
@@ -0,0 +1,14 @@
1
+ import type * as Schematic from "../../api/index";
2
+ import * as core from "../../core";
3
+ import type * as serializers from "../index";
4
+ export declare const FeatureUsageHistoryResponseData: core.serialization.ObjectSchema<serializers.FeatureUsageHistoryResponseData.Raw, Schematic.FeatureUsageHistoryResponseData>;
5
+ export declare namespace FeatureUsageHistoryResponseData {
6
+ interface Raw {
7
+ company_id: string;
8
+ event_subtype: string;
9
+ feature_id: string;
10
+ period_end: string;
11
+ period_start: string;
12
+ usage: number;
13
+ }
14
+ }
@@ -0,0 +1,19 @@
1
+ import type * as Schematic from "../../api/index";
2
+ import * as core from "../../core";
3
+ import type * as serializers from "../index";
4
+ import { OnboardingMilestoneView } from "./OnboardingMilestoneView";
5
+ import { OnboardingPath } from "./OnboardingPath";
6
+ import { OnboardingRequirement } from "./OnboardingRequirement";
7
+ import { OnboardingRequirementView } from "./OnboardingRequirementView";
8
+ import { OnboardingTrack } from "./OnboardingTrack";
9
+ export declare const GetOnboardingStateResp: core.serialization.ObjectSchema<serializers.GetOnboardingStateResp.Raw, Schematic.GetOnboardingStateResp>;
10
+ export declare namespace GetOnboardingStateResp {
11
+ interface Raw {
12
+ environment_id?: string | null;
13
+ milestones: OnboardingMilestoneView.Raw[];
14
+ path?: OnboardingPath.Raw | null;
15
+ requirements: OnboardingRequirementView.Raw[];
16
+ suggested_next: OnboardingRequirement.Raw[];
17
+ track?: OnboardingTrack.Raw | null;
18
+ }
19
+ }
@@ -1,6 +1,7 @@
1
1
  import type * as Schematic from "../../api/index";
2
2
  import * as core from "../../core";
3
3
  import type * as serializers from "../index";
4
+ import { BillingCollectionMethod } from "./BillingCollectionMethod";
4
5
  import { CheckoutFieldValue } from "./CheckoutFieldValue";
5
6
  import { PlanSelection } from "./PlanSelection";
6
7
  import { UpdateCreditBundleRequestBody } from "./UpdateCreditBundleRequestBody";
@@ -8,20 +9,27 @@ import { UpdatePayInAdvanceRequestBody } from "./UpdatePayInAdvanceRequestBody";
8
9
  export declare const ManagePlanRequest: core.serialization.ObjectSchema<serializers.ManagePlanRequest.Raw, Schematic.ManagePlanRequest>;
9
10
  export declare namespace ManagePlanRequest {
10
11
  interface Raw {
12
+ activate_on_payment?: boolean | null;
11
13
  add_on_selections: PlanSelection.Raw[];
12
14
  base_plan_id?: string | null;
13
15
  base_plan_price_id?: string | null;
14
16
  base_plan_version_id?: string | null;
17
+ billing_cycle_anchor?: string | null;
18
+ billing_email?: string | null;
15
19
  billing_entity_id?: string | null;
16
20
  cancel_immediately?: boolean | null;
21
+ collection_method?: BillingCollectionMethod.Raw | null;
17
22
  company_id: string;
18
23
  coupon_external_id?: string | null;
19
24
  credit_bundles: UpdateCreditBundleRequestBody.Raw[];
20
25
  custom_field_values: CheckoutFieldValue.Raw[];
26
+ days_until_due?: number | null;
21
27
  pay_in_advance_entitlements: UpdatePayInAdvanceRequestBody.Raw[];
22
28
  payment_method_external_id?: string | null;
23
29
  promo_code?: string | null;
24
30
  prorate?: boolean | null;
31
+ prorate_first_period?: boolean | null;
32
+ send_invoice?: boolean | null;
25
33
  trial_end?: string | null;
26
34
  }
27
35
  }
@@ -0,0 +1,7 @@
1
+ import type * as Schematic from "../../api/index";
2
+ import * as core from "../../core";
3
+ import type * as serializers from "../index";
4
+ export declare const MigrationProrationBehavior: core.serialization.Schema<serializers.MigrationProrationBehavior.Raw, Schematic.MigrationProrationBehavior>;
5
+ export declare namespace MigrationProrationBehavior {
6
+ type Raw = "always_invoice" | "create_prorations" | "none";
7
+ }
@@ -0,0 +1,7 @@
1
+ import type * as Schematic from "../../api/index";
2
+ import * as core from "../../core";
3
+ import type * as serializers from "../index";
4
+ export declare const OnboardingMilestone: core.serialization.Schema<serializers.OnboardingMilestone.Raw, Schematic.OnboardingMilestone>;
5
+ export declare namespace OnboardingMilestone {
6
+ type Raw = "evaluated" | "implemented";
7
+ }
@@ -0,0 +1,14 @@
1
+ import type * as Schematic from "../../api/index";
2
+ import * as core from "../../core";
3
+ import type * as serializers from "../index";
4
+ import { OnboardingMilestone } from "./OnboardingMilestone";
5
+ import { OnboardingRequirement } from "./OnboardingRequirement";
6
+ export declare const OnboardingMilestoneView: core.serialization.ObjectSchema<serializers.OnboardingMilestoneView.Raw, Schematic.OnboardingMilestoneView>;
7
+ export declare namespace OnboardingMilestoneView {
8
+ interface Raw {
9
+ id: OnboardingMilestone.Raw;
10
+ missing: OnboardingRequirement.Raw[];
11
+ progress: number;
12
+ reached_at?: string | null;
13
+ }
14
+ }
@@ -0,0 +1,7 @@
1
+ import type * as Schematic from "../../api/index";
2
+ import * as core from "../../core";
3
+ import type * as serializers from "../index";
4
+ export declare const OnboardingPath: core.serialization.Schema<serializers.OnboardingPath.Raw, Schematic.OnboardingPath>;
5
+ export declare namespace OnboardingPath {
6
+ type Raw = "agent" | "app";
7
+ }
@@ -0,0 +1,7 @@
1
+ import type * as Schematic from "../../api/index";
2
+ import * as core from "../../core";
3
+ import type * as serializers from "../index";
4
+ export declare const OnboardingRequirement: core.serialization.Schema<serializers.OnboardingRequirement.Raw, Schematic.OnboardingRequirement>;
5
+ export declare namespace OnboardingRequirement {
6
+ type Raw = "connect_billing" | "create_api_key" | "first_flag_check" | "import_companies" | "model_packaging" | "send_events";
7
+ }
@@ -0,0 +1,7 @@
1
+ import type * as Schematic from "../../api/index";
2
+ import * as core from "../../core";
3
+ import type * as serializers from "../index";
4
+ export declare const OnboardingRequirementStatus: core.serialization.Schema<serializers.OnboardingRequirementStatus.Raw, Schematic.OnboardingRequirementStatus>;
5
+ export declare namespace OnboardingRequirementStatus {
6
+ type Raw = "available" | "blocked" | "complete";
7
+ }
@@ -0,0 +1,15 @@
1
+ import type * as Schematic from "../../api/index";
2
+ import * as core from "../../core";
3
+ import type * as serializers from "../index";
4
+ import { OnboardingRequirement } from "./OnboardingRequirement";
5
+ import { OnboardingRequirementStatus } from "./OnboardingRequirementStatus";
6
+ export declare const OnboardingRequirementView: core.serialization.ObjectSchema<serializers.OnboardingRequirementView.Raw, Schematic.OnboardingRequirementView>;
7
+ export declare namespace OnboardingRequirementView {
8
+ interface Raw {
9
+ blocked_by?: OnboardingRequirement.Raw[] | null;
10
+ id: OnboardingRequirement.Raw;
11
+ reached_at?: string | null;
12
+ satisfied_by?: string | null;
13
+ status: OnboardingRequirementStatus.Raw;
14
+ }
15
+ }
@@ -0,0 +1,7 @@
1
+ import type * as Schematic from "../../api/index";
2
+ import * as core from "../../core";
3
+ import type * as serializers from "../index";
4
+ export declare const OnboardingTrack: core.serialization.Schema<serializers.OnboardingTrack.Raw, Schematic.OnboardingTrack>;
5
+ export declare namespace OnboardingTrack {
6
+ type Raw = "catalog" | "single_plan";
7
+ }
@@ -0,0 +1,7 @@
1
+ import type * as Schematic from "../../api/index";
2
+ import * as core from "../../core";
3
+ import type * as serializers from "../index";
4
+ export declare const PlanBillingSource: core.serialization.Schema<serializers.PlanBillingSource.Raw, Schematic.PlanBillingSource>;
5
+ export declare namespace PlanBillingSource {
6
+ type Raw = "custom_plan" | "manage_plan";
7
+ }
@@ -5,6 +5,7 @@ import { BillingPlanCreditGrantResponseData } from "./BillingPlanCreditGrantResp
5
5
  import { BillingProductPlanResponseData } from "./BillingProductPlanResponseData";
6
6
  import { PlanEntitlementResponseData } from "./PlanEntitlementResponseData";
7
7
  import { PlanResponseData } from "./PlanResponseData";
8
+ import { PlanVersionResponseData } from "./PlanVersionResponseData";
8
9
  export declare const PlanBundleResponseData: core.serialization.ObjectSchema<serializers.PlanBundleResponseData.Raw, Schematic.PlanBundleResponseData>;
9
10
  export declare namespace PlanBundleResponseData {
10
11
  interface Raw {
@@ -12,5 +13,6 @@ export declare namespace PlanBundleResponseData {
12
13
  credit_grants?: BillingPlanCreditGrantResponseData.Raw[] | null;
13
14
  entitlements?: PlanEntitlementResponseData.Raw[] | null;
14
15
  plan?: PlanResponseData.Raw | null;
16
+ plan_version?: PlanVersionResponseData.Raw | null;
15
17
  }
16
18
  }
@@ -12,6 +12,7 @@ import { PlanChangeSubscriptionAction } from "./PlanChangeSubscriptionAction";
12
12
  import { PlanSnapshotView } from "./PlanSnapshotView";
13
13
  import { PlanVersionSnapshotView } from "./PlanVersionSnapshotView";
14
14
  import { SubscriptionTraitUpdate } from "./SubscriptionTraitUpdate";
15
+ import { TrialStatus } from "./TrialStatus";
15
16
  export declare const PlanChangeResponseData: core.serialization.ObjectSchema<serializers.PlanChangeResponseData.Raw, Schematic.PlanChangeResponseData>;
16
17
  export declare namespace PlanChangeResponseData {
17
18
  interface Raw {
@@ -36,6 +37,9 @@ export declare namespace PlanChangeResponseData {
36
37
  request_id?: string | null;
37
38
  subscription_change_action?: PlanChangeSubscriptionAction.Raw | null;
38
39
  traits_updated: SubscriptionTraitUpdate.Raw[];
40
+ trial_converted_at?: string | null;
41
+ trial_expires_at?: string | null;
42
+ trial_status?: TrialStatus.Raw | null;
39
43
  updated_at: string;
40
44
  user_id?: string | null;
41
45
  user_name?: string | null;
@@ -24,6 +24,7 @@ export declare namespace PlanCreditGrantView {
24
24
  billing_credit_auto_topup_threshold_credits?: number | null;
25
25
  billing_credit_auto_topup_threshold_percent?: number | null;
26
26
  billing_credit_can_buy_bundles: boolean;
27
+ company_credit_amount: number;
27
28
  created_at: string;
28
29
  credit?: BillingCreditView.Raw | null;
29
30
  credit_amount: number;
@@ -10,5 +10,6 @@ export declare namespace PlanVersionMigrationPreviewCompanyResponseData {
10
10
  note?: string | null;
11
11
  plan_version_id_from?: string | null;
12
12
  will_update_subscription: boolean;
13
+ would_fail: boolean;
13
14
  }
14
15
  }
@@ -6,5 +6,6 @@ export declare const PlanVersionMigrationPreviewResponseData: core.serialization
6
6
  export declare namespace PlanVersionMigrationPreviewResponseData {
7
7
  interface Raw {
8
8
  companies: PlanVersionMigrationPreviewCompanyResponseData.Raw[];
9
+ has_billing_changes: boolean;
9
10
  }
10
11
  }
@@ -1,6 +1,7 @@
1
1
  import type * as Schematic from "../../api/index";
2
2
  import * as core from "../../core";
3
3
  import type * as serializers from "../index";
4
+ import { MigrationProrationBehavior } from "./MigrationProrationBehavior";
4
5
  import { PlanVersionMigrationStatus } from "./PlanVersionMigrationStatus";
5
6
  import { PlanVersionMigrationStrategy } from "./PlanVersionMigrationStrategy";
6
7
  export declare const PlanVersionMigrationResponseData: core.serialization.ObjectSchema<serializers.PlanVersionMigrationResponseData.Raw, Schematic.PlanVersionMigrationResponseData>;
@@ -16,6 +17,7 @@ export declare namespace PlanVersionMigrationResponseData {
16
17
  plan_version_id_from?: string | null;
17
18
  plan_version_id_to: string;
18
19
  plan_version_ids_from: string[];
20
+ proration_behavior?: MigrationProrationBehavior.Raw | null;
19
21
  skipped_companies: number;
20
22
  started_at?: string | null;
21
23
  status: PlanVersionMigrationStatus.Raw;
@@ -0,0 +1,10 @@
1
+ import type * as Schematic from "../../api/index";
2
+ import * as core from "../../core";
3
+ import type * as serializers from "../index";
4
+ export declare const PreflightEventUsageRequestBody: core.serialization.ObjectSchema<serializers.PreflightEventUsageRequestBody.Raw, Schematic.PreflightEventUsageRequestBody>;
5
+ export declare namespace PreflightEventUsageRequestBody {
6
+ interface Raw {
7
+ event_subtype: string;
8
+ quantity: number;
9
+ }
10
+ }
@@ -0,0 +1,12 @@
1
+ import type * as Schematic from "../../api/index";
2
+ import * as core from "../../core";
3
+ import type * as serializers from "../index";
4
+ import { PreflightEventUsageRequestBody } from "./PreflightEventUsageRequestBody";
5
+ export declare const PreflightRequestBody: core.serialization.ObjectSchema<serializers.PreflightRequestBody.Raw, Schematic.PreflightRequestBody>;
6
+ export declare namespace PreflightRequestBody {
7
+ interface Raw {
8
+ credit_cost?: Record<string, number> | null;
9
+ event_usage?: PreflightEventUsageRequestBody.Raw | null;
10
+ usage?: number | null;
11
+ }
12
+ }
@@ -7,6 +7,7 @@ export declare const PreviewSubscriptionFinanceResponseData: core.serialization.
7
7
  export declare namespace PreviewSubscriptionFinanceResponseData {
8
8
  interface Raw {
9
9
  amount_off: number;
10
+ discount_amount: number;
10
11
  discounts: PreviewSubscriptionDiscountResponseData.Raw[];
11
12
  due_now: number;
12
13
  new_charges: number;
@@ -15,6 +16,7 @@ export declare namespace PreviewSubscriptionFinanceResponseData {
15
16
  period_start: string;
16
17
  promo_code_applied: boolean;
17
18
  proration: number;
19
+ proration_billed_at?: string | null;
18
20
  tax_amount?: number | null;
19
21
  tax_display_name?: string | null;
20
22
  tax_require_billing_details: boolean;
@@ -3,5 +3,5 @@ import * as core from "../../core";
3
3
  import type * as serializers from "../index";
4
4
  export declare const RulesEngineSchemaVersion: core.serialization.Schema<serializers.RulesEngineSchemaVersion.Raw, Schematic.RulesEngineSchemaVersion>;
5
5
  export declare namespace RulesEngineSchemaVersion {
6
- type Raw = "v5b3e7220" | "placeholder-for-fern-compatibility";
6
+ type Raw = "vc8eb8df4" | "placeholder-for-fern-compatibility";
7
7
  }
@@ -10,5 +10,6 @@ export declare namespace StripeIntegrationConfig {
10
10
  is_sandbox: boolean;
11
11
  live_mode: boolean;
12
12
  onboard_url?: string | null;
13
+ return_to?: string | null;
13
14
  }
14
15
  }
@@ -0,0 +1,30 @@
1
+ import type * as Schematic from "../../api/index";
2
+ import * as core from "../../core";
3
+ import type * as serializers from "../index";
4
+ import { BillingProviderType } from "./BillingProviderType";
5
+ import { InvoiceStatus } from "./InvoiceStatus";
6
+ export declare const UpcomingInvoiceResponseData: core.serialization.ObjectSchema<serializers.UpcomingInvoiceResponseData.Raw, Schematic.UpcomingInvoiceResponseData>;
7
+ export declare namespace UpcomingInvoiceResponseData {
8
+ interface Raw {
9
+ amount_due: number;
10
+ amount_paid: number;
11
+ amount_remaining: number;
12
+ collection_method: string;
13
+ company_id?: string | null;
14
+ created_at: string;
15
+ currency: string;
16
+ customer_external_id: string;
17
+ due_date?: string | null;
18
+ ending_balance: number;
19
+ environment_id: string;
20
+ external_id?: string | null;
21
+ payment_method_external_id?: string | null;
22
+ provider_type: BillingProviderType.Raw;
23
+ starting_balance: number;
24
+ status?: InvoiceStatus.Raw | null;
25
+ subscription_external_id?: string | null;
26
+ subtotal: number;
27
+ updated_at: string;
28
+ url?: string | null;
29
+ }
30
+ }
@@ -24,6 +24,7 @@ export declare namespace UpdateBillingPlanCreditGrantRequestBody {
24
24
  auto_topup_threshold_credits?: number | null;
25
25
  auto_topup_threshold_percent?: number | null;
26
26
  can_buy_bundles?: boolean | null;
27
+ company_credit_amount?: number | null;
27
28
  credit_amount?: number | null;
28
29
  expiry_type?: BillingCreditExpiryType.Raw | null;
29
30
  expiry_unit?: BillingCreditExpiryUnit.Raw | null;
@@ -11,6 +11,7 @@ export declare namespace UpsertCompanyRequestBody {
11
11
  last_seen_at?: string | null;
12
12
  name?: string | null;
13
13
  prevent_key_remap?: boolean | null;
14
+ remove_keys?: string[] | null;
14
15
  traits?: Record<string, unknown> | null;
15
16
  update_only?: boolean | null;
16
17
  }
@@ -12,6 +12,7 @@ export declare namespace UpsertUserRequestBody {
12
12
  keys: Record<string, string>;
13
13
  last_seen_at?: string | null;
14
14
  name?: string | null;
15
+ remove_keys?: string[] | null;
15
16
  traits?: Record<string, unknown> | null;
16
17
  update_only?: boolean | null;
17
18
  }
@@ -10,6 +10,7 @@ export declare namespace UpsertUserSubRequestBody {
10
10
  keys: Record<string, string>;
11
11
  last_seen_at?: string | null;
12
12
  name?: string | null;
13
+ remove_keys?: string[] | null;
13
14
  traits?: Record<string, unknown> | null;
14
15
  update_only?: boolean | null;
15
16
  }
@@ -12,6 +12,7 @@ export declare namespace WhoAmIResponseData {
12
12
  api_key_id?: string | null;
13
13
  environment_id?: string | null;
14
14
  environments: EnvironmentResponseData.Raw[];
15
+ onboarding_complete: boolean;
15
16
  stripe_user_id?: string | null;
16
17
  user_id?: string | null;
17
18
  user_name?: string | null;
@@ -12,6 +12,7 @@ export * from "./ApiKeyScope";
12
12
  export * from "./AuditLogExportMetadata";
13
13
  export * from "./AuditLogListResponseData";
14
14
  export * from "./AuditLogResponseData";
15
+ export * from "./BillingCollectionMethod";
15
16
  export * from "./BillingCouponResponseData";
16
17
  export * from "./BillingCreditAutoTopupAvailability";
17
18
  export * from "./BillingCreditBundleResponseData";
@@ -80,6 +81,7 @@ export * from "./CheckFlagRequestBody";
80
81
  export * from "./CheckFlagResponseData";
81
82
  export * from "./CheckFlagsBulkResponseData";
82
83
  export * from "./CheckFlagsResponseData";
84
+ export * from "./CheckoutBundlePurchaseBehavior";
83
85
  export * from "./CheckoutDataResponseData";
84
86
  export * from "./CheckoutFieldInput";
85
87
  export * from "./CheckoutFieldResponseData";
@@ -204,6 +206,7 @@ export * from "./EntityKeyDefinitionResponseData";
204
206
  export * from "./EntityKeyDetailResponseData";
205
207
  export * from "./EntityKeyResponseData";
206
208
  export * from "./EntityTraitDefinitionResponseData";
209
+ export * from "./EntityTraitDefinitionUsage";
207
210
  export * from "./EntityTraitDetailResponseData";
208
211
  export * from "./EntityTraitResponseData";
209
212
  export * from "./EntityTraitValue";
@@ -237,6 +240,7 @@ export * from "./FeatureLifecyclePhase";
237
240
  export * from "./FeatureResponseData";
238
241
  export * from "./FeatureType";
239
242
  export * from "./FeatureUsageDetailResponseData";
243
+ export * from "./FeatureUsageHistoryResponseData";
240
244
  export * from "./FeatureUsageLegacyResponseData";
241
245
  export * from "./FeatureUsageResponseData";
242
246
  export * from "./FeatureUsageTimeSeriesResponseData";
@@ -247,6 +251,7 @@ export * from "./FlagResponseData";
247
251
  export * from "./FlagType";
248
252
  export * from "./FlagView";
249
253
  export * from "./GenericPreviewObject";
254
+ export * from "./GetOnboardingStateResp";
250
255
  export * from "./InsightsSummaryResponseData";
251
256
  export * from "./InstallIntegrationRequestBody";
252
257
  export * from "./IntegrationCapabilities";
@@ -276,11 +281,20 @@ export * from "./MetricPeriod";
276
281
  export * from "./MetricPeriodMonthReset";
277
282
  export * from "./MetronomeIntegrationConfig";
278
283
  export * from "./MigrationErrorCode";
284
+ export * from "./MigrationProrationBehavior";
279
285
  export * from "./MrrResponseData";
286
+ export * from "./OnboardingMilestone";
287
+ export * from "./OnboardingMilestoneView";
288
+ export * from "./OnboardingPath";
289
+ export * from "./OnboardingRequirement";
290
+ export * from "./OnboardingRequirementStatus";
291
+ export * from "./OnboardingRequirementView";
292
+ export * from "./OnboardingTrack";
280
293
  export * from "./OrbIntegrationConfig";
281
294
  export * from "./OrderedPlansInGroup";
282
295
  export * from "./PaymentMethodRequestBody";
283
296
  export * from "./PaymentMethodResponseData";
297
+ export * from "./PlanBillingSource";
284
298
  export * from "./PlanBundleAction";
285
299
  export * from "./PlanBundleCreditGrantRequestBody";
286
300
  export * from "./PlanBundleEntitlementRequestBody";
@@ -323,6 +337,8 @@ export * from "./PlanVersionResponseData";
323
337
  export * from "./PlanVersionSnapshotView";
324
338
  export * from "./PlanVersionStatus";
325
339
  export * from "./PlanViewPublicResponseData";
340
+ export * from "./PreflightEventUsageRequestBody";
341
+ export * from "./PreflightRequestBody";
326
342
  export * from "./PreviewObject";
327
343
  export * from "./PreviewObjectResponseData";
328
344
  export * from "./PreviewSubscriptionChangeResponseData";
@@ -391,6 +407,7 @@ export * from "./TraitDefinition";
391
407
  export * from "./TraitDefinitionComparableType";
392
408
  export * from "./TraitType";
393
409
  export * from "./TrialStatus";
410
+ export * from "./UpcomingInvoiceResponseData";
394
411
  export * from "./UpdateAddOnRequestBody";
395
412
  export * from "./UpdateAutoTopupOverrideRequestBody";
396
413
  export * from "./UpdateBillingPlanCreditGrantRequestBody";