schematichq 1.4.8 → 1.4.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (100) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +3 -3
  3. data/.fern/replay.lock +350 -2
  4. data/WASM_VERSION +1 -1
  5. data/lib/schematic/billing/types/create_invoice_request_body.rb +2 -0
  6. data/lib/schematic/catalogs/client.rb +480 -0
  7. data/lib/schematic/catalogs/types/create_catalog_request_body.rb +13 -0
  8. data/lib/schematic/catalogs/types/create_catalog_response.rb +12 -0
  9. data/lib/schematic/catalogs/types/delete_catalog_response.rb +12 -0
  10. data/lib/schematic/catalogs/types/get_catalog_response.rb +12 -0
  11. data/lib/schematic/catalogs/types/get_configuration_response.rb +12 -0
  12. data/lib/schematic/catalogs/types/get_credit_bundles_in_catalog_response.rb +12 -0
  13. data/lib/schematic/catalogs/types/get_derived_features_response.rb +12 -0
  14. data/lib/schematic/catalogs/types/get_plans_in_catalog_response.rb +12 -0
  15. data/lib/schematic/catalogs/types/list_catalogs_params.rb +15 -0
  16. data/lib/schematic/catalogs/types/list_catalogs_request.rb +14 -0
  17. data/lib/schematic/catalogs/types/list_catalogs_response.rb +12 -0
  18. data/lib/schematic/catalogs/types/update_catalog_configuration_request_body.rb +20 -0
  19. data/lib/schematic/catalogs/types/update_catalog_request_body.rb +14 -0
  20. data/lib/schematic/catalogs/types/update_catalog_response.rb +12 -0
  21. data/lib/schematic/catalogs/types/update_configuration_response.rb +12 -0
  22. data/lib/schematic/checkout/client.rb +69 -0
  23. data/lib/schematic/checkout/types/get_company_billing_details_response.rb +12 -0
  24. data/lib/schematic/checkout/types/update_company_billing_details_request_body.rb +15 -0
  25. data/lib/schematic/checkout/types/update_company_billing_details_response.rb +12 -0
  26. data/lib/schematic/client.rb +6 -1
  27. data/lib/schematic/components/client.rb +37 -0
  28. data/lib/schematic/components/types/bind_catalog_request_body.rb +12 -0
  29. data/lib/schematic/components/types/bind_catalog_response.rb +12 -0
  30. data/lib/schematic/dataexports/client.rb +76 -0
  31. data/lib/schematic/dataexports/types/create_data_export_request_body.rb +3 -3
  32. data/lib/schematic/dataexports/types/get_data_export_response.rb +12 -0
  33. data/lib/schematic/dataexports/types/list_data_exports_params.rb +15 -0
  34. data/lib/schematic/dataexports/types/list_data_exports_request.rb +14 -0
  35. data/lib/schematic/dataexports/types/list_data_exports_response.rb +12 -0
  36. data/lib/schematic/entitlements/types/create_billing_linked_plan_entitlement_request_body.rb +1 -0
  37. data/lib/schematic/entitlements/types/create_plan_entitlement_request_body.rb +1 -0
  38. data/lib/schematic/entitlements/types/update_plan_entitlement_request_body.rb +1 -0
  39. data/lib/schematic/planbundle/types/create_custom_plan_bundle_request_body.rb +1 -0
  40. data/lib/schematic/planbundle/types/create_plan_bundle_request_body.rb +0 -1
  41. data/lib/schematic/planbundle/types/update_plan_bundle_request_body.rb +0 -1
  42. data/lib/schematic/rules_engine.rb +11 -0
  43. data/lib/schematic/types/account_member_permission.rb +1 -0
  44. data/lib/schematic/types/audit_log_export_metadata.rb +13 -0
  45. data/lib/schematic/types/billing_plan_credit_grant_reset_cadence.rb +2 -0
  46. data/lib/schematic/types/catalog_config_ordered_bundle.rb +9 -0
  47. data/lib/schematic/types/catalog_config_ordered_bundle_response_data.rb +9 -0
  48. data/lib/schematic/types/catalog_config_ordered_entitlement.rb +10 -0
  49. data/lib/schematic/types/catalog_config_ordered_entitlement_response_data.rb +10 -0
  50. data/lib/schematic/types/catalog_config_ordered_plan.rb +10 -0
  51. data/lib/schematic/types/catalog_config_ordered_plan_response_data.rb +10 -0
  52. data/lib/schematic/types/catalog_configuration_response_data.rb +19 -0
  53. data/lib/schematic/types/catalog_credit_bundle_i_ds_response_data.rb +9 -0
  54. data/lib/schematic/types/catalog_derived_feature_response_data.rb +11 -0
  55. data/lib/schematic/types/catalog_derived_features_response_data.rb +9 -0
  56. data/lib/schematic/types/catalog_plan_i_ds_response_data.rb +9 -0
  57. data/lib/schematic/types/catalog_response_data.rb +22 -0
  58. data/lib/schematic/types/company_billing_address_view.rb +14 -0
  59. data/lib/schematic/types/company_billing_checkout_settings.rb +11 -0
  60. data/lib/schematic/types/company_billing_details_response_data.rb +13 -0
  61. data/lib/schematic/types/company_billing_details_view.rb +13 -0
  62. data/lib/schematic/types/company_feature_usage_export_metadata.rb +25 -0
  63. data/lib/schematic/types/company_plan_detail_response_data.rb +1 -0
  64. data/lib/schematic/types/component_response_data.rb +1 -0
  65. data/lib/schematic/types/create_entitlement_in_bundle_request_body.rb +1 -0
  66. data/lib/schematic/types/credits_auto_topup_success.rb +12 -0
  67. data/lib/schematic/types/credits_credit_purchase_success.rb +14 -0
  68. data/lib/schematic/types/credits_webhook_company_summary.rb +10 -0
  69. data/lib/schematic/types/credits_webhook_credit_summary.rb +10 -0
  70. data/lib/schematic/types/customer_billing_address.rb +14 -0
  71. data/lib/schematic/types/data_export_metadata.rb +14 -0
  72. data/lib/schematic/types/data_export_output_file_type.rb +3 -14
  73. data/lib/schematic/types/data_export_response_data.rb +3 -3
  74. data/lib/schematic/types/data_export_type.rb +3 -14
  75. data/lib/schematic/types/event_body.rb +1 -0
  76. data/lib/schematic/types/event_body_inference.rb +22 -0
  77. data/lib/schematic/types/event_type.rb +1 -0
  78. data/lib/schematic/types/feature_entitlement.rb +1 -0
  79. data/lib/schematic/types/invoice_request_body.rb +2 -0
  80. data/lib/schematic/types/invoice_response_data.rb +2 -0
  81. data/lib/schematic/types/plan_bundle_response_data.rb +0 -1
  82. data/lib/schematic/types/plan_catalog_membership_response_data.rb +10 -0
  83. data/lib/schematic/types/plan_detail_response_data.rb +1 -0
  84. data/lib/schematic/types/plan_entitlement_response_data.rb +1 -0
  85. data/lib/schematic/types/plan_group_plan_detail_response_data.rb +1 -0
  86. data/lib/schematic/types/plan_view_public_response_data.rb +1 -0
  87. data/lib/schematic/types/preview_subscription_discount_response_data.rb +19 -0
  88. data/lib/schematic/types/preview_subscription_finance_response_data.rb +2 -0
  89. data/lib/schematic/types/rulesengine_feature_entitlement.rb +1 -0
  90. data/lib/schematic/types/rulesengine_warning_tier.rb +10 -0
  91. data/lib/schematic/types/upsert_company_request_body.rb +2 -0
  92. data/lib/schematic/types/warning_tier.rb +10 -0
  93. data/lib/schematic/types/warning_tier_request_body.rb +10 -0
  94. data/lib/schematic/types/warning_tier_response_data.rb +11 -0
  95. data/lib/schematic/types/webhook_request_type.rb +2 -0
  96. data/lib/schematic/version.rb +1 -1
  97. data/lib/schematic/wasm/rulesengine.wasm +0 -0
  98. data/lib/schematic.rb +92 -36
  99. data/reference.md +1290 -83
  100. metadata +58 -2
data/reference.md CHANGED
@@ -2017,6 +2017,14 @@ client.billing.upsert_invoice(
2017
2017
  <dl>
2018
2018
  <dd>
2019
2019
 
2020
+ **ending_balance:** `Integer`
2021
+
2022
+ </dd>
2023
+ </dl>
2024
+
2025
+ <dl>
2026
+ <dd>
2027
+
2020
2028
  **external_id:** `String`
2021
2029
 
2022
2030
  </dd>
@@ -2033,6 +2041,14 @@ client.billing.upsert_invoice(
2033
2041
  <dl>
2034
2042
  <dd>
2035
2043
 
2044
+ **starting_balance:** `Integer`
2045
+
2046
+ </dd>
2047
+ </dl>
2048
+
2049
+ <dl>
2050
+ <dd>
2051
+
2036
2052
  **status:** `Schematic::Types::InvoiceStatus`
2037
2053
 
2038
2054
  </dd>
@@ -6389,8 +6405,8 @@ client.credits.count_credit_event_ledger(
6389
6405
  </dl>
6390
6406
  </details>
6391
6407
 
6392
- ## checkout
6393
- <details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">internal</a>(request) -> Schematic::Checkout::Types::CheckoutInternalResponse</code></summary>
6408
+ ## catalogs
6409
+ <details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">list_catalogs</a>() -> Schematic::Catalogs::Types::ListCatalogsResponse</code></summary>
6394
6410
  <dl>
6395
6411
  <dd>
6396
6412
 
@@ -6403,30 +6419,11 @@ client.credits.count_credit_event_ledger(
6403
6419
  <dd>
6404
6420
 
6405
6421
  ```ruby
6406
- client.checkout.internal(
6407
- add_on_ids: [{
6408
- add_on_id: "add_on_id",
6409
- price_id: "price_id"
6410
- }],
6411
- auto_topup_overrides: [{
6412
- plan_credit_grant_id: "plan_credit_grant_id"
6413
- }],
6414
- company_id: "company_id",
6415
- credit_bundles: [{
6416
- bundle_id: "bundle_id",
6417
- quantity: 1000000
6418
- }],
6419
- custom_field_values: [{
6420
- id: "id",
6421
- value: "value"
6422
- }],
6423
- new_plan_id: "new_plan_id",
6424
- new_price_id: "new_price_id",
6425
- pay_in_advance: [{
6426
- price_id: "price_id",
6427
- quantity: 1000000
6428
- }],
6429
- skip_trial: true
6422
+ client.catalogs.list_catalogs(
6423
+ is_default: true,
6424
+ q: "q",
6425
+ limit: 1000000,
6426
+ offset: 1000000
6430
6427
  )
6431
6428
  ```
6432
6429
  </dd>
@@ -6442,7 +6439,7 @@ client.checkout.internal(
6442
6439
  <dl>
6443
6440
  <dd>
6444
6441
 
6445
- **request:** `Schematic::Types::ChangeSubscriptionInternalRequestBody`
6442
+ **is_default:** `Internal::Types::Boolean`
6446
6443
 
6447
6444
  </dd>
6448
6445
  </dl>
@@ -6450,7 +6447,31 @@ client.checkout.internal(
6450
6447
  <dl>
6451
6448
  <dd>
6452
6449
 
6453
- **request_options:** `Schematic::Checkout::RequestOptions`
6450
+ **q:** `String` — Search by catalog name
6451
+
6452
+ </dd>
6453
+ </dl>
6454
+
6455
+ <dl>
6456
+ <dd>
6457
+
6458
+ **limit:** `Integer` — Page limit (default 100)
6459
+
6460
+ </dd>
6461
+ </dl>
6462
+
6463
+ <dl>
6464
+ <dd>
6465
+
6466
+ **offset:** `Integer` — Page offset (default 0)
6467
+
6468
+ </dd>
6469
+ </dl>
6470
+
6471
+ <dl>
6472
+ <dd>
6473
+
6474
+ **request_options:** `Schematic::Catalogs::RequestOptions`
6454
6475
 
6455
6476
  </dd>
6456
6477
  </dl>
@@ -6462,7 +6483,7 @@ client.checkout.internal(
6462
6483
  </dl>
6463
6484
  </details>
6464
6485
 
6465
- <details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">get_checkout_data</a>(request) -> Schematic::Checkout::Types::GetCheckoutDataResponse</code></summary>
6486
+ <details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">create_catalog</a>(request) -> Schematic::Catalogs::Types::CreateCatalogResponse</code></summary>
6466
6487
  <dl>
6467
6488
  <dd>
6468
6489
 
@@ -6475,7 +6496,10 @@ client.checkout.internal(
6475
6496
  <dd>
6476
6497
 
6477
6498
  ```ruby
6478
- client.checkout.get_checkout_data(company_id: "company_id")
6499
+ client.catalogs.create_catalog(
6500
+ is_default: true,
6501
+ name: "name"
6502
+ )
6479
6503
  ```
6480
6504
  </dd>
6481
6505
  </dl>
@@ -6490,7 +6514,7 @@ client.checkout.get_checkout_data(company_id: "company_id")
6490
6514
  <dl>
6491
6515
  <dd>
6492
6516
 
6493
- **company_id:** `String`
6517
+ **description:** `String`
6494
6518
 
6495
6519
  </dd>
6496
6520
  </dl>
@@ -6498,7 +6522,7 @@ client.checkout.get_checkout_data(company_id: "company_id")
6498
6522
  <dl>
6499
6523
  <dd>
6500
6524
 
6501
- **currency:** `String`
6525
+ **is_default:** `Internal::Types::Boolean`
6502
6526
 
6503
6527
  </dd>
6504
6528
  </dl>
@@ -6506,7 +6530,7 @@ client.checkout.get_checkout_data(company_id: "company_id")
6506
6530
  <dl>
6507
6531
  <dd>
6508
6532
 
6509
- **selected_plan_id:** `String`
6533
+ **name:** `String`
6510
6534
 
6511
6535
  </dd>
6512
6536
  </dl>
@@ -6514,7 +6538,175 @@ client.checkout.get_checkout_data(company_id: "company_id")
6514
6538
  <dl>
6515
6539
  <dd>
6516
6540
 
6517
- **request_options:** `Schematic::Checkout::RequestOptions`
6541
+ **request_options:** `Schematic::Catalogs::RequestOptions`
6542
+
6543
+ </dd>
6544
+ </dl>
6545
+ </dd>
6546
+ </dl>
6547
+
6548
+
6549
+ </dd>
6550
+ </dl>
6551
+ </details>
6552
+
6553
+ <details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_catalog</a>(catalog_id) -> Schematic::Catalogs::Types::GetCatalogResponse</code></summary>
6554
+ <dl>
6555
+ <dd>
6556
+
6557
+ #### 🔌 Usage
6558
+
6559
+ <dl>
6560
+ <dd>
6561
+
6562
+ <dl>
6563
+ <dd>
6564
+
6565
+ ```ruby
6566
+ client.catalogs.get_catalog(catalog_id: "catalog_id")
6567
+ ```
6568
+ </dd>
6569
+ </dl>
6570
+ </dd>
6571
+ </dl>
6572
+
6573
+ #### ⚙️ Parameters
6574
+
6575
+ <dl>
6576
+ <dd>
6577
+
6578
+ <dl>
6579
+ <dd>
6580
+
6581
+ **catalog_id:** `String` — catalog_id
6582
+
6583
+ </dd>
6584
+ </dl>
6585
+
6586
+ <dl>
6587
+ <dd>
6588
+
6589
+ **request_options:** `Schematic::Catalogs::RequestOptions`
6590
+
6591
+ </dd>
6592
+ </dl>
6593
+ </dd>
6594
+ </dl>
6595
+
6596
+
6597
+ </dd>
6598
+ </dl>
6599
+ </details>
6600
+
6601
+ <details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">update_catalog</a>(catalog_id, request) -> Schematic::Catalogs::Types::UpdateCatalogResponse</code></summary>
6602
+ <dl>
6603
+ <dd>
6604
+
6605
+ #### 🔌 Usage
6606
+
6607
+ <dl>
6608
+ <dd>
6609
+
6610
+ <dl>
6611
+ <dd>
6612
+
6613
+ ```ruby
6614
+ client.catalogs.update_catalog(catalog_id: "catalog_id")
6615
+ ```
6616
+ </dd>
6617
+ </dl>
6618
+ </dd>
6619
+ </dl>
6620
+
6621
+ #### ⚙️ Parameters
6622
+
6623
+ <dl>
6624
+ <dd>
6625
+
6626
+ <dl>
6627
+ <dd>
6628
+
6629
+ **catalog_id:** `String` — catalog_id
6630
+
6631
+ </dd>
6632
+ </dl>
6633
+
6634
+ <dl>
6635
+ <dd>
6636
+
6637
+ **description:** `String`
6638
+
6639
+ </dd>
6640
+ </dl>
6641
+
6642
+ <dl>
6643
+ <dd>
6644
+
6645
+ **is_default:** `Internal::Types::Boolean`
6646
+
6647
+ </dd>
6648
+ </dl>
6649
+
6650
+ <dl>
6651
+ <dd>
6652
+
6653
+ **name:** `String`
6654
+
6655
+ </dd>
6656
+ </dl>
6657
+
6658
+ <dl>
6659
+ <dd>
6660
+
6661
+ **request_options:** `Schematic::Catalogs::RequestOptions`
6662
+
6663
+ </dd>
6664
+ </dl>
6665
+ </dd>
6666
+ </dl>
6667
+
6668
+
6669
+ </dd>
6670
+ </dl>
6671
+ </details>
6672
+
6673
+ <details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">delete_catalog</a>(catalog_id) -> Schematic::Catalogs::Types::DeleteCatalogResponse</code></summary>
6674
+ <dl>
6675
+ <dd>
6676
+
6677
+ #### 🔌 Usage
6678
+
6679
+ <dl>
6680
+ <dd>
6681
+
6682
+ <dl>
6683
+ <dd>
6684
+
6685
+ ```ruby
6686
+ client.catalogs.delete_catalog(catalog_id: "catalog_id")
6687
+ ```
6688
+ </dd>
6689
+ </dl>
6690
+ </dd>
6691
+ </dl>
6692
+
6693
+ #### ⚙️ Parameters
6694
+
6695
+ <dl>
6696
+ <dd>
6697
+
6698
+ <dl>
6699
+ <dd>
6700
+
6701
+ **catalog_id:** `String` — catalog_id
6702
+
6703
+ </dd>
6704
+ </dl>
6705
+
6706
+ <dl>
6707
+ <dd>
6708
+
6709
+ **request_options:** `Schematic::Catalogs::RequestOptions`
6518
6710
 
6519
6711
  </dd>
6520
6712
  </dl>
@@ -6526,59 +6718,878 @@ client.checkout.get_checkout_data(company_id: "company_id")
6526
6718
  </dl>
6527
6719
  </details>
6528
6720
 
6529
- <details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">preview_checkout_internal</a>(request) -> Schematic::Checkout::Types::PreviewCheckoutInternalResponse</code></summary>
6721
+ <details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_configuration</a>(catalog_id) -> Schematic::Catalogs::Types::GetConfigurationResponse</code></summary>
6722
+ <dl>
6723
+ <dd>
6724
+
6725
+ #### 🔌 Usage
6726
+
6727
+ <dl>
6728
+ <dd>
6729
+
6730
+ <dl>
6731
+ <dd>
6732
+
6733
+ ```ruby
6734
+ client.catalogs.get_configuration(catalog_id: "catalog_id")
6735
+ ```
6736
+ </dd>
6737
+ </dl>
6738
+ </dd>
6739
+ </dl>
6740
+
6741
+ #### ⚙️ Parameters
6742
+
6743
+ <dl>
6744
+ <dd>
6745
+
6746
+ <dl>
6747
+ <dd>
6748
+
6749
+ **catalog_id:** `String` — catalog_id
6750
+
6751
+ </dd>
6752
+ </dl>
6753
+
6754
+ <dl>
6755
+ <dd>
6756
+
6757
+ **request_options:** `Schematic::Catalogs::RequestOptions`
6758
+
6759
+ </dd>
6760
+ </dl>
6761
+ </dd>
6762
+ </dl>
6763
+
6764
+
6765
+ </dd>
6766
+ </dl>
6767
+ </details>
6768
+
6769
+ <details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">update_configuration</a>(catalog_id, request) -> Schematic::Catalogs::Types::UpdateConfigurationResponse</code></summary>
6770
+ <dl>
6771
+ <dd>
6772
+
6773
+ #### 🔌 Usage
6774
+
6775
+ <dl>
6776
+ <dd>
6777
+
6778
+ <dl>
6779
+ <dd>
6780
+
6781
+ ```ruby
6782
+ client.catalogs.update_configuration(catalog_id: "catalog_id")
6783
+ ```
6784
+ </dd>
6785
+ </dl>
6786
+ </dd>
6787
+ </dl>
6788
+
6789
+ #### ⚙️ Parameters
6790
+
6791
+ <dl>
6792
+ <dd>
6793
+
6794
+ <dl>
6795
+ <dd>
6796
+
6797
+ **catalog_id:** `String` — catalog_id
6798
+
6799
+ </dd>
6800
+ </dl>
6801
+
6802
+ <dl>
6803
+ <dd>
6804
+
6805
+ **custom_plan_cta_text:** `String`
6806
+
6807
+ </dd>
6808
+ </dl>
6809
+
6810
+ <dl>
6811
+ <dd>
6812
+
6813
+ **custom_plan_cta_url:** `String`
6814
+
6815
+ </dd>
6816
+ </dl>
6817
+
6818
+ <dl>
6819
+ <dd>
6820
+
6821
+ **custom_plan_price_text:** `String`
6822
+
6823
+ </dd>
6824
+ </dl>
6825
+
6826
+ <dl>
6827
+ <dd>
6828
+
6829
+ **custom_plans_visible:** `Internal::Types::Boolean`
6830
+
6831
+ </dd>
6832
+ </dl>
6833
+
6834
+ <dl>
6835
+ <dd>
6836
+
6837
+ **ordered_add_ons:** `Internal::Types::Array[Schematic::Types::CatalogConfigOrderedPlan]`
6838
+
6839
+ </dd>
6840
+ </dl>
6841
+
6842
+ <dl>
6843
+ <dd>
6844
+
6845
+ **ordered_bundles:** `Internal::Types::Array[Schematic::Types::CatalogConfigOrderedBundle]`
6846
+
6847
+ </dd>
6848
+ </dl>
6849
+
6850
+ <dl>
6851
+ <dd>
6852
+
6853
+ **ordered_plans:** `Internal::Types::Array[Schematic::Types::CatalogConfigOrderedPlan]`
6854
+
6855
+ </dd>
6856
+ </dl>
6857
+
6858
+ <dl>
6859
+ <dd>
6860
+
6861
+ **pricing_model:** `String`
6862
+
6863
+ </dd>
6864
+ </dl>
6865
+
6866
+ <dl>
6867
+ <dd>
6868
+
6869
+ **pricing_url:** `String`
6870
+
6871
+ </dd>
6872
+ </dl>
6873
+
6874
+ <dl>
6875
+ <dd>
6876
+
6877
+ **request_options:** `Schematic::Catalogs::RequestOptions`
6878
+
6879
+ </dd>
6880
+ </dl>
6881
+ </dd>
6882
+ </dl>
6883
+
6884
+
6885
+ </dd>
6886
+ </dl>
6887
+ </details>
6888
+
6889
+ <details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_credit_bundles_in_catalog</a>(catalog_id) -> Schematic::Catalogs::Types::GetCreditBundlesInCatalogResponse</code></summary>
6890
+ <dl>
6891
+ <dd>
6892
+
6893
+ #### 🔌 Usage
6894
+
6895
+ <dl>
6896
+ <dd>
6897
+
6898
+ <dl>
6899
+ <dd>
6900
+
6901
+ ```ruby
6902
+ client.catalogs.get_credit_bundles_in_catalog(catalog_id: "catalog_id")
6903
+ ```
6904
+ </dd>
6905
+ </dl>
6906
+ </dd>
6907
+ </dl>
6908
+
6909
+ #### ⚙️ Parameters
6910
+
6911
+ <dl>
6912
+ <dd>
6913
+
6914
+ <dl>
6915
+ <dd>
6916
+
6917
+ **catalog_id:** `String` — catalog_id
6918
+
6919
+ </dd>
6920
+ </dl>
6921
+
6922
+ <dl>
6923
+ <dd>
6924
+
6925
+ **request_options:** `Schematic::Catalogs::RequestOptions`
6926
+
6927
+ </dd>
6928
+ </dl>
6929
+ </dd>
6930
+ </dl>
6931
+
6932
+
6933
+ </dd>
6934
+ </dl>
6935
+ </details>
6936
+
6937
+ <details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">add_credit_bundle</a>(catalog_id, credit_bundle_id) -> </code></summary>
6938
+ <dl>
6939
+ <dd>
6940
+
6941
+ #### 🔌 Usage
6942
+
6943
+ <dl>
6944
+ <dd>
6945
+
6946
+ <dl>
6947
+ <dd>
6948
+
6949
+ ```ruby
6950
+ client.catalogs.add_credit_bundle(
6951
+ catalog_id: "catalog_id",
6952
+ credit_bundle_id: "credit_bundle_id"
6953
+ )
6954
+ ```
6955
+ </dd>
6956
+ </dl>
6957
+ </dd>
6958
+ </dl>
6959
+
6960
+ #### ⚙️ Parameters
6961
+
6962
+ <dl>
6963
+ <dd>
6964
+
6965
+ <dl>
6966
+ <dd>
6967
+
6968
+ **catalog_id:** `String` — catalog_id
6969
+
6970
+ </dd>
6971
+ </dl>
6972
+
6973
+ <dl>
6974
+ <dd>
6975
+
6976
+ **credit_bundle_id:** `String` — credit_bundle_id
6977
+
6978
+ </dd>
6979
+ </dl>
6980
+
6981
+ <dl>
6982
+ <dd>
6983
+
6984
+ **request_options:** `Schematic::Catalogs::RequestOptions`
6985
+
6986
+ </dd>
6987
+ </dl>
6988
+ </dd>
6989
+ </dl>
6990
+
6991
+
6992
+ </dd>
6993
+ </dl>
6994
+ </details>
6995
+
6996
+ <details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">remove_credit_bundle</a>(catalog_id, credit_bundle_id) -> </code></summary>
6997
+ <dl>
6998
+ <dd>
6999
+
7000
+ #### 🔌 Usage
7001
+
7002
+ <dl>
7003
+ <dd>
7004
+
7005
+ <dl>
7006
+ <dd>
7007
+
7008
+ ```ruby
7009
+ client.catalogs.remove_credit_bundle(
7010
+ catalog_id: "catalog_id",
7011
+ credit_bundle_id: "credit_bundle_id"
7012
+ )
7013
+ ```
7014
+ </dd>
7015
+ </dl>
7016
+ </dd>
7017
+ </dl>
7018
+
7019
+ #### ⚙️ Parameters
7020
+
7021
+ <dl>
7022
+ <dd>
7023
+
7024
+ <dl>
7025
+ <dd>
7026
+
7027
+ **catalog_id:** `String` — catalog_id
7028
+
7029
+ </dd>
7030
+ </dl>
7031
+
7032
+ <dl>
7033
+ <dd>
7034
+
7035
+ **credit_bundle_id:** `String` — credit_bundle_id
7036
+
7037
+ </dd>
7038
+ </dl>
7039
+
7040
+ <dl>
7041
+ <dd>
7042
+
7043
+ **request_options:** `Schematic::Catalogs::RequestOptions`
7044
+
7045
+ </dd>
7046
+ </dl>
7047
+ </dd>
7048
+ </dl>
7049
+
7050
+
7051
+ </dd>
7052
+ </dl>
7053
+ </details>
7054
+
7055
+ <details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_derived_features</a>(catalog_id) -> Schematic::Catalogs::Types::GetDerivedFeaturesResponse</code></summary>
7056
+ <dl>
7057
+ <dd>
7058
+
7059
+ #### 🔌 Usage
7060
+
7061
+ <dl>
7062
+ <dd>
7063
+
7064
+ <dl>
7065
+ <dd>
7066
+
7067
+ ```ruby
7068
+ client.catalogs.get_derived_features(catalog_id: "catalog_id")
7069
+ ```
7070
+ </dd>
7071
+ </dl>
7072
+ </dd>
7073
+ </dl>
7074
+
7075
+ #### ⚙️ Parameters
7076
+
7077
+ <dl>
7078
+ <dd>
7079
+
7080
+ <dl>
7081
+ <dd>
7082
+
7083
+ **catalog_id:** `String` — catalog_id
7084
+
7085
+ </dd>
7086
+ </dl>
7087
+
7088
+ <dl>
7089
+ <dd>
7090
+
7091
+ **request_options:** `Schematic::Catalogs::RequestOptions`
7092
+
7093
+ </dd>
7094
+ </dl>
7095
+ </dd>
7096
+ </dl>
7097
+
7098
+
7099
+ </dd>
7100
+ </dl>
7101
+ </details>
7102
+
7103
+ <details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_plans_in_catalog</a>(catalog_id) -> Schematic::Catalogs::Types::GetPlansInCatalogResponse</code></summary>
7104
+ <dl>
7105
+ <dd>
7106
+
7107
+ #### 🔌 Usage
7108
+
7109
+ <dl>
7110
+ <dd>
7111
+
7112
+ <dl>
7113
+ <dd>
7114
+
7115
+ ```ruby
7116
+ client.catalogs.get_plans_in_catalog(catalog_id: "catalog_id")
7117
+ ```
7118
+ </dd>
7119
+ </dl>
7120
+ </dd>
7121
+ </dl>
7122
+
7123
+ #### ⚙️ Parameters
7124
+
7125
+ <dl>
7126
+ <dd>
7127
+
7128
+ <dl>
7129
+ <dd>
7130
+
7131
+ **catalog_id:** `String` — catalog_id
7132
+
7133
+ </dd>
7134
+ </dl>
7135
+
7136
+ <dl>
7137
+ <dd>
7138
+
7139
+ **request_options:** `Schematic::Catalogs::RequestOptions`
7140
+
7141
+ </dd>
7142
+ </dl>
7143
+ </dd>
7144
+ </dl>
7145
+
7146
+
7147
+ </dd>
7148
+ </dl>
7149
+ </details>
7150
+
7151
+ <details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">add_plan</a>(catalog_id, plan_id) -> </code></summary>
7152
+ <dl>
7153
+ <dd>
7154
+
7155
+ #### 🔌 Usage
7156
+
7157
+ <dl>
7158
+ <dd>
7159
+
7160
+ <dl>
7161
+ <dd>
7162
+
7163
+ ```ruby
7164
+ client.catalogs.add_plan(
7165
+ catalog_id: "catalog_id",
7166
+ plan_id: "plan_id"
7167
+ )
7168
+ ```
7169
+ </dd>
7170
+ </dl>
7171
+ </dd>
7172
+ </dl>
7173
+
7174
+ #### ⚙️ Parameters
7175
+
7176
+ <dl>
7177
+ <dd>
7178
+
7179
+ <dl>
7180
+ <dd>
7181
+
7182
+ **catalog_id:** `String` — catalog_id
7183
+
7184
+ </dd>
7185
+ </dl>
7186
+
7187
+ <dl>
7188
+ <dd>
7189
+
7190
+ **plan_id:** `String` — plan_id
7191
+
7192
+ </dd>
7193
+ </dl>
7194
+
7195
+ <dl>
7196
+ <dd>
7197
+
7198
+ **request_options:** `Schematic::Catalogs::RequestOptions`
7199
+
7200
+ </dd>
7201
+ </dl>
7202
+ </dd>
7203
+ </dl>
7204
+
7205
+
7206
+ </dd>
7207
+ </dl>
7208
+ </details>
7209
+
7210
+ <details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">remove_plan</a>(catalog_id, plan_id) -> </code></summary>
7211
+ <dl>
7212
+ <dd>
7213
+
7214
+ #### 🔌 Usage
7215
+
7216
+ <dl>
7217
+ <dd>
7218
+
7219
+ <dl>
7220
+ <dd>
7221
+
7222
+ ```ruby
7223
+ client.catalogs.remove_plan(
7224
+ catalog_id: "catalog_id",
7225
+ plan_id: "plan_id"
7226
+ )
7227
+ ```
7228
+ </dd>
7229
+ </dl>
7230
+ </dd>
7231
+ </dl>
7232
+
7233
+ #### ⚙️ Parameters
7234
+
7235
+ <dl>
7236
+ <dd>
7237
+
7238
+ <dl>
7239
+ <dd>
7240
+
7241
+ **catalog_id:** `String` — catalog_id
7242
+
7243
+ </dd>
7244
+ </dl>
7245
+
7246
+ <dl>
7247
+ <dd>
7248
+
7249
+ **plan_id:** `String` — plan_id
7250
+
7251
+ </dd>
7252
+ </dl>
7253
+
7254
+ <dl>
7255
+ <dd>
7256
+
7257
+ **request_options:** `Schematic::Catalogs::RequestOptions`
7258
+
7259
+ </dd>
7260
+ </dl>
7261
+ </dd>
7262
+ </dl>
7263
+
7264
+
7265
+ </dd>
7266
+ </dl>
7267
+ </details>
7268
+
7269
+ ## checkout
7270
+ <details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">internal</a>(request) -> Schematic::Checkout::Types::CheckoutInternalResponse</code></summary>
7271
+ <dl>
7272
+ <dd>
7273
+
7274
+ #### 🔌 Usage
7275
+
7276
+ <dl>
7277
+ <dd>
7278
+
7279
+ <dl>
7280
+ <dd>
7281
+
7282
+ ```ruby
7283
+ client.checkout.internal(
7284
+ add_on_ids: [{
7285
+ add_on_id: "add_on_id",
7286
+ price_id: "price_id"
7287
+ }],
7288
+ auto_topup_overrides: [{
7289
+ plan_credit_grant_id: "plan_credit_grant_id"
7290
+ }],
7291
+ company_id: "company_id",
7292
+ credit_bundles: [{
7293
+ bundle_id: "bundle_id",
7294
+ quantity: 1000000
7295
+ }],
7296
+ custom_field_values: [{
7297
+ id: "id",
7298
+ value: "value"
7299
+ }],
7300
+ new_plan_id: "new_plan_id",
7301
+ new_price_id: "new_price_id",
7302
+ pay_in_advance: [{
7303
+ price_id: "price_id",
7304
+ quantity: 1000000
7305
+ }],
7306
+ skip_trial: true
7307
+ )
7308
+ ```
7309
+ </dd>
7310
+ </dl>
7311
+ </dd>
7312
+ </dl>
7313
+
7314
+ #### ⚙️ Parameters
7315
+
7316
+ <dl>
7317
+ <dd>
7318
+
7319
+ <dl>
7320
+ <dd>
7321
+
7322
+ **request:** `Schematic::Types::ChangeSubscriptionInternalRequestBody`
7323
+
7324
+ </dd>
7325
+ </dl>
7326
+
7327
+ <dl>
7328
+ <dd>
7329
+
7330
+ **request_options:** `Schematic::Checkout::RequestOptions`
7331
+
7332
+ </dd>
7333
+ </dl>
7334
+ </dd>
7335
+ </dl>
7336
+
7337
+
7338
+ </dd>
7339
+ </dl>
7340
+ </details>
7341
+
7342
+ <details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">get_checkout_data</a>(request) -> Schematic::Checkout::Types::GetCheckoutDataResponse</code></summary>
7343
+ <dl>
7344
+ <dd>
7345
+
7346
+ #### 🔌 Usage
7347
+
7348
+ <dl>
7349
+ <dd>
7350
+
7351
+ <dl>
7352
+ <dd>
7353
+
7354
+ ```ruby
7355
+ client.checkout.get_checkout_data(company_id: "company_id")
7356
+ ```
7357
+ </dd>
7358
+ </dl>
7359
+ </dd>
7360
+ </dl>
7361
+
7362
+ #### ⚙️ Parameters
7363
+
7364
+ <dl>
7365
+ <dd>
7366
+
7367
+ <dl>
7368
+ <dd>
7369
+
7370
+ **company_id:** `String`
7371
+
7372
+ </dd>
7373
+ </dl>
7374
+
7375
+ <dl>
7376
+ <dd>
7377
+
7378
+ **currency:** `String`
7379
+
7380
+ </dd>
7381
+ </dl>
7382
+
7383
+ <dl>
7384
+ <dd>
7385
+
7386
+ **selected_plan_id:** `String`
7387
+
7388
+ </dd>
7389
+ </dl>
7390
+
7391
+ <dl>
7392
+ <dd>
7393
+
7394
+ **request_options:** `Schematic::Checkout::RequestOptions`
7395
+
7396
+ </dd>
7397
+ </dl>
7398
+ </dd>
7399
+ </dl>
7400
+
7401
+
7402
+ </dd>
7403
+ </dl>
7404
+ </details>
7405
+
7406
+ <details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">preview_checkout_internal</a>(request) -> Schematic::Checkout::Types::PreviewCheckoutInternalResponse</code></summary>
7407
+ <dl>
7408
+ <dd>
7409
+
7410
+ #### 🔌 Usage
7411
+
7412
+ <dl>
7413
+ <dd>
7414
+
7415
+ <dl>
7416
+ <dd>
7417
+
7418
+ ```ruby
7419
+ client.checkout.preview_checkout_internal(
7420
+ add_on_ids: [{
7421
+ add_on_id: "add_on_id",
7422
+ price_id: "price_id"
7423
+ }],
7424
+ auto_topup_overrides: [{
7425
+ plan_credit_grant_id: "plan_credit_grant_id"
7426
+ }],
7427
+ company_id: "company_id",
7428
+ credit_bundles: [{
7429
+ bundle_id: "bundle_id",
7430
+ quantity: 1000000
7431
+ }],
7432
+ custom_field_values: [{
7433
+ id: "id",
7434
+ value: "value"
7435
+ }],
7436
+ new_plan_id: "new_plan_id",
7437
+ new_price_id: "new_price_id",
7438
+ pay_in_advance: [{
7439
+ price_id: "price_id",
7440
+ quantity: 1000000
7441
+ }],
7442
+ skip_trial: true
7443
+ )
7444
+ ```
7445
+ </dd>
7446
+ </dl>
7447
+ </dd>
7448
+ </dl>
7449
+
7450
+ #### ⚙️ Parameters
7451
+
7452
+ <dl>
7453
+ <dd>
7454
+
7455
+ <dl>
7456
+ <dd>
7457
+
7458
+ **request:** `Schematic::Types::ChangeSubscriptionInternalRequestBody`
7459
+
7460
+ </dd>
7461
+ </dl>
7462
+
7463
+ <dl>
7464
+ <dd>
7465
+
7466
+ **request_options:** `Schematic::Checkout::RequestOptions`
7467
+
7468
+ </dd>
7469
+ </dl>
7470
+ </dd>
7471
+ </dl>
7472
+
7473
+
7474
+ </dd>
7475
+ </dl>
7476
+ </details>
7477
+
7478
+ <details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">get_company_billing_details</a>(company_id) -> Schematic::Checkout::Types::GetCompanyBillingDetailsResponse</code></summary>
7479
+ <dl>
7480
+ <dd>
7481
+
7482
+ #### 🔌 Usage
7483
+
7484
+ <dl>
7485
+ <dd>
7486
+
7487
+ <dl>
7488
+ <dd>
7489
+
7490
+ ```ruby
7491
+ client.checkout.get_company_billing_details(company_id: "company_id")
7492
+ ```
7493
+ </dd>
7494
+ </dl>
7495
+ </dd>
7496
+ </dl>
7497
+
7498
+ #### ⚙️ Parameters
7499
+
7500
+ <dl>
7501
+ <dd>
7502
+
7503
+ <dl>
7504
+ <dd>
7505
+
7506
+ **company_id:** `String` — company_id
7507
+
7508
+ </dd>
7509
+ </dl>
7510
+
7511
+ <dl>
7512
+ <dd>
7513
+
7514
+ **request_options:** `Schematic::Checkout::RequestOptions`
7515
+
7516
+ </dd>
7517
+ </dl>
7518
+ </dd>
7519
+ </dl>
7520
+
7521
+
7522
+ </dd>
7523
+ </dl>
7524
+ </details>
7525
+
7526
+ <details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">update_company_billing_details</a>(company_id, request) -> Schematic::Checkout::Types::UpdateCompanyBillingDetailsResponse</code></summary>
7527
+ <dl>
7528
+ <dd>
7529
+
7530
+ #### 🔌 Usage
7531
+
7532
+ <dl>
7533
+ <dd>
7534
+
7535
+ <dl>
7536
+ <dd>
7537
+
7538
+ ```ruby
7539
+ client.checkout.update_company_billing_details(
7540
+ company_id: "company_id",
7541
+ values: [{
7542
+ id: "id",
7543
+ value: "value"
7544
+ }]
7545
+ )
7546
+ ```
7547
+ </dd>
7548
+ </dl>
7549
+ </dd>
7550
+ </dl>
7551
+
7552
+ #### ⚙️ Parameters
7553
+
6530
7554
  <dl>
6531
7555
  <dd>
6532
7556
 
6533
- #### 🔌 Usage
6534
-
6535
7557
  <dl>
6536
7558
  <dd>
6537
7559
 
7560
+ **company_id:** `String` — company_id
7561
+
7562
+ </dd>
7563
+ </dl>
7564
+
6538
7565
  <dl>
6539
7566
  <dd>
6540
7567
 
6541
- ```ruby
6542
- client.checkout.preview_checkout_internal(
6543
- add_on_ids: [{
6544
- add_on_id: "add_on_id",
6545
- price_id: "price_id"
6546
- }],
6547
- auto_topup_overrides: [{
6548
- plan_credit_grant_id: "plan_credit_grant_id"
6549
- }],
6550
- company_id: "company_id",
6551
- credit_bundles: [{
6552
- bundle_id: "bundle_id",
6553
- quantity: 1000000
6554
- }],
6555
- custom_field_values: [{
6556
- id: "id",
6557
- value: "value"
6558
- }],
6559
- new_plan_id: "new_plan_id",
6560
- new_price_id: "new_price_id",
6561
- pay_in_advance: [{
6562
- price_id: "price_id",
6563
- quantity: 1000000
6564
- }],
6565
- skip_trial: true
6566
- )
6567
- ```
7568
+ **address:** `Schematic::Types::CustomerBillingAddress`
7569
+
6568
7570
  </dd>
6569
7571
  </dl>
7572
+
7573
+ <dl>
7574
+ <dd>
7575
+
7576
+ **email:** `String`
7577
+
6570
7578
  </dd>
6571
7579
  </dl>
6572
7580
 
6573
- #### ⚙️ Parameters
6574
-
6575
7581
  <dl>
6576
7582
  <dd>
6577
7583
 
7584
+ **phone:** `String`
7585
+
7586
+ </dd>
7587
+ </dl>
7588
+
6578
7589
  <dl>
6579
7590
  <dd>
6580
7591
 
6581
- **request:** `Schematic::Types::ChangeSubscriptionInternalRequestBody`
7592
+ **values:** `Internal::Types::Array[Schematic::Types::CheckoutFieldValue]`
6582
7593
 
6583
7594
  </dd>
6584
7595
  </dl>
@@ -11335,6 +12346,14 @@ client.entitlements.create_plan_entitlement(
11335
12346
  <dl>
11336
12347
  <dd>
11337
12348
 
12349
+ **warning_tiers:** `Internal::Types::Array[Schematic::Types::WarningTierRequestBody]`
12350
+
12351
+ </dd>
12352
+ </dl>
12353
+
12354
+ <dl>
12355
+ <dd>
12356
+
11338
12357
  **yearly_metered_price_id:** `String`
11339
12358
 
11340
12359
  </dd>
@@ -11674,6 +12693,14 @@ client.entitlements.update_plan_entitlement(
11674
12693
  <dl>
11675
12694
  <dd>
11676
12695
 
12696
+ **warning_tiers:** `Internal::Types::Array[Schematic::Types::WarningTierRequestBody]`
12697
+
12698
+ </dd>
12699
+ </dl>
12700
+
12701
+ <dl>
12702
+ <dd>
12703
+
11677
12704
  **yearly_metered_price_id:** `String`
11678
12705
 
11679
12706
  </dd>
@@ -12048,6 +13075,14 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
12048
13075
  <dl>
12049
13076
  <dd>
12050
13077
 
13078
+ **warning_tiers:** `Internal::Types::Array[Schematic::Types::WarningTierRequestBody]`
13079
+
13080
+ </dd>
13081
+ </dl>
13082
+
13083
+ <dl>
13084
+ <dd>
13085
+
12051
13086
  **yearly_metered_price_id:** `String`
12052
13087
 
12053
13088
  </dd>
@@ -14170,6 +15205,62 @@ client.components.delete_component(component_id: "component_id")
14170
15205
  </dl>
14171
15206
 
14172
15207
 
15208
+ </dd>
15209
+ </dl>
15210
+ </details>
15211
+
15212
+ <details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">bind_catalog</a>(component_id, request) -> Schematic::Components::Types::BindCatalogResponse</code></summary>
15213
+ <dl>
15214
+ <dd>
15215
+
15216
+ #### 🔌 Usage
15217
+
15218
+ <dl>
15219
+ <dd>
15220
+
15221
+ <dl>
15222
+ <dd>
15223
+
15224
+ ```ruby
15225
+ client.components.bind_catalog(component_id: "component_id")
15226
+ ```
15227
+ </dd>
15228
+ </dl>
15229
+ </dd>
15230
+ </dl>
15231
+
15232
+ #### ⚙️ Parameters
15233
+
15234
+ <dl>
15235
+ <dd>
15236
+
15237
+ <dl>
15238
+ <dd>
15239
+
15240
+ **component_id:** `String` — component_id
15241
+
15242
+ </dd>
15243
+ </dl>
15244
+
15245
+ <dl>
15246
+ <dd>
15247
+
15248
+ **catalog_id:** `String`
15249
+
15250
+ </dd>
15251
+ </dl>
15252
+
15253
+ <dl>
15254
+ <dd>
15255
+
15256
+ **request_options:** `Schematic::Components::RequestOptions`
15257
+
15258
+ </dd>
15259
+ </dl>
15260
+ </dd>
15261
+ </dl>
15262
+
15263
+
14173
15264
  </dd>
14174
15265
  </dl>
14175
15266
  </details>
@@ -14340,6 +15431,14 @@ client.planbundle.create_custom_plan_bundle(entitlements: [{
14340
15431
  <dl>
14341
15432
  <dd>
14342
15433
 
15434
+ **credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
15435
+
15436
+ </dd>
15437
+ </dl>
15438
+
15439
+ <dl>
15440
+ <dd>
15441
+
14343
15442
  **entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
14344
15443
 
14345
15444
  </dd>
@@ -14430,14 +15529,6 @@ client.planbundle.create_plan_bundle(entitlements: [{
14430
15529
  <dl>
14431
15530
  <dd>
14432
15531
 
14433
- **traits:** `Internal::Types::Array[Schematic::Types::UpdatePlanTraitTraitRequestBody]`
14434
-
14435
- </dd>
14436
- </dl>
14437
-
14438
- <dl>
14439
- <dd>
14440
-
14441
15532
  **request_options:** `Schematic::Planbundle::RequestOptions`
14442
15533
 
14443
15534
  </dd>
@@ -14531,15 +15622,85 @@ client.planbundle.update_plan_bundle(
14531
15622
  <dl>
14532
15623
  <dd>
14533
15624
 
14534
- **traits:** `Internal::Types::Array[Schematic::Types::UpdatePlanTraitTraitRequestBody]`
15625
+ **request_options:** `Schematic::Planbundle::RequestOptions`
14535
15626
 
14536
15627
  </dd>
14537
15628
  </dl>
15629
+ </dd>
15630
+ </dl>
15631
+
15632
+
15633
+ </dd>
15634
+ </dl>
15635
+ </details>
14538
15636
 
15637
+ ## dataexports
15638
+ <details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">list_data_exports</a>() -> Schematic::Dataexports::Types::ListDataExportsResponse</code></summary>
14539
15639
  <dl>
14540
15640
  <dd>
14541
15641
 
14542
- **request_options:** `Schematic::Planbundle::RequestOptions`
15642
+ #### 🔌 Usage
15643
+
15644
+ <dl>
15645
+ <dd>
15646
+
15647
+ <dl>
15648
+ <dd>
15649
+
15650
+ ```ruby
15651
+ client.dataexports.list_data_exports(
15652
+ export_type: "audit-log",
15653
+ status: "failure",
15654
+ limit: 1000000,
15655
+ offset: 1000000
15656
+ )
15657
+ ```
15658
+ </dd>
15659
+ </dl>
15660
+ </dd>
15661
+ </dl>
15662
+
15663
+ #### ⚙️ Parameters
15664
+
15665
+ <dl>
15666
+ <dd>
15667
+
15668
+ <dl>
15669
+ <dd>
15670
+
15671
+ **export_type:** `Schematic::Types::DataExportType`
15672
+
15673
+ </dd>
15674
+ </dl>
15675
+
15676
+ <dl>
15677
+ <dd>
15678
+
15679
+ **status:** `Schematic::Types::DataExportStatus`
15680
+
15681
+ </dd>
15682
+ </dl>
15683
+
15684
+ <dl>
15685
+ <dd>
15686
+
15687
+ **limit:** `Integer` — Page limit (default 100)
15688
+
15689
+ </dd>
15690
+ </dl>
15691
+
15692
+ <dl>
15693
+ <dd>
15694
+
15695
+ **offset:** `Integer` — Page offset (default 0)
15696
+
15697
+ </dd>
15698
+ </dl>
15699
+
15700
+ <dl>
15701
+ <dd>
15702
+
15703
+ **request_options:** `Schematic::Dataexports::RequestOptions`
14543
15704
 
14544
15705
  </dd>
14545
15706
  </dl>
@@ -14551,7 +15712,6 @@ client.planbundle.update_plan_bundle(
14551
15712
  </dl>
14552
15713
  </details>
14553
15714
 
14554
- ## dataexports
14555
15715
  <details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">create_data_export</a>(request) -> Schematic::Dataexports::Types::CreateDataExportResponse</code></summary>
14556
15716
  <dl>
14557
15717
  <dd>
@@ -14566,8 +15726,7 @@ client.planbundle.update_plan_bundle(
14566
15726
 
14567
15727
  ```ruby
14568
15728
  client.dataexports.create_data_export(
14569
- export_type: "company-feature-usage",
14570
- metadata: "metadata",
15729
+ export_type: "audit-log",
14571
15730
  output_file_type: "csv"
14572
15731
  )
14573
15732
  ```
@@ -14584,7 +15743,23 @@ client.dataexports.create_data_export(
14584
15743
  <dl>
14585
15744
  <dd>
14586
15745
 
14587
- **export_type:** `String`
15746
+ **export_type:** `Schematic::Types::DataExportType`
15747
+
15748
+ </dd>
15749
+ </dl>
15750
+
15751
+ <dl>
15752
+ <dd>
15753
+
15754
+ **metadata:** `Schematic::Types::DataExportMetadata`
15755
+
15756
+ </dd>
15757
+ </dl>
15758
+
15759
+ <dl>
15760
+ <dd>
15761
+
15762
+ **output_file_type:** `Schematic::Types::DataExportOutputFileType`
14588
15763
 
14589
15764
  </dd>
14590
15765
  </dl>
@@ -14592,15 +15767,47 @@ client.dataexports.create_data_export(
14592
15767
  <dl>
14593
15768
  <dd>
14594
15769
 
14595
- **metadata:** `String`
15770
+ **request_options:** `Schematic::Dataexports::RequestOptions`
14596
15771
 
14597
15772
  </dd>
14598
15773
  </dl>
15774
+ </dd>
15775
+ </dl>
15776
+
15777
+
15778
+ </dd>
15779
+ </dl>
15780
+ </details>
15781
+
15782
+ <details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">get_data_export</a>(data_export_id) -> Schematic::Dataexports::Types::GetDataExportResponse</code></summary>
15783
+ <dl>
15784
+ <dd>
15785
+
15786
+ #### 🔌 Usage
15787
+
15788
+ <dl>
15789
+ <dd>
15790
+
15791
+ <dl>
15792
+ <dd>
15793
+
15794
+ ```ruby
15795
+ client.dataexports.get_data_export(data_export_id: "data_export_id")
15796
+ ```
15797
+ </dd>
15798
+ </dl>
15799
+ </dd>
15800
+ </dl>
15801
+
15802
+ #### ⚙️ Parameters
14599
15803
 
14600
15804
  <dl>
14601
15805
  <dd>
14602
15806
 
14603
- **output_file_type:** `String`
15807
+ <dl>
15808
+ <dd>
15809
+
15810
+ **data_export_id:** `String` — data_export_id
14604
15811
 
14605
15812
  </dd>
14606
15813
  </dl>