schematichq 1.4.13 → 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 +9 -3
- 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 +109 -3
- 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_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_plan_credit_grant_response_data.rb +1 -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 +2 -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/entity_trait_definition_usage.rb +14 -0
- 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/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 +21 -0
- data/reference.md +382 -25
- metadata +23 -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>
|
|
@@ -9683,6 +9811,102 @@ client.companies.update_entity_trait_definition(
|
|
|
9683
9811
|
</dl>
|
|
9684
9812
|
|
|
9685
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
|
+
|
|
9686
9910
|
</dd>
|
|
9687
9911
|
</dl>
|
|
9688
9912
|
</details>
|
|
@@ -9864,6 +10088,83 @@ client.companies.get_entity_trait_values(
|
|
|
9864
10088
|
</dl>
|
|
9865
10089
|
|
|
9866
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
|
+
|
|
9867
10168
|
</dd>
|
|
9868
10169
|
</dl>
|
|
9869
10170
|
</details>
|
|
@@ -9886,7 +10187,6 @@ client.companies.list_plan_changes(
|
|
|
9886
10187
|
base_plan_action: "fallback",
|
|
9887
10188
|
company_id: "company_id",
|
|
9888
10189
|
company_ids: ["company_ids"],
|
|
9889
|
-
plan_ids: ["plan_ids"],
|
|
9890
10190
|
limit: 1000000,
|
|
9891
10191
|
offset: 1000000
|
|
9892
10192
|
)
|
|
@@ -9936,14 +10236,6 @@ client.companies.list_plan_changes(
|
|
|
9936
10236
|
<dl>
|
|
9937
10237
|
<dd>
|
|
9938
10238
|
|
|
9939
|
-
**plan_ids:** `String`
|
|
9940
|
-
|
|
9941
|
-
</dd>
|
|
9942
|
-
</dl>
|
|
9943
|
-
|
|
9944
|
-
<dl>
|
|
9945
|
-
<dd>
|
|
9946
|
-
|
|
9947
10239
|
**limit:** `Integer` — Page limit (default 100)
|
|
9948
10240
|
|
|
9949
10241
|
</dd>
|
|
@@ -13705,7 +13997,7 @@ client.entitlements.get_user_usage_detail(
|
|
|
13705
13997
|
</details>
|
|
13706
13998
|
|
|
13707
13999
|
## plans
|
|
13708
|
-
<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>
|
|
13709
14001
|
<dl>
|
|
13710
14002
|
<dd>
|
|
13711
14003
|
|
|
@@ -13719,7 +14011,7 @@ client.entitlements.get_user_usage_detail(
|
|
|
13719
14011
|
|
|
13720
14012
|
```ruby
|
|
13721
14013
|
client.plans.update_company_plans(
|
|
13722
|
-
|
|
14014
|
+
company_id: "company_id",
|
|
13723
14015
|
add_on_ids: ["add_on_ids"]
|
|
13724
14016
|
)
|
|
13725
14017
|
```
|
|
@@ -13736,7 +14028,7 @@ client.plans.update_company_plans(
|
|
|
13736
14028
|
<dl>
|
|
13737
14029
|
<dd>
|
|
13738
14030
|
|
|
13739
|
-
**
|
|
14031
|
+
**company_id:** `String` — company_id
|
|
13740
14032
|
|
|
13741
14033
|
</dd>
|
|
13742
14034
|
</dl>
|
|
@@ -13788,6 +14080,7 @@ client.plans.update_company_plans(
|
|
|
13788
14080
|
client.plans.list_custom_plan_billings(
|
|
13789
14081
|
company_id: "company_id",
|
|
13790
14082
|
plan_id: "plan_id",
|
|
14083
|
+
plan_billing_source: "custom_plan",
|
|
13791
14084
|
status: "active",
|
|
13792
14085
|
statuses: ["active"],
|
|
13793
14086
|
limit: 1000000,
|
|
@@ -13823,6 +14116,14 @@ client.plans.list_custom_plan_billings(
|
|
|
13823
14116
|
<dl>
|
|
13824
14117
|
<dd>
|
|
13825
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
|
+
|
|
13826
14127
|
**status:** `Schematic::Types::CustomPlanBillingStatus` — Filter by billing status
|
|
13827
14128
|
|
|
13828
14129
|
</dd>
|
|
@@ -15074,7 +15375,7 @@ client.plans.list_plan_issues(
|
|
|
15074
15375
|
</dl>
|
|
15075
15376
|
</details>
|
|
15076
15377
|
|
|
15077
|
-
<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>
|
|
15078
15379
|
<dl>
|
|
15079
15380
|
<dd>
|
|
15080
15381
|
|
|
@@ -15088,7 +15389,7 @@ client.plans.list_plan_issues(
|
|
|
15088
15389
|
|
|
15089
15390
|
```ruby
|
|
15090
15391
|
client.plans.delete_plan_version(
|
|
15091
|
-
|
|
15392
|
+
plan_version_id: "plan_version_id",
|
|
15092
15393
|
promote_archived_version: true
|
|
15093
15394
|
)
|
|
15094
15395
|
```
|
|
@@ -15105,7 +15406,7 @@ client.plans.delete_plan_version(
|
|
|
15105
15406
|
<dl>
|
|
15106
15407
|
<dd>
|
|
15107
15408
|
|
|
15108
|
-
**
|
|
15409
|
+
**plan_version_id:** `String` — plan_version_id
|
|
15109
15410
|
|
|
15110
15411
|
</dd>
|
|
15111
15412
|
</dl>
|
|
@@ -15133,7 +15434,7 @@ client.plans.delete_plan_version(
|
|
|
15133
15434
|
</dl>
|
|
15134
15435
|
</details>
|
|
15135
15436
|
|
|
15136
|
-
<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>
|
|
15137
15438
|
<dl>
|
|
15138
15439
|
<dd>
|
|
15139
15440
|
|
|
@@ -15147,7 +15448,7 @@ client.plans.delete_plan_version(
|
|
|
15147
15448
|
|
|
15148
15449
|
```ruby
|
|
15149
15450
|
client.plans.publish_plan_version(
|
|
15150
|
-
|
|
15451
|
+
plan_version_id: "plan_version_id",
|
|
15151
15452
|
excluded_company_ids: ["excluded_company_ids"],
|
|
15152
15453
|
migration_strategy: "immediate"
|
|
15153
15454
|
)
|
|
@@ -15165,7 +15466,7 @@ client.plans.publish_plan_version(
|
|
|
15165
15466
|
<dl>
|
|
15166
15467
|
<dd>
|
|
15167
15468
|
|
|
15168
|
-
**
|
|
15469
|
+
**plan_version_id:** `String` — plan_version_id
|
|
15169
15470
|
|
|
15170
15471
|
</dd>
|
|
15171
15472
|
</dl>
|
|
@@ -15245,6 +15546,14 @@ client.plans.publish_plan_version(
|
|
|
15245
15546
|
<dl>
|
|
15246
15547
|
<dd>
|
|
15247
15548
|
|
|
15549
|
+
**proration_behavior:** `Schematic::Types::MigrationProrationBehavior`
|
|
15550
|
+
|
|
15551
|
+
</dd>
|
|
15552
|
+
</dl>
|
|
15553
|
+
|
|
15554
|
+
<dl>
|
|
15555
|
+
<dd>
|
|
15556
|
+
|
|
15248
15557
|
**send_invoice:** `Internal::Types::Boolean` — Whether Stripe emails the invoice when it is finalized. Defaults to true.
|
|
15249
15558
|
|
|
15250
15559
|
</dd>
|
|
@@ -15917,7 +16226,7 @@ client.planbundle.create_plan_bundle(entitlements: [{
|
|
|
15917
16226
|
</dl>
|
|
15918
16227
|
</details>
|
|
15919
16228
|
|
|
15920
|
-
<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>
|
|
15921
16230
|
<dl>
|
|
15922
16231
|
<dd>
|
|
15923
16232
|
|
|
@@ -15931,7 +16240,7 @@ client.planbundle.create_plan_bundle(entitlements: [{
|
|
|
15931
16240
|
|
|
15932
16241
|
```ruby
|
|
15933
16242
|
client.planbundle.update_plan_bundle(
|
|
15934
|
-
|
|
16243
|
+
plan_id: "plan_id",
|
|
15935
16244
|
entitlements: [{
|
|
15936
16245
|
action: "create"
|
|
15937
16246
|
}]
|
|
@@ -15950,7 +16259,7 @@ client.planbundle.update_plan_bundle(
|
|
|
15950
16259
|
<dl>
|
|
15951
16260
|
<dd>
|
|
15952
16261
|
|
|
15953
|
-
**
|
|
16262
|
+
**plan_id:** `String` — plan_id
|
|
15954
16263
|
|
|
15955
16264
|
</dd>
|
|
15956
16265
|
</dl>
|
|
@@ -19158,9 +19467,11 @@ client.plangroups.get_plan_group(include_company_counts: true)
|
|
|
19158
19467
|
```ruby
|
|
19159
19468
|
client.plangroups.create_plan_group(
|
|
19160
19469
|
add_on_ids: ["add_on_ids"],
|
|
19470
|
+
checkout_bundle_purchase_behavior: "individual",
|
|
19161
19471
|
checkout_collect_address: true,
|
|
19162
19472
|
checkout_collect_email: true,
|
|
19163
19473
|
checkout_collect_phone: true,
|
|
19474
|
+
checkout_collect_tax_id: true,
|
|
19164
19475
|
enable_tax_collection: true,
|
|
19165
19476
|
opt_in_enabled: true,
|
|
19166
19477
|
ordered_add_ons: [{
|
|
@@ -19213,6 +19524,14 @@ client.plangroups.create_plan_group(
|
|
|
19213
19524
|
<dl>
|
|
19214
19525
|
<dd>
|
|
19215
19526
|
|
|
19527
|
+
**checkout_bundle_purchase_behavior:** `Schematic::Types::CheckoutBundlePurchaseBehavior`
|
|
19528
|
+
|
|
19529
|
+
</dd>
|
|
19530
|
+
</dl>
|
|
19531
|
+
|
|
19532
|
+
<dl>
|
|
19533
|
+
<dd>
|
|
19534
|
+
|
|
19216
19535
|
**checkout_collect_address:** `Internal::Types::Boolean`
|
|
19217
19536
|
|
|
19218
19537
|
</dd>
|
|
@@ -19237,6 +19556,14 @@ client.plangroups.create_plan_group(
|
|
|
19237
19556
|
<dl>
|
|
19238
19557
|
<dd>
|
|
19239
19558
|
|
|
19559
|
+
**checkout_collect_tax_id:** `Internal::Types::Boolean`
|
|
19560
|
+
|
|
19561
|
+
</dd>
|
|
19562
|
+
</dl>
|
|
19563
|
+
|
|
19564
|
+
<dl>
|
|
19565
|
+
<dd>
|
|
19566
|
+
|
|
19240
19567
|
**custom_checkout_fields:** `Internal::Types::Array[Schematic::Types::CheckoutFieldInput]`
|
|
19241
19568
|
|
|
19242
19569
|
</dd>
|
|
@@ -19513,9 +19840,11 @@ client.plangroups.create_plan_group(
|
|
|
19513
19840
|
client.plangroups.update_plan_group(
|
|
19514
19841
|
plan_group_id: "plan_group_id",
|
|
19515
19842
|
add_on_ids: ["add_on_ids"],
|
|
19843
|
+
checkout_bundle_purchase_behavior: "individual",
|
|
19516
19844
|
checkout_collect_address: true,
|
|
19517
19845
|
checkout_collect_email: true,
|
|
19518
19846
|
checkout_collect_phone: true,
|
|
19847
|
+
checkout_collect_tax_id: true,
|
|
19519
19848
|
enable_tax_collection: true,
|
|
19520
19849
|
opt_in_enabled: true,
|
|
19521
19850
|
ordered_add_ons: [{
|
|
@@ -19576,6 +19905,14 @@ client.plangroups.update_plan_group(
|
|
|
19576
19905
|
<dl>
|
|
19577
19906
|
<dd>
|
|
19578
19907
|
|
|
19908
|
+
**checkout_bundle_purchase_behavior:** `Schematic::Types::CheckoutBundlePurchaseBehavior`
|
|
19909
|
+
|
|
19910
|
+
</dd>
|
|
19911
|
+
</dl>
|
|
19912
|
+
|
|
19913
|
+
<dl>
|
|
19914
|
+
<dd>
|
|
19915
|
+
|
|
19579
19916
|
**checkout_collect_address:** `Internal::Types::Boolean`
|
|
19580
19917
|
|
|
19581
19918
|
</dd>
|
|
@@ -19600,6 +19937,14 @@ client.plangroups.update_plan_group(
|
|
|
19600
19937
|
<dl>
|
|
19601
19938
|
<dd>
|
|
19602
19939
|
|
|
19940
|
+
**checkout_collect_tax_id:** `Internal::Types::Boolean`
|
|
19941
|
+
|
|
19942
|
+
</dd>
|
|
19943
|
+
</dl>
|
|
19944
|
+
|
|
19945
|
+
<dl>
|
|
19946
|
+
<dd>
|
|
19947
|
+
|
|
19603
19948
|
**custom_checkout_fields:** `Internal::Types::Array[Schematic::Types::CheckoutFieldInput]`
|
|
19604
19949
|
|
|
19605
19950
|
</dd>
|
|
@@ -20172,11 +20517,8 @@ client.planmigrations.list_migrations(
|
|
|
20172
20517
|
|
|
20173
20518
|
```ruby
|
|
20174
20519
|
client.planmigrations.create_migration(
|
|
20175
|
-
company_ids: ["company_ids"],
|
|
20176
|
-
excluded_company_ids: ["excluded_company_ids"],
|
|
20177
20520
|
plan_id: "plan_id",
|
|
20178
20521
|
plan_version_id_to: "plan_version_id_to",
|
|
20179
|
-
plan_version_ids_from: ["plan_version_ids_from"],
|
|
20180
20522
|
strategy: "immediate",
|
|
20181
20523
|
target_plan_type: "plan"
|
|
20182
20524
|
)
|
|
@@ -20234,6 +20576,14 @@ client.planmigrations.create_migration(
|
|
|
20234
20576
|
<dl>
|
|
20235
20577
|
<dd>
|
|
20236
20578
|
|
|
20579
|
+
**proration_behavior:** `Schematic::Types::MigrationProrationBehavior`
|
|
20580
|
+
|
|
20581
|
+
</dd>
|
|
20582
|
+
</dl>
|
|
20583
|
+
|
|
20584
|
+
<dl>
|
|
20585
|
+
<dd>
|
|
20586
|
+
|
|
20237
20587
|
**strategy:** `Schematic::Types::PlanVersionMigrationStrategy`
|
|
20238
20588
|
|
|
20239
20589
|
</dd>
|
|
@@ -20460,7 +20810,6 @@ client.planmigrations.count_migrations(
|
|
|
20460
20810
|
|
|
20461
20811
|
```ruby
|
|
20462
20812
|
client.planmigrations.preview_migration(
|
|
20463
|
-
company_ids: ["company_ids"],
|
|
20464
20813
|
plan_id: "plan_id",
|
|
20465
20814
|
plan_version_id_to: "plan_version_id_to",
|
|
20466
20815
|
target_plan_type: "plan"
|
|
@@ -20503,6 +20852,14 @@ client.planmigrations.preview_migration(
|
|
|
20503
20852
|
<dl>
|
|
20504
20853
|
<dd>
|
|
20505
20854
|
|
|
20855
|
+
**plan_version_ids_from:** `Internal::Types::Array[String]`
|
|
20856
|
+
|
|
20857
|
+
</dd>
|
|
20858
|
+
</dl>
|
|
20859
|
+
|
|
20860
|
+
<dl>
|
|
20861
|
+
<dd>
|
|
20862
|
+
|
|
20506
20863
|
**target_plan_type:** `Schematic::Types::PlanType`
|
|
20507
20864
|
|
|
20508
20865
|
</dd>
|