schematichq 1.4.9 → 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.
- checksums.yaml +4 -4
- data/.fern/metadata.json +2 -2
- data/.fern/replay.lock +344 -2
- data/WASM_VERSION +1 -1
- data/lib/schematic/catalogs/client.rb +480 -0
- data/lib/schematic/catalogs/types/create_catalog_request_body.rb +13 -0
- data/lib/schematic/catalogs/types/create_catalog_response.rb +12 -0
- data/lib/schematic/catalogs/types/delete_catalog_response.rb +12 -0
- data/lib/schematic/catalogs/types/get_catalog_response.rb +12 -0
- data/lib/schematic/catalogs/types/get_configuration_response.rb +12 -0
- data/lib/schematic/catalogs/types/get_credit_bundles_in_catalog_response.rb +12 -0
- data/lib/schematic/catalogs/types/get_derived_features_response.rb +12 -0
- data/lib/schematic/catalogs/types/get_plans_in_catalog_response.rb +12 -0
- data/lib/schematic/catalogs/types/list_catalogs_params.rb +15 -0
- data/lib/schematic/catalogs/types/list_catalogs_request.rb +14 -0
- data/lib/schematic/catalogs/types/list_catalogs_response.rb +12 -0
- data/lib/schematic/catalogs/types/update_catalog_configuration_request_body.rb +20 -0
- data/lib/schematic/catalogs/types/update_catalog_request_body.rb +14 -0
- data/lib/schematic/catalogs/types/update_catalog_response.rb +12 -0
- data/lib/schematic/catalogs/types/update_configuration_response.rb +12 -0
- data/lib/schematic/checkout/client.rb +69 -0
- data/lib/schematic/checkout/types/get_company_billing_details_response.rb +12 -0
- data/lib/schematic/checkout/types/update_company_billing_details_request_body.rb +15 -0
- data/lib/schematic/checkout/types/update_company_billing_details_response.rb +12 -0
- data/lib/schematic/client.rb +6 -1
- data/lib/schematic/components/client.rb +37 -0
- data/lib/schematic/components/types/bind_catalog_request_body.rb +12 -0
- data/lib/schematic/components/types/bind_catalog_response.rb +12 -0
- data/lib/schematic/dataexports/client.rb +76 -0
- data/lib/schematic/dataexports/types/create_data_export_request_body.rb +3 -3
- data/lib/schematic/dataexports/types/get_data_export_response.rb +12 -0
- data/lib/schematic/dataexports/types/list_data_exports_params.rb +15 -0
- data/lib/schematic/dataexports/types/list_data_exports_request.rb +14 -0
- data/lib/schematic/dataexports/types/list_data_exports_response.rb +12 -0
- data/lib/schematic/planbundle/types/create_custom_plan_bundle_request_body.rb +1 -0
- data/lib/schematic/types/audit_log_export_metadata.rb +13 -0
- data/lib/schematic/types/catalog_config_ordered_bundle.rb +9 -0
- data/lib/schematic/types/catalog_config_ordered_bundle_response_data.rb +9 -0
- data/lib/schematic/types/catalog_config_ordered_entitlement.rb +10 -0
- data/lib/schematic/types/catalog_config_ordered_entitlement_response_data.rb +10 -0
- data/lib/schematic/types/catalog_config_ordered_plan.rb +10 -0
- data/lib/schematic/types/catalog_config_ordered_plan_response_data.rb +10 -0
- data/lib/schematic/types/catalog_configuration_response_data.rb +19 -0
- data/lib/schematic/types/catalog_credit_bundle_i_ds_response_data.rb +9 -0
- data/lib/schematic/types/catalog_derived_feature_response_data.rb +11 -0
- data/lib/schematic/types/catalog_derived_features_response_data.rb +9 -0
- data/lib/schematic/types/catalog_plan_i_ds_response_data.rb +9 -0
- data/lib/schematic/types/catalog_response_data.rb +22 -0
- data/lib/schematic/types/company_billing_address_view.rb +14 -0
- data/lib/schematic/types/company_billing_checkout_settings.rb +11 -0
- data/lib/schematic/types/company_billing_details_response_data.rb +13 -0
- data/lib/schematic/types/company_billing_details_view.rb +13 -0
- data/lib/schematic/types/company_feature_usage_export_metadata.rb +25 -0
- data/lib/schematic/types/company_plan_detail_response_data.rb +1 -0
- data/lib/schematic/types/component_response_data.rb +1 -0
- data/lib/schematic/types/create_entitlement_in_bundle_request_body.rb +1 -0
- data/lib/schematic/types/credits_auto_topup_success.rb +12 -0
- data/lib/schematic/types/credits_credit_purchase_success.rb +14 -0
- data/lib/schematic/types/credits_webhook_company_summary.rb +10 -0
- data/lib/schematic/types/credits_webhook_credit_summary.rb +10 -0
- data/lib/schematic/types/customer_billing_address.rb +14 -0
- data/lib/schematic/types/data_export_metadata.rb +14 -0
- data/lib/schematic/types/data_export_output_file_type.rb +3 -14
- data/lib/schematic/types/data_export_response_data.rb +3 -3
- data/lib/schematic/types/data_export_type.rb +3 -14
- data/lib/schematic/types/feature_entitlement.rb +1 -0
- data/lib/schematic/types/plan_catalog_membership_response_data.rb +10 -0
- data/lib/schematic/types/plan_detail_response_data.rb +1 -0
- data/lib/schematic/types/plan_group_plan_detail_response_data.rb +1 -0
- data/lib/schematic/types/plan_view_public_response_data.rb +1 -0
- data/lib/schematic/types/preview_subscription_discount_response_data.rb +19 -0
- data/lib/schematic/types/preview_subscription_finance_response_data.rb +2 -0
- data/lib/schematic/types/rulesengine_feature_entitlement.rb +1 -0
- data/lib/schematic/types/rulesengine_warning_tier.rb +10 -0
- data/lib/schematic/types/upsert_company_request_body.rb +2 -0
- data/lib/schematic/types/warning_tier.rb +10 -0
- data/lib/schematic/types/webhook_request_type.rb +2 -0
- data/lib/schematic/version.rb +1 -1
- data/lib/schematic/wasm/rulesengine.wasm +0 -0
- data/lib/schematic.rb +91 -38
- data/reference.md +1231 -48
- metadata +55 -2
data/reference.md
CHANGED
|
@@ -6401,6 +6401,867 @@ client.credits.count_credit_event_ledger(
|
|
|
6401
6401
|
</dl>
|
|
6402
6402
|
|
|
6403
6403
|
|
|
6404
|
+
</dd>
|
|
6405
|
+
</dl>
|
|
6406
|
+
</details>
|
|
6407
|
+
|
|
6408
|
+
## catalogs
|
|
6409
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">list_catalogs</a>() -> Schematic::Catalogs::Types::ListCatalogsResponse</code></summary>
|
|
6410
|
+
<dl>
|
|
6411
|
+
<dd>
|
|
6412
|
+
|
|
6413
|
+
#### 🔌 Usage
|
|
6414
|
+
|
|
6415
|
+
<dl>
|
|
6416
|
+
<dd>
|
|
6417
|
+
|
|
6418
|
+
<dl>
|
|
6419
|
+
<dd>
|
|
6420
|
+
|
|
6421
|
+
```ruby
|
|
6422
|
+
client.catalogs.list_catalogs(
|
|
6423
|
+
is_default: true,
|
|
6424
|
+
q: "q",
|
|
6425
|
+
limit: 1000000,
|
|
6426
|
+
offset: 1000000
|
|
6427
|
+
)
|
|
6428
|
+
```
|
|
6429
|
+
</dd>
|
|
6430
|
+
</dl>
|
|
6431
|
+
</dd>
|
|
6432
|
+
</dl>
|
|
6433
|
+
|
|
6434
|
+
#### ⚙️ Parameters
|
|
6435
|
+
|
|
6436
|
+
<dl>
|
|
6437
|
+
<dd>
|
|
6438
|
+
|
|
6439
|
+
<dl>
|
|
6440
|
+
<dd>
|
|
6441
|
+
|
|
6442
|
+
**is_default:** `Internal::Types::Boolean`
|
|
6443
|
+
|
|
6444
|
+
</dd>
|
|
6445
|
+
</dl>
|
|
6446
|
+
|
|
6447
|
+
<dl>
|
|
6448
|
+
<dd>
|
|
6449
|
+
|
|
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`
|
|
6475
|
+
|
|
6476
|
+
</dd>
|
|
6477
|
+
</dl>
|
|
6478
|
+
</dd>
|
|
6479
|
+
</dl>
|
|
6480
|
+
|
|
6481
|
+
|
|
6482
|
+
</dd>
|
|
6483
|
+
</dl>
|
|
6484
|
+
</details>
|
|
6485
|
+
|
|
6486
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">create_catalog</a>(request) -> Schematic::Catalogs::Types::CreateCatalogResponse</code></summary>
|
|
6487
|
+
<dl>
|
|
6488
|
+
<dd>
|
|
6489
|
+
|
|
6490
|
+
#### 🔌 Usage
|
|
6491
|
+
|
|
6492
|
+
<dl>
|
|
6493
|
+
<dd>
|
|
6494
|
+
|
|
6495
|
+
<dl>
|
|
6496
|
+
<dd>
|
|
6497
|
+
|
|
6498
|
+
```ruby
|
|
6499
|
+
client.catalogs.create_catalog(
|
|
6500
|
+
is_default: true,
|
|
6501
|
+
name: "name"
|
|
6502
|
+
)
|
|
6503
|
+
```
|
|
6504
|
+
</dd>
|
|
6505
|
+
</dl>
|
|
6506
|
+
</dd>
|
|
6507
|
+
</dl>
|
|
6508
|
+
|
|
6509
|
+
#### ⚙️ Parameters
|
|
6510
|
+
|
|
6511
|
+
<dl>
|
|
6512
|
+
<dd>
|
|
6513
|
+
|
|
6514
|
+
<dl>
|
|
6515
|
+
<dd>
|
|
6516
|
+
|
|
6517
|
+
**description:** `String`
|
|
6518
|
+
|
|
6519
|
+
</dd>
|
|
6520
|
+
</dl>
|
|
6521
|
+
|
|
6522
|
+
<dl>
|
|
6523
|
+
<dd>
|
|
6524
|
+
|
|
6525
|
+
**is_default:** `Internal::Types::Boolean`
|
|
6526
|
+
|
|
6527
|
+
</dd>
|
|
6528
|
+
</dl>
|
|
6529
|
+
|
|
6530
|
+
<dl>
|
|
6531
|
+
<dd>
|
|
6532
|
+
|
|
6533
|
+
**name:** `String`
|
|
6534
|
+
|
|
6535
|
+
</dd>
|
|
6536
|
+
</dl>
|
|
6537
|
+
|
|
6538
|
+
<dl>
|
|
6539
|
+
<dd>
|
|
6540
|
+
|
|
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`
|
|
6710
|
+
|
|
6711
|
+
</dd>
|
|
6712
|
+
</dl>
|
|
6713
|
+
</dd>
|
|
6714
|
+
</dl>
|
|
6715
|
+
|
|
6716
|
+
|
|
6717
|
+
</dd>
|
|
6718
|
+
</dl>
|
|
6719
|
+
</details>
|
|
6720
|
+
|
|
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
|
+
|
|
6404
7265
|
</dd>
|
|
6405
7266
|
</dl>
|
|
6406
7267
|
</details>
|
|
@@ -6419,7 +7280,143 @@ client.credits.count_credit_event_ledger(
|
|
|
6419
7280
|
<dd>
|
|
6420
7281
|
|
|
6421
7282
|
```ruby
|
|
6422
|
-
client.checkout.internal(
|
|
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(
|
|
6423
7420
|
add_on_ids: [{
|
|
6424
7421
|
add_on_id: "add_on_id",
|
|
6425
7422
|
price_id: "price_id"
|
|
@@ -6478,7 +7475,7 @@ client.checkout.internal(
|
|
|
6478
7475
|
</dl>
|
|
6479
7476
|
</details>
|
|
6480
7477
|
|
|
6481
|
-
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">
|
|
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>
|
|
6482
7479
|
<dl>
|
|
6483
7480
|
<dd>
|
|
6484
7481
|
|
|
@@ -6491,7 +7488,7 @@ client.checkout.internal(
|
|
|
6491
7488
|
<dd>
|
|
6492
7489
|
|
|
6493
7490
|
```ruby
|
|
6494
|
-
client.checkout.
|
|
7491
|
+
client.checkout.get_company_billing_details(company_id: "company_id")
|
|
6495
7492
|
```
|
|
6496
7493
|
</dd>
|
|
6497
7494
|
</dl>
|
|
@@ -6506,23 +7503,7 @@ client.checkout.get_checkout_data(company_id: "company_id")
|
|
|
6506
7503
|
<dl>
|
|
6507
7504
|
<dd>
|
|
6508
7505
|
|
|
6509
|
-
**company_id:** `String`
|
|
6510
|
-
|
|
6511
|
-
</dd>
|
|
6512
|
-
</dl>
|
|
6513
|
-
|
|
6514
|
-
<dl>
|
|
6515
|
-
<dd>
|
|
6516
|
-
|
|
6517
|
-
**currency:** `String`
|
|
6518
|
-
|
|
6519
|
-
</dd>
|
|
6520
|
-
</dl>
|
|
6521
|
-
|
|
6522
|
-
<dl>
|
|
6523
|
-
<dd>
|
|
6524
|
-
|
|
6525
|
-
**selected_plan_id:** `String`
|
|
7506
|
+
**company_id:** `String` — company_id
|
|
6526
7507
|
|
|
6527
7508
|
</dd>
|
|
6528
7509
|
</dl>
|
|
@@ -6542,7 +7523,7 @@ client.checkout.get_checkout_data(company_id: "company_id")
|
|
|
6542
7523
|
</dl>
|
|
6543
7524
|
</details>
|
|
6544
7525
|
|
|
6545
|
-
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">
|
|
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>
|
|
6546
7527
|
<dl>
|
|
6547
7528
|
<dd>
|
|
6548
7529
|
|
|
@@ -6555,30 +7536,12 @@ client.checkout.get_checkout_data(company_id: "company_id")
|
|
|
6555
7536
|
<dd>
|
|
6556
7537
|
|
|
6557
7538
|
```ruby
|
|
6558
|
-
client.checkout.
|
|
6559
|
-
add_on_ids: [{
|
|
6560
|
-
add_on_id: "add_on_id",
|
|
6561
|
-
price_id: "price_id"
|
|
6562
|
-
}],
|
|
6563
|
-
auto_topup_overrides: [{
|
|
6564
|
-
plan_credit_grant_id: "plan_credit_grant_id"
|
|
6565
|
-
}],
|
|
7539
|
+
client.checkout.update_company_billing_details(
|
|
6566
7540
|
company_id: "company_id",
|
|
6567
|
-
|
|
6568
|
-
bundle_id: "bundle_id",
|
|
6569
|
-
quantity: 1000000
|
|
6570
|
-
}],
|
|
6571
|
-
custom_field_values: [{
|
|
7541
|
+
values: [{
|
|
6572
7542
|
id: "id",
|
|
6573
7543
|
value: "value"
|
|
6574
|
-
}]
|
|
6575
|
-
new_plan_id: "new_plan_id",
|
|
6576
|
-
new_price_id: "new_price_id",
|
|
6577
|
-
pay_in_advance: [{
|
|
6578
|
-
price_id: "price_id",
|
|
6579
|
-
quantity: 1000000
|
|
6580
|
-
}],
|
|
6581
|
-
skip_trial: true
|
|
7544
|
+
}]
|
|
6582
7545
|
)
|
|
6583
7546
|
```
|
|
6584
7547
|
</dd>
|
|
@@ -6594,7 +7557,39 @@ client.checkout.preview_checkout_internal(
|
|
|
6594
7557
|
<dl>
|
|
6595
7558
|
<dd>
|
|
6596
7559
|
|
|
6597
|
-
**
|
|
7560
|
+
**company_id:** `String` — company_id
|
|
7561
|
+
|
|
7562
|
+
</dd>
|
|
7563
|
+
</dl>
|
|
7564
|
+
|
|
7565
|
+
<dl>
|
|
7566
|
+
<dd>
|
|
7567
|
+
|
|
7568
|
+
**address:** `Schematic::Types::CustomerBillingAddress`
|
|
7569
|
+
|
|
7570
|
+
</dd>
|
|
7571
|
+
</dl>
|
|
7572
|
+
|
|
7573
|
+
<dl>
|
|
7574
|
+
<dd>
|
|
7575
|
+
|
|
7576
|
+
**email:** `String`
|
|
7577
|
+
|
|
7578
|
+
</dd>
|
|
7579
|
+
</dl>
|
|
7580
|
+
|
|
7581
|
+
<dl>
|
|
7582
|
+
<dd>
|
|
7583
|
+
|
|
7584
|
+
**phone:** `String`
|
|
7585
|
+
|
|
7586
|
+
</dd>
|
|
7587
|
+
</dl>
|
|
7588
|
+
|
|
7589
|
+
<dl>
|
|
7590
|
+
<dd>
|
|
7591
|
+
|
|
7592
|
+
**values:** `Internal::Types::Array[Schematic::Types::CheckoutFieldValue]`
|
|
6598
7593
|
|
|
6599
7594
|
</dd>
|
|
6600
7595
|
</dl>
|
|
@@ -14210,6 +15205,62 @@ client.components.delete_component(component_id: "component_id")
|
|
|
14210
15205
|
</dl>
|
|
14211
15206
|
|
|
14212
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
|
+
|
|
14213
15264
|
</dd>
|
|
14214
15265
|
</dl>
|
|
14215
15266
|
</details>
|
|
@@ -14380,6 +15431,14 @@ client.planbundle.create_custom_plan_bundle(entitlements: [{
|
|
|
14380
15431
|
<dl>
|
|
14381
15432
|
<dd>
|
|
14382
15433
|
|
|
15434
|
+
**credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
|
|
15435
|
+
|
|
15436
|
+
</dd>
|
|
15437
|
+
</dl>
|
|
15438
|
+
|
|
15439
|
+
<dl>
|
|
15440
|
+
<dd>
|
|
15441
|
+
|
|
14383
15442
|
**entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
|
|
14384
15443
|
|
|
14385
15444
|
</dd>
|
|
@@ -14576,6 +15635,83 @@ client.planbundle.update_plan_bundle(
|
|
|
14576
15635
|
</details>
|
|
14577
15636
|
|
|
14578
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>
|
|
15639
|
+
<dl>
|
|
15640
|
+
<dd>
|
|
15641
|
+
|
|
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`
|
|
15704
|
+
|
|
15705
|
+
</dd>
|
|
15706
|
+
</dl>
|
|
15707
|
+
</dd>
|
|
15708
|
+
</dl>
|
|
15709
|
+
|
|
15710
|
+
|
|
15711
|
+
</dd>
|
|
15712
|
+
</dl>
|
|
15713
|
+
</details>
|
|
15714
|
+
|
|
14579
15715
|
<details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">create_data_export</a>(request) -> Schematic::Dataexports::Types::CreateDataExportResponse</code></summary>
|
|
14580
15716
|
<dl>
|
|
14581
15717
|
<dd>
|
|
@@ -14590,8 +15726,7 @@ client.planbundle.update_plan_bundle(
|
|
|
14590
15726
|
|
|
14591
15727
|
```ruby
|
|
14592
15728
|
client.dataexports.create_data_export(
|
|
14593
|
-
export_type: "
|
|
14594
|
-
metadata: "metadata",
|
|
15729
|
+
export_type: "audit-log",
|
|
14595
15730
|
output_file_type: "csv"
|
|
14596
15731
|
)
|
|
14597
15732
|
```
|
|
@@ -14608,7 +15743,23 @@ client.dataexports.create_data_export(
|
|
|
14608
15743
|
<dl>
|
|
14609
15744
|
<dd>
|
|
14610
15745
|
|
|
14611
|
-
**export_type:** `
|
|
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`
|
|
14612
15763
|
|
|
14613
15764
|
</dd>
|
|
14614
15765
|
</dl>
|
|
@@ -14616,15 +15767,47 @@ client.dataexports.create_data_export(
|
|
|
14616
15767
|
<dl>
|
|
14617
15768
|
<dd>
|
|
14618
15769
|
|
|
14619
|
-
**
|
|
15770
|
+
**request_options:** `Schematic::Dataexports::RequestOptions`
|
|
14620
15771
|
|
|
14621
15772
|
</dd>
|
|
14622
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
|
|
14623
15803
|
|
|
14624
15804
|
<dl>
|
|
14625
15805
|
<dd>
|
|
14626
15806
|
|
|
14627
|
-
|
|
15807
|
+
<dl>
|
|
15808
|
+
<dd>
|
|
15809
|
+
|
|
15810
|
+
**data_export_id:** `String` — data_export_id
|
|
14628
15811
|
|
|
14629
15812
|
</dd>
|
|
14630
15813
|
</dl>
|