schematichq 1.4.10 → 1.4.12

data/reference.md

@@ -56,6 +56,7 @@ client.get_credit_ledger
 client.accounts.list_account_members(
   ids: ["ids"],
   q: "q",
+  role: "admin",
   limit: 1000000,
   offset: 1000000
 )
@@ -89,6 +90,14 @@ client.accounts.list_account_members(
 <dl>
 <dd>
 
+**role:** `Schematic::Types::AccountMemberRole` — Filter by member role
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **limit:** `Integer` — Page limit (default 100)
     
 </dd>
@@ -181,6 +190,7 @@ client.accounts.get_account_member(account_member_id: "account_member_id")
 client.accounts.count_account_members(
   ids: ["ids"],
   q: "q",
+  role: "admin",
   limit: 1000000,
   offset: 1000000
 )
@@ -214,6 +224,14 @@ client.accounts.count_account_members(
 <dl>
 <dd>
 
+**role:** `Schematic::Types::AccountMemberRole` — Filter by member role
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **limit:** `Integer` — Page limit (default 100)
     
 </dd>
@@ -371,6 +389,14 @@ client.accounts.create_api_key(name: "name")
 <dl>
 <dd>
 
+**rate_limit_percent:** `Integer` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **readonly:** `Internal::Types::Boolean` 
     
 </dd>
@@ -491,6 +517,14 @@ client.accounts.update_api_key(api_key_id: "api_key_id")
 <dl>
 <dd>
 
+**rate_limit_percent:** `Integer` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `Schematic::Accounts::RequestOptions` 
     
 </dd>
@@ -2578,6 +2612,7 @@ client.billing.list_billing_prices(
   for_trial_expiry_plan: true,
   ids: ["ids"],
   interval: "interval",
+  interval_count: 1000000,
   is_active: true,
   plan_version_id: "plan_version_id",
   price: 1000000,
@@ -2645,6 +2680,14 @@ client.billing.list_billing_prices(
 <dl>
 <dd>
 
+**interval_count:** `Integer` — Filter for prices billed every N intervals; combine with interval (e.g. interval=month, interval_count=3 for quarterly)
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **is_active:** `Internal::Types::Boolean` — Filter for active prices on active products (defaults to true if not specified)
     
 </dd>
@@ -3009,6 +3052,7 @@ client.billing.list_billing_product_prices(
   for_trial_expiry_plan: true,
   ids: ["ids"],
   interval: "interval",
+  interval_count: 1000000,
   is_active: true,
   plan_version_id: "plan_version_id",
   price: 1000000,
@@ -3076,6 +3120,14 @@ client.billing.list_billing_product_prices(
 <dl>
 <dd>
 
+**interval_count:** `Integer` — Filter for prices billed every N intervals; combine with interval (e.g. interval=month, interval_count=3 for quarterly)
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **is_active:** `Internal::Types::Boolean` — Filter for active prices on active products (defaults to true if not specified)
     
 </dd>
@@ -6496,10 +6548,7 @@ client.catalogs.list_catalogs(
 <dd>
 
 ```ruby
-client.catalogs.create_catalog(
-  is_default: true,
-  name: "name"
-)
+client.catalogs.create_catalog(name: "name")
 ```
 </dd>
 </dl>
@@ -6522,14 +6571,6 @@ client.catalogs.create_catalog(
 <dl>
 <dd>
 
-**is_default:** `Internal::Types::Boolean` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
 **name:** `String` 
     
 </dd>
@@ -7589,6 +7630,14 @@ client.checkout.update_company_billing_details(
 <dl>
 <dd>
 
+**tax_id:** `Schematic::Types::TaxIdInput` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **values:** `Internal::Types::Array[Schematic::Types::CheckoutFieldValue]` 
     
 </dd>
@@ -13372,6 +13421,160 @@ client.entitlements.get_feature_usage_by_company(keys: {
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">get_user_usage_by_company</a>() -> Schematic::Entitlements::Types::GetUserUsageByCompanyResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.entitlements.get_user_usage_by_company(
+  company_id: "company_id",
+  end_time: "2024-01-15T09:30:00Z",
+  feature_id: "feature_id",
+  start_time: "2024-01-15T09:30:00Z"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**company_id:** `String` — Company to break usage down for
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**end_time:** `String` — End of the usage window (exclusive); defaults to now
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**feature_id:** `String` — Restrict to a single event-based feature
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**start_time:** `String` — Start of the usage window; defaults to 30 days before the end
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Schematic::Entitlements::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">get_user_usage_detail</a>() -> Schematic::Entitlements::Types::GetUserUsageDetailResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.entitlements.get_user_usage_detail(
+  company_id: "company_id",
+  end_time: "2024-01-15T09:30:00Z",
+  start_time: "2024-01-15T09:30:00Z",
+  user_id: "user_id"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**company_id:** `String` — Company the user belongs to
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**end_time:** `String` — End of the usage window (exclusive); defaults to now
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**start_time:** `String` — Start of the usage window; defaults to 30 days before the end
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**user_id:** `String` — User to break usage down for
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Schematic::Entitlements::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -13661,6 +13864,14 @@ client.plans.retry_custom_plan_billing(
 <dl>
 <dd>
 
+**send_invoice:** `Internal::Types::Boolean` — Whether Stripe emails the invoice when it is finalized. Defaults to true.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `Schematic::Plans::RequestOptions` 
     
 </dd>
@@ -14845,6 +15056,14 @@ client.plans.publish_plan_version(
 <dl>
 <dd>
 
+**address:** `Schematic::Types::CustomerBillingAddress` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **coupon_external_id:** `String` 
     
 </dd>
@@ -14853,6 +15072,14 @@ client.plans.publish_plan_version(
 <dl>
 <dd>
 
+**custom_field_values:** `Internal::Types::Array[Schematic::Types::CheckoutFieldValue]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **customer_email:** `String` 
     
 </dd>
@@ -14885,6 +15112,30 @@ client.plans.publish_plan_version(
 <dl>
 <dd>
 
+**phone:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**send_invoice:** `Internal::Types::Boolean` — Whether Stripe emails the invoice when it is finalized. Defaults to true.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**tax_id:** `Schematic::Types::TaxIdInput` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `Schematic::Plans::RequestOptions` 
     
 </dd>
@@ -18497,8 +18748,8 @@ client.integrationsapi.uninstall_integration(integration_id: "integration_id")
 </dl>
 </details>
 
-## plangroups
-<details><summary><code>client.plangroups.<a href="/lib/schematic/plangroups/client.rb">get_plan_group</a>() -> Schematic::Plangroups::Types::GetPlanGroupResponse</code></summary>
+## licenses
+<details><summary><code>client.licenses.<a href="/lib/schematic/licenses/client.rb">list_licenses</a>() -> Schematic::Licenses::Types::ListLicensesResponse</code></summary>
 <dl>
 <dd>
 
@@ -18511,7 +18762,13 @@ client.integrationsapi.uninstall_integration(integration_id: "integration_id")
 <dd>
 
 ```ruby
-client.plangroups.get_plan_group(include_company_counts: true)
+client.licenses.list_licenses(
+  feature_ids: ["feature_ids"],
+  ids: ["ids"],
+  name: "name",
+  limit: 1000000,
+  offset: 1000000
+)
 ```
 </dd>
 </dl>
@@ -18526,7 +18783,222 @@ client.plangroups.get_plan_group(include_company_counts: true)
 <dl>
 <dd>
 
-**include_company_counts:** `Internal::Types::Boolean` 
+**feature_ids:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**ids:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**name:** `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::Licenses::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.licenses.<a href="/lib/schematic/licenses/client.rb">get_single_license</a>(license_id) -> Schematic::Licenses::Types::GetSingleLicenseResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.licenses.get_single_license(license_id: "license_id")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**license_id:** `String` — license_id
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Schematic::Licenses::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.licenses.<a href="/lib/schematic/licenses/client.rb">count_licenses</a>() -> Schematic::Licenses::Types::CountLicensesResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.licenses.count_licenses(
+  feature_ids: ["feature_ids"],
+  ids: ["ids"],
+  name: "name",
+  limit: 1000000,
+  offset: 1000000
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**feature_ids:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**ids:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**name:** `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::Licenses::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+## plangroups
+<details><summary><code>client.plangroups.<a href="/lib/schematic/plangroups/client.rb">get_plan_group</a>() -> Schematic::Plangroups::Types::GetPlanGroupResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.plangroups.get_plan_group(include_company_counts: true)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**include_company_counts:** `Internal::Types::Boolean` 
     
 </dd>
 </dl>
@@ -19845,6 +20317,83 @@ client.planmigrations.count_migrations(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.planmigrations.<a href="/lib/schematic/planmigrations/client.rb">preview_migration</a>(request) -> Schematic::Planmigrations::Types::PreviewMigrationResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.planmigrations.preview_migration(
+  company_ids: ["company_ids"],
+  plan_id: "plan_id",
+  plan_version_id_to: "plan_version_id_to",
+  target_plan_type: "plan"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**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>
+
+**target_plan_type:** `Schematic::Types::PlanType` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Schematic::Planmigrations::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>