schematichq 1.4.1 → 1.4.3

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 (150) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +3 -3
  3. data/.fern/replay.lock +10 -0
  4. data/.fernignore +3 -0
  5. data/README.md +34 -4
  6. data/WASM_VERSION +1 -1
  7. data/lib/schematic/billing/client.rb +38 -2
  8. data/lib/schematic/billing/types/count_billing_products_params.rb +1 -0
  9. data/lib/schematic/billing/types/count_billing_products_request.rb +1 -0
  10. data/lib/schematic/billing/types/create_billing_price_request_body.rb +1 -0
  11. data/lib/schematic/billing/types/delete_payment_method_by_external_id_response.rb +12 -0
  12. data/lib/schematic/billing/types/list_billing_products_params.rb +1 -0
  13. data/lib/schematic/billing/types/list_billing_products_request.rb +1 -0
  14. data/lib/schematic/client.rb +6 -6
  15. data/lib/schematic/companies/client.rb +6 -2
  16. data/lib/schematic/companies/types/count_companies_params.rb +1 -0
  17. data/lib/schematic/companies/types/count_companies_request.rb +1 -0
  18. data/lib/schematic/companies/types/list_companies_params.rb +1 -0
  19. data/lib/schematic/companies/types/list_companies_request.rb +1 -0
  20. data/lib/schematic/credits/client.rb +108 -2
  21. data/lib/schematic/credits/types/acquire_credit_lease_request_body.rb +14 -0
  22. data/lib/schematic/credits/types/acquire_credit_lease_response.rb +12 -0
  23. data/lib/schematic/credits/types/count_billing_plan_credit_grants_params.rb +1 -0
  24. data/lib/schematic/credits/types/count_billing_plan_credit_grants_request.rb +1 -0
  25. data/lib/schematic/credits/types/extend_credit_lease_request_body.rb +13 -0
  26. data/lib/schematic/credits/types/extend_credit_lease_response.rb +12 -0
  27. data/lib/schematic/credits/types/list_billing_plan_credit_grants_params.rb +1 -0
  28. data/lib/schematic/credits/types/list_billing_plan_credit_grants_request.rb +1 -0
  29. data/lib/schematic/credits/types/release_credit_lease_response.rb +12 -0
  30. data/lib/schematic/datastream/merge.rb +71 -0
  31. data/lib/schematic/datastream/websocket_client.rb +32 -1
  32. data/lib/schematic/entitlements/client.rb +6 -2
  33. data/lib/schematic/entitlements/types/count_feature_usage_params.rb +1 -0
  34. data/lib/schematic/entitlements/types/count_feature_usage_request.rb +1 -0
  35. data/lib/schematic/entitlements/types/create_billing_linked_plan_entitlement_request_body.rb +5 -0
  36. data/lib/schematic/entitlements/types/create_plan_entitlement_request_body.rb +5 -0
  37. data/lib/schematic/entitlements/types/list_feature_usage_params.rb +1 -0
  38. data/lib/schematic/entitlements/types/list_feature_usage_request.rb +1 -0
  39. data/lib/schematic/entitlements/types/update_plan_entitlement_request_body.rb +5 -0
  40. data/lib/schematic/event_buffer.rb +17 -3
  41. data/lib/schematic/events/client.rb +3 -1
  42. data/lib/schematic/events/types/list_events_params.rb +1 -0
  43. data/lib/schematic/events/types/list_events_request.rb +1 -0
  44. data/lib/schematic/features/client.rb +6 -2
  45. data/lib/schematic/features/types/count_features_params.rb +1 -0
  46. data/lib/schematic/features/types/count_features_request.rb +1 -0
  47. data/lib/schematic/features/types/list_features_params.rb +1 -0
  48. data/lib/schematic/features/types/list_features_request.rb +1 -0
  49. data/lib/schematic/integrationsapi/client.rb +177 -0
  50. data/lib/schematic/integrationsapi/types/list_integrations_params.rb +18 -0
  51. data/lib/schematic/integrationsapi/types/list_integrations_request.rb +17 -0
  52. data/lib/schematic/integrationsapi/types/list_integrations_response.rb +12 -0
  53. data/lib/schematic/integrationsapi/types/load_sample_data_set_v_2_response.rb +12 -0
  54. data/lib/schematic/integrationsapi/types/run_integration_response.rb +12 -0
  55. data/lib/schematic/integrationsapi/types/start_data_import_request_body.rb +13 -0
  56. data/lib/schematic/integrationsapi/types/start_data_import_response.rb +12 -0
  57. data/lib/schematic/integrationsapi/types/uninstall_integration_response.rb +12 -0
  58. data/lib/schematic/logger.rb +1 -1
  59. data/lib/schematic/planbundle/client.rb +32 -0
  60. data/lib/schematic/planbundle/types/create_custom_plan_bundle_request_body.rb +13 -0
  61. data/lib/schematic/planbundle/types/create_custom_plan_bundle_response.rb +12 -0
  62. data/lib/schematic/planmigrations/client.rb +101 -0
  63. data/lib/schematic/planmigrations/types/create_migration_input.rb +17 -0
  64. data/lib/schematic/planmigrations/types/create_migration_response.rb +12 -0
  65. data/lib/schematic/planmigrations/types/retry_company_migration_response.rb +12 -0
  66. data/lib/schematic/planmigrations/types/retry_migration_request_body.rb +12 -0
  67. data/lib/schematic/planmigrations/types/retry_migration_response.rb +12 -0
  68. data/lib/schematic/plans/client.rb +43 -2
  69. data/lib/schematic/plans/types/count_plans_params.rb +2 -0
  70. data/lib/schematic/plans/types/count_plans_request.rb +2 -0
  71. data/lib/schematic/plans/types/create_billing_linked_plan_request_body.rb +1 -0
  72. data/lib/schematic/plans/types/list_plans_params.rb +2 -0
  73. data/lib/schematic/plans/types/list_plans_request.rb +2 -0
  74. data/lib/schematic/plans/types/mark_custom_plan_billing_paid_response.rb +12 -0
  75. data/lib/schematic/schematic_client.rb +46 -13
  76. data/lib/schematic/types/api_key_create_response_data.rb +1 -0
  77. data/lib/schematic/types/api_key_integration_response_data.rb +11 -0
  78. data/lib/schematic/types/api_key_response_data.rb +1 -0
  79. data/lib/schematic/types/audit_log_list_response_data.rb +1 -0
  80. data/lib/schematic/types/audit_log_response_data.rb +1 -0
  81. data/lib/schematic/types/billing_credit_bundle_view.rb +1 -1
  82. data/lib/schematic/types/billing_credit_view.rb +1 -0
  83. data/lib/schematic/types/billing_plan_credit_grant_response_data.rb +1 -0
  84. data/lib/schematic/types/billing_price_response_data.rb +1 -0
  85. data/lib/schematic/types/billing_price_view.rb +1 -0
  86. data/lib/schematic/types/billing_product_for_subscription_response_data.rb +1 -0
  87. data/lib/schematic/types/billing_product_plan_response_data.rb +1 -0
  88. data/lib/schematic/types/billing_product_price_response_data.rb +1 -0
  89. data/lib/schematic/types/billing_strategy.rb +13 -0
  90. data/lib/schematic/types/change_subscription_internal_request_body.rb +1 -0
  91. data/lib/schematic/types/change_subscription_request_body.rb +1 -0
  92. data/lib/schematic/types/charge_type.rb +1 -0
  93. data/lib/schematic/types/checkout_subscription.rb +1 -0
  94. data/lib/schematic/types/clerk_integration_config.rb +10 -0
  95. data/lib/schematic/types/company_matching_criteria.rb +12 -0
  96. data/lib/schematic/types/company_plan_credit_grant_view.rb +40 -0
  97. data/lib/schematic/types/company_plan_detail_response_data.rb +4 -1
  98. data/lib/schematic/types/company_plan_with_billing_sub_view.rb +1 -1
  99. data/lib/schematic/types/create_billing_plan_credit_grant_request_body.rb +1 -0
  100. data/lib/schematic/types/create_custom_plan_bundle_plan_request_body.rb +12 -0
  101. data/lib/schematic/types/create_entitlement_in_bundle_request_body.rb +5 -0
  102. data/lib/schematic/types/create_event_request_body.rb +3 -0
  103. data/lib/schematic/types/credit_currency_price.rb +10 -0
  104. data/lib/schematic/types/credit_lease_response_data.rb +16 -0
  105. data/lib/schematic/types/currency_price_request_body.rb +3 -0
  106. data/lib/schematic/types/custom_plan_billing_response_data.rb +1 -0
  107. data/lib/schematic/types/data_event_payload.rb +3 -0
  108. data/lib/schematic/types/duplicate_plan_entitlements_response_response_data.rb +1 -0
  109. data/lib/schematic/types/entitlement_currency_prices_response_data.rb +1 -0
  110. data/lib/schematic/types/event_body_track.rb +1 -0
  111. data/lib/schematic/types/event_detail_response_data.rb +2 -0
  112. data/lib/schematic/types/event_response_data.rb +1 -0
  113. data/lib/schematic/types/feature_company_response_data.rb +1 -0
  114. data/lib/schematic/types/feature_usage_response_data.rb +1 -0
  115. data/lib/schematic/types/feature_view.rb +1 -0
  116. data/lib/schematic/types/integration_capabilities.rb +11 -0
  117. data/lib/schematic/types/integration_config.rb +16 -0
  118. data/lib/schematic/types/integration_response_data.rb +13 -0
  119. data/lib/schematic/types/integration_state.rb +13 -0
  120. data/lib/schematic/types/integration_type.rb +1 -0
  121. data/lib/schematic/types/integrations_data_set_response_data.rb +9 -0
  122. data/lib/schematic/types/integrations_list_response_data.rb +15 -0
  123. data/lib/schematic/types/integrations_response_data.rb +13 -0
  124. data/lib/schematic/types/mark_custom_plan_billing_paid_request_body.rb +23 -0
  125. data/lib/schematic/types/migration_error_code.rb +21 -0
  126. data/lib/schematic/types/orb_integration_config.rb +9 -0
  127. data/lib/schematic/types/plan_credit_grant_view.rb +1 -0
  128. data/lib/schematic/types/plan_currency_price_request_body.rb +1 -0
  129. data/lib/schematic/types/plan_currency_prices_response_data.rb +1 -0
  130. data/lib/schematic/types/plan_detail_response_data.rb +3 -0
  131. data/lib/schematic/types/plan_entitlement_response_data.rb +2 -0
  132. data/lib/schematic/types/plan_group_plan_detail_response_data.rb +4 -1
  133. data/lib/schematic/types/plan_price_cadence.rb +13 -0
  134. data/lib/schematic/types/plan_version_company_migration_response_data.rb +1 -0
  135. data/lib/schematic/types/plan_version_migration_response_data.rb +1 -0
  136. data/lib/schematic/types/plan_view_public_response_data.rb +4 -1
  137. data/lib/schematic/types/release_credit_lease_request_body.rb +23 -0
  138. data/lib/schematic/types/rules_engine_schema_version.rb +1 -1
  139. data/lib/schematic/types/stripe_integration_config.rb +14 -0
  140. data/lib/schematic/types/update_auto_topup_override_request_body.rb +12 -0
  141. data/lib/schematic/types/update_billing_plan_credit_grant_request_body.rb +1 -0
  142. data/lib/schematic/types/upsert_billing_product_request_body.rb +3 -0
  143. data/lib/schematic/types/usage_based_entitlement_request_body.rb +5 -0
  144. data/lib/schematic/types/usage_based_entitlement_response_data.rb +2 -0
  145. data/lib/schematic/types/work_os_integration_config.rb +10 -0
  146. data/lib/schematic/version.rb +1 -1
  147. data/lib/schematic/wasm/rulesengine.wasm +0 -0
  148. data/lib/schematic.rb +55 -10
  149. data/reference.md +1355 -188
  150. metadata +48 -2
data/reference.md CHANGED
@@ -2230,6 +2230,54 @@ client.billing.upsert_payment_method(
2230
2230
  </dl>
2231
2231
 
2232
2232
 
2233
+ </dd>
2234
+ </dl>
2235
+ </details>
2236
+
2237
+ <details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">delete_payment_method_by_external_id</a>(billing_id) -> Schematic::Billing::Types::DeletePaymentMethodByExternalIdResponse</code></summary>
2238
+ <dl>
2239
+ <dd>
2240
+
2241
+ #### 🔌 Usage
2242
+
2243
+ <dl>
2244
+ <dd>
2245
+
2246
+ <dl>
2247
+ <dd>
2248
+
2249
+ ```ruby
2250
+ client.billing.delete_payment_method_by_external_id(billing_id: "billing_id")
2251
+ ```
2252
+ </dd>
2253
+ </dl>
2254
+ </dd>
2255
+ </dl>
2256
+
2257
+ #### ⚙️ Parameters
2258
+
2259
+ <dl>
2260
+ <dd>
2261
+
2262
+ <dl>
2263
+ <dd>
2264
+
2265
+ **billing_id:** `String` — billing_id
2266
+
2267
+ </dd>
2268
+ </dl>
2269
+
2270
+ <dl>
2271
+ <dd>
2272
+
2273
+ **request_options:** `Schematic::Billing::RequestOptions`
2274
+
2275
+ </dd>
2276
+ </dl>
2277
+ </dd>
2278
+ </dl>
2279
+
2280
+
2233
2281
  </dd>
2234
2282
  </dl>
2235
2283
  </details>
@@ -2492,6 +2540,14 @@ client.billing.upsert_billing_price(
2492
2540
  <dl>
2493
2541
  <dd>
2494
2542
 
2543
+ **interval_count:** `Integer`
2544
+
2545
+ </dd>
2546
+ </dl>
2547
+
2548
+ <dl>
2549
+ <dd>
2550
+
2495
2551
  **is_active:** `Internal::Types::Boolean`
2496
2552
 
2497
2553
  </dd>
@@ -2984,6 +3040,7 @@ client.billing.list_billing_products(
2984
3040
  price_usage_type: "licensed",
2985
3041
  provider_type: "orb",
2986
3042
  q: "q",
3043
+ recurring_charges_only: true,
2987
3044
  with_one_time_charges: true,
2988
3045
  with_prices_only: true,
2989
3046
  with_zero_price: true,
@@ -3053,6 +3110,14 @@ client.billing.list_billing_products(
3053
3110
  <dl>
3054
3111
  <dd>
3055
3112
 
3113
+ **recurring_charges_only:** `Internal::Types::Boolean` — Filter to products that have at least one recurring price
3114
+
3115
+ </dd>
3116
+ </dl>
3117
+
3118
+ <dl>
3119
+ <dd>
3120
+
3056
3121
  **with_one_time_charges:** `Internal::Types::Boolean` — Filter products that are one time charges
3057
3122
 
3058
3123
  </dd>
@@ -3133,6 +3198,7 @@ client.billing.count_billing_products(
3133
3198
  price_usage_type: "licensed",
3134
3199
  provider_type: "orb",
3135
3200
  q: "q",
3201
+ recurring_charges_only: true,
3136
3202
  with_one_time_charges: true,
3137
3203
  with_prices_only: true,
3138
3204
  with_zero_price: true,
@@ -3202,6 +3268,14 @@ client.billing.count_billing_products(
3202
3268
  <dl>
3203
3269
  <dd>
3204
3270
 
3271
+ **recurring_charges_only:** `Internal::Types::Boolean` — Filter to products that have at least one recurring price
3272
+
3273
+ </dd>
3274
+ </dl>
3275
+
3276
+ <dl>
3277
+ <dd>
3278
+
3205
3279
  **with_one_time_charges:** `Internal::Types::Boolean` — Filter products that are one time charges
3206
3280
 
3207
3281
  </dd>
@@ -5153,7 +5227,7 @@ client.credits.list_grants_for_credit(
5153
5227
  </dl>
5154
5228
  </details>
5155
5229
 
5156
- <details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">get_enriched_credit_ledger</a>() -> Schematic::Credits::Types::GetEnrichedCreditLedgerResponse</code></summary>
5230
+ <details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">acquire_credit_lease</a>(request) -> Schematic::Credits::Types::AcquireCreditLeaseResponse</code></summary>
5157
5231
  <dl>
5158
5232
  <dd>
5159
5233
 
@@ -5166,15 +5240,10 @@ client.credits.list_grants_for_credit(
5166
5240
  <dd>
5167
5241
 
5168
5242
  ```ruby
5169
- client.credits.get_enriched_credit_ledger(
5243
+ client.credits.acquire_credit_lease(
5170
5244
  company_id: "company_id",
5171
- billing_credit_id: "billing_credit_id",
5172
- feature_id: "feature_id",
5173
- period: "daily",
5174
- start_time: "start_time",
5175
- end_time: "end_time",
5176
- limit: 1000000,
5177
- offset: 1000000
5245
+ credit_type_id: "credit_type_id",
5246
+ requested_amount: 1.1
5178
5247
  )
5179
5248
  ```
5180
5249
  </dd>
@@ -5198,7 +5267,7 @@ client.credits.get_enriched_credit_ledger(
5198
5267
  <dl>
5199
5268
  <dd>
5200
5269
 
5201
- **billing_credit_id:** `String`
5270
+ **credit_type_id:** `String`
5202
5271
 
5203
5272
  </dd>
5204
5273
  </dl>
@@ -5206,7 +5275,7 @@ client.credits.get_enriched_credit_ledger(
5206
5275
  <dl>
5207
5276
  <dd>
5208
5277
 
5209
- **feature_id:** `String`
5278
+ **expires_at:** `String`
5210
5279
 
5211
5280
  </dd>
5212
5281
  </dl>
@@ -5214,7 +5283,7 @@ client.credits.get_enriched_credit_ledger(
5214
5283
  <dl>
5215
5284
  <dd>
5216
5285
 
5217
- **period:** `Schematic::Types::CreditLedgerPeriod`
5286
+ **requested_amount:** `Integer`
5218
5287
 
5219
5288
  </dd>
5220
5289
  </dl>
@@ -5222,15 +5291,50 @@ client.credits.get_enriched_credit_ledger(
5222
5291
  <dl>
5223
5292
  <dd>
5224
5293
 
5225
- **start_time:** `String`
5294
+ **request_options:** `Schematic::Credits::RequestOptions`
5226
5295
 
5227
5296
  </dd>
5228
5297
  </dl>
5298
+ </dd>
5299
+ </dl>
5300
+
5301
+
5302
+ </dd>
5303
+ </dl>
5304
+ </details>
5229
5305
 
5306
+ <details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">extend_credit_lease</a>(lease_id, request) -> Schematic::Credits::Types::ExtendCreditLeaseResponse</code></summary>
5230
5307
  <dl>
5231
5308
  <dd>
5232
5309
 
5233
- **end_time:** `String`
5310
+ #### 🔌 Usage
5311
+
5312
+ <dl>
5313
+ <dd>
5314
+
5315
+ <dl>
5316
+ <dd>
5317
+
5318
+ ```ruby
5319
+ client.credits.extend_credit_lease(
5320
+ lease_id: "lease_id",
5321
+ additional_amount: 1.1
5322
+ )
5323
+ ```
5324
+ </dd>
5325
+ </dl>
5326
+ </dd>
5327
+ </dl>
5328
+
5329
+ #### ⚙️ Parameters
5330
+
5331
+ <dl>
5332
+ <dd>
5333
+
5334
+ <dl>
5335
+ <dd>
5336
+
5337
+ **lease_id:** `String` — lease_id
5234
5338
 
5235
5339
  </dd>
5236
5340
  </dl>
@@ -5238,7 +5342,7 @@ client.credits.get_enriched_credit_ledger(
5238
5342
  <dl>
5239
5343
  <dd>
5240
5344
 
5241
- **limit:** `Integer` — Page limit (default 100)
5345
+ **additional_amount:** `Integer`
5242
5346
 
5243
5347
  </dd>
5244
5348
  </dl>
@@ -5246,7 +5350,7 @@ client.credits.get_enriched_credit_ledger(
5246
5350
  <dl>
5247
5351
  <dd>
5248
5352
 
5249
- **offset:** `Integer` — Page offset (default 0)
5353
+ **expires_at:** `String`
5250
5354
 
5251
5355
  </dd>
5252
5356
  </dl>
@@ -5266,7 +5370,7 @@ client.credits.get_enriched_credit_ledger(
5266
5370
  </dl>
5267
5371
  </details>
5268
5372
 
5269
- <details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">count_credit_ledger</a>() -> Schematic::Credits::Types::CountCreditLedgerResponse</code></summary>
5373
+ <details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">release_credit_lease</a>(lease_id, request) -> Schematic::Credits::Types::ReleaseCreditLeaseResponse</code></summary>
5270
5374
  <dl>
5271
5375
  <dd>
5272
5376
 
@@ -5279,7 +5383,66 @@ client.credits.get_enriched_credit_ledger(
5279
5383
  <dd>
5280
5384
 
5281
5385
  ```ruby
5282
- client.credits.count_credit_ledger(
5386
+ client.credits.release_credit_lease(
5387
+ lease_id: "lease_id",
5388
+ request: {}
5389
+ )
5390
+ ```
5391
+ </dd>
5392
+ </dl>
5393
+ </dd>
5394
+ </dl>
5395
+
5396
+ #### ⚙️ Parameters
5397
+
5398
+ <dl>
5399
+ <dd>
5400
+
5401
+ <dl>
5402
+ <dd>
5403
+
5404
+ **lease_id:** `String` — lease_id
5405
+
5406
+ </dd>
5407
+ </dl>
5408
+
5409
+ <dl>
5410
+ <dd>
5411
+
5412
+ **request:** `Internal::Types::Hash[String, Object]`
5413
+
5414
+ </dd>
5415
+ </dl>
5416
+
5417
+ <dl>
5418
+ <dd>
5419
+
5420
+ **request_options:** `Schematic::Credits::RequestOptions`
5421
+
5422
+ </dd>
5423
+ </dl>
5424
+ </dd>
5425
+ </dl>
5426
+
5427
+
5428
+ </dd>
5429
+ </dl>
5430
+ </details>
5431
+
5432
+ <details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">get_enriched_credit_ledger</a>() -> Schematic::Credits::Types::GetEnrichedCreditLedgerResponse</code></summary>
5433
+ <dl>
5434
+ <dd>
5435
+
5436
+ #### 🔌 Usage
5437
+
5438
+ <dl>
5439
+ <dd>
5440
+
5441
+ <dl>
5442
+ <dd>
5443
+
5444
+ ```ruby
5445
+ client.credits.get_enriched_credit_ledger(
5283
5446
  company_id: "company_id",
5284
5447
  billing_credit_id: "billing_credit_id",
5285
5448
  feature_id: "feature_id",
@@ -5379,7 +5542,7 @@ client.credits.count_credit_ledger(
5379
5542
  </dl>
5380
5543
  </details>
5381
5544
 
5382
- <details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">list_billing_plan_credit_grants</a>() -> Schematic::Credits::Types::ListBillingPlanCreditGrantsResponse</code></summary>
5545
+ <details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">count_credit_ledger</a>() -> Schematic::Credits::Types::CountCreditLedgerResponse</code></summary>
5383
5546
  <dl>
5384
5547
  <dd>
5385
5548
 
@@ -5392,12 +5555,13 @@ client.credits.count_credit_ledger(
5392
5555
  <dd>
5393
5556
 
5394
5557
  ```ruby
5395
- client.credits.list_billing_plan_credit_grants(
5396
- credit_id: "credit_id",
5397
- ids: ["ids"],
5398
- plan_id: "plan_id",
5399
- plan_ids: ["plan_ids"],
5400
- plan_version_id: "plan_version_id",
5558
+ client.credits.count_credit_ledger(
5559
+ company_id: "company_id",
5560
+ billing_credit_id: "billing_credit_id",
5561
+ feature_id: "feature_id",
5562
+ period: "daily",
5563
+ start_time: "start_time",
5564
+ end_time: "end_time",
5401
5565
  limit: 1000000,
5402
5566
  offset: 1000000
5403
5567
  )
@@ -5415,7 +5579,7 @@ client.credits.list_billing_plan_credit_grants(
5415
5579
  <dl>
5416
5580
  <dd>
5417
5581
 
5418
- **credit_id:** `String`
5582
+ **company_id:** `String`
5419
5583
 
5420
5584
  </dd>
5421
5585
  </dl>
@@ -5423,7 +5587,7 @@ client.credits.list_billing_plan_credit_grants(
5423
5587
  <dl>
5424
5588
  <dd>
5425
5589
 
5426
- **ids:** `String`
5590
+ **billing_credit_id:** `String`
5427
5591
 
5428
5592
  </dd>
5429
5593
  </dl>
@@ -5431,7 +5595,7 @@ client.credits.list_billing_plan_credit_grants(
5431
5595
  <dl>
5432
5596
  <dd>
5433
5597
 
5434
- **plan_id:** `String`
5598
+ **feature_id:** `String`
5435
5599
 
5436
5600
  </dd>
5437
5601
  </dl>
@@ -5439,7 +5603,7 @@ client.credits.list_billing_plan_credit_grants(
5439
5603
  <dl>
5440
5604
  <dd>
5441
5605
 
5442
- **plan_ids:** `String`
5606
+ **period:** `Schematic::Types::CreditLedgerPeriod`
5443
5607
 
5444
5608
  </dd>
5445
5609
  </dl>
@@ -5447,7 +5611,15 @@ client.credits.list_billing_plan_credit_grants(
5447
5611
  <dl>
5448
5612
  <dd>
5449
5613
 
5450
- **plan_version_id:** `String`
5614
+ **start_time:** `String`
5615
+
5616
+ </dd>
5617
+ </dl>
5618
+
5619
+ <dl>
5620
+ <dd>
5621
+
5622
+ **end_time:** `String`
5451
5623
 
5452
5624
  </dd>
5453
5625
  </dl>
@@ -5483,7 +5655,7 @@ client.credits.list_billing_plan_credit_grants(
5483
5655
  </dl>
5484
5656
  </details>
5485
5657
 
5486
- <details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">create_billing_plan_credit_grant</a>(request) -> Schematic::Credits::Types::CreateBillingPlanCreditGrantResponse</code></summary>
5658
+ <details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">list_billing_plan_credit_grants</a>() -> Schematic::Credits::Types::ListBillingPlanCreditGrantsResponse</code></summary>
5487
5659
  <dl>
5488
5660
  <dd>
5489
5661
 
@@ -5496,12 +5668,15 @@ client.credits.list_billing_plan_credit_grants(
5496
5668
  <dd>
5497
5669
 
5498
5670
  ```ruby
5499
- client.credits.create_billing_plan_credit_grant(
5500
- credit_amount: 1000000,
5671
+ client.credits.list_billing_plan_credit_grants(
5501
5672
  credit_id: "credit_id",
5673
+ ids: ["ids"],
5502
5674
  plan_id: "plan_id",
5503
- reset_cadence: "daily",
5504
- reset_start: "billing_period"
5675
+ plan_ids: ["plan_ids"],
5676
+ plan_version_id: "plan_version_id",
5677
+ plan_version_ids: ["plan_version_ids"],
5678
+ limit: 1000000,
5679
+ offset: 1000000
5505
5680
  )
5506
5681
  ```
5507
5682
  </dd>
@@ -5517,7 +5692,7 @@ client.credits.create_billing_plan_credit_grant(
5517
5692
  <dl>
5518
5693
  <dd>
5519
5694
 
5520
- **request:** `Schematic::Types::CreateBillingPlanCreditGrantRequestBody`
5695
+ **credit_id:** `String`
5521
5696
 
5522
5697
  </dd>
5523
5698
  </dl>
@@ -5525,47 +5700,39 @@ client.credits.create_billing_plan_credit_grant(
5525
5700
  <dl>
5526
5701
  <dd>
5527
5702
 
5528
- **request_options:** `Schematic::Credits::RequestOptions`
5703
+ **ids:** `String`
5529
5704
 
5530
5705
  </dd>
5531
5706
  </dl>
5532
- </dd>
5533
- </dl>
5534
5707
 
5708
+ <dl>
5709
+ <dd>
5535
5710
 
5711
+ **plan_id:** `String`
5712
+
5536
5713
  </dd>
5537
5714
  </dl>
5538
- </details>
5539
5715
 
5540
- <details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">get_single_billing_plan_credit_grant</a>(plan_grant_id) -> Schematic::Credits::Types::GetSingleBillingPlanCreditGrantResponse</code></summary>
5541
5716
  <dl>
5542
5717
  <dd>
5543
5718
 
5544
- #### 🔌 Usage
5545
-
5546
- <dl>
5547
- <dd>
5719
+ **plan_ids:** `String`
5720
+
5721
+ </dd>
5722
+ </dl>
5548
5723
 
5549
5724
  <dl>
5550
5725
  <dd>
5551
5726
 
5552
- ```ruby
5553
- client.credits.get_single_billing_plan_credit_grant(plan_grant_id: "plan_grant_id")
5554
- ```
5555
- </dd>
5556
- </dl>
5727
+ **plan_version_id:** `String`
5728
+
5557
5729
  </dd>
5558
5730
  </dl>
5559
5731
 
5560
- #### ⚙️ Parameters
5561
-
5562
- <dl>
5563
- <dd>
5564
-
5565
5732
  <dl>
5566
5733
  <dd>
5567
5734
 
5568
- **plan_grant_id:** `String` — plan_grant_id
5735
+ **plan_version_ids:** `String`
5569
5736
 
5570
5737
  </dd>
5571
5738
  </dl>
@@ -5573,11 +5740,129 @@ client.credits.get_single_billing_plan_credit_grant(plan_grant_id: "plan_grant_i
5573
5740
  <dl>
5574
5741
  <dd>
5575
5742
 
5576
- **request_options:** `Schematic::Credits::RequestOptions`
5743
+ **limit:** `Integer` — Page limit (default 100)
5577
5744
 
5578
5745
  </dd>
5579
5746
  </dl>
5580
- </dd>
5747
+
5748
+ <dl>
5749
+ <dd>
5750
+
5751
+ **offset:** `Integer` — Page offset (default 0)
5752
+
5753
+ </dd>
5754
+ </dl>
5755
+
5756
+ <dl>
5757
+ <dd>
5758
+
5759
+ **request_options:** `Schematic::Credits::RequestOptions`
5760
+
5761
+ </dd>
5762
+ </dl>
5763
+ </dd>
5764
+ </dl>
5765
+
5766
+
5767
+ </dd>
5768
+ </dl>
5769
+ </details>
5770
+
5771
+ <details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">create_billing_plan_credit_grant</a>(request) -> Schematic::Credits::Types::CreateBillingPlanCreditGrantResponse</code></summary>
5772
+ <dl>
5773
+ <dd>
5774
+
5775
+ #### 🔌 Usage
5776
+
5777
+ <dl>
5778
+ <dd>
5779
+
5780
+ <dl>
5781
+ <dd>
5782
+
5783
+ ```ruby
5784
+ client.credits.create_billing_plan_credit_grant(
5785
+ credit_amount: 1000000,
5786
+ credit_id: "credit_id",
5787
+ plan_id: "plan_id",
5788
+ reset_cadence: "daily",
5789
+ reset_start: "billing_period"
5790
+ )
5791
+ ```
5792
+ </dd>
5793
+ </dl>
5794
+ </dd>
5795
+ </dl>
5796
+
5797
+ #### ⚙️ Parameters
5798
+
5799
+ <dl>
5800
+ <dd>
5801
+
5802
+ <dl>
5803
+ <dd>
5804
+
5805
+ **request:** `Schematic::Types::CreateBillingPlanCreditGrantRequestBody`
5806
+
5807
+ </dd>
5808
+ </dl>
5809
+
5810
+ <dl>
5811
+ <dd>
5812
+
5813
+ **request_options:** `Schematic::Credits::RequestOptions`
5814
+
5815
+ </dd>
5816
+ </dl>
5817
+ </dd>
5818
+ </dl>
5819
+
5820
+
5821
+ </dd>
5822
+ </dl>
5823
+ </details>
5824
+
5825
+ <details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">get_single_billing_plan_credit_grant</a>(plan_grant_id) -> Schematic::Credits::Types::GetSingleBillingPlanCreditGrantResponse</code></summary>
5826
+ <dl>
5827
+ <dd>
5828
+
5829
+ #### 🔌 Usage
5830
+
5831
+ <dl>
5832
+ <dd>
5833
+
5834
+ <dl>
5835
+ <dd>
5836
+
5837
+ ```ruby
5838
+ client.credits.get_single_billing_plan_credit_grant(plan_grant_id: "plan_grant_id")
5839
+ ```
5840
+ </dd>
5841
+ </dl>
5842
+ </dd>
5843
+ </dl>
5844
+
5845
+ #### ⚙️ Parameters
5846
+
5847
+ <dl>
5848
+ <dd>
5849
+
5850
+ <dl>
5851
+ <dd>
5852
+
5853
+ **plan_grant_id:** `String` — plan_grant_id
5854
+
5855
+ </dd>
5856
+ </dl>
5857
+
5858
+ <dl>
5859
+ <dd>
5860
+
5861
+ **request_options:** `Schematic::Credits::RequestOptions`
5862
+
5863
+ </dd>
5864
+ </dl>
5865
+ </dd>
5581
5866
  </dl>
5582
5867
 
5583
5868
 
@@ -5723,6 +6008,7 @@ client.credits.count_billing_plan_credit_grants(
5723
6008
  plan_id: "plan_id",
5724
6009
  plan_ids: ["plan_ids"],
5725
6010
  plan_version_id: "plan_version_id",
6011
+ plan_version_ids: ["plan_version_ids"],
5726
6012
  limit: 1000000,
5727
6013
  offset: 1000000
5728
6014
  )
@@ -5780,6 +6066,14 @@ client.credits.count_billing_plan_credit_grants(
5780
6066
  <dl>
5781
6067
  <dd>
5782
6068
 
6069
+ **plan_version_ids:** `String`
6070
+
6071
+ </dd>
6072
+ </dl>
6073
+
6074
+ <dl>
6075
+ <dd>
6076
+
5783
6077
  **limit:** `Integer` — Page limit (default 100)
5784
6078
 
5785
6079
  </dd>
@@ -6053,6 +6347,9 @@ client.checkout.internal(
6053
6347
  add_on_id: "add_on_id",
6054
6348
  price_id: "price_id"
6055
6349
  }],
6350
+ auto_topup_overrides: [{
6351
+ plan_credit_grant_id: "plan_credit_grant_id"
6352
+ }],
6056
6353
  company_id: "company_id",
6057
6354
  credit_bundles: [{
6058
6355
  bundle_id: "bundle_id",
@@ -6174,6 +6471,9 @@ client.checkout.preview_checkout_internal(
6174
6471
  add_on_id: "add_on_id",
6175
6472
  price_id: "price_id"
6176
6473
  }],
6474
+ auto_topup_overrides: [{
6475
+ plan_credit_grant_id: "plan_credit_grant_id"
6476
+ }],
6177
6477
  company_id: "company_id",
6178
6478
  credit_bundles: [{
6179
6479
  bundle_id: "bundle_id",
@@ -6485,6 +6785,7 @@ client.companies.list_companies(
6485
6785
  plan_id: "plan_id",
6486
6786
  plan_ids: ["plan_ids"],
6487
6787
  plan_version_id: "plan_version_id",
6788
+ plan_version_ids: ["plan_version_ids"],
6488
6789
  q: "q",
6489
6790
  sort_order_column: "sort_order_column",
6490
6791
  sort_order_direction: "asc",
@@ -6568,6 +6869,14 @@ client.companies.list_companies(
6568
6869
  <dl>
6569
6870
  <dd>
6570
6871
 
6872
+ **plan_version_ids:** `String` — Filter companies by one or more plan version IDs (each ID starts with plvr_). Takes precedence over plan_version_id when set.
6873
+
6874
+ </dd>
6875
+ </dl>
6876
+
6877
+ <dl>
6878
+ <dd>
6879
+
6571
6880
  **q:** `String` — Search for companies by name, keys or string traits
6572
6881
 
6573
6882
  </dd>
@@ -6863,6 +7172,7 @@ client.companies.count_companies(
6863
7172
  plan_id: "plan_id",
6864
7173
  plan_ids: ["plan_ids"],
6865
7174
  plan_version_id: "plan_version_id",
7175
+ plan_version_ids: ["plan_version_ids"],
6866
7176
  q: "q",
6867
7177
  sort_order_column: "sort_order_column",
6868
7178
  sort_order_direction: "asc",
@@ -6946,6 +7256,14 @@ client.companies.count_companies(
6946
7256
  <dl>
6947
7257
  <dd>
6948
7258
 
7259
+ **plan_version_ids:** `String` — Filter companies by one or more plan version IDs (each ID starts with plvr_). Takes precedence over plan_version_id when set.
7260
+
7261
+ </dd>
7262
+ </dl>
7263
+
7264
+ <dl>
7265
+ <dd>
7266
+
6949
7267
  **q:** `String` — Search for companies by name, keys or string traits
6950
7268
 
6951
7269
  </dd>
@@ -9967,6 +10285,7 @@ client.entitlements.list_feature_usage(
9967
10285
  company_id: "company_id",
9968
10286
  feature_ids: ["feature_ids"],
9969
10287
  include_usage_aggregation: true,
10288
+ managed_by: "orb",
9970
10289
  q: "q",
9971
10290
  without_negative_entitlements: true,
9972
10291
  limit: 1000000,
@@ -10018,6 +10337,14 @@ client.entitlements.list_feature_usage(
10018
10337
  <dl>
10019
10338
  <dd>
10020
10339
 
10340
+ **managed_by:** `Schematic::Types::BillingProviderType` — Filter for features managed by a billing provider, or by Schematic (no billing provider)
10341
+
10342
+ </dd>
10343
+ </dl>
10344
+
10345
+ <dl>
10346
+ <dd>
10347
+
10021
10348
  **q:** `String`
10022
10349
 
10023
10350
  </dd>
@@ -10165,6 +10492,7 @@ client.entitlements.count_feature_usage(
10165
10492
  company_id: "company_id",
10166
10493
  feature_ids: ["feature_ids"],
10167
10494
  include_usage_aggregation: true,
10495
+ managed_by: "orb",
10168
10496
  q: "q",
10169
10497
  without_negative_entitlements: true,
10170
10498
  limit: 1000000,
@@ -10216,6 +10544,14 @@ client.entitlements.count_feature_usage(
10216
10544
  <dl>
10217
10545
  <dd>
10218
10546
 
10547
+ **managed_by:** `Schematic::Types::BillingProviderType` — Filter for features managed by a billing provider, or by Schematic (no billing provider)
10548
+
10549
+ </dd>
10550
+ </dl>
10551
+
10552
+ <dl>
10553
+ <dd>
10554
+
10219
10555
  **q:** `String`
10220
10556
 
10221
10557
  </dd>
@@ -10722,6 +11058,38 @@ client.entitlements.create_plan_entitlement(
10722
11058
  <dl>
10723
11059
  <dd>
10724
11060
 
11061
+ **quarterly_metered_price_id:** `String`
11062
+
11063
+ </dd>
11064
+ </dl>
11065
+
11066
+ <dl>
11067
+ <dd>
11068
+
11069
+ **quarterly_price_tiers:** `Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody]`
11070
+
11071
+ </dd>
11072
+ </dl>
11073
+
11074
+ <dl>
11075
+ <dd>
11076
+
11077
+ **quarterly_unit_price:** `Integer`
11078
+
11079
+ </dd>
11080
+ </dl>
11081
+
11082
+ <dl>
11083
+ <dd>
11084
+
11085
+ **quarterly_unit_price_decimal:** `String`
11086
+
11087
+ </dd>
11088
+ </dl>
11089
+
11090
+ <dl>
11091
+ <dd>
11092
+
10725
11093
  **soft_limit:** `Integer`
10726
11094
 
10727
11095
  </dd>
@@ -10738,6 +11106,14 @@ client.entitlements.create_plan_entitlement(
10738
11106
  <dl>
10739
11107
  <dd>
10740
11108
 
11109
+ **usage_quantity:** `Integer` — The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use.
11110
+
11111
+ </dd>
11112
+ </dl>
11113
+
11114
+ <dl>
11115
+ <dd>
11116
+
10741
11117
  **value_bool:** `Internal::Types::Boolean`
10742
11118
 
10743
11119
  </dd>
@@ -11021,6 +11397,38 @@ client.entitlements.update_plan_entitlement(
11021
11397
  <dl>
11022
11398
  <dd>
11023
11399
 
11400
+ **quarterly_metered_price_id:** `String`
11401
+
11402
+ </dd>
11403
+ </dl>
11404
+
11405
+ <dl>
11406
+ <dd>
11407
+
11408
+ **quarterly_price_tiers:** `Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody]`
11409
+
11410
+ </dd>
11411
+ </dl>
11412
+
11413
+ <dl>
11414
+ <dd>
11415
+
11416
+ **quarterly_unit_price:** `Integer`
11417
+
11418
+ </dd>
11419
+ </dl>
11420
+
11421
+ <dl>
11422
+ <dd>
11423
+
11424
+ **quarterly_unit_price_decimal:** `String`
11425
+
11426
+ </dd>
11427
+ </dl>
11428
+
11429
+ <dl>
11430
+ <dd>
11431
+
11024
11432
  **soft_limit:** `Integer`
11025
11433
 
11026
11434
  </dd>
@@ -11037,6 +11445,14 @@ client.entitlements.update_plan_entitlement(
11037
11445
  <dl>
11038
11446
  <dd>
11039
11447
 
11448
+ **usage_quantity:** `Integer` — The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use.
11449
+
11450
+ </dd>
11451
+ </dl>
11452
+
11453
+ <dl>
11454
+ <dd>
11455
+
11040
11456
  **value_bool:** `Internal::Types::Boolean`
11041
11457
 
11042
11458
  </dd>
@@ -11355,7 +11771,7 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
11355
11771
  <dl>
11356
11772
  <dd>
11357
11773
 
11358
- **soft_limit:** `Integer`
11774
+ **quarterly_metered_price_id:** `String`
11359
11775
 
11360
11776
  </dd>
11361
11777
  </dl>
@@ -11363,7 +11779,7 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
11363
11779
  <dl>
11364
11780
  <dd>
11365
11781
 
11366
- **tier_mode:** `Schematic::Types::BillingTiersMode`
11782
+ **quarterly_price_tiers:** `Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody]`
11367
11783
 
11368
11784
  </dd>
11369
11785
  </dl>
@@ -11371,7 +11787,7 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
11371
11787
  <dl>
11372
11788
  <dd>
11373
11789
 
11374
- **value_bool:** `Internal::Types::Boolean`
11790
+ **quarterly_unit_price:** `Integer`
11375
11791
 
11376
11792
  </dd>
11377
11793
  </dl>
@@ -11379,7 +11795,7 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
11379
11795
  <dl>
11380
11796
  <dd>
11381
11797
 
11382
- **value_credit_id:** `String`
11798
+ **quarterly_unit_price_decimal:** `String`
11383
11799
 
11384
11800
  </dd>
11385
11801
  </dl>
@@ -11387,7 +11803,7 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
11387
11803
  <dl>
11388
11804
  <dd>
11389
11805
 
11390
- **value_numeric:** `Integer`
11806
+ **soft_limit:** `Integer`
11391
11807
 
11392
11808
  </dd>
11393
11809
  </dl>
@@ -11395,7 +11811,7 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
11395
11811
  <dl>
11396
11812
  <dd>
11397
11813
 
11398
- **value_trait_id:** `String`
11814
+ **tier_mode:** `Schematic::Types::BillingTiersMode`
11399
11815
 
11400
11816
  </dd>
11401
11817
  </dl>
@@ -11403,7 +11819,7 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
11403
11819
  <dl>
11404
11820
  <dd>
11405
11821
 
11406
- **value_type:** `Schematic::Types::EntitlementValueType`
11822
+ **usage_quantity:** `Integer` — The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use.
11407
11823
 
11408
11824
  </dd>
11409
11825
  </dl>
@@ -11411,7 +11827,7 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
11411
11827
  <dl>
11412
11828
  <dd>
11413
11829
 
11414
- **yearly_metered_price_id:** `String`
11830
+ **value_bool:** `Internal::Types::Boolean`
11415
11831
 
11416
11832
  </dd>
11417
11833
  </dl>
@@ -11419,7 +11835,7 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
11419
11835
  <dl>
11420
11836
  <dd>
11421
11837
 
11422
- **yearly_price_tiers:** `Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody]`
11838
+ **value_credit_id:** `String`
11423
11839
 
11424
11840
  </dd>
11425
11841
  </dl>
@@ -11427,7 +11843,7 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
11427
11843
  <dl>
11428
11844
  <dd>
11429
11845
 
11430
- **yearly_unit_price:** `Integer`
11846
+ **value_numeric:** `Integer`
11431
11847
 
11432
11848
  </dd>
11433
11849
  </dl>
@@ -11435,7 +11851,7 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
11435
11851
  <dl>
11436
11852
  <dd>
11437
11853
 
11438
- **yearly_unit_price_decimal:** `String`
11854
+ **value_trait_id:** `String`
11439
11855
 
11440
11856
  </dd>
11441
11857
  </dl>
@@ -11443,19 +11859,59 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
11443
11859
  <dl>
11444
11860
  <dd>
11445
11861
 
11446
- **request_options:** `Schematic::Entitlements::RequestOptions`
11862
+ **value_type:** `Schematic::Types::EntitlementValueType`
11447
11863
 
11448
11864
  </dd>
11449
11865
  </dl>
11450
- </dd>
11451
- </dl>
11452
11866
 
11867
+ <dl>
11868
+ <dd>
11453
11869
 
11870
+ **yearly_metered_price_id:** `String`
11871
+
11454
11872
  </dd>
11455
11873
  </dl>
11456
- </details>
11457
11874
 
11458
- <details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">count_plan_entitlements</a>() -> Schematic::Entitlements::Types::CountPlanEntitlementsResponse</code></summary>
11875
+ <dl>
11876
+ <dd>
11877
+
11878
+ **yearly_price_tiers:** `Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody]`
11879
+
11880
+ </dd>
11881
+ </dl>
11882
+
11883
+ <dl>
11884
+ <dd>
11885
+
11886
+ **yearly_unit_price:** `Integer`
11887
+
11888
+ </dd>
11889
+ </dl>
11890
+
11891
+ <dl>
11892
+ <dd>
11893
+
11894
+ **yearly_unit_price_decimal:** `String`
11895
+
11896
+ </dd>
11897
+ </dl>
11898
+
11899
+ <dl>
11900
+ <dd>
11901
+
11902
+ **request_options:** `Schematic::Entitlements::RequestOptions`
11903
+
11904
+ </dd>
11905
+ </dl>
11906
+ </dd>
11907
+ </dl>
11908
+
11909
+
11910
+ </dd>
11911
+ </dl>
11912
+ </details>
11913
+
11914
+ <details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">count_plan_entitlements</a>() -> Schematic::Entitlements::Types::CountPlanEntitlementsResponse</code></summary>
11459
11915
  <dl>
11460
11916
  <dd>
11461
11917
 
@@ -11863,6 +12319,65 @@ client.plans.list_custom_plan_billings(
11863
12319
  </dl>
11864
12320
 
11865
12321
 
12322
+ </dd>
12323
+ </dl>
12324
+ </details>
12325
+
12326
+ <details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">mark_custom_plan_billing_paid</a>(custom_plan_billing_id, request) -> Schematic::Plans::Types::MarkCustomPlanBillingPaidResponse</code></summary>
12327
+ <dl>
12328
+ <dd>
12329
+
12330
+ #### 🔌 Usage
12331
+
12332
+ <dl>
12333
+ <dd>
12334
+
12335
+ <dl>
12336
+ <dd>
12337
+
12338
+ ```ruby
12339
+ client.plans.mark_custom_plan_billing_paid(
12340
+ custom_plan_billing_id: "custom_plan_billing_id",
12341
+ request: {}
12342
+ )
12343
+ ```
12344
+ </dd>
12345
+ </dl>
12346
+ </dd>
12347
+ </dl>
12348
+
12349
+ #### ⚙️ Parameters
12350
+
12351
+ <dl>
12352
+ <dd>
12353
+
12354
+ <dl>
12355
+ <dd>
12356
+
12357
+ **custom_plan_billing_id:** `String` — custom_plan_billing_id
12358
+
12359
+ </dd>
12360
+ </dl>
12361
+
12362
+ <dl>
12363
+ <dd>
12364
+
12365
+ **request:** `Internal::Types::Hash[String, Object]`
12366
+
12367
+ </dd>
12368
+ </dl>
12369
+
12370
+ <dl>
12371
+ <dd>
12372
+
12373
+ **request_options:** `Schematic::Plans::RequestOptions`
12374
+
12375
+ </dd>
12376
+ </dl>
12377
+ </dd>
12378
+ </dl>
12379
+
12380
+
11866
12381
  </dd>
11867
12382
  </dl>
11868
12383
  </details>
@@ -12053,6 +12568,7 @@ client.plans.create_custom_plan(
12053
12568
  ```ruby
12054
12569
  client.plans.list_plans(
12055
12570
  company_id: "company_id",
12571
+ company_scoped_only: true,
12056
12572
  exclude_company_scoped: true,
12057
12573
  for_fallback_plan: true,
12058
12574
  for_initial_plan: true,
@@ -12063,6 +12579,7 @@ client.plans.list_plans(
12063
12579
  plan_type: "plan",
12064
12580
  q: "q",
12065
12581
  scoped_to_company_id: "scoped_to_company_id",
12582
+ with_entitlements: true,
12066
12583
  without_entitlement_for: "without_entitlement_for",
12067
12584
  without_paid_product_id: true,
12068
12585
  limit: 1000000,
@@ -12090,6 +12607,14 @@ client.plans.list_plans(
12090
12607
  <dl>
12091
12608
  <dd>
12092
12609
 
12610
+ **company_scoped_only:** `Internal::Types::Boolean` — Only return plans that are scoped to a company (custom plans assigned to a company)
12611
+
12612
+ </dd>
12613
+ </dl>
12614
+
12615
+ <dl>
12616
+ <dd>
12617
+
12093
12618
  **exclude_company_scoped:** `Internal::Types::Boolean` — Exclude plans that are scoped to a company (custom plans assigned to a company)
12094
12619
 
12095
12620
  </dd>
@@ -12170,6 +12695,14 @@ client.plans.list_plans(
12170
12695
  <dl>
12171
12696
  <dd>
12172
12697
 
12698
+ **with_entitlements:** `Internal::Types::Boolean` — Include each plan's entitlements in the response
12699
+
12700
+ </dd>
12701
+ </dl>
12702
+
12703
+ <dl>
12704
+ <dd>
12705
+
12173
12706
  **without_entitlement_for:** `String` — Filter out plans that already have a plan entitlement for the specified feature ID
12174
12707
 
12175
12708
  </dd>
@@ -12550,6 +13083,14 @@ client.plans.upsert_plan_for_billing_product(
12550
13083
  <dl>
12551
13084
  <dd>
12552
13085
 
13086
+ **external_resource_version:** `String`
13087
+
13088
+ </dd>
13089
+ </dl>
13090
+
13091
+ <dl>
13092
+ <dd>
13093
+
12553
13094
  **icon:** `Schematic::Types::PlanIcon`
12554
13095
 
12555
13096
  </dd>
@@ -12755,6 +13296,7 @@ client.plans.count_billing_product_match_companies(
12755
13296
  ```ruby
12756
13297
  client.plans.count_plans(
12757
13298
  company_id: "company_id",
13299
+ company_scoped_only: true,
12758
13300
  exclude_company_scoped: true,
12759
13301
  for_fallback_plan: true,
12760
13302
  for_initial_plan: true,
@@ -12765,6 +13307,7 @@ client.plans.count_plans(
12765
13307
  plan_type: "plan",
12766
13308
  q: "q",
12767
13309
  scoped_to_company_id: "scoped_to_company_id",
13310
+ with_entitlements: true,
12768
13311
  without_entitlement_for: "without_entitlement_for",
12769
13312
  without_paid_product_id: true,
12770
13313
  limit: 1000000,
@@ -12792,6 +13335,14 @@ client.plans.count_plans(
12792
13335
  <dl>
12793
13336
  <dd>
12794
13337
 
13338
+ **company_scoped_only:** `Internal::Types::Boolean` — Only return plans that are scoped to a company (custom plans assigned to a company)
13339
+
13340
+ </dd>
13341
+ </dl>
13342
+
13343
+ <dl>
13344
+ <dd>
13345
+
12795
13346
  **exclude_company_scoped:** `Internal::Types::Boolean` — Exclude plans that are scoped to a company (custom plans assigned to a company)
12796
13347
 
12797
13348
  </dd>
@@ -12872,6 +13423,14 @@ client.plans.count_plans(
12872
13423
  <dl>
12873
13424
  <dd>
12874
13425
 
13426
+ **with_entitlements:** `Internal::Types::Boolean` — Include each plan's entitlements in the response
13427
+
13428
+ </dd>
13429
+ </dl>
13430
+
13431
+ <dl>
13432
+ <dd>
13433
+
12875
13434
  **without_entitlement_for:** `String` — Filter out plans that already have a plan entitlement for the specified feature ID
12876
13435
 
12877
13436
  </dd>
@@ -13577,8 +14136,8 @@ client.components.preview_component_data(
13577
14136
  </dl>
13578
14137
  </details>
13579
14138
 
13580
- ## dataexports
13581
- <details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">create_data_export</a>(request) -> Schematic::Dataexports::Types::CreateDataExportResponse</code></summary>
14139
+ ## planbundle
14140
+ <details><summary><code>client.planbundle.<a href="/lib/schematic/planbundle/client.rb">create_custom_plan_bundle</a>(request) -> Schematic::Planbundle::Types::CreateCustomPlanBundleResponse</code></summary>
13582
14141
  <dl>
13583
14142
  <dd>
13584
14143
 
@@ -13591,11 +14150,9 @@ client.components.preview_component_data(
13591
14150
  <dd>
13592
14151
 
13593
14152
  ```ruby
13594
- client.dataexports.create_data_export(
13595
- export_type: "company-feature-usage",
13596
- metadata: "metadata",
13597
- output_file_type: "csv"
13598
- )
14153
+ client.planbundle.create_custom_plan_bundle(entitlements: [{
14154
+ action: "create"
14155
+ }])
13599
14156
  ```
13600
14157
  </dd>
13601
14158
  </dl>
@@ -13610,7 +14167,7 @@ client.dataexports.create_data_export(
13610
14167
  <dl>
13611
14168
  <dd>
13612
14169
 
13613
- **export_type:** `String`
14170
+ **billing_product:** `Schematic::Types::UpsertBillingProductRequestBody`
13614
14171
 
13615
14172
  </dd>
13616
14173
  </dl>
@@ -13618,7 +14175,7 @@ client.dataexports.create_data_export(
13618
14175
  <dl>
13619
14176
  <dd>
13620
14177
 
13621
- **metadata:** `String`
14178
+ **entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
13622
14179
 
13623
14180
  </dd>
13624
14181
  </dl>
@@ -13626,7 +14183,7 @@ client.dataexports.create_data_export(
13626
14183
  <dl>
13627
14184
  <dd>
13628
14185
 
13629
- **output_file_type:** `String`
14186
+ **plan:** `Schematic::Types::CreateCustomPlanBundlePlanRequestBody`
13630
14187
 
13631
14188
  </dd>
13632
14189
  </dl>
@@ -13634,7 +14191,7 @@ client.dataexports.create_data_export(
13634
14191
  <dl>
13635
14192
  <dd>
13636
14193
 
13637
- **request_options:** `Schematic::Dataexports::RequestOptions`
14194
+ **request_options:** `Schematic::Planbundle::RequestOptions`
13638
14195
 
13639
14196
  </dd>
13640
14197
  </dl>
@@ -13646,7 +14203,7 @@ client.dataexports.create_data_export(
13646
14203
  </dl>
13647
14204
  </details>
13648
14205
 
13649
- <details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">get_data_export_artifact</a>(data_export_id) -> String</code></summary>
14206
+ <details><summary><code>client.planbundle.<a href="/lib/schematic/planbundle/client.rb">create_plan_bundle</a>(request) -> Schematic::Planbundle::Types::CreatePlanBundleResponse</code></summary>
13650
14207
  <dl>
13651
14208
  <dd>
13652
14209
 
@@ -13659,7 +14216,9 @@ client.dataexports.create_data_export(
13659
14216
  <dd>
13660
14217
 
13661
14218
  ```ruby
13662
- client.dataexports.get_data_export_artifact(data_export_id: "data_export_id")
14219
+ client.planbundle.create_plan_bundle(entitlements: [{
14220
+ action: "create"
14221
+ }])
13663
14222
  ```
13664
14223
  </dd>
13665
14224
  </dl>
@@ -13674,7 +14233,7 @@ client.dataexports.get_data_export_artifact(data_export_id: "data_export_id")
13674
14233
  <dl>
13675
14234
  <dd>
13676
14235
 
13677
- **data_export_id:** `String` — data_export_id
14236
+ **billing_product:** `Schematic::Types::UpsertBillingProductRequestBody`
13678
14237
 
13679
14238
  </dd>
13680
14239
  </dl>
@@ -13682,50 +14241,31 @@ client.dataexports.get_data_export_artifact(data_export_id: "data_export_id")
13682
14241
  <dl>
13683
14242
  <dd>
13684
14243
 
13685
- **request_options:** `Schematic::Dataexports::RequestOptions`
14244
+ **credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
13686
14245
 
13687
14246
  </dd>
13688
14247
  </dl>
13689
- </dd>
13690
- </dl>
13691
-
13692
-
13693
- </dd>
13694
- </dl>
13695
- </details>
13696
14248
 
13697
- ## events
13698
- <details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">create_event_batch</a>(request) -> Schematic::Events::Types::CreateEventBatchResponse</code></summary>
13699
14249
  <dl>
13700
14250
  <dd>
13701
14251
 
13702
- #### 🔌 Usage
13703
-
13704
- <dl>
13705
- <dd>
14252
+ **entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
14253
+
14254
+ </dd>
14255
+ </dl>
13706
14256
 
13707
14257
  <dl>
13708
14258
  <dd>
13709
14259
 
13710
- ```ruby
13711
- client.events.create_event_batch(events: [{
13712
- event_type: "flag_check"
13713
- }])
13714
- ```
13715
- </dd>
13716
- </dl>
14260
+ **plan:** `Schematic::Types::CreatePlanRequestBody`
14261
+
13717
14262
  </dd>
13718
14263
  </dl>
13719
14264
 
13720
- #### ⚙️ Parameters
13721
-
13722
- <dl>
13723
- <dd>
13724
-
13725
14265
  <dl>
13726
14266
  <dd>
13727
14267
 
13728
- **events:** `Internal::Types::Array[Schematic::Types::CreateEventRequestBody]`
14268
+ **traits:** `Internal::Types::Array[Schematic::Types::UpdatePlanTraitTraitRequestBody]`
13729
14269
 
13730
14270
  </dd>
13731
14271
  </dl>
@@ -13733,7 +14273,7 @@ client.events.create_event_batch(events: [{
13733
14273
  <dl>
13734
14274
  <dd>
13735
14275
 
13736
- **request_options:** `Schematic::Events::RequestOptions`
14276
+ **request_options:** `Schematic::Planbundle::RequestOptions`
13737
14277
 
13738
14278
  </dd>
13739
14279
  </dl>
@@ -13745,7 +14285,7 @@ client.events.create_event_batch(events: [{
13745
14285
  </dl>
13746
14286
  </details>
13747
14287
 
13748
- <details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">get_event_summaries</a>() -> Schematic::Events::Types::GetEventSummariesResponse</code></summary>
14288
+ <details><summary><code>client.planbundle.<a href="/lib/schematic/planbundle/client.rb">update_plan_bundle</a>(plan_bundle_id, request) -> Schematic::Planbundle::Types::UpdatePlanBundleResponse</code></summary>
13749
14289
  <dl>
13750
14290
  <dd>
13751
14291
 
@@ -13758,11 +14298,11 @@ client.events.create_event_batch(events: [{
13758
14298
  <dd>
13759
14299
 
13760
14300
  ```ruby
13761
- client.events.get_event_summaries(
13762
- q: "q",
13763
- event_subtypes: ["event_subtypes"],
13764
- limit: 1000000,
13765
- offset: 1000000
14301
+ client.planbundle.update_plan_bundle(
14302
+ plan_bundle_id: "plan_bundle_id",
14303
+ entitlements: [{
14304
+ action: "create"
14305
+ }]
13766
14306
  )
13767
14307
  ```
13768
14308
  </dd>
@@ -13778,7 +14318,7 @@ client.events.get_event_summaries(
13778
14318
  <dl>
13779
14319
  <dd>
13780
14320
 
13781
- **q:** `String`
14321
+ **plan_bundle_id:** `String` — plan_bundle_id
13782
14322
 
13783
14323
  </dd>
13784
14324
  </dl>
@@ -13786,7 +14326,7 @@ client.events.get_event_summaries(
13786
14326
  <dl>
13787
14327
  <dd>
13788
14328
 
13789
- **event_subtypes:** `String`
14329
+ **billing_product:** `Schematic::Types::UpsertBillingProductRequestBody`
13790
14330
 
13791
14331
  </dd>
13792
14332
  </dl>
@@ -13794,7 +14334,7 @@ client.events.get_event_summaries(
13794
14334
  <dl>
13795
14335
  <dd>
13796
14336
 
13797
- **limit:** `Integer` — Page limit (default 100)
14337
+ **credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
13798
14338
 
13799
14339
  </dd>
13800
14340
  </dl>
@@ -13802,7 +14342,7 @@ client.events.get_event_summaries(
13802
14342
  <dl>
13803
14343
  <dd>
13804
14344
 
13805
- **offset:** `Integer` — Page offset (default 0)
14345
+ **entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
13806
14346
 
13807
14347
  </dd>
13808
14348
  </dl>
@@ -13810,7 +14350,31 @@ client.events.get_event_summaries(
13810
14350
  <dl>
13811
14351
  <dd>
13812
14352
 
13813
- **request_options:** `Schematic::Events::RequestOptions`
14353
+ **plan:** `Schematic::Types::UpdatePlanRequestBody`
14354
+
14355
+ </dd>
14356
+ </dl>
14357
+
14358
+ <dl>
14359
+ <dd>
14360
+
14361
+ **plan_version_id:** `String`
14362
+
14363
+ </dd>
14364
+ </dl>
14365
+
14366
+ <dl>
14367
+ <dd>
14368
+
14369
+ **traits:** `Internal::Types::Array[Schematic::Types::UpdatePlanTraitTraitRequestBody]`
14370
+
14371
+ </dd>
14372
+ </dl>
14373
+
14374
+ <dl>
14375
+ <dd>
14376
+
14377
+ **request_options:** `Schematic::Planbundle::RequestOptions`
13814
14378
 
13815
14379
  </dd>
13816
14380
  </dl>
@@ -13822,7 +14386,8 @@ client.events.get_event_summaries(
13822
14386
  </dl>
13823
14387
  </details>
13824
14388
 
13825
- <details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">list_events</a>() -> Schematic::Events::Types::ListEventsResponse</code></summary>
14389
+ ## dataexports
14390
+ <details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">create_data_export</a>(request) -> Schematic::Dataexports::Types::CreateDataExportResponse</code></summary>
13826
14391
  <dl>
13827
14392
  <dd>
13828
14393
 
@@ -13835,14 +14400,10 @@ client.events.get_event_summaries(
13835
14400
  <dd>
13836
14401
 
13837
14402
  ```ruby
13838
- client.events.list_events(
13839
- company_id: "company_id",
13840
- event_subtype: "event_subtype",
13841
- event_types: ["flag_check"],
13842
- flag_id: "flag_id",
13843
- user_id: "user_id",
13844
- limit: 1000000,
13845
- offset: 1000000
14403
+ client.dataexports.create_data_export(
14404
+ export_type: "company-feature-usage",
14405
+ metadata: "metadata",
14406
+ output_file_type: "csv"
13846
14407
  )
13847
14408
  ```
13848
14409
  </dd>
@@ -13858,7 +14419,7 @@ client.events.list_events(
13858
14419
  <dl>
13859
14420
  <dd>
13860
14421
 
13861
- **company_id:** `String`
14422
+ **export_type:** `String`
13862
14423
 
13863
14424
  </dd>
13864
14425
  </dl>
@@ -13866,7 +14427,256 @@ client.events.list_events(
13866
14427
  <dl>
13867
14428
  <dd>
13868
14429
 
13869
- **event_subtype:** `String`
14430
+ **metadata:** `String`
14431
+
14432
+ </dd>
14433
+ </dl>
14434
+
14435
+ <dl>
14436
+ <dd>
14437
+
14438
+ **output_file_type:** `String`
14439
+
14440
+ </dd>
14441
+ </dl>
14442
+
14443
+ <dl>
14444
+ <dd>
14445
+
14446
+ **request_options:** `Schematic::Dataexports::RequestOptions`
14447
+
14448
+ </dd>
14449
+ </dl>
14450
+ </dd>
14451
+ </dl>
14452
+
14453
+
14454
+ </dd>
14455
+ </dl>
14456
+ </details>
14457
+
14458
+ <details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">get_data_export_artifact</a>(data_export_id) -> String</code></summary>
14459
+ <dl>
14460
+ <dd>
14461
+
14462
+ #### 🔌 Usage
14463
+
14464
+ <dl>
14465
+ <dd>
14466
+
14467
+ <dl>
14468
+ <dd>
14469
+
14470
+ ```ruby
14471
+ client.dataexports.get_data_export_artifact(data_export_id: "data_export_id")
14472
+ ```
14473
+ </dd>
14474
+ </dl>
14475
+ </dd>
14476
+ </dl>
14477
+
14478
+ #### ⚙️ Parameters
14479
+
14480
+ <dl>
14481
+ <dd>
14482
+
14483
+ <dl>
14484
+ <dd>
14485
+
14486
+ **data_export_id:** `String` — data_export_id
14487
+
14488
+ </dd>
14489
+ </dl>
14490
+
14491
+ <dl>
14492
+ <dd>
14493
+
14494
+ **request_options:** `Schematic::Dataexports::RequestOptions`
14495
+
14496
+ </dd>
14497
+ </dl>
14498
+ </dd>
14499
+ </dl>
14500
+
14501
+
14502
+ </dd>
14503
+ </dl>
14504
+ </details>
14505
+
14506
+ ## events
14507
+ <details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">create_event_batch</a>(request) -> Schematic::Events::Types::CreateEventBatchResponse</code></summary>
14508
+ <dl>
14509
+ <dd>
14510
+
14511
+ #### 🔌 Usage
14512
+
14513
+ <dl>
14514
+ <dd>
14515
+
14516
+ <dl>
14517
+ <dd>
14518
+
14519
+ ```ruby
14520
+ client.events.create_event_batch(events: [{
14521
+ event_type: "flag_check"
14522
+ }])
14523
+ ```
14524
+ </dd>
14525
+ </dl>
14526
+ </dd>
14527
+ </dl>
14528
+
14529
+ #### ⚙️ Parameters
14530
+
14531
+ <dl>
14532
+ <dd>
14533
+
14534
+ <dl>
14535
+ <dd>
14536
+
14537
+ **events:** `Internal::Types::Array[Schematic::Types::CreateEventRequestBody]`
14538
+
14539
+ </dd>
14540
+ </dl>
14541
+
14542
+ <dl>
14543
+ <dd>
14544
+
14545
+ **request_options:** `Schematic::Events::RequestOptions`
14546
+
14547
+ </dd>
14548
+ </dl>
14549
+ </dd>
14550
+ </dl>
14551
+
14552
+
14553
+ </dd>
14554
+ </dl>
14555
+ </details>
14556
+
14557
+ <details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">get_event_summaries</a>() -> Schematic::Events::Types::GetEventSummariesResponse</code></summary>
14558
+ <dl>
14559
+ <dd>
14560
+
14561
+ #### 🔌 Usage
14562
+
14563
+ <dl>
14564
+ <dd>
14565
+
14566
+ <dl>
14567
+ <dd>
14568
+
14569
+ ```ruby
14570
+ client.events.get_event_summaries(
14571
+ q: "q",
14572
+ event_subtypes: ["event_subtypes"],
14573
+ limit: 1000000,
14574
+ offset: 1000000
14575
+ )
14576
+ ```
14577
+ </dd>
14578
+ </dl>
14579
+ </dd>
14580
+ </dl>
14581
+
14582
+ #### ⚙️ Parameters
14583
+
14584
+ <dl>
14585
+ <dd>
14586
+
14587
+ <dl>
14588
+ <dd>
14589
+
14590
+ **q:** `String`
14591
+
14592
+ </dd>
14593
+ </dl>
14594
+
14595
+ <dl>
14596
+ <dd>
14597
+
14598
+ **event_subtypes:** `String`
14599
+
14600
+ </dd>
14601
+ </dl>
14602
+
14603
+ <dl>
14604
+ <dd>
14605
+
14606
+ **limit:** `Integer` — Page limit (default 100)
14607
+
14608
+ </dd>
14609
+ </dl>
14610
+
14611
+ <dl>
14612
+ <dd>
14613
+
14614
+ **offset:** `Integer` — Page offset (default 0)
14615
+
14616
+ </dd>
14617
+ </dl>
14618
+
14619
+ <dl>
14620
+ <dd>
14621
+
14622
+ **request_options:** `Schematic::Events::RequestOptions`
14623
+
14624
+ </dd>
14625
+ </dl>
14626
+ </dd>
14627
+ </dl>
14628
+
14629
+
14630
+ </dd>
14631
+ </dl>
14632
+ </details>
14633
+
14634
+ <details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">list_events</a>() -> Schematic::Events::Types::ListEventsResponse</code></summary>
14635
+ <dl>
14636
+ <dd>
14637
+
14638
+ #### 🔌 Usage
14639
+
14640
+ <dl>
14641
+ <dd>
14642
+
14643
+ <dl>
14644
+ <dd>
14645
+
14646
+ ```ruby
14647
+ client.events.list_events(
14648
+ company_id: "company_id",
14649
+ event_subtype: "event_subtype",
14650
+ event_types: ["flag_check"],
14651
+ flag_id: "flag_id",
14652
+ idempotency_key: "idempotency_key",
14653
+ user_id: "user_id",
14654
+ limit: 1000000,
14655
+ offset: 1000000
14656
+ )
14657
+ ```
14658
+ </dd>
14659
+ </dl>
14660
+ </dd>
14661
+ </dl>
14662
+
14663
+ #### ⚙️ Parameters
14664
+
14665
+ <dl>
14666
+ <dd>
14667
+
14668
+ <dl>
14669
+ <dd>
14670
+
14671
+ **company_id:** `String`
14672
+
14673
+ </dd>
14674
+ </dl>
14675
+
14676
+ <dl>
14677
+ <dd>
14678
+
14679
+ **event_subtype:** `String`
13870
14680
 
13871
14681
  </dd>
13872
14682
  </dl>
@@ -13890,6 +14700,14 @@ client.events.list_events(
13890
14700
  <dl>
13891
14701
  <dd>
13892
14702
 
14703
+ **idempotency_key:** `String`
14704
+
14705
+ </dd>
14706
+ </dl>
14707
+
14708
+ <dl>
14709
+ <dd>
14710
+
13893
14711
  **user_id:** `String`
13894
14712
 
13895
14713
  </dd>
@@ -14080,6 +14898,7 @@ client.features.list_features(
14080
14898
  boolean_require_event: true,
14081
14899
  feature_type: ["boolean"],
14082
14900
  ids: ["ids"],
14901
+ managed_by: "orb",
14083
14902
  plan_version_id: "plan_version_id",
14084
14903
  q: "q",
14085
14904
  without_company_override_for: "without_company_override_for",
@@ -14125,6 +14944,14 @@ client.features.list_features(
14125
14944
  <dl>
14126
14945
  <dd>
14127
14946
 
14947
+ **managed_by:** `Schematic::Types::BillingProviderType` — Filter for features managed by a billing provider, or by Schematic (no billing provider)
14948
+
14949
+ </dd>
14950
+ </dl>
14951
+
14952
+ <dl>
14953
+ <dd>
14954
+
14128
14955
  **plan_version_id:** `String` — Filter by plan version ID when used with without_plan_entitlement_for; if not provided, the latest published version is used
14129
14956
 
14130
14957
  </dd>
@@ -14716,6 +15543,7 @@ client.features.count_features(
14716
15543
  boolean_require_event: true,
14717
15544
  feature_type: ["boolean"],
14718
15545
  ids: ["ids"],
15546
+ managed_by: "orb",
14719
15547
  plan_version_id: "plan_version_id",
14720
15548
  q: "q",
14721
15549
  without_company_override_for: "without_company_override_for",
@@ -14761,6 +15589,14 @@ client.features.count_features(
14761
15589
  <dl>
14762
15590
  <dd>
14763
15591
 
15592
+ **managed_by:** `Schematic::Types::BillingProviderType` — Filter for features managed by a billing provider, or by Schematic (no billing provider)
15593
+
15594
+ </dd>
15595
+ </dl>
15596
+
15597
+ <dl>
15598
+ <dd>
15599
+
14764
15600
  **plan_version_id:** `String` — Filter by plan version ID when used with without_plan_entitlement_for; if not provided, the latest published version is used
14765
15601
 
14766
15602
  </dd>
@@ -15793,7 +16629,7 @@ client.insights.get_environment_trait_usage_time_series(
15793
16629
  </details>
15794
16630
 
15795
16631
  ## integrationsapi
15796
- <details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">get_integration_webhook_url</a>(type) -> Schematic::Integrationsapi::Types::GetIntegrationWebhookUrlResponse</code></summary>
16632
+ <details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">run_integration</a>(integration_id) -> Schematic::Integrationsapi::Types::RunIntegrationResponse</code></summary>
15797
16633
  <dl>
15798
16634
  <dd>
15799
16635
 
@@ -15806,7 +16642,7 @@ client.insights.get_environment_trait_usage_time_series(
15806
16642
  <dd>
15807
16643
 
15808
16644
  ```ruby
15809
- client.integrationsapi.get_integration_webhook_url(type: "type")
16645
+ client.integrationsapi.run_integration(integration_id: "integration_id")
15810
16646
  ```
15811
16647
  </dd>
15812
16648
  </dl>
@@ -15821,7 +16657,7 @@ client.integrationsapi.get_integration_webhook_url(type: "type")
15821
16657
  <dl>
15822
16658
  <dd>
15823
16659
 
15824
- **type:** `String` — type
16660
+ **integration_id:** `String` — integration_id
15825
16661
 
15826
16662
  </dd>
15827
16663
  </dl>
@@ -15841,8 +16677,7 @@ client.integrationsapi.get_integration_webhook_url(type: "type")
15841
16677
  </dl>
15842
16678
  </details>
15843
16679
 
15844
- ## planbundle
15845
- <details><summary><code>client.planbundle.<a href="/lib/schematic/planbundle/client.rb">create_plan_bundle</a>(request) -> Schematic::Planbundle::Types::CreatePlanBundleResponse</code></summary>
16680
+ <details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">list_integrations</a>() -> Schematic::Integrationsapi::Types::ListIntegrationsResponse</code></summary>
15846
16681
  <dl>
15847
16682
  <dd>
15848
16683
 
@@ -15855,16 +16690,150 @@ client.integrationsapi.get_integration_webhook_url(type: "type")
15855
16690
  <dd>
15856
16691
 
15857
16692
  ```ruby
15858
- client.planbundle.create_plan_bundle(entitlements: [{
15859
- action: "create"
15860
- }])
16693
+ client.integrationsapi.list_integrations(
16694
+ billing_only: true,
16695
+ exclude_ids: ["exclude_ids"],
16696
+ id: "id",
16697
+ state: "active",
16698
+ type: "clerk",
16699
+ limit: 1000000,
16700
+ offset: 1000000
16701
+ )
16702
+ ```
16703
+ </dd>
16704
+ </dl>
16705
+ </dd>
16706
+ </dl>
16707
+
16708
+ #### ⚙️ Parameters
16709
+
16710
+ <dl>
16711
+ <dd>
16712
+
16713
+ <dl>
16714
+ <dd>
16715
+
16716
+ **billing_only:** `Internal::Types::Boolean`
16717
+
16718
+ </dd>
16719
+ </dl>
16720
+
16721
+ <dl>
16722
+ <dd>
16723
+
16724
+ **exclude_ids:** `String`
16725
+
16726
+ </dd>
16727
+ </dl>
16728
+
16729
+ <dl>
16730
+ <dd>
16731
+
16732
+ **id:** `String`
16733
+
16734
+ </dd>
16735
+ </dl>
16736
+
16737
+ <dl>
16738
+ <dd>
16739
+
16740
+ **state:** `Schematic::Types::IntegrationState`
16741
+
16742
+ </dd>
16743
+ </dl>
16744
+
16745
+ <dl>
16746
+ <dd>
16747
+
16748
+ **type:** `Schematic::Types::IntegrationType`
16749
+
16750
+ </dd>
16751
+ </dl>
16752
+
16753
+ <dl>
16754
+ <dd>
16755
+
16756
+ **limit:** `Integer` — Page limit (default 100)
16757
+
16758
+ </dd>
16759
+ </dl>
16760
+
16761
+ <dl>
16762
+ <dd>
16763
+
16764
+ **offset:** `Integer` — Page offset (default 0)
16765
+
16766
+ </dd>
16767
+ </dl>
16768
+
16769
+ <dl>
16770
+ <dd>
16771
+
16772
+ **request_options:** `Schematic::Integrationsapi::RequestOptions`
16773
+
16774
+ </dd>
16775
+ </dl>
16776
+ </dd>
16777
+ </dl>
16778
+
16779
+
16780
+ </dd>
16781
+ </dl>
16782
+ </details>
16783
+
16784
+ <details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">get_integration_webhook_url</a>(type) -> Schematic::Integrationsapi::Types::GetIntegrationWebhookUrlResponse</code></summary>
16785
+ <dl>
16786
+ <dd>
16787
+
16788
+ #### 🔌 Usage
16789
+
16790
+ <dl>
16791
+ <dd>
16792
+
16793
+ <dl>
16794
+ <dd>
16795
+
16796
+ ```ruby
16797
+ client.integrationsapi.get_integration_webhook_url(type: "type")
15861
16798
  ```
15862
16799
  </dd>
15863
16800
  </dl>
15864
16801
  </dd>
15865
16802
  </dl>
15866
16803
 
15867
- #### ⚙️ Parameters
16804
+ #### ⚙️ Parameters
16805
+
16806
+ <dl>
16807
+ <dd>
16808
+
16809
+ <dl>
16810
+ <dd>
16811
+
16812
+ **type:** `String` — type
16813
+
16814
+ </dd>
16815
+ </dl>
16816
+
16817
+ <dl>
16818
+ <dd>
16819
+
16820
+ **request_options:** `Schematic::Integrationsapi::RequestOptions`
16821
+
16822
+ </dd>
16823
+ </dl>
16824
+ </dd>
16825
+ </dl>
16826
+
16827
+
16828
+ </dd>
16829
+ </dl>
16830
+ </details>
16831
+
16832
+ <details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">start_data_import</a>(request) -> Schematic::Integrationsapi::Types::StartDataImportResponse</code></summary>
16833
+ <dl>
16834
+ <dd>
16835
+
16836
+ #### 🔌 Usage
15868
16837
 
15869
16838
  <dl>
15870
16839
  <dd>
@@ -15872,23 +16841,23 @@ client.planbundle.create_plan_bundle(entitlements: [{
15872
16841
  <dl>
15873
16842
  <dd>
15874
16843
 
15875
- **billing_product:** `Schematic::Types::UpsertBillingProductRequestBody`
15876
-
16844
+ ```ruby
16845
+ client.integrationsapi.start_data_import(integration_id: "integration_id")
16846
+ ```
15877
16847
  </dd>
15878
16848
  </dl>
16849
+ </dd>
16850
+ </dl>
16851
+
16852
+ #### ⚙️ Parameters
15879
16853
 
15880
16854
  <dl>
15881
16855
  <dd>
15882
16856
 
15883
- **credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
15884
-
15885
- </dd>
15886
- </dl>
15887
-
15888
16857
  <dl>
15889
16858
  <dd>
15890
16859
 
15891
- **entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
16860
+ **company_matching_criteria:** `Schematic::Types::CompanyMatchingCriteria`
15892
16861
 
15893
16862
  </dd>
15894
16863
  </dl>
@@ -15896,7 +16865,7 @@ client.planbundle.create_plan_bundle(entitlements: [{
15896
16865
  <dl>
15897
16866
  <dd>
15898
16867
 
15899
- **plan:** `Schematic::Types::CreatePlanRequestBody`
16868
+ **company_matching_field:** `String`
15900
16869
 
15901
16870
  </dd>
15902
16871
  </dl>
@@ -15904,7 +16873,7 @@ client.planbundle.create_plan_bundle(entitlements: [{
15904
16873
  <dl>
15905
16874
  <dd>
15906
16875
 
15907
- **traits:** `Internal::Types::Array[Schematic::Types::UpdatePlanTraitTraitRequestBody]`
16876
+ **integration_id:** `String`
15908
16877
 
15909
16878
  </dd>
15910
16879
  </dl>
@@ -15912,7 +16881,7 @@ client.planbundle.create_plan_bundle(entitlements: [{
15912
16881
  <dl>
15913
16882
  <dd>
15914
16883
 
15915
- **request_options:** `Schematic::Planbundle::RequestOptions`
16884
+ **request_options:** `Schematic::Integrationsapi::RequestOptions`
15916
16885
 
15917
16886
  </dd>
15918
16887
  </dl>
@@ -15924,7 +16893,7 @@ client.planbundle.create_plan_bundle(entitlements: [{
15924
16893
  </dl>
15925
16894
  </details>
15926
16895
 
15927
- <details><summary><code>client.planbundle.<a href="/lib/schematic/planbundle/client.rb">update_plan_bundle</a>(plan_bundle_id, request) -> Schematic::Planbundle::Types::UpdatePlanBundleResponse</code></summary>
16896
+ <details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">load_sample_data_set_v_2</a>() -> Schematic::Integrationsapi::Types::LoadSampleDataSetV2Response</code></summary>
15928
16897
  <dl>
15929
16898
  <dd>
15930
16899
 
@@ -15937,12 +16906,7 @@ client.planbundle.create_plan_bundle(entitlements: [{
15937
16906
  <dd>
15938
16907
 
15939
16908
  ```ruby
15940
- client.planbundle.update_plan_bundle(
15941
- plan_bundle_id: "plan_bundle_id",
15942
- entitlements: [{
15943
- action: "create"
15944
- }]
15945
- )
16909
+ client.integrationsapi.load_sample_data_set_v_2
15946
16910
  ```
15947
16911
  </dd>
15948
16912
  </dl>
@@ -15957,55 +16921,47 @@ client.planbundle.update_plan_bundle(
15957
16921
  <dl>
15958
16922
  <dd>
15959
16923
 
15960
- **plan_bundle_id:** `String` — plan_bundle_id
16924
+ **request_options:** `Schematic::Integrationsapi::RequestOptions`
15961
16925
 
15962
16926
  </dd>
15963
16927
  </dl>
16928
+ </dd>
16929
+ </dl>
15964
16930
 
15965
- <dl>
15966
- <dd>
15967
16931
 
15968
- **billing_product:** `Schematic::Types::UpsertBillingProductRequestBody`
15969
-
15970
16932
  </dd>
15971
16933
  </dl>
16934
+ </details>
15972
16935
 
16936
+ <details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">uninstall_integration</a>(integration_id) -> Schematic::Integrationsapi::Types::UninstallIntegrationResponse</code></summary>
15973
16937
  <dl>
15974
16938
  <dd>
15975
16939
 
15976
- **credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
15977
-
15978
- </dd>
15979
- </dl>
16940
+ #### 🔌 Usage
15980
16941
 
15981
16942
  <dl>
15982
16943
  <dd>
15983
16944
 
15984
- **entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
15985
-
15986
- </dd>
15987
- </dl>
15988
-
15989
16945
  <dl>
15990
16946
  <dd>
15991
16947
 
15992
- **plan:** `Schematic::Types::UpdatePlanRequestBody`
15993
-
16948
+ ```ruby
16949
+ client.integrationsapi.uninstall_integration(integration_id: "integration_id")
16950
+ ```
15994
16951
  </dd>
15995
16952
  </dl>
16953
+ </dd>
16954
+ </dl>
16955
+
16956
+ #### ⚙️ Parameters
15996
16957
 
15997
16958
  <dl>
15998
16959
  <dd>
15999
16960
 
16000
- **plan_version_id:** `String`
16001
-
16002
- </dd>
16003
- </dl>
16004
-
16005
16961
  <dl>
16006
16962
  <dd>
16007
16963
 
16008
- **traits:** `Internal::Types::Array[Schematic::Types::UpdatePlanTraitTraitRequestBody]`
16964
+ **integration_id:** `String` — integration_id
16009
16965
 
16010
16966
  </dd>
16011
16967
  </dl>
@@ -16013,7 +16969,7 @@ client.planbundle.update_plan_bundle(
16013
16969
  <dl>
16014
16970
  <dd>
16015
16971
 
16016
- **request_options:** `Schematic::Planbundle::RequestOptions`
16972
+ **request_options:** `Schematic::Integrationsapi::RequestOptions`
16017
16973
 
16018
16974
  </dd>
16019
16975
  </dl>
@@ -16808,6 +17764,54 @@ client.planmigrations.list_company_migrations(
16808
17764
  </dl>
16809
17765
 
16810
17766
 
17767
+ </dd>
17768
+ </dl>
17769
+ </details>
17770
+
17771
+ <details><summary><code>client.planmigrations.<a href="/lib/schematic/planmigrations/client.rb">retry_company_migration</a>(plan_version_company_migration_id) -> Schematic::Planmigrations::Types::RetryCompanyMigrationResponse</code></summary>
17772
+ <dl>
17773
+ <dd>
17774
+
17775
+ #### 🔌 Usage
17776
+
17777
+ <dl>
17778
+ <dd>
17779
+
17780
+ <dl>
17781
+ <dd>
17782
+
17783
+ ```ruby
17784
+ client.planmigrations.retry_company_migration(plan_version_company_migration_id: "plan_version_company_migration_id")
17785
+ ```
17786
+ </dd>
17787
+ </dl>
17788
+ </dd>
17789
+ </dl>
17790
+
17791
+ #### ⚙️ Parameters
17792
+
17793
+ <dl>
17794
+ <dd>
17795
+
17796
+ <dl>
17797
+ <dd>
17798
+
17799
+ **plan_version_company_migration_id:** `String` — plan_version_company_migration_id
17800
+
17801
+ </dd>
17802
+ </dl>
17803
+
17804
+ <dl>
17805
+ <dd>
17806
+
17807
+ **request_options:** `Schematic::Planmigrations::RequestOptions`
17808
+
17809
+ </dd>
17810
+ </dl>
17811
+ </dd>
17812
+ </dl>
17813
+
17814
+
16811
17815
  </dd>
16812
17816
  </dl>
16813
17817
  </details>
@@ -16971,6 +17975,110 @@ client.planmigrations.list_migrations(
16971
17975
  </dl>
16972
17976
 
16973
17977
 
17978
+ </dd>
17979
+ </dl>
17980
+ </details>
17981
+
17982
+ <details><summary><code>client.planmigrations.<a href="/lib/schematic/planmigrations/client.rb">create_migration</a>(request) -> Schematic::Planmigrations::Types::CreateMigrationResponse</code></summary>
17983
+ <dl>
17984
+ <dd>
17985
+
17986
+ #### 🔌 Usage
17987
+
17988
+ <dl>
17989
+ <dd>
17990
+
17991
+ <dl>
17992
+ <dd>
17993
+
17994
+ ```ruby
17995
+ client.planmigrations.create_migration(
17996
+ company_ids: ["company_ids"],
17997
+ excluded_company_ids: ["excluded_company_ids"],
17998
+ plan_id: "plan_id",
17999
+ plan_version_id_to: "plan_version_id_to",
18000
+ plan_version_ids_from: ["plan_version_ids_from"],
18001
+ strategy: "immediate",
18002
+ target_plan_type: "plan"
18003
+ )
18004
+ ```
18005
+ </dd>
18006
+ </dl>
18007
+ </dd>
18008
+ </dl>
18009
+
18010
+ #### ⚙️ Parameters
18011
+
18012
+ <dl>
18013
+ <dd>
18014
+
18015
+ <dl>
18016
+ <dd>
18017
+
18018
+ **company_ids:** `Internal::Types::Array[String]`
18019
+
18020
+ </dd>
18021
+ </dl>
18022
+
18023
+ <dl>
18024
+ <dd>
18025
+
18026
+ **excluded_company_ids:** `Internal::Types::Array[String]`
18027
+
18028
+ </dd>
18029
+ </dl>
18030
+
18031
+ <dl>
18032
+ <dd>
18033
+
18034
+ **plan_id:** `String`
18035
+
18036
+ </dd>
18037
+ </dl>
18038
+
18039
+ <dl>
18040
+ <dd>
18041
+
18042
+ **plan_version_id_to:** `String`
18043
+
18044
+ </dd>
18045
+ </dl>
18046
+
18047
+ <dl>
18048
+ <dd>
18049
+
18050
+ **plan_version_ids_from:** `Internal::Types::Array[String]`
18051
+
18052
+ </dd>
18053
+ </dl>
18054
+
18055
+ <dl>
18056
+ <dd>
18057
+
18058
+ **strategy:** `Schematic::Types::PlanVersionMigrationStrategy`
18059
+
18060
+ </dd>
18061
+ </dl>
18062
+
18063
+ <dl>
18064
+ <dd>
18065
+
18066
+ **target_plan_type:** `Schematic::Types::PlanType`
18067
+
18068
+ </dd>
18069
+ </dl>
18070
+
18071
+ <dl>
18072
+ <dd>
18073
+
18074
+ **request_options:** `Schematic::Planmigrations::RequestOptions`
18075
+
18076
+ </dd>
18077
+ </dl>
18078
+ </dd>
18079
+ </dl>
18080
+
18081
+
16974
18082
  </dd>
16975
18083
  </dl>
16976
18084
  </details>
@@ -17019,6 +18127,65 @@ client.planmigrations.get_migration(plan_version_migration_id: "plan_version_mig
17019
18127
  </dl>
17020
18128
 
17021
18129
 
18130
+ </dd>
18131
+ </dl>
18132
+ </details>
18133
+
18134
+ <details><summary><code>client.planmigrations.<a href="/lib/schematic/planmigrations/client.rb">retry_migration</a>(plan_version_migration_id, request) -> Schematic::Planmigrations::Types::RetryMigrationResponse</code></summary>
18135
+ <dl>
18136
+ <dd>
18137
+
18138
+ #### 🔌 Usage
18139
+
18140
+ <dl>
18141
+ <dd>
18142
+
18143
+ <dl>
18144
+ <dd>
18145
+
18146
+ ```ruby
18147
+ client.planmigrations.retry_migration(
18148
+ plan_version_migration_id: "plan_version_migration_id",
18149
+ error_codes: ["ambiguous_subscription_item"]
18150
+ )
18151
+ ```
18152
+ </dd>
18153
+ </dl>
18154
+ </dd>
18155
+ </dl>
18156
+
18157
+ #### ⚙️ Parameters
18158
+
18159
+ <dl>
18160
+ <dd>
18161
+
18162
+ <dl>
18163
+ <dd>
18164
+
18165
+ **plan_version_migration_id:** `String` — plan_version_migration_id
18166
+
18167
+ </dd>
18168
+ </dl>
18169
+
18170
+ <dl>
18171
+ <dd>
18172
+
18173
+ **error_codes:** `Internal::Types::Array[Schematic::Types::MigrationErrorCode]`
18174
+
18175
+ </dd>
18176
+ </dl>
18177
+
18178
+ <dl>
18179
+ <dd>
18180
+
18181
+ **request_options:** `Schematic::Planmigrations::RequestOptions`
18182
+
18183
+ </dd>
18184
+ </dl>
18185
+ </dd>
18186
+ </dl>
18187
+
18188
+
17022
18189
  </dd>
17023
18190
  </dl>
17024
18191
  </details>