schematichq 1.4.2 → 1.4.4
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/README.md +33 -3
- data/WASM_VERSION +1 -1
- data/lib/schematic/accounts/client.rb +44 -0
- data/lib/schematic/accounts/types/count_account_members_params.rb +15 -0
- data/lib/schematic/accounts/types/count_account_members_request.rb +14 -0
- data/lib/schematic/accounts/types/count_account_members_response.rb +12 -0
- data/lib/schematic/billing/client.rb +32 -0
- data/lib/schematic/billing/types/delete_payment_method_by_external_id_response.rb +12 -0
- data/lib/schematic/client.rb +1 -1
- data/lib/schematic/companies/client.rb +6 -2
- data/lib/schematic/companies/types/count_companies_params.rb +1 -0
- data/lib/schematic/companies/types/count_companies_request.rb +1 -0
- data/lib/schematic/companies/types/list_companies_params.rb +1 -0
- data/lib/schematic/companies/types/list_companies_request.rb +1 -0
- data/lib/schematic/credits/client.rb +102 -0
- data/lib/schematic/credits/types/acquire_credit_lease_request_body.rb +14 -0
- data/lib/schematic/credits/types/acquire_credit_lease_response.rb +12 -0
- data/lib/schematic/credits/types/extend_credit_lease_request_body.rb +13 -0
- data/lib/schematic/credits/types/extend_credit_lease_response.rb +12 -0
- data/lib/schematic/credits/types/release_credit_lease_response.rb +12 -0
- data/lib/schematic/datastream/merge.rb +71 -0
- data/lib/schematic/entitlements/types/create_billing_linked_plan_entitlement_request_body.rb +1 -0
- data/lib/schematic/entitlements/types/create_plan_entitlement_request_body.rb +1 -0
- data/lib/schematic/entitlements/types/update_plan_entitlement_request_body.rb +1 -0
- data/lib/schematic/event_buffer.rb +7 -1
- data/lib/schematic/integrationsapi/client.rb +99 -3
- data/lib/schematic/integrationsapi/types/assume_stripe_installed_response.rb +12 -0
- data/lib/schematic/integrationsapi/types/install_integration_response.rb +12 -0
- data/lib/schematic/integrationsapi/types/install_stripe_response.rb +12 -0
- data/lib/schematic/integrationsapi/types/{load_sample_data_set_v_2_response.rb → load_sample_data_set_response.rb} +1 -1
- data/lib/schematic/logger.rb +1 -1
- data/lib/schematic/plangroups/types/create_plan_group_request_body.rb +1 -0
- data/lib/schematic/plangroups/types/update_plan_group_request_body.rb +1 -0
- data/lib/schematic/planmigrations/client.rb +101 -0
- data/lib/schematic/planmigrations/types/create_migration_input.rb +17 -0
- data/lib/schematic/planmigrations/types/create_migration_response.rb +12 -0
- data/lib/schematic/planmigrations/types/retry_company_migration_response.rb +12 -0
- data/lib/schematic/planmigrations/types/retry_migration_request_body.rb +12 -0
- data/lib/schematic/planmigrations/types/retry_migration_response.rb +12 -0
- data/lib/schematic/plans/client.rb +39 -2
- data/lib/schematic/plans/types/count_plans_params.rb +1 -0
- data/lib/schematic/plans/types/count_plans_request.rb +1 -0
- data/lib/schematic/plans/types/list_plans_params.rb +1 -0
- data/lib/schematic/plans/types/list_plans_request.rb +1 -0
- data/lib/schematic/plans/types/mark_custom_plan_billing_paid_response.rb +12 -0
- data/lib/schematic/schematic_client.rb +46 -13
- data/lib/schematic/types/account_member_response_data.rb +2 -0
- data/lib/schematic/types/billing_credit_grant_reason.rb +1 -0
- data/lib/schematic/types/billing_credit_grant_response_data.rb +3 -0
- data/lib/schematic/types/billing_credit_ledger_authority.rb +13 -0
- data/lib/schematic/types/billing_credit_view.rb +1 -0
- data/lib/schematic/types/billing_plan_credit_grant_response_data.rb +1 -0
- data/lib/schematic/types/billing_provider_type.rb +1 -0
- data/lib/schematic/types/change_subscription_internal_request_body.rb +1 -0
- data/lib/schematic/types/change_subscription_request_body.rb +1 -0
- data/lib/schematic/types/checkout_data_response_data.rb +1 -0
- data/lib/schematic/types/checkout_field_input.rb +14 -0
- data/lib/schematic/types/checkout_field_response_data.rb +18 -0
- data/lib/schematic/types/checkout_field_value.rb +10 -0
- data/lib/schematic/types/checkout_field_with_value.rb +15 -0
- data/lib/schematic/types/checkout_subscription.rb +1 -0
- data/lib/schematic/types/company_credit_balance_response_data.rb +2 -0
- data/lib/schematic/types/company_plan_credit_grant_view.rb +1 -0
- data/lib/schematic/types/company_plan_detail_response_data.rb +2 -1
- data/lib/schematic/types/component_hydrate_response_data.rb +1 -0
- data/lib/schematic/types/component_preview_response_data.rb +1 -0
- data/lib/schematic/types/create_billing_plan_credit_grant_request_body.rb +1 -0
- data/lib/schematic/types/create_entitlement_in_bundle_request_body.rb +1 -0
- data/lib/schematic/types/credit_company_grant_view.rb +3 -0
- data/lib/schematic/types/credit_event_ledger_response_data.rb +1 -0
- data/lib/schematic/types/credit_lease_response_data.rb +16 -0
- data/lib/schematic/types/credit_usage_reason.rb +15 -0
- data/lib/schematic/types/custom_plan_billing_response_data.rb +1 -0
- data/lib/schematic/types/event_body_track.rb +1 -0
- data/lib/schematic/types/event_detail_response_data.rb +1 -0
- data/lib/schematic/types/event_response_data.rb +1 -0
- data/lib/schematic/types/feature_view.rb +1 -0
- data/lib/schematic/types/install_integration_request_body.rb +14 -0
- data/lib/schematic/types/integration_config.rb +2 -0
- data/lib/schematic/types/integration_install_config.rb +18 -0
- data/lib/schematic/types/integration_install_response_data.rb +11 -0
- data/lib/schematic/types/integration_type.rb +2 -0
- data/lib/schematic/types/manage_plan_request.rb +1 -0
- data/lib/schematic/types/mark_custom_plan_billing_paid_request_body.rb +23 -0
- data/lib/schematic/types/metronome_integration_config.rb +7 -0
- data/lib/schematic/types/migration_error_code.rb +22 -0
- data/lib/schematic/types/plan_credit_grant_view.rb +1 -0
- data/lib/schematic/types/plan_detail_response_data.rb +1 -0
- data/lib/schematic/types/plan_entitlement_response_data.rb +1 -0
- data/lib/schematic/types/plan_group_detail_response_data.rb +1 -0
- data/lib/schematic/types/plan_group_plan_detail_response_data.rb +2 -1
- data/lib/schematic/types/plan_price_cadence.rb +13 -0
- data/lib/schematic/types/plan_version_company_migration_response_data.rb +1 -0
- data/lib/schematic/types/plan_version_migration_response_data.rb +1 -0
- data/lib/schematic/types/plan_view_public_response_data.rb +2 -1
- data/lib/schematic/types/release_credit_lease_request_body.rb +23 -0
- data/lib/schematic/types/stripe_integration_config.rb +0 -1
- data/lib/schematic/types/update_billing_plan_credit_grant_request_body.rb +1 -0
- data/lib/schematic/types/usage_based_entitlement_request_body.rb +1 -0
- data/lib/schematic/types/usage_based_entitlement_response_data.rb +1 -0
- data/lib/schematic/types/work_os_integration_config.rb +10 -0
- data/lib/schematic/version.rb +1 -1
- data/lib/schematic/wasm/rulesengine.wasm +0 -0
- data/lib/schematic.rb +38 -4
- data/reference.md +906 -73
- metadata +37 -3
data/reference.md
CHANGED
|
@@ -121,6 +121,83 @@ client.accounts.get_account_member(account_member_id: "account_member_id")
|
|
|
121
121
|
</dl>
|
|
122
122
|
|
|
123
123
|
|
|
124
|
+
</dd>
|
|
125
|
+
</dl>
|
|
126
|
+
</details>
|
|
127
|
+
|
|
128
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">count_account_members</a>() -> Schematic::Accounts::Types::CountAccountMembersResponse</code></summary>
|
|
129
|
+
<dl>
|
|
130
|
+
<dd>
|
|
131
|
+
|
|
132
|
+
#### 🔌 Usage
|
|
133
|
+
|
|
134
|
+
<dl>
|
|
135
|
+
<dd>
|
|
136
|
+
|
|
137
|
+
<dl>
|
|
138
|
+
<dd>
|
|
139
|
+
|
|
140
|
+
```ruby
|
|
141
|
+
client.accounts.count_account_members(
|
|
142
|
+
ids: ["ids"],
|
|
143
|
+
q: "q",
|
|
144
|
+
limit: 1000000,
|
|
145
|
+
offset: 1000000
|
|
146
|
+
)
|
|
147
|
+
```
|
|
148
|
+
</dd>
|
|
149
|
+
</dl>
|
|
150
|
+
</dd>
|
|
151
|
+
</dl>
|
|
152
|
+
|
|
153
|
+
#### ⚙️ Parameters
|
|
154
|
+
|
|
155
|
+
<dl>
|
|
156
|
+
<dd>
|
|
157
|
+
|
|
158
|
+
<dl>
|
|
159
|
+
<dd>
|
|
160
|
+
|
|
161
|
+
**ids:** `String`
|
|
162
|
+
|
|
163
|
+
</dd>
|
|
164
|
+
</dl>
|
|
165
|
+
|
|
166
|
+
<dl>
|
|
167
|
+
<dd>
|
|
168
|
+
|
|
169
|
+
**q:** `String` — Search filter
|
|
170
|
+
|
|
171
|
+
</dd>
|
|
172
|
+
</dl>
|
|
173
|
+
|
|
174
|
+
<dl>
|
|
175
|
+
<dd>
|
|
176
|
+
|
|
177
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
178
|
+
|
|
179
|
+
</dd>
|
|
180
|
+
</dl>
|
|
181
|
+
|
|
182
|
+
<dl>
|
|
183
|
+
<dd>
|
|
184
|
+
|
|
185
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
186
|
+
|
|
187
|
+
</dd>
|
|
188
|
+
</dl>
|
|
189
|
+
|
|
190
|
+
<dl>
|
|
191
|
+
<dd>
|
|
192
|
+
|
|
193
|
+
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
194
|
+
|
|
195
|
+
</dd>
|
|
196
|
+
</dl>
|
|
197
|
+
</dd>
|
|
198
|
+
</dl>
|
|
199
|
+
|
|
200
|
+
|
|
124
201
|
</dd>
|
|
125
202
|
</dl>
|
|
126
203
|
</details>
|
|
@@ -1452,7 +1529,7 @@ client.billing.upsert_billing_customer(
|
|
|
1452
1529
|
client.billing.list_customers_with_subscriptions(
|
|
1453
1530
|
company_ids: ["company_ids"],
|
|
1454
1531
|
name: "name",
|
|
1455
|
-
provider_type: "
|
|
1532
|
+
provider_type: "metronome",
|
|
1456
1533
|
q: "q",
|
|
1457
1534
|
limit: 1000000,
|
|
1458
1535
|
offset: 1000000
|
|
@@ -1547,7 +1624,7 @@ client.billing.list_customers_with_subscriptions(
|
|
|
1547
1624
|
client.billing.count_customers(
|
|
1548
1625
|
company_ids: ["company_ids"],
|
|
1549
1626
|
name: "name",
|
|
1550
|
-
provider_type: "
|
|
1627
|
+
provider_type: "metronome",
|
|
1551
1628
|
q: "q",
|
|
1552
1629
|
limit: 1000000,
|
|
1553
1630
|
offset: 1000000
|
|
@@ -2230,6 +2307,54 @@ client.billing.upsert_payment_method(
|
|
|
2230
2307
|
</dl>
|
|
2231
2308
|
|
|
2232
2309
|
|
|
2310
|
+
</dd>
|
|
2311
|
+
</dl>
|
|
2312
|
+
</details>
|
|
2313
|
+
|
|
2314
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">delete_payment_method_by_external_id</a>(billing_id) -> Schematic::Billing::Types::DeletePaymentMethodByExternalIdResponse</code></summary>
|
|
2315
|
+
<dl>
|
|
2316
|
+
<dd>
|
|
2317
|
+
|
|
2318
|
+
#### 🔌 Usage
|
|
2319
|
+
|
|
2320
|
+
<dl>
|
|
2321
|
+
<dd>
|
|
2322
|
+
|
|
2323
|
+
<dl>
|
|
2324
|
+
<dd>
|
|
2325
|
+
|
|
2326
|
+
```ruby
|
|
2327
|
+
client.billing.delete_payment_method_by_external_id(billing_id: "billing_id")
|
|
2328
|
+
```
|
|
2329
|
+
</dd>
|
|
2330
|
+
</dl>
|
|
2331
|
+
</dd>
|
|
2332
|
+
</dl>
|
|
2333
|
+
|
|
2334
|
+
#### ⚙️ Parameters
|
|
2335
|
+
|
|
2336
|
+
<dl>
|
|
2337
|
+
<dd>
|
|
2338
|
+
|
|
2339
|
+
<dl>
|
|
2340
|
+
<dd>
|
|
2341
|
+
|
|
2342
|
+
**billing_id:** `String` — billing_id
|
|
2343
|
+
|
|
2344
|
+
</dd>
|
|
2345
|
+
</dl>
|
|
2346
|
+
|
|
2347
|
+
<dl>
|
|
2348
|
+
<dd>
|
|
2349
|
+
|
|
2350
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
2351
|
+
|
|
2352
|
+
</dd>
|
|
2353
|
+
</dl>
|
|
2354
|
+
</dd>
|
|
2355
|
+
</dl>
|
|
2356
|
+
|
|
2357
|
+
|
|
2233
2358
|
</dd>
|
|
2234
2359
|
</dl>
|
|
2235
2360
|
</details>
|
|
@@ -2257,7 +2382,7 @@ client.billing.list_billing_prices(
|
|
|
2257
2382
|
price: 1000000,
|
|
2258
2383
|
product_id: "product_id",
|
|
2259
2384
|
product_ids: ["product_ids"],
|
|
2260
|
-
provider_type: "
|
|
2385
|
+
provider_type: "metronome",
|
|
2261
2386
|
q: "q",
|
|
2262
2387
|
tiers_mode: "graduated",
|
|
2263
2388
|
usage_type: "licensed",
|
|
@@ -2679,7 +2804,7 @@ client.billing.list_billing_product_prices(
|
|
|
2679
2804
|
price: 1000000,
|
|
2680
2805
|
product_id: "product_id",
|
|
2681
2806
|
product_ids: ["product_ids"],
|
|
2682
|
-
provider_type: "
|
|
2807
|
+
provider_type: "metronome",
|
|
2683
2808
|
q: "q",
|
|
2684
2809
|
tiers_mode: "graduated",
|
|
2685
2810
|
usage_type: "licensed",
|
|
@@ -2990,7 +3115,7 @@ client.billing.list_billing_products(
|
|
|
2990
3115
|
is_active: true,
|
|
2991
3116
|
name: "name",
|
|
2992
3117
|
price_usage_type: "licensed",
|
|
2993
|
-
provider_type: "
|
|
3118
|
+
provider_type: "metronome",
|
|
2994
3119
|
q: "q",
|
|
2995
3120
|
recurring_charges_only: true,
|
|
2996
3121
|
with_one_time_charges: true,
|
|
@@ -3148,7 +3273,7 @@ client.billing.count_billing_products(
|
|
|
3148
3273
|
is_active: true,
|
|
3149
3274
|
name: "name",
|
|
3150
3275
|
price_usage_type: "licensed",
|
|
3151
|
-
provider_type: "
|
|
3276
|
+
provider_type: "metronome",
|
|
3152
3277
|
q: "q",
|
|
3153
3278
|
recurring_charges_only: true,
|
|
3154
3279
|
with_one_time_charges: true,
|
|
@@ -5179,7 +5304,7 @@ client.credits.list_grants_for_credit(
|
|
|
5179
5304
|
</dl>
|
|
5180
5305
|
</details>
|
|
5181
5306
|
|
|
5182
|
-
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">
|
|
5307
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">acquire_credit_lease</a>(request) -> Schematic::Credits::Types::AcquireCreditLeaseResponse</code></summary>
|
|
5183
5308
|
<dl>
|
|
5184
5309
|
<dd>
|
|
5185
5310
|
|
|
@@ -5192,15 +5317,10 @@ client.credits.list_grants_for_credit(
|
|
|
5192
5317
|
<dd>
|
|
5193
5318
|
|
|
5194
5319
|
```ruby
|
|
5195
|
-
client.credits.
|
|
5320
|
+
client.credits.acquire_credit_lease(
|
|
5196
5321
|
company_id: "company_id",
|
|
5197
|
-
|
|
5198
|
-
|
|
5199
|
-
period: "daily",
|
|
5200
|
-
start_time: "start_time",
|
|
5201
|
-
end_time: "end_time",
|
|
5202
|
-
limit: 1000000,
|
|
5203
|
-
offset: 1000000
|
|
5322
|
+
credit_type_id: "credit_type_id",
|
|
5323
|
+
requested_amount: 1.1
|
|
5204
5324
|
)
|
|
5205
5325
|
```
|
|
5206
5326
|
</dd>
|
|
@@ -5224,7 +5344,7 @@ client.credits.get_enriched_credit_ledger(
|
|
|
5224
5344
|
<dl>
|
|
5225
5345
|
<dd>
|
|
5226
5346
|
|
|
5227
|
-
**
|
|
5347
|
+
**credit_type_id:** `String`
|
|
5228
5348
|
|
|
5229
5349
|
</dd>
|
|
5230
5350
|
</dl>
|
|
@@ -5232,7 +5352,7 @@ client.credits.get_enriched_credit_ledger(
|
|
|
5232
5352
|
<dl>
|
|
5233
5353
|
<dd>
|
|
5234
5354
|
|
|
5235
|
-
**
|
|
5355
|
+
**expires_at:** `String`
|
|
5236
5356
|
|
|
5237
5357
|
</dd>
|
|
5238
5358
|
</dl>
|
|
@@ -5240,7 +5360,7 @@ client.credits.get_enriched_credit_ledger(
|
|
|
5240
5360
|
<dl>
|
|
5241
5361
|
<dd>
|
|
5242
5362
|
|
|
5243
|
-
**
|
|
5363
|
+
**requested_amount:** `Integer`
|
|
5244
5364
|
|
|
5245
5365
|
</dd>
|
|
5246
5366
|
</dl>
|
|
@@ -5248,15 +5368,50 @@ client.credits.get_enriched_credit_ledger(
|
|
|
5248
5368
|
<dl>
|
|
5249
5369
|
<dd>
|
|
5250
5370
|
|
|
5251
|
-
**
|
|
5371
|
+
**request_options:** `Schematic::Credits::RequestOptions`
|
|
5252
5372
|
|
|
5253
5373
|
</dd>
|
|
5254
5374
|
</dl>
|
|
5375
|
+
</dd>
|
|
5376
|
+
</dl>
|
|
5377
|
+
|
|
5378
|
+
|
|
5379
|
+
</dd>
|
|
5380
|
+
</dl>
|
|
5381
|
+
</details>
|
|
5255
5382
|
|
|
5383
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">extend_credit_lease</a>(lease_id, request) -> Schematic::Credits::Types::ExtendCreditLeaseResponse</code></summary>
|
|
5256
5384
|
<dl>
|
|
5257
5385
|
<dd>
|
|
5258
5386
|
|
|
5259
|
-
|
|
5387
|
+
#### 🔌 Usage
|
|
5388
|
+
|
|
5389
|
+
<dl>
|
|
5390
|
+
<dd>
|
|
5391
|
+
|
|
5392
|
+
<dl>
|
|
5393
|
+
<dd>
|
|
5394
|
+
|
|
5395
|
+
```ruby
|
|
5396
|
+
client.credits.extend_credit_lease(
|
|
5397
|
+
lease_id: "lease_id",
|
|
5398
|
+
additional_amount: 1.1
|
|
5399
|
+
)
|
|
5400
|
+
```
|
|
5401
|
+
</dd>
|
|
5402
|
+
</dl>
|
|
5403
|
+
</dd>
|
|
5404
|
+
</dl>
|
|
5405
|
+
|
|
5406
|
+
#### ⚙️ Parameters
|
|
5407
|
+
|
|
5408
|
+
<dl>
|
|
5409
|
+
<dd>
|
|
5410
|
+
|
|
5411
|
+
<dl>
|
|
5412
|
+
<dd>
|
|
5413
|
+
|
|
5414
|
+
**lease_id:** `String` — lease_id
|
|
5260
5415
|
|
|
5261
5416
|
</dd>
|
|
5262
5417
|
</dl>
|
|
@@ -5264,7 +5419,7 @@ client.credits.get_enriched_credit_ledger(
|
|
|
5264
5419
|
<dl>
|
|
5265
5420
|
<dd>
|
|
5266
5421
|
|
|
5267
|
-
**
|
|
5422
|
+
**additional_amount:** `Integer`
|
|
5268
5423
|
|
|
5269
5424
|
</dd>
|
|
5270
5425
|
</dl>
|
|
@@ -5272,7 +5427,7 @@ client.credits.get_enriched_credit_ledger(
|
|
|
5272
5427
|
<dl>
|
|
5273
5428
|
<dd>
|
|
5274
5429
|
|
|
5275
|
-
**
|
|
5430
|
+
**expires_at:** `String`
|
|
5276
5431
|
|
|
5277
5432
|
</dd>
|
|
5278
5433
|
</dl>
|
|
@@ -5292,7 +5447,7 @@ client.credits.get_enriched_credit_ledger(
|
|
|
5292
5447
|
</dl>
|
|
5293
5448
|
</details>
|
|
5294
5449
|
|
|
5295
|
-
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">
|
|
5450
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">release_credit_lease</a>(lease_id, request) -> Schematic::Credits::Types::ReleaseCreditLeaseResponse</code></summary>
|
|
5296
5451
|
<dl>
|
|
5297
5452
|
<dd>
|
|
5298
5453
|
|
|
@@ -5305,7 +5460,66 @@ client.credits.get_enriched_credit_ledger(
|
|
|
5305
5460
|
<dd>
|
|
5306
5461
|
|
|
5307
5462
|
```ruby
|
|
5308
|
-
client.credits.
|
|
5463
|
+
client.credits.release_credit_lease(
|
|
5464
|
+
lease_id: "lease_id",
|
|
5465
|
+
request: {}
|
|
5466
|
+
)
|
|
5467
|
+
```
|
|
5468
|
+
</dd>
|
|
5469
|
+
</dl>
|
|
5470
|
+
</dd>
|
|
5471
|
+
</dl>
|
|
5472
|
+
|
|
5473
|
+
#### ⚙️ Parameters
|
|
5474
|
+
|
|
5475
|
+
<dl>
|
|
5476
|
+
<dd>
|
|
5477
|
+
|
|
5478
|
+
<dl>
|
|
5479
|
+
<dd>
|
|
5480
|
+
|
|
5481
|
+
**lease_id:** `String` — lease_id
|
|
5482
|
+
|
|
5483
|
+
</dd>
|
|
5484
|
+
</dl>
|
|
5485
|
+
|
|
5486
|
+
<dl>
|
|
5487
|
+
<dd>
|
|
5488
|
+
|
|
5489
|
+
**request:** `Internal::Types::Hash[String, Object]`
|
|
5490
|
+
|
|
5491
|
+
</dd>
|
|
5492
|
+
</dl>
|
|
5493
|
+
|
|
5494
|
+
<dl>
|
|
5495
|
+
<dd>
|
|
5496
|
+
|
|
5497
|
+
**request_options:** `Schematic::Credits::RequestOptions`
|
|
5498
|
+
|
|
5499
|
+
</dd>
|
|
5500
|
+
</dl>
|
|
5501
|
+
</dd>
|
|
5502
|
+
</dl>
|
|
5503
|
+
|
|
5504
|
+
|
|
5505
|
+
</dd>
|
|
5506
|
+
</dl>
|
|
5507
|
+
</details>
|
|
5508
|
+
|
|
5509
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">get_enriched_credit_ledger</a>() -> Schematic::Credits::Types::GetEnrichedCreditLedgerResponse</code></summary>
|
|
5510
|
+
<dl>
|
|
5511
|
+
<dd>
|
|
5512
|
+
|
|
5513
|
+
#### 🔌 Usage
|
|
5514
|
+
|
|
5515
|
+
<dl>
|
|
5516
|
+
<dd>
|
|
5517
|
+
|
|
5518
|
+
<dl>
|
|
5519
|
+
<dd>
|
|
5520
|
+
|
|
5521
|
+
```ruby
|
|
5522
|
+
client.credits.get_enriched_credit_ledger(
|
|
5309
5523
|
company_id: "company_id",
|
|
5310
5524
|
billing_credit_id: "billing_credit_id",
|
|
5311
5525
|
feature_id: "feature_id",
|
|
@@ -5405,7 +5619,7 @@ client.credits.count_credit_ledger(
|
|
|
5405
5619
|
</dl>
|
|
5406
5620
|
</details>
|
|
5407
5621
|
|
|
5408
|
-
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">
|
|
5622
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">count_credit_ledger</a>() -> Schematic::Credits::Types::CountCreditLedgerResponse</code></summary>
|
|
5409
5623
|
<dl>
|
|
5410
5624
|
<dd>
|
|
5411
5625
|
|
|
@@ -5418,13 +5632,13 @@ client.credits.count_credit_ledger(
|
|
|
5418
5632
|
<dd>
|
|
5419
5633
|
|
|
5420
5634
|
```ruby
|
|
5421
|
-
client.credits.
|
|
5422
|
-
|
|
5423
|
-
|
|
5424
|
-
|
|
5425
|
-
|
|
5426
|
-
|
|
5427
|
-
|
|
5635
|
+
client.credits.count_credit_ledger(
|
|
5636
|
+
company_id: "company_id",
|
|
5637
|
+
billing_credit_id: "billing_credit_id",
|
|
5638
|
+
feature_id: "feature_id",
|
|
5639
|
+
period: "daily",
|
|
5640
|
+
start_time: "start_time",
|
|
5641
|
+
end_time: "end_time",
|
|
5428
5642
|
limit: 1000000,
|
|
5429
5643
|
offset: 1000000
|
|
5430
5644
|
)
|
|
@@ -5442,7 +5656,7 @@ client.credits.list_billing_plan_credit_grants(
|
|
|
5442
5656
|
<dl>
|
|
5443
5657
|
<dd>
|
|
5444
5658
|
|
|
5445
|
-
**
|
|
5659
|
+
**company_id:** `String`
|
|
5446
5660
|
|
|
5447
5661
|
</dd>
|
|
5448
5662
|
</dl>
|
|
@@ -5450,7 +5664,7 @@ client.credits.list_billing_plan_credit_grants(
|
|
|
5450
5664
|
<dl>
|
|
5451
5665
|
<dd>
|
|
5452
5666
|
|
|
5453
|
-
**
|
|
5667
|
+
**billing_credit_id:** `String`
|
|
5454
5668
|
|
|
5455
5669
|
</dd>
|
|
5456
5670
|
</dl>
|
|
@@ -5458,7 +5672,7 @@ client.credits.list_billing_plan_credit_grants(
|
|
|
5458
5672
|
<dl>
|
|
5459
5673
|
<dd>
|
|
5460
5674
|
|
|
5461
|
-
**
|
|
5675
|
+
**feature_id:** `String`
|
|
5462
5676
|
|
|
5463
5677
|
</dd>
|
|
5464
5678
|
</dl>
|
|
@@ -5466,7 +5680,7 @@ client.credits.list_billing_plan_credit_grants(
|
|
|
5466
5680
|
<dl>
|
|
5467
5681
|
<dd>
|
|
5468
5682
|
|
|
5469
|
-
**
|
|
5683
|
+
**period:** `Schematic::Types::CreditLedgerPeriod`
|
|
5470
5684
|
|
|
5471
5685
|
</dd>
|
|
5472
5686
|
</dl>
|
|
@@ -5474,7 +5688,7 @@ client.credits.list_billing_plan_credit_grants(
|
|
|
5474
5688
|
<dl>
|
|
5475
5689
|
<dd>
|
|
5476
5690
|
|
|
5477
|
-
**
|
|
5691
|
+
**start_time:** `String`
|
|
5478
5692
|
|
|
5479
5693
|
</dd>
|
|
5480
5694
|
</dl>
|
|
@@ -5482,7 +5696,120 @@ client.credits.list_billing_plan_credit_grants(
|
|
|
5482
5696
|
<dl>
|
|
5483
5697
|
<dd>
|
|
5484
5698
|
|
|
5485
|
-
**
|
|
5699
|
+
**end_time:** `String`
|
|
5700
|
+
|
|
5701
|
+
</dd>
|
|
5702
|
+
</dl>
|
|
5703
|
+
|
|
5704
|
+
<dl>
|
|
5705
|
+
<dd>
|
|
5706
|
+
|
|
5707
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
5708
|
+
|
|
5709
|
+
</dd>
|
|
5710
|
+
</dl>
|
|
5711
|
+
|
|
5712
|
+
<dl>
|
|
5713
|
+
<dd>
|
|
5714
|
+
|
|
5715
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
5716
|
+
|
|
5717
|
+
</dd>
|
|
5718
|
+
</dl>
|
|
5719
|
+
|
|
5720
|
+
<dl>
|
|
5721
|
+
<dd>
|
|
5722
|
+
|
|
5723
|
+
**request_options:** `Schematic::Credits::RequestOptions`
|
|
5724
|
+
|
|
5725
|
+
</dd>
|
|
5726
|
+
</dl>
|
|
5727
|
+
</dd>
|
|
5728
|
+
</dl>
|
|
5729
|
+
|
|
5730
|
+
|
|
5731
|
+
</dd>
|
|
5732
|
+
</dl>
|
|
5733
|
+
</details>
|
|
5734
|
+
|
|
5735
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">list_billing_plan_credit_grants</a>() -> Schematic::Credits::Types::ListBillingPlanCreditGrantsResponse</code></summary>
|
|
5736
|
+
<dl>
|
|
5737
|
+
<dd>
|
|
5738
|
+
|
|
5739
|
+
#### 🔌 Usage
|
|
5740
|
+
|
|
5741
|
+
<dl>
|
|
5742
|
+
<dd>
|
|
5743
|
+
|
|
5744
|
+
<dl>
|
|
5745
|
+
<dd>
|
|
5746
|
+
|
|
5747
|
+
```ruby
|
|
5748
|
+
client.credits.list_billing_plan_credit_grants(
|
|
5749
|
+
credit_id: "credit_id",
|
|
5750
|
+
ids: ["ids"],
|
|
5751
|
+
plan_id: "plan_id",
|
|
5752
|
+
plan_ids: ["plan_ids"],
|
|
5753
|
+
plan_version_id: "plan_version_id",
|
|
5754
|
+
plan_version_ids: ["plan_version_ids"],
|
|
5755
|
+
limit: 1000000,
|
|
5756
|
+
offset: 1000000
|
|
5757
|
+
)
|
|
5758
|
+
```
|
|
5759
|
+
</dd>
|
|
5760
|
+
</dl>
|
|
5761
|
+
</dd>
|
|
5762
|
+
</dl>
|
|
5763
|
+
|
|
5764
|
+
#### ⚙️ Parameters
|
|
5765
|
+
|
|
5766
|
+
<dl>
|
|
5767
|
+
<dd>
|
|
5768
|
+
|
|
5769
|
+
<dl>
|
|
5770
|
+
<dd>
|
|
5771
|
+
|
|
5772
|
+
**credit_id:** `String`
|
|
5773
|
+
|
|
5774
|
+
</dd>
|
|
5775
|
+
</dl>
|
|
5776
|
+
|
|
5777
|
+
<dl>
|
|
5778
|
+
<dd>
|
|
5779
|
+
|
|
5780
|
+
**ids:** `String`
|
|
5781
|
+
|
|
5782
|
+
</dd>
|
|
5783
|
+
</dl>
|
|
5784
|
+
|
|
5785
|
+
<dl>
|
|
5786
|
+
<dd>
|
|
5787
|
+
|
|
5788
|
+
**plan_id:** `String`
|
|
5789
|
+
|
|
5790
|
+
</dd>
|
|
5791
|
+
</dl>
|
|
5792
|
+
|
|
5793
|
+
<dl>
|
|
5794
|
+
<dd>
|
|
5795
|
+
|
|
5796
|
+
**plan_ids:** `String`
|
|
5797
|
+
|
|
5798
|
+
</dd>
|
|
5799
|
+
</dl>
|
|
5800
|
+
|
|
5801
|
+
<dl>
|
|
5802
|
+
<dd>
|
|
5803
|
+
|
|
5804
|
+
**plan_version_id:** `String`
|
|
5805
|
+
|
|
5806
|
+
</dd>
|
|
5807
|
+
</dl>
|
|
5808
|
+
|
|
5809
|
+
<dl>
|
|
5810
|
+
<dd>
|
|
5811
|
+
|
|
5812
|
+
**plan_version_ids:** `String`
|
|
5486
5813
|
|
|
5487
5814
|
</dd>
|
|
5488
5815
|
</dl>
|
|
@@ -6105,6 +6432,10 @@ client.checkout.internal(
|
|
|
6105
6432
|
bundle_id: "bundle_id",
|
|
6106
6433
|
quantity: 1000000
|
|
6107
6434
|
}],
|
|
6435
|
+
custom_field_values: [{
|
|
6436
|
+
id: "id",
|
|
6437
|
+
value: "value"
|
|
6438
|
+
}],
|
|
6108
6439
|
new_plan_id: "new_plan_id",
|
|
6109
6440
|
new_price_id: "new_price_id",
|
|
6110
6441
|
pay_in_advance: [{
|
|
@@ -6229,6 +6560,10 @@ client.checkout.preview_checkout_internal(
|
|
|
6229
6560
|
bundle_id: "bundle_id",
|
|
6230
6561
|
quantity: 1000000
|
|
6231
6562
|
}],
|
|
6563
|
+
custom_field_values: [{
|
|
6564
|
+
id: "id",
|
|
6565
|
+
value: "value"
|
|
6566
|
+
}],
|
|
6232
6567
|
new_plan_id: "new_plan_id",
|
|
6233
6568
|
new_price_id: "new_price_id",
|
|
6234
6569
|
pay_in_advance: [{
|
|
@@ -6293,6 +6628,10 @@ client.checkout.manage_plan(
|
|
|
6293
6628
|
bundle_id: "bundle_id",
|
|
6294
6629
|
quantity: 1000000
|
|
6295
6630
|
}],
|
|
6631
|
+
custom_field_values: [{
|
|
6632
|
+
id: "id",
|
|
6633
|
+
value: "value"
|
|
6634
|
+
}],
|
|
6296
6635
|
pay_in_advance_entitlements: [{
|
|
6297
6636
|
price_id: "price_id",
|
|
6298
6637
|
quantity: 1000000
|
|
@@ -6354,6 +6693,10 @@ client.checkout.preview_manage_plan(
|
|
|
6354
6693
|
bundle_id: "bundle_id",
|
|
6355
6694
|
quantity: 1000000
|
|
6356
6695
|
}],
|
|
6696
|
+
custom_field_values: [{
|
|
6697
|
+
id: "id",
|
|
6698
|
+
value: "value"
|
|
6699
|
+
}],
|
|
6357
6700
|
pay_in_advance_entitlements: [{
|
|
6358
6701
|
price_id: "price_id",
|
|
6359
6702
|
quantity: 1000000
|
|
@@ -6535,6 +6878,7 @@ client.companies.list_companies(
|
|
|
6535
6878
|
plan_id: "plan_id",
|
|
6536
6879
|
plan_ids: ["plan_ids"],
|
|
6537
6880
|
plan_version_id: "plan_version_id",
|
|
6881
|
+
plan_version_ids: ["plan_version_ids"],
|
|
6538
6882
|
q: "q",
|
|
6539
6883
|
sort_order_column: "sort_order_column",
|
|
6540
6884
|
sort_order_direction: "asc",
|
|
@@ -6618,6 +6962,14 @@ client.companies.list_companies(
|
|
|
6618
6962
|
<dl>
|
|
6619
6963
|
<dd>
|
|
6620
6964
|
|
|
6965
|
+
**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.
|
|
6966
|
+
|
|
6967
|
+
</dd>
|
|
6968
|
+
</dl>
|
|
6969
|
+
|
|
6970
|
+
<dl>
|
|
6971
|
+
<dd>
|
|
6972
|
+
|
|
6621
6973
|
**q:** `String` — Search for companies by name, keys or string traits
|
|
6622
6974
|
|
|
6623
6975
|
</dd>
|
|
@@ -6913,6 +7265,7 @@ client.companies.count_companies(
|
|
|
6913
7265
|
plan_id: "plan_id",
|
|
6914
7266
|
plan_ids: ["plan_ids"],
|
|
6915
7267
|
plan_version_id: "plan_version_id",
|
|
7268
|
+
plan_version_ids: ["plan_version_ids"],
|
|
6916
7269
|
q: "q",
|
|
6917
7270
|
sort_order_column: "sort_order_column",
|
|
6918
7271
|
sort_order_direction: "asc",
|
|
@@ -6996,6 +7349,14 @@ client.companies.count_companies(
|
|
|
6996
7349
|
<dl>
|
|
6997
7350
|
<dd>
|
|
6998
7351
|
|
|
7352
|
+
**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.
|
|
7353
|
+
|
|
7354
|
+
</dd>
|
|
7355
|
+
</dl>
|
|
7356
|
+
|
|
7357
|
+
<dl>
|
|
7358
|
+
<dd>
|
|
7359
|
+
|
|
6999
7360
|
**q:** `String` — Search for companies by name, keys or string traits
|
|
7000
7361
|
|
|
7001
7362
|
</dd>
|
|
@@ -10017,7 +10378,7 @@ client.entitlements.list_feature_usage(
|
|
|
10017
10378
|
company_id: "company_id",
|
|
10018
10379
|
feature_ids: ["feature_ids"],
|
|
10019
10380
|
include_usage_aggregation: true,
|
|
10020
|
-
managed_by: "
|
|
10381
|
+
managed_by: "metronome",
|
|
10021
10382
|
q: "q",
|
|
10022
10383
|
without_negative_entitlements: true,
|
|
10023
10384
|
limit: 1000000,
|
|
@@ -10224,7 +10585,7 @@ client.entitlements.count_feature_usage(
|
|
|
10224
10585
|
company_id: "company_id",
|
|
10225
10586
|
feature_ids: ["feature_ids"],
|
|
10226
10587
|
include_usage_aggregation: true,
|
|
10227
|
-
managed_by: "
|
|
10588
|
+
managed_by: "metronome",
|
|
10228
10589
|
q: "q",
|
|
10229
10590
|
without_negative_entitlements: true,
|
|
10230
10591
|
limit: 1000000,
|
|
@@ -10838,6 +11199,14 @@ client.entitlements.create_plan_entitlement(
|
|
|
10838
11199
|
<dl>
|
|
10839
11200
|
<dd>
|
|
10840
11201
|
|
|
11202
|
+
**usage_quantity:** `Integer` — The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use.
|
|
11203
|
+
|
|
11204
|
+
</dd>
|
|
11205
|
+
</dl>
|
|
11206
|
+
|
|
11207
|
+
<dl>
|
|
11208
|
+
<dd>
|
|
11209
|
+
|
|
10841
11210
|
**value_bool:** `Internal::Types::Boolean`
|
|
10842
11211
|
|
|
10843
11212
|
</dd>
|
|
@@ -11169,6 +11538,14 @@ client.entitlements.update_plan_entitlement(
|
|
|
11169
11538
|
<dl>
|
|
11170
11539
|
<dd>
|
|
11171
11540
|
|
|
11541
|
+
**usage_quantity:** `Integer` — The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use.
|
|
11542
|
+
|
|
11543
|
+
</dd>
|
|
11544
|
+
</dl>
|
|
11545
|
+
|
|
11546
|
+
<dl>
|
|
11547
|
+
<dd>
|
|
11548
|
+
|
|
11172
11549
|
**value_bool:** `Internal::Types::Boolean`
|
|
11173
11550
|
|
|
11174
11551
|
</dd>
|
|
@@ -11315,7 +11692,7 @@ client.entitlements.delete_plan_entitlement(plan_entitlement_id: "plan_entitleme
|
|
|
11315
11692
|
|
|
11316
11693
|
```ruby
|
|
11317
11694
|
client.entitlements.upsert_plan_entitlement_for_billing_product(
|
|
11318
|
-
billing_provider: "
|
|
11695
|
+
billing_provider: "metronome",
|
|
11319
11696
|
external_resource_id: "external_resource_id",
|
|
11320
11697
|
feature_id: "feature_id",
|
|
11321
11698
|
plan_id: "plan_id",
|
|
@@ -11535,6 +11912,14 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
|
|
|
11535
11912
|
<dl>
|
|
11536
11913
|
<dd>
|
|
11537
11914
|
|
|
11915
|
+
**usage_quantity:** `Integer` — The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use.
|
|
11916
|
+
|
|
11917
|
+
</dd>
|
|
11918
|
+
</dl>
|
|
11919
|
+
|
|
11920
|
+
<dl>
|
|
11921
|
+
<dd>
|
|
11922
|
+
|
|
11538
11923
|
**value_bool:** `Internal::Types::Boolean`
|
|
11539
11924
|
|
|
11540
11925
|
</dd>
|
|
@@ -12027,6 +12412,65 @@ client.plans.list_custom_plan_billings(
|
|
|
12027
12412
|
</dl>
|
|
12028
12413
|
|
|
12029
12414
|
|
|
12415
|
+
</dd>
|
|
12416
|
+
</dl>
|
|
12417
|
+
</details>
|
|
12418
|
+
|
|
12419
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">mark_custom_plan_billing_paid</a>(custom_plan_billing_id, request) -> Schematic::Plans::Types::MarkCustomPlanBillingPaidResponse</code></summary>
|
|
12420
|
+
<dl>
|
|
12421
|
+
<dd>
|
|
12422
|
+
|
|
12423
|
+
#### 🔌 Usage
|
|
12424
|
+
|
|
12425
|
+
<dl>
|
|
12426
|
+
<dd>
|
|
12427
|
+
|
|
12428
|
+
<dl>
|
|
12429
|
+
<dd>
|
|
12430
|
+
|
|
12431
|
+
```ruby
|
|
12432
|
+
client.plans.mark_custom_plan_billing_paid(
|
|
12433
|
+
custom_plan_billing_id: "custom_plan_billing_id",
|
|
12434
|
+
request: {}
|
|
12435
|
+
)
|
|
12436
|
+
```
|
|
12437
|
+
</dd>
|
|
12438
|
+
</dl>
|
|
12439
|
+
</dd>
|
|
12440
|
+
</dl>
|
|
12441
|
+
|
|
12442
|
+
#### ⚙️ Parameters
|
|
12443
|
+
|
|
12444
|
+
<dl>
|
|
12445
|
+
<dd>
|
|
12446
|
+
|
|
12447
|
+
<dl>
|
|
12448
|
+
<dd>
|
|
12449
|
+
|
|
12450
|
+
**custom_plan_billing_id:** `String` — custom_plan_billing_id
|
|
12451
|
+
|
|
12452
|
+
</dd>
|
|
12453
|
+
</dl>
|
|
12454
|
+
|
|
12455
|
+
<dl>
|
|
12456
|
+
<dd>
|
|
12457
|
+
|
|
12458
|
+
**request:** `Internal::Types::Hash[String, Object]`
|
|
12459
|
+
|
|
12460
|
+
</dd>
|
|
12461
|
+
</dl>
|
|
12462
|
+
|
|
12463
|
+
<dl>
|
|
12464
|
+
<dd>
|
|
12465
|
+
|
|
12466
|
+
**request_options:** `Schematic::Plans::RequestOptions`
|
|
12467
|
+
|
|
12468
|
+
</dd>
|
|
12469
|
+
</dl>
|
|
12470
|
+
</dd>
|
|
12471
|
+
</dl>
|
|
12472
|
+
|
|
12473
|
+
|
|
12030
12474
|
</dd>
|
|
12031
12475
|
</dl>
|
|
12032
12476
|
</details>
|
|
@@ -12228,6 +12672,7 @@ client.plans.list_plans(
|
|
|
12228
12672
|
plan_type: "plan",
|
|
12229
12673
|
q: "q",
|
|
12230
12674
|
scoped_to_company_id: "scoped_to_company_id",
|
|
12675
|
+
with_entitlements: true,
|
|
12231
12676
|
without_entitlement_for: "without_entitlement_for",
|
|
12232
12677
|
without_paid_product_id: true,
|
|
12233
12678
|
limit: 1000000,
|
|
@@ -12343,6 +12788,14 @@ client.plans.list_plans(
|
|
|
12343
12788
|
<dl>
|
|
12344
12789
|
<dd>
|
|
12345
12790
|
|
|
12791
|
+
**with_entitlements:** `Internal::Types::Boolean` — Include each plan's entitlements in the response
|
|
12792
|
+
|
|
12793
|
+
</dd>
|
|
12794
|
+
</dl>
|
|
12795
|
+
|
|
12796
|
+
<dl>
|
|
12797
|
+
<dd>
|
|
12798
|
+
|
|
12346
12799
|
**without_entitlement_for:** `String` — Filter out plans that already have a plan entitlement for the specified feature ID
|
|
12347
12800
|
|
|
12348
12801
|
</dd>
|
|
@@ -12679,7 +13132,7 @@ client.plans.upsert_billing_product_plan(
|
|
|
12679
13132
|
|
|
12680
13133
|
```ruby
|
|
12681
13134
|
client.plans.upsert_plan_for_billing_product(
|
|
12682
|
-
billing_provider: "
|
|
13135
|
+
billing_provider: "metronome",
|
|
12683
13136
|
description: "description",
|
|
12684
13137
|
external_resource_id: "external_resource_id",
|
|
12685
13138
|
name: "name",
|
|
@@ -12947,6 +13400,7 @@ client.plans.count_plans(
|
|
|
12947
13400
|
plan_type: "plan",
|
|
12948
13401
|
q: "q",
|
|
12949
13402
|
scoped_to_company_id: "scoped_to_company_id",
|
|
13403
|
+
with_entitlements: true,
|
|
12950
13404
|
without_entitlement_for: "without_entitlement_for",
|
|
12951
13405
|
without_paid_product_id: true,
|
|
12952
13406
|
limit: 1000000,
|
|
@@ -13062,6 +13516,14 @@ client.plans.count_plans(
|
|
|
13062
13516
|
<dl>
|
|
13063
13517
|
<dd>
|
|
13064
13518
|
|
|
13519
|
+
**with_entitlements:** `Internal::Types::Boolean` — Include each plan's entitlements in the response
|
|
13520
|
+
|
|
13521
|
+
</dd>
|
|
13522
|
+
</dl>
|
|
13523
|
+
|
|
13524
|
+
<dl>
|
|
13525
|
+
<dd>
|
|
13526
|
+
|
|
13065
13527
|
**without_entitlement_for:** `String` — Filter out plans that already have a plan entitlement for the specified feature ID
|
|
13066
13528
|
|
|
13067
13529
|
</dd>
|
|
@@ -14529,7 +14991,7 @@ client.features.list_features(
|
|
|
14529
14991
|
boolean_require_event: true,
|
|
14530
14992
|
feature_type: ["boolean"],
|
|
14531
14993
|
ids: ["ids"],
|
|
14532
|
-
managed_by: "
|
|
14994
|
+
managed_by: "metronome",
|
|
14533
14995
|
plan_version_id: "plan_version_id",
|
|
14534
14996
|
q: "q",
|
|
14535
14997
|
without_company_override_for: "without_company_override_for",
|
|
@@ -15021,7 +15483,7 @@ client.features.delete_feature(feature_id: "feature_id")
|
|
|
15021
15483
|
|
|
15022
15484
|
```ruby
|
|
15023
15485
|
client.features.upsert_feature_for_billing_product(
|
|
15024
|
-
billing_provider: "
|
|
15486
|
+
billing_provider: "metronome",
|
|
15025
15487
|
description: "description",
|
|
15026
15488
|
external_resource_id: "external_resource_id",
|
|
15027
15489
|
feature_type: "boolean",
|
|
@@ -15174,7 +15636,7 @@ client.features.count_features(
|
|
|
15174
15636
|
boolean_require_event: true,
|
|
15175
15637
|
feature_type: ["boolean"],
|
|
15176
15638
|
ids: ["ids"],
|
|
15177
|
-
managed_by: "
|
|
15639
|
+
managed_by: "metronome",
|
|
15178
15640
|
plan_version_id: "plan_version_id",
|
|
15179
15641
|
q: "q",
|
|
15180
15642
|
without_company_override_for: "without_company_override_for",
|
|
@@ -16460,7 +16922,7 @@ client.integrationsapi.get_integration_webhook_url(type: "type")
|
|
|
16460
16922
|
</dl>
|
|
16461
16923
|
</details>
|
|
16462
16924
|
|
|
16463
|
-
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">
|
|
16925
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">install_integration</a>(request) -> Schematic::Integrationsapi::Types::InstallIntegrationResponse</code></summary>
|
|
16464
16926
|
<dl>
|
|
16465
16927
|
<dd>
|
|
16466
16928
|
|
|
@@ -16473,7 +16935,7 @@ client.integrationsapi.get_integration_webhook_url(type: "type")
|
|
|
16473
16935
|
<dd>
|
|
16474
16936
|
|
|
16475
16937
|
```ruby
|
|
16476
|
-
client.integrationsapi.
|
|
16938
|
+
client.integrationsapi.install_integration(type: "clerk")
|
|
16477
16939
|
```
|
|
16478
16940
|
</dd>
|
|
16479
16941
|
</dl>
|
|
@@ -16488,23 +16950,7 @@ client.integrationsapi.start_data_import(integration_id: "integration_id")
|
|
|
16488
16950
|
<dl>
|
|
16489
16951
|
<dd>
|
|
16490
16952
|
|
|
16491
|
-
**
|
|
16492
|
-
|
|
16493
|
-
</dd>
|
|
16494
|
-
</dl>
|
|
16495
|
-
|
|
16496
|
-
<dl>
|
|
16497
|
-
<dd>
|
|
16498
|
-
|
|
16499
|
-
**company_matching_field:** `String`
|
|
16500
|
-
|
|
16501
|
-
</dd>
|
|
16502
|
-
</dl>
|
|
16503
|
-
|
|
16504
|
-
<dl>
|
|
16505
|
-
<dd>
|
|
16506
|
-
|
|
16507
|
-
**integration_id:** `String`
|
|
16953
|
+
**request:** `Schematic::Types::InstallIntegrationRequestBody`
|
|
16508
16954
|
|
|
16509
16955
|
</dd>
|
|
16510
16956
|
</dl>
|
|
@@ -16524,7 +16970,7 @@ client.integrationsapi.start_data_import(integration_id: "integration_id")
|
|
|
16524
16970
|
</dl>
|
|
16525
16971
|
</details>
|
|
16526
16972
|
|
|
16527
|
-
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">
|
|
16973
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">start_data_import</a>(request) -> Schematic::Integrationsapi::Types::StartDataImportResponse</code></summary>
|
|
16528
16974
|
<dl>
|
|
16529
16975
|
<dd>
|
|
16530
16976
|
|
|
@@ -16537,7 +16983,7 @@ client.integrationsapi.start_data_import(integration_id: "integration_id")
|
|
|
16537
16983
|
<dd>
|
|
16538
16984
|
|
|
16539
16985
|
```ruby
|
|
16540
|
-
client.integrationsapi.
|
|
16986
|
+
client.integrationsapi.start_data_import(integration_id: "integration_id")
|
|
16541
16987
|
```
|
|
16542
16988
|
</dd>
|
|
16543
16989
|
</dl>
|
|
@@ -16552,24 +16998,184 @@ client.integrationsapi.load_sample_data_set_v_2
|
|
|
16552
16998
|
<dl>
|
|
16553
16999
|
<dd>
|
|
16554
17000
|
|
|
16555
|
-
**
|
|
17001
|
+
**company_matching_criteria:** `Schematic::Types::CompanyMatchingCriteria`
|
|
16556
17002
|
|
|
16557
17003
|
</dd>
|
|
16558
17004
|
</dl>
|
|
16559
|
-
</dd>
|
|
16560
|
-
</dl>
|
|
16561
17005
|
|
|
17006
|
+
<dl>
|
|
17007
|
+
<dd>
|
|
16562
17008
|
|
|
17009
|
+
**company_matching_field:** `String`
|
|
17010
|
+
|
|
16563
17011
|
</dd>
|
|
16564
17012
|
</dl>
|
|
16565
|
-
</details>
|
|
16566
17013
|
|
|
16567
|
-
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">uninstall_integration</a>(integration_id) -> Schematic::Integrationsapi::Types::UninstallIntegrationResponse</code></summary>
|
|
16568
17014
|
<dl>
|
|
16569
17015
|
<dd>
|
|
16570
17016
|
|
|
16571
|
-
|
|
16572
|
-
|
|
17017
|
+
**integration_id:** `String`
|
|
17018
|
+
|
|
17019
|
+
</dd>
|
|
17020
|
+
</dl>
|
|
17021
|
+
|
|
17022
|
+
<dl>
|
|
17023
|
+
<dd>
|
|
17024
|
+
|
|
17025
|
+
**request_options:** `Schematic::Integrationsapi::RequestOptions`
|
|
17026
|
+
|
|
17027
|
+
</dd>
|
|
17028
|
+
</dl>
|
|
17029
|
+
</dd>
|
|
17030
|
+
</dl>
|
|
17031
|
+
|
|
17032
|
+
|
|
17033
|
+
</dd>
|
|
17034
|
+
</dl>
|
|
17035
|
+
</details>
|
|
17036
|
+
|
|
17037
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">load_sample_data_set</a>() -> Schematic::Integrationsapi::Types::LoadSampleDataSetResponse</code></summary>
|
|
17038
|
+
<dl>
|
|
17039
|
+
<dd>
|
|
17040
|
+
|
|
17041
|
+
#### 🔌 Usage
|
|
17042
|
+
|
|
17043
|
+
<dl>
|
|
17044
|
+
<dd>
|
|
17045
|
+
|
|
17046
|
+
<dl>
|
|
17047
|
+
<dd>
|
|
17048
|
+
|
|
17049
|
+
```ruby
|
|
17050
|
+
client.integrationsapi.load_sample_data_set
|
|
17051
|
+
```
|
|
17052
|
+
</dd>
|
|
17053
|
+
</dl>
|
|
17054
|
+
</dd>
|
|
17055
|
+
</dl>
|
|
17056
|
+
|
|
17057
|
+
#### ⚙️ Parameters
|
|
17058
|
+
|
|
17059
|
+
<dl>
|
|
17060
|
+
<dd>
|
|
17061
|
+
|
|
17062
|
+
<dl>
|
|
17063
|
+
<dd>
|
|
17064
|
+
|
|
17065
|
+
**request_options:** `Schematic::Integrationsapi::RequestOptions`
|
|
17066
|
+
|
|
17067
|
+
</dd>
|
|
17068
|
+
</dl>
|
|
17069
|
+
</dd>
|
|
17070
|
+
</dl>
|
|
17071
|
+
|
|
17072
|
+
|
|
17073
|
+
</dd>
|
|
17074
|
+
</dl>
|
|
17075
|
+
</details>
|
|
17076
|
+
|
|
17077
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">assume_stripe_installed</a>(request) -> Schematic::Integrationsapi::Types::AssumeStripeInstalledResponse</code></summary>
|
|
17078
|
+
<dl>
|
|
17079
|
+
<dd>
|
|
17080
|
+
|
|
17081
|
+
#### 🔌 Usage
|
|
17082
|
+
|
|
17083
|
+
<dl>
|
|
17084
|
+
<dd>
|
|
17085
|
+
|
|
17086
|
+
<dl>
|
|
17087
|
+
<dd>
|
|
17088
|
+
|
|
17089
|
+
```ruby
|
|
17090
|
+
client.integrationsapi.assume_stripe_installed(type: "clerk")
|
|
17091
|
+
```
|
|
17092
|
+
</dd>
|
|
17093
|
+
</dl>
|
|
17094
|
+
</dd>
|
|
17095
|
+
</dl>
|
|
17096
|
+
|
|
17097
|
+
#### ⚙️ Parameters
|
|
17098
|
+
|
|
17099
|
+
<dl>
|
|
17100
|
+
<dd>
|
|
17101
|
+
|
|
17102
|
+
<dl>
|
|
17103
|
+
<dd>
|
|
17104
|
+
|
|
17105
|
+
**request:** `Schematic::Types::InstallIntegrationRequestBody`
|
|
17106
|
+
|
|
17107
|
+
</dd>
|
|
17108
|
+
</dl>
|
|
17109
|
+
|
|
17110
|
+
<dl>
|
|
17111
|
+
<dd>
|
|
17112
|
+
|
|
17113
|
+
**request_options:** `Schematic::Integrationsapi::RequestOptions`
|
|
17114
|
+
|
|
17115
|
+
</dd>
|
|
17116
|
+
</dl>
|
|
17117
|
+
</dd>
|
|
17118
|
+
</dl>
|
|
17119
|
+
|
|
17120
|
+
|
|
17121
|
+
</dd>
|
|
17122
|
+
</dl>
|
|
17123
|
+
</details>
|
|
17124
|
+
|
|
17125
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">install_stripe</a>(request) -> Schematic::Integrationsapi::Types::InstallStripeResponse</code></summary>
|
|
17126
|
+
<dl>
|
|
17127
|
+
<dd>
|
|
17128
|
+
|
|
17129
|
+
#### 🔌 Usage
|
|
17130
|
+
|
|
17131
|
+
<dl>
|
|
17132
|
+
<dd>
|
|
17133
|
+
|
|
17134
|
+
<dl>
|
|
17135
|
+
<dd>
|
|
17136
|
+
|
|
17137
|
+
```ruby
|
|
17138
|
+
client.integrationsapi.install_stripe(type: "clerk")
|
|
17139
|
+
```
|
|
17140
|
+
</dd>
|
|
17141
|
+
</dl>
|
|
17142
|
+
</dd>
|
|
17143
|
+
</dl>
|
|
17144
|
+
|
|
17145
|
+
#### ⚙️ Parameters
|
|
17146
|
+
|
|
17147
|
+
<dl>
|
|
17148
|
+
<dd>
|
|
17149
|
+
|
|
17150
|
+
<dl>
|
|
17151
|
+
<dd>
|
|
17152
|
+
|
|
17153
|
+
**request:** `Schematic::Types::InstallIntegrationRequestBody`
|
|
17154
|
+
|
|
17155
|
+
</dd>
|
|
17156
|
+
</dl>
|
|
17157
|
+
|
|
17158
|
+
<dl>
|
|
17159
|
+
<dd>
|
|
17160
|
+
|
|
17161
|
+
**request_options:** `Schematic::Integrationsapi::RequestOptions`
|
|
17162
|
+
|
|
17163
|
+
</dd>
|
|
17164
|
+
</dl>
|
|
17165
|
+
</dd>
|
|
17166
|
+
</dl>
|
|
17167
|
+
|
|
17168
|
+
|
|
17169
|
+
</dd>
|
|
17170
|
+
</dl>
|
|
17171
|
+
</details>
|
|
17172
|
+
|
|
17173
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">uninstall_integration</a>(integration_id) -> Schematic::Integrationsapi::Types::UninstallIntegrationResponse</code></summary>
|
|
17174
|
+
<dl>
|
|
17175
|
+
<dd>
|
|
17176
|
+
|
|
17177
|
+
#### 🔌 Usage
|
|
17178
|
+
|
|
16573
17179
|
<dl>
|
|
16574
17180
|
<dd>
|
|
16575
17181
|
|
|
@@ -16754,6 +17360,14 @@ client.plangroups.create_plan_group(
|
|
|
16754
17360
|
<dl>
|
|
16755
17361
|
<dd>
|
|
16756
17362
|
|
|
17363
|
+
**custom_checkout_fields:** `Internal::Types::Array[Schematic::Types::CheckoutFieldInput]`
|
|
17364
|
+
|
|
17365
|
+
</dd>
|
|
17366
|
+
</dl>
|
|
17367
|
+
|
|
17368
|
+
<dl>
|
|
17369
|
+
<dd>
|
|
17370
|
+
|
|
16757
17371
|
**custom_plan_config:** `Schematic::Types::CustomPlanConfig`
|
|
16758
17372
|
|
|
16759
17373
|
</dd>
|
|
@@ -17084,6 +17698,14 @@ client.plangroups.update_plan_group(
|
|
|
17084
17698
|
<dl>
|
|
17085
17699
|
<dd>
|
|
17086
17700
|
|
|
17701
|
+
**custom_checkout_fields:** `Internal::Types::Array[Schematic::Types::CheckoutFieldInput]`
|
|
17702
|
+
|
|
17703
|
+
</dd>
|
|
17704
|
+
</dl>
|
|
17705
|
+
|
|
17706
|
+
<dl>
|
|
17707
|
+
<dd>
|
|
17708
|
+
|
|
17087
17709
|
**custom_plan_config:** `Schematic::Types::CustomPlanConfig`
|
|
17088
17710
|
|
|
17089
17711
|
</dd>
|
|
@@ -17395,6 +18017,54 @@ client.planmigrations.list_company_migrations(
|
|
|
17395
18017
|
</dl>
|
|
17396
18018
|
|
|
17397
18019
|
|
|
18020
|
+
</dd>
|
|
18021
|
+
</dl>
|
|
18022
|
+
</details>
|
|
18023
|
+
|
|
18024
|
+
<details><summary><code>client.planmigrations.<a href="/lib/schematic/planmigrations/client.rb">retry_company_migration</a>(plan_version_company_migration_id) -> Schematic::Planmigrations::Types::RetryCompanyMigrationResponse</code></summary>
|
|
18025
|
+
<dl>
|
|
18026
|
+
<dd>
|
|
18027
|
+
|
|
18028
|
+
#### 🔌 Usage
|
|
18029
|
+
|
|
18030
|
+
<dl>
|
|
18031
|
+
<dd>
|
|
18032
|
+
|
|
18033
|
+
<dl>
|
|
18034
|
+
<dd>
|
|
18035
|
+
|
|
18036
|
+
```ruby
|
|
18037
|
+
client.planmigrations.retry_company_migration(plan_version_company_migration_id: "plan_version_company_migration_id")
|
|
18038
|
+
```
|
|
18039
|
+
</dd>
|
|
18040
|
+
</dl>
|
|
18041
|
+
</dd>
|
|
18042
|
+
</dl>
|
|
18043
|
+
|
|
18044
|
+
#### ⚙️ Parameters
|
|
18045
|
+
|
|
18046
|
+
<dl>
|
|
18047
|
+
<dd>
|
|
18048
|
+
|
|
18049
|
+
<dl>
|
|
18050
|
+
<dd>
|
|
18051
|
+
|
|
18052
|
+
**plan_version_company_migration_id:** `String` — plan_version_company_migration_id
|
|
18053
|
+
|
|
18054
|
+
</dd>
|
|
18055
|
+
</dl>
|
|
18056
|
+
|
|
18057
|
+
<dl>
|
|
18058
|
+
<dd>
|
|
18059
|
+
|
|
18060
|
+
**request_options:** `Schematic::Planmigrations::RequestOptions`
|
|
18061
|
+
|
|
18062
|
+
</dd>
|
|
18063
|
+
</dl>
|
|
18064
|
+
</dd>
|
|
18065
|
+
</dl>
|
|
18066
|
+
|
|
18067
|
+
|
|
17398
18068
|
</dd>
|
|
17399
18069
|
</dl>
|
|
17400
18070
|
</details>
|
|
@@ -17558,6 +18228,110 @@ client.planmigrations.list_migrations(
|
|
|
17558
18228
|
</dl>
|
|
17559
18229
|
|
|
17560
18230
|
|
|
18231
|
+
</dd>
|
|
18232
|
+
</dl>
|
|
18233
|
+
</details>
|
|
18234
|
+
|
|
18235
|
+
<details><summary><code>client.planmigrations.<a href="/lib/schematic/planmigrations/client.rb">create_migration</a>(request) -> Schematic::Planmigrations::Types::CreateMigrationResponse</code></summary>
|
|
18236
|
+
<dl>
|
|
18237
|
+
<dd>
|
|
18238
|
+
|
|
18239
|
+
#### 🔌 Usage
|
|
18240
|
+
|
|
18241
|
+
<dl>
|
|
18242
|
+
<dd>
|
|
18243
|
+
|
|
18244
|
+
<dl>
|
|
18245
|
+
<dd>
|
|
18246
|
+
|
|
18247
|
+
```ruby
|
|
18248
|
+
client.planmigrations.create_migration(
|
|
18249
|
+
company_ids: ["company_ids"],
|
|
18250
|
+
excluded_company_ids: ["excluded_company_ids"],
|
|
18251
|
+
plan_id: "plan_id",
|
|
18252
|
+
plan_version_id_to: "plan_version_id_to",
|
|
18253
|
+
plan_version_ids_from: ["plan_version_ids_from"],
|
|
18254
|
+
strategy: "immediate",
|
|
18255
|
+
target_plan_type: "plan"
|
|
18256
|
+
)
|
|
18257
|
+
```
|
|
18258
|
+
</dd>
|
|
18259
|
+
</dl>
|
|
18260
|
+
</dd>
|
|
18261
|
+
</dl>
|
|
18262
|
+
|
|
18263
|
+
#### ⚙️ Parameters
|
|
18264
|
+
|
|
18265
|
+
<dl>
|
|
18266
|
+
<dd>
|
|
18267
|
+
|
|
18268
|
+
<dl>
|
|
18269
|
+
<dd>
|
|
18270
|
+
|
|
18271
|
+
**company_ids:** `Internal::Types::Array[String]`
|
|
18272
|
+
|
|
18273
|
+
</dd>
|
|
18274
|
+
</dl>
|
|
18275
|
+
|
|
18276
|
+
<dl>
|
|
18277
|
+
<dd>
|
|
18278
|
+
|
|
18279
|
+
**excluded_company_ids:** `Internal::Types::Array[String]`
|
|
18280
|
+
|
|
18281
|
+
</dd>
|
|
18282
|
+
</dl>
|
|
18283
|
+
|
|
18284
|
+
<dl>
|
|
18285
|
+
<dd>
|
|
18286
|
+
|
|
18287
|
+
**plan_id:** `String`
|
|
18288
|
+
|
|
18289
|
+
</dd>
|
|
18290
|
+
</dl>
|
|
18291
|
+
|
|
18292
|
+
<dl>
|
|
18293
|
+
<dd>
|
|
18294
|
+
|
|
18295
|
+
**plan_version_id_to:** `String`
|
|
18296
|
+
|
|
18297
|
+
</dd>
|
|
18298
|
+
</dl>
|
|
18299
|
+
|
|
18300
|
+
<dl>
|
|
18301
|
+
<dd>
|
|
18302
|
+
|
|
18303
|
+
**plan_version_ids_from:** `Internal::Types::Array[String]`
|
|
18304
|
+
|
|
18305
|
+
</dd>
|
|
18306
|
+
</dl>
|
|
18307
|
+
|
|
18308
|
+
<dl>
|
|
18309
|
+
<dd>
|
|
18310
|
+
|
|
18311
|
+
**strategy:** `Schematic::Types::PlanVersionMigrationStrategy`
|
|
18312
|
+
|
|
18313
|
+
</dd>
|
|
18314
|
+
</dl>
|
|
18315
|
+
|
|
18316
|
+
<dl>
|
|
18317
|
+
<dd>
|
|
18318
|
+
|
|
18319
|
+
**target_plan_type:** `Schematic::Types::PlanType`
|
|
18320
|
+
|
|
18321
|
+
</dd>
|
|
18322
|
+
</dl>
|
|
18323
|
+
|
|
18324
|
+
<dl>
|
|
18325
|
+
<dd>
|
|
18326
|
+
|
|
18327
|
+
**request_options:** `Schematic::Planmigrations::RequestOptions`
|
|
18328
|
+
|
|
18329
|
+
</dd>
|
|
18330
|
+
</dl>
|
|
18331
|
+
</dd>
|
|
18332
|
+
</dl>
|
|
18333
|
+
|
|
18334
|
+
|
|
17561
18335
|
</dd>
|
|
17562
18336
|
</dl>
|
|
17563
18337
|
</details>
|
|
@@ -17606,6 +18380,65 @@ client.planmigrations.get_migration(plan_version_migration_id: "plan_version_mig
|
|
|
17606
18380
|
</dl>
|
|
17607
18381
|
|
|
17608
18382
|
|
|
18383
|
+
</dd>
|
|
18384
|
+
</dl>
|
|
18385
|
+
</details>
|
|
18386
|
+
|
|
18387
|
+
<details><summary><code>client.planmigrations.<a href="/lib/schematic/planmigrations/client.rb">retry_migration</a>(plan_version_migration_id, request) -> Schematic::Planmigrations::Types::RetryMigrationResponse</code></summary>
|
|
18388
|
+
<dl>
|
|
18389
|
+
<dd>
|
|
18390
|
+
|
|
18391
|
+
#### 🔌 Usage
|
|
18392
|
+
|
|
18393
|
+
<dl>
|
|
18394
|
+
<dd>
|
|
18395
|
+
|
|
18396
|
+
<dl>
|
|
18397
|
+
<dd>
|
|
18398
|
+
|
|
18399
|
+
```ruby
|
|
18400
|
+
client.planmigrations.retry_migration(
|
|
18401
|
+
plan_version_migration_id: "plan_version_migration_id",
|
|
18402
|
+
error_codes: ["ambiguous_subscription_item"]
|
|
18403
|
+
)
|
|
18404
|
+
```
|
|
18405
|
+
</dd>
|
|
18406
|
+
</dl>
|
|
18407
|
+
</dd>
|
|
18408
|
+
</dl>
|
|
18409
|
+
|
|
18410
|
+
#### ⚙️ Parameters
|
|
18411
|
+
|
|
18412
|
+
<dl>
|
|
18413
|
+
<dd>
|
|
18414
|
+
|
|
18415
|
+
<dl>
|
|
18416
|
+
<dd>
|
|
18417
|
+
|
|
18418
|
+
**plan_version_migration_id:** `String` — plan_version_migration_id
|
|
18419
|
+
|
|
18420
|
+
</dd>
|
|
18421
|
+
</dl>
|
|
18422
|
+
|
|
18423
|
+
<dl>
|
|
18424
|
+
<dd>
|
|
18425
|
+
|
|
18426
|
+
**error_codes:** `Internal::Types::Array[Schematic::Types::MigrationErrorCode]`
|
|
18427
|
+
|
|
18428
|
+
</dd>
|
|
18429
|
+
</dl>
|
|
18430
|
+
|
|
18431
|
+
<dl>
|
|
18432
|
+
<dd>
|
|
18433
|
+
|
|
18434
|
+
**request_options:** `Schematic::Planmigrations::RequestOptions`
|
|
18435
|
+
|
|
18436
|
+
</dd>
|
|
18437
|
+
</dl>
|
|
18438
|
+
</dd>
|
|
18439
|
+
</dl>
|
|
18440
|
+
|
|
18441
|
+
|
|
17609
18442
|
</dd>
|
|
17610
18443
|
</dl>
|
|
17611
18444
|
</details>
|