schematichq 1.4.2 → 1.4.3

data/reference.md

@@ -2230,6 +2230,54 @@ client.billing.upsert_payment_method(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<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>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.billing.delete_payment_method_by_external_id(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>
@@ -5175,6 +5223,208 @@ client.credits.list_grants_for_credit(
 </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>
+<dd>
+
+**lease_id:** `String` — lease_id
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**additional_amount:** `Integer` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**expires_at:** `String` 
+    
+</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">release_credit_lease</a>(lease_id, request) -> Schematic::Credits::Types::ReleaseCreditLeaseResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.credits.release_credit_lease(
+  lease_id: "lease_id",
+  request: {}
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**lease_id:** `String` — lease_id
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Internal::Types::Hash[String, Object]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Schematic::Credits::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -6535,6 +6785,7 @@ client.companies.list_companies(
   plan_id: "plan_id",
   plan_ids: ["plan_ids"],
   plan_version_id: "plan_version_id",
+  plan_version_ids: ["plan_version_ids"],
   q: "q",
   sort_order_column: "sort_order_column",
   sort_order_direction: "asc",
@@ -6618,6 +6869,14 @@ client.companies.list_companies(
 <dl>
 <dd>
 
+**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.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **q:** `String` — Search for companies by name, keys or string traits
     
 </dd>
@@ -6913,6 +7172,7 @@ client.companies.count_companies(
   plan_id: "plan_id",
   plan_ids: ["plan_ids"],
   plan_version_id: "plan_version_id",
+  plan_version_ids: ["plan_version_ids"],
   q: "q",
   sort_order_column: "sort_order_column",
   sort_order_direction: "asc",
@@ -6996,6 +7256,14 @@ client.companies.count_companies(
 <dl>
 <dd>
 
+**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.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **q:** `String` — Search for companies by name, keys or string traits
     
 </dd>
@@ -10838,6 +11106,14 @@ client.entitlements.create_plan_entitlement(
 <dl>
 <dd>
 
+**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.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **value_bool:** `Internal::Types::Boolean` 
     
 </dd>
@@ -11169,7 +11445,7 @@ client.entitlements.update_plan_entitlement(
 <dl>
 <dd>
 
-**value_bool:** `Internal::Types::Boolean` 
+**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.
     
 </dd>
 </dl>
@@ -11177,7 +11453,15 @@ client.entitlements.update_plan_entitlement(
 <dl>
 <dd>
 
-**value_credit_id:** `String` 
+**value_bool:** `Internal::Types::Boolean` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**value_credit_id:** `String` 
     
 </dd>
 </dl>
@@ -11535,6 +11819,14 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
 <dl>
 <dd>
 
+**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.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **value_bool:** `Internal::Types::Boolean` 
     
 </dd>
@@ -12027,6 +12319,65 @@ client.plans.list_custom_plan_billings(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<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>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.plans.mark_custom_plan_billing_paid(
+  custom_plan_billing_id: "custom_plan_billing_id",
+  request: {}
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**custom_plan_billing_id:** `String` — custom_plan_billing_id
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Internal::Types::Hash[String, Object]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Schematic::Plans::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -12228,6 +12579,7 @@ client.plans.list_plans(
   plan_type: "plan",
   q: "q",
   scoped_to_company_id: "scoped_to_company_id",
+  with_entitlements: true,
   without_entitlement_for: "without_entitlement_for",
   without_paid_product_id: true,
   limit: 1000000,
@@ -12343,6 +12695,14 @@ client.plans.list_plans(
 <dl>
 <dd>
 
+**with_entitlements:** `Internal::Types::Boolean` — Include each plan's entitlements in the response
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **without_entitlement_for:** `String` — Filter out plans that already have a plan entitlement for the specified feature ID
     
 </dd>
@@ -12947,6 +13307,7 @@ client.plans.count_plans(
   plan_type: "plan",
   q: "q",
   scoped_to_company_id: "scoped_to_company_id",
+  with_entitlements: true,
   without_entitlement_for: "without_entitlement_for",
   without_paid_product_id: true,
   limit: 1000000,
@@ -13062,6 +13423,14 @@ client.plans.count_plans(
 <dl>
 <dd>
 
+**with_entitlements:** `Internal::Types::Boolean` — Include each plan's entitlements in the response
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **without_entitlement_for:** `String` — Filter out plans that already have a plan entitlement for the specified feature ID
     
 </dd>
@@ -17395,6 +17764,54 @@ client.planmigrations.list_company_migrations(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<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>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.planmigrations.retry_company_migration(plan_version_company_migration_id: "plan_version_company_migration_id")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**plan_version_company_migration_id:** `String` — plan_version_company_migration_id
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Schematic::Planmigrations::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -17558,6 +17975,110 @@ client.planmigrations.list_migrations(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.planmigrations.<a href="/lib/schematic/planmigrations/client.rb">create_migration</a>(request) -> Schematic::Planmigrations::Types::CreateMigrationResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.planmigrations.create_migration(
+  company_ids: ["company_ids"],
+  excluded_company_ids: ["excluded_company_ids"],
+  plan_id: "plan_id",
+  plan_version_id_to: "plan_version_id_to",
+  plan_version_ids_from: ["plan_version_ids_from"],
+  strategy: "immediate",
+  target_plan_type: "plan"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**company_ids:** `Internal::Types::Array[String]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**excluded_company_ids:** `Internal::Types::Array[String]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**plan_id:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**plan_version_id_to:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**plan_version_ids_from:** `Internal::Types::Array[String]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**strategy:** `Schematic::Types::PlanVersionMigrationStrategy` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**target_plan_type:** `Schematic::Types::PlanType` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Schematic::Planmigrations::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -17606,6 +18127,65 @@ client.planmigrations.get_migration(plan_version_migration_id: "plan_version_mig
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<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>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.planmigrations.retry_migration(
+  plan_version_migration_id: "plan_version_migration_id",
+  error_codes: ["ambiguous_subscription_item"]
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**plan_version_migration_id:** `String` — plan_version_migration_id
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**error_codes:** `Internal::Types::Array[Schematic::Types::MigrationErrorCode]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Schematic::Planmigrations::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>