schematichq 1.4.12 → 1.4.14
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 +15 -3
- data/README.md +1 -1
- data/WASM_VERSION +1 -1
- data/lib/schematic/accounts/client.rb +63 -0
- data/lib/schematic/accounts/types/get_onboarding_state_response.rb +12 -0
- data/lib/schematic/accounts/types/update_onboarding_state_request_body.rb +14 -0
- data/lib/schematic/accounts/types/update_onboarding_state_response.rb +12 -0
- data/lib/schematic/client.rb +1 -1
- data/lib/schematic/companies/client.rb +185 -3
- data/lib/schematic/companies/types/count_entity_keys_params.rb +15 -0
- data/lib/schematic/companies/types/count_entity_keys_request.rb +14 -0
- data/lib/schematic/companies/types/count_entity_keys_response.rb +12 -0
- data/lib/schematic/companies/types/count_entity_traits_params.rb +15 -0
- data/lib/schematic/companies/types/count_entity_traits_request.rb +14 -0
- data/lib/schematic/companies/types/count_entity_traits_response.rb +12 -0
- data/lib/schematic/companies/types/delete_entity_key_definition_response.rb +12 -0
- data/lib/schematic/companies/types/delete_entity_trait_definition_response.rb +12 -0
- data/lib/schematic/companies/types/get_entity_trait_definition_usage_response.rb +12 -0
- data/lib/schematic/companies/types/list_plan_changes_params.rb +0 -1
- data/lib/schematic/companies/types/list_plan_changes_request.rb +0 -1
- data/lib/schematic/credits/types/create_credit_bundle_request_body.rb +1 -0
- data/lib/schematic/credits/types/update_credit_bundle_details_request_body.rb +1 -0
- data/lib/schematic/planbundle/client.rb +3 -3
- data/lib/schematic/planbundle/types/update_plan_bundle_request_body.rb +1 -1
- data/lib/schematic/plangroups/types/create_plan_group_request_body.rb +2 -0
- data/lib/schematic/plangroups/types/update_plan_group_request_body.rb +2 -0
- data/lib/schematic/planmigrations/types/create_migration_input.rb +4 -3
- data/lib/schematic/planmigrations/types/preview_migration_request_body.rb +2 -1
- data/lib/schematic/plans/client.rb +11 -9
- data/lib/schematic/plans/types/delete_plan_version_request.rb +1 -1
- data/lib/schematic/plans/types/list_custom_plan_billings_params.rb +1 -0
- data/lib/schematic/plans/types/list_custom_plan_billings_request.rb +1 -0
- data/lib/schematic/plans/types/publish_plan_version_request_body.rb +2 -1
- data/lib/schematic/plans/types/update_company_plans_request_body.rb +1 -1
- data/lib/schematic/types/billing_collection_method.rb +12 -0
- data/lib/schematic/types/billing_credit_bundle_response_data.rb +1 -0
- data/lib/schematic/types/billing_credit_bundle_view.rb +1 -0
- data/lib/schematic/types/billing_credit_grant_response_data.rb +2 -0
- data/lib/schematic/types/billing_credit_view.rb +1 -1
- data/lib/schematic/types/billing_plan_credit_grant_response_data.rb +1 -0
- data/lib/schematic/types/billing_product_record_response_data.rb +17 -0
- data/lib/schematic/types/checkout_bundle_purchase_behavior.rb +12 -0
- data/lib/schematic/types/checkout_settings_response_data.rb +2 -0
- data/lib/schematic/types/company_billing_checkout_settings.rb +1 -0
- data/lib/schematic/types/company_feature_usage_export_metadata.rb +6 -1
- data/lib/schematic/types/company_feature_usage_export_metadata_sort_order_direction.rb +12 -0
- data/lib/schematic/types/company_feature_usage_export_metadata_visible_columns_item.rb +14 -0
- data/lib/schematic/types/company_plan_credit_grant_view.rb +1 -0
- data/lib/schematic/types/component_checkout_settings.rb +2 -0
- data/lib/schematic/types/create_billing_plan_credit_grant_request_body.rb +1 -0
- data/lib/schematic/types/credit_company_grant_view.rb +2 -0
- data/lib/schematic/types/custom_plan_billing_response_data.rb +2 -0
- data/lib/schematic/types/data_export_metadata.rb +1 -0
- data/lib/schematic/types/data_export_type.rb +1 -0
- data/lib/schematic/types/entity_trait_definition_usage.rb +14 -0
- data/lib/schematic/types/event_export_metadata.rb +16 -0
- data/lib/schematic/types/event_export_metadata_event_types_item.rb +14 -0
- data/lib/schematic/types/feature_view.rb +1 -1
- data/lib/schematic/types/get_onboarding_state_resp.rb +14 -0
- data/lib/schematic/types/manage_plan_request.rb +7 -0
- data/lib/schematic/types/migration_proration_behavior.rb +12 -0
- data/lib/schematic/types/onboarding_milestone.rb +12 -0
- data/lib/schematic/types/onboarding_milestone_view.rb +12 -0
- data/lib/schematic/types/onboarding_path.rb +12 -0
- data/lib/schematic/types/onboarding_requirement.rb +16 -0
- data/lib/schematic/types/onboarding_requirement_status.rb +13 -0
- data/lib/schematic/types/onboarding_requirement_view.rb +12 -0
- data/lib/schematic/types/onboarding_track.rb +12 -0
- data/lib/schematic/types/plan_billing_source.rb +12 -0
- data/lib/schematic/types/plan_bundle_response_data.rb +1 -0
- data/lib/schematic/types/plan_credit_grant_view.rb +1 -0
- data/lib/schematic/types/plan_version_migration_preview_response_data.rb +1 -0
- data/lib/schematic/types/plan_version_migration_response_data.rb +1 -0
- data/lib/schematic/types/preview_subscription_finance_response_data.rb +1 -0
- data/lib/schematic/types/test_webhook_response_data.rb +1 -0
- data/lib/schematic/types/update_billing_plan_credit_grant_request_body.rb +1 -0
- data/lib/schematic/types/upsert_company_request_body.rb +1 -0
- data/lib/schematic/types/upsert_user_request_body.rb +1 -0
- data/lib/schematic/types/upsert_user_sub_request_body.rb +1 -0
- data/lib/schematic/types/who_am_i_response_data.rb +1 -0
- data/lib/schematic/version.rb +1 -1
- data/lib/schematic/wasm/rulesengine.wasm +0 -0
- data/lib/schematic.rb +30 -0
- data/reference.md +507 -25
- metadata +32 -2
data/reference.md
CHANGED
|
@@ -1201,6 +1201,118 @@ client.accounts.delete_environment(environment_id: "environment_id")
|
|
|
1201
1201
|
</dl>
|
|
1202
1202
|
|
|
1203
1203
|
|
|
1204
|
+
</dd>
|
|
1205
|
+
</dl>
|
|
1206
|
+
</details>
|
|
1207
|
+
|
|
1208
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_onboarding_state</a>() -> Schematic::Accounts::Types::GetOnboardingStateResponse</code></summary>
|
|
1209
|
+
<dl>
|
|
1210
|
+
<dd>
|
|
1211
|
+
|
|
1212
|
+
#### 🔌 Usage
|
|
1213
|
+
|
|
1214
|
+
<dl>
|
|
1215
|
+
<dd>
|
|
1216
|
+
|
|
1217
|
+
<dl>
|
|
1218
|
+
<dd>
|
|
1219
|
+
|
|
1220
|
+
```ruby
|
|
1221
|
+
client.accounts.get_onboarding_state
|
|
1222
|
+
```
|
|
1223
|
+
</dd>
|
|
1224
|
+
</dl>
|
|
1225
|
+
</dd>
|
|
1226
|
+
</dl>
|
|
1227
|
+
|
|
1228
|
+
#### ⚙️ Parameters
|
|
1229
|
+
|
|
1230
|
+
<dl>
|
|
1231
|
+
<dd>
|
|
1232
|
+
|
|
1233
|
+
<dl>
|
|
1234
|
+
<dd>
|
|
1235
|
+
|
|
1236
|
+
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
1237
|
+
|
|
1238
|
+
</dd>
|
|
1239
|
+
</dl>
|
|
1240
|
+
</dd>
|
|
1241
|
+
</dl>
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
</dd>
|
|
1245
|
+
</dl>
|
|
1246
|
+
</details>
|
|
1247
|
+
|
|
1248
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">update_onboarding_state</a>(request) -> Schematic::Accounts::Types::UpdateOnboardingStateResponse</code></summary>
|
|
1249
|
+
<dl>
|
|
1250
|
+
<dd>
|
|
1251
|
+
|
|
1252
|
+
#### 🔌 Usage
|
|
1253
|
+
|
|
1254
|
+
<dl>
|
|
1255
|
+
<dd>
|
|
1256
|
+
|
|
1257
|
+
<dl>
|
|
1258
|
+
<dd>
|
|
1259
|
+
|
|
1260
|
+
```ruby
|
|
1261
|
+
client.accounts.update_onboarding_state
|
|
1262
|
+
```
|
|
1263
|
+
</dd>
|
|
1264
|
+
</dl>
|
|
1265
|
+
</dd>
|
|
1266
|
+
</dl>
|
|
1267
|
+
|
|
1268
|
+
#### ⚙️ Parameters
|
|
1269
|
+
|
|
1270
|
+
<dl>
|
|
1271
|
+
<dd>
|
|
1272
|
+
|
|
1273
|
+
<dl>
|
|
1274
|
+
<dd>
|
|
1275
|
+
|
|
1276
|
+
**path:** `Schematic::Types::OnboardingPath`
|
|
1277
|
+
|
|
1278
|
+
</dd>
|
|
1279
|
+
</dl>
|
|
1280
|
+
|
|
1281
|
+
<dl>
|
|
1282
|
+
<dd>
|
|
1283
|
+
|
|
1284
|
+
**pricing_page_url:** `String`
|
|
1285
|
+
|
|
1286
|
+
</dd>
|
|
1287
|
+
</dl>
|
|
1288
|
+
|
|
1289
|
+
<dl>
|
|
1290
|
+
<dd>
|
|
1291
|
+
|
|
1292
|
+
**track:** `Schematic::Types::OnboardingTrack`
|
|
1293
|
+
|
|
1294
|
+
</dd>
|
|
1295
|
+
</dl>
|
|
1296
|
+
|
|
1297
|
+
<dl>
|
|
1298
|
+
<dd>
|
|
1299
|
+
|
|
1300
|
+
**website_url:** `String`
|
|
1301
|
+
|
|
1302
|
+
</dd>
|
|
1303
|
+
</dl>
|
|
1304
|
+
|
|
1305
|
+
<dl>
|
|
1306
|
+
<dd>
|
|
1307
|
+
|
|
1308
|
+
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
1309
|
+
|
|
1310
|
+
</dd>
|
|
1311
|
+
</dl>
|
|
1312
|
+
</dd>
|
|
1313
|
+
</dl>
|
|
1314
|
+
|
|
1315
|
+
|
|
1204
1316
|
</dd>
|
|
1205
1317
|
</dl>
|
|
1206
1318
|
</details>
|
|
@@ -4575,6 +4687,14 @@ client.credits.create_credit_bundle(
|
|
|
4575
4687
|
<dl>
|
|
4576
4688
|
<dd>
|
|
4577
4689
|
|
|
4690
|
+
**compatible_plan_ids:** `Internal::Types::Array[String]` — Plans whose companies may purchase this bundle. Omitted or empty means the bundle is purchasable on every plan.
|
|
4691
|
+
|
|
4692
|
+
</dd>
|
|
4693
|
+
</dl>
|
|
4694
|
+
|
|
4695
|
+
<dl>
|
|
4696
|
+
<dd>
|
|
4697
|
+
|
|
4578
4698
|
**credit_id:** `String`
|
|
4579
4699
|
|
|
4580
4700
|
</dd>
|
|
@@ -4763,6 +4883,14 @@ client.credits.update_credit_bundle_details(
|
|
|
4763
4883
|
<dl>
|
|
4764
4884
|
<dd>
|
|
4765
4885
|
|
|
4886
|
+
**compatible_plan_ids:** `Internal::Types::Array[String]` — Plans whose companies may purchase this bundle. Omitted leaves compatibility unchanged; empty resets the bundle to purchasable on every plan.
|
|
4887
|
+
|
|
4888
|
+
</dd>
|
|
4889
|
+
</dl>
|
|
4890
|
+
|
|
4891
|
+
<dl>
|
|
4892
|
+
<dd>
|
|
4893
|
+
|
|
4766
4894
|
**currency_prices:** `Internal::Types::Array[Schematic::Types::CreditBundleCurrencyPriceRequestBody]`
|
|
4767
4895
|
|
|
4768
4896
|
</dd>
|
|
@@ -9177,6 +9305,54 @@ client.companies.list_entity_key_definitions(
|
|
|
9177
9305
|
</dl>
|
|
9178
9306
|
|
|
9179
9307
|
|
|
9308
|
+
</dd>
|
|
9309
|
+
</dl>
|
|
9310
|
+
</details>
|
|
9311
|
+
|
|
9312
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">delete_entity_key_definition</a>(entity_key_definition_id) -> Schematic::Companies::Types::DeleteEntityKeyDefinitionResponse</code></summary>
|
|
9313
|
+
<dl>
|
|
9314
|
+
<dd>
|
|
9315
|
+
|
|
9316
|
+
#### 🔌 Usage
|
|
9317
|
+
|
|
9318
|
+
<dl>
|
|
9319
|
+
<dd>
|
|
9320
|
+
|
|
9321
|
+
<dl>
|
|
9322
|
+
<dd>
|
|
9323
|
+
|
|
9324
|
+
```ruby
|
|
9325
|
+
client.companies.delete_entity_key_definition(entity_key_definition_id: "entity_key_definition_id")
|
|
9326
|
+
```
|
|
9327
|
+
</dd>
|
|
9328
|
+
</dl>
|
|
9329
|
+
</dd>
|
|
9330
|
+
</dl>
|
|
9331
|
+
|
|
9332
|
+
#### ⚙️ Parameters
|
|
9333
|
+
|
|
9334
|
+
<dl>
|
|
9335
|
+
<dd>
|
|
9336
|
+
|
|
9337
|
+
<dl>
|
|
9338
|
+
<dd>
|
|
9339
|
+
|
|
9340
|
+
**entity_key_definition_id:** `String` — entity_key_definition_id
|
|
9341
|
+
|
|
9342
|
+
</dd>
|
|
9343
|
+
</dl>
|
|
9344
|
+
|
|
9345
|
+
<dl>
|
|
9346
|
+
<dd>
|
|
9347
|
+
|
|
9348
|
+
**request_options:** `Schematic::Companies::RequestOptions`
|
|
9349
|
+
|
|
9350
|
+
</dd>
|
|
9351
|
+
</dl>
|
|
9352
|
+
</dd>
|
|
9353
|
+
</dl>
|
|
9354
|
+
|
|
9355
|
+
|
|
9180
9356
|
</dd>
|
|
9181
9357
|
</dl>
|
|
9182
9358
|
</details>
|
|
@@ -9263,6 +9439,83 @@ client.companies.count_entity_key_definitions(
|
|
|
9263
9439
|
</dl>
|
|
9264
9440
|
|
|
9265
9441
|
|
|
9442
|
+
</dd>
|
|
9443
|
+
</dl>
|
|
9444
|
+
</details>
|
|
9445
|
+
|
|
9446
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">count_entity_keys</a>() -> Schematic::Companies::Types::CountEntityKeysResponse</code></summary>
|
|
9447
|
+
<dl>
|
|
9448
|
+
<dd>
|
|
9449
|
+
|
|
9450
|
+
#### 🔌 Usage
|
|
9451
|
+
|
|
9452
|
+
<dl>
|
|
9453
|
+
<dd>
|
|
9454
|
+
|
|
9455
|
+
<dl>
|
|
9456
|
+
<dd>
|
|
9457
|
+
|
|
9458
|
+
```ruby
|
|
9459
|
+
client.companies.count_entity_keys(
|
|
9460
|
+
definition_id: "definition_id",
|
|
9461
|
+
entity_type: "company",
|
|
9462
|
+
limit: 1000000,
|
|
9463
|
+
offset: 1000000
|
|
9464
|
+
)
|
|
9465
|
+
```
|
|
9466
|
+
</dd>
|
|
9467
|
+
</dl>
|
|
9468
|
+
</dd>
|
|
9469
|
+
</dl>
|
|
9470
|
+
|
|
9471
|
+
#### ⚙️ Parameters
|
|
9472
|
+
|
|
9473
|
+
<dl>
|
|
9474
|
+
<dd>
|
|
9475
|
+
|
|
9476
|
+
<dl>
|
|
9477
|
+
<dd>
|
|
9478
|
+
|
|
9479
|
+
**definition_id:** `String`
|
|
9480
|
+
|
|
9481
|
+
</dd>
|
|
9482
|
+
</dl>
|
|
9483
|
+
|
|
9484
|
+
<dl>
|
|
9485
|
+
<dd>
|
|
9486
|
+
|
|
9487
|
+
**entity_type:** `Schematic::Types::EntityType`
|
|
9488
|
+
|
|
9489
|
+
</dd>
|
|
9490
|
+
</dl>
|
|
9491
|
+
|
|
9492
|
+
<dl>
|
|
9493
|
+
<dd>
|
|
9494
|
+
|
|
9495
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
9496
|
+
|
|
9497
|
+
</dd>
|
|
9498
|
+
</dl>
|
|
9499
|
+
|
|
9500
|
+
<dl>
|
|
9501
|
+
<dd>
|
|
9502
|
+
|
|
9503
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
9504
|
+
|
|
9505
|
+
</dd>
|
|
9506
|
+
</dl>
|
|
9507
|
+
|
|
9508
|
+
<dl>
|
|
9509
|
+
<dd>
|
|
9510
|
+
|
|
9511
|
+
**request_options:** `Schematic::Companies::RequestOptions`
|
|
9512
|
+
|
|
9513
|
+
</dd>
|
|
9514
|
+
</dl>
|
|
9515
|
+
</dd>
|
|
9516
|
+
</dl>
|
|
9517
|
+
|
|
9518
|
+
|
|
9266
9519
|
</dd>
|
|
9267
9520
|
</dl>
|
|
9268
9521
|
</details>
|
|
@@ -9558,6 +9811,102 @@ client.companies.update_entity_trait_definition(
|
|
|
9558
9811
|
</dl>
|
|
9559
9812
|
|
|
9560
9813
|
|
|
9814
|
+
</dd>
|
|
9815
|
+
</dl>
|
|
9816
|
+
</details>
|
|
9817
|
+
|
|
9818
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">delete_entity_trait_definition</a>(entity_trait_definition_id) -> Schematic::Companies::Types::DeleteEntityTraitDefinitionResponse</code></summary>
|
|
9819
|
+
<dl>
|
|
9820
|
+
<dd>
|
|
9821
|
+
|
|
9822
|
+
#### 🔌 Usage
|
|
9823
|
+
|
|
9824
|
+
<dl>
|
|
9825
|
+
<dd>
|
|
9826
|
+
|
|
9827
|
+
<dl>
|
|
9828
|
+
<dd>
|
|
9829
|
+
|
|
9830
|
+
```ruby
|
|
9831
|
+
client.companies.delete_entity_trait_definition(entity_trait_definition_id: "entity_trait_definition_id")
|
|
9832
|
+
```
|
|
9833
|
+
</dd>
|
|
9834
|
+
</dl>
|
|
9835
|
+
</dd>
|
|
9836
|
+
</dl>
|
|
9837
|
+
|
|
9838
|
+
#### ⚙️ Parameters
|
|
9839
|
+
|
|
9840
|
+
<dl>
|
|
9841
|
+
<dd>
|
|
9842
|
+
|
|
9843
|
+
<dl>
|
|
9844
|
+
<dd>
|
|
9845
|
+
|
|
9846
|
+
**entity_trait_definition_id:** `String` — entity_trait_definition_id
|
|
9847
|
+
|
|
9848
|
+
</dd>
|
|
9849
|
+
</dl>
|
|
9850
|
+
|
|
9851
|
+
<dl>
|
|
9852
|
+
<dd>
|
|
9853
|
+
|
|
9854
|
+
**request_options:** `Schematic::Companies::RequestOptions`
|
|
9855
|
+
|
|
9856
|
+
</dd>
|
|
9857
|
+
</dl>
|
|
9858
|
+
</dd>
|
|
9859
|
+
</dl>
|
|
9860
|
+
|
|
9861
|
+
|
|
9862
|
+
</dd>
|
|
9863
|
+
</dl>
|
|
9864
|
+
</details>
|
|
9865
|
+
|
|
9866
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">get_entity_trait_definition_usage</a>(entity_trait_definition_id) -> Schematic::Companies::Types::GetEntityTraitDefinitionUsageResponse</code></summary>
|
|
9867
|
+
<dl>
|
|
9868
|
+
<dd>
|
|
9869
|
+
|
|
9870
|
+
#### 🔌 Usage
|
|
9871
|
+
|
|
9872
|
+
<dl>
|
|
9873
|
+
<dd>
|
|
9874
|
+
|
|
9875
|
+
<dl>
|
|
9876
|
+
<dd>
|
|
9877
|
+
|
|
9878
|
+
```ruby
|
|
9879
|
+
client.companies.get_entity_trait_definition_usage(entity_trait_definition_id: "entity_trait_definition_id")
|
|
9880
|
+
```
|
|
9881
|
+
</dd>
|
|
9882
|
+
</dl>
|
|
9883
|
+
</dd>
|
|
9884
|
+
</dl>
|
|
9885
|
+
|
|
9886
|
+
#### ⚙️ Parameters
|
|
9887
|
+
|
|
9888
|
+
<dl>
|
|
9889
|
+
<dd>
|
|
9890
|
+
|
|
9891
|
+
<dl>
|
|
9892
|
+
<dd>
|
|
9893
|
+
|
|
9894
|
+
**entity_trait_definition_id:** `String` — entity_trait_definition_id
|
|
9895
|
+
|
|
9896
|
+
</dd>
|
|
9897
|
+
</dl>
|
|
9898
|
+
|
|
9899
|
+
<dl>
|
|
9900
|
+
<dd>
|
|
9901
|
+
|
|
9902
|
+
**request_options:** `Schematic::Companies::RequestOptions`
|
|
9903
|
+
|
|
9904
|
+
</dd>
|
|
9905
|
+
</dl>
|
|
9906
|
+
</dd>
|
|
9907
|
+
</dl>
|
|
9908
|
+
|
|
9909
|
+
|
|
9561
9910
|
</dd>
|
|
9562
9911
|
</dl>
|
|
9563
9912
|
</details>
|
|
@@ -9739,6 +10088,83 @@ client.companies.get_entity_trait_values(
|
|
|
9739
10088
|
</dl>
|
|
9740
10089
|
|
|
9741
10090
|
|
|
10091
|
+
</dd>
|
|
10092
|
+
</dl>
|
|
10093
|
+
</details>
|
|
10094
|
+
|
|
10095
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">count_entity_traits</a>() -> Schematic::Companies::Types::CountEntityTraitsResponse</code></summary>
|
|
10096
|
+
<dl>
|
|
10097
|
+
<dd>
|
|
10098
|
+
|
|
10099
|
+
#### 🔌 Usage
|
|
10100
|
+
|
|
10101
|
+
<dl>
|
|
10102
|
+
<dd>
|
|
10103
|
+
|
|
10104
|
+
<dl>
|
|
10105
|
+
<dd>
|
|
10106
|
+
|
|
10107
|
+
```ruby
|
|
10108
|
+
client.companies.count_entity_traits(
|
|
10109
|
+
definition_id: "definition_id",
|
|
10110
|
+
entity_type: "company",
|
|
10111
|
+
limit: 1000000,
|
|
10112
|
+
offset: 1000000
|
|
10113
|
+
)
|
|
10114
|
+
```
|
|
10115
|
+
</dd>
|
|
10116
|
+
</dl>
|
|
10117
|
+
</dd>
|
|
10118
|
+
</dl>
|
|
10119
|
+
|
|
10120
|
+
#### ⚙️ Parameters
|
|
10121
|
+
|
|
10122
|
+
<dl>
|
|
10123
|
+
<dd>
|
|
10124
|
+
|
|
10125
|
+
<dl>
|
|
10126
|
+
<dd>
|
|
10127
|
+
|
|
10128
|
+
**definition_id:** `String`
|
|
10129
|
+
|
|
10130
|
+
</dd>
|
|
10131
|
+
</dl>
|
|
10132
|
+
|
|
10133
|
+
<dl>
|
|
10134
|
+
<dd>
|
|
10135
|
+
|
|
10136
|
+
**entity_type:** `Schematic::Types::EntityType`
|
|
10137
|
+
|
|
10138
|
+
</dd>
|
|
10139
|
+
</dl>
|
|
10140
|
+
|
|
10141
|
+
<dl>
|
|
10142
|
+
<dd>
|
|
10143
|
+
|
|
10144
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
10145
|
+
|
|
10146
|
+
</dd>
|
|
10147
|
+
</dl>
|
|
10148
|
+
|
|
10149
|
+
<dl>
|
|
10150
|
+
<dd>
|
|
10151
|
+
|
|
10152
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
10153
|
+
|
|
10154
|
+
</dd>
|
|
10155
|
+
</dl>
|
|
10156
|
+
|
|
10157
|
+
<dl>
|
|
10158
|
+
<dd>
|
|
10159
|
+
|
|
10160
|
+
**request_options:** `Schematic::Companies::RequestOptions`
|
|
10161
|
+
|
|
10162
|
+
</dd>
|
|
10163
|
+
</dl>
|
|
10164
|
+
</dd>
|
|
10165
|
+
</dl>
|
|
10166
|
+
|
|
10167
|
+
|
|
9742
10168
|
</dd>
|
|
9743
10169
|
</dl>
|
|
9744
10170
|
</details>
|
|
@@ -9761,7 +10187,6 @@ client.companies.list_plan_changes(
|
|
|
9761
10187
|
base_plan_action: "fallback",
|
|
9762
10188
|
company_id: "company_id",
|
|
9763
10189
|
company_ids: ["company_ids"],
|
|
9764
|
-
plan_ids: ["plan_ids"],
|
|
9765
10190
|
limit: 1000000,
|
|
9766
10191
|
offset: 1000000
|
|
9767
10192
|
)
|
|
@@ -9811,14 +10236,6 @@ client.companies.list_plan_changes(
|
|
|
9811
10236
|
<dl>
|
|
9812
10237
|
<dd>
|
|
9813
10238
|
|
|
9814
|
-
**plan_ids:** `String`
|
|
9815
|
-
|
|
9816
|
-
</dd>
|
|
9817
|
-
</dl>
|
|
9818
|
-
|
|
9819
|
-
<dl>
|
|
9820
|
-
<dd>
|
|
9821
|
-
|
|
9822
10239
|
**limit:** `Integer` — Page limit (default 100)
|
|
9823
10240
|
|
|
9824
10241
|
</dd>
|
|
@@ -13580,7 +13997,7 @@ client.entitlements.get_user_usage_detail(
|
|
|
13580
13997
|
</details>
|
|
13581
13998
|
|
|
13582
13999
|
## plans
|
|
13583
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">update_company_plans</a>(
|
|
14000
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">update_company_plans</a>(company_id, request) -> Schematic::Plans::Types::UpdateCompanyPlansResponse</code></summary>
|
|
13584
14001
|
<dl>
|
|
13585
14002
|
<dd>
|
|
13586
14003
|
|
|
@@ -13594,7 +14011,7 @@ client.entitlements.get_user_usage_detail(
|
|
|
13594
14011
|
|
|
13595
14012
|
```ruby
|
|
13596
14013
|
client.plans.update_company_plans(
|
|
13597
|
-
|
|
14014
|
+
company_id: "company_id",
|
|
13598
14015
|
add_on_ids: ["add_on_ids"]
|
|
13599
14016
|
)
|
|
13600
14017
|
```
|
|
@@ -13611,7 +14028,7 @@ client.plans.update_company_plans(
|
|
|
13611
14028
|
<dl>
|
|
13612
14029
|
<dd>
|
|
13613
14030
|
|
|
13614
|
-
**
|
|
14031
|
+
**company_id:** `String` — company_id
|
|
13615
14032
|
|
|
13616
14033
|
</dd>
|
|
13617
14034
|
</dl>
|
|
@@ -13663,6 +14080,7 @@ client.plans.update_company_plans(
|
|
|
13663
14080
|
client.plans.list_custom_plan_billings(
|
|
13664
14081
|
company_id: "company_id",
|
|
13665
14082
|
plan_id: "plan_id",
|
|
14083
|
+
plan_billing_source: "custom_plan",
|
|
13666
14084
|
status: "active",
|
|
13667
14085
|
statuses: ["active"],
|
|
13668
14086
|
limit: 1000000,
|
|
@@ -13698,6 +14116,14 @@ client.plans.list_custom_plan_billings(
|
|
|
13698
14116
|
<dl>
|
|
13699
14117
|
<dd>
|
|
13700
14118
|
|
|
14119
|
+
**plan_billing_source:** `Schematic::Types::PlanBillingSource` — Filter by the flow that created the billing record. Defaults to custom_plan.
|
|
14120
|
+
|
|
14121
|
+
</dd>
|
|
14122
|
+
</dl>
|
|
14123
|
+
|
|
14124
|
+
<dl>
|
|
14125
|
+
<dd>
|
|
14126
|
+
|
|
13701
14127
|
**status:** `Schematic::Types::CustomPlanBillingStatus` — Filter by billing status
|
|
13702
14128
|
|
|
13703
14129
|
</dd>
|
|
@@ -14949,7 +15375,7 @@ client.plans.list_plan_issues(
|
|
|
14949
15375
|
</dl>
|
|
14950
15376
|
</details>
|
|
14951
15377
|
|
|
14952
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">delete_plan_version</a>(
|
|
15378
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">delete_plan_version</a>(plan_version_id) -> Schematic::Plans::Types::DeletePlanVersionResponse</code></summary>
|
|
14953
15379
|
<dl>
|
|
14954
15380
|
<dd>
|
|
14955
15381
|
|
|
@@ -14963,7 +15389,7 @@ client.plans.list_plan_issues(
|
|
|
14963
15389
|
|
|
14964
15390
|
```ruby
|
|
14965
15391
|
client.plans.delete_plan_version(
|
|
14966
|
-
|
|
15392
|
+
plan_version_id: "plan_version_id",
|
|
14967
15393
|
promote_archived_version: true
|
|
14968
15394
|
)
|
|
14969
15395
|
```
|
|
@@ -14980,7 +15406,7 @@ client.plans.delete_plan_version(
|
|
|
14980
15406
|
<dl>
|
|
14981
15407
|
<dd>
|
|
14982
15408
|
|
|
14983
|
-
**
|
|
15409
|
+
**plan_version_id:** `String` — plan_version_id
|
|
14984
15410
|
|
|
14985
15411
|
</dd>
|
|
14986
15412
|
</dl>
|
|
@@ -15008,7 +15434,7 @@ client.plans.delete_plan_version(
|
|
|
15008
15434
|
</dl>
|
|
15009
15435
|
</details>
|
|
15010
15436
|
|
|
15011
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">publish_plan_version</a>(
|
|
15437
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">publish_plan_version</a>(plan_version_id, request) -> Schematic::Plans::Types::PublishPlanVersionResponse</code></summary>
|
|
15012
15438
|
<dl>
|
|
15013
15439
|
<dd>
|
|
15014
15440
|
|
|
@@ -15022,7 +15448,7 @@ client.plans.delete_plan_version(
|
|
|
15022
15448
|
|
|
15023
15449
|
```ruby
|
|
15024
15450
|
client.plans.publish_plan_version(
|
|
15025
|
-
|
|
15451
|
+
plan_version_id: "plan_version_id",
|
|
15026
15452
|
excluded_company_ids: ["excluded_company_ids"],
|
|
15027
15453
|
migration_strategy: "immediate"
|
|
15028
15454
|
)
|
|
@@ -15040,7 +15466,7 @@ client.plans.publish_plan_version(
|
|
|
15040
15466
|
<dl>
|
|
15041
15467
|
<dd>
|
|
15042
15468
|
|
|
15043
|
-
**
|
|
15469
|
+
**plan_version_id:** `String` — plan_version_id
|
|
15044
15470
|
|
|
15045
15471
|
</dd>
|
|
15046
15472
|
</dl>
|
|
@@ -15120,6 +15546,14 @@ client.plans.publish_plan_version(
|
|
|
15120
15546
|
<dl>
|
|
15121
15547
|
<dd>
|
|
15122
15548
|
|
|
15549
|
+
**proration_behavior:** `Schematic::Types::MigrationProrationBehavior`
|
|
15550
|
+
|
|
15551
|
+
</dd>
|
|
15552
|
+
</dl>
|
|
15553
|
+
|
|
15554
|
+
<dl>
|
|
15555
|
+
<dd>
|
|
15556
|
+
|
|
15123
15557
|
**send_invoice:** `Internal::Types::Boolean` — Whether Stripe emails the invoice when it is finalized. Defaults to true.
|
|
15124
15558
|
|
|
15125
15559
|
</dd>
|
|
@@ -15792,7 +16226,7 @@ client.planbundle.create_plan_bundle(entitlements: [{
|
|
|
15792
16226
|
</dl>
|
|
15793
16227
|
</details>
|
|
15794
16228
|
|
|
15795
|
-
<details><summary><code>client.planbundle.<a href="/lib/schematic/planbundle/client.rb">update_plan_bundle</a>(
|
|
16229
|
+
<details><summary><code>client.planbundle.<a href="/lib/schematic/planbundle/client.rb">update_plan_bundle</a>(plan_id, request) -> Schematic::Planbundle::Types::UpdatePlanBundleResponse</code></summary>
|
|
15796
16230
|
<dl>
|
|
15797
16231
|
<dd>
|
|
15798
16232
|
|
|
@@ -15806,7 +16240,7 @@ client.planbundle.create_plan_bundle(entitlements: [{
|
|
|
15806
16240
|
|
|
15807
16241
|
```ruby
|
|
15808
16242
|
client.planbundle.update_plan_bundle(
|
|
15809
|
-
|
|
16243
|
+
plan_id: "plan_id",
|
|
15810
16244
|
entitlements: [{
|
|
15811
16245
|
action: "create"
|
|
15812
16246
|
}]
|
|
@@ -15825,7 +16259,7 @@ client.planbundle.update_plan_bundle(
|
|
|
15825
16259
|
<dl>
|
|
15826
16260
|
<dd>
|
|
15827
16261
|
|
|
15828
|
-
**
|
|
16262
|
+
**plan_id:** `String` — plan_id
|
|
15829
16263
|
|
|
15830
16264
|
</dd>
|
|
15831
16265
|
</dl>
|
|
@@ -19033,9 +19467,11 @@ client.plangroups.get_plan_group(include_company_counts: true)
|
|
|
19033
19467
|
```ruby
|
|
19034
19468
|
client.plangroups.create_plan_group(
|
|
19035
19469
|
add_on_ids: ["add_on_ids"],
|
|
19470
|
+
checkout_bundle_purchase_behavior: "individual",
|
|
19036
19471
|
checkout_collect_address: true,
|
|
19037
19472
|
checkout_collect_email: true,
|
|
19038
19473
|
checkout_collect_phone: true,
|
|
19474
|
+
checkout_collect_tax_id: true,
|
|
19039
19475
|
enable_tax_collection: true,
|
|
19040
19476
|
opt_in_enabled: true,
|
|
19041
19477
|
ordered_add_ons: [{
|
|
@@ -19088,6 +19524,14 @@ client.plangroups.create_plan_group(
|
|
|
19088
19524
|
<dl>
|
|
19089
19525
|
<dd>
|
|
19090
19526
|
|
|
19527
|
+
**checkout_bundle_purchase_behavior:** `Schematic::Types::CheckoutBundlePurchaseBehavior`
|
|
19528
|
+
|
|
19529
|
+
</dd>
|
|
19530
|
+
</dl>
|
|
19531
|
+
|
|
19532
|
+
<dl>
|
|
19533
|
+
<dd>
|
|
19534
|
+
|
|
19091
19535
|
**checkout_collect_address:** `Internal::Types::Boolean`
|
|
19092
19536
|
|
|
19093
19537
|
</dd>
|
|
@@ -19112,6 +19556,14 @@ client.plangroups.create_plan_group(
|
|
|
19112
19556
|
<dl>
|
|
19113
19557
|
<dd>
|
|
19114
19558
|
|
|
19559
|
+
**checkout_collect_tax_id:** `Internal::Types::Boolean`
|
|
19560
|
+
|
|
19561
|
+
</dd>
|
|
19562
|
+
</dl>
|
|
19563
|
+
|
|
19564
|
+
<dl>
|
|
19565
|
+
<dd>
|
|
19566
|
+
|
|
19115
19567
|
**custom_checkout_fields:** `Internal::Types::Array[Schematic::Types::CheckoutFieldInput]`
|
|
19116
19568
|
|
|
19117
19569
|
</dd>
|
|
@@ -19388,9 +19840,11 @@ client.plangroups.create_plan_group(
|
|
|
19388
19840
|
client.plangroups.update_plan_group(
|
|
19389
19841
|
plan_group_id: "plan_group_id",
|
|
19390
19842
|
add_on_ids: ["add_on_ids"],
|
|
19843
|
+
checkout_bundle_purchase_behavior: "individual",
|
|
19391
19844
|
checkout_collect_address: true,
|
|
19392
19845
|
checkout_collect_email: true,
|
|
19393
19846
|
checkout_collect_phone: true,
|
|
19847
|
+
checkout_collect_tax_id: true,
|
|
19394
19848
|
enable_tax_collection: true,
|
|
19395
19849
|
opt_in_enabled: true,
|
|
19396
19850
|
ordered_add_ons: [{
|
|
@@ -19451,6 +19905,14 @@ client.plangroups.update_plan_group(
|
|
|
19451
19905
|
<dl>
|
|
19452
19906
|
<dd>
|
|
19453
19907
|
|
|
19908
|
+
**checkout_bundle_purchase_behavior:** `Schematic::Types::CheckoutBundlePurchaseBehavior`
|
|
19909
|
+
|
|
19910
|
+
</dd>
|
|
19911
|
+
</dl>
|
|
19912
|
+
|
|
19913
|
+
<dl>
|
|
19914
|
+
<dd>
|
|
19915
|
+
|
|
19454
19916
|
**checkout_collect_address:** `Internal::Types::Boolean`
|
|
19455
19917
|
|
|
19456
19918
|
</dd>
|
|
@@ -19475,6 +19937,14 @@ client.plangroups.update_plan_group(
|
|
|
19475
19937
|
<dl>
|
|
19476
19938
|
<dd>
|
|
19477
19939
|
|
|
19940
|
+
**checkout_collect_tax_id:** `Internal::Types::Boolean`
|
|
19941
|
+
|
|
19942
|
+
</dd>
|
|
19943
|
+
</dl>
|
|
19944
|
+
|
|
19945
|
+
<dl>
|
|
19946
|
+
<dd>
|
|
19947
|
+
|
|
19478
19948
|
**custom_checkout_fields:** `Internal::Types::Array[Schematic::Types::CheckoutFieldInput]`
|
|
19479
19949
|
|
|
19480
19950
|
</dd>
|
|
@@ -20047,11 +20517,8 @@ client.planmigrations.list_migrations(
|
|
|
20047
20517
|
|
|
20048
20518
|
```ruby
|
|
20049
20519
|
client.planmigrations.create_migration(
|
|
20050
|
-
company_ids: ["company_ids"],
|
|
20051
|
-
excluded_company_ids: ["excluded_company_ids"],
|
|
20052
20520
|
plan_id: "plan_id",
|
|
20053
20521
|
plan_version_id_to: "plan_version_id_to",
|
|
20054
|
-
plan_version_ids_from: ["plan_version_ids_from"],
|
|
20055
20522
|
strategy: "immediate",
|
|
20056
20523
|
target_plan_type: "plan"
|
|
20057
20524
|
)
|
|
@@ -20109,6 +20576,14 @@ client.planmigrations.create_migration(
|
|
|
20109
20576
|
<dl>
|
|
20110
20577
|
<dd>
|
|
20111
20578
|
|
|
20579
|
+
**proration_behavior:** `Schematic::Types::MigrationProrationBehavior`
|
|
20580
|
+
|
|
20581
|
+
</dd>
|
|
20582
|
+
</dl>
|
|
20583
|
+
|
|
20584
|
+
<dl>
|
|
20585
|
+
<dd>
|
|
20586
|
+
|
|
20112
20587
|
**strategy:** `Schematic::Types::PlanVersionMigrationStrategy`
|
|
20113
20588
|
|
|
20114
20589
|
</dd>
|
|
@@ -20335,7 +20810,6 @@ client.planmigrations.count_migrations(
|
|
|
20335
20810
|
|
|
20336
20811
|
```ruby
|
|
20337
20812
|
client.planmigrations.preview_migration(
|
|
20338
|
-
company_ids: ["company_ids"],
|
|
20339
20813
|
plan_id: "plan_id",
|
|
20340
20814
|
plan_version_id_to: "plan_version_id_to",
|
|
20341
20815
|
target_plan_type: "plan"
|
|
@@ -20378,6 +20852,14 @@ client.planmigrations.preview_migration(
|
|
|
20378
20852
|
<dl>
|
|
20379
20853
|
<dd>
|
|
20380
20854
|
|
|
20855
|
+
**plan_version_ids_from:** `Internal::Types::Array[String]`
|
|
20856
|
+
|
|
20857
|
+
</dd>
|
|
20858
|
+
</dl>
|
|
20859
|
+
|
|
20860
|
+
<dl>
|
|
20861
|
+
<dd>
|
|
20862
|
+
|
|
20381
20863
|
**target_plan_type:** `Schematic::Types::PlanType`
|
|
20382
20864
|
|
|
20383
20865
|
</dd>
|