schematichq 1.4.9 → 1.4.11
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 +350 -2
- data/WASM_VERSION +1 -1
- data/lib/schematic/accounts/client.rb +6 -2
- data/lib/schematic/accounts/types/count_account_members_params.rb +1 -0
- data/lib/schematic/accounts/types/count_account_members_request.rb +1 -0
- data/lib/schematic/accounts/types/list_account_members_params.rb +1 -0
- data/lib/schematic/accounts/types/list_account_members_request.rb +1 -0
- 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 +11 -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/licenses/client.rb +138 -0
- data/lib/schematic/licenses/types/count_licenses_params.rb +16 -0
- data/lib/schematic/licenses/types/count_licenses_request.rb +15 -0
- data/lib/schematic/licenses/types/count_licenses_response.rb +12 -0
- data/lib/schematic/licenses/types/get_single_license_response.rb +12 -0
- data/lib/schematic/licenses/types/list_licenses_params.rb +16 -0
- data/lib/schematic/licenses/types/list_licenses_request.rb +15 -0
- data/lib/schematic/licenses/types/list_licenses_response.rb +12 -0
- data/lib/schematic/planbundle/types/create_custom_plan_bundle_request_body.rb +1 -0
- data/lib/schematic/planmigrations/client.rb +32 -0
- data/lib/schematic/planmigrations/types/preview_migration_request_body.rb +14 -0
- data/lib/schematic/planmigrations/types/preview_migration_response.rb +12 -0
- data/lib/schematic/types/audit_log_export_metadata.rb +13 -0
- data/lib/schematic/types/billing_credit_grant_zeroed_out_reason.rb +1 -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_detail_response_data.rb +3 -0
- data/lib/schematic/types/feature_entitlement.rb +1 -0
- data/lib/schematic/types/feature_in_plan_response_data.rb +2 -0
- data/lib/schematic/types/feature_response_data.rb +2 -0
- data/lib/schematic/types/feature_type.rb +1 -0
- data/lib/schematic/types/feature_view.rb +2 -0
- data/lib/schematic/types/license_response_data.rb +12 -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_version_migration_preview_company_response_data.rb +14 -0
- data/lib/schematic/types/plan_version_migration_preview_response_data.rb +9 -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 +105 -39
- data/reference.md +1800 -301
- metadata +68 -2
data/reference.md
CHANGED
|
@@ -56,6 +56,7 @@ client.get_credit_ledger
|
|
|
56
56
|
client.accounts.list_account_members(
|
|
57
57
|
ids: ["ids"],
|
|
58
58
|
q: "q",
|
|
59
|
+
role: "admin",
|
|
59
60
|
limit: 1000000,
|
|
60
61
|
offset: 1000000
|
|
61
62
|
)
|
|
@@ -89,6 +90,14 @@ client.accounts.list_account_members(
|
|
|
89
90
|
<dl>
|
|
90
91
|
<dd>
|
|
91
92
|
|
|
93
|
+
**role:** `Schematic::Types::AccountMemberRole` — Filter by member role
|
|
94
|
+
|
|
95
|
+
</dd>
|
|
96
|
+
</dl>
|
|
97
|
+
|
|
98
|
+
<dl>
|
|
99
|
+
<dd>
|
|
100
|
+
|
|
92
101
|
**limit:** `Integer` — Page limit (default 100)
|
|
93
102
|
|
|
94
103
|
</dd>
|
|
@@ -181,6 +190,7 @@ client.accounts.get_account_member(account_member_id: "account_member_id")
|
|
|
181
190
|
client.accounts.count_account_members(
|
|
182
191
|
ids: ["ids"],
|
|
183
192
|
q: "q",
|
|
193
|
+
role: "admin",
|
|
184
194
|
limit: 1000000,
|
|
185
195
|
offset: 1000000
|
|
186
196
|
)
|
|
@@ -214,6 +224,14 @@ client.accounts.count_account_members(
|
|
|
214
224
|
<dl>
|
|
215
225
|
<dd>
|
|
216
226
|
|
|
227
|
+
**role:** `Schematic::Types::AccountMemberRole` — Filter by member role
|
|
228
|
+
|
|
229
|
+
</dd>
|
|
230
|
+
</dl>
|
|
231
|
+
|
|
232
|
+
<dl>
|
|
233
|
+
<dd>
|
|
234
|
+
|
|
217
235
|
**limit:** `Integer` — Page limit (default 100)
|
|
218
236
|
|
|
219
237
|
</dd>
|
|
@@ -6405,8 +6423,8 @@ client.credits.count_credit_event_ledger(
|
|
|
6405
6423
|
</dl>
|
|
6406
6424
|
</details>
|
|
6407
6425
|
|
|
6408
|
-
##
|
|
6409
|
-
<details><summary><code>client.
|
|
6426
|
+
## catalogs
|
|
6427
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">list_catalogs</a>() -> Schematic::Catalogs::Types::ListCatalogsResponse</code></summary>
|
|
6410
6428
|
<dl>
|
|
6411
6429
|
<dd>
|
|
6412
6430
|
|
|
@@ -6419,30 +6437,11 @@ client.credits.count_credit_event_ledger(
|
|
|
6419
6437
|
<dd>
|
|
6420
6438
|
|
|
6421
6439
|
```ruby
|
|
6422
|
-
client.
|
|
6423
|
-
|
|
6424
|
-
|
|
6425
|
-
|
|
6426
|
-
|
|
6427
|
-
auto_topup_overrides: [{
|
|
6428
|
-
plan_credit_grant_id: "plan_credit_grant_id"
|
|
6429
|
-
}],
|
|
6430
|
-
company_id: "company_id",
|
|
6431
|
-
credit_bundles: [{
|
|
6432
|
-
bundle_id: "bundle_id",
|
|
6433
|
-
quantity: 1000000
|
|
6434
|
-
}],
|
|
6435
|
-
custom_field_values: [{
|
|
6436
|
-
id: "id",
|
|
6437
|
-
value: "value"
|
|
6438
|
-
}],
|
|
6439
|
-
new_plan_id: "new_plan_id",
|
|
6440
|
-
new_price_id: "new_price_id",
|
|
6441
|
-
pay_in_advance: [{
|
|
6442
|
-
price_id: "price_id",
|
|
6443
|
-
quantity: 1000000
|
|
6444
|
-
}],
|
|
6445
|
-
skip_trial: true
|
|
6440
|
+
client.catalogs.list_catalogs(
|
|
6441
|
+
is_default: true,
|
|
6442
|
+
q: "q",
|
|
6443
|
+
limit: 1000000,
|
|
6444
|
+
offset: 1000000
|
|
6446
6445
|
)
|
|
6447
6446
|
```
|
|
6448
6447
|
</dd>
|
|
@@ -6458,7 +6457,7 @@ client.checkout.internal(
|
|
|
6458
6457
|
<dl>
|
|
6459
6458
|
<dd>
|
|
6460
6459
|
|
|
6461
|
-
**
|
|
6460
|
+
**is_default:** `Internal::Types::Boolean`
|
|
6462
6461
|
|
|
6463
6462
|
</dd>
|
|
6464
6463
|
</dl>
|
|
@@ -6466,7 +6465,31 @@ client.checkout.internal(
|
|
|
6466
6465
|
<dl>
|
|
6467
6466
|
<dd>
|
|
6468
6467
|
|
|
6469
|
-
**
|
|
6468
|
+
**q:** `String` — Search by catalog name
|
|
6469
|
+
|
|
6470
|
+
</dd>
|
|
6471
|
+
</dl>
|
|
6472
|
+
|
|
6473
|
+
<dl>
|
|
6474
|
+
<dd>
|
|
6475
|
+
|
|
6476
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
6477
|
+
|
|
6478
|
+
</dd>
|
|
6479
|
+
</dl>
|
|
6480
|
+
|
|
6481
|
+
<dl>
|
|
6482
|
+
<dd>
|
|
6483
|
+
|
|
6484
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
6485
|
+
|
|
6486
|
+
</dd>
|
|
6487
|
+
</dl>
|
|
6488
|
+
|
|
6489
|
+
<dl>
|
|
6490
|
+
<dd>
|
|
6491
|
+
|
|
6492
|
+
**request_options:** `Schematic::Catalogs::RequestOptions`
|
|
6470
6493
|
|
|
6471
6494
|
</dd>
|
|
6472
6495
|
</dl>
|
|
@@ -6478,7 +6501,7 @@ client.checkout.internal(
|
|
|
6478
6501
|
</dl>
|
|
6479
6502
|
</details>
|
|
6480
6503
|
|
|
6481
|
-
<details><summary><code>client.
|
|
6504
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">create_catalog</a>(request) -> Schematic::Catalogs::Types::CreateCatalogResponse</code></summary>
|
|
6482
6505
|
<dl>
|
|
6483
6506
|
<dd>
|
|
6484
6507
|
|
|
@@ -6491,7 +6514,10 @@ client.checkout.internal(
|
|
|
6491
6514
|
<dd>
|
|
6492
6515
|
|
|
6493
6516
|
```ruby
|
|
6494
|
-
client.
|
|
6517
|
+
client.catalogs.create_catalog(
|
|
6518
|
+
is_default: true,
|
|
6519
|
+
name: "name"
|
|
6520
|
+
)
|
|
6495
6521
|
```
|
|
6496
6522
|
</dd>
|
|
6497
6523
|
</dl>
|
|
@@ -6506,7 +6532,7 @@ client.checkout.get_checkout_data(company_id: "company_id")
|
|
|
6506
6532
|
<dl>
|
|
6507
6533
|
<dd>
|
|
6508
6534
|
|
|
6509
|
-
**
|
|
6535
|
+
**description:** `String`
|
|
6510
6536
|
|
|
6511
6537
|
</dd>
|
|
6512
6538
|
</dl>
|
|
@@ -6514,7 +6540,7 @@ client.checkout.get_checkout_data(company_id: "company_id")
|
|
|
6514
6540
|
<dl>
|
|
6515
6541
|
<dd>
|
|
6516
6542
|
|
|
6517
|
-
**
|
|
6543
|
+
**is_default:** `Internal::Types::Boolean`
|
|
6518
6544
|
|
|
6519
6545
|
</dd>
|
|
6520
6546
|
</dl>
|
|
@@ -6522,7 +6548,7 @@ client.checkout.get_checkout_data(company_id: "company_id")
|
|
|
6522
6548
|
<dl>
|
|
6523
6549
|
<dd>
|
|
6524
6550
|
|
|
6525
|
-
**
|
|
6551
|
+
**name:** `String`
|
|
6526
6552
|
|
|
6527
6553
|
</dd>
|
|
6528
6554
|
</dl>
|
|
@@ -6530,7 +6556,7 @@ client.checkout.get_checkout_data(company_id: "company_id")
|
|
|
6530
6556
|
<dl>
|
|
6531
6557
|
<dd>
|
|
6532
6558
|
|
|
6533
|
-
**request_options:** `Schematic::
|
|
6559
|
+
**request_options:** `Schematic::Catalogs::RequestOptions`
|
|
6534
6560
|
|
|
6535
6561
|
</dd>
|
|
6536
6562
|
</dl>
|
|
@@ -6542,7 +6568,7 @@ client.checkout.get_checkout_data(company_id: "company_id")
|
|
|
6542
6568
|
</dl>
|
|
6543
6569
|
</details>
|
|
6544
6570
|
|
|
6545
|
-
<details><summary><code>client.
|
|
6571
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_catalog</a>(catalog_id) -> Schematic::Catalogs::Types::GetCatalogResponse</code></summary>
|
|
6546
6572
|
<dl>
|
|
6547
6573
|
<dd>
|
|
6548
6574
|
|
|
@@ -6555,31 +6581,7 @@ client.checkout.get_checkout_data(company_id: "company_id")
|
|
|
6555
6581
|
<dd>
|
|
6556
6582
|
|
|
6557
6583
|
```ruby
|
|
6558
|
-
client.
|
|
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
|
-
}],
|
|
6566
|
-
company_id: "company_id",
|
|
6567
|
-
credit_bundles: [{
|
|
6568
|
-
bundle_id: "bundle_id",
|
|
6569
|
-
quantity: 1000000
|
|
6570
|
-
}],
|
|
6571
|
-
custom_field_values: [{
|
|
6572
|
-
id: "id",
|
|
6573
|
-
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
|
|
6582
|
-
)
|
|
6584
|
+
client.catalogs.get_catalog(catalog_id: "catalog_id")
|
|
6583
6585
|
```
|
|
6584
6586
|
</dd>
|
|
6585
6587
|
</dl>
|
|
@@ -6594,7 +6596,7 @@ client.checkout.preview_checkout_internal(
|
|
|
6594
6596
|
<dl>
|
|
6595
6597
|
<dd>
|
|
6596
6598
|
|
|
6597
|
-
**
|
|
6599
|
+
**catalog_id:** `String` — catalog_id
|
|
6598
6600
|
|
|
6599
6601
|
</dd>
|
|
6600
6602
|
</dl>
|
|
@@ -6602,7 +6604,7 @@ client.checkout.preview_checkout_internal(
|
|
|
6602
6604
|
<dl>
|
|
6603
6605
|
<dd>
|
|
6604
6606
|
|
|
6605
|
-
**request_options:** `Schematic::
|
|
6607
|
+
**request_options:** `Schematic::Catalogs::RequestOptions`
|
|
6606
6608
|
|
|
6607
6609
|
</dd>
|
|
6608
6610
|
</dl>
|
|
@@ -6614,7 +6616,7 @@ client.checkout.preview_checkout_internal(
|
|
|
6614
6616
|
</dl>
|
|
6615
6617
|
</details>
|
|
6616
6618
|
|
|
6617
|
-
<details><summary><code>client.
|
|
6619
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">update_catalog</a>(catalog_id, request) -> Schematic::Catalogs::Types::UpdateCatalogResponse</code></summary>
|
|
6618
6620
|
<dl>
|
|
6619
6621
|
<dd>
|
|
6620
6622
|
|
|
@@ -6627,24 +6629,7 @@ client.checkout.preview_checkout_internal(
|
|
|
6627
6629
|
<dd>
|
|
6628
6630
|
|
|
6629
6631
|
```ruby
|
|
6630
|
-
client.
|
|
6631
|
-
add_on_selections: [{
|
|
6632
|
-
plan_id: "plan_id"
|
|
6633
|
-
}],
|
|
6634
|
-
company_id: "company_id",
|
|
6635
|
-
credit_bundles: [{
|
|
6636
|
-
bundle_id: "bundle_id",
|
|
6637
|
-
quantity: 1000000
|
|
6638
|
-
}],
|
|
6639
|
-
custom_field_values: [{
|
|
6640
|
-
id: "id",
|
|
6641
|
-
value: "value"
|
|
6642
|
-
}],
|
|
6643
|
-
pay_in_advance_entitlements: [{
|
|
6644
|
-
price_id: "price_id",
|
|
6645
|
-
quantity: 1000000
|
|
6646
|
-
}]
|
|
6647
|
-
)
|
|
6632
|
+
client.catalogs.update_catalog(catalog_id: "catalog_id")
|
|
6648
6633
|
```
|
|
6649
6634
|
</dd>
|
|
6650
6635
|
</dl>
|
|
@@ -6659,7 +6644,7 @@ client.checkout.manage_plan(
|
|
|
6659
6644
|
<dl>
|
|
6660
6645
|
<dd>
|
|
6661
6646
|
|
|
6662
|
-
**
|
|
6647
|
+
**catalog_id:** `String` — catalog_id
|
|
6663
6648
|
|
|
6664
6649
|
</dd>
|
|
6665
6650
|
</dl>
|
|
@@ -6667,64 +6652,23 @@ client.checkout.manage_plan(
|
|
|
6667
6652
|
<dl>
|
|
6668
6653
|
<dd>
|
|
6669
6654
|
|
|
6670
|
-
**
|
|
6655
|
+
**description:** `String`
|
|
6671
6656
|
|
|
6672
6657
|
</dd>
|
|
6673
6658
|
</dl>
|
|
6674
|
-
</dd>
|
|
6675
|
-
</dl>
|
|
6676
|
-
|
|
6677
|
-
|
|
6678
|
-
</dd>
|
|
6679
|
-
</dl>
|
|
6680
|
-
</details>
|
|
6681
|
-
|
|
6682
|
-
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">preview_manage_plan</a>(request) -> Schematic::Checkout::Types::PreviewManagePlanResponse</code></summary>
|
|
6683
|
-
<dl>
|
|
6684
|
-
<dd>
|
|
6685
|
-
|
|
6686
|
-
#### 🔌 Usage
|
|
6687
|
-
|
|
6688
|
-
<dl>
|
|
6689
|
-
<dd>
|
|
6690
6659
|
|
|
6691
6660
|
<dl>
|
|
6692
6661
|
<dd>
|
|
6693
6662
|
|
|
6694
|
-
|
|
6695
|
-
|
|
6696
|
-
add_on_selections: [{
|
|
6697
|
-
plan_id: "plan_id"
|
|
6698
|
-
}],
|
|
6699
|
-
company_id: "company_id",
|
|
6700
|
-
credit_bundles: [{
|
|
6701
|
-
bundle_id: "bundle_id",
|
|
6702
|
-
quantity: 1000000
|
|
6703
|
-
}],
|
|
6704
|
-
custom_field_values: [{
|
|
6705
|
-
id: "id",
|
|
6706
|
-
value: "value"
|
|
6707
|
-
}],
|
|
6708
|
-
pay_in_advance_entitlements: [{
|
|
6709
|
-
price_id: "price_id",
|
|
6710
|
-
quantity: 1000000
|
|
6711
|
-
}]
|
|
6712
|
-
)
|
|
6713
|
-
```
|
|
6714
|
-
</dd>
|
|
6715
|
-
</dl>
|
|
6663
|
+
**is_default:** `Internal::Types::Boolean`
|
|
6664
|
+
|
|
6716
6665
|
</dd>
|
|
6717
6666
|
</dl>
|
|
6718
6667
|
|
|
6719
|
-
#### ⚙️ Parameters
|
|
6720
|
-
|
|
6721
|
-
<dl>
|
|
6722
|
-
<dd>
|
|
6723
|
-
|
|
6724
6668
|
<dl>
|
|
6725
6669
|
<dd>
|
|
6726
6670
|
|
|
6727
|
-
**
|
|
6671
|
+
**name:** `String`
|
|
6728
6672
|
|
|
6729
6673
|
</dd>
|
|
6730
6674
|
</dl>
|
|
@@ -6732,7 +6676,7 @@ client.checkout.preview_manage_plan(
|
|
|
6732
6676
|
<dl>
|
|
6733
6677
|
<dd>
|
|
6734
6678
|
|
|
6735
|
-
**request_options:** `Schematic::
|
|
6679
|
+
**request_options:** `Schematic::Catalogs::RequestOptions`
|
|
6736
6680
|
|
|
6737
6681
|
</dd>
|
|
6738
6682
|
</dl>
|
|
@@ -6744,7 +6688,7 @@ client.checkout.preview_manage_plan(
|
|
|
6744
6688
|
</dl>
|
|
6745
6689
|
</details>
|
|
6746
6690
|
|
|
6747
|
-
<details><summary><code>client.
|
|
6691
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">delete_catalog</a>(catalog_id) -> Schematic::Catalogs::Types::DeleteCatalogResponse</code></summary>
|
|
6748
6692
|
<dl>
|
|
6749
6693
|
<dd>
|
|
6750
6694
|
|
|
@@ -6757,7 +6701,7 @@ client.checkout.preview_manage_plan(
|
|
|
6757
6701
|
<dd>
|
|
6758
6702
|
|
|
6759
6703
|
```ruby
|
|
6760
|
-
client.
|
|
6704
|
+
client.catalogs.delete_catalog(catalog_id: "catalog_id")
|
|
6761
6705
|
```
|
|
6762
6706
|
</dd>
|
|
6763
6707
|
</dl>
|
|
@@ -6772,23 +6716,7 @@ client.checkout.cancel_subscription(company_id: "company_id")
|
|
|
6772
6716
|
<dl>
|
|
6773
6717
|
<dd>
|
|
6774
6718
|
|
|
6775
|
-
**
|
|
6776
|
-
|
|
6777
|
-
</dd>
|
|
6778
|
-
</dl>
|
|
6779
|
-
|
|
6780
|
-
<dl>
|
|
6781
|
-
<dd>
|
|
6782
|
-
|
|
6783
|
-
**company_id:** `String`
|
|
6784
|
-
|
|
6785
|
-
</dd>
|
|
6786
|
-
</dl>
|
|
6787
|
-
|
|
6788
|
-
<dl>
|
|
6789
|
-
<dd>
|
|
6790
|
-
|
|
6791
|
-
**prorate:** `Internal::Types::Boolean` — If true and cancel_immediately is true, issue prorated credit. Defaults to true.
|
|
6719
|
+
**catalog_id:** `String` — catalog_id
|
|
6792
6720
|
|
|
6793
6721
|
</dd>
|
|
6794
6722
|
</dl>
|
|
@@ -6796,7 +6724,7 @@ client.checkout.cancel_subscription(company_id: "company_id")
|
|
|
6796
6724
|
<dl>
|
|
6797
6725
|
<dd>
|
|
6798
6726
|
|
|
6799
|
-
**request_options:** `Schematic::
|
|
6727
|
+
**request_options:** `Schematic::Catalogs::RequestOptions`
|
|
6800
6728
|
|
|
6801
6729
|
</dd>
|
|
6802
6730
|
</dl>
|
|
@@ -6808,7 +6736,7 @@ client.checkout.cancel_subscription(company_id: "company_id")
|
|
|
6808
6736
|
</dl>
|
|
6809
6737
|
</details>
|
|
6810
6738
|
|
|
6811
|
-
<details><summary><code>client.
|
|
6739
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_configuration</a>(catalog_id) -> Schematic::Catalogs::Types::GetConfigurationResponse</code></summary>
|
|
6812
6740
|
<dl>
|
|
6813
6741
|
<dd>
|
|
6814
6742
|
|
|
@@ -6821,7 +6749,7 @@ client.checkout.cancel_subscription(company_id: "company_id")
|
|
|
6821
6749
|
<dd>
|
|
6822
6750
|
|
|
6823
6751
|
```ruby
|
|
6824
|
-
client.
|
|
6752
|
+
client.catalogs.get_configuration(catalog_id: "catalog_id")
|
|
6825
6753
|
```
|
|
6826
6754
|
</dd>
|
|
6827
6755
|
</dl>
|
|
@@ -6836,15 +6764,7 @@ client.checkout.update_customer_subscription_trial_end(subscription_id: "subscri
|
|
|
6836
6764
|
<dl>
|
|
6837
6765
|
<dd>
|
|
6838
6766
|
|
|
6839
|
-
**
|
|
6840
|
-
|
|
6841
|
-
</dd>
|
|
6842
|
-
</dl>
|
|
6843
|
-
|
|
6844
|
-
<dl>
|
|
6845
|
-
<dd>
|
|
6846
|
-
|
|
6847
|
-
**trial_end:** `String`
|
|
6767
|
+
**catalog_id:** `String` — catalog_id
|
|
6848
6768
|
|
|
6849
6769
|
</dd>
|
|
6850
6770
|
</dl>
|
|
@@ -6852,7 +6772,7 @@ client.checkout.update_customer_subscription_trial_end(subscription_id: "subscri
|
|
|
6852
6772
|
<dl>
|
|
6853
6773
|
<dd>
|
|
6854
6774
|
|
|
6855
|
-
**request_options:** `Schematic::
|
|
6775
|
+
**request_options:** `Schematic::Catalogs::RequestOptions`
|
|
6856
6776
|
|
|
6857
6777
|
</dd>
|
|
6858
6778
|
</dl>
|
|
@@ -6864,8 +6784,7 @@ client.checkout.update_customer_subscription_trial_end(subscription_id: "subscri
|
|
|
6864
6784
|
</dl>
|
|
6865
6785
|
</details>
|
|
6866
6786
|
|
|
6867
|
-
|
|
6868
|
-
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">list_companies</a>() -> Schematic::Companies::Types::ListCompaniesResponse</code></summary>
|
|
6787
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">update_configuration</a>(catalog_id, request) -> Schematic::Catalogs::Types::UpdateConfigurationResponse</code></summary>
|
|
6869
6788
|
<dl>
|
|
6870
6789
|
<dd>
|
|
6871
6790
|
|
|
@@ -6878,28 +6797,7 @@ client.checkout.update_customer_subscription_trial_end(subscription_id: "subscri
|
|
|
6878
6797
|
<dd>
|
|
6879
6798
|
|
|
6880
6799
|
```ruby
|
|
6881
|
-
client.
|
|
6882
|
-
credit_type_ids: ["credit_type_ids"],
|
|
6883
|
-
has_scheduled_downgrade: true,
|
|
6884
|
-
ids: ["ids"],
|
|
6885
|
-
monetized_subscriptions: true,
|
|
6886
|
-
plan_id: "plan_id",
|
|
6887
|
-
plan_ids: ["plan_ids"],
|
|
6888
|
-
plan_version_id: "plan_version_id",
|
|
6889
|
-
plan_version_ids: ["plan_version_ids"],
|
|
6890
|
-
q: "q",
|
|
6891
|
-
sort_order_column: "sort_order_column",
|
|
6892
|
-
sort_order_direction: "asc",
|
|
6893
|
-
subscription_statuses: ["active"],
|
|
6894
|
-
subscription_types: ["free"],
|
|
6895
|
-
with_entitlement_for: "with_entitlement_for",
|
|
6896
|
-
without_feature_override_for: "without_feature_override_for",
|
|
6897
|
-
without_plan: true,
|
|
6898
|
-
without_subscription: true,
|
|
6899
|
-
with_subscription: true,
|
|
6900
|
-
limit: 1000000,
|
|
6901
|
-
offset: 1000000
|
|
6902
|
-
)
|
|
6800
|
+
client.catalogs.update_configuration(catalog_id: "catalog_id")
|
|
6903
6801
|
```
|
|
6904
6802
|
</dd>
|
|
6905
6803
|
</dl>
|
|
@@ -6914,7 +6812,7 @@ client.companies.list_companies(
|
|
|
6914
6812
|
<dl>
|
|
6915
6813
|
<dd>
|
|
6916
6814
|
|
|
6917
|
-
**
|
|
6815
|
+
**catalog_id:** `String` — catalog_id
|
|
6918
6816
|
|
|
6919
6817
|
</dd>
|
|
6920
6818
|
</dl>
|
|
@@ -6922,7 +6820,7 @@ client.companies.list_companies(
|
|
|
6922
6820
|
<dl>
|
|
6923
6821
|
<dd>
|
|
6924
6822
|
|
|
6925
|
-
**
|
|
6823
|
+
**custom_plan_cta_text:** `String`
|
|
6926
6824
|
|
|
6927
6825
|
</dd>
|
|
6928
6826
|
</dl>
|
|
@@ -6930,7 +6828,7 @@ client.companies.list_companies(
|
|
|
6930
6828
|
<dl>
|
|
6931
6829
|
<dd>
|
|
6932
6830
|
|
|
6933
|
-
**
|
|
6831
|
+
**custom_plan_cta_url:** `String`
|
|
6934
6832
|
|
|
6935
6833
|
</dd>
|
|
6936
6834
|
</dl>
|
|
@@ -6938,7 +6836,7 @@ client.companies.list_companies(
|
|
|
6938
6836
|
<dl>
|
|
6939
6837
|
<dd>
|
|
6940
6838
|
|
|
6941
|
-
**
|
|
6839
|
+
**custom_plan_price_text:** `String`
|
|
6942
6840
|
|
|
6943
6841
|
</dd>
|
|
6944
6842
|
</dl>
|
|
@@ -6946,7 +6844,7 @@ client.companies.list_companies(
|
|
|
6946
6844
|
<dl>
|
|
6947
6845
|
<dd>
|
|
6948
6846
|
|
|
6949
|
-
**
|
|
6847
|
+
**custom_plans_visible:** `Internal::Types::Boolean`
|
|
6950
6848
|
|
|
6951
6849
|
</dd>
|
|
6952
6850
|
</dl>
|
|
@@ -6954,7 +6852,7 @@ client.companies.list_companies(
|
|
|
6954
6852
|
<dl>
|
|
6955
6853
|
<dd>
|
|
6956
6854
|
|
|
6957
|
-
**
|
|
6855
|
+
**ordered_add_ons:** `Internal::Types::Array[Schematic::Types::CatalogConfigOrderedPlan]`
|
|
6958
6856
|
|
|
6959
6857
|
</dd>
|
|
6960
6858
|
</dl>
|
|
@@ -6962,7 +6860,7 @@ client.companies.list_companies(
|
|
|
6962
6860
|
<dl>
|
|
6963
6861
|
<dd>
|
|
6964
6862
|
|
|
6965
|
-
**
|
|
6863
|
+
**ordered_bundles:** `Internal::Types::Array[Schematic::Types::CatalogConfigOrderedBundle]`
|
|
6966
6864
|
|
|
6967
6865
|
</dd>
|
|
6968
6866
|
</dl>
|
|
@@ -6970,7 +6868,7 @@ client.companies.list_companies(
|
|
|
6970
6868
|
<dl>
|
|
6971
6869
|
<dd>
|
|
6972
6870
|
|
|
6973
|
-
**
|
|
6871
|
+
**ordered_plans:** `Internal::Types::Array[Schematic::Types::CatalogConfigOrderedPlan]`
|
|
6974
6872
|
|
|
6975
6873
|
</dd>
|
|
6976
6874
|
</dl>
|
|
@@ -6978,7 +6876,7 @@ client.companies.list_companies(
|
|
|
6978
6876
|
<dl>
|
|
6979
6877
|
<dd>
|
|
6980
6878
|
|
|
6981
|
-
**
|
|
6879
|
+
**pricing_model:** `String`
|
|
6982
6880
|
|
|
6983
6881
|
</dd>
|
|
6984
6882
|
</dl>
|
|
@@ -6986,7 +6884,7 @@ client.companies.list_companies(
|
|
|
6986
6884
|
<dl>
|
|
6987
6885
|
<dd>
|
|
6988
6886
|
|
|
6989
|
-
**
|
|
6887
|
+
**pricing_url:** `String`
|
|
6990
6888
|
|
|
6991
6889
|
</dd>
|
|
6992
6890
|
</dl>
|
|
@@ -6994,32 +6892,1147 @@ client.companies.list_companies(
|
|
|
6994
6892
|
<dl>
|
|
6995
6893
|
<dd>
|
|
6996
6894
|
|
|
6997
|
-
**
|
|
6895
|
+
**request_options:** `Schematic::Catalogs::RequestOptions`
|
|
6998
6896
|
|
|
6999
6897
|
</dd>
|
|
7000
6898
|
</dl>
|
|
6899
|
+
</dd>
|
|
6900
|
+
</dl>
|
|
7001
6901
|
|
|
7002
|
-
<dl>
|
|
7003
|
-
<dd>
|
|
7004
6902
|
|
|
7005
|
-
**subscription_statuses:** `Schematic::Types::SubscriptionStatus` — Filter companies by one or more subscription statuses
|
|
7006
|
-
|
|
7007
6903
|
</dd>
|
|
7008
6904
|
</dl>
|
|
6905
|
+
</details>
|
|
7009
6906
|
|
|
6907
|
+
<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>
|
|
7010
6908
|
<dl>
|
|
7011
6909
|
<dd>
|
|
7012
6910
|
|
|
7013
|
-
|
|
7014
|
-
|
|
7015
|
-
</dd>
|
|
7016
|
-
</dl>
|
|
6911
|
+
#### 🔌 Usage
|
|
7017
6912
|
|
|
7018
6913
|
<dl>
|
|
7019
6914
|
<dd>
|
|
7020
6915
|
|
|
7021
|
-
|
|
7022
|
-
|
|
6916
|
+
<dl>
|
|
6917
|
+
<dd>
|
|
6918
|
+
|
|
6919
|
+
```ruby
|
|
6920
|
+
client.catalogs.get_credit_bundles_in_catalog(catalog_id: "catalog_id")
|
|
6921
|
+
```
|
|
6922
|
+
</dd>
|
|
6923
|
+
</dl>
|
|
6924
|
+
</dd>
|
|
6925
|
+
</dl>
|
|
6926
|
+
|
|
6927
|
+
#### ⚙️ Parameters
|
|
6928
|
+
|
|
6929
|
+
<dl>
|
|
6930
|
+
<dd>
|
|
6931
|
+
|
|
6932
|
+
<dl>
|
|
6933
|
+
<dd>
|
|
6934
|
+
|
|
6935
|
+
**catalog_id:** `String` — catalog_id
|
|
6936
|
+
|
|
6937
|
+
</dd>
|
|
6938
|
+
</dl>
|
|
6939
|
+
|
|
6940
|
+
<dl>
|
|
6941
|
+
<dd>
|
|
6942
|
+
|
|
6943
|
+
**request_options:** `Schematic::Catalogs::RequestOptions`
|
|
6944
|
+
|
|
6945
|
+
</dd>
|
|
6946
|
+
</dl>
|
|
6947
|
+
</dd>
|
|
6948
|
+
</dl>
|
|
6949
|
+
|
|
6950
|
+
|
|
6951
|
+
</dd>
|
|
6952
|
+
</dl>
|
|
6953
|
+
</details>
|
|
6954
|
+
|
|
6955
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">add_credit_bundle</a>(catalog_id, credit_bundle_id) -> </code></summary>
|
|
6956
|
+
<dl>
|
|
6957
|
+
<dd>
|
|
6958
|
+
|
|
6959
|
+
#### 🔌 Usage
|
|
6960
|
+
|
|
6961
|
+
<dl>
|
|
6962
|
+
<dd>
|
|
6963
|
+
|
|
6964
|
+
<dl>
|
|
6965
|
+
<dd>
|
|
6966
|
+
|
|
6967
|
+
```ruby
|
|
6968
|
+
client.catalogs.add_credit_bundle(
|
|
6969
|
+
catalog_id: "catalog_id",
|
|
6970
|
+
credit_bundle_id: "credit_bundle_id"
|
|
6971
|
+
)
|
|
6972
|
+
```
|
|
6973
|
+
</dd>
|
|
6974
|
+
</dl>
|
|
6975
|
+
</dd>
|
|
6976
|
+
</dl>
|
|
6977
|
+
|
|
6978
|
+
#### ⚙️ Parameters
|
|
6979
|
+
|
|
6980
|
+
<dl>
|
|
6981
|
+
<dd>
|
|
6982
|
+
|
|
6983
|
+
<dl>
|
|
6984
|
+
<dd>
|
|
6985
|
+
|
|
6986
|
+
**catalog_id:** `String` — catalog_id
|
|
6987
|
+
|
|
6988
|
+
</dd>
|
|
6989
|
+
</dl>
|
|
6990
|
+
|
|
6991
|
+
<dl>
|
|
6992
|
+
<dd>
|
|
6993
|
+
|
|
6994
|
+
**credit_bundle_id:** `String` — credit_bundle_id
|
|
6995
|
+
|
|
6996
|
+
</dd>
|
|
6997
|
+
</dl>
|
|
6998
|
+
|
|
6999
|
+
<dl>
|
|
7000
|
+
<dd>
|
|
7001
|
+
|
|
7002
|
+
**request_options:** `Schematic::Catalogs::RequestOptions`
|
|
7003
|
+
|
|
7004
|
+
</dd>
|
|
7005
|
+
</dl>
|
|
7006
|
+
</dd>
|
|
7007
|
+
</dl>
|
|
7008
|
+
|
|
7009
|
+
|
|
7010
|
+
</dd>
|
|
7011
|
+
</dl>
|
|
7012
|
+
</details>
|
|
7013
|
+
|
|
7014
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">remove_credit_bundle</a>(catalog_id, credit_bundle_id) -> </code></summary>
|
|
7015
|
+
<dl>
|
|
7016
|
+
<dd>
|
|
7017
|
+
|
|
7018
|
+
#### 🔌 Usage
|
|
7019
|
+
|
|
7020
|
+
<dl>
|
|
7021
|
+
<dd>
|
|
7022
|
+
|
|
7023
|
+
<dl>
|
|
7024
|
+
<dd>
|
|
7025
|
+
|
|
7026
|
+
```ruby
|
|
7027
|
+
client.catalogs.remove_credit_bundle(
|
|
7028
|
+
catalog_id: "catalog_id",
|
|
7029
|
+
credit_bundle_id: "credit_bundle_id"
|
|
7030
|
+
)
|
|
7031
|
+
```
|
|
7032
|
+
</dd>
|
|
7033
|
+
</dl>
|
|
7034
|
+
</dd>
|
|
7035
|
+
</dl>
|
|
7036
|
+
|
|
7037
|
+
#### ⚙️ Parameters
|
|
7038
|
+
|
|
7039
|
+
<dl>
|
|
7040
|
+
<dd>
|
|
7041
|
+
|
|
7042
|
+
<dl>
|
|
7043
|
+
<dd>
|
|
7044
|
+
|
|
7045
|
+
**catalog_id:** `String` — catalog_id
|
|
7046
|
+
|
|
7047
|
+
</dd>
|
|
7048
|
+
</dl>
|
|
7049
|
+
|
|
7050
|
+
<dl>
|
|
7051
|
+
<dd>
|
|
7052
|
+
|
|
7053
|
+
**credit_bundle_id:** `String` — credit_bundle_id
|
|
7054
|
+
|
|
7055
|
+
</dd>
|
|
7056
|
+
</dl>
|
|
7057
|
+
|
|
7058
|
+
<dl>
|
|
7059
|
+
<dd>
|
|
7060
|
+
|
|
7061
|
+
**request_options:** `Schematic::Catalogs::RequestOptions`
|
|
7062
|
+
|
|
7063
|
+
</dd>
|
|
7064
|
+
</dl>
|
|
7065
|
+
</dd>
|
|
7066
|
+
</dl>
|
|
7067
|
+
|
|
7068
|
+
|
|
7069
|
+
</dd>
|
|
7070
|
+
</dl>
|
|
7071
|
+
</details>
|
|
7072
|
+
|
|
7073
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_derived_features</a>(catalog_id) -> Schematic::Catalogs::Types::GetDerivedFeaturesResponse</code></summary>
|
|
7074
|
+
<dl>
|
|
7075
|
+
<dd>
|
|
7076
|
+
|
|
7077
|
+
#### 🔌 Usage
|
|
7078
|
+
|
|
7079
|
+
<dl>
|
|
7080
|
+
<dd>
|
|
7081
|
+
|
|
7082
|
+
<dl>
|
|
7083
|
+
<dd>
|
|
7084
|
+
|
|
7085
|
+
```ruby
|
|
7086
|
+
client.catalogs.get_derived_features(catalog_id: "catalog_id")
|
|
7087
|
+
```
|
|
7088
|
+
</dd>
|
|
7089
|
+
</dl>
|
|
7090
|
+
</dd>
|
|
7091
|
+
</dl>
|
|
7092
|
+
|
|
7093
|
+
#### ⚙️ Parameters
|
|
7094
|
+
|
|
7095
|
+
<dl>
|
|
7096
|
+
<dd>
|
|
7097
|
+
|
|
7098
|
+
<dl>
|
|
7099
|
+
<dd>
|
|
7100
|
+
|
|
7101
|
+
**catalog_id:** `String` — catalog_id
|
|
7102
|
+
|
|
7103
|
+
</dd>
|
|
7104
|
+
</dl>
|
|
7105
|
+
|
|
7106
|
+
<dl>
|
|
7107
|
+
<dd>
|
|
7108
|
+
|
|
7109
|
+
**request_options:** `Schematic::Catalogs::RequestOptions`
|
|
7110
|
+
|
|
7111
|
+
</dd>
|
|
7112
|
+
</dl>
|
|
7113
|
+
</dd>
|
|
7114
|
+
</dl>
|
|
7115
|
+
|
|
7116
|
+
|
|
7117
|
+
</dd>
|
|
7118
|
+
</dl>
|
|
7119
|
+
</details>
|
|
7120
|
+
|
|
7121
|
+
<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>
|
|
7122
|
+
<dl>
|
|
7123
|
+
<dd>
|
|
7124
|
+
|
|
7125
|
+
#### 🔌 Usage
|
|
7126
|
+
|
|
7127
|
+
<dl>
|
|
7128
|
+
<dd>
|
|
7129
|
+
|
|
7130
|
+
<dl>
|
|
7131
|
+
<dd>
|
|
7132
|
+
|
|
7133
|
+
```ruby
|
|
7134
|
+
client.catalogs.get_plans_in_catalog(catalog_id: "catalog_id")
|
|
7135
|
+
```
|
|
7136
|
+
</dd>
|
|
7137
|
+
</dl>
|
|
7138
|
+
</dd>
|
|
7139
|
+
</dl>
|
|
7140
|
+
|
|
7141
|
+
#### ⚙️ Parameters
|
|
7142
|
+
|
|
7143
|
+
<dl>
|
|
7144
|
+
<dd>
|
|
7145
|
+
|
|
7146
|
+
<dl>
|
|
7147
|
+
<dd>
|
|
7148
|
+
|
|
7149
|
+
**catalog_id:** `String` — catalog_id
|
|
7150
|
+
|
|
7151
|
+
</dd>
|
|
7152
|
+
</dl>
|
|
7153
|
+
|
|
7154
|
+
<dl>
|
|
7155
|
+
<dd>
|
|
7156
|
+
|
|
7157
|
+
**request_options:** `Schematic::Catalogs::RequestOptions`
|
|
7158
|
+
|
|
7159
|
+
</dd>
|
|
7160
|
+
</dl>
|
|
7161
|
+
</dd>
|
|
7162
|
+
</dl>
|
|
7163
|
+
|
|
7164
|
+
|
|
7165
|
+
</dd>
|
|
7166
|
+
</dl>
|
|
7167
|
+
</details>
|
|
7168
|
+
|
|
7169
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">add_plan</a>(catalog_id, plan_id) -> </code></summary>
|
|
7170
|
+
<dl>
|
|
7171
|
+
<dd>
|
|
7172
|
+
|
|
7173
|
+
#### 🔌 Usage
|
|
7174
|
+
|
|
7175
|
+
<dl>
|
|
7176
|
+
<dd>
|
|
7177
|
+
|
|
7178
|
+
<dl>
|
|
7179
|
+
<dd>
|
|
7180
|
+
|
|
7181
|
+
```ruby
|
|
7182
|
+
client.catalogs.add_plan(
|
|
7183
|
+
catalog_id: "catalog_id",
|
|
7184
|
+
plan_id: "plan_id"
|
|
7185
|
+
)
|
|
7186
|
+
```
|
|
7187
|
+
</dd>
|
|
7188
|
+
</dl>
|
|
7189
|
+
</dd>
|
|
7190
|
+
</dl>
|
|
7191
|
+
|
|
7192
|
+
#### ⚙️ Parameters
|
|
7193
|
+
|
|
7194
|
+
<dl>
|
|
7195
|
+
<dd>
|
|
7196
|
+
|
|
7197
|
+
<dl>
|
|
7198
|
+
<dd>
|
|
7199
|
+
|
|
7200
|
+
**catalog_id:** `String` — catalog_id
|
|
7201
|
+
|
|
7202
|
+
</dd>
|
|
7203
|
+
</dl>
|
|
7204
|
+
|
|
7205
|
+
<dl>
|
|
7206
|
+
<dd>
|
|
7207
|
+
|
|
7208
|
+
**plan_id:** `String` — plan_id
|
|
7209
|
+
|
|
7210
|
+
</dd>
|
|
7211
|
+
</dl>
|
|
7212
|
+
|
|
7213
|
+
<dl>
|
|
7214
|
+
<dd>
|
|
7215
|
+
|
|
7216
|
+
**request_options:** `Schematic::Catalogs::RequestOptions`
|
|
7217
|
+
|
|
7218
|
+
</dd>
|
|
7219
|
+
</dl>
|
|
7220
|
+
</dd>
|
|
7221
|
+
</dl>
|
|
7222
|
+
|
|
7223
|
+
|
|
7224
|
+
</dd>
|
|
7225
|
+
</dl>
|
|
7226
|
+
</details>
|
|
7227
|
+
|
|
7228
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">remove_plan</a>(catalog_id, plan_id) -> </code></summary>
|
|
7229
|
+
<dl>
|
|
7230
|
+
<dd>
|
|
7231
|
+
|
|
7232
|
+
#### 🔌 Usage
|
|
7233
|
+
|
|
7234
|
+
<dl>
|
|
7235
|
+
<dd>
|
|
7236
|
+
|
|
7237
|
+
<dl>
|
|
7238
|
+
<dd>
|
|
7239
|
+
|
|
7240
|
+
```ruby
|
|
7241
|
+
client.catalogs.remove_plan(
|
|
7242
|
+
catalog_id: "catalog_id",
|
|
7243
|
+
plan_id: "plan_id"
|
|
7244
|
+
)
|
|
7245
|
+
```
|
|
7246
|
+
</dd>
|
|
7247
|
+
</dl>
|
|
7248
|
+
</dd>
|
|
7249
|
+
</dl>
|
|
7250
|
+
|
|
7251
|
+
#### ⚙️ Parameters
|
|
7252
|
+
|
|
7253
|
+
<dl>
|
|
7254
|
+
<dd>
|
|
7255
|
+
|
|
7256
|
+
<dl>
|
|
7257
|
+
<dd>
|
|
7258
|
+
|
|
7259
|
+
**catalog_id:** `String` — catalog_id
|
|
7260
|
+
|
|
7261
|
+
</dd>
|
|
7262
|
+
</dl>
|
|
7263
|
+
|
|
7264
|
+
<dl>
|
|
7265
|
+
<dd>
|
|
7266
|
+
|
|
7267
|
+
**plan_id:** `String` — plan_id
|
|
7268
|
+
|
|
7269
|
+
</dd>
|
|
7270
|
+
</dl>
|
|
7271
|
+
|
|
7272
|
+
<dl>
|
|
7273
|
+
<dd>
|
|
7274
|
+
|
|
7275
|
+
**request_options:** `Schematic::Catalogs::RequestOptions`
|
|
7276
|
+
|
|
7277
|
+
</dd>
|
|
7278
|
+
</dl>
|
|
7279
|
+
</dd>
|
|
7280
|
+
</dl>
|
|
7281
|
+
|
|
7282
|
+
|
|
7283
|
+
</dd>
|
|
7284
|
+
</dl>
|
|
7285
|
+
</details>
|
|
7286
|
+
|
|
7287
|
+
## checkout
|
|
7288
|
+
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">internal</a>(request) -> Schematic::Checkout::Types::CheckoutInternalResponse</code></summary>
|
|
7289
|
+
<dl>
|
|
7290
|
+
<dd>
|
|
7291
|
+
|
|
7292
|
+
#### 🔌 Usage
|
|
7293
|
+
|
|
7294
|
+
<dl>
|
|
7295
|
+
<dd>
|
|
7296
|
+
|
|
7297
|
+
<dl>
|
|
7298
|
+
<dd>
|
|
7299
|
+
|
|
7300
|
+
```ruby
|
|
7301
|
+
client.checkout.internal(
|
|
7302
|
+
add_on_ids: [{
|
|
7303
|
+
add_on_id: "add_on_id",
|
|
7304
|
+
price_id: "price_id"
|
|
7305
|
+
}],
|
|
7306
|
+
auto_topup_overrides: [{
|
|
7307
|
+
plan_credit_grant_id: "plan_credit_grant_id"
|
|
7308
|
+
}],
|
|
7309
|
+
company_id: "company_id",
|
|
7310
|
+
credit_bundles: [{
|
|
7311
|
+
bundle_id: "bundle_id",
|
|
7312
|
+
quantity: 1000000
|
|
7313
|
+
}],
|
|
7314
|
+
custom_field_values: [{
|
|
7315
|
+
id: "id",
|
|
7316
|
+
value: "value"
|
|
7317
|
+
}],
|
|
7318
|
+
new_plan_id: "new_plan_id",
|
|
7319
|
+
new_price_id: "new_price_id",
|
|
7320
|
+
pay_in_advance: [{
|
|
7321
|
+
price_id: "price_id",
|
|
7322
|
+
quantity: 1000000
|
|
7323
|
+
}],
|
|
7324
|
+
skip_trial: true
|
|
7325
|
+
)
|
|
7326
|
+
```
|
|
7327
|
+
</dd>
|
|
7328
|
+
</dl>
|
|
7329
|
+
</dd>
|
|
7330
|
+
</dl>
|
|
7331
|
+
|
|
7332
|
+
#### ⚙️ Parameters
|
|
7333
|
+
|
|
7334
|
+
<dl>
|
|
7335
|
+
<dd>
|
|
7336
|
+
|
|
7337
|
+
<dl>
|
|
7338
|
+
<dd>
|
|
7339
|
+
|
|
7340
|
+
**request:** `Schematic::Types::ChangeSubscriptionInternalRequestBody`
|
|
7341
|
+
|
|
7342
|
+
</dd>
|
|
7343
|
+
</dl>
|
|
7344
|
+
|
|
7345
|
+
<dl>
|
|
7346
|
+
<dd>
|
|
7347
|
+
|
|
7348
|
+
**request_options:** `Schematic::Checkout::RequestOptions`
|
|
7349
|
+
|
|
7350
|
+
</dd>
|
|
7351
|
+
</dl>
|
|
7352
|
+
</dd>
|
|
7353
|
+
</dl>
|
|
7354
|
+
|
|
7355
|
+
|
|
7356
|
+
</dd>
|
|
7357
|
+
</dl>
|
|
7358
|
+
</details>
|
|
7359
|
+
|
|
7360
|
+
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">get_checkout_data</a>(request) -> Schematic::Checkout::Types::GetCheckoutDataResponse</code></summary>
|
|
7361
|
+
<dl>
|
|
7362
|
+
<dd>
|
|
7363
|
+
|
|
7364
|
+
#### 🔌 Usage
|
|
7365
|
+
|
|
7366
|
+
<dl>
|
|
7367
|
+
<dd>
|
|
7368
|
+
|
|
7369
|
+
<dl>
|
|
7370
|
+
<dd>
|
|
7371
|
+
|
|
7372
|
+
```ruby
|
|
7373
|
+
client.checkout.get_checkout_data(company_id: "company_id")
|
|
7374
|
+
```
|
|
7375
|
+
</dd>
|
|
7376
|
+
</dl>
|
|
7377
|
+
</dd>
|
|
7378
|
+
</dl>
|
|
7379
|
+
|
|
7380
|
+
#### ⚙️ Parameters
|
|
7381
|
+
|
|
7382
|
+
<dl>
|
|
7383
|
+
<dd>
|
|
7384
|
+
|
|
7385
|
+
<dl>
|
|
7386
|
+
<dd>
|
|
7387
|
+
|
|
7388
|
+
**company_id:** `String`
|
|
7389
|
+
|
|
7390
|
+
</dd>
|
|
7391
|
+
</dl>
|
|
7392
|
+
|
|
7393
|
+
<dl>
|
|
7394
|
+
<dd>
|
|
7395
|
+
|
|
7396
|
+
**currency:** `String`
|
|
7397
|
+
|
|
7398
|
+
</dd>
|
|
7399
|
+
</dl>
|
|
7400
|
+
|
|
7401
|
+
<dl>
|
|
7402
|
+
<dd>
|
|
7403
|
+
|
|
7404
|
+
**selected_plan_id:** `String`
|
|
7405
|
+
|
|
7406
|
+
</dd>
|
|
7407
|
+
</dl>
|
|
7408
|
+
|
|
7409
|
+
<dl>
|
|
7410
|
+
<dd>
|
|
7411
|
+
|
|
7412
|
+
**request_options:** `Schematic::Checkout::RequestOptions`
|
|
7413
|
+
|
|
7414
|
+
</dd>
|
|
7415
|
+
</dl>
|
|
7416
|
+
</dd>
|
|
7417
|
+
</dl>
|
|
7418
|
+
|
|
7419
|
+
|
|
7420
|
+
</dd>
|
|
7421
|
+
</dl>
|
|
7422
|
+
</details>
|
|
7423
|
+
|
|
7424
|
+
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">preview_checkout_internal</a>(request) -> Schematic::Checkout::Types::PreviewCheckoutInternalResponse</code></summary>
|
|
7425
|
+
<dl>
|
|
7426
|
+
<dd>
|
|
7427
|
+
|
|
7428
|
+
#### 🔌 Usage
|
|
7429
|
+
|
|
7430
|
+
<dl>
|
|
7431
|
+
<dd>
|
|
7432
|
+
|
|
7433
|
+
<dl>
|
|
7434
|
+
<dd>
|
|
7435
|
+
|
|
7436
|
+
```ruby
|
|
7437
|
+
client.checkout.preview_checkout_internal(
|
|
7438
|
+
add_on_ids: [{
|
|
7439
|
+
add_on_id: "add_on_id",
|
|
7440
|
+
price_id: "price_id"
|
|
7441
|
+
}],
|
|
7442
|
+
auto_topup_overrides: [{
|
|
7443
|
+
plan_credit_grant_id: "plan_credit_grant_id"
|
|
7444
|
+
}],
|
|
7445
|
+
company_id: "company_id",
|
|
7446
|
+
credit_bundles: [{
|
|
7447
|
+
bundle_id: "bundle_id",
|
|
7448
|
+
quantity: 1000000
|
|
7449
|
+
}],
|
|
7450
|
+
custom_field_values: [{
|
|
7451
|
+
id: "id",
|
|
7452
|
+
value: "value"
|
|
7453
|
+
}],
|
|
7454
|
+
new_plan_id: "new_plan_id",
|
|
7455
|
+
new_price_id: "new_price_id",
|
|
7456
|
+
pay_in_advance: [{
|
|
7457
|
+
price_id: "price_id",
|
|
7458
|
+
quantity: 1000000
|
|
7459
|
+
}],
|
|
7460
|
+
skip_trial: true
|
|
7461
|
+
)
|
|
7462
|
+
```
|
|
7463
|
+
</dd>
|
|
7464
|
+
</dl>
|
|
7465
|
+
</dd>
|
|
7466
|
+
</dl>
|
|
7467
|
+
|
|
7468
|
+
#### ⚙️ Parameters
|
|
7469
|
+
|
|
7470
|
+
<dl>
|
|
7471
|
+
<dd>
|
|
7472
|
+
|
|
7473
|
+
<dl>
|
|
7474
|
+
<dd>
|
|
7475
|
+
|
|
7476
|
+
**request:** `Schematic::Types::ChangeSubscriptionInternalRequestBody`
|
|
7477
|
+
|
|
7478
|
+
</dd>
|
|
7479
|
+
</dl>
|
|
7480
|
+
|
|
7481
|
+
<dl>
|
|
7482
|
+
<dd>
|
|
7483
|
+
|
|
7484
|
+
**request_options:** `Schematic::Checkout::RequestOptions`
|
|
7485
|
+
|
|
7486
|
+
</dd>
|
|
7487
|
+
</dl>
|
|
7488
|
+
</dd>
|
|
7489
|
+
</dl>
|
|
7490
|
+
|
|
7491
|
+
|
|
7492
|
+
</dd>
|
|
7493
|
+
</dl>
|
|
7494
|
+
</details>
|
|
7495
|
+
|
|
7496
|
+
<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>
|
|
7497
|
+
<dl>
|
|
7498
|
+
<dd>
|
|
7499
|
+
|
|
7500
|
+
#### 🔌 Usage
|
|
7501
|
+
|
|
7502
|
+
<dl>
|
|
7503
|
+
<dd>
|
|
7504
|
+
|
|
7505
|
+
<dl>
|
|
7506
|
+
<dd>
|
|
7507
|
+
|
|
7508
|
+
```ruby
|
|
7509
|
+
client.checkout.get_company_billing_details(company_id: "company_id")
|
|
7510
|
+
```
|
|
7511
|
+
</dd>
|
|
7512
|
+
</dl>
|
|
7513
|
+
</dd>
|
|
7514
|
+
</dl>
|
|
7515
|
+
|
|
7516
|
+
#### ⚙️ Parameters
|
|
7517
|
+
|
|
7518
|
+
<dl>
|
|
7519
|
+
<dd>
|
|
7520
|
+
|
|
7521
|
+
<dl>
|
|
7522
|
+
<dd>
|
|
7523
|
+
|
|
7524
|
+
**company_id:** `String` — company_id
|
|
7525
|
+
|
|
7526
|
+
</dd>
|
|
7527
|
+
</dl>
|
|
7528
|
+
|
|
7529
|
+
<dl>
|
|
7530
|
+
<dd>
|
|
7531
|
+
|
|
7532
|
+
**request_options:** `Schematic::Checkout::RequestOptions`
|
|
7533
|
+
|
|
7534
|
+
</dd>
|
|
7535
|
+
</dl>
|
|
7536
|
+
</dd>
|
|
7537
|
+
</dl>
|
|
7538
|
+
|
|
7539
|
+
|
|
7540
|
+
</dd>
|
|
7541
|
+
</dl>
|
|
7542
|
+
</details>
|
|
7543
|
+
|
|
7544
|
+
<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>
|
|
7545
|
+
<dl>
|
|
7546
|
+
<dd>
|
|
7547
|
+
|
|
7548
|
+
#### 🔌 Usage
|
|
7549
|
+
|
|
7550
|
+
<dl>
|
|
7551
|
+
<dd>
|
|
7552
|
+
|
|
7553
|
+
<dl>
|
|
7554
|
+
<dd>
|
|
7555
|
+
|
|
7556
|
+
```ruby
|
|
7557
|
+
client.checkout.update_company_billing_details(
|
|
7558
|
+
company_id: "company_id",
|
|
7559
|
+
values: [{
|
|
7560
|
+
id: "id",
|
|
7561
|
+
value: "value"
|
|
7562
|
+
}]
|
|
7563
|
+
)
|
|
7564
|
+
```
|
|
7565
|
+
</dd>
|
|
7566
|
+
</dl>
|
|
7567
|
+
</dd>
|
|
7568
|
+
</dl>
|
|
7569
|
+
|
|
7570
|
+
#### ⚙️ Parameters
|
|
7571
|
+
|
|
7572
|
+
<dl>
|
|
7573
|
+
<dd>
|
|
7574
|
+
|
|
7575
|
+
<dl>
|
|
7576
|
+
<dd>
|
|
7577
|
+
|
|
7578
|
+
**company_id:** `String` — company_id
|
|
7579
|
+
|
|
7580
|
+
</dd>
|
|
7581
|
+
</dl>
|
|
7582
|
+
|
|
7583
|
+
<dl>
|
|
7584
|
+
<dd>
|
|
7585
|
+
|
|
7586
|
+
**address:** `Schematic::Types::CustomerBillingAddress`
|
|
7587
|
+
|
|
7588
|
+
</dd>
|
|
7589
|
+
</dl>
|
|
7590
|
+
|
|
7591
|
+
<dl>
|
|
7592
|
+
<dd>
|
|
7593
|
+
|
|
7594
|
+
**email:** `String`
|
|
7595
|
+
|
|
7596
|
+
</dd>
|
|
7597
|
+
</dl>
|
|
7598
|
+
|
|
7599
|
+
<dl>
|
|
7600
|
+
<dd>
|
|
7601
|
+
|
|
7602
|
+
**phone:** `String`
|
|
7603
|
+
|
|
7604
|
+
</dd>
|
|
7605
|
+
</dl>
|
|
7606
|
+
|
|
7607
|
+
<dl>
|
|
7608
|
+
<dd>
|
|
7609
|
+
|
|
7610
|
+
**values:** `Internal::Types::Array[Schematic::Types::CheckoutFieldValue]`
|
|
7611
|
+
|
|
7612
|
+
</dd>
|
|
7613
|
+
</dl>
|
|
7614
|
+
|
|
7615
|
+
<dl>
|
|
7616
|
+
<dd>
|
|
7617
|
+
|
|
7618
|
+
**request_options:** `Schematic::Checkout::RequestOptions`
|
|
7619
|
+
|
|
7620
|
+
</dd>
|
|
7621
|
+
</dl>
|
|
7622
|
+
</dd>
|
|
7623
|
+
</dl>
|
|
7624
|
+
|
|
7625
|
+
|
|
7626
|
+
</dd>
|
|
7627
|
+
</dl>
|
|
7628
|
+
</details>
|
|
7629
|
+
|
|
7630
|
+
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">manage_plan</a>(request) -> Schematic::Checkout::Types::ManagePlanResponse</code></summary>
|
|
7631
|
+
<dl>
|
|
7632
|
+
<dd>
|
|
7633
|
+
|
|
7634
|
+
#### 🔌 Usage
|
|
7635
|
+
|
|
7636
|
+
<dl>
|
|
7637
|
+
<dd>
|
|
7638
|
+
|
|
7639
|
+
<dl>
|
|
7640
|
+
<dd>
|
|
7641
|
+
|
|
7642
|
+
```ruby
|
|
7643
|
+
client.checkout.manage_plan(
|
|
7644
|
+
add_on_selections: [{
|
|
7645
|
+
plan_id: "plan_id"
|
|
7646
|
+
}],
|
|
7647
|
+
company_id: "company_id",
|
|
7648
|
+
credit_bundles: [{
|
|
7649
|
+
bundle_id: "bundle_id",
|
|
7650
|
+
quantity: 1000000
|
|
7651
|
+
}],
|
|
7652
|
+
custom_field_values: [{
|
|
7653
|
+
id: "id",
|
|
7654
|
+
value: "value"
|
|
7655
|
+
}],
|
|
7656
|
+
pay_in_advance_entitlements: [{
|
|
7657
|
+
price_id: "price_id",
|
|
7658
|
+
quantity: 1000000
|
|
7659
|
+
}]
|
|
7660
|
+
)
|
|
7661
|
+
```
|
|
7662
|
+
</dd>
|
|
7663
|
+
</dl>
|
|
7664
|
+
</dd>
|
|
7665
|
+
</dl>
|
|
7666
|
+
|
|
7667
|
+
#### ⚙️ Parameters
|
|
7668
|
+
|
|
7669
|
+
<dl>
|
|
7670
|
+
<dd>
|
|
7671
|
+
|
|
7672
|
+
<dl>
|
|
7673
|
+
<dd>
|
|
7674
|
+
|
|
7675
|
+
**request:** `Schematic::Types::ManagePlanRequest`
|
|
7676
|
+
|
|
7677
|
+
</dd>
|
|
7678
|
+
</dl>
|
|
7679
|
+
|
|
7680
|
+
<dl>
|
|
7681
|
+
<dd>
|
|
7682
|
+
|
|
7683
|
+
**request_options:** `Schematic::Checkout::RequestOptions`
|
|
7684
|
+
|
|
7685
|
+
</dd>
|
|
7686
|
+
</dl>
|
|
7687
|
+
</dd>
|
|
7688
|
+
</dl>
|
|
7689
|
+
|
|
7690
|
+
|
|
7691
|
+
</dd>
|
|
7692
|
+
</dl>
|
|
7693
|
+
</details>
|
|
7694
|
+
|
|
7695
|
+
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">preview_manage_plan</a>(request) -> Schematic::Checkout::Types::PreviewManagePlanResponse</code></summary>
|
|
7696
|
+
<dl>
|
|
7697
|
+
<dd>
|
|
7698
|
+
|
|
7699
|
+
#### 🔌 Usage
|
|
7700
|
+
|
|
7701
|
+
<dl>
|
|
7702
|
+
<dd>
|
|
7703
|
+
|
|
7704
|
+
<dl>
|
|
7705
|
+
<dd>
|
|
7706
|
+
|
|
7707
|
+
```ruby
|
|
7708
|
+
client.checkout.preview_manage_plan(
|
|
7709
|
+
add_on_selections: [{
|
|
7710
|
+
plan_id: "plan_id"
|
|
7711
|
+
}],
|
|
7712
|
+
company_id: "company_id",
|
|
7713
|
+
credit_bundles: [{
|
|
7714
|
+
bundle_id: "bundle_id",
|
|
7715
|
+
quantity: 1000000
|
|
7716
|
+
}],
|
|
7717
|
+
custom_field_values: [{
|
|
7718
|
+
id: "id",
|
|
7719
|
+
value: "value"
|
|
7720
|
+
}],
|
|
7721
|
+
pay_in_advance_entitlements: [{
|
|
7722
|
+
price_id: "price_id",
|
|
7723
|
+
quantity: 1000000
|
|
7724
|
+
}]
|
|
7725
|
+
)
|
|
7726
|
+
```
|
|
7727
|
+
</dd>
|
|
7728
|
+
</dl>
|
|
7729
|
+
</dd>
|
|
7730
|
+
</dl>
|
|
7731
|
+
|
|
7732
|
+
#### ⚙️ Parameters
|
|
7733
|
+
|
|
7734
|
+
<dl>
|
|
7735
|
+
<dd>
|
|
7736
|
+
|
|
7737
|
+
<dl>
|
|
7738
|
+
<dd>
|
|
7739
|
+
|
|
7740
|
+
**request:** `Schematic::Types::ManagePlanRequest`
|
|
7741
|
+
|
|
7742
|
+
</dd>
|
|
7743
|
+
</dl>
|
|
7744
|
+
|
|
7745
|
+
<dl>
|
|
7746
|
+
<dd>
|
|
7747
|
+
|
|
7748
|
+
**request_options:** `Schematic::Checkout::RequestOptions`
|
|
7749
|
+
|
|
7750
|
+
</dd>
|
|
7751
|
+
</dl>
|
|
7752
|
+
</dd>
|
|
7753
|
+
</dl>
|
|
7754
|
+
|
|
7755
|
+
|
|
7756
|
+
</dd>
|
|
7757
|
+
</dl>
|
|
7758
|
+
</details>
|
|
7759
|
+
|
|
7760
|
+
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">cancel_subscription</a>(request) -> Schematic::Checkout::Types::CancelSubscriptionResponse</code></summary>
|
|
7761
|
+
<dl>
|
|
7762
|
+
<dd>
|
|
7763
|
+
|
|
7764
|
+
#### 🔌 Usage
|
|
7765
|
+
|
|
7766
|
+
<dl>
|
|
7767
|
+
<dd>
|
|
7768
|
+
|
|
7769
|
+
<dl>
|
|
7770
|
+
<dd>
|
|
7771
|
+
|
|
7772
|
+
```ruby
|
|
7773
|
+
client.checkout.cancel_subscription(company_id: "company_id")
|
|
7774
|
+
```
|
|
7775
|
+
</dd>
|
|
7776
|
+
</dl>
|
|
7777
|
+
</dd>
|
|
7778
|
+
</dl>
|
|
7779
|
+
|
|
7780
|
+
#### ⚙️ Parameters
|
|
7781
|
+
|
|
7782
|
+
<dl>
|
|
7783
|
+
<dd>
|
|
7784
|
+
|
|
7785
|
+
<dl>
|
|
7786
|
+
<dd>
|
|
7787
|
+
|
|
7788
|
+
**cancel_immediately:** `Internal::Types::Boolean` — If false, subscription cancels at period end. Defaults to true.
|
|
7789
|
+
|
|
7790
|
+
</dd>
|
|
7791
|
+
</dl>
|
|
7792
|
+
|
|
7793
|
+
<dl>
|
|
7794
|
+
<dd>
|
|
7795
|
+
|
|
7796
|
+
**company_id:** `String`
|
|
7797
|
+
|
|
7798
|
+
</dd>
|
|
7799
|
+
</dl>
|
|
7800
|
+
|
|
7801
|
+
<dl>
|
|
7802
|
+
<dd>
|
|
7803
|
+
|
|
7804
|
+
**prorate:** `Internal::Types::Boolean` — If true and cancel_immediately is true, issue prorated credit. Defaults to true.
|
|
7805
|
+
|
|
7806
|
+
</dd>
|
|
7807
|
+
</dl>
|
|
7808
|
+
|
|
7809
|
+
<dl>
|
|
7810
|
+
<dd>
|
|
7811
|
+
|
|
7812
|
+
**request_options:** `Schematic::Checkout::RequestOptions`
|
|
7813
|
+
|
|
7814
|
+
</dd>
|
|
7815
|
+
</dl>
|
|
7816
|
+
</dd>
|
|
7817
|
+
</dl>
|
|
7818
|
+
|
|
7819
|
+
|
|
7820
|
+
</dd>
|
|
7821
|
+
</dl>
|
|
7822
|
+
</details>
|
|
7823
|
+
|
|
7824
|
+
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">update_customer_subscription_trial_end</a>(subscription_id, request) -> Schematic::Checkout::Types::UpdateCustomerSubscriptionTrialEndResponse</code></summary>
|
|
7825
|
+
<dl>
|
|
7826
|
+
<dd>
|
|
7827
|
+
|
|
7828
|
+
#### 🔌 Usage
|
|
7829
|
+
|
|
7830
|
+
<dl>
|
|
7831
|
+
<dd>
|
|
7832
|
+
|
|
7833
|
+
<dl>
|
|
7834
|
+
<dd>
|
|
7835
|
+
|
|
7836
|
+
```ruby
|
|
7837
|
+
client.checkout.update_customer_subscription_trial_end(subscription_id: "subscription_id")
|
|
7838
|
+
```
|
|
7839
|
+
</dd>
|
|
7840
|
+
</dl>
|
|
7841
|
+
</dd>
|
|
7842
|
+
</dl>
|
|
7843
|
+
|
|
7844
|
+
#### ⚙️ Parameters
|
|
7845
|
+
|
|
7846
|
+
<dl>
|
|
7847
|
+
<dd>
|
|
7848
|
+
|
|
7849
|
+
<dl>
|
|
7850
|
+
<dd>
|
|
7851
|
+
|
|
7852
|
+
**subscription_id:** `String` — subscription_id
|
|
7853
|
+
|
|
7854
|
+
</dd>
|
|
7855
|
+
</dl>
|
|
7856
|
+
|
|
7857
|
+
<dl>
|
|
7858
|
+
<dd>
|
|
7859
|
+
|
|
7860
|
+
**trial_end:** `String`
|
|
7861
|
+
|
|
7862
|
+
</dd>
|
|
7863
|
+
</dl>
|
|
7864
|
+
|
|
7865
|
+
<dl>
|
|
7866
|
+
<dd>
|
|
7867
|
+
|
|
7868
|
+
**request_options:** `Schematic::Checkout::RequestOptions`
|
|
7869
|
+
|
|
7870
|
+
</dd>
|
|
7871
|
+
</dl>
|
|
7872
|
+
</dd>
|
|
7873
|
+
</dl>
|
|
7874
|
+
|
|
7875
|
+
|
|
7876
|
+
</dd>
|
|
7877
|
+
</dl>
|
|
7878
|
+
</details>
|
|
7879
|
+
|
|
7880
|
+
## companies
|
|
7881
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">list_companies</a>() -> Schematic::Companies::Types::ListCompaniesResponse</code></summary>
|
|
7882
|
+
<dl>
|
|
7883
|
+
<dd>
|
|
7884
|
+
|
|
7885
|
+
#### 🔌 Usage
|
|
7886
|
+
|
|
7887
|
+
<dl>
|
|
7888
|
+
<dd>
|
|
7889
|
+
|
|
7890
|
+
<dl>
|
|
7891
|
+
<dd>
|
|
7892
|
+
|
|
7893
|
+
```ruby
|
|
7894
|
+
client.companies.list_companies(
|
|
7895
|
+
credit_type_ids: ["credit_type_ids"],
|
|
7896
|
+
has_scheduled_downgrade: true,
|
|
7897
|
+
ids: ["ids"],
|
|
7898
|
+
monetized_subscriptions: true,
|
|
7899
|
+
plan_id: "plan_id",
|
|
7900
|
+
plan_ids: ["plan_ids"],
|
|
7901
|
+
plan_version_id: "plan_version_id",
|
|
7902
|
+
plan_version_ids: ["plan_version_ids"],
|
|
7903
|
+
q: "q",
|
|
7904
|
+
sort_order_column: "sort_order_column",
|
|
7905
|
+
sort_order_direction: "asc",
|
|
7906
|
+
subscription_statuses: ["active"],
|
|
7907
|
+
subscription_types: ["free"],
|
|
7908
|
+
with_entitlement_for: "with_entitlement_for",
|
|
7909
|
+
without_feature_override_for: "without_feature_override_for",
|
|
7910
|
+
without_plan: true,
|
|
7911
|
+
without_subscription: true,
|
|
7912
|
+
with_subscription: true,
|
|
7913
|
+
limit: 1000000,
|
|
7914
|
+
offset: 1000000
|
|
7915
|
+
)
|
|
7916
|
+
```
|
|
7917
|
+
</dd>
|
|
7918
|
+
</dl>
|
|
7919
|
+
</dd>
|
|
7920
|
+
</dl>
|
|
7921
|
+
|
|
7922
|
+
#### ⚙️ Parameters
|
|
7923
|
+
|
|
7924
|
+
<dl>
|
|
7925
|
+
<dd>
|
|
7926
|
+
|
|
7927
|
+
<dl>
|
|
7928
|
+
<dd>
|
|
7929
|
+
|
|
7930
|
+
**credit_type_ids:** `String` — Filter companies by one or more credit type IDs (each ID starts with bcrd_)
|
|
7931
|
+
|
|
7932
|
+
</dd>
|
|
7933
|
+
</dl>
|
|
7934
|
+
|
|
7935
|
+
<dl>
|
|
7936
|
+
<dd>
|
|
7937
|
+
|
|
7938
|
+
**has_scheduled_downgrade:** `Internal::Types::Boolean` — Filter companies that have a pending scheduled downgrade
|
|
7939
|
+
|
|
7940
|
+
</dd>
|
|
7941
|
+
</dl>
|
|
7942
|
+
|
|
7943
|
+
<dl>
|
|
7944
|
+
<dd>
|
|
7945
|
+
|
|
7946
|
+
**ids:** `String` — Filter companies by multiple company IDs (starts with comp_)
|
|
7947
|
+
|
|
7948
|
+
</dd>
|
|
7949
|
+
</dl>
|
|
7950
|
+
|
|
7951
|
+
<dl>
|
|
7952
|
+
<dd>
|
|
7953
|
+
|
|
7954
|
+
**monetized_subscriptions:** `Internal::Types::Boolean` — Filter companies that have monetized subscriptions
|
|
7955
|
+
|
|
7956
|
+
</dd>
|
|
7957
|
+
</dl>
|
|
7958
|
+
|
|
7959
|
+
<dl>
|
|
7960
|
+
<dd>
|
|
7961
|
+
|
|
7962
|
+
**plan_id:** `String` — Filter companies by plan ID (starts with plan_)
|
|
7963
|
+
|
|
7964
|
+
</dd>
|
|
7965
|
+
</dl>
|
|
7966
|
+
|
|
7967
|
+
<dl>
|
|
7968
|
+
<dd>
|
|
7969
|
+
|
|
7970
|
+
**plan_ids:** `String` — Filter companies by one or more plan IDs (each ID starts with plan_)
|
|
7971
|
+
|
|
7972
|
+
</dd>
|
|
7973
|
+
</dl>
|
|
7974
|
+
|
|
7975
|
+
<dl>
|
|
7976
|
+
<dd>
|
|
7977
|
+
|
|
7978
|
+
**plan_version_id:** `String` — Filter companies by plan version ID (starts with plvr_)
|
|
7979
|
+
|
|
7980
|
+
</dd>
|
|
7981
|
+
</dl>
|
|
7982
|
+
|
|
7983
|
+
<dl>
|
|
7984
|
+
<dd>
|
|
7985
|
+
|
|
7986
|
+
**plan_version_ids:** `String` — Filter companies by one or more plan version IDs (each ID starts with plvr_). Takes precedence over plan_version_id when set.
|
|
7987
|
+
|
|
7988
|
+
</dd>
|
|
7989
|
+
</dl>
|
|
7990
|
+
|
|
7991
|
+
<dl>
|
|
7992
|
+
<dd>
|
|
7993
|
+
|
|
7994
|
+
**q:** `String` — Search for companies by name, keys or string traits
|
|
7995
|
+
|
|
7996
|
+
</dd>
|
|
7997
|
+
</dl>
|
|
7998
|
+
|
|
7999
|
+
<dl>
|
|
8000
|
+
<dd>
|
|
8001
|
+
|
|
8002
|
+
**sort_order_column:** `String` — Column to sort by (e.g. name, created_at, last_seen_at)
|
|
8003
|
+
|
|
8004
|
+
</dd>
|
|
8005
|
+
</dl>
|
|
8006
|
+
|
|
8007
|
+
<dl>
|
|
8008
|
+
<dd>
|
|
8009
|
+
|
|
8010
|
+
**sort_order_direction:** `Schematic::Types::SortDirection` — Direction to sort by (asc or desc)
|
|
8011
|
+
|
|
8012
|
+
</dd>
|
|
8013
|
+
</dl>
|
|
8014
|
+
|
|
8015
|
+
<dl>
|
|
8016
|
+
<dd>
|
|
8017
|
+
|
|
8018
|
+
**subscription_statuses:** `Schematic::Types::SubscriptionStatus` — Filter companies by one or more subscription statuses
|
|
8019
|
+
|
|
8020
|
+
</dd>
|
|
8021
|
+
</dl>
|
|
8022
|
+
|
|
8023
|
+
<dl>
|
|
8024
|
+
<dd>
|
|
8025
|
+
|
|
8026
|
+
**subscription_types:** `Schematic::Types::SubscriptionType` — Filter companies by one or more subscription types
|
|
8027
|
+
|
|
8028
|
+
</dd>
|
|
8029
|
+
</dl>
|
|
8030
|
+
|
|
8031
|
+
<dl>
|
|
8032
|
+
<dd>
|
|
8033
|
+
|
|
8034
|
+
**with_entitlement_for:** `String` — Filter companies that have an entitlement (plan entitlement or company override) for the specified feature ID
|
|
8035
|
+
|
|
7023
8036
|
</dd>
|
|
7024
8037
|
</dl>
|
|
7025
8038
|
|
|
@@ -14210,6 +15223,62 @@ client.components.delete_component(component_id: "component_id")
|
|
|
14210
15223
|
</dl>
|
|
14211
15224
|
|
|
14212
15225
|
|
|
15226
|
+
</dd>
|
|
15227
|
+
</dl>
|
|
15228
|
+
</details>
|
|
15229
|
+
|
|
15230
|
+
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">bind_catalog</a>(component_id, request) -> Schematic::Components::Types::BindCatalogResponse</code></summary>
|
|
15231
|
+
<dl>
|
|
15232
|
+
<dd>
|
|
15233
|
+
|
|
15234
|
+
#### 🔌 Usage
|
|
15235
|
+
|
|
15236
|
+
<dl>
|
|
15237
|
+
<dd>
|
|
15238
|
+
|
|
15239
|
+
<dl>
|
|
15240
|
+
<dd>
|
|
15241
|
+
|
|
15242
|
+
```ruby
|
|
15243
|
+
client.components.bind_catalog(component_id: "component_id")
|
|
15244
|
+
```
|
|
15245
|
+
</dd>
|
|
15246
|
+
</dl>
|
|
15247
|
+
</dd>
|
|
15248
|
+
</dl>
|
|
15249
|
+
|
|
15250
|
+
#### ⚙️ Parameters
|
|
15251
|
+
|
|
15252
|
+
<dl>
|
|
15253
|
+
<dd>
|
|
15254
|
+
|
|
15255
|
+
<dl>
|
|
15256
|
+
<dd>
|
|
15257
|
+
|
|
15258
|
+
**component_id:** `String` — component_id
|
|
15259
|
+
|
|
15260
|
+
</dd>
|
|
15261
|
+
</dl>
|
|
15262
|
+
|
|
15263
|
+
<dl>
|
|
15264
|
+
<dd>
|
|
15265
|
+
|
|
15266
|
+
**catalog_id:** `String`
|
|
15267
|
+
|
|
15268
|
+
</dd>
|
|
15269
|
+
</dl>
|
|
15270
|
+
|
|
15271
|
+
<dl>
|
|
15272
|
+
<dd>
|
|
15273
|
+
|
|
15274
|
+
**request_options:** `Schematic::Components::RequestOptions`
|
|
15275
|
+
|
|
15276
|
+
</dd>
|
|
15277
|
+
</dl>
|
|
15278
|
+
</dd>
|
|
15279
|
+
</dl>
|
|
15280
|
+
|
|
15281
|
+
|
|
14213
15282
|
</dd>
|
|
14214
15283
|
</dl>
|
|
14215
15284
|
</details>
|
|
@@ -14380,6 +15449,14 @@ client.planbundle.create_custom_plan_bundle(entitlements: [{
|
|
|
14380
15449
|
<dl>
|
|
14381
15450
|
<dd>
|
|
14382
15451
|
|
|
15452
|
+
**credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
|
|
15453
|
+
|
|
15454
|
+
</dd>
|
|
15455
|
+
</dl>
|
|
15456
|
+
|
|
15457
|
+
<dl>
|
|
15458
|
+
<dd>
|
|
15459
|
+
|
|
14383
15460
|
**entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
|
|
14384
15461
|
|
|
14385
15462
|
</dd>
|
|
@@ -14531,7 +15608,85 @@ client.planbundle.update_plan_bundle(
|
|
|
14531
15608
|
<dl>
|
|
14532
15609
|
<dd>
|
|
14533
15610
|
|
|
14534
|
-
**credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
|
|
15611
|
+
**credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
|
|
15612
|
+
|
|
15613
|
+
</dd>
|
|
15614
|
+
</dl>
|
|
15615
|
+
|
|
15616
|
+
<dl>
|
|
15617
|
+
<dd>
|
|
15618
|
+
|
|
15619
|
+
**entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
|
|
15620
|
+
|
|
15621
|
+
</dd>
|
|
15622
|
+
</dl>
|
|
15623
|
+
|
|
15624
|
+
<dl>
|
|
15625
|
+
<dd>
|
|
15626
|
+
|
|
15627
|
+
**plan:** `Schematic::Types::UpdatePlanRequestBody`
|
|
15628
|
+
|
|
15629
|
+
</dd>
|
|
15630
|
+
</dl>
|
|
15631
|
+
|
|
15632
|
+
<dl>
|
|
15633
|
+
<dd>
|
|
15634
|
+
|
|
15635
|
+
**plan_version_id:** `String`
|
|
15636
|
+
|
|
15637
|
+
</dd>
|
|
15638
|
+
</dl>
|
|
15639
|
+
|
|
15640
|
+
<dl>
|
|
15641
|
+
<dd>
|
|
15642
|
+
|
|
15643
|
+
**request_options:** `Schematic::Planbundle::RequestOptions`
|
|
15644
|
+
|
|
15645
|
+
</dd>
|
|
15646
|
+
</dl>
|
|
15647
|
+
</dd>
|
|
15648
|
+
</dl>
|
|
15649
|
+
|
|
15650
|
+
|
|
15651
|
+
</dd>
|
|
15652
|
+
</dl>
|
|
15653
|
+
</details>
|
|
15654
|
+
|
|
15655
|
+
## dataexports
|
|
15656
|
+
<details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">list_data_exports</a>() -> Schematic::Dataexports::Types::ListDataExportsResponse</code></summary>
|
|
15657
|
+
<dl>
|
|
15658
|
+
<dd>
|
|
15659
|
+
|
|
15660
|
+
#### 🔌 Usage
|
|
15661
|
+
|
|
15662
|
+
<dl>
|
|
15663
|
+
<dd>
|
|
15664
|
+
|
|
15665
|
+
<dl>
|
|
15666
|
+
<dd>
|
|
15667
|
+
|
|
15668
|
+
```ruby
|
|
15669
|
+
client.dataexports.list_data_exports(
|
|
15670
|
+
export_type: "audit-log",
|
|
15671
|
+
status: "failure",
|
|
15672
|
+
limit: 1000000,
|
|
15673
|
+
offset: 1000000
|
|
15674
|
+
)
|
|
15675
|
+
```
|
|
15676
|
+
</dd>
|
|
15677
|
+
</dl>
|
|
15678
|
+
</dd>
|
|
15679
|
+
</dl>
|
|
15680
|
+
|
|
15681
|
+
#### ⚙️ Parameters
|
|
15682
|
+
|
|
15683
|
+
<dl>
|
|
15684
|
+
<dd>
|
|
15685
|
+
|
|
15686
|
+
<dl>
|
|
15687
|
+
<dd>
|
|
15688
|
+
|
|
15689
|
+
**export_type:** `Schematic::Types::DataExportType`
|
|
14535
15690
|
|
|
14536
15691
|
</dd>
|
|
14537
15692
|
</dl>
|
|
@@ -14539,7 +15694,7 @@ client.planbundle.update_plan_bundle(
|
|
|
14539
15694
|
<dl>
|
|
14540
15695
|
<dd>
|
|
14541
15696
|
|
|
14542
|
-
**
|
|
15697
|
+
**status:** `Schematic::Types::DataExportStatus`
|
|
14543
15698
|
|
|
14544
15699
|
</dd>
|
|
14545
15700
|
</dl>
|
|
@@ -14547,7 +15702,7 @@ client.planbundle.update_plan_bundle(
|
|
|
14547
15702
|
<dl>
|
|
14548
15703
|
<dd>
|
|
14549
15704
|
|
|
14550
|
-
**
|
|
15705
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
14551
15706
|
|
|
14552
15707
|
</dd>
|
|
14553
15708
|
</dl>
|
|
@@ -14555,7 +15710,7 @@ client.planbundle.update_plan_bundle(
|
|
|
14555
15710
|
<dl>
|
|
14556
15711
|
<dd>
|
|
14557
15712
|
|
|
14558
|
-
**
|
|
15713
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
14559
15714
|
|
|
14560
15715
|
</dd>
|
|
14561
15716
|
</dl>
|
|
@@ -14563,7 +15718,7 @@ client.planbundle.update_plan_bundle(
|
|
|
14563
15718
|
<dl>
|
|
14564
15719
|
<dd>
|
|
14565
15720
|
|
|
14566
|
-
**request_options:** `Schematic::
|
|
15721
|
+
**request_options:** `Schematic::Dataexports::RequestOptions`
|
|
14567
15722
|
|
|
14568
15723
|
</dd>
|
|
14569
15724
|
</dl>
|
|
@@ -14575,7 +15730,6 @@ client.planbundle.update_plan_bundle(
|
|
|
14575
15730
|
</dl>
|
|
14576
15731
|
</details>
|
|
14577
15732
|
|
|
14578
|
-
## dataexports
|
|
14579
15733
|
<details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">create_data_export</a>(request) -> Schematic::Dataexports::Types::CreateDataExportResponse</code></summary>
|
|
14580
15734
|
<dl>
|
|
14581
15735
|
<dd>
|
|
@@ -14590,8 +15744,7 @@ client.planbundle.update_plan_bundle(
|
|
|
14590
15744
|
|
|
14591
15745
|
```ruby
|
|
14592
15746
|
client.dataexports.create_data_export(
|
|
14593
|
-
export_type: "
|
|
14594
|
-
metadata: "metadata",
|
|
15747
|
+
export_type: "audit-log",
|
|
14595
15748
|
output_file_type: "csv"
|
|
14596
15749
|
)
|
|
14597
15750
|
```
|
|
@@ -14608,7 +15761,23 @@ client.dataexports.create_data_export(
|
|
|
14608
15761
|
<dl>
|
|
14609
15762
|
<dd>
|
|
14610
15763
|
|
|
14611
|
-
**export_type:** `
|
|
15764
|
+
**export_type:** `Schematic::Types::DataExportType`
|
|
15765
|
+
|
|
15766
|
+
</dd>
|
|
15767
|
+
</dl>
|
|
15768
|
+
|
|
15769
|
+
<dl>
|
|
15770
|
+
<dd>
|
|
15771
|
+
|
|
15772
|
+
**metadata:** `Schematic::Types::DataExportMetadata`
|
|
15773
|
+
|
|
15774
|
+
</dd>
|
|
15775
|
+
</dl>
|
|
15776
|
+
|
|
15777
|
+
<dl>
|
|
15778
|
+
<dd>
|
|
15779
|
+
|
|
15780
|
+
**output_file_type:** `Schematic::Types::DataExportOutputFileType`
|
|
14612
15781
|
|
|
14613
15782
|
</dd>
|
|
14614
15783
|
</dl>
|
|
@@ -14616,15 +15785,47 @@ client.dataexports.create_data_export(
|
|
|
14616
15785
|
<dl>
|
|
14617
15786
|
<dd>
|
|
14618
15787
|
|
|
14619
|
-
**
|
|
15788
|
+
**request_options:** `Schematic::Dataexports::RequestOptions`
|
|
14620
15789
|
|
|
14621
15790
|
</dd>
|
|
14622
15791
|
</dl>
|
|
15792
|
+
</dd>
|
|
15793
|
+
</dl>
|
|
15794
|
+
|
|
15795
|
+
|
|
15796
|
+
</dd>
|
|
15797
|
+
</dl>
|
|
15798
|
+
</details>
|
|
15799
|
+
|
|
15800
|
+
<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>
|
|
15801
|
+
<dl>
|
|
15802
|
+
<dd>
|
|
15803
|
+
|
|
15804
|
+
#### 🔌 Usage
|
|
15805
|
+
|
|
15806
|
+
<dl>
|
|
15807
|
+
<dd>
|
|
15808
|
+
|
|
15809
|
+
<dl>
|
|
15810
|
+
<dd>
|
|
15811
|
+
|
|
15812
|
+
```ruby
|
|
15813
|
+
client.dataexports.get_data_export(data_export_id: "data_export_id")
|
|
15814
|
+
```
|
|
15815
|
+
</dd>
|
|
15816
|
+
</dl>
|
|
15817
|
+
</dd>
|
|
15818
|
+
</dl>
|
|
15819
|
+
|
|
15820
|
+
#### ⚙️ Parameters
|
|
15821
|
+
|
|
15822
|
+
<dl>
|
|
15823
|
+
<dd>
|
|
14623
15824
|
|
|
14624
15825
|
<dl>
|
|
14625
15826
|
<dd>
|
|
14626
15827
|
|
|
14627
|
-
**
|
|
15828
|
+
**data_export_id:** `String` — data_export_id
|
|
14628
15829
|
|
|
14629
15830
|
</dd>
|
|
14630
15831
|
</dl>
|
|
@@ -16797,7 +17998,208 @@ client.insights.get_environment_trait_usage_time_series(
|
|
|
16797
17998
|
<dl>
|
|
16798
17999
|
<dd>
|
|
16799
18000
|
|
|
16800
|
-
**start_time:** `String`
|
|
18001
|
+
**start_time:** `String`
|
|
18002
|
+
|
|
18003
|
+
</dd>
|
|
18004
|
+
</dl>
|
|
18005
|
+
|
|
18006
|
+
<dl>
|
|
18007
|
+
<dd>
|
|
18008
|
+
|
|
18009
|
+
**request_options:** `Schematic::Insights::RequestOptions`
|
|
18010
|
+
|
|
18011
|
+
</dd>
|
|
18012
|
+
</dl>
|
|
18013
|
+
</dd>
|
|
18014
|
+
</dl>
|
|
18015
|
+
|
|
18016
|
+
|
|
18017
|
+
</dd>
|
|
18018
|
+
</dl>
|
|
18019
|
+
</details>
|
|
18020
|
+
|
|
18021
|
+
## integrationsapi
|
|
18022
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">run_integration</a>(integration_id) -> Schematic::Integrationsapi::Types::RunIntegrationResponse</code></summary>
|
|
18023
|
+
<dl>
|
|
18024
|
+
<dd>
|
|
18025
|
+
|
|
18026
|
+
#### 🔌 Usage
|
|
18027
|
+
|
|
18028
|
+
<dl>
|
|
18029
|
+
<dd>
|
|
18030
|
+
|
|
18031
|
+
<dl>
|
|
18032
|
+
<dd>
|
|
18033
|
+
|
|
18034
|
+
```ruby
|
|
18035
|
+
client.integrationsapi.run_integration(integration_id: "integration_id")
|
|
18036
|
+
```
|
|
18037
|
+
</dd>
|
|
18038
|
+
</dl>
|
|
18039
|
+
</dd>
|
|
18040
|
+
</dl>
|
|
18041
|
+
|
|
18042
|
+
#### ⚙️ Parameters
|
|
18043
|
+
|
|
18044
|
+
<dl>
|
|
18045
|
+
<dd>
|
|
18046
|
+
|
|
18047
|
+
<dl>
|
|
18048
|
+
<dd>
|
|
18049
|
+
|
|
18050
|
+
**integration_id:** `String` — integration_id
|
|
18051
|
+
|
|
18052
|
+
</dd>
|
|
18053
|
+
</dl>
|
|
18054
|
+
|
|
18055
|
+
<dl>
|
|
18056
|
+
<dd>
|
|
18057
|
+
|
|
18058
|
+
**request_options:** `Schematic::Integrationsapi::RequestOptions`
|
|
18059
|
+
|
|
18060
|
+
</dd>
|
|
18061
|
+
</dl>
|
|
18062
|
+
</dd>
|
|
18063
|
+
</dl>
|
|
18064
|
+
|
|
18065
|
+
|
|
18066
|
+
</dd>
|
|
18067
|
+
</dl>
|
|
18068
|
+
</details>
|
|
18069
|
+
|
|
18070
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">list_integrations</a>() -> Schematic::Integrationsapi::Types::ListIntegrationsResponse</code></summary>
|
|
18071
|
+
<dl>
|
|
18072
|
+
<dd>
|
|
18073
|
+
|
|
18074
|
+
#### 🔌 Usage
|
|
18075
|
+
|
|
18076
|
+
<dl>
|
|
18077
|
+
<dd>
|
|
18078
|
+
|
|
18079
|
+
<dl>
|
|
18080
|
+
<dd>
|
|
18081
|
+
|
|
18082
|
+
```ruby
|
|
18083
|
+
client.integrationsapi.list_integrations(
|
|
18084
|
+
billing_only: true,
|
|
18085
|
+
exclude_ids: ["exclude_ids"],
|
|
18086
|
+
id: "id",
|
|
18087
|
+
state: "active",
|
|
18088
|
+
type: "clerk",
|
|
18089
|
+
limit: 1000000,
|
|
18090
|
+
offset: 1000000
|
|
18091
|
+
)
|
|
18092
|
+
```
|
|
18093
|
+
</dd>
|
|
18094
|
+
</dl>
|
|
18095
|
+
</dd>
|
|
18096
|
+
</dl>
|
|
18097
|
+
|
|
18098
|
+
#### ⚙️ Parameters
|
|
18099
|
+
|
|
18100
|
+
<dl>
|
|
18101
|
+
<dd>
|
|
18102
|
+
|
|
18103
|
+
<dl>
|
|
18104
|
+
<dd>
|
|
18105
|
+
|
|
18106
|
+
**billing_only:** `Internal::Types::Boolean`
|
|
18107
|
+
|
|
18108
|
+
</dd>
|
|
18109
|
+
</dl>
|
|
18110
|
+
|
|
18111
|
+
<dl>
|
|
18112
|
+
<dd>
|
|
18113
|
+
|
|
18114
|
+
**exclude_ids:** `String`
|
|
18115
|
+
|
|
18116
|
+
</dd>
|
|
18117
|
+
</dl>
|
|
18118
|
+
|
|
18119
|
+
<dl>
|
|
18120
|
+
<dd>
|
|
18121
|
+
|
|
18122
|
+
**id:** `String`
|
|
18123
|
+
|
|
18124
|
+
</dd>
|
|
18125
|
+
</dl>
|
|
18126
|
+
|
|
18127
|
+
<dl>
|
|
18128
|
+
<dd>
|
|
18129
|
+
|
|
18130
|
+
**state:** `Schematic::Types::IntegrationState`
|
|
18131
|
+
|
|
18132
|
+
</dd>
|
|
18133
|
+
</dl>
|
|
18134
|
+
|
|
18135
|
+
<dl>
|
|
18136
|
+
<dd>
|
|
18137
|
+
|
|
18138
|
+
**type:** `Schematic::Types::IntegrationType`
|
|
18139
|
+
|
|
18140
|
+
</dd>
|
|
18141
|
+
</dl>
|
|
18142
|
+
|
|
18143
|
+
<dl>
|
|
18144
|
+
<dd>
|
|
18145
|
+
|
|
18146
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
18147
|
+
|
|
18148
|
+
</dd>
|
|
18149
|
+
</dl>
|
|
18150
|
+
|
|
18151
|
+
<dl>
|
|
18152
|
+
<dd>
|
|
18153
|
+
|
|
18154
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
18155
|
+
|
|
18156
|
+
</dd>
|
|
18157
|
+
</dl>
|
|
18158
|
+
|
|
18159
|
+
<dl>
|
|
18160
|
+
<dd>
|
|
18161
|
+
|
|
18162
|
+
**request_options:** `Schematic::Integrationsapi::RequestOptions`
|
|
18163
|
+
|
|
18164
|
+
</dd>
|
|
18165
|
+
</dl>
|
|
18166
|
+
</dd>
|
|
18167
|
+
</dl>
|
|
18168
|
+
|
|
18169
|
+
|
|
18170
|
+
</dd>
|
|
18171
|
+
</dl>
|
|
18172
|
+
</details>
|
|
18173
|
+
|
|
18174
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">get_integration_webhook_url</a>(type) -> Schematic::Integrationsapi::Types::GetIntegrationWebhookUrlResponse</code></summary>
|
|
18175
|
+
<dl>
|
|
18176
|
+
<dd>
|
|
18177
|
+
|
|
18178
|
+
#### 🔌 Usage
|
|
18179
|
+
|
|
18180
|
+
<dl>
|
|
18181
|
+
<dd>
|
|
18182
|
+
|
|
18183
|
+
<dl>
|
|
18184
|
+
<dd>
|
|
18185
|
+
|
|
18186
|
+
```ruby
|
|
18187
|
+
client.integrationsapi.get_integration_webhook_url(type: "type")
|
|
18188
|
+
```
|
|
18189
|
+
</dd>
|
|
18190
|
+
</dl>
|
|
18191
|
+
</dd>
|
|
18192
|
+
</dl>
|
|
18193
|
+
|
|
18194
|
+
#### ⚙️ Parameters
|
|
18195
|
+
|
|
18196
|
+
<dl>
|
|
18197
|
+
<dd>
|
|
18198
|
+
|
|
18199
|
+
<dl>
|
|
18200
|
+
<dd>
|
|
18201
|
+
|
|
18202
|
+
**type:** `String` — type
|
|
16801
18203
|
|
|
16802
18204
|
</dd>
|
|
16803
18205
|
</dl>
|
|
@@ -16805,7 +18207,7 @@ client.insights.get_environment_trait_usage_time_series(
|
|
|
16805
18207
|
<dl>
|
|
16806
18208
|
<dd>
|
|
16807
18209
|
|
|
16808
|
-
**request_options:** `Schematic::
|
|
18210
|
+
**request_options:** `Schematic::Integrationsapi::RequestOptions`
|
|
16809
18211
|
|
|
16810
18212
|
</dd>
|
|
16811
18213
|
</dl>
|
|
@@ -16817,8 +18219,7 @@ client.insights.get_environment_trait_usage_time_series(
|
|
|
16817
18219
|
</dl>
|
|
16818
18220
|
</details>
|
|
16819
18221
|
|
|
16820
|
-
|
|
16821
|
-
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">run_integration</a>(integration_id) -> Schematic::Integrationsapi::Types::RunIntegrationResponse</code></summary>
|
|
18222
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">install_integration</a>(request) -> Schematic::Integrationsapi::Types::InstallIntegrationResponse</code></summary>
|
|
16822
18223
|
<dl>
|
|
16823
18224
|
<dd>
|
|
16824
18225
|
|
|
@@ -16831,7 +18232,7 @@ client.insights.get_environment_trait_usage_time_series(
|
|
|
16831
18232
|
<dd>
|
|
16832
18233
|
|
|
16833
18234
|
```ruby
|
|
16834
|
-
client.integrationsapi.
|
|
18235
|
+
client.integrationsapi.install_integration(type: "clerk")
|
|
16835
18236
|
```
|
|
16836
18237
|
</dd>
|
|
16837
18238
|
</dl>
|
|
@@ -16846,7 +18247,7 @@ client.integrationsapi.run_integration(integration_id: "integration_id")
|
|
|
16846
18247
|
<dl>
|
|
16847
18248
|
<dd>
|
|
16848
18249
|
|
|
16849
|
-
**
|
|
18250
|
+
**request:** `Schematic::Types::InstallIntegrationRequestBody`
|
|
16850
18251
|
|
|
16851
18252
|
</dd>
|
|
16852
18253
|
</dl>
|
|
@@ -16866,7 +18267,7 @@ client.integrationsapi.run_integration(integration_id: "integration_id")
|
|
|
16866
18267
|
</dl>
|
|
16867
18268
|
</details>
|
|
16868
18269
|
|
|
16869
|
-
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">
|
|
18270
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">start_data_import</a>(request) -> Schematic::Integrationsapi::Types::StartDataImportResponse</code></summary>
|
|
16870
18271
|
<dl>
|
|
16871
18272
|
<dd>
|
|
16872
18273
|
|
|
@@ -16879,15 +18280,7 @@ client.integrationsapi.run_integration(integration_id: "integration_id")
|
|
|
16879
18280
|
<dd>
|
|
16880
18281
|
|
|
16881
18282
|
```ruby
|
|
16882
|
-
client.integrationsapi.
|
|
16883
|
-
billing_only: true,
|
|
16884
|
-
exclude_ids: ["exclude_ids"],
|
|
16885
|
-
id: "id",
|
|
16886
|
-
state: "active",
|
|
16887
|
-
type: "clerk",
|
|
16888
|
-
limit: 1000000,
|
|
16889
|
-
offset: 1000000
|
|
16890
|
-
)
|
|
18283
|
+
client.integrationsapi.start_data_import(integration_id: "integration_id")
|
|
16891
18284
|
```
|
|
16892
18285
|
</dd>
|
|
16893
18286
|
</dl>
|
|
@@ -16902,7 +18295,7 @@ client.integrationsapi.list_integrations(
|
|
|
16902
18295
|
<dl>
|
|
16903
18296
|
<dd>
|
|
16904
18297
|
|
|
16905
|
-
**
|
|
18298
|
+
**company_matching_criteria:** `Schematic::Types::CompanyMatchingCriteria`
|
|
16906
18299
|
|
|
16907
18300
|
</dd>
|
|
16908
18301
|
</dl>
|
|
@@ -16910,7 +18303,7 @@ client.integrationsapi.list_integrations(
|
|
|
16910
18303
|
<dl>
|
|
16911
18304
|
<dd>
|
|
16912
18305
|
|
|
16913
|
-
**
|
|
18306
|
+
**company_matching_field:** `String`
|
|
16914
18307
|
|
|
16915
18308
|
</dd>
|
|
16916
18309
|
</dl>
|
|
@@ -16918,7 +18311,7 @@ client.integrationsapi.list_integrations(
|
|
|
16918
18311
|
<dl>
|
|
16919
18312
|
<dd>
|
|
16920
18313
|
|
|
16921
|
-
**
|
|
18314
|
+
**integration_id:** `String`
|
|
16922
18315
|
|
|
16923
18316
|
</dd>
|
|
16924
18317
|
</dl>
|
|
@@ -16926,35 +18319,43 @@ client.integrationsapi.list_integrations(
|
|
|
16926
18319
|
<dl>
|
|
16927
18320
|
<dd>
|
|
16928
18321
|
|
|
16929
|
-
**
|
|
18322
|
+
**request_options:** `Schematic::Integrationsapi::RequestOptions`
|
|
16930
18323
|
|
|
16931
18324
|
</dd>
|
|
16932
18325
|
</dl>
|
|
18326
|
+
</dd>
|
|
18327
|
+
</dl>
|
|
16933
18328
|
|
|
16934
|
-
<dl>
|
|
16935
|
-
<dd>
|
|
16936
18329
|
|
|
16937
|
-
**type:** `Schematic::Types::IntegrationType`
|
|
16938
|
-
|
|
16939
18330
|
</dd>
|
|
16940
18331
|
</dl>
|
|
18332
|
+
</details>
|
|
16941
18333
|
|
|
18334
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">load_sample_data_set</a>() -> Schematic::Integrationsapi::Types::LoadSampleDataSetResponse</code></summary>
|
|
16942
18335
|
<dl>
|
|
16943
18336
|
<dd>
|
|
16944
18337
|
|
|
16945
|
-
|
|
16946
|
-
|
|
16947
|
-
</dd>
|
|
16948
|
-
</dl>
|
|
18338
|
+
#### 🔌 Usage
|
|
16949
18339
|
|
|
16950
18340
|
<dl>
|
|
16951
18341
|
<dd>
|
|
16952
18342
|
|
|
16953
|
-
|
|
16954
|
-
|
|
18343
|
+
<dl>
|
|
18344
|
+
<dd>
|
|
18345
|
+
|
|
18346
|
+
```ruby
|
|
18347
|
+
client.integrationsapi.load_sample_data_set
|
|
18348
|
+
```
|
|
18349
|
+
</dd>
|
|
18350
|
+
</dl>
|
|
16955
18351
|
</dd>
|
|
16956
18352
|
</dl>
|
|
16957
18353
|
|
|
18354
|
+
#### ⚙️ Parameters
|
|
18355
|
+
|
|
18356
|
+
<dl>
|
|
18357
|
+
<dd>
|
|
18358
|
+
|
|
16958
18359
|
<dl>
|
|
16959
18360
|
<dd>
|
|
16960
18361
|
|
|
@@ -16970,7 +18371,7 @@ client.integrationsapi.list_integrations(
|
|
|
16970
18371
|
</dl>
|
|
16971
18372
|
</details>
|
|
16972
18373
|
|
|
16973
|
-
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">
|
|
18374
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">assume_stripe_installed</a>(request) -> Schematic::Integrationsapi::Types::AssumeStripeInstalledResponse</code></summary>
|
|
16974
18375
|
<dl>
|
|
16975
18376
|
<dd>
|
|
16976
18377
|
|
|
@@ -16983,7 +18384,7 @@ client.integrationsapi.list_integrations(
|
|
|
16983
18384
|
<dd>
|
|
16984
18385
|
|
|
16985
18386
|
```ruby
|
|
16986
|
-
client.integrationsapi.
|
|
18387
|
+
client.integrationsapi.assume_stripe_installed(type: "clerk")
|
|
16987
18388
|
```
|
|
16988
18389
|
</dd>
|
|
16989
18390
|
</dl>
|
|
@@ -16998,7 +18399,7 @@ client.integrationsapi.get_integration_webhook_url(type: "type")
|
|
|
16998
18399
|
<dl>
|
|
16999
18400
|
<dd>
|
|
17000
18401
|
|
|
17001
|
-
**
|
|
18402
|
+
**request:** `Schematic::Types::InstallIntegrationRequestBody`
|
|
17002
18403
|
|
|
17003
18404
|
</dd>
|
|
17004
18405
|
</dl>
|
|
@@ -17018,7 +18419,7 @@ client.integrationsapi.get_integration_webhook_url(type: "type")
|
|
|
17018
18419
|
</dl>
|
|
17019
18420
|
</details>
|
|
17020
18421
|
|
|
17021
|
-
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">
|
|
18422
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">install_stripe</a>(request) -> Schematic::Integrationsapi::Types::InstallStripeResponse</code></summary>
|
|
17022
18423
|
<dl>
|
|
17023
18424
|
<dd>
|
|
17024
18425
|
|
|
@@ -17031,7 +18432,7 @@ client.integrationsapi.get_integration_webhook_url(type: "type")
|
|
|
17031
18432
|
<dd>
|
|
17032
18433
|
|
|
17033
18434
|
```ruby
|
|
17034
|
-
client.integrationsapi.
|
|
18435
|
+
client.integrationsapi.install_stripe(type: "clerk")
|
|
17035
18436
|
```
|
|
17036
18437
|
</dd>
|
|
17037
18438
|
</dl>
|
|
@@ -17066,7 +18467,7 @@ client.integrationsapi.install_integration(type: "clerk")
|
|
|
17066
18467
|
</dl>
|
|
17067
18468
|
</details>
|
|
17068
18469
|
|
|
17069
|
-
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">
|
|
18470
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">uninstall_integration</a>(integration_id) -> Schematic::Integrationsapi::Types::UninstallIntegrationResponse</code></summary>
|
|
17070
18471
|
<dl>
|
|
17071
18472
|
<dd>
|
|
17072
18473
|
|
|
@@ -17079,7 +18480,7 @@ client.integrationsapi.install_integration(type: "clerk")
|
|
|
17079
18480
|
<dd>
|
|
17080
18481
|
|
|
17081
18482
|
```ruby
|
|
17082
|
-
client.integrationsapi.
|
|
18483
|
+
client.integrationsapi.uninstall_integration(integration_id: "integration_id")
|
|
17083
18484
|
```
|
|
17084
18485
|
</dd>
|
|
17085
18486
|
</dl>
|
|
@@ -17094,23 +18495,7 @@ client.integrationsapi.start_data_import(integration_id: "integration_id")
|
|
|
17094
18495
|
<dl>
|
|
17095
18496
|
<dd>
|
|
17096
18497
|
|
|
17097
|
-
**
|
|
17098
|
-
|
|
17099
|
-
</dd>
|
|
17100
|
-
</dl>
|
|
17101
|
-
|
|
17102
|
-
<dl>
|
|
17103
|
-
<dd>
|
|
17104
|
-
|
|
17105
|
-
**company_matching_field:** `String`
|
|
17106
|
-
|
|
17107
|
-
</dd>
|
|
17108
|
-
</dl>
|
|
17109
|
-
|
|
17110
|
-
<dl>
|
|
17111
|
-
<dd>
|
|
17112
|
-
|
|
17113
|
-
**integration_id:** `String`
|
|
18498
|
+
**integration_id:** `String` — integration_id
|
|
17114
18499
|
|
|
17115
18500
|
</dd>
|
|
17116
18501
|
</dl>
|
|
@@ -17130,7 +18515,8 @@ client.integrationsapi.start_data_import(integration_id: "integration_id")
|
|
|
17130
18515
|
</dl>
|
|
17131
18516
|
</details>
|
|
17132
18517
|
|
|
17133
|
-
|
|
18518
|
+
## licenses
|
|
18519
|
+
<details><summary><code>client.licenses.<a href="/lib/schematic/licenses/client.rb">list_licenses</a>() -> Schematic::Licenses::Types::ListLicensesResponse</code></summary>
|
|
17134
18520
|
<dl>
|
|
17135
18521
|
<dd>
|
|
17136
18522
|
|
|
@@ -17143,7 +18529,13 @@ client.integrationsapi.start_data_import(integration_id: "integration_id")
|
|
|
17143
18529
|
<dd>
|
|
17144
18530
|
|
|
17145
18531
|
```ruby
|
|
17146
|
-
client.
|
|
18532
|
+
client.licenses.list_licenses(
|
|
18533
|
+
feature_ids: ["feature_ids"],
|
|
18534
|
+
ids: ["ids"],
|
|
18535
|
+
name: "name",
|
|
18536
|
+
limit: 1000000,
|
|
18537
|
+
offset: 1000000
|
|
18538
|
+
)
|
|
17147
18539
|
```
|
|
17148
18540
|
</dd>
|
|
17149
18541
|
</dl>
|
|
@@ -17158,47 +18550,39 @@ client.integrationsapi.load_sample_data_set
|
|
|
17158
18550
|
<dl>
|
|
17159
18551
|
<dd>
|
|
17160
18552
|
|
|
17161
|
-
**
|
|
18553
|
+
**feature_ids:** `String`
|
|
17162
18554
|
|
|
17163
18555
|
</dd>
|
|
17164
18556
|
</dl>
|
|
17165
|
-
</dd>
|
|
17166
|
-
</dl>
|
|
17167
18557
|
|
|
18558
|
+
<dl>
|
|
18559
|
+
<dd>
|
|
17168
18560
|
|
|
18561
|
+
**ids:** `String`
|
|
18562
|
+
|
|
17169
18563
|
</dd>
|
|
17170
18564
|
</dl>
|
|
17171
|
-
</details>
|
|
17172
18565
|
|
|
17173
|
-
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">assume_stripe_installed</a>(request) -> Schematic::Integrationsapi::Types::AssumeStripeInstalledResponse</code></summary>
|
|
17174
18566
|
<dl>
|
|
17175
18567
|
<dd>
|
|
17176
18568
|
|
|
17177
|
-
|
|
17178
|
-
|
|
17179
|
-
|
|
17180
|
-
|
|
18569
|
+
**name:** `String`
|
|
18570
|
+
|
|
18571
|
+
</dd>
|
|
18572
|
+
</dl>
|
|
17181
18573
|
|
|
17182
18574
|
<dl>
|
|
17183
18575
|
<dd>
|
|
17184
18576
|
|
|
17185
|
-
|
|
17186
|
-
|
|
17187
|
-
```
|
|
17188
|
-
</dd>
|
|
17189
|
-
</dl>
|
|
18577
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
18578
|
+
|
|
17190
18579
|
</dd>
|
|
17191
18580
|
</dl>
|
|
17192
18581
|
|
|
17193
|
-
#### ⚙️ Parameters
|
|
17194
|
-
|
|
17195
18582
|
<dl>
|
|
17196
18583
|
<dd>
|
|
17197
18584
|
|
|
17198
|
-
|
|
17199
|
-
<dd>
|
|
17200
|
-
|
|
17201
|
-
**request:** `Schematic::Types::InstallIntegrationRequestBody`
|
|
18585
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
17202
18586
|
|
|
17203
18587
|
</dd>
|
|
17204
18588
|
</dl>
|
|
@@ -17206,7 +18590,7 @@ client.integrationsapi.assume_stripe_installed(type: "clerk")
|
|
|
17206
18590
|
<dl>
|
|
17207
18591
|
<dd>
|
|
17208
18592
|
|
|
17209
|
-
**request_options:** `Schematic::
|
|
18593
|
+
**request_options:** `Schematic::Licenses::RequestOptions`
|
|
17210
18594
|
|
|
17211
18595
|
</dd>
|
|
17212
18596
|
</dl>
|
|
@@ -17218,7 +18602,7 @@ client.integrationsapi.assume_stripe_installed(type: "clerk")
|
|
|
17218
18602
|
</dl>
|
|
17219
18603
|
</details>
|
|
17220
18604
|
|
|
17221
|
-
<details><summary><code>client.
|
|
18605
|
+
<details><summary><code>client.licenses.<a href="/lib/schematic/licenses/client.rb">get_single_license</a>(license_id) -> Schematic::Licenses::Types::GetSingleLicenseResponse</code></summary>
|
|
17222
18606
|
<dl>
|
|
17223
18607
|
<dd>
|
|
17224
18608
|
|
|
@@ -17231,7 +18615,7 @@ client.integrationsapi.assume_stripe_installed(type: "clerk")
|
|
|
17231
18615
|
<dd>
|
|
17232
18616
|
|
|
17233
18617
|
```ruby
|
|
17234
|
-
client.
|
|
18618
|
+
client.licenses.get_single_license(license_id: "license_id")
|
|
17235
18619
|
```
|
|
17236
18620
|
</dd>
|
|
17237
18621
|
</dl>
|
|
@@ -17246,7 +18630,7 @@ client.integrationsapi.install_stripe(type: "clerk")
|
|
|
17246
18630
|
<dl>
|
|
17247
18631
|
<dd>
|
|
17248
18632
|
|
|
17249
|
-
**
|
|
18633
|
+
**license_id:** `String` — license_id
|
|
17250
18634
|
|
|
17251
18635
|
</dd>
|
|
17252
18636
|
</dl>
|
|
@@ -17254,7 +18638,7 @@ client.integrationsapi.install_stripe(type: "clerk")
|
|
|
17254
18638
|
<dl>
|
|
17255
18639
|
<dd>
|
|
17256
18640
|
|
|
17257
|
-
**request_options:** `Schematic::
|
|
18641
|
+
**request_options:** `Schematic::Licenses::RequestOptions`
|
|
17258
18642
|
|
|
17259
18643
|
</dd>
|
|
17260
18644
|
</dl>
|
|
@@ -17266,7 +18650,7 @@ client.integrationsapi.install_stripe(type: "clerk")
|
|
|
17266
18650
|
</dl>
|
|
17267
18651
|
</details>
|
|
17268
18652
|
|
|
17269
|
-
<details><summary><code>client.
|
|
18653
|
+
<details><summary><code>client.licenses.<a href="/lib/schematic/licenses/client.rb">count_licenses</a>() -> Schematic::Licenses::Types::CountLicensesResponse</code></summary>
|
|
17270
18654
|
<dl>
|
|
17271
18655
|
<dd>
|
|
17272
18656
|
|
|
@@ -17279,7 +18663,13 @@ client.integrationsapi.install_stripe(type: "clerk")
|
|
|
17279
18663
|
<dd>
|
|
17280
18664
|
|
|
17281
18665
|
```ruby
|
|
17282
|
-
client.
|
|
18666
|
+
client.licenses.count_licenses(
|
|
18667
|
+
feature_ids: ["feature_ids"],
|
|
18668
|
+
ids: ["ids"],
|
|
18669
|
+
name: "name",
|
|
18670
|
+
limit: 1000000,
|
|
18671
|
+
offset: 1000000
|
|
18672
|
+
)
|
|
17283
18673
|
```
|
|
17284
18674
|
</dd>
|
|
17285
18675
|
</dl>
|
|
@@ -17294,7 +18684,7 @@ client.integrationsapi.uninstall_integration(integration_id: "integration_id")
|
|
|
17294
18684
|
<dl>
|
|
17295
18685
|
<dd>
|
|
17296
18686
|
|
|
17297
|
-
**
|
|
18687
|
+
**feature_ids:** `String`
|
|
17298
18688
|
|
|
17299
18689
|
</dd>
|
|
17300
18690
|
</dl>
|
|
@@ -17302,7 +18692,39 @@ client.integrationsapi.uninstall_integration(integration_id: "integration_id")
|
|
|
17302
18692
|
<dl>
|
|
17303
18693
|
<dd>
|
|
17304
18694
|
|
|
17305
|
-
**
|
|
18695
|
+
**ids:** `String`
|
|
18696
|
+
|
|
18697
|
+
</dd>
|
|
18698
|
+
</dl>
|
|
18699
|
+
|
|
18700
|
+
<dl>
|
|
18701
|
+
<dd>
|
|
18702
|
+
|
|
18703
|
+
**name:** `String`
|
|
18704
|
+
|
|
18705
|
+
</dd>
|
|
18706
|
+
</dl>
|
|
18707
|
+
|
|
18708
|
+
<dl>
|
|
18709
|
+
<dd>
|
|
18710
|
+
|
|
18711
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
18712
|
+
|
|
18713
|
+
</dd>
|
|
18714
|
+
</dl>
|
|
18715
|
+
|
|
18716
|
+
<dl>
|
|
18717
|
+
<dd>
|
|
18718
|
+
|
|
18719
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
18720
|
+
|
|
18721
|
+
</dd>
|
|
18722
|
+
</dl>
|
|
18723
|
+
|
|
18724
|
+
<dl>
|
|
18725
|
+
<dd>
|
|
18726
|
+
|
|
18727
|
+
**request_options:** `Schematic::Licenses::RequestOptions`
|
|
17306
18728
|
|
|
17307
18729
|
</dd>
|
|
17308
18730
|
</dl>
|
|
@@ -18662,6 +20084,83 @@ client.planmigrations.count_migrations(
|
|
|
18662
20084
|
</dl>
|
|
18663
20085
|
|
|
18664
20086
|
|
|
20087
|
+
</dd>
|
|
20088
|
+
</dl>
|
|
20089
|
+
</details>
|
|
20090
|
+
|
|
20091
|
+
<details><summary><code>client.planmigrations.<a href="/lib/schematic/planmigrations/client.rb">preview_migration</a>(request) -> Schematic::Planmigrations::Types::PreviewMigrationResponse</code></summary>
|
|
20092
|
+
<dl>
|
|
20093
|
+
<dd>
|
|
20094
|
+
|
|
20095
|
+
#### 🔌 Usage
|
|
20096
|
+
|
|
20097
|
+
<dl>
|
|
20098
|
+
<dd>
|
|
20099
|
+
|
|
20100
|
+
<dl>
|
|
20101
|
+
<dd>
|
|
20102
|
+
|
|
20103
|
+
```ruby
|
|
20104
|
+
client.planmigrations.preview_migration(
|
|
20105
|
+
company_ids: ["company_ids"],
|
|
20106
|
+
plan_id: "plan_id",
|
|
20107
|
+
plan_version_id_to: "plan_version_id_to",
|
|
20108
|
+
target_plan_type: "plan"
|
|
20109
|
+
)
|
|
20110
|
+
```
|
|
20111
|
+
</dd>
|
|
20112
|
+
</dl>
|
|
20113
|
+
</dd>
|
|
20114
|
+
</dl>
|
|
20115
|
+
|
|
20116
|
+
#### ⚙️ Parameters
|
|
20117
|
+
|
|
20118
|
+
<dl>
|
|
20119
|
+
<dd>
|
|
20120
|
+
|
|
20121
|
+
<dl>
|
|
20122
|
+
<dd>
|
|
20123
|
+
|
|
20124
|
+
**company_ids:** `Internal::Types::Array[String]`
|
|
20125
|
+
|
|
20126
|
+
</dd>
|
|
20127
|
+
</dl>
|
|
20128
|
+
|
|
20129
|
+
<dl>
|
|
20130
|
+
<dd>
|
|
20131
|
+
|
|
20132
|
+
**plan_id:** `String`
|
|
20133
|
+
|
|
20134
|
+
</dd>
|
|
20135
|
+
</dl>
|
|
20136
|
+
|
|
20137
|
+
<dl>
|
|
20138
|
+
<dd>
|
|
20139
|
+
|
|
20140
|
+
**plan_version_id_to:** `String`
|
|
20141
|
+
|
|
20142
|
+
</dd>
|
|
20143
|
+
</dl>
|
|
20144
|
+
|
|
20145
|
+
<dl>
|
|
20146
|
+
<dd>
|
|
20147
|
+
|
|
20148
|
+
**target_plan_type:** `Schematic::Types::PlanType`
|
|
20149
|
+
|
|
20150
|
+
</dd>
|
|
20151
|
+
</dl>
|
|
20152
|
+
|
|
20153
|
+
<dl>
|
|
20154
|
+
<dd>
|
|
20155
|
+
|
|
20156
|
+
**request_options:** `Schematic::Planmigrations::RequestOptions`
|
|
20157
|
+
|
|
20158
|
+
</dd>
|
|
20159
|
+
</dl>
|
|
20160
|
+
</dd>
|
|
20161
|
+
</dl>
|
|
20162
|
+
|
|
20163
|
+
|
|
18665
20164
|
</dd>
|
|
18666
20165
|
</dl>
|
|
18667
20166
|
</details>
|