schematichq 1.4.3 → 1.4.5

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 (73) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +2 -2
  3. data/.fern/replay.lock +501 -2
  4. data/WASM_VERSION +1 -1
  5. data/lib/schematic/accounts/client.rb +44 -0
  6. data/lib/schematic/accounts/types/count_account_members_params.rb +15 -0
  7. data/lib/schematic/accounts/types/count_account_members_request.rb +14 -0
  8. data/lib/schematic/accounts/types/count_account_members_response.rb +12 -0
  9. data/lib/schematic/client.rb +1 -1
  10. data/lib/schematic/credits/client.rb +0 -104
  11. data/lib/schematic/integrationsapi/client.rb +99 -3
  12. data/lib/schematic/integrationsapi/types/assume_stripe_installed_response.rb +12 -0
  13. data/lib/schematic/integrationsapi/types/install_integration_response.rb +12 -0
  14. data/lib/schematic/integrationsapi/types/install_stripe_response.rb +12 -0
  15. data/lib/schematic/integrationsapi/types/{load_sample_data_set_v_2_response.rb → load_sample_data_set_response.rb} +1 -1
  16. data/lib/schematic/plangroups/types/create_plan_group_request_body.rb +4 -0
  17. data/lib/schematic/plangroups/types/update_plan_group_request_body.rb +4 -0
  18. data/lib/schematic/plans/types/publish_plan_version_request_body.rb +0 -1
  19. data/lib/schematic/plans/types/retry_custom_plan_billing_request_body.rb +0 -1
  20. data/lib/schematic/types/account_member_response_data.rb +2 -0
  21. data/lib/schematic/types/billing_credit_grant_reason.rb +1 -0
  22. data/lib/schematic/types/billing_credit_grant_response_data.rb +3 -0
  23. data/lib/schematic/types/billing_credit_grant_zeroed_out_reason.rb +1 -0
  24. data/lib/schematic/types/billing_credit_ledger_authority.rb +13 -0
  25. data/lib/schematic/types/billing_credit_view.rb +1 -0
  26. data/lib/schematic/types/billing_plan_credit_grant_response_data.rb +1 -0
  27. data/lib/schematic/types/billing_provider_type.rb +1 -0
  28. data/lib/schematic/types/change_subscription_internal_request_body.rb +2 -0
  29. data/lib/schematic/types/change_subscription_request_body.rb +2 -0
  30. data/lib/schematic/types/checkout_data_response_data.rb +1 -0
  31. data/lib/schematic/types/checkout_field_input.rb +14 -0
  32. data/lib/schematic/types/checkout_field_response_data.rb +18 -0
  33. data/lib/schematic/types/checkout_field_value.rb +10 -0
  34. data/lib/schematic/types/checkout_field_with_value.rb +15 -0
  35. data/lib/schematic/types/checkout_settings_response_data.rb +3 -0
  36. data/lib/schematic/types/company_credit_balance_response_data.rb +2 -0
  37. data/lib/schematic/types/company_plan_credit_grant_view.rb +1 -0
  38. data/lib/schematic/types/component_hydrate_response_data.rb +1 -0
  39. data/lib/schematic/types/component_preview_response_data.rb +1 -0
  40. data/lib/schematic/types/create_billing_plan_credit_grant_request_body.rb +1 -0
  41. data/lib/schematic/types/credit_company_grant_view.rb +3 -0
  42. data/lib/schematic/types/credit_event_ledger_response_data.rb +1 -0
  43. data/lib/schematic/types/credit_usage_reason.rb +15 -0
  44. data/lib/schematic/types/event_detail_response_data.rb +1 -0
  45. data/lib/schematic/types/event_response_data.rb +1 -0
  46. data/lib/schematic/types/feature_entitlement.rb +2 -0
  47. data/lib/schematic/types/install_integration_request_body.rb +14 -0
  48. data/lib/schematic/types/integration_config.rb +1 -0
  49. data/lib/schematic/types/integration_install_config.rb +18 -0
  50. data/lib/schematic/types/integration_install_response_data.rb +11 -0
  51. data/lib/schematic/types/integration_type.rb +1 -0
  52. data/lib/schematic/types/manage_plan_request.rb +1 -0
  53. data/lib/schematic/types/metronome_integration_config.rb +7 -0
  54. data/lib/schematic/types/migration_error_code.rb +1 -0
  55. data/lib/schematic/types/plan_change_response_data.rb +1 -0
  56. data/lib/schematic/types/plan_credit_grant_view.rb +1 -0
  57. data/lib/schematic/types/plan_group_detail_response_data.rb +1 -0
  58. data/lib/schematic/types/preview_subscription_change_response_data.rb +3 -0
  59. data/lib/schematic/types/rulesengine_feature_entitlement.rb +2 -0
  60. data/lib/schematic/types/update_billing_plan_credit_grant_request_body.rb +1 -0
  61. data/lib/schematic/version.rb +1 -1
  62. data/lib/schematic/wasm/rulesengine.wasm +0 -0
  63. data/lib/schematic.rb +23 -15
  64. data/reference.md +386 -293
  65. metadata +19 -11
  66. data/lib/schematic/credits/types/count_credit_ledger_params.rb +0 -19
  67. data/lib/schematic/credits/types/count_credit_ledger_request.rb +0 -18
  68. data/lib/schematic/credits/types/count_credit_ledger_response.rb +0 -12
  69. data/lib/schematic/credits/types/get_enriched_credit_ledger_params.rb +0 -19
  70. data/lib/schematic/credits/types/get_enriched_credit_ledger_request.rb +0 -18
  71. data/lib/schematic/credits/types/get_enriched_credit_ledger_response.rb +0 -12
  72. data/lib/schematic/types/credit_ledger_enriched_entry_response_data.rb +0 -30
  73. data/lib/schematic/types/credit_ledger_period.rb +0 -14
data/reference.md CHANGED
@@ -1,4 +1,44 @@
1
1
  # Reference
2
+ <details><summary><code>client.<a href="/lib/schematic/client.rb">get_credit_ledger</a>() -> </code></summary>
3
+ <dl>
4
+ <dd>
5
+
6
+ #### 🔌 Usage
7
+
8
+ <dl>
9
+ <dd>
10
+
11
+ <dl>
12
+ <dd>
13
+
14
+ ```ruby
15
+ client.get_credit_ledger
16
+ ```
17
+ </dd>
18
+ </dl>
19
+ </dd>
20
+ </dl>
21
+
22
+ #### ⚙️ Parameters
23
+
24
+ <dl>
25
+ <dd>
26
+
27
+ <dl>
28
+ <dd>
29
+
30
+ **request_options:** `Schematic::RequestOptions`
31
+
32
+ </dd>
33
+ </dl>
34
+ </dd>
35
+ </dl>
36
+
37
+
38
+ </dd>
39
+ </dl>
40
+ </details>
41
+
2
42
  ## accounts
3
43
  <details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">list_account_members</a>() -> Schematic::Accounts::Types::ListAccountMembersResponse</code></summary>
4
44
  <dl>
@@ -121,6 +161,83 @@ client.accounts.get_account_member(account_member_id: "account_member_id")
121
161
  </dl>
122
162
 
123
163
 
164
+ </dd>
165
+ </dl>
166
+ </details>
167
+
168
+ <details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">count_account_members</a>() -> Schematic::Accounts::Types::CountAccountMembersResponse</code></summary>
169
+ <dl>
170
+ <dd>
171
+
172
+ #### 🔌 Usage
173
+
174
+ <dl>
175
+ <dd>
176
+
177
+ <dl>
178
+ <dd>
179
+
180
+ ```ruby
181
+ client.accounts.count_account_members(
182
+ ids: ["ids"],
183
+ q: "q",
184
+ limit: 1000000,
185
+ offset: 1000000
186
+ )
187
+ ```
188
+ </dd>
189
+ </dl>
190
+ </dd>
191
+ </dl>
192
+
193
+ #### ⚙️ Parameters
194
+
195
+ <dl>
196
+ <dd>
197
+
198
+ <dl>
199
+ <dd>
200
+
201
+ **ids:** `String`
202
+
203
+ </dd>
204
+ </dl>
205
+
206
+ <dl>
207
+ <dd>
208
+
209
+ **q:** `String` — Search filter
210
+
211
+ </dd>
212
+ </dl>
213
+
214
+ <dl>
215
+ <dd>
216
+
217
+ **limit:** `Integer` — Page limit (default 100)
218
+
219
+ </dd>
220
+ </dl>
221
+
222
+ <dl>
223
+ <dd>
224
+
225
+ **offset:** `Integer` — Page offset (default 0)
226
+
227
+ </dd>
228
+ </dl>
229
+
230
+ <dl>
231
+ <dd>
232
+
233
+ **request_options:** `Schematic::Accounts::RequestOptions`
234
+
235
+ </dd>
236
+ </dl>
237
+ </dd>
238
+ </dl>
239
+
240
+
124
241
  </dd>
125
242
  </dl>
126
243
  </details>
@@ -1452,7 +1569,7 @@ client.billing.upsert_billing_customer(
1452
1569
  client.billing.list_customers_with_subscriptions(
1453
1570
  company_ids: ["company_ids"],
1454
1571
  name: "name",
1455
- provider_type: "orb",
1572
+ provider_type: "metronome",
1456
1573
  q: "q",
1457
1574
  limit: 1000000,
1458
1575
  offset: 1000000
@@ -1547,7 +1664,7 @@ client.billing.list_customers_with_subscriptions(
1547
1664
  client.billing.count_customers(
1548
1665
  company_ids: ["company_ids"],
1549
1666
  name: "name",
1550
- provider_type: "orb",
1667
+ provider_type: "metronome",
1551
1668
  q: "q",
1552
1669
  limit: 1000000,
1553
1670
  offset: 1000000
@@ -2305,7 +2422,7 @@ client.billing.list_billing_prices(
2305
2422
  price: 1000000,
2306
2423
  product_id: "product_id",
2307
2424
  product_ids: ["product_ids"],
2308
- provider_type: "orb",
2425
+ provider_type: "metronome",
2309
2426
  q: "q",
2310
2427
  tiers_mode: "graduated",
2311
2428
  usage_type: "licensed",
@@ -2727,7 +2844,7 @@ client.billing.list_billing_product_prices(
2727
2844
  price: 1000000,
2728
2845
  product_id: "product_id",
2729
2846
  product_ids: ["product_ids"],
2730
- provider_type: "orb",
2847
+ provider_type: "metronome",
2731
2848
  q: "q",
2732
2849
  tiers_mode: "graduated",
2733
2850
  usage_type: "licensed",
@@ -3038,7 +3155,7 @@ client.billing.list_billing_products(
3038
3155
  is_active: true,
3039
3156
  name: "name",
3040
3157
  price_usage_type: "licensed",
3041
- provider_type: "orb",
3158
+ provider_type: "metronome",
3042
3159
  q: "q",
3043
3160
  recurring_charges_only: true,
3044
3161
  with_one_time_charges: true,
@@ -3196,7 +3313,7 @@ client.billing.count_billing_products(
3196
3313
  is_active: true,
3197
3314
  name: "name",
3198
3315
  price_usage_type: "licensed",
3199
- provider_type: "orb",
3316
+ provider_type: "metronome",
3200
3317
  q: "q",
3201
3318
  recurring_charges_only: true,
3202
3319
  with_one_time_charges: true,
@@ -5342,244 +5459,7 @@ client.credits.extend_credit_lease(
5342
5459
  <dl>
5343
5460
  <dd>
5344
5461
 
5345
- **additional_amount:** `Integer`
5346
-
5347
- </dd>
5348
- </dl>
5349
-
5350
- <dl>
5351
- <dd>
5352
-
5353
- **expires_at:** `String`
5354
-
5355
- </dd>
5356
- </dl>
5357
-
5358
- <dl>
5359
- <dd>
5360
-
5361
- **request_options:** `Schematic::Credits::RequestOptions`
5362
-
5363
- </dd>
5364
- </dl>
5365
- </dd>
5366
- </dl>
5367
-
5368
-
5369
- </dd>
5370
- </dl>
5371
- </details>
5372
-
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>
5374
- <dl>
5375
- <dd>
5376
-
5377
- #### 🔌 Usage
5378
-
5379
- <dl>
5380
- <dd>
5381
-
5382
- <dl>
5383
- <dd>
5384
-
5385
- ```ruby
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(
5446
- company_id: "company_id",
5447
- billing_credit_id: "billing_credit_id",
5448
- feature_id: "feature_id",
5449
- period: "daily",
5450
- start_time: "start_time",
5451
- end_time: "end_time",
5452
- limit: 1000000,
5453
- offset: 1000000
5454
- )
5455
- ```
5456
- </dd>
5457
- </dl>
5458
- </dd>
5459
- </dl>
5460
-
5461
- #### ⚙️ Parameters
5462
-
5463
- <dl>
5464
- <dd>
5465
-
5466
- <dl>
5467
- <dd>
5468
-
5469
- **company_id:** `String`
5470
-
5471
- </dd>
5472
- </dl>
5473
-
5474
- <dl>
5475
- <dd>
5476
-
5477
- **billing_credit_id:** `String`
5478
-
5479
- </dd>
5480
- </dl>
5481
-
5482
- <dl>
5483
- <dd>
5484
-
5485
- **feature_id:** `String`
5486
-
5487
- </dd>
5488
- </dl>
5489
-
5490
- <dl>
5491
- <dd>
5492
-
5493
- **period:** `Schematic::Types::CreditLedgerPeriod`
5494
-
5495
- </dd>
5496
- </dl>
5497
-
5498
- <dl>
5499
- <dd>
5500
-
5501
- **start_time:** `String`
5502
-
5503
- </dd>
5504
- </dl>
5505
-
5506
- <dl>
5507
- <dd>
5508
-
5509
- **end_time:** `String`
5510
-
5511
- </dd>
5512
- </dl>
5513
-
5514
- <dl>
5515
- <dd>
5516
-
5517
- **limit:** `Integer` — Page limit (default 100)
5518
-
5519
- </dd>
5520
- </dl>
5521
-
5522
- <dl>
5523
- <dd>
5524
-
5525
- **offset:** `Integer` — Page offset (default 0)
5526
-
5527
- </dd>
5528
- </dl>
5529
-
5530
- <dl>
5531
- <dd>
5532
-
5533
- **request_options:** `Schematic::Credits::RequestOptions`
5534
-
5535
- </dd>
5536
- </dl>
5537
- </dd>
5538
- </dl>
5539
-
5540
-
5541
- </dd>
5542
- </dl>
5543
- </details>
5544
-
5545
- <details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">count_credit_ledger</a>() -> Schematic::Credits::Types::CountCreditLedgerResponse</code></summary>
5546
- <dl>
5547
- <dd>
5548
-
5549
- #### 🔌 Usage
5550
-
5551
- <dl>
5552
- <dd>
5553
-
5554
- <dl>
5555
- <dd>
5556
-
5557
- ```ruby
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",
5565
- limit: 1000000,
5566
- offset: 1000000
5567
- )
5568
- ```
5569
- </dd>
5570
- </dl>
5571
- </dd>
5572
- </dl>
5573
-
5574
- #### ⚙️ Parameters
5575
-
5576
- <dl>
5577
- <dd>
5578
-
5579
- <dl>
5580
- <dd>
5581
-
5582
- **company_id:** `String`
5462
+ **additional_amount:** `Integer`
5583
5463
 
5584
5464
  </dd>
5585
5465
  </dl>
@@ -5587,7 +5467,7 @@ client.credits.count_credit_ledger(
5587
5467
  <dl>
5588
5468
  <dd>
5589
5469
 
5590
- **billing_credit_id:** `String`
5470
+ **expires_at:** `String`
5591
5471
 
5592
5472
  </dd>
5593
5473
  </dl>
@@ -5595,39 +5475,50 @@ client.credits.count_credit_ledger(
5595
5475
  <dl>
5596
5476
  <dd>
5597
5477
 
5598
- **feature_id:** `String`
5478
+ **request_options:** `Schematic::Credits::RequestOptions`
5599
5479
 
5600
5480
  </dd>
5601
5481
  </dl>
5482
+ </dd>
5483
+ </dl>
5602
5484
 
5603
- <dl>
5604
- <dd>
5605
5485
 
5606
- **period:** `Schematic::Types::CreditLedgerPeriod`
5607
-
5608
5486
  </dd>
5609
5487
  </dl>
5488
+ </details>
5610
5489
 
5490
+ <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>
5611
5491
  <dl>
5612
5492
  <dd>
5613
5493
 
5614
- **start_time:** `String`
5615
-
5616
- </dd>
5617
- </dl>
5494
+ #### 🔌 Usage
5618
5495
 
5619
5496
  <dl>
5620
5497
  <dd>
5621
5498
 
5622
- **end_time:** `String`
5623
-
5499
+ <dl>
5500
+ <dd>
5501
+
5502
+ ```ruby
5503
+ client.credits.release_credit_lease(
5504
+ lease_id: "lease_id",
5505
+ request: {}
5506
+ )
5507
+ ```
5624
5508
  </dd>
5625
5509
  </dl>
5510
+ </dd>
5511
+ </dl>
5512
+
5513
+ #### ⚙️ Parameters
5626
5514
 
5627
5515
  <dl>
5628
5516
  <dd>
5629
5517
 
5630
- **limit:** `Integer` — Page limit (default 100)
5518
+ <dl>
5519
+ <dd>
5520
+
5521
+ **lease_id:** `String` — lease_id
5631
5522
 
5632
5523
  </dd>
5633
5524
  </dl>
@@ -5635,7 +5526,7 @@ client.credits.count_credit_ledger(
5635
5526
  <dl>
5636
5527
  <dd>
5637
5528
 
5638
- **offset:** `Integer` — Page offset (default 0)
5529
+ **request:** `Internal::Types::Hash[String, Object]`
5639
5530
 
5640
5531
  </dd>
5641
5532
  </dl>
@@ -6355,6 +6246,10 @@ client.checkout.internal(
6355
6246
  bundle_id: "bundle_id",
6356
6247
  quantity: 1000000
6357
6248
  }],
6249
+ custom_field_values: [{
6250
+ id: "id",
6251
+ value: "value"
6252
+ }],
6358
6253
  new_plan_id: "new_plan_id",
6359
6254
  new_price_id: "new_price_id",
6360
6255
  pay_in_advance: [{
@@ -6479,6 +6374,10 @@ client.checkout.preview_checkout_internal(
6479
6374
  bundle_id: "bundle_id",
6480
6375
  quantity: 1000000
6481
6376
  }],
6377
+ custom_field_values: [{
6378
+ id: "id",
6379
+ value: "value"
6380
+ }],
6482
6381
  new_plan_id: "new_plan_id",
6483
6382
  new_price_id: "new_price_id",
6484
6383
  pay_in_advance: [{
@@ -6543,6 +6442,10 @@ client.checkout.manage_plan(
6543
6442
  bundle_id: "bundle_id",
6544
6443
  quantity: 1000000
6545
6444
  }],
6445
+ custom_field_values: [{
6446
+ id: "id",
6447
+ value: "value"
6448
+ }],
6546
6449
  pay_in_advance_entitlements: [{
6547
6450
  price_id: "price_id",
6548
6451
  quantity: 1000000
@@ -6604,6 +6507,10 @@ client.checkout.preview_manage_plan(
6604
6507
  bundle_id: "bundle_id",
6605
6508
  quantity: 1000000
6606
6509
  }],
6510
+ custom_field_values: [{
6511
+ id: "id",
6512
+ value: "value"
6513
+ }],
6607
6514
  pay_in_advance_entitlements: [{
6608
6515
  price_id: "price_id",
6609
6516
  quantity: 1000000
@@ -10285,7 +10192,7 @@ client.entitlements.list_feature_usage(
10285
10192
  company_id: "company_id",
10286
10193
  feature_ids: ["feature_ids"],
10287
10194
  include_usage_aggregation: true,
10288
- managed_by: "orb",
10195
+ managed_by: "metronome",
10289
10196
  q: "q",
10290
10197
  without_negative_entitlements: true,
10291
10198
  limit: 1000000,
@@ -10492,7 +10399,7 @@ client.entitlements.count_feature_usage(
10492
10399
  company_id: "company_id",
10493
10400
  feature_ids: ["feature_ids"],
10494
10401
  include_usage_aggregation: true,
10495
- managed_by: "orb",
10402
+ managed_by: "metronome",
10496
10403
  q: "q",
10497
10404
  without_negative_entitlements: true,
10498
10405
  limit: 1000000,
@@ -11599,7 +11506,7 @@ client.entitlements.delete_plan_entitlement(plan_entitlement_id: "plan_entitleme
11599
11506
 
11600
11507
  ```ruby
11601
11508
  client.entitlements.upsert_plan_entitlement_for_billing_product(
11602
- billing_provider: "orb",
11509
+ billing_provider: "metronome",
11603
11510
  external_resource_id: "external_resource_id",
11604
11511
  feature_id: "feature_id",
11605
11512
  plan_id: "plan_id",
@@ -12397,11 +12304,7 @@ client.plans.mark_custom_plan_billing_paid(
12397
12304
  ```ruby
12398
12305
  client.plans.retry_custom_plan_billing(
12399
12306
  custom_plan_billing_id: "custom_plan_billing_id",
12400
- customer_email: "customer_email",
12401
- pay_in_advance: [{
12402
- price_id: "price_id",
12403
- quantity: 1000000
12404
- }]
12307
+ customer_email: "customer_email"
12405
12308
  )
12406
12309
  ```
12407
12310
  </dd>
@@ -12449,14 +12352,6 @@ client.plans.retry_custom_plan_billing(
12449
12352
  <dl>
12450
12353
  <dd>
12451
12354
 
12452
- **pay_in_advance:** `Internal::Types::Array[Schematic::Types::UpdatePayInAdvanceRequestBody]`
12453
-
12454
- </dd>
12455
- </dl>
12456
-
12457
- <dl>
12458
- <dd>
12459
-
12460
12355
  **request_options:** `Schematic::Plans::RequestOptions`
12461
12356
 
12462
12357
  </dd>
@@ -13039,7 +12934,7 @@ client.plans.upsert_billing_product_plan(
13039
12934
 
13040
12935
  ```ruby
13041
12936
  client.plans.upsert_plan_for_billing_product(
13042
- billing_provider: "orb",
12937
+ billing_provider: "metronome",
13043
12938
  description: "description",
13044
12939
  external_resource_id: "external_resource_id",
13045
12940
  name: "name",
@@ -13609,11 +13504,7 @@ client.plans.delete_plan_version(
13609
13504
  client.plans.publish_plan_version(
13610
13505
  plan_id: "plan_id",
13611
13506
  excluded_company_ids: ["excluded_company_ids"],
13612
- migration_strategy: "immediate",
13613
- pay_in_advance: [{
13614
- price_id: "price_id",
13615
- quantity: 1000000
13616
- }]
13507
+ migration_strategy: "immediate"
13617
13508
  )
13618
13509
  ```
13619
13510
  </dd>
@@ -13677,14 +13568,6 @@ client.plans.publish_plan_version(
13677
13568
  <dl>
13678
13569
  <dd>
13679
13570
 
13680
- **pay_in_advance:** `Internal::Types::Array[Schematic::Types::UpdatePayInAdvanceRequestBody]`
13681
-
13682
- </dd>
13683
- </dl>
13684
-
13685
- <dl>
13686
- <dd>
13687
-
13688
13571
  **request_options:** `Schematic::Plans::RequestOptions`
13689
13572
 
13690
13573
  </dd>
@@ -14898,7 +14781,7 @@ client.features.list_features(
14898
14781
  boolean_require_event: true,
14899
14782
  feature_type: ["boolean"],
14900
14783
  ids: ["ids"],
14901
- managed_by: "orb",
14784
+ managed_by: "metronome",
14902
14785
  plan_version_id: "plan_version_id",
14903
14786
  q: "q",
14904
14787
  without_company_override_for: "without_company_override_for",
@@ -15390,7 +15273,7 @@ client.features.delete_feature(feature_id: "feature_id")
15390
15273
 
15391
15274
  ```ruby
15392
15275
  client.features.upsert_feature_for_billing_product(
15393
- billing_provider: "orb",
15276
+ billing_provider: "metronome",
15394
15277
  description: "description",
15395
15278
  external_resource_id: "external_resource_id",
15396
15279
  feature_type: "boolean",
@@ -15543,7 +15426,7 @@ client.features.count_features(
15543
15426
  boolean_require_event: true,
15544
15427
  feature_type: ["boolean"],
15545
15428
  ids: ["ids"],
15546
- managed_by: "orb",
15429
+ managed_by: "metronome",
15547
15430
  plan_version_id: "plan_version_id",
15548
15431
  q: "q",
15549
15432
  without_company_override_for: "without_company_override_for",
@@ -16825,6 +16708,54 @@ client.integrationsapi.get_integration_webhook_url(type: "type")
16825
16708
  </dl>
16826
16709
 
16827
16710
 
16711
+ </dd>
16712
+ </dl>
16713
+ </details>
16714
+
16715
+ <details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">install_integration</a>(request) -> Schematic::Integrationsapi::Types::InstallIntegrationResponse</code></summary>
16716
+ <dl>
16717
+ <dd>
16718
+
16719
+ #### 🔌 Usage
16720
+
16721
+ <dl>
16722
+ <dd>
16723
+
16724
+ <dl>
16725
+ <dd>
16726
+
16727
+ ```ruby
16728
+ client.integrationsapi.install_integration(type: "clerk")
16729
+ ```
16730
+ </dd>
16731
+ </dl>
16732
+ </dd>
16733
+ </dl>
16734
+
16735
+ #### ⚙️ Parameters
16736
+
16737
+ <dl>
16738
+ <dd>
16739
+
16740
+ <dl>
16741
+ <dd>
16742
+
16743
+ **request:** `Schematic::Types::InstallIntegrationRequestBody`
16744
+
16745
+ </dd>
16746
+ </dl>
16747
+
16748
+ <dl>
16749
+ <dd>
16750
+
16751
+ **request_options:** `Schematic::Integrationsapi::RequestOptions`
16752
+
16753
+ </dd>
16754
+ </dl>
16755
+ </dd>
16756
+ </dl>
16757
+
16758
+
16828
16759
  </dd>
16829
16760
  </dl>
16830
16761
  </details>
@@ -16893,7 +16824,95 @@ client.integrationsapi.start_data_import(integration_id: "integration_id")
16893
16824
  </dl>
16894
16825
  </details>
16895
16826
 
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>
16827
+ <details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">load_sample_data_set</a>() -> Schematic::Integrationsapi::Types::LoadSampleDataSetResponse</code></summary>
16828
+ <dl>
16829
+ <dd>
16830
+
16831
+ #### 🔌 Usage
16832
+
16833
+ <dl>
16834
+ <dd>
16835
+
16836
+ <dl>
16837
+ <dd>
16838
+
16839
+ ```ruby
16840
+ client.integrationsapi.load_sample_data_set
16841
+ ```
16842
+ </dd>
16843
+ </dl>
16844
+ </dd>
16845
+ </dl>
16846
+
16847
+ #### ⚙️ Parameters
16848
+
16849
+ <dl>
16850
+ <dd>
16851
+
16852
+ <dl>
16853
+ <dd>
16854
+
16855
+ **request_options:** `Schematic::Integrationsapi::RequestOptions`
16856
+
16857
+ </dd>
16858
+ </dl>
16859
+ </dd>
16860
+ </dl>
16861
+
16862
+
16863
+ </dd>
16864
+ </dl>
16865
+ </details>
16866
+
16867
+ <details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">assume_stripe_installed</a>(request) -> Schematic::Integrationsapi::Types::AssumeStripeInstalledResponse</code></summary>
16868
+ <dl>
16869
+ <dd>
16870
+
16871
+ #### 🔌 Usage
16872
+
16873
+ <dl>
16874
+ <dd>
16875
+
16876
+ <dl>
16877
+ <dd>
16878
+
16879
+ ```ruby
16880
+ client.integrationsapi.assume_stripe_installed(type: "clerk")
16881
+ ```
16882
+ </dd>
16883
+ </dl>
16884
+ </dd>
16885
+ </dl>
16886
+
16887
+ #### ⚙️ Parameters
16888
+
16889
+ <dl>
16890
+ <dd>
16891
+
16892
+ <dl>
16893
+ <dd>
16894
+
16895
+ **request:** `Schematic::Types::InstallIntegrationRequestBody`
16896
+
16897
+ </dd>
16898
+ </dl>
16899
+
16900
+ <dl>
16901
+ <dd>
16902
+
16903
+ **request_options:** `Schematic::Integrationsapi::RequestOptions`
16904
+
16905
+ </dd>
16906
+ </dl>
16907
+ </dd>
16908
+ </dl>
16909
+
16910
+
16911
+ </dd>
16912
+ </dl>
16913
+ </details>
16914
+
16915
+ <details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">install_stripe</a>(request) -> Schematic::Integrationsapi::Types::InstallStripeResponse</code></summary>
16897
16916
  <dl>
16898
16917
  <dd>
16899
16918
 
@@ -16906,7 +16925,7 @@ client.integrationsapi.start_data_import(integration_id: "integration_id")
16906
16925
  <dd>
16907
16926
 
16908
16927
  ```ruby
16909
- client.integrationsapi.load_sample_data_set_v_2
16928
+ client.integrationsapi.install_stripe(type: "clerk")
16910
16929
  ```
16911
16930
  </dd>
16912
16931
  </dl>
@@ -16921,6 +16940,14 @@ client.integrationsapi.load_sample_data_set_v_2
16921
16940
  <dl>
16922
16941
  <dd>
16923
16942
 
16943
+ **request:** `Schematic::Types::InstallIntegrationRequestBody`
16944
+
16945
+ </dd>
16946
+ </dl>
16947
+
16948
+ <dl>
16949
+ <dd>
16950
+
16924
16951
  **request_options:** `Schematic::Integrationsapi::RequestOptions`
16925
16952
 
16926
16953
  </dd>
@@ -17049,6 +17076,7 @@ client.plangroups.create_plan_group(
17049
17076
  checkout_collect_email: true,
17050
17077
  checkout_collect_phone: true,
17051
17078
  enable_tax_collection: true,
17079
+ opt_in_enabled: true,
17052
17080
  ordered_add_ons: [{
17053
17081
  plan_id: "plan_id"
17054
17082
  }],
@@ -17123,6 +17151,14 @@ client.plangroups.create_plan_group(
17123
17151
  <dl>
17124
17152
  <dd>
17125
17153
 
17154
+ **custom_checkout_fields:** `Internal::Types::Array[Schematic::Types::CheckoutFieldInput]`
17155
+
17156
+ </dd>
17157
+ </dl>
17158
+
17159
+ <dl>
17160
+ <dd>
17161
+
17126
17162
  **custom_plan_config:** `Schematic::Types::CustomPlanConfig`
17127
17163
 
17128
17164
  </dd>
@@ -17171,6 +17207,30 @@ client.plangroups.create_plan_group(
17171
17207
  <dl>
17172
17208
  <dd>
17173
17209
 
17210
+ **opt_in_enabled:** `Internal::Types::Boolean`
17211
+
17212
+ </dd>
17213
+ </dl>
17214
+
17215
+ <dl>
17216
+ <dd>
17217
+
17218
+ **opt_in_text:** `String`
17219
+
17220
+ </dd>
17221
+ </dl>
17222
+
17223
+ <dl>
17224
+ <dd>
17225
+
17226
+ **opt_in_title:** `String`
17227
+
17228
+ </dd>
17229
+ </dl>
17230
+
17231
+ <dl>
17232
+ <dd>
17233
+
17174
17234
  **ordered_add_ons:** `Internal::Types::Array[Schematic::Types::OrderedPlansInGroup]`
17175
17235
 
17176
17236
  </dd>
@@ -17371,6 +17431,7 @@ client.plangroups.update_plan_group(
17371
17431
  checkout_collect_email: true,
17372
17432
  checkout_collect_phone: true,
17373
17433
  enable_tax_collection: true,
17434
+ opt_in_enabled: true,
17374
17435
  ordered_add_ons: [{
17375
17436
  plan_id: "plan_id"
17376
17437
  }],
@@ -17453,6 +17514,14 @@ client.plangroups.update_plan_group(
17453
17514
  <dl>
17454
17515
  <dd>
17455
17516
 
17517
+ **custom_checkout_fields:** `Internal::Types::Array[Schematic::Types::CheckoutFieldInput]`
17518
+
17519
+ </dd>
17520
+ </dl>
17521
+
17522
+ <dl>
17523
+ <dd>
17524
+
17456
17525
  **custom_plan_config:** `Schematic::Types::CustomPlanConfig`
17457
17526
 
17458
17527
  </dd>
@@ -17501,6 +17570,30 @@ client.plangroups.update_plan_group(
17501
17570
  <dl>
17502
17571
  <dd>
17503
17572
 
17573
+ **opt_in_enabled:** `Internal::Types::Boolean`
17574
+
17575
+ </dd>
17576
+ </dl>
17577
+
17578
+ <dl>
17579
+ <dd>
17580
+
17581
+ **opt_in_text:** `String`
17582
+
17583
+ </dd>
17584
+ </dl>
17585
+
17586
+ <dl>
17587
+ <dd>
17588
+
17589
+ **opt_in_title:** `String`
17590
+
17591
+ </dd>
17592
+ </dl>
17593
+
17594
+ <dl>
17595
+ <dd>
17596
+
17504
17597
  **ordered_add_ons:** `Internal::Types::Array[Schematic::Types::OrderedPlansInGroup]`
17505
17598
 
17506
17599
  </dd>