schematichq 1.4.1 → 1.4.2

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 (114) 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 +1 -1
  6. data/lib/schematic/billing/client.rb +6 -2
  7. data/lib/schematic/billing/types/count_billing_products_params.rb +1 -0
  8. data/lib/schematic/billing/types/count_billing_products_request.rb +1 -0
  9. data/lib/schematic/billing/types/create_billing_price_request_body.rb +1 -0
  10. data/lib/schematic/billing/types/list_billing_products_params.rb +1 -0
  11. data/lib/schematic/billing/types/list_billing_products_request.rb +1 -0
  12. data/lib/schematic/client.rb +6 -6
  13. data/lib/schematic/credits/client.rb +6 -2
  14. data/lib/schematic/credits/types/count_billing_plan_credit_grants_params.rb +1 -0
  15. data/lib/schematic/credits/types/count_billing_plan_credit_grants_request.rb +1 -0
  16. data/lib/schematic/credits/types/list_billing_plan_credit_grants_params.rb +1 -0
  17. data/lib/schematic/credits/types/list_billing_plan_credit_grants_request.rb +1 -0
  18. data/lib/schematic/datastream/websocket_client.rb +32 -1
  19. data/lib/schematic/entitlements/client.rb +6 -2
  20. data/lib/schematic/entitlements/types/count_feature_usage_params.rb +1 -0
  21. data/lib/schematic/entitlements/types/count_feature_usage_request.rb +1 -0
  22. data/lib/schematic/entitlements/types/create_billing_linked_plan_entitlement_request_body.rb +4 -0
  23. data/lib/schematic/entitlements/types/create_plan_entitlement_request_body.rb +4 -0
  24. data/lib/schematic/entitlements/types/list_feature_usage_params.rb +1 -0
  25. data/lib/schematic/entitlements/types/list_feature_usage_request.rb +1 -0
  26. data/lib/schematic/entitlements/types/update_plan_entitlement_request_body.rb +4 -0
  27. data/lib/schematic/event_buffer.rb +10 -2
  28. data/lib/schematic/events/client.rb +3 -1
  29. data/lib/schematic/events/types/list_events_params.rb +1 -0
  30. data/lib/schematic/events/types/list_events_request.rb +1 -0
  31. data/lib/schematic/features/client.rb +6 -2
  32. data/lib/schematic/features/types/count_features_params.rb +1 -0
  33. data/lib/schematic/features/types/count_features_request.rb +1 -0
  34. data/lib/schematic/features/types/list_features_params.rb +1 -0
  35. data/lib/schematic/features/types/list_features_request.rb +1 -0
  36. data/lib/schematic/integrationsapi/client.rb +177 -0
  37. data/lib/schematic/integrationsapi/types/list_integrations_params.rb +18 -0
  38. data/lib/schematic/integrationsapi/types/list_integrations_request.rb +17 -0
  39. data/lib/schematic/integrationsapi/types/list_integrations_response.rb +12 -0
  40. data/lib/schematic/integrationsapi/types/load_sample_data_set_v_2_response.rb +12 -0
  41. data/lib/schematic/integrationsapi/types/run_integration_response.rb +12 -0
  42. data/lib/schematic/integrationsapi/types/start_data_import_request_body.rb +13 -0
  43. data/lib/schematic/integrationsapi/types/start_data_import_response.rb +12 -0
  44. data/lib/schematic/integrationsapi/types/uninstall_integration_response.rb +12 -0
  45. data/lib/schematic/planbundle/client.rb +32 -0
  46. data/lib/schematic/planbundle/types/create_custom_plan_bundle_request_body.rb +13 -0
  47. data/lib/schematic/planbundle/types/create_custom_plan_bundle_response.rb +12 -0
  48. data/lib/schematic/plans/client.rb +6 -2
  49. data/lib/schematic/plans/types/count_plans_params.rb +1 -0
  50. data/lib/schematic/plans/types/count_plans_request.rb +1 -0
  51. data/lib/schematic/plans/types/create_billing_linked_plan_request_body.rb +1 -0
  52. data/lib/schematic/plans/types/list_plans_params.rb +1 -0
  53. data/lib/schematic/plans/types/list_plans_request.rb +1 -0
  54. data/lib/schematic/types/api_key_create_response_data.rb +1 -0
  55. data/lib/schematic/types/api_key_integration_response_data.rb +11 -0
  56. data/lib/schematic/types/api_key_response_data.rb +1 -0
  57. data/lib/schematic/types/audit_log_list_response_data.rb +1 -0
  58. data/lib/schematic/types/audit_log_response_data.rb +1 -0
  59. data/lib/schematic/types/billing_credit_bundle_view.rb +1 -1
  60. data/lib/schematic/types/billing_credit_view.rb +1 -0
  61. data/lib/schematic/types/billing_plan_credit_grant_response_data.rb +1 -0
  62. data/lib/schematic/types/billing_price_response_data.rb +1 -0
  63. data/lib/schematic/types/billing_price_view.rb +1 -0
  64. data/lib/schematic/types/billing_product_for_subscription_response_data.rb +1 -0
  65. data/lib/schematic/types/billing_product_plan_response_data.rb +1 -0
  66. data/lib/schematic/types/billing_product_price_response_data.rb +1 -0
  67. data/lib/schematic/types/billing_strategy.rb +13 -0
  68. data/lib/schematic/types/change_subscription_internal_request_body.rb +1 -0
  69. data/lib/schematic/types/change_subscription_request_body.rb +1 -0
  70. data/lib/schematic/types/charge_type.rb +1 -0
  71. data/lib/schematic/types/clerk_integration_config.rb +10 -0
  72. data/lib/schematic/types/company_matching_criteria.rb +12 -0
  73. data/lib/schematic/types/company_plan_credit_grant_view.rb +40 -0
  74. data/lib/schematic/types/company_plan_detail_response_data.rb +2 -0
  75. data/lib/schematic/types/company_plan_with_billing_sub_view.rb +1 -1
  76. data/lib/schematic/types/create_billing_plan_credit_grant_request_body.rb +1 -0
  77. data/lib/schematic/types/create_custom_plan_bundle_plan_request_body.rb +12 -0
  78. data/lib/schematic/types/create_entitlement_in_bundle_request_body.rb +4 -0
  79. data/lib/schematic/types/create_event_request_body.rb +3 -0
  80. data/lib/schematic/types/credit_currency_price.rb +10 -0
  81. data/lib/schematic/types/currency_price_request_body.rb +3 -0
  82. data/lib/schematic/types/data_event_payload.rb +3 -0
  83. data/lib/schematic/types/duplicate_plan_entitlements_response_response_data.rb +1 -0
  84. data/lib/schematic/types/entitlement_currency_prices_response_data.rb +1 -0
  85. data/lib/schematic/types/event_detail_response_data.rb +2 -0
  86. data/lib/schematic/types/event_response_data.rb +1 -0
  87. data/lib/schematic/types/feature_company_response_data.rb +1 -0
  88. data/lib/schematic/types/feature_usage_response_data.rb +1 -0
  89. data/lib/schematic/types/integration_capabilities.rb +11 -0
  90. data/lib/schematic/types/integration_config.rb +15 -0
  91. data/lib/schematic/types/integration_response_data.rb +13 -0
  92. data/lib/schematic/types/integration_state.rb +13 -0
  93. data/lib/schematic/types/integrations_data_set_response_data.rb +9 -0
  94. data/lib/schematic/types/integrations_list_response_data.rb +15 -0
  95. data/lib/schematic/types/integrations_response_data.rb +13 -0
  96. data/lib/schematic/types/orb_integration_config.rb +9 -0
  97. data/lib/schematic/types/plan_credit_grant_view.rb +1 -0
  98. data/lib/schematic/types/plan_currency_price_request_body.rb +1 -0
  99. data/lib/schematic/types/plan_currency_prices_response_data.rb +1 -0
  100. data/lib/schematic/types/plan_detail_response_data.rb +2 -0
  101. data/lib/schematic/types/plan_entitlement_response_data.rb +1 -0
  102. data/lib/schematic/types/plan_group_plan_detail_response_data.rb +2 -0
  103. data/lib/schematic/types/plan_view_public_response_data.rb +2 -0
  104. data/lib/schematic/types/rules_engine_schema_version.rb +1 -1
  105. data/lib/schematic/types/stripe_integration_config.rb +15 -0
  106. data/lib/schematic/types/update_auto_topup_override_request_body.rb +12 -0
  107. data/lib/schematic/types/update_billing_plan_credit_grant_request_body.rb +1 -0
  108. data/lib/schematic/types/upsert_billing_product_request_body.rb +3 -0
  109. data/lib/schematic/types/usage_based_entitlement_request_body.rb +4 -0
  110. data/lib/schematic/types/usage_based_entitlement_response_data.rb +1 -0
  111. data/lib/schematic/version.rb +1 -1
  112. data/lib/schematic.rb +37 -10
  113. data/reference.md +675 -88
  114. metadata +30 -2
data/reference.md CHANGED
@@ -2492,6 +2492,14 @@ client.billing.upsert_billing_price(
2492
2492
  <dl>
2493
2493
  <dd>
2494
2494
 
2495
+ **interval_count:** `Integer`
2496
+
2497
+ </dd>
2498
+ </dl>
2499
+
2500
+ <dl>
2501
+ <dd>
2502
+
2495
2503
  **is_active:** `Internal::Types::Boolean`
2496
2504
 
2497
2505
  </dd>
@@ -2984,6 +2992,7 @@ client.billing.list_billing_products(
2984
2992
  price_usage_type: "licensed",
2985
2993
  provider_type: "orb",
2986
2994
  q: "q",
2995
+ recurring_charges_only: true,
2987
2996
  with_one_time_charges: true,
2988
2997
  with_prices_only: true,
2989
2998
  with_zero_price: true,
@@ -3053,6 +3062,14 @@ client.billing.list_billing_products(
3053
3062
  <dl>
3054
3063
  <dd>
3055
3064
 
3065
+ **recurring_charges_only:** `Internal::Types::Boolean` — Filter to products that have at least one recurring price
3066
+
3067
+ </dd>
3068
+ </dl>
3069
+
3070
+ <dl>
3071
+ <dd>
3072
+
3056
3073
  **with_one_time_charges:** `Internal::Types::Boolean` — Filter products that are one time charges
3057
3074
 
3058
3075
  </dd>
@@ -3133,6 +3150,7 @@ client.billing.count_billing_products(
3133
3150
  price_usage_type: "licensed",
3134
3151
  provider_type: "orb",
3135
3152
  q: "q",
3153
+ recurring_charges_only: true,
3136
3154
  with_one_time_charges: true,
3137
3155
  with_prices_only: true,
3138
3156
  with_zero_price: true,
@@ -3202,6 +3220,14 @@ client.billing.count_billing_products(
3202
3220
  <dl>
3203
3221
  <dd>
3204
3222
 
3223
+ **recurring_charges_only:** `Internal::Types::Boolean` — Filter to products that have at least one recurring price
3224
+
3225
+ </dd>
3226
+ </dl>
3227
+
3228
+ <dl>
3229
+ <dd>
3230
+
3205
3231
  **with_one_time_charges:** `Internal::Types::Boolean` — Filter products that are one time charges
3206
3232
 
3207
3233
  </dd>
@@ -5398,6 +5424,7 @@ client.credits.list_billing_plan_credit_grants(
5398
5424
  plan_id: "plan_id",
5399
5425
  plan_ids: ["plan_ids"],
5400
5426
  plan_version_id: "plan_version_id",
5427
+ plan_version_ids: ["plan_version_ids"],
5401
5428
  limit: 1000000,
5402
5429
  offset: 1000000
5403
5430
  )
@@ -5455,6 +5482,14 @@ client.credits.list_billing_plan_credit_grants(
5455
5482
  <dl>
5456
5483
  <dd>
5457
5484
 
5485
+ **plan_version_ids:** `String`
5486
+
5487
+ </dd>
5488
+ </dl>
5489
+
5490
+ <dl>
5491
+ <dd>
5492
+
5458
5493
  **limit:** `Integer` — Page limit (default 100)
5459
5494
 
5460
5495
  </dd>
@@ -5723,6 +5758,7 @@ client.credits.count_billing_plan_credit_grants(
5723
5758
  plan_id: "plan_id",
5724
5759
  plan_ids: ["plan_ids"],
5725
5760
  plan_version_id: "plan_version_id",
5761
+ plan_version_ids: ["plan_version_ids"],
5726
5762
  limit: 1000000,
5727
5763
  offset: 1000000
5728
5764
  )
@@ -5780,6 +5816,14 @@ client.credits.count_billing_plan_credit_grants(
5780
5816
  <dl>
5781
5817
  <dd>
5782
5818
 
5819
+ **plan_version_ids:** `String`
5820
+
5821
+ </dd>
5822
+ </dl>
5823
+
5824
+ <dl>
5825
+ <dd>
5826
+
5783
5827
  **limit:** `Integer` — Page limit (default 100)
5784
5828
 
5785
5829
  </dd>
@@ -6053,6 +6097,9 @@ client.checkout.internal(
6053
6097
  add_on_id: "add_on_id",
6054
6098
  price_id: "price_id"
6055
6099
  }],
6100
+ auto_topup_overrides: [{
6101
+ plan_credit_grant_id: "plan_credit_grant_id"
6102
+ }],
6056
6103
  company_id: "company_id",
6057
6104
  credit_bundles: [{
6058
6105
  bundle_id: "bundle_id",
@@ -6174,6 +6221,9 @@ client.checkout.preview_checkout_internal(
6174
6221
  add_on_id: "add_on_id",
6175
6222
  price_id: "price_id"
6176
6223
  }],
6224
+ auto_topup_overrides: [{
6225
+ plan_credit_grant_id: "plan_credit_grant_id"
6226
+ }],
6177
6227
  company_id: "company_id",
6178
6228
  credit_bundles: [{
6179
6229
  bundle_id: "bundle_id",
@@ -9967,6 +10017,7 @@ client.entitlements.list_feature_usage(
9967
10017
  company_id: "company_id",
9968
10018
  feature_ids: ["feature_ids"],
9969
10019
  include_usage_aggregation: true,
10020
+ managed_by: "orb",
9970
10021
  q: "q",
9971
10022
  without_negative_entitlements: true,
9972
10023
  limit: 1000000,
@@ -10018,6 +10069,14 @@ client.entitlements.list_feature_usage(
10018
10069
  <dl>
10019
10070
  <dd>
10020
10071
 
10072
+ **managed_by:** `Schematic::Types::BillingProviderType` — Filter for features managed by a billing provider, or by Schematic (no billing provider)
10073
+
10074
+ </dd>
10075
+ </dl>
10076
+
10077
+ <dl>
10078
+ <dd>
10079
+
10021
10080
  **q:** `String`
10022
10081
 
10023
10082
  </dd>
@@ -10165,6 +10224,7 @@ client.entitlements.count_feature_usage(
10165
10224
  company_id: "company_id",
10166
10225
  feature_ids: ["feature_ids"],
10167
10226
  include_usage_aggregation: true,
10227
+ managed_by: "orb",
10168
10228
  q: "q",
10169
10229
  without_negative_entitlements: true,
10170
10230
  limit: 1000000,
@@ -10216,6 +10276,14 @@ client.entitlements.count_feature_usage(
10216
10276
  <dl>
10217
10277
  <dd>
10218
10278
 
10279
+ **managed_by:** `Schematic::Types::BillingProviderType` — Filter for features managed by a billing provider, or by Schematic (no billing provider)
10280
+
10281
+ </dd>
10282
+ </dl>
10283
+
10284
+ <dl>
10285
+ <dd>
10286
+
10219
10287
  **q:** `String`
10220
10288
 
10221
10289
  </dd>
@@ -10722,6 +10790,38 @@ client.entitlements.create_plan_entitlement(
10722
10790
  <dl>
10723
10791
  <dd>
10724
10792
 
10793
+ **quarterly_metered_price_id:** `String`
10794
+
10795
+ </dd>
10796
+ </dl>
10797
+
10798
+ <dl>
10799
+ <dd>
10800
+
10801
+ **quarterly_price_tiers:** `Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody]`
10802
+
10803
+ </dd>
10804
+ </dl>
10805
+
10806
+ <dl>
10807
+ <dd>
10808
+
10809
+ **quarterly_unit_price:** `Integer`
10810
+
10811
+ </dd>
10812
+ </dl>
10813
+
10814
+ <dl>
10815
+ <dd>
10816
+
10817
+ **quarterly_unit_price_decimal:** `String`
10818
+
10819
+ </dd>
10820
+ </dl>
10821
+
10822
+ <dl>
10823
+ <dd>
10824
+
10725
10825
  **soft_limit:** `Integer`
10726
10826
 
10727
10827
  </dd>
@@ -11021,6 +11121,38 @@ client.entitlements.update_plan_entitlement(
11021
11121
  <dl>
11022
11122
  <dd>
11023
11123
 
11124
+ **quarterly_metered_price_id:** `String`
11125
+
11126
+ </dd>
11127
+ </dl>
11128
+
11129
+ <dl>
11130
+ <dd>
11131
+
11132
+ **quarterly_price_tiers:** `Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody]`
11133
+
11134
+ </dd>
11135
+ </dl>
11136
+
11137
+ <dl>
11138
+ <dd>
11139
+
11140
+ **quarterly_unit_price:** `Integer`
11141
+
11142
+ </dd>
11143
+ </dl>
11144
+
11145
+ <dl>
11146
+ <dd>
11147
+
11148
+ **quarterly_unit_price_decimal:** `String`
11149
+
11150
+ </dd>
11151
+ </dl>
11152
+
11153
+ <dl>
11154
+ <dd>
11155
+
11024
11156
  **soft_limit:** `Integer`
11025
11157
 
11026
11158
  </dd>
@@ -11355,6 +11487,38 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
11355
11487
  <dl>
11356
11488
  <dd>
11357
11489
 
11490
+ **quarterly_metered_price_id:** `String`
11491
+
11492
+ </dd>
11493
+ </dl>
11494
+
11495
+ <dl>
11496
+ <dd>
11497
+
11498
+ **quarterly_price_tiers:** `Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody]`
11499
+
11500
+ </dd>
11501
+ </dl>
11502
+
11503
+ <dl>
11504
+ <dd>
11505
+
11506
+ **quarterly_unit_price:** `Integer`
11507
+
11508
+ </dd>
11509
+ </dl>
11510
+
11511
+ <dl>
11512
+ <dd>
11513
+
11514
+ **quarterly_unit_price_decimal:** `String`
11515
+
11516
+ </dd>
11517
+ </dl>
11518
+
11519
+ <dl>
11520
+ <dd>
11521
+
11358
11522
  **soft_limit:** `Integer`
11359
11523
 
11360
11524
  </dd>
@@ -12053,6 +12217,7 @@ client.plans.create_custom_plan(
12053
12217
  ```ruby
12054
12218
  client.plans.list_plans(
12055
12219
  company_id: "company_id",
12220
+ company_scoped_only: true,
12056
12221
  exclude_company_scoped: true,
12057
12222
  for_fallback_plan: true,
12058
12223
  for_initial_plan: true,
@@ -12090,6 +12255,14 @@ client.plans.list_plans(
12090
12255
  <dl>
12091
12256
  <dd>
12092
12257
 
12258
+ **company_scoped_only:** `Internal::Types::Boolean` — Only return plans that are scoped to a company (custom plans assigned to a company)
12259
+
12260
+ </dd>
12261
+ </dl>
12262
+
12263
+ <dl>
12264
+ <dd>
12265
+
12093
12266
  **exclude_company_scoped:** `Internal::Types::Boolean` — Exclude plans that are scoped to a company (custom plans assigned to a company)
12094
12267
 
12095
12268
  </dd>
@@ -12550,6 +12723,14 @@ client.plans.upsert_plan_for_billing_product(
12550
12723
  <dl>
12551
12724
  <dd>
12552
12725
 
12726
+ **external_resource_version:** `String`
12727
+
12728
+ </dd>
12729
+ </dl>
12730
+
12731
+ <dl>
12732
+ <dd>
12733
+
12553
12734
  **icon:** `Schematic::Types::PlanIcon`
12554
12735
 
12555
12736
  </dd>
@@ -12755,6 +12936,7 @@ client.plans.count_billing_product_match_companies(
12755
12936
  ```ruby
12756
12937
  client.plans.count_plans(
12757
12938
  company_id: "company_id",
12939
+ company_scoped_only: true,
12758
12940
  exclude_company_scoped: true,
12759
12941
  for_fallback_plan: true,
12760
12942
  for_initial_plan: true,
@@ -12792,6 +12974,14 @@ client.plans.count_plans(
12792
12974
  <dl>
12793
12975
  <dd>
12794
12976
 
12977
+ **company_scoped_only:** `Internal::Types::Boolean` — Only return plans that are scoped to a company (custom plans assigned to a company)
12978
+
12979
+ </dd>
12980
+ </dl>
12981
+
12982
+ <dl>
12983
+ <dd>
12984
+
12795
12985
  **exclude_company_scoped:** `Internal::Types::Boolean` — Exclude plans that are scoped to a company (custom plans assigned to a company)
12796
12986
 
12797
12987
  </dd>
@@ -13577,8 +13767,8 @@ client.components.preview_component_data(
13577
13767
  </dl>
13578
13768
  </details>
13579
13769
 
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>
13770
+ ## planbundle
13771
+ <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
13772
  <dl>
13583
13773
  <dd>
13584
13774
 
@@ -13591,11 +13781,9 @@ client.components.preview_component_data(
13591
13781
  <dd>
13592
13782
 
13593
13783
  ```ruby
13594
- client.dataexports.create_data_export(
13595
- export_type: "company-feature-usage",
13596
- metadata: "metadata",
13597
- output_file_type: "csv"
13598
- )
13784
+ client.planbundle.create_custom_plan_bundle(entitlements: [{
13785
+ action: "create"
13786
+ }])
13599
13787
  ```
13600
13788
  </dd>
13601
13789
  </dl>
@@ -13610,7 +13798,7 @@ client.dataexports.create_data_export(
13610
13798
  <dl>
13611
13799
  <dd>
13612
13800
 
13613
- **export_type:** `String`
13801
+ **billing_product:** `Schematic::Types::UpsertBillingProductRequestBody`
13614
13802
 
13615
13803
  </dd>
13616
13804
  </dl>
@@ -13618,7 +13806,7 @@ client.dataexports.create_data_export(
13618
13806
  <dl>
13619
13807
  <dd>
13620
13808
 
13621
- **metadata:** `String`
13809
+ **entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
13622
13810
 
13623
13811
  </dd>
13624
13812
  </dl>
@@ -13626,7 +13814,7 @@ client.dataexports.create_data_export(
13626
13814
  <dl>
13627
13815
  <dd>
13628
13816
 
13629
- **output_file_type:** `String`
13817
+ **plan:** `Schematic::Types::CreateCustomPlanBundlePlanRequestBody`
13630
13818
 
13631
13819
  </dd>
13632
13820
  </dl>
@@ -13634,7 +13822,7 @@ client.dataexports.create_data_export(
13634
13822
  <dl>
13635
13823
  <dd>
13636
13824
 
13637
- **request_options:** `Schematic::Dataexports::RequestOptions`
13825
+ **request_options:** `Schematic::Planbundle::RequestOptions`
13638
13826
 
13639
13827
  </dd>
13640
13828
  </dl>
@@ -13646,7 +13834,7 @@ client.dataexports.create_data_export(
13646
13834
  </dl>
13647
13835
  </details>
13648
13836
 
13649
- <details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">get_data_export_artifact</a>(data_export_id) -> String</code></summary>
13837
+ <details><summary><code>client.planbundle.<a href="/lib/schematic/planbundle/client.rb">create_plan_bundle</a>(request) -> Schematic::Planbundle::Types::CreatePlanBundleResponse</code></summary>
13650
13838
  <dl>
13651
13839
  <dd>
13652
13840
 
@@ -13659,7 +13847,9 @@ client.dataexports.create_data_export(
13659
13847
  <dd>
13660
13848
 
13661
13849
  ```ruby
13662
- client.dataexports.get_data_export_artifact(data_export_id: "data_export_id")
13850
+ client.planbundle.create_plan_bundle(entitlements: [{
13851
+ action: "create"
13852
+ }])
13663
13853
  ```
13664
13854
  </dd>
13665
13855
  </dl>
@@ -13674,7 +13864,7 @@ client.dataexports.get_data_export_artifact(data_export_id: "data_export_id")
13674
13864
  <dl>
13675
13865
  <dd>
13676
13866
 
13677
- **data_export_id:** `String` — data_export_id
13867
+ **billing_product:** `Schematic::Types::UpsertBillingProductRequestBody`
13678
13868
 
13679
13869
  </dd>
13680
13870
  </dl>
@@ -13682,50 +13872,31 @@ client.dataexports.get_data_export_artifact(data_export_id: "data_export_id")
13682
13872
  <dl>
13683
13873
  <dd>
13684
13874
 
13685
- **request_options:** `Schematic::Dataexports::RequestOptions`
13875
+ **credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
13686
13876
 
13687
13877
  </dd>
13688
13878
  </dl>
13689
- </dd>
13690
- </dl>
13691
-
13692
-
13693
- </dd>
13694
- </dl>
13695
- </details>
13696
13879
 
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
13880
  <dl>
13700
13881
  <dd>
13701
13882
 
13702
- #### 🔌 Usage
13703
-
13704
- <dl>
13705
- <dd>
13883
+ **entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
13884
+
13885
+ </dd>
13886
+ </dl>
13706
13887
 
13707
13888
  <dl>
13708
13889
  <dd>
13709
13890
 
13710
- ```ruby
13711
- client.events.create_event_batch(events: [{
13712
- event_type: "flag_check"
13713
- }])
13714
- ```
13715
- </dd>
13716
- </dl>
13891
+ **plan:** `Schematic::Types::CreatePlanRequestBody`
13892
+
13717
13893
  </dd>
13718
13894
  </dl>
13719
13895
 
13720
- #### ⚙️ Parameters
13721
-
13722
- <dl>
13723
- <dd>
13724
-
13725
13896
  <dl>
13726
13897
  <dd>
13727
13898
 
13728
- **events:** `Internal::Types::Array[Schematic::Types::CreateEventRequestBody]`
13899
+ **traits:** `Internal::Types::Array[Schematic::Types::UpdatePlanTraitTraitRequestBody]`
13729
13900
 
13730
13901
  </dd>
13731
13902
  </dl>
@@ -13733,7 +13904,7 @@ client.events.create_event_batch(events: [{
13733
13904
  <dl>
13734
13905
  <dd>
13735
13906
 
13736
- **request_options:** `Schematic::Events::RequestOptions`
13907
+ **request_options:** `Schematic::Planbundle::RequestOptions`
13737
13908
 
13738
13909
  </dd>
13739
13910
  </dl>
@@ -13745,7 +13916,7 @@ client.events.create_event_batch(events: [{
13745
13916
  </dl>
13746
13917
  </details>
13747
13918
 
13748
- <details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">get_event_summaries</a>() -> Schematic::Events::Types::GetEventSummariesResponse</code></summary>
13919
+ <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
13920
  <dl>
13750
13921
  <dd>
13751
13922
 
@@ -13758,11 +13929,11 @@ client.events.create_event_batch(events: [{
13758
13929
  <dd>
13759
13930
 
13760
13931
  ```ruby
13761
- client.events.get_event_summaries(
13762
- q: "q",
13763
- event_subtypes: ["event_subtypes"],
13764
- limit: 1000000,
13765
- offset: 1000000
13932
+ client.planbundle.update_plan_bundle(
13933
+ plan_bundle_id: "plan_bundle_id",
13934
+ entitlements: [{
13935
+ action: "create"
13936
+ }]
13766
13937
  )
13767
13938
  ```
13768
13939
  </dd>
@@ -13778,7 +13949,7 @@ client.events.get_event_summaries(
13778
13949
  <dl>
13779
13950
  <dd>
13780
13951
 
13781
- **q:** `String`
13952
+ **plan_bundle_id:** `String` — plan_bundle_id
13782
13953
 
13783
13954
  </dd>
13784
13955
  </dl>
@@ -13786,7 +13957,7 @@ client.events.get_event_summaries(
13786
13957
  <dl>
13787
13958
  <dd>
13788
13959
 
13789
- **event_subtypes:** `String`
13960
+ **billing_product:** `Schematic::Types::UpsertBillingProductRequestBody`
13790
13961
 
13791
13962
  </dd>
13792
13963
  </dl>
@@ -13794,7 +13965,7 @@ client.events.get_event_summaries(
13794
13965
  <dl>
13795
13966
  <dd>
13796
13967
 
13797
- **limit:** `Integer` — Page limit (default 100)
13968
+ **credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
13798
13969
 
13799
13970
  </dd>
13800
13971
  </dl>
@@ -13802,7 +13973,7 @@ client.events.get_event_summaries(
13802
13973
  <dl>
13803
13974
  <dd>
13804
13975
 
13805
- **offset:** `Integer` — Page offset (default 0)
13976
+ **entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
13806
13977
 
13807
13978
  </dd>
13808
13979
  </dl>
@@ -13810,28 +13981,297 @@ client.events.get_event_summaries(
13810
13981
  <dl>
13811
13982
  <dd>
13812
13983
 
13813
- **request_options:** `Schematic::Events::RequestOptions`
13984
+ **plan:** `Schematic::Types::UpdatePlanRequestBody`
13814
13985
 
13815
13986
  </dd>
13816
13987
  </dl>
13817
- </dd>
13818
- </dl>
13819
13988
 
13989
+ <dl>
13990
+ <dd>
13820
13991
 
13992
+ **plan_version_id:** `String`
13993
+
13821
13994
  </dd>
13822
13995
  </dl>
13823
- </details>
13824
13996
 
13825
- <details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">list_events</a>() -> Schematic::Events::Types::ListEventsResponse</code></summary>
13826
13997
  <dl>
13827
13998
  <dd>
13828
13999
 
13829
- #### 🔌 Usage
14000
+ **traits:** `Internal::Types::Array[Schematic::Types::UpdatePlanTraitTraitRequestBody]`
14001
+
14002
+ </dd>
14003
+ </dl>
13830
14004
 
13831
14005
  <dl>
13832
14006
  <dd>
13833
14007
 
13834
- <dl>
14008
+ **request_options:** `Schematic::Planbundle::RequestOptions`
14009
+
14010
+ </dd>
14011
+ </dl>
14012
+ </dd>
14013
+ </dl>
14014
+
14015
+
14016
+ </dd>
14017
+ </dl>
14018
+ </details>
14019
+
14020
+ ## dataexports
14021
+ <details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">create_data_export</a>(request) -> Schematic::Dataexports::Types::CreateDataExportResponse</code></summary>
14022
+ <dl>
14023
+ <dd>
14024
+
14025
+ #### 🔌 Usage
14026
+
14027
+ <dl>
14028
+ <dd>
14029
+
14030
+ <dl>
14031
+ <dd>
14032
+
14033
+ ```ruby
14034
+ client.dataexports.create_data_export(
14035
+ export_type: "company-feature-usage",
14036
+ metadata: "metadata",
14037
+ output_file_type: "csv"
14038
+ )
14039
+ ```
14040
+ </dd>
14041
+ </dl>
14042
+ </dd>
14043
+ </dl>
14044
+
14045
+ #### ⚙️ Parameters
14046
+
14047
+ <dl>
14048
+ <dd>
14049
+
14050
+ <dl>
14051
+ <dd>
14052
+
14053
+ **export_type:** `String`
14054
+
14055
+ </dd>
14056
+ </dl>
14057
+
14058
+ <dl>
14059
+ <dd>
14060
+
14061
+ **metadata:** `String`
14062
+
14063
+ </dd>
14064
+ </dl>
14065
+
14066
+ <dl>
14067
+ <dd>
14068
+
14069
+ **output_file_type:** `String`
14070
+
14071
+ </dd>
14072
+ </dl>
14073
+
14074
+ <dl>
14075
+ <dd>
14076
+
14077
+ **request_options:** `Schematic::Dataexports::RequestOptions`
14078
+
14079
+ </dd>
14080
+ </dl>
14081
+ </dd>
14082
+ </dl>
14083
+
14084
+
14085
+ </dd>
14086
+ </dl>
14087
+ </details>
14088
+
14089
+ <details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">get_data_export_artifact</a>(data_export_id) -> String</code></summary>
14090
+ <dl>
14091
+ <dd>
14092
+
14093
+ #### 🔌 Usage
14094
+
14095
+ <dl>
14096
+ <dd>
14097
+
14098
+ <dl>
14099
+ <dd>
14100
+
14101
+ ```ruby
14102
+ client.dataexports.get_data_export_artifact(data_export_id: "data_export_id")
14103
+ ```
14104
+ </dd>
14105
+ </dl>
14106
+ </dd>
14107
+ </dl>
14108
+
14109
+ #### ⚙️ Parameters
14110
+
14111
+ <dl>
14112
+ <dd>
14113
+
14114
+ <dl>
14115
+ <dd>
14116
+
14117
+ **data_export_id:** `String` — data_export_id
14118
+
14119
+ </dd>
14120
+ </dl>
14121
+
14122
+ <dl>
14123
+ <dd>
14124
+
14125
+ **request_options:** `Schematic::Dataexports::RequestOptions`
14126
+
14127
+ </dd>
14128
+ </dl>
14129
+ </dd>
14130
+ </dl>
14131
+
14132
+
14133
+ </dd>
14134
+ </dl>
14135
+ </details>
14136
+
14137
+ ## events
14138
+ <details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">create_event_batch</a>(request) -> Schematic::Events::Types::CreateEventBatchResponse</code></summary>
14139
+ <dl>
14140
+ <dd>
14141
+
14142
+ #### 🔌 Usage
14143
+
14144
+ <dl>
14145
+ <dd>
14146
+
14147
+ <dl>
14148
+ <dd>
14149
+
14150
+ ```ruby
14151
+ client.events.create_event_batch(events: [{
14152
+ event_type: "flag_check"
14153
+ }])
14154
+ ```
14155
+ </dd>
14156
+ </dl>
14157
+ </dd>
14158
+ </dl>
14159
+
14160
+ #### ⚙️ Parameters
14161
+
14162
+ <dl>
14163
+ <dd>
14164
+
14165
+ <dl>
14166
+ <dd>
14167
+
14168
+ **events:** `Internal::Types::Array[Schematic::Types::CreateEventRequestBody]`
14169
+
14170
+ </dd>
14171
+ </dl>
14172
+
14173
+ <dl>
14174
+ <dd>
14175
+
14176
+ **request_options:** `Schematic::Events::RequestOptions`
14177
+
14178
+ </dd>
14179
+ </dl>
14180
+ </dd>
14181
+ </dl>
14182
+
14183
+
14184
+ </dd>
14185
+ </dl>
14186
+ </details>
14187
+
14188
+ <details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">get_event_summaries</a>() -> Schematic::Events::Types::GetEventSummariesResponse</code></summary>
14189
+ <dl>
14190
+ <dd>
14191
+
14192
+ #### 🔌 Usage
14193
+
14194
+ <dl>
14195
+ <dd>
14196
+
14197
+ <dl>
14198
+ <dd>
14199
+
14200
+ ```ruby
14201
+ client.events.get_event_summaries(
14202
+ q: "q",
14203
+ event_subtypes: ["event_subtypes"],
14204
+ limit: 1000000,
14205
+ offset: 1000000
14206
+ )
14207
+ ```
14208
+ </dd>
14209
+ </dl>
14210
+ </dd>
14211
+ </dl>
14212
+
14213
+ #### ⚙️ Parameters
14214
+
14215
+ <dl>
14216
+ <dd>
14217
+
14218
+ <dl>
14219
+ <dd>
14220
+
14221
+ **q:** `String`
14222
+
14223
+ </dd>
14224
+ </dl>
14225
+
14226
+ <dl>
14227
+ <dd>
14228
+
14229
+ **event_subtypes:** `String`
14230
+
14231
+ </dd>
14232
+ </dl>
14233
+
14234
+ <dl>
14235
+ <dd>
14236
+
14237
+ **limit:** `Integer` — Page limit (default 100)
14238
+
14239
+ </dd>
14240
+ </dl>
14241
+
14242
+ <dl>
14243
+ <dd>
14244
+
14245
+ **offset:** `Integer` — Page offset (default 0)
14246
+
14247
+ </dd>
14248
+ </dl>
14249
+
14250
+ <dl>
14251
+ <dd>
14252
+
14253
+ **request_options:** `Schematic::Events::RequestOptions`
14254
+
14255
+ </dd>
14256
+ </dl>
14257
+ </dd>
14258
+ </dl>
14259
+
14260
+
14261
+ </dd>
14262
+ </dl>
14263
+ </details>
14264
+
14265
+ <details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">list_events</a>() -> Schematic::Events::Types::ListEventsResponse</code></summary>
14266
+ <dl>
14267
+ <dd>
14268
+
14269
+ #### 🔌 Usage
14270
+
14271
+ <dl>
14272
+ <dd>
14273
+
14274
+ <dl>
13835
14275
  <dd>
13836
14276
 
13837
14277
  ```ruby
@@ -13840,6 +14280,7 @@ client.events.list_events(
13840
14280
  event_subtype: "event_subtype",
13841
14281
  event_types: ["flag_check"],
13842
14282
  flag_id: "flag_id",
14283
+ idempotency_key: "idempotency_key",
13843
14284
  user_id: "user_id",
13844
14285
  limit: 1000000,
13845
14286
  offset: 1000000
@@ -13890,6 +14331,14 @@ client.events.list_events(
13890
14331
  <dl>
13891
14332
  <dd>
13892
14333
 
14334
+ **idempotency_key:** `String`
14335
+
14336
+ </dd>
14337
+ </dl>
14338
+
14339
+ <dl>
14340
+ <dd>
14341
+
13893
14342
  **user_id:** `String`
13894
14343
 
13895
14344
  </dd>
@@ -14080,6 +14529,7 @@ client.features.list_features(
14080
14529
  boolean_require_event: true,
14081
14530
  feature_type: ["boolean"],
14082
14531
  ids: ["ids"],
14532
+ managed_by: "orb",
14083
14533
  plan_version_id: "plan_version_id",
14084
14534
  q: "q",
14085
14535
  without_company_override_for: "without_company_override_for",
@@ -14125,6 +14575,14 @@ client.features.list_features(
14125
14575
  <dl>
14126
14576
  <dd>
14127
14577
 
14578
+ **managed_by:** `Schematic::Types::BillingProviderType` — Filter for features managed by a billing provider, or by Schematic (no billing provider)
14579
+
14580
+ </dd>
14581
+ </dl>
14582
+
14583
+ <dl>
14584
+ <dd>
14585
+
14128
14586
  **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
14587
 
14130
14588
  </dd>
@@ -14716,6 +15174,7 @@ client.features.count_features(
14716
15174
  boolean_require_event: true,
14717
15175
  feature_type: ["boolean"],
14718
15176
  ids: ["ids"],
15177
+ managed_by: "orb",
14719
15178
  plan_version_id: "plan_version_id",
14720
15179
  q: "q",
14721
15180
  without_company_override_for: "without_company_override_for",
@@ -14761,6 +15220,14 @@ client.features.count_features(
14761
15220
  <dl>
14762
15221
  <dd>
14763
15222
 
15223
+ **managed_by:** `Schematic::Types::BillingProviderType` — Filter for features managed by a billing provider, or by Schematic (no billing provider)
15224
+
15225
+ </dd>
15226
+ </dl>
15227
+
15228
+ <dl>
15229
+ <dd>
15230
+
14764
15231
  **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
15232
 
14766
15233
  </dd>
@@ -15793,7 +16260,7 @@ client.insights.get_environment_trait_usage_time_series(
15793
16260
  </details>
15794
16261
 
15795
16262
  ## 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>
16263
+ <details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">run_integration</a>(integration_id) -> Schematic::Integrationsapi::Types::RunIntegrationResponse</code></summary>
15797
16264
  <dl>
15798
16265
  <dd>
15799
16266
 
@@ -15806,7 +16273,7 @@ client.insights.get_environment_trait_usage_time_series(
15806
16273
  <dd>
15807
16274
 
15808
16275
  ```ruby
15809
- client.integrationsapi.get_integration_webhook_url(type: "type")
16276
+ client.integrationsapi.run_integration(integration_id: "integration_id")
15810
16277
  ```
15811
16278
  </dd>
15812
16279
  </dl>
@@ -15821,7 +16288,7 @@ client.integrationsapi.get_integration_webhook_url(type: "type")
15821
16288
  <dl>
15822
16289
  <dd>
15823
16290
 
15824
- **type:** `String` — type
16291
+ **integration_id:** `String` — integration_id
15825
16292
 
15826
16293
  </dd>
15827
16294
  </dl>
@@ -15841,8 +16308,7 @@ client.integrationsapi.get_integration_webhook_url(type: "type")
15841
16308
  </dl>
15842
16309
  </details>
15843
16310
 
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>
16311
+ <details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">list_integrations</a>() -> Schematic::Integrationsapi::Types::ListIntegrationsResponse</code></summary>
15846
16312
  <dl>
15847
16313
  <dd>
15848
16314
 
@@ -15855,9 +16321,15 @@ client.integrationsapi.get_integration_webhook_url(type: "type")
15855
16321
  <dd>
15856
16322
 
15857
16323
  ```ruby
15858
- client.planbundle.create_plan_bundle(entitlements: [{
15859
- action: "create"
15860
- }])
16324
+ client.integrationsapi.list_integrations(
16325
+ billing_only: true,
16326
+ exclude_ids: ["exclude_ids"],
16327
+ id: "id",
16328
+ state: "active",
16329
+ type: "clerk",
16330
+ limit: 1000000,
16331
+ offset: 1000000
16332
+ )
15861
16333
  ```
15862
16334
  </dd>
15863
16335
  </dl>
@@ -15872,7 +16344,7 @@ client.planbundle.create_plan_bundle(entitlements: [{
15872
16344
  <dl>
15873
16345
  <dd>
15874
16346
 
15875
- **billing_product:** `Schematic::Types::UpsertBillingProductRequestBody`
16347
+ **billing_only:** `Internal::Types::Boolean`
15876
16348
 
15877
16349
  </dd>
15878
16350
  </dl>
@@ -15880,7 +16352,7 @@ client.planbundle.create_plan_bundle(entitlements: [{
15880
16352
  <dl>
15881
16353
  <dd>
15882
16354
 
15883
- **credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
16355
+ **exclude_ids:** `String`
15884
16356
 
15885
16357
  </dd>
15886
16358
  </dl>
@@ -15888,7 +16360,7 @@ client.planbundle.create_plan_bundle(entitlements: [{
15888
16360
  <dl>
15889
16361
  <dd>
15890
16362
 
15891
- **entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
16363
+ **id:** `String`
15892
16364
 
15893
16365
  </dd>
15894
16366
  </dl>
@@ -15896,7 +16368,7 @@ client.planbundle.create_plan_bundle(entitlements: [{
15896
16368
  <dl>
15897
16369
  <dd>
15898
16370
 
15899
- **plan:** `Schematic::Types::CreatePlanRequestBody`
16371
+ **state:** `Schematic::Types::IntegrationState`
15900
16372
 
15901
16373
  </dd>
15902
16374
  </dl>
@@ -15904,7 +16376,7 @@ client.planbundle.create_plan_bundle(entitlements: [{
15904
16376
  <dl>
15905
16377
  <dd>
15906
16378
 
15907
- **traits:** `Internal::Types::Array[Schematic::Types::UpdatePlanTraitTraitRequestBody]`
16379
+ **type:** `Schematic::Types::IntegrationType`
15908
16380
 
15909
16381
  </dd>
15910
16382
  </dl>
@@ -15912,7 +16384,23 @@ client.planbundle.create_plan_bundle(entitlements: [{
15912
16384
  <dl>
15913
16385
  <dd>
15914
16386
 
15915
- **request_options:** `Schematic::Planbundle::RequestOptions`
16387
+ **limit:** `Integer` — Page limit (default 100)
16388
+
16389
+ </dd>
16390
+ </dl>
16391
+
16392
+ <dl>
16393
+ <dd>
16394
+
16395
+ **offset:** `Integer` — Page offset (default 0)
16396
+
16397
+ </dd>
16398
+ </dl>
16399
+
16400
+ <dl>
16401
+ <dd>
16402
+
16403
+ **request_options:** `Schematic::Integrationsapi::RequestOptions`
15916
16404
 
15917
16405
  </dd>
15918
16406
  </dl>
@@ -15924,7 +16412,7 @@ client.planbundle.create_plan_bundle(entitlements: [{
15924
16412
  </dl>
15925
16413
  </details>
15926
16414
 
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>
16415
+ <details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">get_integration_webhook_url</a>(type) -> Schematic::Integrationsapi::Types::GetIntegrationWebhookUrlResponse</code></summary>
15928
16416
  <dl>
15929
16417
  <dd>
15930
16418
 
@@ -15937,12 +16425,7 @@ client.planbundle.create_plan_bundle(entitlements: [{
15937
16425
  <dd>
15938
16426
 
15939
16427
  ```ruby
15940
- client.planbundle.update_plan_bundle(
15941
- plan_bundle_id: "plan_bundle_id",
15942
- entitlements: [{
15943
- action: "create"
15944
- }]
15945
- )
16428
+ client.integrationsapi.get_integration_webhook_url(type: "type")
15946
16429
  ```
15947
16430
  </dd>
15948
16431
  </dl>
@@ -15957,7 +16440,7 @@ client.planbundle.update_plan_bundle(
15957
16440
  <dl>
15958
16441
  <dd>
15959
16442
 
15960
- **plan_bundle_id:** `String` — plan_bundle_id
16443
+ **type:** `String` — type
15961
16444
 
15962
16445
  </dd>
15963
16446
  </dl>
@@ -15965,15 +16448,47 @@ client.planbundle.update_plan_bundle(
15965
16448
  <dl>
15966
16449
  <dd>
15967
16450
 
15968
- **billing_product:** `Schematic::Types::UpsertBillingProductRequestBody`
16451
+ **request_options:** `Schematic::Integrationsapi::RequestOptions`
15969
16452
 
15970
16453
  </dd>
15971
16454
  </dl>
16455
+ </dd>
16456
+ </dl>
16457
+
16458
+
16459
+ </dd>
16460
+ </dl>
16461
+ </details>
15972
16462
 
16463
+ <details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">start_data_import</a>(request) -> Schematic::Integrationsapi::Types::StartDataImportResponse</code></summary>
15973
16464
  <dl>
15974
16465
  <dd>
15975
16466
 
15976
- **credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
16467
+ #### 🔌 Usage
16468
+
16469
+ <dl>
16470
+ <dd>
16471
+
16472
+ <dl>
16473
+ <dd>
16474
+
16475
+ ```ruby
16476
+ client.integrationsapi.start_data_import(integration_id: "integration_id")
16477
+ ```
16478
+ </dd>
16479
+ </dl>
16480
+ </dd>
16481
+ </dl>
16482
+
16483
+ #### ⚙️ Parameters
16484
+
16485
+ <dl>
16486
+ <dd>
16487
+
16488
+ <dl>
16489
+ <dd>
16490
+
16491
+ **company_matching_criteria:** `Schematic::Types::CompanyMatchingCriteria`
15977
16492
 
15978
16493
  </dd>
15979
16494
  </dl>
@@ -15981,7 +16496,7 @@ client.planbundle.update_plan_bundle(
15981
16496
  <dl>
15982
16497
  <dd>
15983
16498
 
15984
- **entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
16499
+ **company_matching_field:** `String`
15985
16500
 
15986
16501
  </dd>
15987
16502
  </dl>
@@ -15989,7 +16504,7 @@ client.planbundle.update_plan_bundle(
15989
16504
  <dl>
15990
16505
  <dd>
15991
16506
 
15992
- **plan:** `Schematic::Types::UpdatePlanRequestBody`
16507
+ **integration_id:** `String`
15993
16508
 
15994
16509
  </dd>
15995
16510
  </dl>
@@ -15997,23 +16512,95 @@ client.planbundle.update_plan_bundle(
15997
16512
  <dl>
15998
16513
  <dd>
15999
16514
 
16000
- **plan_version_id:** `String`
16515
+ **request_options:** `Schematic::Integrationsapi::RequestOptions`
16001
16516
 
16002
16517
  </dd>
16003
16518
  </dl>
16519
+ </dd>
16520
+ </dl>
16521
+
16004
16522
 
16523
+ </dd>
16524
+ </dl>
16525
+ </details>
16526
+
16527
+ <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>
16005
16528
  <dl>
16006
16529
  <dd>
16007
16530
 
16008
- **traits:** `Internal::Types::Array[Schematic::Types::UpdatePlanTraitTraitRequestBody]`
16531
+ #### 🔌 Usage
16532
+
16533
+ <dl>
16534
+ <dd>
16535
+
16536
+ <dl>
16537
+ <dd>
16538
+
16539
+ ```ruby
16540
+ client.integrationsapi.load_sample_data_set_v_2
16541
+ ```
16542
+ </dd>
16543
+ </dl>
16544
+ </dd>
16545
+ </dl>
16546
+
16547
+ #### ⚙️ Parameters
16548
+
16549
+ <dl>
16550
+ <dd>
16551
+
16552
+ <dl>
16553
+ <dd>
16554
+
16555
+ **request_options:** `Schematic::Integrationsapi::RequestOptions`
16009
16556
 
16010
16557
  </dd>
16011
16558
  </dl>
16559
+ </dd>
16560
+ </dl>
16561
+
16562
+
16563
+ </dd>
16564
+ </dl>
16565
+ </details>
16012
16566
 
16567
+ <details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">uninstall_integration</a>(integration_id) -> Schematic::Integrationsapi::Types::UninstallIntegrationResponse</code></summary>
16013
16568
  <dl>
16014
16569
  <dd>
16015
16570
 
16016
- **request_options:** `Schematic::Planbundle::RequestOptions`
16571
+ #### 🔌 Usage
16572
+
16573
+ <dl>
16574
+ <dd>
16575
+
16576
+ <dl>
16577
+ <dd>
16578
+
16579
+ ```ruby
16580
+ client.integrationsapi.uninstall_integration(integration_id: "integration_id")
16581
+ ```
16582
+ </dd>
16583
+ </dl>
16584
+ </dd>
16585
+ </dl>
16586
+
16587
+ #### ⚙️ Parameters
16588
+
16589
+ <dl>
16590
+ <dd>
16591
+
16592
+ <dl>
16593
+ <dd>
16594
+
16595
+ **integration_id:** `String` — integration_id
16596
+
16597
+ </dd>
16598
+ </dl>
16599
+
16600
+ <dl>
16601
+ <dd>
16602
+
16603
+ **request_options:** `Schematic::Integrationsapi::RequestOptions`
16017
16604
 
16018
16605
  </dd>
16019
16606
  </dl>