schematichq 1.5.8 → 1.5.9
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 +5 -5
- data/.fern/replay.lock +7 -1
- data/README.md +7 -1
- data/lib/schematic/billing/client.rb +228 -0
- data/lib/schematic/billing/types/convert_company_trial_response.rb +15 -0
- data/lib/schematic/billing/types/create_billing_subscription_request_body.rb +2 -0
- data/lib/schematic/billing/types/end_company_trial_response.rb +15 -0
- data/lib/schematic/billing/types/get_company_trial_response.rb +15 -0
- data/lib/schematic/billing/types/start_company_trial_request_body.rb +21 -0
- data/lib/schematic/billing/types/start_company_trial_response.rb +15 -0
- data/lib/schematic/billing/types/update_company_trial_request_body.rb +15 -0
- data/lib/schematic/billing/types/update_company_trial_response.rb +15 -0
- data/lib/schematic/cache.rb +19 -2
- data/lib/schematic/checkout/types/checkout_data_request_body.rb +2 -0
- data/lib/schematic/client.rb +1 -1
- data/lib/schematic/datastream/client.rb +52 -22
- data/lib/schematic/datastream/resource_cache.rb +13 -3
- data/lib/schematic/internal/http/raw_client.rb +1 -1
- data/lib/schematic/internal/iterators/offset_page_iterator.rb +2 -0
- data/lib/schematic/redis_cache.rb +10 -1
- data/lib/schematic/schematic_client.rb +21 -3
- data/lib/schematic/types/billing_customer_subscription.rb +2 -0
- data/lib/schematic/types/billing_native_subscription_response_data.rb +4 -0
- data/lib/schematic/types/billing_product_for_subscription_response_data.rb +2 -0
- data/lib/schematic/types/billing_product_plan_response_data.rb +2 -0
- data/lib/schematic/types/company_trial_response_data.rb +35 -0
- data/lib/schematic/types/company_trial_status.rb +16 -0
- data/lib/schematic/types/credit_ledger_export_metadata.rb +25 -0
- data/lib/schematic/types/credit_ledger_export_metadata_event_type.rb +19 -0
- data/lib/schematic/types/data_export_metadata.rb +2 -0
- data/lib/schematic/types/data_export_type.rb +1 -0
- data/lib/schematic/types/manage_plan_request.rb +2 -0
- data/lib/schematic/types/manage_plan_response_response_data.rb +2 -0
- data/lib/schematic/types/migration_error_code.rb +1 -0
- data/lib/schematic/types/plan_change_action.rb +1 -0
- data/lib/schematic/types/plan_change_response_data.rb +4 -0
- data/lib/schematic/types/publish_plan_version_request_body.rb +4 -0
- data/lib/schematic/types/publish_preview_interval_change_response_data.rb +13 -0
- data/lib/schematic/types/publish_preview_response_data.rb +2 -0
- data/lib/schematic/types/scheduled_downgrade_response_data.rb +4 -0
- data/lib/schematic/types/trial_source.rb +15 -0
- data/lib/schematic/types/web_scheduled_downgrade_webhook_output.rb +2 -0
- data/lib/schematic/version.rb +1 -1
- data/lib/schematic.rb +13 -0
- data/reference.md +316 -0
- metadata +15 -2
data/reference.md
CHANGED
|
@@ -4072,6 +4072,14 @@ client.billing.upsert_billing_subscription(
|
|
|
4072
4072
|
<dl>
|
|
4073
4073
|
<dd>
|
|
4074
4074
|
|
|
4075
|
+
**billing_cycle_anchor:** `String`
|
|
4076
|
+
|
|
4077
|
+
</dd>
|
|
4078
|
+
</dl>
|
|
4079
|
+
|
|
4080
|
+
<dl>
|
|
4081
|
+
<dd>
|
|
4082
|
+
|
|
4075
4083
|
**cancel_at:** `Integer`
|
|
4076
4084
|
|
|
4077
4085
|
</dd>
|
|
@@ -4360,6 +4368,306 @@ client.billing.move_to_default_plan(company_id: "company_id")
|
|
|
4360
4368
|
</dl>
|
|
4361
4369
|
|
|
4362
4370
|
|
|
4371
|
+
</dd>
|
|
4372
|
+
</dl>
|
|
4373
|
+
</details>
|
|
4374
|
+
|
|
4375
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">get_company_trial</a>(company_id:) -> Schematic::Billing::Types::GetCompanyTrialResponse</code></summary>
|
|
4376
|
+
<dl>
|
|
4377
|
+
<dd>
|
|
4378
|
+
|
|
4379
|
+
#### 🔌 Usage
|
|
4380
|
+
|
|
4381
|
+
<dl>
|
|
4382
|
+
<dd>
|
|
4383
|
+
|
|
4384
|
+
<dl>
|
|
4385
|
+
<dd>
|
|
4386
|
+
|
|
4387
|
+
```ruby
|
|
4388
|
+
client.billing.get_company_trial(company_id: "company_id")
|
|
4389
|
+
```
|
|
4390
|
+
</dd>
|
|
4391
|
+
</dl>
|
|
4392
|
+
</dd>
|
|
4393
|
+
</dl>
|
|
4394
|
+
|
|
4395
|
+
#### ⚙️ Parameters
|
|
4396
|
+
|
|
4397
|
+
<dl>
|
|
4398
|
+
<dd>
|
|
4399
|
+
|
|
4400
|
+
<dl>
|
|
4401
|
+
<dd>
|
|
4402
|
+
|
|
4403
|
+
**company_id:** `String` — company_id
|
|
4404
|
+
|
|
4405
|
+
</dd>
|
|
4406
|
+
</dl>
|
|
4407
|
+
|
|
4408
|
+
<dl>
|
|
4409
|
+
<dd>
|
|
4410
|
+
|
|
4411
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4412
|
+
|
|
4413
|
+
</dd>
|
|
4414
|
+
</dl>
|
|
4415
|
+
</dd>
|
|
4416
|
+
</dl>
|
|
4417
|
+
|
|
4418
|
+
|
|
4419
|
+
</dd>
|
|
4420
|
+
</dl>
|
|
4421
|
+
</details>
|
|
4422
|
+
|
|
4423
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">start_company_trial</a>(company_id:, request) -> Schematic::Billing::Types::StartCompanyTrialResponse</code></summary>
|
|
4424
|
+
<dl>
|
|
4425
|
+
<dd>
|
|
4426
|
+
|
|
4427
|
+
#### 🔌 Usage
|
|
4428
|
+
|
|
4429
|
+
<dl>
|
|
4430
|
+
<dd>
|
|
4431
|
+
|
|
4432
|
+
<dl>
|
|
4433
|
+
<dd>
|
|
4434
|
+
|
|
4435
|
+
```ruby
|
|
4436
|
+
client.billing.start_company_trial(
|
|
4437
|
+
company_id: "company_id",
|
|
4438
|
+
cadence: "day",
|
|
4439
|
+
plan_id: "plan_id"
|
|
4440
|
+
)
|
|
4441
|
+
```
|
|
4442
|
+
</dd>
|
|
4443
|
+
</dl>
|
|
4444
|
+
</dd>
|
|
4445
|
+
</dl>
|
|
4446
|
+
|
|
4447
|
+
#### ⚙️ Parameters
|
|
4448
|
+
|
|
4449
|
+
<dl>
|
|
4450
|
+
<dd>
|
|
4451
|
+
|
|
4452
|
+
<dl>
|
|
4453
|
+
<dd>
|
|
4454
|
+
|
|
4455
|
+
**company_id:** `String` — company_id
|
|
4456
|
+
|
|
4457
|
+
</dd>
|
|
4458
|
+
</dl>
|
|
4459
|
+
|
|
4460
|
+
<dl>
|
|
4461
|
+
<dd>
|
|
4462
|
+
|
|
4463
|
+
**cadence:** `Schematic::Types::BillingProductPriceInterval` — The unit of how often the plan bills once the trial converts: month or year.
|
|
4464
|
+
|
|
4465
|
+
</dd>
|
|
4466
|
+
</dl>
|
|
4467
|
+
|
|
4468
|
+
<dl>
|
|
4469
|
+
<dd>
|
|
4470
|
+
|
|
4471
|
+
**cadence_interval_count:** `Integer` — How many cadence units one billing period spans. Defaults to 1; use 3 with month for quarterly.
|
|
4472
|
+
|
|
4473
|
+
</dd>
|
|
4474
|
+
</dl>
|
|
4475
|
+
|
|
4476
|
+
<dl>
|
|
4477
|
+
<dd>
|
|
4478
|
+
|
|
4479
|
+
**end_behavior:** `Schematic::Types::BillingSubscriptionTrialEndSetting` — What happens when the trial reaches its end date: subscribe starts billing, cancel moves the company off the plan. Defaults to the plan group's trial setting.
|
|
4480
|
+
|
|
4481
|
+
</dd>
|
|
4482
|
+
</dl>
|
|
4483
|
+
|
|
4484
|
+
<dl>
|
|
4485
|
+
<dd>
|
|
4486
|
+
|
|
4487
|
+
**plan_id:** `String`
|
|
4488
|
+
|
|
4489
|
+
</dd>
|
|
4490
|
+
</dl>
|
|
4491
|
+
|
|
4492
|
+
<dl>
|
|
4493
|
+
<dd>
|
|
4494
|
+
|
|
4495
|
+
**trial_end:** `String` — When the trial ends. Defaults to the plan's trial length, then the plan group's, then 14 days. Setting it grants the trial even when the company has used its trial before.
|
|
4496
|
+
|
|
4497
|
+
</dd>
|
|
4498
|
+
</dl>
|
|
4499
|
+
|
|
4500
|
+
<dl>
|
|
4501
|
+
<dd>
|
|
4502
|
+
|
|
4503
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4504
|
+
|
|
4505
|
+
</dd>
|
|
4506
|
+
</dl>
|
|
4507
|
+
</dd>
|
|
4508
|
+
</dl>
|
|
4509
|
+
|
|
4510
|
+
|
|
4511
|
+
</dd>
|
|
4512
|
+
</dl>
|
|
4513
|
+
</details>
|
|
4514
|
+
|
|
4515
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">update_company_trial</a>(company_id:, request) -> Schematic::Billing::Types::UpdateCompanyTrialResponse</code></summary>
|
|
4516
|
+
<dl>
|
|
4517
|
+
<dd>
|
|
4518
|
+
|
|
4519
|
+
#### 🔌 Usage
|
|
4520
|
+
|
|
4521
|
+
<dl>
|
|
4522
|
+
<dd>
|
|
4523
|
+
|
|
4524
|
+
<dl>
|
|
4525
|
+
<dd>
|
|
4526
|
+
|
|
4527
|
+
```ruby
|
|
4528
|
+
client.billing.update_company_trial(company_id: "company_id")
|
|
4529
|
+
```
|
|
4530
|
+
</dd>
|
|
4531
|
+
</dl>
|
|
4532
|
+
</dd>
|
|
4533
|
+
</dl>
|
|
4534
|
+
|
|
4535
|
+
#### ⚙️ Parameters
|
|
4536
|
+
|
|
4537
|
+
<dl>
|
|
4538
|
+
<dd>
|
|
4539
|
+
|
|
4540
|
+
<dl>
|
|
4541
|
+
<dd>
|
|
4542
|
+
|
|
4543
|
+
**company_id:** `String` — company_id
|
|
4544
|
+
|
|
4545
|
+
</dd>
|
|
4546
|
+
</dl>
|
|
4547
|
+
|
|
4548
|
+
<dl>
|
|
4549
|
+
<dd>
|
|
4550
|
+
|
|
4551
|
+
**end_behavior:** `Schematic::Types::BillingSubscriptionTrialEndSetting`
|
|
4552
|
+
|
|
4553
|
+
</dd>
|
|
4554
|
+
</dl>
|
|
4555
|
+
|
|
4556
|
+
<dl>
|
|
4557
|
+
<dd>
|
|
4558
|
+
|
|
4559
|
+
**trial_end:** `String` — Moves the end of the trial, and the first billing date with it.
|
|
4560
|
+
|
|
4561
|
+
</dd>
|
|
4562
|
+
</dl>
|
|
4563
|
+
|
|
4564
|
+
<dl>
|
|
4565
|
+
<dd>
|
|
4566
|
+
|
|
4567
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4568
|
+
|
|
4569
|
+
</dd>
|
|
4570
|
+
</dl>
|
|
4571
|
+
</dd>
|
|
4572
|
+
</dl>
|
|
4573
|
+
|
|
4574
|
+
|
|
4575
|
+
</dd>
|
|
4576
|
+
</dl>
|
|
4577
|
+
</details>
|
|
4578
|
+
|
|
4579
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">convert_company_trial</a>(company_id:) -> Schematic::Billing::Types::ConvertCompanyTrialResponse</code></summary>
|
|
4580
|
+
<dl>
|
|
4581
|
+
<dd>
|
|
4582
|
+
|
|
4583
|
+
#### 🔌 Usage
|
|
4584
|
+
|
|
4585
|
+
<dl>
|
|
4586
|
+
<dd>
|
|
4587
|
+
|
|
4588
|
+
<dl>
|
|
4589
|
+
<dd>
|
|
4590
|
+
|
|
4591
|
+
```ruby
|
|
4592
|
+
client.billing.convert_company_trial(company_id: "company_id")
|
|
4593
|
+
```
|
|
4594
|
+
</dd>
|
|
4595
|
+
</dl>
|
|
4596
|
+
</dd>
|
|
4597
|
+
</dl>
|
|
4598
|
+
|
|
4599
|
+
#### ⚙️ Parameters
|
|
4600
|
+
|
|
4601
|
+
<dl>
|
|
4602
|
+
<dd>
|
|
4603
|
+
|
|
4604
|
+
<dl>
|
|
4605
|
+
<dd>
|
|
4606
|
+
|
|
4607
|
+
**company_id:** `String` — company_id
|
|
4608
|
+
|
|
4609
|
+
</dd>
|
|
4610
|
+
</dl>
|
|
4611
|
+
|
|
4612
|
+
<dl>
|
|
4613
|
+
<dd>
|
|
4614
|
+
|
|
4615
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4616
|
+
|
|
4617
|
+
</dd>
|
|
4618
|
+
</dl>
|
|
4619
|
+
</dd>
|
|
4620
|
+
</dl>
|
|
4621
|
+
|
|
4622
|
+
|
|
4623
|
+
</dd>
|
|
4624
|
+
</dl>
|
|
4625
|
+
</details>
|
|
4626
|
+
|
|
4627
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">end_company_trial</a>(company_id:) -> Schematic::Billing::Types::EndCompanyTrialResponse</code></summary>
|
|
4628
|
+
<dl>
|
|
4629
|
+
<dd>
|
|
4630
|
+
|
|
4631
|
+
#### 🔌 Usage
|
|
4632
|
+
|
|
4633
|
+
<dl>
|
|
4634
|
+
<dd>
|
|
4635
|
+
|
|
4636
|
+
<dl>
|
|
4637
|
+
<dd>
|
|
4638
|
+
|
|
4639
|
+
```ruby
|
|
4640
|
+
client.billing.end_company_trial(company_id: "company_id")
|
|
4641
|
+
```
|
|
4642
|
+
</dd>
|
|
4643
|
+
</dl>
|
|
4644
|
+
</dd>
|
|
4645
|
+
</dl>
|
|
4646
|
+
|
|
4647
|
+
#### ⚙️ Parameters
|
|
4648
|
+
|
|
4649
|
+
<dl>
|
|
4650
|
+
<dd>
|
|
4651
|
+
|
|
4652
|
+
<dl>
|
|
4653
|
+
<dd>
|
|
4654
|
+
|
|
4655
|
+
**company_id:** `String` — company_id
|
|
4656
|
+
|
|
4657
|
+
</dd>
|
|
4658
|
+
</dl>
|
|
4659
|
+
|
|
4660
|
+
<dl>
|
|
4661
|
+
<dd>
|
|
4662
|
+
|
|
4663
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4664
|
+
|
|
4665
|
+
</dd>
|
|
4666
|
+
</dl>
|
|
4667
|
+
</dd>
|
|
4668
|
+
</dl>
|
|
4669
|
+
|
|
4670
|
+
|
|
4363
4671
|
</dd>
|
|
4364
4672
|
</dl>
|
|
4365
4673
|
</details>
|
|
@@ -9598,6 +9906,14 @@ client.checkout.get_checkout_data(company_id: "company_id")
|
|
|
9598
9906
|
<dl>
|
|
9599
9907
|
<dd>
|
|
9600
9908
|
|
|
9909
|
+
**selected_plan_version_id:** `String`
|
|
9910
|
+
|
|
9911
|
+
</dd>
|
|
9912
|
+
</dl>
|
|
9913
|
+
|
|
9914
|
+
<dl>
|
|
9915
|
+
<dd>
|
|
9916
|
+
|
|
9601
9917
|
**request_options:** `Schematic::Checkout::RequestOptions`
|
|
9602
9918
|
|
|
9603
9919
|
</dd>
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: schematichq
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.5.
|
|
4
|
+
version: 1.5.9
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Schematic
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-11-
|
|
11
|
+
date: 2026-11-17 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: wasmtime
|
|
@@ -95,6 +95,7 @@ files:
|
|
|
95
95
|
- lib/schematic/accounts/types/update_onboarding_state_response.rb
|
|
96
96
|
- lib/schematic/billing/client.rb
|
|
97
97
|
- lib/schematic/billing/types/charge_native_invoice_response.rb
|
|
98
|
+
- lib/schematic/billing/types/convert_company_trial_response.rb
|
|
98
99
|
- lib/schematic/billing/types/count_billing_invoices_params.rb
|
|
99
100
|
- lib/schematic/billing/types/count_billing_invoices_request.rb
|
|
100
101
|
- lib/schematic/billing/types/count_billing_invoices_response.rb
|
|
@@ -119,11 +120,13 @@ files:
|
|
|
119
120
|
- lib/schematic/billing/types/delete_contract_document_response.rb
|
|
120
121
|
- lib/schematic/billing/types/delete_payment_method_by_external_id_response.rb
|
|
121
122
|
- lib/schematic/billing/types/delete_product_price_response.rb
|
|
123
|
+
- lib/schematic/billing/types/end_company_trial_response.rb
|
|
122
124
|
- lib/schematic/billing/types/finalize_native_invoice_response.rb
|
|
123
125
|
- lib/schematic/billing/types/get_billing_invoice_response.rb
|
|
124
126
|
- lib/schematic/billing/types/get_billing_settings_response.rb
|
|
125
127
|
- lib/schematic/billing/types/get_company_contract_response.rb
|
|
126
128
|
- lib/schematic/billing/types/get_company_native_subscription_response.rb
|
|
129
|
+
- lib/schematic/billing/types/get_company_trial_response.rb
|
|
127
130
|
- lib/schematic/billing/types/get_company_upcoming_invoices_response.rb
|
|
128
131
|
- lib/schematic/billing/types/list_billing_invoices_params.rb
|
|
129
132
|
- lib/schematic/billing/types/list_billing_invoices_request.rb
|
|
@@ -160,10 +163,14 @@ files:
|
|
|
160
163
|
- lib/schematic/billing/types/move_to_default_plan_response.rb
|
|
161
164
|
- lib/schematic/billing/types/reissue_native_invoice_link_response.rb
|
|
162
165
|
- lib/schematic/billing/types/revoke_native_invoice_link_response.rb
|
|
166
|
+
- lib/schematic/billing/types/start_company_trial_request_body.rb
|
|
167
|
+
- lib/schematic/billing/types/start_company_trial_response.rb
|
|
163
168
|
- lib/schematic/billing/types/update_billing_settings_request_body.rb
|
|
164
169
|
- lib/schematic/billing/types/update_billing_settings_response.rb
|
|
165
170
|
- lib/schematic/billing/types/update_company_billing_profile_request_body.rb
|
|
166
171
|
- lib/schematic/billing/types/update_company_billing_profile_response.rb
|
|
172
|
+
- lib/schematic/billing/types/update_company_trial_request_body.rb
|
|
173
|
+
- lib/schematic/billing/types/update_company_trial_response.rb
|
|
167
174
|
- lib/schematic/billing/types/upload_contract_document_request.rb
|
|
168
175
|
- lib/schematic/billing/types/upload_contract_document_response.rb
|
|
169
176
|
- lib/schematic/billing/types/upsert_billing_coupon_response.rb
|
|
@@ -927,6 +934,8 @@ files:
|
|
|
927
934
|
- lib/schematic/types/company_response_data.rb
|
|
928
935
|
- lib/schematic/types/company_subscription_response_data.rb
|
|
929
936
|
- lib/schematic/types/company_tax_id_view.rb
|
|
937
|
+
- lib/schematic/types/company_trial_response_data.rb
|
|
938
|
+
- lib/schematic/types/company_trial_status.rb
|
|
930
939
|
- lib/schematic/types/company_user_usage_metrics_response_data.rb
|
|
931
940
|
- lib/schematic/types/company_user_usage_response_data.rb
|
|
932
941
|
- lib/schematic/types/company_user_usage_row_response_data.rb
|
|
@@ -989,6 +998,8 @@ files:
|
|
|
989
998
|
- lib/schematic/types/credit_grant_sort_order.rb
|
|
990
999
|
- lib/schematic/types/credit_lease_response_data.rb
|
|
991
1000
|
- lib/schematic/types/credit_ledger_entry_kind.rb
|
|
1001
|
+
- lib/schematic/types/credit_ledger_export_metadata.rb
|
|
1002
|
+
- lib/schematic/types/credit_ledger_export_metadata_event_type.rb
|
|
992
1003
|
- lib/schematic/types/credit_ledger_source_type.rb
|
|
993
1004
|
- lib/schematic/types/credit_model_rate.rb
|
|
994
1005
|
- lib/schematic/types/credit_reservation_response_data.rb
|
|
@@ -1223,6 +1234,7 @@ files:
|
|
|
1223
1234
|
- lib/schematic/types/public_catalog_response_data.rb
|
|
1224
1235
|
- lib/schematic/types/public_plans_response_data.rb
|
|
1225
1236
|
- lib/schematic/types/publish_plan_version_request_body.rb
|
|
1237
|
+
- lib/schematic/types/publish_preview_interval_change_response_data.rb
|
|
1226
1238
|
- lib/schematic/types/publish_preview_pay_in_advance_response_data.rb
|
|
1227
1239
|
- lib/schematic/types/publish_preview_payment_method_response_data.rb
|
|
1228
1240
|
- lib/schematic/types/publish_preview_proration_line_response_data.rb
|
|
@@ -1300,6 +1312,7 @@ files:
|
|
|
1300
1312
|
- lib/schematic/types/trait_definition.rb
|
|
1301
1313
|
- lib/schematic/types/trait_definition_comparable_type.rb
|
|
1302
1314
|
- lib/schematic/types/trait_type.rb
|
|
1315
|
+
- lib/schematic/types/trial_source.rb
|
|
1303
1316
|
- lib/schematic/types/trial_status.rb
|
|
1304
1317
|
- lib/schematic/types/upcoming_invoice_response_data.rb
|
|
1305
1318
|
- lib/schematic/types/update_add_on_request_body.rb
|