schematichq 1.4.4 → 1.4.6

data/reference.md

@@ -1,4 +1,44 @@
 # Reference
+<details><summary><code>client.<a href="/lib/schematic/client.rb">get_credit_ledger</a>() -> </code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.get_credit_ledger
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request_options:** `Schematic::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
 ## accounts
 <details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">list_account_members</a>() -> Schematic::Accounts::Types::ListAccountMembersResponse</code></summary>
 <dl>
@@ -1406,6 +1446,102 @@ client.billing.upsert_billing_coupon(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">delete_billing_coupon</a>(billing_id) -> Schematic::Billing::Types::DeleteBillingCouponResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.billing.delete_billing_coupon(billing_id: "billing_id")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**billing_id:** `String` — billing_id
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Schematic::Billing::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">delete_billing_customer</a>(billing_id) -> Schematic::Billing::Types::DeleteBillingCustomerResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.billing.delete_billing_customer(billing_id: "billing_id")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**billing_id:** `String` — billing_id
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Schematic::Billing::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -1937,6 +2073,54 @@ client.billing.upsert_invoice(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">delete_billing_invoice</a>(billing_id) -> Schematic::Billing::Types::DeleteBillingInvoiceResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.billing.delete_billing_invoice(billing_id: "billing_id")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**billing_id:** `String` — billing_id
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Schematic::Billing::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -2379,6 +2563,7 @@ client.billing.list_billing_prices(
   ids: ["ids"],
   interval: "interval",
   is_active: true,
+  plan_version_id: "plan_version_id",
   price: 1000000,
   product_id: "product_id",
   product_ids: ["product_ids"],
@@ -2452,6 +2637,14 @@ client.billing.list_billing_prices(
 <dl>
 <dd>
 
+**plan_version_id:** `String` — Filter for prices belonging to a specific plan version (e.g. the latest published version)
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **price:** `Integer` 
     
 </dd>
@@ -2801,6 +2994,7 @@ client.billing.list_billing_product_prices(
   ids: ["ids"],
   interval: "interval",
   is_active: true,
+  plan_version_id: "plan_version_id",
   price: 1000000,
   product_id: "product_id",
   product_ids: ["product_ids"],
@@ -2874,6 +3068,14 @@ client.billing.list_billing_product_prices(
 <dl>
 <dd>
 
+**plan_version_id:** `String` — Filter for prices belonging to a specific plan version (e.g. the latest published version)
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **price:** `Integer` 
     
 </dd>
@@ -5186,232 +5388,12 @@ client.credits.count_billing_credits_grants(
 **credit_id:** `String` 
     
 </dd>
-</dl>
-
-<dl>
-<dd>
-
-**ids:** `String` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**limit:** `Integer` — Page limit (default 100)
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**offset:** `Integer` — Page offset (default 0)
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request_options:** `Schematic::Credits::RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">list_grants_for_credit</a>() -> Schematic::Credits::Types::ListGrantsForCreditResponse</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```ruby
-client.credits.list_grants_for_credit(
-  credit_id: "credit_id",
-  ids: ["ids"],
-  limit: 1000000,
-  offset: 1000000
-)
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**credit_id:** `String` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**ids:** `String` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**limit:** `Integer` — Page limit (default 100)
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**offset:** `Integer` — Page offset (default 0)
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request_options:** `Schematic::Credits::RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">acquire_credit_lease</a>(request) -> Schematic::Credits::Types::AcquireCreditLeaseResponse</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```ruby
-client.credits.acquire_credit_lease(
-  company_id: "company_id",
-  credit_type_id: "credit_type_id",
-  requested_amount: 1.1
-)
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**company_id:** `String` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**credit_type_id:** `String` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**expires_at:** `String` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requested_amount:** `Integer` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request_options:** `Schematic::Credits::RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<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>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```ruby
-client.credits.extend_credit_lease(
-  lease_id: "lease_id",
-  additional_amount: 1.1
-)
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
+</dl>
 
 <dl>
 <dd>
 
-**lease_id:** `String` — lease_id
+**ids:** `String` 
     
 </dd>
 </dl>
@@ -5419,7 +5401,7 @@ client.credits.extend_credit_lease(
 <dl>
 <dd>
 
-**additional_amount:** `Integer` 
+**limit:** `Integer` — Page limit (default 100)
     
 </dd>
 </dl>
@@ -5427,7 +5409,7 @@ client.credits.extend_credit_lease(
 <dl>
 <dd>
 
-**expires_at:** `String` 
+**offset:** `Integer` — Page offset (default 0)
     
 </dd>
 </dl>
@@ -5447,7 +5429,7 @@ client.credits.extend_credit_lease(
 </dl>
 </details>
 
-<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>
+<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">list_grants_for_credit</a>() -> Schematic::Credits::Types::ListGrantsForCreditResponse</code></summary>
 <dl>
 <dd>
 
@@ -5460,9 +5442,11 @@ client.credits.extend_credit_lease(
 <dd>
 
 ```ruby
-client.credits.release_credit_lease(
-  lease_id: "lease_id",
-  request: {}
+client.credits.list_grants_for_credit(
+  credit_id: "credit_id",
+  ids: ["ids"],
+  limit: 1000000,
+  offset: 1000000
 )
 ```
 </dd>
@@ -5478,7 +5462,7 @@ client.credits.release_credit_lease(
 <dl>
 <dd>
 
-**lease_id:** `String` — lease_id
+**credit_id:** `String` 
     
 </dd>
 </dl>
@@ -5486,7 +5470,23 @@ client.credits.release_credit_lease(
 <dl>
 <dd>
 
-**request:** `Internal::Types::Hash[String, Object]` 
+**ids:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**limit:** `Integer` — Page limit (default 100)
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**offset:** `Integer` — Page offset (default 0)
     
 </dd>
 </dl>
@@ -5506,7 +5506,7 @@ client.credits.release_credit_lease(
 </dl>
 </details>
 
-<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">get_enriched_credit_ledger</a>() -> Schematic::Credits::Types::GetEnrichedCreditLedgerResponse</code></summary>
+<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">acquire_credit_lease</a>(request) -> Schematic::Credits::Types::AcquireCreditLeaseResponse</code></summary>
 <dl>
 <dd>
 
@@ -5519,15 +5519,10 @@ client.credits.release_credit_lease(
 <dd>
 
 ```ruby
-client.credits.get_enriched_credit_ledger(
+client.credits.acquire_credit_lease(
   company_id: "company_id",
-  billing_credit_id: "billing_credit_id",
-  feature_id: "feature_id",
-  period: "daily",
-  start_time: "start_time",
-  end_time: "end_time",
-  limit: 1000000,
-  offset: 1000000
+  credit_type_id: "credit_type_id",
+  requested_amount: 1.1
 )
 ```
 </dd>
@@ -5551,39 +5546,7 @@ client.credits.get_enriched_credit_ledger(
 <dl>
 <dd>
 
-**billing_credit_id:** `String` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**feature_id:** `String` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**period:** `Schematic::Types::CreditLedgerPeriod` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**start_time:** `String` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**end_time:** `String` 
+**credit_type_id:** `String` 
     
 </dd>
 </dl>
@@ -5591,7 +5554,7 @@ client.credits.get_enriched_credit_ledger(
 <dl>
 <dd>
 
-**limit:** `Integer` — Page limit (default 100)
+**expires_at:** `String` 
     
 </dd>
 </dl>
@@ -5599,7 +5562,7 @@ client.credits.get_enriched_credit_ledger(
 <dl>
 <dd>
 
-**offset:** `Integer` — Page offset (default 0)
+**requested_amount:** `Integer` 
     
 </dd>
 </dl>
@@ -5619,7 +5582,7 @@ client.credits.get_enriched_credit_ledger(
 </dl>
 </details>
 
-<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">count_credit_ledger</a>() -> Schematic::Credits::Types::CountCreditLedgerResponse</code></summary>
+<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>
 <dl>
 <dd>
 
@@ -5632,15 +5595,9 @@ client.credits.get_enriched_credit_ledger(
 <dd>
 
 ```ruby
-client.credits.count_credit_ledger(
-  company_id: "company_id",
-  billing_credit_id: "billing_credit_id",
-  feature_id: "feature_id",
-  period: "daily",
-  start_time: "start_time",
-  end_time: "end_time",
-  limit: 1000000,
-  offset: 1000000
+client.credits.extend_credit_lease(
+  lease_id: "lease_id",
+  additional_amount: 1.1
 )
 ```
 </dd>
@@ -5656,7 +5613,7 @@ client.credits.count_credit_ledger(
 <dl>
 <dd>
 
-**company_id:** `String` 
+**lease_id:** `String` — lease_id
     
 </dd>
 </dl>
@@ -5664,7 +5621,7 @@ client.credits.count_credit_ledger(
 <dl>
 <dd>
 
-**billing_credit_id:** `String` 
+**additional_amount:** `Integer` 
     
 </dd>
 </dl>
@@ -5672,7 +5629,7 @@ client.credits.count_credit_ledger(
 <dl>
 <dd>
 
-**feature_id:** `String` 
+**expires_at:** `String` 
     
 </dd>
 </dl>
@@ -5680,31 +5637,50 @@ client.credits.count_credit_ledger(
 <dl>
 <dd>
 
-**period:** `Schematic::Types::CreditLedgerPeriod` 
+**request_options:** `Schematic::Credits::RequestOptions` 
     
 </dd>
 </dl>
+</dd>
+</dl>
 
-<dl>
-<dd>
 
-**start_time:** `String` 
-    
 </dd>
 </dl>
+</details>
 
+<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>
 <dl>
 <dd>
 
-**end_time:** `String` 
-    
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.credits.release_credit_lease(
+  lease_id: "lease_id",
+  request: {}
+)
+```
+</dd>
+</dl>
 </dd>
 </dl>
 
+#### ⚙️ Parameters
+
 <dl>
 <dd>
 
-**limit:** `Integer` — Page limit (default 100)
+<dl>
+<dd>
+
+**lease_id:** `String` — lease_id
     
 </dd>
 </dl>
@@ -5712,7 +5688,7 @@ client.credits.count_credit_ledger(
 <dl>
 <dd>
 
-**offset:** `Integer` — Page offset (default 0)
+**request:** `Internal::Types::Hash[String, Object]` 
     
 </dd>
 </dl>
@@ -12490,11 +12466,7 @@ client.plans.mark_custom_plan_billing_paid(
 ```ruby
 client.plans.retry_custom_plan_billing(
   custom_plan_billing_id: "custom_plan_billing_id",
-  customer_email: "customer_email",
-  pay_in_advance: [{
-    price_id: "price_id",
-    quantity: 1000000
-  }]
+  customer_email: "customer_email"
 )
 ```
 </dd>
@@ -12542,14 +12514,6 @@ client.plans.retry_custom_plan_billing(
 <dl>
 <dd>
 
-**pay_in_advance:** `Internal::Types::Array[Schematic::Types::UpdatePayInAdvanceRequestBody]` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
 **request_options:** `Schematic::Plans::RequestOptions` 
     
 </dd>
@@ -13702,11 +13666,7 @@ client.plans.delete_plan_version(
 client.plans.publish_plan_version(
   plan_id: "plan_id",
   excluded_company_ids: ["excluded_company_ids"],
-  migration_strategy: "immediate",
-  pay_in_advance: [{
-    price_id: "price_id",
-    quantity: 1000000
-  }]
+  migration_strategy: "immediate"
 )
 ```
 </dd>
@@ -13770,14 +13730,6 @@ client.plans.publish_plan_version(
 <dl>
 <dd>
 
-**pay_in_advance:** `Internal::Types::Array[Schematic::Types::UpdatePayInAdvanceRequestBody]` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
 **request_options:** `Schematic::Plans::RequestOptions` 
     
 </dd>
@@ -17286,6 +17238,7 @@ client.plangroups.create_plan_group(
   checkout_collect_email: true,
   checkout_collect_phone: true,
   enable_tax_collection: true,
+  opt_in_enabled: true,
   ordered_add_ons: [{
     plan_id: "plan_id"
   }],
@@ -17416,6 +17369,30 @@ client.plangroups.create_plan_group(
 <dl>
 <dd>
 
+**opt_in_enabled:** `Internal::Types::Boolean` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**opt_in_text:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**opt_in_title:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **ordered_add_ons:** `Internal::Types::Array[Schematic::Types::OrderedPlansInGroup]` 
     
 </dd>
@@ -17616,6 +17593,7 @@ client.plangroups.update_plan_group(
   checkout_collect_email: true,
   checkout_collect_phone: true,
   enable_tax_collection: true,
+  opt_in_enabled: true,
   ordered_add_ons: [{
     plan_id: "plan_id"
   }],
@@ -17754,6 +17732,30 @@ client.plangroups.update_plan_group(
 <dl>
 <dd>
 
+**opt_in_enabled:** `Internal::Types::Boolean` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**opt_in_text:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**opt_in_title:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **ordered_add_ons:** `Internal::Types::Array[Schematic::Types::OrderedPlansInGroup]` 
     
 </dd>
@@ -19451,6 +19453,65 @@ client.webhooks.delete_webhook(webhook_id: "webhook_id")
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.webhooks.<a href="/lib/schematic/webhooks/client.rb">send_test_webhook_action</a>(webhook_id, request) -> Schematic::Webhooks::Types::SendTestWebhookActionResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.webhooks.send_test_webhook_action(
+  webhook_id: "webhook_id",
+  request_type: "subscription.trial.ended"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**webhook_id:** `String` — webhook_id
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_type:** `Schematic::Types::WebhookRequestType` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Schematic::Webhooks::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>