schematichq 1.4.3 → 1.4.4

data/lib/schematic/types/integration_install_config.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    class IntegrationInstallConfig < Internal::Types::Model
+      field :company_matching_criteria, -> { Schematic::Types::CompanyMatchingCriteria }, optional: true, nullable: false
+      field :company_matching_field, -> { String }, optional: true, nullable: false
+      field :config, -> { Schematic::Types::IntegrationConfig }, optional: true, nullable: false
+      field :created_at, -> { String }, optional: false, nullable: false
+      field :id, -> { String }, optional: false, nullable: false
+      field :integration_id, -> { String }, optional: false, nullable: false
+      field :is_app_install, -> { Internal::Types::Boolean }, optional: false, nullable: false
+      field :is_connect_install, -> { Internal::Types::Boolean }, optional: false, nullable: false
+      field :live_mode, -> { Internal::Types::Boolean }, optional: false, nullable: false
+      field :updated_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/schematic/types/integration_install_response_data.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    class IntegrationInstallResponseData < Internal::Types::Model
+      field :capabilities, -> { Schematic::Types::IntegrationCapabilities }, optional: false, nullable: false
+      field :config, -> { Schematic::Types::IntegrationInstallConfig }, optional: false, nullable: false
+      field :integration, -> { Schematic::Types::IntegrationResponseData }, optional: false, nullable: false
+    end
+  end
+end

data/lib/schematic/types/integration_type.rb

@@ -6,6 +6,7 @@ module Schematic
       extend Schematic::Internal::Types::Enum
 
       CLERK = "clerk"
+      METRONOME = "metronome"
       ORB = "orb"
       STRIPE = "stripe"
       UNKNOWN = "unknown"

data/lib/schematic/types/manage_plan_request.rb

@@ -11,6 +11,7 @@ module Schematic
       field :company_id, -> { String }, optional: false, nullable: false
       field :coupon_external_id, -> { String }, optional: true, nullable: false
       field :credit_bundles, -> { Internal::Types::Array[Schematic::Types::UpdateCreditBundleRequestBody] }, optional: false, nullable: false
+      field :custom_field_values, -> { Internal::Types::Array[Schematic::Types::CheckoutFieldValue] }, optional: false, nullable: false
       field :pay_in_advance_entitlements, -> { Internal::Types::Array[Schematic::Types::UpdatePayInAdvanceRequestBody] }, optional: false, nullable: false
       field :payment_method_external_id, -> { String }, optional: true, nullable: false
       field :promo_code, -> { String }, optional: true, nullable: false

data/lib/schematic/types/metronome_integration_config.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    class MetronomeIntegrationConfig < Internal::Types::Model; end
+  end
+end

data/lib/schematic/types/migration_error_code.rb

@@ -9,6 +9,7 @@ module Schematic
       MULTIPLE_SUBSCRIPTIONS = "multiple_subscriptions"
       NO_PRICE_FOR_INTERVAL = "no_price_for_interval"
       NOT_ON_ORIGIN_VERSION = "not_on_origin_version"
+      OPERATION_ITEM_NOT_FOUND = "operation_item_not_found"
       PERMANENT_CONFIG = "permanent_config"
       PERMANENT_DECLINE = "permanent_decline"
       TRANSIENT_DECLINE = "transient_decline"

data/lib/schematic/types/plan_credit_grant_view.rb

@@ -30,6 +30,7 @@ module Schematic
       field :reset_cadence, -> { Schematic::Types::BillingPlanCreditGrantResetCadence }, optional: true, nullable: false
       field :reset_start, -> { Schematic::Types::BillingPlanCreditGrantResetStart }, optional: true, nullable: false
       field :reset_type, -> { Schematic::Types::BillingPlanCreditGrantResetType }, optional: false, nullable: false
+      field :rollover_percentage, -> { Integer }, optional: false, nullable: false
       field :singular_name, -> { String }, optional: true, nullable: false
       field :updated_at, -> { String }, optional: false, nullable: false
     end

data/lib/schematic/types/plan_group_detail_response_data.rb

@@ -6,6 +6,7 @@ module Schematic
       field :add_ons, -> { Internal::Types::Array[Schematic::Types::PlanGroupPlanDetailResponseData] }, optional: false, nullable: false
       field :checkout_settings, -> { Schematic::Types::CheckoutSettingsResponseData }, optional: false, nullable: false
       field :component_settings, -> { Schematic::Types::ComponentSettingsResponseData }, optional: false, nullable: false
+      field :custom_checkout_fields, -> { Internal::Types::Array[Schematic::Types::CheckoutFieldResponseData] }, optional: false, nullable: false
       field :custom_plan_config, -> { Schematic::Types::CustomPlanViewConfigResponseData }, optional: true, nullable: false
       field :custom_plan_id, -> { String }, optional: true, nullable: false
       field :default_plan, -> { Schematic::Types::PlanGroupPlanDetailResponseData }, optional: true, nullable: false

data/lib/schematic/types/update_billing_plan_credit_grant_request_body.rb

@@ -20,6 +20,7 @@ module Schematic
       field :reset_cadence, -> { Schematic::Types::BillingPlanCreditGrantResetCadence }, optional: false, nullable: false
       field :reset_start, -> { Schematic::Types::BillingPlanCreditGrantResetStart }, optional: false, nullable: false
       field :reset_type, -> { Schematic::Types::BillingPlanCreditGrantResetType }, optional: true, nullable: false
+      field :rollover_percentage, -> { Integer }, optional: true, nullable: false
     end
   end
 end

data/lib/schematic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Schematic
-  VERSION = "1.4.3"
+  VERSION = "1.4.4"
 end

data/lib/schematic.rb

@@ -41,6 +41,9 @@ require_relative "schematic/types/account_member_role"
 require_relative "schematic/types/account_member_response_data"
 require_relative "schematic/accounts/types/list_account_members_response"
 require_relative "schematic/accounts/types/get_account_member_response"
+require_relative "schematic/accounts/types/count_account_members_params"
+require_relative "schematic/types/count_response"
+require_relative "schematic/accounts/types/count_account_members_response"
 require_relative "schematic/accounts/types/list_api_keys_params"
 require_relative "schematic/types/integration_state"
 require_relative "schematic/types/integration_type"
@@ -57,7 +60,6 @@ require_relative "schematic/accounts/types/update_api_key_response"
 require_relative "schematic/types/delete_response"
 require_relative "schematic/accounts/types/delete_api_key_response"
 require_relative "schematic/accounts/types/count_api_keys_params"
-require_relative "schematic/types/count_response"
 require_relative "schematic/accounts/types/count_api_keys_response"
 require_relative "schematic/types/actor_type"
 require_relative "schematic/accounts/types/list_audit_logs_params"
@@ -203,12 +205,14 @@ require_relative "schematic/credits/types/count_billing_plan_credit_grants_param
 require_relative "schematic/credits/types/count_billing_plan_credit_grants_response"
 require_relative "schematic/types/credit_event_type"
 require_relative "schematic/credits/types/list_credit_event_ledger_params"
+require_relative "schematic/types/credit_usage_reason"
 require_relative "schematic/types/credit_event_ledger_response_data"
 require_relative "schematic/credits/types/list_credit_event_ledger_response"
 require_relative "schematic/credits/types/count_credit_event_ledger_params"
 require_relative "schematic/credits/types/count_credit_event_ledger_response"
 require_relative "schematic/types/checkout_subscription"
 require_relative "schematic/checkout/types/checkout_internal_response"
+require_relative "schematic/types/billing_credit_ledger_authority"
 require_relative "schematic/types/credit_currency_price"
 require_relative "schematic/types/billing_credit_view"
 require_relative "schematic/types/billing_linked_resource_response_data"
@@ -217,6 +221,7 @@ require_relative "schematic/types/billing_strategy"
 require_relative "schematic/types/billing_subscription_discount_view"
 require_relative "schematic/types/billing_subscription_view"
 require_relative "schematic/types/charge_type"
+require_relative "schematic/types/checkout_field_with_value"
 require_relative "schematic/types/metric_period"
 require_relative "schematic/types/metric_period_month_reset"
 require_relative "schematic/types/company_event_period_metrics_response_data"
@@ -536,6 +541,7 @@ require_relative "schematic/integrationsapi/types/run_integration_response"
 require_relative "schematic/integrationsapi/types/list_integrations_params"
 require_relative "schematic/types/clerk_integration_config"
 require_relative "schematic/types/integration_capabilities"
+require_relative "schematic/types/metronome_integration_config"
 require_relative "schematic/types/orb_integration_config"
 require_relative "schematic/types/stripe_integration_config"
 require_relative "schematic/types/work_os_integration_config"
@@ -544,11 +550,19 @@ require_relative "schematic/types/integrations_list_response_data"
 require_relative "schematic/integrationsapi/types/list_integrations_response"
 require_relative "schematic/types/integration_webhook_url_response_data"
 require_relative "schematic/integrationsapi/types/get_integration_webhook_url_response"
+require_relative "schematic/types/company_matching_criteria"
+require_relative "schematic/types/integration_install_config"
+require_relative "schematic/types/integration_response_data"
+require_relative "schematic/types/integration_install_response_data"
+require_relative "schematic/integrationsapi/types/install_integration_response"
 require_relative "schematic/integrationsapi/types/start_data_import_response"
 require_relative "schematic/types/integrations_data_set_response_data"
-require_relative "schematic/integrationsapi/types/load_sample_data_set_v_2_response"
+require_relative "schematic/integrationsapi/types/load_sample_data_set_response"
+require_relative "schematic/integrationsapi/types/assume_stripe_installed_response"
+require_relative "schematic/integrationsapi/types/install_stripe_response"
 require_relative "schematic/integrationsapi/types/uninstall_integration_response"
 require_relative "schematic/plangroups/types/get_plan_group_params"
+require_relative "schematic/types/checkout_field_response_data"
 require_relative "schematic/types/checkout_settings_response_data"
 require_relative "schematic/types/component_settings_response_data"
 require_relative "schematic/types/custom_plan_view_config_response_data"
@@ -620,6 +634,7 @@ require_relative "schematic/types/billing_product_pricing"
 require_relative "schematic/types/billing_subscription_discount"
 require_relative "schematic/types/capture_raw_event"
 require_relative "schematic/types/capture_raw_event_batch"
+require_relative "schematic/types/checkout_field_value"
 require_relative "schematic/types/update_add_on_request_body"
 require_relative "schematic/types/update_auto_topup_override_request_body"
 require_relative "schematic/types/update_credit_bundle_request_body"
@@ -627,7 +642,7 @@ require_relative "schematic/types/update_pay_in_advance_request_body"
 require_relative "schematic/types/change_subscription_internal_request_body"
 require_relative "schematic/types/change_subscription_request_body"
 require_relative "schematic/types/check_flag_request_body"
-require_relative "schematic/types/company_matching_criteria"
+require_relative "schematic/types/checkout_field_input"
 require_relative "schematic/types/company_membership_response_data"
 require_relative "schematic/types/component_hydrate_response_data"
 require_relative "schematic/types/condition_group_response_data"
@@ -671,7 +686,7 @@ require_relative "schematic/types/rule_view"
 require_relative "schematic/types/flag_view"
 require_relative "schematic/types/feature_view"
 require_relative "schematic/types/feature_usage_legacy_response_data"
-require_relative "schematic/types/integration_response_data"
+require_relative "schematic/types/install_integration_request_body"
 require_relative "schematic/types/invoice_request_body"
 require_relative "schematic/types/keys_request_body"
 require_relative "schematic/types/plan_selection"
@@ -728,6 +743,7 @@ require_relative "schematic/types/webhook_url"
 require_relative "schematic/client"
 require_relative "schematic/accounts/client"
 require_relative "schematic/accounts/types/list_account_members_request"
+require_relative "schematic/accounts/types/count_account_members_request"
 require_relative "schematic/accounts/types/list_api_keys_request"
 require_relative "schematic/accounts/types/create_api_key_request_body"
 require_relative "schematic/accounts/types/update_api_key_request_body"

data/reference.md

@@ -121,6 +121,83 @@ client.accounts.get_account_member(account_member_id: "account_member_id")
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">count_account_members</a>() -> Schematic::Accounts::Types::CountAccountMembersResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.accounts.count_account_members(
+  ids: ["ids"],
+  q: "q",
+  limit: 1000000,
+  offset: 1000000
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**ids:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**q:** `String` — Search filter
+    
+</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::Accounts::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -1452,7 +1529,7 @@ client.billing.upsert_billing_customer(
 client.billing.list_customers_with_subscriptions(
   company_ids: ["company_ids"],
   name: "name",
-  provider_type: "orb",
+  provider_type: "metronome",
   q: "q",
   limit: 1000000,
   offset: 1000000
@@ -1547,7 +1624,7 @@ client.billing.list_customers_with_subscriptions(
 client.billing.count_customers(
   company_ids: ["company_ids"],
   name: "name",
-  provider_type: "orb",
+  provider_type: "metronome",
   q: "q",
   limit: 1000000,
   offset: 1000000
@@ -2305,7 +2382,7 @@ client.billing.list_billing_prices(
   price: 1000000,
   product_id: "product_id",
   product_ids: ["product_ids"],
-  provider_type: "orb",
+  provider_type: "metronome",
   q: "q",
   tiers_mode: "graduated",
   usage_type: "licensed",
@@ -2727,7 +2804,7 @@ client.billing.list_billing_product_prices(
   price: 1000000,
   product_id: "product_id",
   product_ids: ["product_ids"],
-  provider_type: "orb",
+  provider_type: "metronome",
   q: "q",
   tiers_mode: "graduated",
   usage_type: "licensed",
@@ -3038,7 +3115,7 @@ client.billing.list_billing_products(
   is_active: true,
   name: "name",
   price_usage_type: "licensed",
-  provider_type: "orb",
+  provider_type: "metronome",
   q: "q",
   recurring_charges_only: true,
   with_one_time_charges: true,
@@ -3196,7 +3273,7 @@ client.billing.count_billing_products(
   is_active: true,
   name: "name",
   price_usage_type: "licensed",
-  provider_type: "orb",
+  provider_type: "metronome",
   q: "q",
   recurring_charges_only: true,
   with_one_time_charges: true,
@@ -6355,6 +6432,10 @@ client.checkout.internal(
     bundle_id: "bundle_id",
     quantity: 1000000
   }],
+  custom_field_values: [{
+    id: "id",
+    value: "value"
+  }],
   new_plan_id: "new_plan_id",
   new_price_id: "new_price_id",
   pay_in_advance: [{
@@ -6479,6 +6560,10 @@ client.checkout.preview_checkout_internal(
     bundle_id: "bundle_id",
     quantity: 1000000
   }],
+  custom_field_values: [{
+    id: "id",
+    value: "value"
+  }],
   new_plan_id: "new_plan_id",
   new_price_id: "new_price_id",
   pay_in_advance: [{
@@ -6543,6 +6628,10 @@ client.checkout.manage_plan(
     bundle_id: "bundle_id",
     quantity: 1000000
   }],
+  custom_field_values: [{
+    id: "id",
+    value: "value"
+  }],
   pay_in_advance_entitlements: [{
     price_id: "price_id",
     quantity: 1000000
@@ -6604,6 +6693,10 @@ client.checkout.preview_manage_plan(
     bundle_id: "bundle_id",
     quantity: 1000000
   }],
+  custom_field_values: [{
+    id: "id",
+    value: "value"
+  }],
   pay_in_advance_entitlements: [{
     price_id: "price_id",
     quantity: 1000000
@@ -10285,7 +10378,7 @@ client.entitlements.list_feature_usage(
   company_id: "company_id",
   feature_ids: ["feature_ids"],
   include_usage_aggregation: true,
-  managed_by: "orb",
+  managed_by: "metronome",
   q: "q",
   without_negative_entitlements: true,
   limit: 1000000,
@@ -10492,7 +10585,7 @@ client.entitlements.count_feature_usage(
   company_id: "company_id",
   feature_ids: ["feature_ids"],
   include_usage_aggregation: true,
-  managed_by: "orb",
+  managed_by: "metronome",
   q: "q",
   without_negative_entitlements: true,
   limit: 1000000,
@@ -11599,7 +11692,7 @@ client.entitlements.delete_plan_entitlement(plan_entitlement_id: "plan_entitleme
 
 ```ruby
 client.entitlements.upsert_plan_entitlement_for_billing_product(
-  billing_provider: "orb",
+  billing_provider: "metronome",
   external_resource_id: "external_resource_id",
   feature_id: "feature_id",
   plan_id: "plan_id",
@@ -13039,7 +13132,7 @@ client.plans.upsert_billing_product_plan(
 
 ```ruby
 client.plans.upsert_plan_for_billing_product(
-  billing_provider: "orb",
+  billing_provider: "metronome",
   description: "description",
   external_resource_id: "external_resource_id",
   name: "name",
@@ -14898,7 +14991,7 @@ client.features.list_features(
   boolean_require_event: true,
   feature_type: ["boolean"],
   ids: ["ids"],
-  managed_by: "orb",
+  managed_by: "metronome",
   plan_version_id: "plan_version_id",
   q: "q",
   without_company_override_for: "without_company_override_for",
@@ -15390,7 +15483,7 @@ client.features.delete_feature(feature_id: "feature_id")
 
 ```ruby
 client.features.upsert_feature_for_billing_product(
-  billing_provider: "orb",
+  billing_provider: "metronome",
   description: "description",
   external_resource_id: "external_resource_id",
   feature_type: "boolean",
@@ -15543,7 +15636,7 @@ client.features.count_features(
   boolean_require_event: true,
   feature_type: ["boolean"],
   ids: ["ids"],
-  managed_by: "orb",
+  managed_by: "metronome",
   plan_version_id: "plan_version_id",
   q: "q",
   without_company_override_for: "without_company_override_for",
@@ -16825,6 +16918,54 @@ client.integrationsapi.get_integration_webhook_url(type: "type")
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">install_integration</a>(request) -> Schematic::Integrationsapi::Types::InstallIntegrationResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.integrationsapi.install_integration(type: "clerk")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Schematic::Types::InstallIntegrationRequestBody` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Schematic::Integrationsapi::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -16893,7 +17034,95 @@ client.integrationsapi.start_data_import(integration_id: "integration_id")
 </dl>
 </details>
 
-<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">load_sample_data_set_v_2</a>() -> Schematic::Integrationsapi::Types::LoadSampleDataSetV2Response</code></summary>
+<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">load_sample_data_set</a>() -> Schematic::Integrationsapi::Types::LoadSampleDataSetResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.integrationsapi.load_sample_data_set
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request_options:** `Schematic::Integrationsapi::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">assume_stripe_installed</a>(request) -> Schematic::Integrationsapi::Types::AssumeStripeInstalledResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.integrationsapi.assume_stripe_installed(type: "clerk")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Schematic::Types::InstallIntegrationRequestBody` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Schematic::Integrationsapi::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">install_stripe</a>(request) -> Schematic::Integrationsapi::Types::InstallStripeResponse</code></summary>
 <dl>
 <dd>
 
@@ -16906,7 +17135,7 @@ client.integrationsapi.start_data_import(integration_id: "integration_id")
 <dd>
 
 ```ruby
-client.integrationsapi.load_sample_data_set_v_2
+client.integrationsapi.install_stripe(type: "clerk")
 ```
 </dd>
 </dl>
@@ -16921,6 +17150,14 @@ client.integrationsapi.load_sample_data_set_v_2
 <dl>
 <dd>
 
+**request:** `Schematic::Types::InstallIntegrationRequestBody` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `Schematic::Integrationsapi::RequestOptions` 
     
 </dd>
@@ -17123,6 +17360,14 @@ client.plangroups.create_plan_group(
 <dl>
 <dd>
 
+**custom_checkout_fields:** `Internal::Types::Array[Schematic::Types::CheckoutFieldInput]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **custom_plan_config:** `Schematic::Types::CustomPlanConfig` 
     
 </dd>
@@ -17453,6 +17698,14 @@ client.plangroups.update_plan_group(
 <dl>
 <dd>
 
+**custom_checkout_fields:** `Internal::Types::Array[Schematic::Types::CheckoutFieldInput]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **custom_plan_config:** `Schematic::Types::CustomPlanConfig` 
     
 </dd>