schematichq 1.4.13 → 1.4.15
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 +7 -3
- data/.fern/replay.lock +15 -3
- data/.rubocop.yml +33 -0
- data/CONTRIBUTING.md +120 -0
- data/WASM_VERSION +1 -1
- data/lib/schematic/accesstokens/client.rb +8 -0
- data/lib/schematic/accesstokens/types/issue_temporary_access_token_request_body.rb +1 -0
- data/lib/schematic/accesstokens/types/issue_temporary_access_token_response.rb +1 -0
- data/lib/schematic/accounts/client.rb +176 -22
- data/lib/schematic/accounts/types/count_account_members_params.rb +4 -0
- data/lib/schematic/accounts/types/count_account_members_request.rb +4 -0
- data/lib/schematic/accounts/types/count_account_members_response.rb +1 -0
- data/lib/schematic/accounts/types/count_api_keys_params.rb +3 -0
- data/lib/schematic/accounts/types/count_api_keys_request.rb +3 -0
- data/lib/schematic/accounts/types/count_api_keys_response.rb +1 -0
- data/lib/schematic/accounts/types/count_audit_logs_params.rb +6 -0
- data/lib/schematic/accounts/types/count_audit_logs_request.rb +6 -0
- data/lib/schematic/accounts/types/count_audit_logs_response.rb +1 -0
- data/lib/schematic/accounts/types/create_api_key_request_body.rb +4 -0
- data/lib/schematic/accounts/types/create_api_key_response.rb +1 -0
- data/lib/schematic/accounts/types/create_environment_request_body.rb +1 -0
- data/lib/schematic/accounts/types/create_environment_response.rb +1 -0
- data/lib/schematic/accounts/types/delete_api_key_response.rb +1 -0
- data/lib/schematic/accounts/types/delete_environment_response.rb +1 -0
- data/lib/schematic/accounts/types/get_account_member_response.rb +1 -0
- data/lib/schematic/accounts/types/get_api_key_response.rb +1 -0
- data/lib/schematic/accounts/types/get_audit_log_response.rb +1 -0
- data/lib/schematic/accounts/types/get_environment_response.rb +1 -0
- data/lib/schematic/accounts/types/get_onboarding_state_response.rb +13 -0
- data/lib/schematic/accounts/types/get_who_am_i_response.rb +1 -0
- data/lib/schematic/accounts/types/list_account_members_params.rb +4 -0
- data/lib/schematic/accounts/types/list_account_members_request.rb +4 -0
- data/lib/schematic/accounts/types/list_account_members_response.rb +1 -0
- data/lib/schematic/accounts/types/list_api_keys_params.rb +3 -0
- data/lib/schematic/accounts/types/list_api_keys_request.rb +3 -0
- data/lib/schematic/accounts/types/list_api_keys_response.rb +1 -0
- data/lib/schematic/accounts/types/list_audit_logs_params.rb +6 -0
- data/lib/schematic/accounts/types/list_audit_logs_request.rb +6 -0
- data/lib/schematic/accounts/types/list_audit_logs_response.rb +1 -0
- data/lib/schematic/accounts/types/list_environments_params.rb +2 -0
- data/lib/schematic/accounts/types/list_environments_request.rb +2 -0
- data/lib/schematic/accounts/types/list_environments_response.rb +1 -0
- data/lib/schematic/accounts/types/quickstart_response.rb +1 -0
- data/lib/schematic/accounts/types/update_api_key_request_body.rb +3 -0
- data/lib/schematic/accounts/types/update_api_key_response.rb +1 -0
- data/lib/schematic/accounts/types/update_environment_request_body.rb +2 -0
- data/lib/schematic/accounts/types/update_environment_response.rb +1 -0
- data/lib/schematic/accounts/types/update_onboarding_state_request_body.rb +17 -0
- data/lib/schematic/accounts/types/update_onboarding_state_response.rb +13 -0
- data/lib/schematic/billing/client.rb +243 -20
- data/lib/schematic/billing/types/count_billing_products_params.rb +12 -0
- data/lib/schematic/billing/types/count_billing_products_request.rb +12 -0
- data/lib/schematic/billing/types/count_billing_products_response.rb +1 -0
- data/lib/schematic/billing/types/count_customers_params.rb +5 -0
- data/lib/schematic/billing/types/count_customers_request.rb +5 -0
- data/lib/schematic/billing/types/count_customers_response.rb +1 -0
- data/lib/schematic/billing/types/create_billing_customer_request_body.rb +6 -0
- data/lib/schematic/billing/types/create_billing_price_request_body.rb +16 -0
- data/lib/schematic/billing/types/create_billing_product_request_body.rb +4 -0
- data/lib/schematic/billing/types/create_billing_subscription_request_body.rb +20 -0
- data/lib/schematic/billing/types/create_coupon_request_body.rb +8 -0
- data/lib/schematic/billing/types/create_invoice_request_body.rb +14 -0
- data/lib/schematic/billing/types/create_meter_request_body.rb +4 -0
- data/lib/schematic/billing/types/create_payment_method_request_body.rb +11 -0
- data/lib/schematic/billing/types/delete_billing_coupon_response.rb +1 -0
- data/lib/schematic/billing/types/delete_billing_customer_response.rb +1 -0
- data/lib/schematic/billing/types/delete_billing_invoice_response.rb +1 -0
- data/lib/schematic/billing/types/delete_billing_product_response.rb +1 -0
- data/lib/schematic/billing/types/delete_payment_method_by_external_id_response.rb +1 -0
- data/lib/schematic/billing/types/delete_product_price_response.rb +1 -0
- data/lib/schematic/billing/types/list_billing_prices_params.rb +17 -0
- data/lib/schematic/billing/types/list_billing_prices_request.rb +17 -0
- data/lib/schematic/billing/types/list_billing_prices_response.rb +1 -0
- data/lib/schematic/billing/types/list_billing_product_prices_params.rb +17 -0
- data/lib/schematic/billing/types/list_billing_product_prices_request.rb +17 -0
- data/lib/schematic/billing/types/list_billing_product_prices_response.rb +1 -0
- data/lib/schematic/billing/types/list_billing_products_params.rb +12 -0
- data/lib/schematic/billing/types/list_billing_products_request.rb +12 -0
- data/lib/schematic/billing/types/list_billing_products_response.rb +1 -0
- data/lib/schematic/billing/types/list_coupons_params.rb +3 -0
- data/lib/schematic/billing/types/list_coupons_request.rb +3 -0
- data/lib/schematic/billing/types/list_coupons_response.rb +1 -0
- data/lib/schematic/billing/types/list_customers_with_subscriptions_params.rb +5 -0
- data/lib/schematic/billing/types/list_customers_with_subscriptions_request.rb +5 -0
- data/lib/schematic/billing/types/list_customers_with_subscriptions_response.rb +1 -0
- data/lib/schematic/billing/types/list_invoices_params.rb +4 -0
- data/lib/schematic/billing/types/list_invoices_request.rb +4 -0
- data/lib/schematic/billing/types/list_invoices_response.rb +1 -0
- data/lib/schematic/billing/types/list_meters_params.rb +2 -0
- data/lib/schematic/billing/types/list_meters_request.rb +2 -0
- data/lib/schematic/billing/types/list_meters_response.rb +1 -0
- data/lib/schematic/billing/types/list_payment_methods_params.rb +3 -0
- data/lib/schematic/billing/types/list_payment_methods_request.rb +3 -0
- data/lib/schematic/billing/types/list_payment_methods_response.rb +1 -0
- data/lib/schematic/billing/types/upsert_billing_coupon_response.rb +1 -0
- data/lib/schematic/billing/types/upsert_billing_customer_response.rb +1 -0
- data/lib/schematic/billing/types/upsert_billing_meter_response.rb +1 -0
- data/lib/schematic/billing/types/upsert_billing_price_response.rb +1 -0
- data/lib/schematic/billing/types/upsert_billing_product_response.rb +1 -0
- data/lib/schematic/billing/types/upsert_billing_subscription_response.rb +1 -0
- data/lib/schematic/billing/types/upsert_invoice_response.rb +1 -0
- data/lib/schematic/billing/types/upsert_payment_method_response.rb +1 -0
- data/lib/schematic/catalogs/client.rb +61 -4
- data/lib/schematic/catalogs/types/create_catalog_request_body.rb +1 -0
- data/lib/schematic/catalogs/types/create_catalog_response.rb +1 -0
- data/lib/schematic/catalogs/types/delete_catalog_response.rb +1 -0
- data/lib/schematic/catalogs/types/get_catalog_response.rb +1 -0
- data/lib/schematic/catalogs/types/get_configuration_response.rb +1 -0
- data/lib/schematic/catalogs/types/get_credit_bundles_in_catalog_response.rb +1 -0
- data/lib/schematic/catalogs/types/get_derived_features_response.rb +1 -0
- data/lib/schematic/catalogs/types/get_plans_in_catalog_response.rb +1 -0
- data/lib/schematic/catalogs/types/list_catalogs_params.rb +3 -0
- data/lib/schematic/catalogs/types/list_catalogs_request.rb +3 -0
- data/lib/schematic/catalogs/types/list_catalogs_response.rb +1 -0
- data/lib/schematic/catalogs/types/update_catalog_configuration_request_body.rb +9 -0
- data/lib/schematic/catalogs/types/update_catalog_request_body.rb +3 -0
- data/lib/schematic/catalogs/types/update_catalog_response.rb +1 -0
- data/lib/schematic/catalogs/types/update_configuration_response.rb +1 -0
- data/lib/schematic/checkout/client.rb +117 -2
- data/lib/schematic/checkout/types/cancel_subscription_request.rb +2 -0
- data/lib/schematic/checkout/types/cancel_subscription_response.rb +1 -0
- data/lib/schematic/checkout/types/checkout_data_request_body.rb +2 -0
- data/lib/schematic/checkout/types/checkout_internal_response.rb +1 -0
- data/lib/schematic/checkout/types/get_checkout_data_response.rb +1 -0
- data/lib/schematic/checkout/types/get_company_billing_details_response.rb +1 -0
- data/lib/schematic/checkout/types/manage_plan_response.rb +1 -0
- data/lib/schematic/checkout/types/preview_checkout_internal_response.rb +1 -0
- data/lib/schematic/checkout/types/preview_manage_plan_response.rb +1 -0
- data/lib/schematic/checkout/types/update_company_billing_details_request_body.rb +5 -0
- data/lib/schematic/checkout/types/update_company_billing_details_response.rb +1 -0
- data/lib/schematic/checkout/types/update_customer_subscription_trial_end_response.rb +1 -0
- data/lib/schematic/checkout/types/update_trial_end_request_body.rb +1 -0
- data/lib/schematic/client.rb +37 -4
- data/lib/schematic/companies/client.rb +421 -45
- data/lib/schematic/companies/types/count_companies_params.rb +21 -0
- data/lib/schematic/companies/types/count_companies_request.rb +21 -0
- data/lib/schematic/companies/types/count_companies_response.rb +1 -0
- data/lib/schematic/companies/types/count_entity_key_definitions_params.rb +4 -0
- data/lib/schematic/companies/types/count_entity_key_definitions_request.rb +4 -0
- data/lib/schematic/companies/types/count_entity_key_definitions_response.rb +1 -0
- data/lib/schematic/companies/types/count_entity_keys_params.rb +3 -0
- data/lib/schematic/companies/types/count_entity_keys_request.rb +3 -0
- data/lib/schematic/companies/types/count_entity_keys_response.rb +1 -0
- data/lib/schematic/companies/types/count_entity_trait_definitions_params.rb +6 -0
- data/lib/schematic/companies/types/count_entity_trait_definitions_request.rb +6 -0
- data/lib/schematic/companies/types/count_entity_trait_definitions_response.rb +1 -0
- data/lib/schematic/companies/types/count_entity_traits_params.rb +18 -0
- data/lib/schematic/companies/types/count_entity_traits_request.rb +17 -0
- data/lib/schematic/companies/types/count_entity_traits_response.rb +13 -0
- data/lib/schematic/companies/types/count_plan_traits_params.rb +5 -0
- data/lib/schematic/companies/types/count_plan_traits_request.rb +5 -0
- data/lib/schematic/companies/types/count_plan_traits_response.rb +1 -0
- data/lib/schematic/companies/types/count_users_params.rb +5 -0
- data/lib/schematic/companies/types/count_users_request.rb +5 -0
- data/lib/schematic/companies/types/count_users_response.rb +1 -0
- data/lib/schematic/companies/types/create_company_response.rb +1 -0
- data/lib/schematic/companies/types/create_entity_trait_definition_request_body.rb +3 -0
- data/lib/schematic/companies/types/create_user_response.rb +1 -0
- data/lib/schematic/companies/types/delete_company_by_keys_response.rb +1 -0
- data/lib/schematic/companies/types/delete_company_membership_response.rb +1 -0
- data/lib/schematic/companies/types/delete_company_params.rb +1 -0
- data/lib/schematic/companies/types/delete_company_request.rb +2 -0
- data/lib/schematic/companies/types/delete_company_response.rb +1 -0
- data/lib/schematic/companies/types/delete_entity_key_definition_response.rb +1 -0
- data/lib/schematic/companies/types/delete_entity_trait_definition_response.rb +13 -0
- data/lib/schematic/companies/types/delete_user_by_keys_response.rb +1 -0
- data/lib/schematic/companies/types/delete_user_response.rb +1 -0
- data/lib/schematic/companies/types/get_active_company_subscription_params.rb +3 -0
- data/lib/schematic/companies/types/get_active_company_subscription_request.rb +3 -0
- data/lib/schematic/companies/types/get_active_company_subscription_response.rb +1 -0
- data/lib/schematic/companies/types/get_billing_entity_child_subscriptions_request.rb +1 -1
- data/lib/schematic/companies/types/get_billing_entity_child_subscriptions_response.rb +1 -0
- data/lib/schematic/companies/types/get_company_billing_entity_request.rb +1 -1
- data/lib/schematic/companies/types/get_company_billing_entity_response.rb +1 -0
- data/lib/schematic/companies/types/get_company_response.rb +1 -0
- data/lib/schematic/companies/types/get_entity_trait_definition_response.rb +1 -0
- data/lib/schematic/companies/types/get_entity_trait_definition_usage_response.rb +13 -0
- data/lib/schematic/companies/types/get_entity_trait_values_params.rb +3 -0
- data/lib/schematic/companies/types/get_entity_trait_values_request.rb +3 -0
- data/lib/schematic/companies/types/get_entity_trait_values_response.rb +1 -0
- data/lib/schematic/companies/types/get_or_create_company_membership_request_body.rb +1 -0
- data/lib/schematic/companies/types/get_or_create_company_membership_response.rb +1 -0
- data/lib/schematic/companies/types/get_or_create_entity_trait_definition_response.rb +1 -0
- data/lib/schematic/companies/types/get_plan_change_response.rb +1 -0
- data/lib/schematic/companies/types/get_plan_trait_response.rb +1 -0
- data/lib/schematic/companies/types/get_user_response.rb +1 -0
- data/lib/schematic/companies/types/list_companies_params.rb +21 -0
- data/lib/schematic/companies/types/list_companies_request.rb +21 -0
- data/lib/schematic/companies/types/list_companies_response.rb +1 -0
- data/lib/schematic/companies/types/list_company_memberships_params.rb +3 -0
- data/lib/schematic/companies/types/list_company_memberships_request.rb +3 -0
- data/lib/schematic/companies/types/list_company_memberships_response.rb +1 -0
- data/lib/schematic/companies/types/list_entity_key_definitions_params.rb +4 -0
- data/lib/schematic/companies/types/list_entity_key_definitions_request.rb +4 -0
- data/lib/schematic/companies/types/list_entity_key_definitions_response.rb +1 -0
- data/lib/schematic/companies/types/list_entity_trait_definitions_params.rb +6 -0
- data/lib/schematic/companies/types/list_entity_trait_definitions_request.rb +6 -0
- data/lib/schematic/companies/types/list_entity_trait_definitions_response.rb +1 -0
- data/lib/schematic/companies/types/list_plan_changes_params.rb +5 -1
- data/lib/schematic/companies/types/list_plan_changes_request.rb +5 -1
- data/lib/schematic/companies/types/list_plan_changes_response.rb +1 -0
- data/lib/schematic/companies/types/list_plan_traits_params.rb +5 -0
- data/lib/schematic/companies/types/list_plan_traits_request.rb +5 -0
- data/lib/schematic/companies/types/list_plan_traits_response.rb +1 -0
- data/lib/schematic/companies/types/list_users_params.rb +5 -0
- data/lib/schematic/companies/types/list_users_request.rb +5 -0
- data/lib/schematic/companies/types/list_users_response.rb +1 -0
- data/lib/schematic/companies/types/lookup_company_response.rb +1 -0
- data/lib/schematic/companies/types/lookup_user_response.rb +1 -0
- data/lib/schematic/companies/types/update_entity_trait_definition_request_body.rb +2 -0
- data/lib/schematic/companies/types/update_entity_trait_definition_response.rb +1 -0
- data/lib/schematic/companies/types/update_plan_trait_bulk_request_body.rb +2 -0
- data/lib/schematic/companies/types/update_plan_traits_bulk_response.rb +1 -0
- data/lib/schematic/companies/types/upsert_company_response.rb +1 -0
- data/lib/schematic/companies/types/upsert_company_trait_response.rb +1 -0
- data/lib/schematic/companies/types/upsert_user_response.rb +1 -0
- data/lib/schematic/companies/types/upsert_user_trait_response.rb +1 -0
- data/lib/schematic/components/client.rb +40 -8
- data/lib/schematic/components/types/bind_catalog_request_body.rb +1 -0
- data/lib/schematic/components/types/bind_catalog_response.rb +1 -0
- data/lib/schematic/components/types/count_components_params.rb +2 -0
- data/lib/schematic/components/types/count_components_request.rb +2 -0
- data/lib/schematic/components/types/count_components_response.rb +1 -0
- data/lib/schematic/components/types/create_component_request_body.rb +2 -0
- data/lib/schematic/components/types/create_component_response.rb +1 -0
- data/lib/schematic/components/types/delete_component_response.rb +1 -0
- data/lib/schematic/components/types/get_component_response.rb +1 -0
- data/lib/schematic/components/types/list_components_params.rb +2 -0
- data/lib/schematic/components/types/list_components_request.rb +2 -0
- data/lib/schematic/components/types/list_components_response.rb +1 -0
- data/lib/schematic/components/types/preview_component_data_params.rb +1 -0
- data/lib/schematic/components/types/preview_component_data_request.rb +1 -0
- data/lib/schematic/components/types/preview_component_data_response.rb +1 -0
- data/lib/schematic/components/types/update_component_request_body.rb +4 -0
- data/lib/schematic/components/types/update_component_response.rb +1 -0
- data/lib/schematic/componentspublic/client.rb +5 -3
- data/lib/schematic/componentspublic/types/get_public_plans_response.rb +1 -0
- data/lib/schematic/credits/client.rb +233 -36
- data/lib/schematic/credits/types/acquire_credit_lease_request_body.rb +3 -0
- data/lib/schematic/credits/types/acquire_credit_lease_response.rb +1 -0
- data/lib/schematic/credits/types/count_billing_credits_grants_params.rb +3 -0
- data/lib/schematic/credits/types/count_billing_credits_grants_request.rb +3 -0
- data/lib/schematic/credits/types/count_billing_credits_grants_response.rb +1 -0
- data/lib/schematic/credits/types/count_billing_credits_params.rb +3 -0
- data/lib/schematic/credits/types/count_billing_credits_request.rb +3 -0
- data/lib/schematic/credits/types/count_billing_credits_response.rb +1 -0
- data/lib/schematic/credits/types/count_billing_plan_credit_grants_params.rb +7 -0
- data/lib/schematic/credits/types/count_billing_plan_credit_grants_request.rb +7 -0
- data/lib/schematic/credits/types/count_billing_plan_credit_grants_response.rb +1 -0
- data/lib/schematic/credits/types/count_company_grants_params.rb +4 -0
- data/lib/schematic/credits/types/count_company_grants_request.rb +5 -1
- data/lib/schematic/credits/types/count_company_grants_response.rb +1 -0
- data/lib/schematic/credits/types/count_credit_bundles_params.rb +5 -0
- data/lib/schematic/credits/types/count_credit_bundles_request.rb +5 -0
- data/lib/schematic/credits/types/count_credit_bundles_response.rb +1 -0
- data/lib/schematic/credits/types/count_credit_event_ledger_params.rb +7 -0
- data/lib/schematic/credits/types/count_credit_event_ledger_request.rb +7 -0
- data/lib/schematic/credits/types/count_credit_event_ledger_response.rb +1 -0
- data/lib/schematic/credits/types/create_billing_credit_request_body.rb +12 -0
- data/lib/schematic/credits/types/create_billing_credit_response.rb +1 -0
- data/lib/schematic/credits/types/create_billing_plan_credit_grant_response.rb +1 -0
- data/lib/schematic/credits/types/create_company_credit_grant.rb +11 -0
- data/lib/schematic/credits/types/create_credit_bundle_request_body.rb +13 -0
- data/lib/schematic/credits/types/create_credit_bundle_response.rb +1 -0
- data/lib/schematic/credits/types/delete_billing_plan_credit_grant_request.rb +1 -0
- data/lib/schematic/credits/types/delete_billing_plan_credit_grant_response.rb +1 -0
- data/lib/schematic/credits/types/delete_credit_bundle_response.rb +1 -0
- data/lib/schematic/credits/types/extend_credit_lease_request_body.rb +2 -0
- data/lib/schematic/credits/types/extend_credit_lease_response.rb +1 -0
- data/lib/schematic/credits/types/get_credit_bundle_response.rb +1 -0
- data/lib/schematic/credits/types/get_single_billing_credit_response.rb +1 -0
- data/lib/schematic/credits/types/get_single_billing_plan_credit_grant_response.rb +1 -0
- data/lib/schematic/credits/types/grant_billing_credits_to_company_response.rb +1 -0
- data/lib/schematic/credits/types/list_billing_credits_params.rb +3 -0
- data/lib/schematic/credits/types/list_billing_credits_request.rb +3 -0
- data/lib/schematic/credits/types/list_billing_credits_response.rb +1 -0
- data/lib/schematic/credits/types/list_billing_plan_credit_grants_params.rb +7 -0
- data/lib/schematic/credits/types/list_billing_plan_credit_grants_request.rb +7 -0
- data/lib/schematic/credits/types/list_billing_plan_credit_grants_response.rb +1 -0
- data/lib/schematic/credits/types/list_company_credit_balances_response.rb +1 -0
- data/lib/schematic/credits/types/list_company_grants_params.rb +4 -0
- data/lib/schematic/credits/types/list_company_grants_request.rb +5 -1
- data/lib/schematic/credits/types/list_company_grants_response.rb +1 -0
- data/lib/schematic/credits/types/list_credit_bundles_params.rb +5 -0
- data/lib/schematic/credits/types/list_credit_bundles_request.rb +5 -0
- data/lib/schematic/credits/types/list_credit_bundles_response.rb +1 -0
- data/lib/schematic/credits/types/list_credit_event_ledger_params.rb +7 -0
- data/lib/schematic/credits/types/list_credit_event_ledger_request.rb +7 -0
- data/lib/schematic/credits/types/list_credit_event_ledger_response.rb +1 -0
- data/lib/schematic/credits/types/list_grants_for_credit_params.rb +3 -0
- data/lib/schematic/credits/types/list_grants_for_credit_request.rb +3 -0
- data/lib/schematic/credits/types/list_grants_for_credit_response.rb +1 -0
- data/lib/schematic/credits/types/release_credit_lease_response.rb +1 -0
- data/lib/schematic/credits/types/soft_delete_billing_credit_response.rb +1 -0
- data/lib/schematic/credits/types/update_billing_credit_request_body.rb +12 -0
- data/lib/schematic/credits/types/update_billing_credit_response.rb +1 -0
- data/lib/schematic/credits/types/update_billing_plan_credit_grant_response.rb +1 -0
- data/lib/schematic/credits/types/update_credit_bundle_details_request_body.rb +11 -0
- data/lib/schematic/credits/types/update_credit_bundle_details_response.rb +1 -0
- data/lib/schematic/credits/types/zero_out_grant_request_body.rb +1 -0
- data/lib/schematic/credits/types/zero_out_grant_response.rb +1 -0
- data/lib/schematic/dataexports/client.rb +20 -2
- data/lib/schematic/dataexports/types/create_data_export_request_body.rb +2 -0
- data/lib/schematic/dataexports/types/create_data_export_response.rb +1 -0
- data/lib/schematic/dataexports/types/get_data_export_response.rb +1 -0
- data/lib/schematic/dataexports/types/list_data_exports_params.rb +3 -0
- data/lib/schematic/dataexports/types/list_data_exports_request.rb +3 -0
- data/lib/schematic/dataexports/types/list_data_exports_response.rb +1 -0
- data/lib/schematic/datastream/client.rb +4 -4
- data/lib/schematic/entitlements/client.rb +256 -30
- data/lib/schematic/entitlements/types/count_company_overrides_params.rb +8 -0
- data/lib/schematic/entitlements/types/count_company_overrides_request.rb +8 -0
- data/lib/schematic/entitlements/types/count_company_overrides_response.rb +1 -0
- data/lib/schematic/entitlements/types/count_feature_companies_params.rb +3 -0
- data/lib/schematic/entitlements/types/count_feature_companies_request.rb +3 -0
- data/lib/schematic/entitlements/types/count_feature_companies_response.rb +1 -0
- data/lib/schematic/entitlements/types/count_feature_usage_params.rb +8 -0
- data/lib/schematic/entitlements/types/count_feature_usage_request.rb +8 -0
- data/lib/schematic/entitlements/types/count_feature_usage_response.rb +1 -0
- data/lib/schematic/entitlements/types/count_feature_users_params.rb +3 -0
- data/lib/schematic/entitlements/types/count_feature_users_request.rb +3 -0
- data/lib/schematic/entitlements/types/count_feature_users_response.rb +1 -0
- data/lib/schematic/entitlements/types/count_plan_entitlements_params.rb +10 -0
- data/lib/schematic/entitlements/types/count_plan_entitlements_request.rb +10 -0
- data/lib/schematic/entitlements/types/count_plan_entitlements_response.rb +1 -0
- data/lib/schematic/entitlements/types/create_billing_linked_plan_entitlement_request_body.rb +35 -0
- data/lib/schematic/entitlements/types/create_company_override_request_body.rb +11 -0
- data/lib/schematic/entitlements/types/create_company_override_response.rb +1 -0
- data/lib/schematic/entitlements/types/create_plan_entitlement_request_body.rb +33 -0
- data/lib/schematic/entitlements/types/create_plan_entitlement_response.rb +1 -0
- data/lib/schematic/entitlements/types/delete_company_override_response.rb +1 -0
- data/lib/schematic/entitlements/types/delete_plan_entitlement_response.rb +1 -0
- data/lib/schematic/entitlements/types/duplicate_plan_entitlements_request_body.rb +1 -0
- data/lib/schematic/entitlements/types/duplicate_plan_entitlements_response.rb +1 -0
- data/lib/schematic/entitlements/types/get_company_override_response.rb +1 -0
- data/lib/schematic/entitlements/types/get_feature_usage_by_company_response.rb +1 -0
- data/lib/schematic/entitlements/types/get_feature_usage_time_series_params.rb +4 -0
- data/lib/schematic/entitlements/types/get_feature_usage_time_series_request.rb +4 -0
- data/lib/schematic/entitlements/types/get_feature_usage_time_series_response.rb +1 -0
- data/lib/schematic/entitlements/types/get_plan_entitlement_response.rb +1 -0
- data/lib/schematic/entitlements/types/get_user_usage_by_company_params.rb +3 -0
- data/lib/schematic/entitlements/types/get_user_usage_by_company_request.rb +3 -0
- data/lib/schematic/entitlements/types/get_user_usage_by_company_response.rb +1 -0
- data/lib/schematic/entitlements/types/get_user_usage_detail_params.rb +3 -0
- data/lib/schematic/entitlements/types/get_user_usage_detail_request.rb +3 -0
- data/lib/schematic/entitlements/types/get_user_usage_detail_response.rb +1 -0
- data/lib/schematic/entitlements/types/list_company_overrides_params.rb +8 -0
- data/lib/schematic/entitlements/types/list_company_overrides_request.rb +8 -0
- data/lib/schematic/entitlements/types/list_company_overrides_response.rb +1 -0
- data/lib/schematic/entitlements/types/list_feature_companies_params.rb +3 -0
- data/lib/schematic/entitlements/types/list_feature_companies_request.rb +3 -0
- data/lib/schematic/entitlements/types/list_feature_companies_response.rb +1 -0
- data/lib/schematic/entitlements/types/list_feature_usage_history_params.rb +24 -0
- data/lib/schematic/entitlements/types/list_feature_usage_history_request.rb +23 -0
- data/lib/schematic/entitlements/types/list_feature_usage_history_response.rb +13 -0
- data/lib/schematic/entitlements/types/list_feature_usage_params.rb +8 -0
- data/lib/schematic/entitlements/types/list_feature_usage_request.rb +8 -0
- data/lib/schematic/entitlements/types/list_feature_usage_response.rb +1 -0
- data/lib/schematic/entitlements/types/list_feature_users_params.rb +3 -0
- data/lib/schematic/entitlements/types/list_feature_users_request.rb +3 -0
- data/lib/schematic/entitlements/types/list_feature_users_response.rb +1 -0
- data/lib/schematic/entitlements/types/list_plan_entitlements_params.rb +10 -0
- data/lib/schematic/entitlements/types/list_plan_entitlements_request.rb +10 -0
- data/lib/schematic/entitlements/types/list_plan_entitlements_response.rb +1 -0
- data/lib/schematic/entitlements/types/update_company_override_request_body.rb +10 -0
- data/lib/schematic/entitlements/types/update_company_override_response.rb +1 -0
- data/lib/schematic/entitlements/types/update_plan_entitlement_request_body.rb +31 -0
- data/lib/schematic/entitlements/types/update_plan_entitlement_response.rb +1 -0
- data/lib/schematic/entitlements/types/upsert_plan_entitlement_for_billing_product_response.rb +1 -0
- data/lib/schematic/event_buffer.rb +16 -2
- data/lib/schematic/events/client.rb +36 -7
- data/lib/schematic/events/types/create_event_batch_response.rb +1 -0
- data/lib/schematic/events/types/create_event_response.rb +1 -0
- data/lib/schematic/events/types/get_event_response.rb +1 -0
- data/lib/schematic/events/types/get_event_summaries_params.rb +3 -0
- data/lib/schematic/events/types/get_event_summaries_request.rb +3 -0
- data/lib/schematic/events/types/get_event_summaries_response.rb +1 -0
- data/lib/schematic/events/types/get_segment_integration_status_response.rb +1 -0
- data/lib/schematic/events/types/list_events_params.rb +7 -0
- data/lib/schematic/events/types/list_events_request.rb +7 -0
- data/lib/schematic/events/types/list_events_response.rb +1 -0
- data/lib/schematic/features/client.rb +137 -12
- data/lib/schematic/features/types/check_flag_response.rb +1 -0
- data/lib/schematic/features/types/check_flags_bulk_response.rb +1 -0
- data/lib/schematic/features/types/check_flags_response.rb +1 -0
- data/lib/schematic/features/types/count_features_params.rb +9 -0
- data/lib/schematic/features/types/count_features_request.rb +9 -0
- data/lib/schematic/features/types/count_features_response.rb +1 -0
- data/lib/schematic/features/types/count_flags_params.rb +4 -0
- data/lib/schematic/features/types/count_flags_request.rb +4 -0
- data/lib/schematic/features/types/count_flags_response.rb +1 -0
- data/lib/schematic/features/types/create_billing_linked_feature_request_body.rb +12 -0
- data/lib/schematic/features/types/create_feature_request_body.rb +10 -0
- data/lib/schematic/features/types/create_feature_response.rb +1 -0
- data/lib/schematic/features/types/create_flag_response.rb +1 -0
- data/lib/schematic/features/types/delete_feature_response.rb +1 -0
- data/lib/schematic/features/types/delete_flag_response.rb +1 -0
- data/lib/schematic/features/types/get_feature_response.rb +1 -0
- data/lib/schematic/features/types/get_flag_response.rb +1 -0
- data/lib/schematic/features/types/list_features_params.rb +9 -0
- data/lib/schematic/features/types/list_features_request.rb +9 -0
- data/lib/schematic/features/types/list_features_response.rb +1 -0
- data/lib/schematic/features/types/list_flags_params.rb +4 -0
- data/lib/schematic/features/types/list_flags_request.rb +4 -0
- data/lib/schematic/features/types/list_flags_response.rb +1 -0
- data/lib/schematic/features/types/update_feature_request_body.rb +11 -0
- data/lib/schematic/features/types/update_feature_response.rb +1 -0
- data/lib/schematic/features/types/update_flag_response.rb +1 -0
- data/lib/schematic/features/types/update_flag_rules_request_body.rb +1 -0
- data/lib/schematic/features/types/update_flag_rules_response.rb +1 -0
- data/lib/schematic/features/types/upsert_feature_for_billing_product_response.rb +1 -0
- data/lib/schematic/insights/client.rb +34 -13
- data/lib/schematic/insights/types/get_activity_response.rb +1 -0
- data/lib/schematic/insights/types/get_environment_feature_usage_time_series_params.rb +3 -0
- data/lib/schematic/insights/types/get_environment_feature_usage_time_series_request.rb +3 -0
- data/lib/schematic/insights/types/get_environment_feature_usage_time_series_response.rb +1 -0
- data/lib/schematic/insights/types/get_environment_trait_usage_time_series_params.rb +3 -0
- data/lib/schematic/insights/types/get_environment_trait_usage_time_series_request.rb +3 -0
- data/lib/schematic/insights/types/get_environment_trait_usage_time_series_response.rb +1 -0
- data/lib/schematic/insights/types/get_plan_growth_response.rb +1 -0
- data/lib/schematic/insights/types/get_summary_response.rb +1 -0
- data/lib/schematic/insights/types/get_top_features_by_usage_params.rb +2 -0
- data/lib/schematic/insights/types/get_top_features_by_usage_request.rb +2 -0
- data/lib/schematic/insights/types/get_top_features_by_usage_response.rb +1 -0
- data/lib/schematic/integrationsapi/client.rb +37 -5
- data/lib/schematic/integrationsapi/types/assume_stripe_installed_response.rb +1 -0
- data/lib/schematic/integrationsapi/types/get_integration_webhook_url_response.rb +1 -0
- data/lib/schematic/integrationsapi/types/install_integration_response.rb +1 -0
- data/lib/schematic/integrationsapi/types/install_stripe_response.rb +1 -0
- data/lib/schematic/integrationsapi/types/list_integrations_params.rb +6 -0
- data/lib/schematic/integrationsapi/types/list_integrations_request.rb +6 -0
- data/lib/schematic/integrationsapi/types/list_integrations_response.rb +1 -0
- data/lib/schematic/integrationsapi/types/load_sample_data_set_response.rb +1 -0
- data/lib/schematic/integrationsapi/types/run_integration_response.rb +1 -0
- data/lib/schematic/integrationsapi/types/start_data_import_request_body.rb +2 -0
- data/lib/schematic/integrationsapi/types/start_data_import_response.rb +1 -0
- data/lib/schematic/integrationsapi/types/uninstall_integration_response.rb +1 -0
- data/lib/schematic/internal/http/raw_client.rb +58 -7
- data/lib/schematic/internal/iterators/cursor_page_iterator.rb +14 -2
- data/lib/schematic/internal/iterators/item_iterator.rb +6 -0
- data/lib/schematic/internal/iterators/offset_page_iterator.rb +22 -2
- data/lib/schematic/internal/types/utils.rb +2 -2
- data/lib/schematic/licenses/client.rb +21 -4
- data/lib/schematic/licenses/types/count_licenses_params.rb +4 -0
- data/lib/schematic/licenses/types/count_licenses_request.rb +4 -0
- data/lib/schematic/licenses/types/count_licenses_response.rb +1 -0
- data/lib/schematic/licenses/types/get_single_license_response.rb +1 -0
- data/lib/schematic/licenses/types/list_licenses_params.rb +4 -0
- data/lib/schematic/licenses/types/list_licenses_request.rb +4 -0
- data/lib/schematic/licenses/types/list_licenses_response.rb +1 -0
- data/lib/schematic/planbundle/client.rb +40 -3
- data/lib/schematic/planbundle/types/create_custom_plan_bundle_request_body.rb +5 -2
- data/lib/schematic/planbundle/types/create_custom_plan_bundle_response.rb +1 -0
- data/lib/schematic/planbundle/types/create_plan_bundle_request_body.rb +4 -1
- data/lib/schematic/planbundle/types/create_plan_bundle_response.rb +1 -0
- data/lib/schematic/planbundle/types/update_plan_bundle_request_body.rb +7 -2
- data/lib/schematic/planbundle/types/update_plan_bundle_response.rb +1 -0
- data/lib/schematic/plangroups/client.rb +65 -3
- data/lib/schematic/plangroups/types/create_plan_group_request_body.rb +39 -0
- data/lib/schematic/plangroups/types/create_plan_group_response.rb +1 -0
- data/lib/schematic/plangroups/types/get_plan_group_response.rb +1 -0
- data/lib/schematic/plangroups/types/update_plan_group_request_body.rb +40 -0
- data/lib/schematic/plangroups/types/update_plan_group_response.rb +1 -0
- data/lib/schematic/planmigrations/client.rb +66 -13
- data/lib/schematic/planmigrations/types/count_company_migrations_params.rb +4 -0
- data/lib/schematic/planmigrations/types/count_company_migrations_request.rb +5 -1
- data/lib/schematic/planmigrations/types/count_company_migrations_response.rb +1 -0
- data/lib/schematic/planmigrations/types/count_migrations_params.rb +3 -0
- data/lib/schematic/planmigrations/types/count_migrations_request.rb +4 -1
- data/lib/schematic/planmigrations/types/count_migrations_response.rb +1 -0
- data/lib/schematic/planmigrations/types/create_migration_input.rb +11 -3
- data/lib/schematic/planmigrations/types/create_migration_response.rb +1 -0
- data/lib/schematic/planmigrations/types/get_migration_response.rb +1 -0
- data/lib/schematic/planmigrations/types/list_company_migrations_params.rb +4 -0
- data/lib/schematic/planmigrations/types/list_company_migrations_request.rb +5 -1
- data/lib/schematic/planmigrations/types/list_company_migrations_response.rb +1 -0
- data/lib/schematic/planmigrations/types/list_migrations_params.rb +3 -0
- data/lib/schematic/planmigrations/types/list_migrations_request.rb +4 -1
- data/lib/schematic/planmigrations/types/list_migrations_response.rb +1 -0
- data/lib/schematic/planmigrations/types/preview_migration_request_body.rb +6 -1
- data/lib/schematic/planmigrations/types/preview_migration_response.rb +1 -0
- data/lib/schematic/planmigrations/types/retry_company_migration_response.rb +1 -0
- data/lib/schematic/planmigrations/types/retry_migration_request_body.rb +1 -0
- data/lib/schematic/planmigrations/types/retry_migration_response.rb +1 -0
- data/lib/schematic/plans/client.rb +173 -28
- data/lib/schematic/plans/types/count_billing_product_match_companies_params.rb +3 -0
- data/lib/schematic/plans/types/count_billing_product_match_companies_request.rb +3 -0
- data/lib/schematic/plans/types/count_billing_product_match_companies_response.rb +1 -0
- data/lib/schematic/plans/types/count_plans_params.rb +16 -0
- data/lib/schematic/plans/types/count_plans_request.rb +16 -0
- data/lib/schematic/plans/types/count_plans_response.rb +1 -0
- data/lib/schematic/plans/types/create_billing_linked_plan_request_body.rb +7 -1
- data/lib/schematic/plans/types/create_custom_plan_request_body.rb +7 -1
- data/lib/schematic/plans/types/create_custom_plan_response.rb +1 -0
- data/lib/schematic/plans/types/create_plan_response.rb +1 -0
- data/lib/schematic/plans/types/delete_plan_response.rb +1 -0
- data/lib/schematic/plans/types/delete_plan_version_request.rb +2 -1
- data/lib/schematic/plans/types/delete_plan_version_response.rb +1 -0
- data/lib/schematic/plans/types/get_plan_request.rb +1 -0
- data/lib/schematic/plans/types/get_plan_response.rb +1 -0
- data/lib/schematic/plans/types/list_billing_product_match_companies_params.rb +3 -0
- data/lib/schematic/plans/types/list_billing_product_match_companies_request.rb +3 -0
- data/lib/schematic/plans/types/list_billing_product_match_companies_response.rb +1 -0
- data/lib/schematic/plans/types/list_custom_plan_billings_params.rb +7 -0
- data/lib/schematic/plans/types/list_custom_plan_billings_request.rb +7 -0
- data/lib/schematic/plans/types/list_custom_plan_billings_response.rb +1 -0
- data/lib/schematic/plans/types/list_plan_issues_params.rb +1 -0
- data/lib/schematic/plans/types/list_plan_issues_request.rb +1 -0
- data/lib/schematic/plans/types/list_plan_issues_response.rb +1 -0
- data/lib/schematic/plans/types/list_plans_params.rb +16 -0
- data/lib/schematic/plans/types/list_plans_request.rb +16 -0
- data/lib/schematic/plans/types/list_plans_response.rb +1 -0
- data/lib/schematic/plans/types/mark_custom_plan_billing_paid_response.rb +1 -0
- data/lib/schematic/plans/types/publish_plan_version_request_body.rb +16 -1
- data/lib/schematic/plans/types/publish_plan_version_response.rb +1 -0
- data/lib/schematic/plans/types/retry_custom_plan_billing_request_body.rb +4 -0
- data/lib/schematic/plans/types/retry_custom_plan_billing_response.rb +1 -0
- data/lib/schematic/plans/types/update_company_plans_request_body.rb +3 -1
- data/lib/schematic/plans/types/update_company_plans_response.rb +1 -0
- data/lib/schematic/plans/types/update_plan_response.rb +1 -0
- data/lib/schematic/plans/types/upsert_billing_product_plan_response.rb +1 -0
- data/lib/schematic/plans/types/upsert_plan_for_billing_product_response.rb +1 -0
- data/lib/schematic/scheduledcheckout/client.rb +23 -3
- data/lib/schematic/scheduledcheckout/types/create_scheduled_checkout_request.rb +3 -0
- data/lib/schematic/scheduledcheckout/types/create_scheduled_checkout_response.rb +1 -0
- data/lib/schematic/scheduledcheckout/types/get_scheduled_checkout_response.rb +1 -0
- data/lib/schematic/scheduledcheckout/types/list_scheduled_checkouts_params.rb +3 -0
- data/lib/schematic/scheduledcheckout/types/list_scheduled_checkouts_request.rb +3 -0
- data/lib/schematic/scheduledcheckout/types/list_scheduled_checkouts_response.rb +1 -0
- data/lib/schematic/scheduledcheckout/types/update_scheduled_checkout_request.rb +2 -0
- data/lib/schematic/scheduledcheckout/types/update_scheduled_checkout_response.rb +1 -0
- data/lib/schematic/schematic_client.rb +4 -4
- data/lib/schematic/types/account_member_response_data.rb +9 -0
- data/lib/schematic/types/activity_entry_response_data.rb +5 -0
- data/lib/schematic/types/api_key_create_response_data.rb +12 -0
- data/lib/schematic/types/api_key_integration_response_data.rb +2 -0
- data/lib/schematic/types/api_key_response_data.rb +11 -0
- data/lib/schematic/types/audit_log_export_metadata.rb +4 -0
- data/lib/schematic/types/audit_log_list_response_data.rb +16 -0
- data/lib/schematic/types/audit_log_response_data.rb +21 -0
- data/lib/schematic/types/billing_collection_method.rb +12 -0
- data/lib/schematic/types/billing_coupon_response_data.rb +16 -0
- data/lib/schematic/types/billing_credit_bundle_response_data.rb +22 -0
- data/lib/schematic/types/billing_credit_bundle_view.rb +21 -0
- data/lib/schematic/types/billing_credit_grant_response_data.rb +30 -0
- data/lib/schematic/types/billing_credit_ledger_response_data.rb +5 -0
- data/lib/schematic/types/billing_credit_response_data.rb +15 -0
- data/lib/schematic/types/billing_credit_view.rb +20 -0
- data/lib/schematic/types/billing_customer_response_data.rb +7 -0
- data/lib/schematic/types/billing_customer_subscription.rb +5 -0
- data/lib/schematic/types/billing_customer_with_subscriptions_response_data.rb +8 -0
- data/lib/schematic/types/billing_linked_resource_response_data.rb +2 -0
- data/lib/schematic/types/billing_meter_response_data.rb +5 -0
- data/lib/schematic/types/billing_plan_credit_grant_response_data.rb +34 -0
- data/lib/schematic/types/billing_price_response_data.rb +9 -0
- data/lib/schematic/types/billing_price_view.rb +23 -0
- data/lib/schematic/types/billing_product_detail_response_data.rb +14 -0
- data/lib/schematic/types/billing_product_for_subscription_response_data.rb +22 -0
- data/lib/schematic/types/billing_product_plan_response_data.rb +11 -0
- data/lib/schematic/types/billing_product_price_response_data.rb +17 -0
- data/lib/schematic/types/billing_product_price_tier_response_data.rb +3 -0
- data/lib/schematic/types/billing_product_pricing.rb +11 -0
- data/lib/schematic/types/billing_product_record_response_data.rb +8 -0
- data/lib/schematic/types/billing_product_response_data.rb +12 -0
- data/lib/schematic/types/billing_subscription_discount.rb +6 -0
- data/lib/schematic/types/billing_subscription_discount_view.rb +13 -0
- data/lib/schematic/types/billing_subscription_response_data.rb +19 -0
- data/lib/schematic/types/billing_subscription_view.rb +23 -0
- data/lib/schematic/types/capture_raw_event.rb +4 -0
- data/lib/schematic/types/catalog_config_ordered_entitlement.rb +1 -0
- data/lib/schematic/types/catalog_config_ordered_entitlement_response_data.rb +1 -0
- data/lib/schematic/types/catalog_config_ordered_plan.rb +1 -0
- data/lib/schematic/types/catalog_config_ordered_plan_response_data.rb +1 -0
- data/lib/schematic/types/catalog_configuration_response_data.rb +10 -0
- data/lib/schematic/types/catalog_derived_feature_response_data.rb +2 -0
- data/lib/schematic/types/catalog_response_data.rb +12 -0
- data/lib/schematic/types/change_subscription_internal_request_body.rb +13 -0
- data/lib/schematic/types/change_subscription_request_body.rb +12 -0
- data/lib/schematic/types/check_flag_request_body.rb +3 -0
- data/lib/schematic/types/check_flag_response_data.rb +14 -0
- data/lib/schematic/types/check_flags_response_data.rb +2 -0
- data/lib/schematic/types/checkout_bundle_purchase_behavior.rb +12 -0
- data/lib/schematic/types/checkout_data_response_data.rb +10 -0
- data/lib/schematic/types/checkout_field_input.rb +5 -0
- data/lib/schematic/types/checkout_field_response_data.rb +9 -0
- data/lib/schematic/types/checkout_field_value.rb +1 -0
- data/lib/schematic/types/checkout_field_with_value.rb +6 -0
- data/lib/schematic/types/checkout_settings_response_data.rb +9 -0
- data/lib/schematic/types/checkout_subscription.rb +23 -0
- data/lib/schematic/types/clerk_integration_config.rb +1 -0
- data/lib/schematic/types/company_billing_address_view.rb +5 -0
- data/lib/schematic/types/company_billing_checkout_settings.rb +4 -0
- data/lib/schematic/types/company_billing_details_response_data.rb +5 -0
- data/lib/schematic/types/company_billing_details_view.rb +5 -0
- data/lib/schematic/types/company_billing_entity_response_data.rb +1 -0
- data/lib/schematic/types/company_billing_entity_subscription_response_data.rb +17 -0
- data/lib/schematic/types/company_credit_balance.rb +2 -0
- data/lib/schematic/types/company_credit_balance_response_data.rb +5 -0
- data/lib/schematic/types/company_detail_response_data.rb +23 -0
- data/lib/schematic/types/company_event_period_metrics_response_data.rb +10 -0
- data/lib/schematic/types/company_feature_usage_export_metadata.rb +25 -0
- data/lib/schematic/types/company_ledger_response_data.rb +2 -0
- data/lib/schematic/types/company_membership_detail_response_data.rb +5 -0
- data/lib/schematic/types/company_membership_response_data.rb +4 -0
- data/lib/schematic/types/company_override_note_response_data.rb +5 -0
- data/lib/schematic/types/company_override_response_data.rb +19 -0
- data/lib/schematic/types/company_plan_credit_grant_view.rb +38 -0
- data/lib/schematic/types/company_plan_detail_response_data.rb +44 -0
- data/lib/schematic/types/company_plan_with_billing_sub_view.rb +10 -0
- data/lib/schematic/types/company_response_data.rb +6 -0
- data/lib/schematic/types/company_subscription_response_data.rb +15 -0
- data/lib/schematic/types/company_tax_id_view.rb +4 -0
- data/lib/schematic/types/compatible_plans.rb +1 -0
- data/lib/schematic/types/compatible_plans_response_data.rb +1 -0
- data/lib/schematic/types/component_capabilities.rb +1 -0
- data/lib/schematic/types/component_checkout_settings.rb +8 -0
- data/lib/schematic/types/component_display_settings.rb +5 -0
- data/lib/schematic/types/component_hydrate_response_data.rb +27 -1
- data/lib/schematic/types/component_preview_response_data.rb +28 -1
- data/lib/schematic/types/component_response_data.rb +7 -0
- data/lib/schematic/types/component_settings_response_data.rb +5 -0
- data/lib/schematic/types/condition.rb +14 -0
- data/lib/schematic/types/condition_group_response_data.rb +6 -0
- data/lib/schematic/types/condition_group_view.rb +7 -0
- data/lib/schematic/types/condition_response_data.rb +23 -0
- data/lib/schematic/types/condition_view.rb +30 -0
- data/lib/schematic/types/coupon_request_body.rb +7 -0
- data/lib/schematic/types/create_billing_plan_credit_grant_request_body.rb +26 -0
- data/lib/schematic/types/create_billing_price_tier_request_body.rb +5 -0
- data/lib/schematic/types/create_custom_plan_bundle_plan_request_body.rb +4 -1
- data/lib/schematic/types/create_entitlement_in_bundle_request_body.rb +33 -0
- data/lib/schematic/types/create_entitlement_req_common.rb +8 -0
- data/lib/schematic/types/create_event_request_body.rb +5 -0
- data/lib/schematic/types/create_flag_request_body.rb +6 -0
- data/lib/schematic/types/create_or_update_condition_group_request_body.rb +2 -0
- data/lib/schematic/types/create_or_update_condition_request_body.rb +12 -0
- data/lib/schematic/types/create_or_update_flag_request_body.rb +7 -0
- data/lib/schematic/types/create_or_update_rule_request_body.rb +6 -0
- data/lib/schematic/types/create_plan_request_body.rb +4 -1
- data/lib/schematic/types/create_price_tier_request_body.rb +3 -0
- data/lib/schematic/types/credit_bundle_currency_price.rb +1 -0
- data/lib/schematic/types/credit_bundle_currency_price_request_body.rb +2 -0
- data/lib/schematic/types/credit_bundle_currency_price_response_data.rb +1 -0
- data/lib/schematic/types/credit_bundle_purchase_response_data.rb +2 -0
- data/lib/schematic/types/credit_company_grant_view.rb +38 -0
- data/lib/schematic/types/credit_currency_price.rb +1 -0
- data/lib/schematic/types/credit_currency_price_request_body.rb +2 -0
- data/lib/schematic/types/credit_currency_price_response_data.rb +1 -0
- data/lib/schematic/types/credit_event_ledger_response_data.rb +31 -0
- data/lib/schematic/types/credit_grant_detail.rb +3 -0
- data/lib/schematic/types/credit_grant_expiry_request_body.rb +5 -0
- data/lib/schematic/types/credit_lease_response_data.rb +7 -0
- data/lib/schematic/types/credit_transfer_response_data.rb +5 -0
- data/lib/schematic/types/credit_transfer_view.rb +5 -0
- data/lib/schematic/types/credit_usage.rb +8 -0
- data/lib/schematic/types/credit_usage_aggregation.rb +3 -0
- data/lib/schematic/types/credits_auto_topup_company_summary.rb +1 -0
- data/lib/schematic/types/credits_auto_topup_credit_summary.rb +1 -0
- data/lib/schematic/types/credits_auto_topup_hard_failure.rb +3 -0
- data/lib/schematic/types/credits_auto_topup_retry_failure.rb +4 -0
- data/lib/schematic/types/credits_auto_topup_success.rb +3 -0
- data/lib/schematic/types/credits_credit_purchase_success.rb +5 -0
- data/lib/schematic/types/credits_webhook_company_summary.rb +1 -0
- data/lib/schematic/types/credits_webhook_credit_summary.rb +1 -0
- data/lib/schematic/types/currency_price_request_body.rb +9 -0
- data/lib/schematic/types/custom_plan_billing_response_data.rb +16 -0
- data/lib/schematic/types/custom_plan_config.rb +2 -0
- data/lib/schematic/types/custom_plan_view_config_response_data.rb +2 -0
- data/lib/schematic/types/customer_billing_address.rb +5 -0
- data/lib/schematic/types/data_event_payload.rb +6 -0
- data/lib/schematic/types/data_export_metadata.rb +2 -0
- data/lib/schematic/types/data_export_response_data.rb +8 -0
- data/lib/schematic/types/datastream_company_plan.rb +3 -0
- data/lib/schematic/types/duplicate_plan_entitlements_response_response_data.rb +2 -0
- data/lib/schematic/types/entitlement_currency_prices_response_data.rb +3 -0
- data/lib/schematic/types/entitlements_in_plan.rb +1 -0
- data/lib/schematic/types/entity_key_definition_response_data.rb +4 -0
- data/lib/schematic/types/entity_key_detail_response_data.rb +9 -0
- data/lib/schematic/types/entity_key_response_data.rb +8 -0
- data/lib/schematic/types/entity_trait_definition_response_data.rb +6 -0
- data/lib/schematic/types/entity_trait_definition_usage.rb +19 -0
- data/lib/schematic/types/entity_trait_detail_response_data.rb +6 -0
- data/lib/schematic/types/entity_trait_response_data.rb +5 -0
- data/lib/schematic/types/entity_trait_value.rb +1 -0
- data/lib/schematic/types/environment_detail_response_data.rb +5 -0
- data/lib/schematic/types/environment_feature_usage_time_series_response_data.rb +2 -0
- data/lib/schematic/types/environment_response_data.rb +4 -0
- data/lib/schematic/types/environment_trait_usage_time_series_response_data.rb +2 -0
- data/lib/schematic/types/environment_usage_point_response_data.rb +1 -0
- data/lib/schematic/types/event_body.rb +3 -0
- data/lib/schematic/types/event_body_flag_check.rb +11 -0
- data/lib/schematic/types/event_body_identify.rb +3 -0
- data/lib/schematic/types/event_body_identify_company.rb +2 -0
- data/lib/schematic/types/event_body_inference.rb +13 -0
- data/lib/schematic/types/event_body_track.rb +5 -0
- data/lib/schematic/types/event_detail_response_data.rb +24 -0
- data/lib/schematic/types/event_export_metadata.rb +7 -0
- data/lib/schematic/types/event_response_data.rb +20 -0
- data/lib/schematic/types/event_summary_response_data.rb +5 -0
- data/lib/schematic/types/feature_company_response_data.rb +36 -0
- data/lib/schematic/types/feature_company_user_response_data.rb +12 -0
- data/lib/schematic/types/feature_detail_response_data.rb +21 -0
- data/lib/schematic/types/feature_entitlement.rb +18 -0
- data/lib/schematic/types/feature_in_plan_response_data.rb +19 -0
- data/lib/schematic/types/feature_ledger_response_data.rb +3 -0
- data/lib/schematic/types/feature_response_data.rb +14 -0
- data/lib/schematic/types/feature_usage_history_response_data.rb +19 -0
- data/lib/schematic/types/feature_usage_legacy_response_data.rb +5 -0
- data/lib/schematic/types/feature_usage_response_data.rb +34 -0
- data/lib/schematic/types/feature_usage_time_series_response_data.rb +4 -0
- data/lib/schematic/types/feature_view.rb +20 -0
- data/lib/schematic/types/flag_detail_response_data.rb +13 -0
- data/lib/schematic/types/flag_in_plan_response_data.rb +12 -0
- data/lib/schematic/types/flag_response_data.rb +9 -0
- data/lib/schematic/types/flag_view.rb +12 -0
- data/lib/schematic/types/generic_preview_object.rb +3 -0
- data/lib/schematic/types/get_onboarding_state_resp.rb +19 -0
- data/lib/schematic/types/insights_summary_response_data.rb +5 -0
- data/lib/schematic/types/install_integration_request_body.rb +5 -0
- data/lib/schematic/types/integration_capabilities.rb +2 -0
- data/lib/schematic/types/integration_config.rb +4 -0
- data/lib/schematic/types/integration_install_config.rb +9 -0
- data/lib/schematic/types/integration_install_response_data.rb +2 -0
- data/lib/schematic/types/integration_response_data.rb +4 -0
- data/lib/schematic/types/integration_webhook_url_response_data.rb +1 -0
- data/lib/schematic/types/integrations_list_response_data.rb +7 -0
- data/lib/schematic/types/integrations_response_data.rb +4 -0
- data/lib/schematic/types/invoice_request_body.rb +13 -0
- data/lib/schematic/types/invoice_response_data.rb +20 -0
- data/lib/schematic/types/issue_temporary_access_token_response_data.rb +7 -0
- data/lib/schematic/types/license_response_data.rb +3 -0
- data/lib/schematic/types/limit_time_series_point_response_data.rb +5 -0
- data/lib/schematic/types/manage_plan_request.rb +28 -0
- data/lib/schematic/types/manage_plan_response_response_data.rb +1 -0
- data/lib/schematic/types/meter_request_body.rb +2 -0
- data/lib/schematic/types/migration_proration_behavior.rb +13 -0
- data/lib/schematic/types/mrr_response_data.rb +1 -0
- data/lib/schematic/types/onboarding_milestone.rb +12 -0
- data/lib/schematic/types/onboarding_milestone_view.rb +15 -0
- data/lib/schematic/types/onboarding_path.rb +12 -0
- data/lib/schematic/types/onboarding_requirement.rb +16 -0
- data/lib/schematic/types/onboarding_requirement_status.rb +13 -0
- data/lib/schematic/types/onboarding_requirement_view.rb +17 -0
- data/lib/schematic/types/onboarding_track.rb +12 -0
- data/lib/schematic/types/ordered_plans_in_group.rb +1 -0
- data/lib/schematic/types/payment_method_request_body.rb +10 -0
- data/lib/schematic/types/payment_method_response_data.rb +17 -0
- data/lib/schematic/types/plan_billing_source.rb +12 -0
- data/lib/schematic/types/plan_bundle_credit_grant_request_body.rb +4 -0
- data/lib/schematic/types/plan_bundle_entitlement_request_body.rb +2 -0
- data/lib/schematic/types/plan_bundle_response_data.rb +5 -0
- data/lib/schematic/types/plan_catalog_membership_response_data.rb +1 -0
- data/lib/schematic/types/plan_change_response_data.rb +29 -0
- data/lib/schematic/types/plan_credit_grant_view.rb +35 -0
- data/lib/schematic/types/plan_currency_price_request_body.rb +4 -0
- data/lib/schematic/types/plan_currency_prices_response_data.rb +4 -0
- data/lib/schematic/types/plan_detail_response_data.rb +34 -0
- data/lib/schematic/types/plan_entitlement_response_data.rb +29 -0
- data/lib/schematic/types/plan_entitlements_order.rb +1 -0
- data/lib/schematic/types/plan_group_detail_response_data.rb +37 -0
- data/lib/schematic/types/plan_group_plan_detail_response_data.rb +38 -0
- data/lib/schematic/types/plan_group_plan_entitlements_order.rb +1 -0
- data/lib/schematic/types/plan_group_response_data.rb +27 -0
- data/lib/schematic/types/plan_growth_point_response_data.rb +3 -0
- data/lib/schematic/types/plan_issue_response_data.rb +3 -0
- data/lib/schematic/types/plan_response_data.rb +9 -0
- data/lib/schematic/types/plan_selection.rb +2 -0
- data/lib/schematic/types/plan_snapshot_view.rb +4 -0
- data/lib/schematic/types/plan_trait_response_data.rb +8 -0
- data/lib/schematic/types/plan_version_company_migration_response_data.rb +11 -0
- data/lib/schematic/types/plan_version_migration_preview_company_response_data.rb +7 -0
- data/lib/schematic/types/plan_version_migration_preview_response_data.rb +2 -0
- data/lib/schematic/types/plan_version_migration_response_data.rb +17 -0
- data/lib/schematic/types/plan_version_response_data.rb +10 -0
- data/lib/schematic/types/plan_version_snapshot_view.rb +2 -0
- data/lib/schematic/types/plan_view_public_response_data.rb +39 -0
- data/lib/schematic/types/preflight_event_usage_request_body.rb +11 -0
- data/lib/schematic/types/preflight_request_body.rb +13 -0
- data/lib/schematic/types/preview_object.rb +3 -0
- data/lib/schematic/types/preview_object_response_data.rb +3 -0
- data/lib/schematic/types/preview_subscription_change_response_data.rb +15 -0
- data/lib/schematic/types/preview_subscription_discount_response_data.rb +10 -0
- data/lib/schematic/types/preview_subscription_finance_response_data.rb +18 -0
- data/lib/schematic/types/preview_subscription_upcoming_invoice_line_items.rb +4 -0
- data/lib/schematic/types/public_plans_response_data.rb +8 -0
- data/lib/schematic/types/raw_event_response_data.rb +4 -0
- data/lib/schematic/types/rule.rb +9 -0
- data/lib/schematic/types/rule_condition_detail_response_data.rb +20 -0
- data/lib/schematic/types/rule_condition_group_detail_response_data.rb +6 -0
- data/lib/schematic/types/rule_condition_group_response_data.rb +5 -0
- data/lib/schematic/types/rule_condition_response_data.rb +17 -0
- data/lib/schematic/types/rule_detail_response_data.rb +10 -0
- data/lib/schematic/types/rule_response_data.rb +8 -0
- data/lib/schematic/types/rule_view.rb +11 -0
- data/lib/schematic/types/rules_detail_response_data.rb +1 -0
- data/lib/schematic/types/rules_engine_schema_version.rb +1 -1
- data/lib/schematic/types/rulesengine_check_flag_result.rb +14 -0
- data/lib/schematic/types/rulesengine_company.rb +13 -0
- data/lib/schematic/types/rulesengine_company_metric.rb +8 -0
- data/lib/schematic/types/rulesengine_condition.rb +14 -0
- data/lib/schematic/types/rulesengine_feature_entitlement.rb +18 -0
- data/lib/schematic/types/rulesengine_flag.rb +5 -0
- data/lib/schematic/types/rulesengine_rule.rb +9 -0
- data/lib/schematic/types/rulesengine_subscription.rb +2 -0
- data/lib/schematic/types/rulesengine_trait.rb +1 -0
- data/lib/schematic/types/rulesengine_trait_definition.rb +2 -0
- data/lib/schematic/types/rulesengine_user.rb +5 -0
- data/lib/schematic/types/rulesengine_warning_tier.rb +1 -0
- data/lib/schematic/types/scheduled_checkout_response_data.rb +13 -0
- data/lib/schematic/types/scheduled_downgrade_response_data.rb +10 -0
- data/lib/schematic/types/segment_status_resp.rb +2 -0
- data/lib/schematic/types/skipped_entitlement_response_data.rb +3 -0
- data/lib/schematic/types/stripe_embed_info.rb +3 -0
- data/lib/schematic/types/stripe_integration_config.rb +7 -0
- data/lib/schematic/types/subscription_trait_update.rb +6 -0
- data/lib/schematic/types/tax_id_input.rb +1 -0
- data/lib/schematic/types/temporary_access_token_response_data.rb +6 -0
- data/lib/schematic/types/test_webhook_response_data.rb +2 -0
- data/lib/schematic/types/top_feature_by_usage_response_data.rb +5 -0
- data/lib/schematic/types/trait_definition.rb +2 -0
- data/lib/schematic/types/upcoming_invoice_response_data.rb +47 -0
- data/lib/schematic/types/update_add_on_request_body.rb +1 -0
- data/lib/schematic/types/update_auto_topup_override_request_body.rb +3 -0
- data/lib/schematic/types/update_billing_plan_credit_grant_request_body.rb +23 -0
- data/lib/schematic/types/update_credit_bundle_request_body.rb +1 -0
- data/lib/schematic/types/update_entitlement_req_common.rb +7 -0
- data/lib/schematic/types/update_pay_in_advance_request_body.rb +1 -0
- data/lib/schematic/types/update_plan_request_body.rb +2 -0
- data/lib/schematic/types/update_plan_trait_trait_request_body.rb +1 -0
- data/lib/schematic/types/update_rule_request_body.rb +4 -0
- data/lib/schematic/types/upsert_billing_product_request_body.rb +14 -0
- data/lib/schematic/types/upsert_company_request_body.rb +10 -0
- data/lib/schematic/types/upsert_trait_request_body.rb +4 -0
- data/lib/schematic/types/upsert_user_request_body.rb +11 -0
- data/lib/schematic/types/upsert_user_sub_request_body.rb +9 -0
- data/lib/schematic/types/usage_based_entitlement_request_body.rb +21 -0
- data/lib/schematic/types/usage_based_entitlement_response_data.rb +13 -0
- data/lib/schematic/types/usage_time_series_point_response_data.rb +3 -0
- data/lib/schematic/types/user_credit_usage_response_data.rb +5 -0
- data/lib/schematic/types/user_daily_credit_point_response_data.rb +1 -0
- data/lib/schematic/types/user_daily_usage_point_response_data.rb +2 -0
- data/lib/schematic/types/user_detail_response_data.rb +9 -0
- data/lib/schematic/types/user_feature_usage_response_data.rb +5 -0
- data/lib/schematic/types/user_response_data.rb +5 -0
- data/lib/schematic/types/user_usage_by_company_response_data.rb +3 -0
- data/lib/schematic/types/user_usage_detail_response_data.rb +6 -0
- data/lib/schematic/types/warning_tier.rb +1 -0
- data/lib/schematic/types/warning_tier_request_body.rb +1 -0
- data/lib/schematic/types/warning_tier_response_data.rb +2 -0
- data/lib/schematic/types/web_feature_usage_webhook_output.rb +6 -0
- data/lib/schematic/types/web_scheduled_downgrade_webhook_output.rb +6 -0
- data/lib/schematic/types/webhook_event_detail_response_data.rb +9 -0
- data/lib/schematic/types/webhook_event_response_data.rb +8 -0
- data/lib/schematic/types/webhook_response_data.rb +9 -0
- data/lib/schematic/types/webhook_url.rb +1 -0
- data/lib/schematic/types/who_am_i_response_data.rb +10 -0
- data/lib/schematic/types/work_os_integration_config.rb +1 -0
- data/lib/schematic/version.rb +1 -1
- data/lib/schematic/wasm/rulesengine.wasm +0 -0
- data/lib/schematic/webhooks/client.rb +59 -10
- data/lib/schematic/webhooks/types/count_webhook_events_params.rb +4 -0
- data/lib/schematic/webhooks/types/count_webhook_events_request.rb +4 -0
- data/lib/schematic/webhooks/types/count_webhook_events_response.rb +1 -0
- data/lib/schematic/webhooks/types/count_webhooks_params.rb +2 -0
- data/lib/schematic/webhooks/types/count_webhooks_request.rb +2 -0
- data/lib/schematic/webhooks/types/count_webhooks_response.rb +1 -0
- data/lib/schematic/webhooks/types/create_webhook_request_body.rb +4 -0
- data/lib/schematic/webhooks/types/create_webhook_response.rb +1 -0
- data/lib/schematic/webhooks/types/delete_webhook_response.rb +1 -0
- data/lib/schematic/webhooks/types/get_webhook_event_response.rb +1 -0
- data/lib/schematic/webhooks/types/get_webhook_response.rb +1 -0
- data/lib/schematic/webhooks/types/list_webhook_events_params.rb +4 -0
- data/lib/schematic/webhooks/types/list_webhook_events_request.rb +4 -0
- data/lib/schematic/webhooks/types/list_webhook_events_response.rb +1 -0
- data/lib/schematic/webhooks/types/list_webhooks_params.rb +2 -0
- data/lib/schematic/webhooks/types/list_webhooks_request.rb +2 -0
- data/lib/schematic/webhooks/types/list_webhooks_response.rb +1 -0
- data/lib/schematic/webhooks/types/send_test_webhook_action_response.rb +1 -0
- data/lib/schematic/webhooks/types/test_webhook_request_body.rb +1 -0
- data/lib/schematic/webhooks/types/update_webhook_request_body.rb +6 -0
- data/lib/schematic/webhooks/types/update_webhook_response.rb +1 -0
- data/lib/schematic.rb +29 -1
- data/reference.md +643 -130
- metadata +31 -2
data/reference.md
CHANGED
|
@@ -126,7 +126,7 @@ client.accounts.list_account_members(
|
|
|
126
126
|
</dl>
|
|
127
127
|
</details>
|
|
128
128
|
|
|
129
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_account_member</a>(account_member_id) -> Schematic::Accounts::Types::GetAccountMemberResponse</code></summary>
|
|
129
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_account_member</a>(account_member_id:) -> Schematic::Accounts::Types::GetAccountMemberResponse</code></summary>
|
|
130
130
|
<dl>
|
|
131
131
|
<dd>
|
|
132
132
|
|
|
@@ -417,7 +417,7 @@ client.accounts.create_api_key(name: "name")
|
|
|
417
417
|
</dl>
|
|
418
418
|
</details>
|
|
419
419
|
|
|
420
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_api_key</a>(api_key_id) -> Schematic::Accounts::Types::GetApiKeyResponse</code></summary>
|
|
420
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_api_key</a>(api_key_id:) -> Schematic::Accounts::Types::GetApiKeyResponse</code></summary>
|
|
421
421
|
<dl>
|
|
422
422
|
<dd>
|
|
423
423
|
|
|
@@ -465,7 +465,7 @@ client.accounts.get_api_key(api_key_id: "api_key_id")
|
|
|
465
465
|
</dl>
|
|
466
466
|
</details>
|
|
467
467
|
|
|
468
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">update_api_key</a>(api_key_id
|
|
468
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">update_api_key</a>(api_key_id:, request) -> Schematic::Accounts::Types::UpdateApiKeyResponse</code></summary>
|
|
469
469
|
<dl>
|
|
470
470
|
<dd>
|
|
471
471
|
|
|
@@ -537,7 +537,7 @@ client.accounts.update_api_key(api_key_id: "api_key_id")
|
|
|
537
537
|
</dl>
|
|
538
538
|
</details>
|
|
539
539
|
|
|
540
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">delete_api_key</a>(api_key_id) -> Schematic::Accounts::Types::DeleteApiKeyResponse</code></summary>
|
|
540
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">delete_api_key</a>(api_key_id:) -> Schematic::Accounts::Types::DeleteApiKeyResponse</code></summary>
|
|
541
541
|
<dl>
|
|
542
542
|
<dd>
|
|
543
543
|
|
|
@@ -766,7 +766,7 @@ client.accounts.list_audit_logs(
|
|
|
766
766
|
</dl>
|
|
767
767
|
</details>
|
|
768
768
|
|
|
769
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_audit_log</a>(audit_log_id) -> Schematic::Accounts::Types::GetAuditLogResponse</code></summary>
|
|
769
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_audit_log</a>(audit_log_id:) -> Schematic::Accounts::Types::GetAuditLogResponse</code></summary>
|
|
770
770
|
<dl>
|
|
771
771
|
<dd>
|
|
772
772
|
|
|
@@ -1045,7 +1045,7 @@ client.accounts.create_environment(
|
|
|
1045
1045
|
</dl>
|
|
1046
1046
|
</details>
|
|
1047
1047
|
|
|
1048
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_environment</a>(environment_id) -> Schematic::Accounts::Types::GetEnvironmentResponse</code></summary>
|
|
1048
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_environment</a>(environment_id:) -> Schematic::Accounts::Types::GetEnvironmentResponse</code></summary>
|
|
1049
1049
|
<dl>
|
|
1050
1050
|
<dd>
|
|
1051
1051
|
|
|
@@ -1093,7 +1093,7 @@ client.accounts.get_environment(environment_id: "environment_id")
|
|
|
1093
1093
|
</dl>
|
|
1094
1094
|
</details>
|
|
1095
1095
|
|
|
1096
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">update_environment</a>(environment_id
|
|
1096
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">update_environment</a>(environment_id:, request) -> Schematic::Accounts::Types::UpdateEnvironmentResponse</code></summary>
|
|
1097
1097
|
<dl>
|
|
1098
1098
|
<dd>
|
|
1099
1099
|
|
|
@@ -1157,7 +1157,7 @@ client.accounts.update_environment(environment_id: "environment_id")
|
|
|
1157
1157
|
</dl>
|
|
1158
1158
|
</details>
|
|
1159
1159
|
|
|
1160
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">delete_environment</a>(environment_id) -> Schematic::Accounts::Types::DeleteEnvironmentResponse</code></summary>
|
|
1160
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">delete_environment</a>(environment_id:) -> Schematic::Accounts::Types::DeleteEnvironmentResponse</code></summary>
|
|
1161
1161
|
<dl>
|
|
1162
1162
|
<dd>
|
|
1163
1163
|
|
|
@@ -1201,6 +1201,118 @@ client.accounts.delete_environment(environment_id: "environment_id")
|
|
|
1201
1201
|
</dl>
|
|
1202
1202
|
|
|
1203
1203
|
|
|
1204
|
+
</dd>
|
|
1205
|
+
</dl>
|
|
1206
|
+
</details>
|
|
1207
|
+
|
|
1208
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_onboarding_state</a>() -> Schematic::Accounts::Types::GetOnboardingStateResponse</code></summary>
|
|
1209
|
+
<dl>
|
|
1210
|
+
<dd>
|
|
1211
|
+
|
|
1212
|
+
#### 🔌 Usage
|
|
1213
|
+
|
|
1214
|
+
<dl>
|
|
1215
|
+
<dd>
|
|
1216
|
+
|
|
1217
|
+
<dl>
|
|
1218
|
+
<dd>
|
|
1219
|
+
|
|
1220
|
+
```ruby
|
|
1221
|
+
client.accounts.get_onboarding_state
|
|
1222
|
+
```
|
|
1223
|
+
</dd>
|
|
1224
|
+
</dl>
|
|
1225
|
+
</dd>
|
|
1226
|
+
</dl>
|
|
1227
|
+
|
|
1228
|
+
#### ⚙️ Parameters
|
|
1229
|
+
|
|
1230
|
+
<dl>
|
|
1231
|
+
<dd>
|
|
1232
|
+
|
|
1233
|
+
<dl>
|
|
1234
|
+
<dd>
|
|
1235
|
+
|
|
1236
|
+
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
1237
|
+
|
|
1238
|
+
</dd>
|
|
1239
|
+
</dl>
|
|
1240
|
+
</dd>
|
|
1241
|
+
</dl>
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
</dd>
|
|
1245
|
+
</dl>
|
|
1246
|
+
</details>
|
|
1247
|
+
|
|
1248
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">update_onboarding_state</a>(request) -> Schematic::Accounts::Types::UpdateOnboardingStateResponse</code></summary>
|
|
1249
|
+
<dl>
|
|
1250
|
+
<dd>
|
|
1251
|
+
|
|
1252
|
+
#### 🔌 Usage
|
|
1253
|
+
|
|
1254
|
+
<dl>
|
|
1255
|
+
<dd>
|
|
1256
|
+
|
|
1257
|
+
<dl>
|
|
1258
|
+
<dd>
|
|
1259
|
+
|
|
1260
|
+
```ruby
|
|
1261
|
+
client.accounts.update_onboarding_state
|
|
1262
|
+
```
|
|
1263
|
+
</dd>
|
|
1264
|
+
</dl>
|
|
1265
|
+
</dd>
|
|
1266
|
+
</dl>
|
|
1267
|
+
|
|
1268
|
+
#### ⚙️ Parameters
|
|
1269
|
+
|
|
1270
|
+
<dl>
|
|
1271
|
+
<dd>
|
|
1272
|
+
|
|
1273
|
+
<dl>
|
|
1274
|
+
<dd>
|
|
1275
|
+
|
|
1276
|
+
**path:** `Schematic::Types::OnboardingPath`
|
|
1277
|
+
|
|
1278
|
+
</dd>
|
|
1279
|
+
</dl>
|
|
1280
|
+
|
|
1281
|
+
<dl>
|
|
1282
|
+
<dd>
|
|
1283
|
+
|
|
1284
|
+
**pricing_page_url:** `String`
|
|
1285
|
+
|
|
1286
|
+
</dd>
|
|
1287
|
+
</dl>
|
|
1288
|
+
|
|
1289
|
+
<dl>
|
|
1290
|
+
<dd>
|
|
1291
|
+
|
|
1292
|
+
**track:** `Schematic::Types::OnboardingTrack`
|
|
1293
|
+
|
|
1294
|
+
</dd>
|
|
1295
|
+
</dl>
|
|
1296
|
+
|
|
1297
|
+
<dl>
|
|
1298
|
+
<dd>
|
|
1299
|
+
|
|
1300
|
+
**website_url:** `String`
|
|
1301
|
+
|
|
1302
|
+
</dd>
|
|
1303
|
+
</dl>
|
|
1304
|
+
|
|
1305
|
+
<dl>
|
|
1306
|
+
<dd>
|
|
1307
|
+
|
|
1308
|
+
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
1309
|
+
|
|
1310
|
+
</dd>
|
|
1311
|
+
</dl>
|
|
1312
|
+
</dd>
|
|
1313
|
+
</dl>
|
|
1314
|
+
|
|
1315
|
+
|
|
1204
1316
|
</dd>
|
|
1205
1317
|
</dl>
|
|
1206
1318
|
</details>
|
|
@@ -1484,7 +1596,7 @@ client.billing.upsert_billing_coupon(
|
|
|
1484
1596
|
</dl>
|
|
1485
1597
|
</details>
|
|
1486
1598
|
|
|
1487
|
-
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">delete_billing_coupon</a>(billing_id) -> Schematic::Billing::Types::DeleteBillingCouponResponse</code></summary>
|
|
1599
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">delete_billing_coupon</a>(billing_id:) -> Schematic::Billing::Types::DeleteBillingCouponResponse</code></summary>
|
|
1488
1600
|
<dl>
|
|
1489
1601
|
<dd>
|
|
1490
1602
|
|
|
@@ -1532,7 +1644,7 @@ client.billing.delete_billing_coupon(billing_id: "billing_id")
|
|
|
1532
1644
|
</dl>
|
|
1533
1645
|
</details>
|
|
1534
1646
|
|
|
1535
|
-
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">delete_billing_customer</a>(billing_id) -> Schematic::Billing::Types::DeleteBillingCustomerResponse</code></summary>
|
|
1647
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">delete_billing_customer</a>(billing_id:) -> Schematic::Billing::Types::DeleteBillingCustomerResponse</code></summary>
|
|
1536
1648
|
<dl>
|
|
1537
1649
|
<dd>
|
|
1538
1650
|
|
|
@@ -2127,7 +2239,7 @@ client.billing.upsert_invoice(
|
|
|
2127
2239
|
</dl>
|
|
2128
2240
|
</details>
|
|
2129
2241
|
|
|
2130
|
-
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">delete_billing_invoice</a>(billing_id) -> Schematic::Billing::Types::DeleteBillingInvoiceResponse</code></summary>
|
|
2242
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">delete_billing_invoice</a>(billing_id:) -> Schematic::Billing::Types::DeleteBillingInvoiceResponse</code></summary>
|
|
2131
2243
|
<dl>
|
|
2132
2244
|
<dd>
|
|
2133
2245
|
|
|
@@ -2545,7 +2657,7 @@ client.billing.upsert_payment_method(
|
|
|
2545
2657
|
</dl>
|
|
2546
2658
|
</details>
|
|
2547
2659
|
|
|
2548
|
-
<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>
|
|
2660
|
+
<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>
|
|
2549
2661
|
<dl>
|
|
2550
2662
|
<dd>
|
|
2551
2663
|
|
|
@@ -2985,7 +3097,7 @@ client.billing.upsert_billing_price(
|
|
|
2985
3097
|
</dl>
|
|
2986
3098
|
</details>
|
|
2987
3099
|
|
|
2988
|
-
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">delete_billing_product</a>(billing_id) -> Schematic::Billing::Types::DeleteBillingProductResponse</code></summary>
|
|
3100
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">delete_billing_product</a>(billing_id:) -> Schematic::Billing::Types::DeleteBillingProductResponse</code></summary>
|
|
2989
3101
|
<dl>
|
|
2990
3102
|
<dd>
|
|
2991
3103
|
|
|
@@ -3236,7 +3348,7 @@ client.billing.list_billing_product_prices(
|
|
|
3236
3348
|
</dl>
|
|
3237
3349
|
</details>
|
|
3238
3350
|
|
|
3239
|
-
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">delete_product_price</a>(billing_id) -> Schematic::Billing::Types::DeleteProductPriceResponse</code></summary>
|
|
3351
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">delete_product_price</a>(billing_id:) -> Schematic::Billing::Types::DeleteProductPriceResponse</code></summary>
|
|
3240
3352
|
<dl>
|
|
3241
3353
|
<dd>
|
|
3242
3354
|
|
|
@@ -4139,7 +4251,7 @@ client.credits.create_billing_credit(
|
|
|
4139
4251
|
</dl>
|
|
4140
4252
|
</details>
|
|
4141
4253
|
|
|
4142
|
-
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">get_single_billing_credit</a>(credit_id) -> Schematic::Credits::Types::GetSingleBillingCreditResponse</code></summary>
|
|
4254
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">get_single_billing_credit</a>(credit_id:) -> Schematic::Credits::Types::GetSingleBillingCreditResponse</code></summary>
|
|
4143
4255
|
<dl>
|
|
4144
4256
|
<dd>
|
|
4145
4257
|
|
|
@@ -4187,7 +4299,7 @@ client.credits.get_single_billing_credit(credit_id: "credit_id")
|
|
|
4187
4299
|
</dl>
|
|
4188
4300
|
</details>
|
|
4189
4301
|
|
|
4190
|
-
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">update_billing_credit</a>(credit_id
|
|
4302
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">update_billing_credit</a>(credit_id:, request) -> Schematic::Credits::Types::UpdateBillingCreditResponse</code></summary>
|
|
4191
4303
|
<dl>
|
|
4192
4304
|
<dd>
|
|
4193
4305
|
|
|
@@ -4335,7 +4447,7 @@ client.credits.update_billing_credit(
|
|
|
4335
4447
|
</dl>
|
|
4336
4448
|
</details>
|
|
4337
4449
|
|
|
4338
|
-
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">soft_delete_billing_credit</a>(credit_id) -> Schematic::Credits::Types::SoftDeleteBillingCreditResponse</code></summary>
|
|
4450
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">soft_delete_billing_credit</a>(credit_id:) -> Schematic::Credits::Types::SoftDeleteBillingCreditResponse</code></summary>
|
|
4339
4451
|
<dl>
|
|
4340
4452
|
<dd>
|
|
4341
4453
|
|
|
@@ -4575,6 +4687,14 @@ client.credits.create_credit_bundle(
|
|
|
4575
4687
|
<dl>
|
|
4576
4688
|
<dd>
|
|
4577
4689
|
|
|
4690
|
+
**compatible_plan_ids:** `Internal::Types::Array[String]` — Plans whose companies may purchase this bundle. Omitted or empty means the bundle is purchasable on every plan.
|
|
4691
|
+
|
|
4692
|
+
</dd>
|
|
4693
|
+
</dl>
|
|
4694
|
+
|
|
4695
|
+
<dl>
|
|
4696
|
+
<dd>
|
|
4697
|
+
|
|
4578
4698
|
**credit_id:** `String`
|
|
4579
4699
|
|
|
4580
4700
|
</dd>
|
|
@@ -4667,7 +4787,7 @@ client.credits.create_credit_bundle(
|
|
|
4667
4787
|
</dl>
|
|
4668
4788
|
</details>
|
|
4669
4789
|
|
|
4670
|
-
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">get_credit_bundle</a>(bundle_id) -> Schematic::Credits::Types::GetCreditBundleResponse</code></summary>
|
|
4790
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">get_credit_bundle</a>(bundle_id:) -> Schematic::Credits::Types::GetCreditBundleResponse</code></summary>
|
|
4671
4791
|
<dl>
|
|
4672
4792
|
<dd>
|
|
4673
4793
|
|
|
@@ -4715,7 +4835,7 @@ client.credits.get_credit_bundle(bundle_id: "bundle_id")
|
|
|
4715
4835
|
</dl>
|
|
4716
4836
|
</details>
|
|
4717
4837
|
|
|
4718
|
-
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">update_credit_bundle_details</a>(bundle_id
|
|
4838
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">update_credit_bundle_details</a>(bundle_id:, request) -> Schematic::Credits::Types::UpdateCreditBundleDetailsResponse</code></summary>
|
|
4719
4839
|
<dl>
|
|
4720
4840
|
<dd>
|
|
4721
4841
|
|
|
@@ -4763,6 +4883,14 @@ client.credits.update_credit_bundle_details(
|
|
|
4763
4883
|
<dl>
|
|
4764
4884
|
<dd>
|
|
4765
4885
|
|
|
4886
|
+
**compatible_plan_ids:** `Internal::Types::Array[String]` — Plans whose companies may purchase this bundle. Omitted leaves compatibility unchanged; empty resets the bundle to purchasable on every plan.
|
|
4887
|
+
|
|
4888
|
+
</dd>
|
|
4889
|
+
</dl>
|
|
4890
|
+
|
|
4891
|
+
<dl>
|
|
4892
|
+
<dd>
|
|
4893
|
+
|
|
4766
4894
|
**currency_prices:** `Internal::Types::Array[Schematic::Types::CreditBundleCurrencyPriceRequestBody]`
|
|
4767
4895
|
|
|
4768
4896
|
</dd>
|
|
@@ -4839,7 +4967,7 @@ client.credits.update_credit_bundle_details(
|
|
|
4839
4967
|
</dl>
|
|
4840
4968
|
</details>
|
|
4841
4969
|
|
|
4842
|
-
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">delete_credit_bundle</a>(bundle_id) -> Schematic::Credits::Types::DeleteCreditBundleResponse</code></summary>
|
|
4970
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">delete_credit_bundle</a>(bundle_id:) -> Schematic::Credits::Types::DeleteCreditBundleResponse</code></summary>
|
|
4843
4971
|
<dl>
|
|
4844
4972
|
<dd>
|
|
4845
4973
|
|
|
@@ -5059,7 +5187,7 @@ client.credits.count_billing_credits(
|
|
|
5059
5187
|
</dl>
|
|
5060
5188
|
</details>
|
|
5061
5189
|
|
|
5062
|
-
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">zero_out_grant</a>(grant_id
|
|
5190
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">zero_out_grant</a>(grant_id:, request) -> Schematic::Credits::Types::ZeroOutGrantResponse</code></summary>
|
|
5063
5191
|
<dl>
|
|
5064
5192
|
<dd>
|
|
5065
5193
|
|
|
@@ -5658,7 +5786,7 @@ client.credits.acquire_credit_lease(
|
|
|
5658
5786
|
</dl>
|
|
5659
5787
|
</details>
|
|
5660
5788
|
|
|
5661
|
-
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">extend_credit_lease</a>(lease_id
|
|
5789
|
+
<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>
|
|
5662
5790
|
<dl>
|
|
5663
5791
|
<dd>
|
|
5664
5792
|
|
|
@@ -5725,7 +5853,7 @@ client.credits.extend_credit_lease(
|
|
|
5725
5853
|
</dl>
|
|
5726
5854
|
</details>
|
|
5727
5855
|
|
|
5728
|
-
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">release_credit_lease</a>(lease_id
|
|
5856
|
+
<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>
|
|
5729
5857
|
<dl>
|
|
5730
5858
|
<dd>
|
|
5731
5859
|
|
|
@@ -5740,7 +5868,9 @@ client.credits.extend_credit_lease(
|
|
|
5740
5868
|
```ruby
|
|
5741
5869
|
client.credits.release_credit_lease(
|
|
5742
5870
|
lease_id: "lease_id",
|
|
5743
|
-
request: {
|
|
5871
|
+
request: {
|
|
5872
|
+
key: "value"
|
|
5873
|
+
}
|
|
5744
5874
|
)
|
|
5745
5875
|
```
|
|
5746
5876
|
</dd>
|
|
@@ -5951,7 +6081,7 @@ client.credits.create_billing_plan_credit_grant(
|
|
|
5951
6081
|
</dl>
|
|
5952
6082
|
</details>
|
|
5953
6083
|
|
|
5954
|
-
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">get_single_billing_plan_credit_grant</a>(plan_grant_id) -> Schematic::Credits::Types::GetSingleBillingPlanCreditGrantResponse</code></summary>
|
|
6084
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">get_single_billing_plan_credit_grant</a>(plan_grant_id:) -> Schematic::Credits::Types::GetSingleBillingPlanCreditGrantResponse</code></summary>
|
|
5955
6085
|
<dl>
|
|
5956
6086
|
<dd>
|
|
5957
6087
|
|
|
@@ -5999,7 +6129,7 @@ client.credits.get_single_billing_plan_credit_grant(plan_grant_id: "plan_grant_i
|
|
|
5999
6129
|
</dl>
|
|
6000
6130
|
</details>
|
|
6001
6131
|
|
|
6002
|
-
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">update_billing_plan_credit_grant</a>(plan_grant_id
|
|
6132
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">update_billing_plan_credit_grant</a>(plan_grant_id:, request) -> Schematic::Credits::Types::UpdateBillingPlanCreditGrantResponse</code></summary>
|
|
6003
6133
|
<dl>
|
|
6004
6134
|
<dd>
|
|
6005
6135
|
|
|
@@ -6059,7 +6189,7 @@ client.credits.update_billing_plan_credit_grant(
|
|
|
6059
6189
|
</dl>
|
|
6060
6190
|
</details>
|
|
6061
6191
|
|
|
6062
|
-
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">delete_billing_plan_credit_grant</a>(plan_grant_id) -> Schematic::Credits::Types::DeleteBillingPlanCreditGrantResponse</code></summary>
|
|
6192
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">delete_billing_plan_credit_grant</a>(plan_grant_id:) -> Schematic::Credits::Types::DeleteBillingPlanCreditGrantResponse</code></summary>
|
|
6063
6193
|
<dl>
|
|
6064
6194
|
<dd>
|
|
6065
6195
|
|
|
@@ -6591,7 +6721,7 @@ client.catalogs.create_catalog(name: "name")
|
|
|
6591
6721
|
</dl>
|
|
6592
6722
|
</details>
|
|
6593
6723
|
|
|
6594
|
-
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_catalog</a>(catalog_id) -> Schematic::Catalogs::Types::GetCatalogResponse</code></summary>
|
|
6724
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_catalog</a>(catalog_id:) -> Schematic::Catalogs::Types::GetCatalogResponse</code></summary>
|
|
6595
6725
|
<dl>
|
|
6596
6726
|
<dd>
|
|
6597
6727
|
|
|
@@ -6639,7 +6769,7 @@ client.catalogs.get_catalog(catalog_id: "catalog_id")
|
|
|
6639
6769
|
</dl>
|
|
6640
6770
|
</details>
|
|
6641
6771
|
|
|
6642
|
-
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">update_catalog</a>(catalog_id
|
|
6772
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">update_catalog</a>(catalog_id:, request) -> Schematic::Catalogs::Types::UpdateCatalogResponse</code></summary>
|
|
6643
6773
|
<dl>
|
|
6644
6774
|
<dd>
|
|
6645
6775
|
|
|
@@ -6711,7 +6841,7 @@ client.catalogs.update_catalog(catalog_id: "catalog_id")
|
|
|
6711
6841
|
</dl>
|
|
6712
6842
|
</details>
|
|
6713
6843
|
|
|
6714
|
-
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">delete_catalog</a>(catalog_id) -> Schematic::Catalogs::Types::DeleteCatalogResponse</code></summary>
|
|
6844
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">delete_catalog</a>(catalog_id:) -> Schematic::Catalogs::Types::DeleteCatalogResponse</code></summary>
|
|
6715
6845
|
<dl>
|
|
6716
6846
|
<dd>
|
|
6717
6847
|
|
|
@@ -6759,7 +6889,7 @@ client.catalogs.delete_catalog(catalog_id: "catalog_id")
|
|
|
6759
6889
|
</dl>
|
|
6760
6890
|
</details>
|
|
6761
6891
|
|
|
6762
|
-
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_configuration</a>(catalog_id) -> Schematic::Catalogs::Types::GetConfigurationResponse</code></summary>
|
|
6892
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_configuration</a>(catalog_id:) -> Schematic::Catalogs::Types::GetConfigurationResponse</code></summary>
|
|
6763
6893
|
<dl>
|
|
6764
6894
|
<dd>
|
|
6765
6895
|
|
|
@@ -6807,7 +6937,7 @@ client.catalogs.get_configuration(catalog_id: "catalog_id")
|
|
|
6807
6937
|
</dl>
|
|
6808
6938
|
</details>
|
|
6809
6939
|
|
|
6810
|
-
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">update_configuration</a>(catalog_id
|
|
6940
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">update_configuration</a>(catalog_id:, request) -> Schematic::Catalogs::Types::UpdateConfigurationResponse</code></summary>
|
|
6811
6941
|
<dl>
|
|
6812
6942
|
<dd>
|
|
6813
6943
|
|
|
@@ -6927,7 +7057,7 @@ client.catalogs.update_configuration(catalog_id: "catalog_id")
|
|
|
6927
7057
|
</dl>
|
|
6928
7058
|
</details>
|
|
6929
7059
|
|
|
6930
|
-
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_credit_bundles_in_catalog</a>(catalog_id) -> Schematic::Catalogs::Types::GetCreditBundlesInCatalogResponse</code></summary>
|
|
7060
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_credit_bundles_in_catalog</a>(catalog_id:) -> Schematic::Catalogs::Types::GetCreditBundlesInCatalogResponse</code></summary>
|
|
6931
7061
|
<dl>
|
|
6932
7062
|
<dd>
|
|
6933
7063
|
|
|
@@ -6975,7 +7105,7 @@ client.catalogs.get_credit_bundles_in_catalog(catalog_id: "catalog_id")
|
|
|
6975
7105
|
</dl>
|
|
6976
7106
|
</details>
|
|
6977
7107
|
|
|
6978
|
-
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">add_credit_bundle</a>(catalog_id
|
|
7108
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">add_credit_bundle</a>(catalog_id:, credit_bundle_id:) -> </code></summary>
|
|
6979
7109
|
<dl>
|
|
6980
7110
|
<dd>
|
|
6981
7111
|
|
|
@@ -7034,7 +7164,7 @@ client.catalogs.add_credit_bundle(
|
|
|
7034
7164
|
</dl>
|
|
7035
7165
|
</details>
|
|
7036
7166
|
|
|
7037
|
-
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">remove_credit_bundle</a>(catalog_id
|
|
7167
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">remove_credit_bundle</a>(catalog_id:, credit_bundle_id:) -> </code></summary>
|
|
7038
7168
|
<dl>
|
|
7039
7169
|
<dd>
|
|
7040
7170
|
|
|
@@ -7093,7 +7223,7 @@ client.catalogs.remove_credit_bundle(
|
|
|
7093
7223
|
</dl>
|
|
7094
7224
|
</details>
|
|
7095
7225
|
|
|
7096
|
-
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_derived_features</a>(catalog_id) -> Schematic::Catalogs::Types::GetDerivedFeaturesResponse</code></summary>
|
|
7226
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_derived_features</a>(catalog_id:) -> Schematic::Catalogs::Types::GetDerivedFeaturesResponse</code></summary>
|
|
7097
7227
|
<dl>
|
|
7098
7228
|
<dd>
|
|
7099
7229
|
|
|
@@ -7141,7 +7271,7 @@ client.catalogs.get_derived_features(catalog_id: "catalog_id")
|
|
|
7141
7271
|
</dl>
|
|
7142
7272
|
</details>
|
|
7143
7273
|
|
|
7144
|
-
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_plans_in_catalog</a>(catalog_id) -> Schematic::Catalogs::Types::GetPlansInCatalogResponse</code></summary>
|
|
7274
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_plans_in_catalog</a>(catalog_id:) -> Schematic::Catalogs::Types::GetPlansInCatalogResponse</code></summary>
|
|
7145
7275
|
<dl>
|
|
7146
7276
|
<dd>
|
|
7147
7277
|
|
|
@@ -7189,7 +7319,7 @@ client.catalogs.get_plans_in_catalog(catalog_id: "catalog_id")
|
|
|
7189
7319
|
</dl>
|
|
7190
7320
|
</details>
|
|
7191
7321
|
|
|
7192
|
-
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">add_plan</a>(catalog_id
|
|
7322
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">add_plan</a>(catalog_id:, plan_id:) -> </code></summary>
|
|
7193
7323
|
<dl>
|
|
7194
7324
|
<dd>
|
|
7195
7325
|
|
|
@@ -7248,7 +7378,7 @@ client.catalogs.add_plan(
|
|
|
7248
7378
|
</dl>
|
|
7249
7379
|
</details>
|
|
7250
7380
|
|
|
7251
|
-
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">remove_plan</a>(catalog_id
|
|
7381
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">remove_plan</a>(catalog_id:, plan_id:) -> </code></summary>
|
|
7252
7382
|
<dl>
|
|
7253
7383
|
<dd>
|
|
7254
7384
|
|
|
@@ -7516,7 +7646,7 @@ client.checkout.preview_checkout_internal(
|
|
|
7516
7646
|
</dl>
|
|
7517
7647
|
</details>
|
|
7518
7648
|
|
|
7519
|
-
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">get_company_billing_details</a>(company_id) -> Schematic::Checkout::Types::GetCompanyBillingDetailsResponse</code></summary>
|
|
7649
|
+
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">get_company_billing_details</a>(company_id:) -> Schematic::Checkout::Types::GetCompanyBillingDetailsResponse</code></summary>
|
|
7520
7650
|
<dl>
|
|
7521
7651
|
<dd>
|
|
7522
7652
|
|
|
@@ -7564,7 +7694,7 @@ client.checkout.get_company_billing_details(company_id: "company_id")
|
|
|
7564
7694
|
</dl>
|
|
7565
7695
|
</details>
|
|
7566
7696
|
|
|
7567
|
-
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">update_company_billing_details</a>(company_id
|
|
7697
|
+
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">update_company_billing_details</a>(company_id:, request) -> Schematic::Checkout::Types::UpdateCompanyBillingDetailsResponse</code></summary>
|
|
7568
7698
|
<dl>
|
|
7569
7699
|
<dd>
|
|
7570
7700
|
|
|
@@ -7852,7 +7982,7 @@ client.checkout.cancel_subscription(company_id: "company_id")
|
|
|
7852
7982
|
</dl>
|
|
7853
7983
|
</details>
|
|
7854
7984
|
|
|
7855
|
-
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">update_customer_subscription_trial_end</a>(subscription_id
|
|
7985
|
+
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">update_customer_subscription_trial_end</a>(subscription_id:, request) -> Schematic::Checkout::Types::UpdateCustomerSubscriptionTrialEndResponse</code></summary>
|
|
7856
7986
|
<dl>
|
|
7857
7987
|
<dd>
|
|
7858
7988
|
|
|
@@ -7931,6 +8061,7 @@ client.companies.list_companies(
|
|
|
7931
8061
|
plan_ids: ["plan_ids"],
|
|
7932
8062
|
plan_version_id: "plan_version_id",
|
|
7933
8063
|
plan_version_ids: ["plan_version_ids"],
|
|
8064
|
+
plan_version_unpublished: true,
|
|
7934
8065
|
q: "q",
|
|
7935
8066
|
sort_order_column: "sort_order_column",
|
|
7936
8067
|
sort_order_direction: "asc",
|
|
@@ -8022,6 +8153,14 @@ client.companies.list_companies(
|
|
|
8022
8153
|
<dl>
|
|
8023
8154
|
<dd>
|
|
8024
8155
|
|
|
8156
|
+
**plan_version_unpublished:** `Internal::Types::Boolean` — Filter companies assigned to a plan version that is no longer published, meaning the plan has since moved on to a newer version
|
|
8157
|
+
|
|
8158
|
+
</dd>
|
|
8159
|
+
</dl>
|
|
8160
|
+
|
|
8161
|
+
<dl>
|
|
8162
|
+
<dd>
|
|
8163
|
+
|
|
8025
8164
|
**q:** `String` — Search for companies by name, keys or string traits
|
|
8026
8165
|
|
|
8027
8166
|
</dd>
|
|
@@ -8180,7 +8319,7 @@ client.companies.upsert_company(keys: {
|
|
|
8180
8319
|
</dl>
|
|
8181
8320
|
</details>
|
|
8182
8321
|
|
|
8183
|
-
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">get_company</a>(company_id) -> Schematic::Companies::Types::GetCompanyResponse</code></summary>
|
|
8322
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">get_company</a>(company_id:) -> Schematic::Companies::Types::GetCompanyResponse</code></summary>
|
|
8184
8323
|
<dl>
|
|
8185
8324
|
<dd>
|
|
8186
8325
|
|
|
@@ -8228,7 +8367,7 @@ client.companies.get_company(company_id: "company_id")
|
|
|
8228
8367
|
</dl>
|
|
8229
8368
|
</details>
|
|
8230
8369
|
|
|
8231
|
-
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">delete_company</a>(company_id) -> Schematic::Companies::Types::DeleteCompanyResponse</code></summary>
|
|
8370
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">delete_company</a>(company_id:) -> Schematic::Companies::Types::DeleteCompanyResponse</code></summary>
|
|
8232
8371
|
<dl>
|
|
8233
8372
|
<dd>
|
|
8234
8373
|
|
|
@@ -8318,6 +8457,7 @@ client.companies.count_companies(
|
|
|
8318
8457
|
plan_ids: ["plan_ids"],
|
|
8319
8458
|
plan_version_id: "plan_version_id",
|
|
8320
8459
|
plan_version_ids: ["plan_version_ids"],
|
|
8460
|
+
plan_version_unpublished: true,
|
|
8321
8461
|
q: "q",
|
|
8322
8462
|
sort_order_column: "sort_order_column",
|
|
8323
8463
|
sort_order_direction: "asc",
|
|
@@ -8409,6 +8549,14 @@ client.companies.count_companies(
|
|
|
8409
8549
|
<dl>
|
|
8410
8550
|
<dd>
|
|
8411
8551
|
|
|
8552
|
+
**plan_version_unpublished:** `Internal::Types::Boolean` — Filter companies assigned to a plan version that is no longer published, meaning the plan has since moved on to a newer version
|
|
8553
|
+
|
|
8554
|
+
</dd>
|
|
8555
|
+
</dl>
|
|
8556
|
+
|
|
8557
|
+
<dl>
|
|
8558
|
+
<dd>
|
|
8559
|
+
|
|
8412
8560
|
**q:** `String` — Search for companies by name, keys or string traits
|
|
8413
8561
|
|
|
8414
8562
|
</dd>
|
|
@@ -8917,7 +9065,7 @@ client.companies.get_or_create_company_membership(
|
|
|
8917
9065
|
</dl>
|
|
8918
9066
|
</details>
|
|
8919
9067
|
|
|
8920
|
-
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">delete_company_membership</a>(company_membership_id) -> Schematic::Companies::Types::DeleteCompanyMembershipResponse</code></summary>
|
|
9068
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">delete_company_membership</a>(company_membership_id:) -> Schematic::Companies::Types::DeleteCompanyMembershipResponse</code></summary>
|
|
8921
9069
|
<dl>
|
|
8922
9070
|
<dd>
|
|
8923
9071
|
|
|
@@ -9181,7 +9329,7 @@ client.companies.list_entity_key_definitions(
|
|
|
9181
9329
|
</dl>
|
|
9182
9330
|
</details>
|
|
9183
9331
|
|
|
9184
|
-
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">delete_entity_key_definition</a>(entity_key_definition_id) -> Schematic::Companies::Types::DeleteEntityKeyDefinitionResponse</code></summary>
|
|
9332
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">delete_entity_key_definition</a>(entity_key_definition_id:) -> Schematic::Companies::Types::DeleteEntityKeyDefinitionResponse</code></summary>
|
|
9185
9333
|
<dl>
|
|
9186
9334
|
<dd>
|
|
9187
9335
|
|
|
@@ -9572,7 +9720,7 @@ client.companies.get_or_create_entity_trait_definition(
|
|
|
9572
9720
|
</dl>
|
|
9573
9721
|
</details>
|
|
9574
9722
|
|
|
9575
|
-
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">get_entity_trait_definition</a>(entity_trait_definition_id) -> Schematic::Companies::Types::GetEntityTraitDefinitionResponse</code></summary>
|
|
9723
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">get_entity_trait_definition</a>(entity_trait_definition_id:) -> Schematic::Companies::Types::GetEntityTraitDefinitionResponse</code></summary>
|
|
9576
9724
|
<dl>
|
|
9577
9725
|
<dd>
|
|
9578
9726
|
|
|
@@ -9620,7 +9768,7 @@ client.companies.get_entity_trait_definition(entity_trait_definition_id: "entity
|
|
|
9620
9768
|
</dl>
|
|
9621
9769
|
</details>
|
|
9622
9770
|
|
|
9623
|
-
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">update_entity_trait_definition</a>(entity_trait_definition_id
|
|
9771
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">update_entity_trait_definition</a>(entity_trait_definition_id:, request) -> Schematic::Companies::Types::UpdateEntityTraitDefinitionResponse</code></summary>
|
|
9624
9772
|
<dl>
|
|
9625
9773
|
<dd>
|
|
9626
9774
|
|
|
@@ -9683,6 +9831,102 @@ client.companies.update_entity_trait_definition(
|
|
|
9683
9831
|
</dl>
|
|
9684
9832
|
|
|
9685
9833
|
|
|
9834
|
+
</dd>
|
|
9835
|
+
</dl>
|
|
9836
|
+
</details>
|
|
9837
|
+
|
|
9838
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">delete_entity_trait_definition</a>(entity_trait_definition_id:) -> Schematic::Companies::Types::DeleteEntityTraitDefinitionResponse</code></summary>
|
|
9839
|
+
<dl>
|
|
9840
|
+
<dd>
|
|
9841
|
+
|
|
9842
|
+
#### 🔌 Usage
|
|
9843
|
+
|
|
9844
|
+
<dl>
|
|
9845
|
+
<dd>
|
|
9846
|
+
|
|
9847
|
+
<dl>
|
|
9848
|
+
<dd>
|
|
9849
|
+
|
|
9850
|
+
```ruby
|
|
9851
|
+
client.companies.delete_entity_trait_definition(entity_trait_definition_id: "entity_trait_definition_id")
|
|
9852
|
+
```
|
|
9853
|
+
</dd>
|
|
9854
|
+
</dl>
|
|
9855
|
+
</dd>
|
|
9856
|
+
</dl>
|
|
9857
|
+
|
|
9858
|
+
#### ⚙️ Parameters
|
|
9859
|
+
|
|
9860
|
+
<dl>
|
|
9861
|
+
<dd>
|
|
9862
|
+
|
|
9863
|
+
<dl>
|
|
9864
|
+
<dd>
|
|
9865
|
+
|
|
9866
|
+
**entity_trait_definition_id:** `String` — entity_trait_definition_id
|
|
9867
|
+
|
|
9868
|
+
</dd>
|
|
9869
|
+
</dl>
|
|
9870
|
+
|
|
9871
|
+
<dl>
|
|
9872
|
+
<dd>
|
|
9873
|
+
|
|
9874
|
+
**request_options:** `Schematic::Companies::RequestOptions`
|
|
9875
|
+
|
|
9876
|
+
</dd>
|
|
9877
|
+
</dl>
|
|
9878
|
+
</dd>
|
|
9879
|
+
</dl>
|
|
9880
|
+
|
|
9881
|
+
|
|
9882
|
+
</dd>
|
|
9883
|
+
</dl>
|
|
9884
|
+
</details>
|
|
9885
|
+
|
|
9886
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">get_entity_trait_definition_usage</a>(entity_trait_definition_id:) -> Schematic::Companies::Types::GetEntityTraitDefinitionUsageResponse</code></summary>
|
|
9887
|
+
<dl>
|
|
9888
|
+
<dd>
|
|
9889
|
+
|
|
9890
|
+
#### 🔌 Usage
|
|
9891
|
+
|
|
9892
|
+
<dl>
|
|
9893
|
+
<dd>
|
|
9894
|
+
|
|
9895
|
+
<dl>
|
|
9896
|
+
<dd>
|
|
9897
|
+
|
|
9898
|
+
```ruby
|
|
9899
|
+
client.companies.get_entity_trait_definition_usage(entity_trait_definition_id: "entity_trait_definition_id")
|
|
9900
|
+
```
|
|
9901
|
+
</dd>
|
|
9902
|
+
</dl>
|
|
9903
|
+
</dd>
|
|
9904
|
+
</dl>
|
|
9905
|
+
|
|
9906
|
+
#### ⚙️ Parameters
|
|
9907
|
+
|
|
9908
|
+
<dl>
|
|
9909
|
+
<dd>
|
|
9910
|
+
|
|
9911
|
+
<dl>
|
|
9912
|
+
<dd>
|
|
9913
|
+
|
|
9914
|
+
**entity_trait_definition_id:** `String` — entity_trait_definition_id
|
|
9915
|
+
|
|
9916
|
+
</dd>
|
|
9917
|
+
</dl>
|
|
9918
|
+
|
|
9919
|
+
<dl>
|
|
9920
|
+
<dd>
|
|
9921
|
+
|
|
9922
|
+
**request_options:** `Schematic::Companies::RequestOptions`
|
|
9923
|
+
|
|
9924
|
+
</dd>
|
|
9925
|
+
</dl>
|
|
9926
|
+
</dd>
|
|
9927
|
+
</dl>
|
|
9928
|
+
|
|
9929
|
+
|
|
9686
9930
|
</dd>
|
|
9687
9931
|
</dl>
|
|
9688
9932
|
</details>
|
|
@@ -9864,6 +10108,83 @@ client.companies.get_entity_trait_values(
|
|
|
9864
10108
|
</dl>
|
|
9865
10109
|
|
|
9866
10110
|
|
|
10111
|
+
</dd>
|
|
10112
|
+
</dl>
|
|
10113
|
+
</details>
|
|
10114
|
+
|
|
10115
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">count_entity_traits</a>() -> Schematic::Companies::Types::CountEntityTraitsResponse</code></summary>
|
|
10116
|
+
<dl>
|
|
10117
|
+
<dd>
|
|
10118
|
+
|
|
10119
|
+
#### 🔌 Usage
|
|
10120
|
+
|
|
10121
|
+
<dl>
|
|
10122
|
+
<dd>
|
|
10123
|
+
|
|
10124
|
+
<dl>
|
|
10125
|
+
<dd>
|
|
10126
|
+
|
|
10127
|
+
```ruby
|
|
10128
|
+
client.companies.count_entity_traits(
|
|
10129
|
+
definition_id: "definition_id",
|
|
10130
|
+
entity_type: "company",
|
|
10131
|
+
limit: 1000000,
|
|
10132
|
+
offset: 1000000
|
|
10133
|
+
)
|
|
10134
|
+
```
|
|
10135
|
+
</dd>
|
|
10136
|
+
</dl>
|
|
10137
|
+
</dd>
|
|
10138
|
+
</dl>
|
|
10139
|
+
|
|
10140
|
+
#### ⚙️ Parameters
|
|
10141
|
+
|
|
10142
|
+
<dl>
|
|
10143
|
+
<dd>
|
|
10144
|
+
|
|
10145
|
+
<dl>
|
|
10146
|
+
<dd>
|
|
10147
|
+
|
|
10148
|
+
**definition_id:** `String`
|
|
10149
|
+
|
|
10150
|
+
</dd>
|
|
10151
|
+
</dl>
|
|
10152
|
+
|
|
10153
|
+
<dl>
|
|
10154
|
+
<dd>
|
|
10155
|
+
|
|
10156
|
+
**entity_type:** `Schematic::Types::EntityType`
|
|
10157
|
+
|
|
10158
|
+
</dd>
|
|
10159
|
+
</dl>
|
|
10160
|
+
|
|
10161
|
+
<dl>
|
|
10162
|
+
<dd>
|
|
10163
|
+
|
|
10164
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
10165
|
+
|
|
10166
|
+
</dd>
|
|
10167
|
+
</dl>
|
|
10168
|
+
|
|
10169
|
+
<dl>
|
|
10170
|
+
<dd>
|
|
10171
|
+
|
|
10172
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
10173
|
+
|
|
10174
|
+
</dd>
|
|
10175
|
+
</dl>
|
|
10176
|
+
|
|
10177
|
+
<dl>
|
|
10178
|
+
<dd>
|
|
10179
|
+
|
|
10180
|
+
**request_options:** `Schematic::Companies::RequestOptions`
|
|
10181
|
+
|
|
10182
|
+
</dd>
|
|
10183
|
+
</dl>
|
|
10184
|
+
</dd>
|
|
10185
|
+
</dl>
|
|
10186
|
+
|
|
10187
|
+
|
|
9867
10188
|
</dd>
|
|
9868
10189
|
</dl>
|
|
9869
10190
|
</details>
|
|
@@ -9886,7 +10207,6 @@ client.companies.list_plan_changes(
|
|
|
9886
10207
|
base_plan_action: "fallback",
|
|
9887
10208
|
company_id: "company_id",
|
|
9888
10209
|
company_ids: ["company_ids"],
|
|
9889
|
-
plan_ids: ["plan_ids"],
|
|
9890
10210
|
limit: 1000000,
|
|
9891
10211
|
offset: 1000000
|
|
9892
10212
|
)
|
|
@@ -9936,14 +10256,6 @@ client.companies.list_plan_changes(
|
|
|
9936
10256
|
<dl>
|
|
9937
10257
|
<dd>
|
|
9938
10258
|
|
|
9939
|
-
**plan_ids:** `String`
|
|
9940
|
-
|
|
9941
|
-
</dd>
|
|
9942
|
-
</dl>
|
|
9943
|
-
|
|
9944
|
-
<dl>
|
|
9945
|
-
<dd>
|
|
9946
|
-
|
|
9947
10259
|
**limit:** `Integer` — Page limit (default 100)
|
|
9948
10260
|
|
|
9949
10261
|
</dd>
|
|
@@ -9972,7 +10284,7 @@ client.companies.list_plan_changes(
|
|
|
9972
10284
|
</dl>
|
|
9973
10285
|
</details>
|
|
9974
10286
|
|
|
9975
|
-
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">get_plan_change</a>(plan_change_id) -> Schematic::Companies::Types::GetPlanChangeResponse</code></summary>
|
|
10287
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">get_plan_change</a>(plan_change_id:) -> Schematic::Companies::Types::GetPlanChangeResponse</code></summary>
|
|
9976
10288
|
<dl>
|
|
9977
10289
|
<dd>
|
|
9978
10290
|
|
|
@@ -10115,7 +10427,7 @@ client.companies.list_plan_traits(
|
|
|
10115
10427
|
</dl>
|
|
10116
10428
|
</details>
|
|
10117
10429
|
|
|
10118
|
-
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">get_plan_trait</a>(plan_trait_id) -> Schematic::Companies::Types::GetPlanTraitResponse</code></summary>
|
|
10430
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">get_plan_trait</a>(plan_trait_id:) -> Schematic::Companies::Types::GetPlanTraitResponse</code></summary>
|
|
10119
10431
|
<dl>
|
|
10120
10432
|
<dd>
|
|
10121
10433
|
|
|
@@ -10527,7 +10839,7 @@ client.companies.upsert_user(keys: {
|
|
|
10527
10839
|
</dl>
|
|
10528
10840
|
</details>
|
|
10529
10841
|
|
|
10530
|
-
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">get_user</a>(user_id) -> Schematic::Companies::Types::GetUserResponse</code></summary>
|
|
10842
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">get_user</a>(user_id:) -> Schematic::Companies::Types::GetUserResponse</code></summary>
|
|
10531
10843
|
<dl>
|
|
10532
10844
|
<dd>
|
|
10533
10845
|
|
|
@@ -10575,7 +10887,7 @@ client.companies.get_user(user_id: "user_id")
|
|
|
10575
10887
|
</dl>
|
|
10576
10888
|
</details>
|
|
10577
10889
|
|
|
10578
|
-
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">delete_user</a>(user_id) -> Schematic::Companies::Types::DeleteUserResponse</code></summary>
|
|
10890
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">delete_user</a>(user_id:) -> Schematic::Companies::Types::DeleteUserResponse</code></summary>
|
|
10579
10891
|
<dl>
|
|
10580
10892
|
<dd>
|
|
10581
10893
|
|
|
@@ -11131,7 +11443,7 @@ client.entitlements.create_company_override(
|
|
|
11131
11443
|
</dl>
|
|
11132
11444
|
</details>
|
|
11133
11445
|
|
|
11134
|
-
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">get_company_override</a>(company_override_id) -> Schematic::Entitlements::Types::GetCompanyOverrideResponse</code></summary>
|
|
11446
|
+
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">get_company_override</a>(company_override_id:) -> Schematic::Entitlements::Types::GetCompanyOverrideResponse</code></summary>
|
|
11135
11447
|
<dl>
|
|
11136
11448
|
<dd>
|
|
11137
11449
|
|
|
@@ -11179,7 +11491,7 @@ client.entitlements.get_company_override(company_override_id: "company_override_
|
|
|
11179
11491
|
</dl>
|
|
11180
11492
|
</details>
|
|
11181
11493
|
|
|
11182
|
-
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">update_company_override</a>(company_override_id
|
|
11494
|
+
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">update_company_override</a>(company_override_id:, request) -> Schematic::Entitlements::Types::UpdateCompanyOverrideResponse</code></summary>
|
|
11183
11495
|
<dl>
|
|
11184
11496
|
<dd>
|
|
11185
11497
|
|
|
@@ -11310,7 +11622,7 @@ client.entitlements.update_company_override(
|
|
|
11310
11622
|
</dl>
|
|
11311
11623
|
</details>
|
|
11312
11624
|
|
|
11313
|
-
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">delete_company_override</a>(company_override_id) -> Schematic::Entitlements::Types::DeleteCompanyOverrideResponse</code></summary>
|
|
11625
|
+
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">delete_company_override</a>(company_override_id:) -> Schematic::Entitlements::Types::DeleteCompanyOverrideResponse</code></summary>
|
|
11314
11626
|
<dl>
|
|
11315
11627
|
<dd>
|
|
11316
11628
|
|
|
@@ -11751,6 +12063,110 @@ client.entitlements.list_feature_usage(
|
|
|
11751
12063
|
</dl>
|
|
11752
12064
|
|
|
11753
12065
|
|
|
12066
|
+
</dd>
|
|
12067
|
+
</dl>
|
|
12068
|
+
</details>
|
|
12069
|
+
|
|
12070
|
+
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">list_feature_usage_history</a>() -> Schematic::Entitlements::Types::ListFeatureUsageHistoryResponse</code></summary>
|
|
12071
|
+
<dl>
|
|
12072
|
+
<dd>
|
|
12073
|
+
|
|
12074
|
+
#### 🔌 Usage
|
|
12075
|
+
|
|
12076
|
+
<dl>
|
|
12077
|
+
<dd>
|
|
12078
|
+
|
|
12079
|
+
<dl>
|
|
12080
|
+
<dd>
|
|
12081
|
+
|
|
12082
|
+
```ruby
|
|
12083
|
+
client.entitlements.list_feature_usage_history(
|
|
12084
|
+
company_ids: ["company_ids"],
|
|
12085
|
+
end_time: "2024-01-15T09:30:00Z",
|
|
12086
|
+
feature_ids: ["feature_ids"],
|
|
12087
|
+
granularity: "daily",
|
|
12088
|
+
start_time: "2024-01-15T09:30:00Z",
|
|
12089
|
+
limit: 1000000,
|
|
12090
|
+
offset: 1000000
|
|
12091
|
+
)
|
|
12092
|
+
```
|
|
12093
|
+
</dd>
|
|
12094
|
+
</dl>
|
|
12095
|
+
</dd>
|
|
12096
|
+
</dl>
|
|
12097
|
+
|
|
12098
|
+
#### ⚙️ Parameters
|
|
12099
|
+
|
|
12100
|
+
<dl>
|
|
12101
|
+
<dd>
|
|
12102
|
+
|
|
12103
|
+
<dl>
|
|
12104
|
+
<dd>
|
|
12105
|
+
|
|
12106
|
+
**company_ids:** `String` — Restrict to these company IDs; omit for every company in the environment
|
|
12107
|
+
|
|
12108
|
+
</dd>
|
|
12109
|
+
</dl>
|
|
12110
|
+
|
|
12111
|
+
<dl>
|
|
12112
|
+
<dd>
|
|
12113
|
+
|
|
12114
|
+
**end_time:** `String` — Exclusive end of the window; must fall on an hour boundary
|
|
12115
|
+
|
|
12116
|
+
</dd>
|
|
12117
|
+
</dl>
|
|
12118
|
+
|
|
12119
|
+
<dl>
|
|
12120
|
+
<dd>
|
|
12121
|
+
|
|
12122
|
+
**feature_ids:** `String` — Restrict to these event features; omit for every event feature in the environment. Where several features measure the same event, each is reported separately and a page may carry more rows than the requested limit
|
|
12123
|
+
|
|
12124
|
+
</dd>
|
|
12125
|
+
</dl>
|
|
12126
|
+
|
|
12127
|
+
<dl>
|
|
12128
|
+
<dd>
|
|
12129
|
+
|
|
12130
|
+
**granularity:** `Schematic::Types::TimeSeriesGranularity` — Bucket the window; omit for a single total per company and feature
|
|
12131
|
+
|
|
12132
|
+
</dd>
|
|
12133
|
+
</dl>
|
|
12134
|
+
|
|
12135
|
+
<dl>
|
|
12136
|
+
<dd>
|
|
12137
|
+
|
|
12138
|
+
**start_time:** `String` — Inclusive start of the window; must fall on an hour boundary
|
|
12139
|
+
|
|
12140
|
+
</dd>
|
|
12141
|
+
</dl>
|
|
12142
|
+
|
|
12143
|
+
<dl>
|
|
12144
|
+
<dd>
|
|
12145
|
+
|
|
12146
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
12147
|
+
|
|
12148
|
+
</dd>
|
|
12149
|
+
</dl>
|
|
12150
|
+
|
|
12151
|
+
<dl>
|
|
12152
|
+
<dd>
|
|
12153
|
+
|
|
12154
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
12155
|
+
|
|
12156
|
+
</dd>
|
|
12157
|
+
</dl>
|
|
12158
|
+
|
|
12159
|
+
<dl>
|
|
12160
|
+
<dd>
|
|
12161
|
+
|
|
12162
|
+
**request_options:** `Schematic::Entitlements::RequestOptions`
|
|
12163
|
+
|
|
12164
|
+
</dd>
|
|
12165
|
+
</dl>
|
|
12166
|
+
</dd>
|
|
12167
|
+
</dl>
|
|
12168
|
+
|
|
12169
|
+
|
|
11754
12170
|
</dd>
|
|
11755
12171
|
</dl>
|
|
11756
12172
|
</details>
|
|
@@ -12572,7 +12988,7 @@ client.entitlements.create_plan_entitlement(
|
|
|
12572
12988
|
</dl>
|
|
12573
12989
|
</details>
|
|
12574
12990
|
|
|
12575
|
-
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">get_plan_entitlement</a>(plan_entitlement_id) -> Schematic::Entitlements::Types::GetPlanEntitlementResponse</code></summary>
|
|
12991
|
+
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">get_plan_entitlement</a>(plan_entitlement_id:) -> Schematic::Entitlements::Types::GetPlanEntitlementResponse</code></summary>
|
|
12576
12992
|
<dl>
|
|
12577
12993
|
<dd>
|
|
12578
12994
|
|
|
@@ -12620,7 +13036,7 @@ client.entitlements.get_plan_entitlement(plan_entitlement_id: "plan_entitlement_
|
|
|
12620
13036
|
</dl>
|
|
12621
13037
|
</details>
|
|
12622
13038
|
|
|
12623
|
-
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">update_plan_entitlement</a>(plan_entitlement_id
|
|
13039
|
+
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">update_plan_entitlement</a>(plan_entitlement_id:, request) -> Schematic::Entitlements::Types::UpdatePlanEntitlementResponse</code></summary>
|
|
12624
13040
|
<dl>
|
|
12625
13041
|
<dd>
|
|
12626
13042
|
|
|
@@ -12919,7 +13335,7 @@ client.entitlements.update_plan_entitlement(
|
|
|
12919
13335
|
</dl>
|
|
12920
13336
|
</details>
|
|
12921
13337
|
|
|
12922
|
-
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">delete_plan_entitlement</a>(plan_entitlement_id) -> Schematic::Entitlements::Types::DeletePlanEntitlementResponse</code></summary>
|
|
13338
|
+
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">delete_plan_entitlement</a>(plan_entitlement_id:) -> Schematic::Entitlements::Types::DeletePlanEntitlementResponse</code></summary>
|
|
12923
13339
|
<dl>
|
|
12924
13340
|
<dd>
|
|
12925
13341
|
|
|
@@ -13705,7 +14121,7 @@ client.entitlements.get_user_usage_detail(
|
|
|
13705
14121
|
</details>
|
|
13706
14122
|
|
|
13707
14123
|
## plans
|
|
13708
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">update_company_plans</a>(
|
|
14124
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">update_company_plans</a>(company_id:, request) -> Schematic::Plans::Types::UpdateCompanyPlansResponse</code></summary>
|
|
13709
14125
|
<dl>
|
|
13710
14126
|
<dd>
|
|
13711
14127
|
|
|
@@ -13719,7 +14135,7 @@ client.entitlements.get_user_usage_detail(
|
|
|
13719
14135
|
|
|
13720
14136
|
```ruby
|
|
13721
14137
|
client.plans.update_company_plans(
|
|
13722
|
-
|
|
14138
|
+
company_id: "company_id",
|
|
13723
14139
|
add_on_ids: ["add_on_ids"]
|
|
13724
14140
|
)
|
|
13725
14141
|
```
|
|
@@ -13736,7 +14152,7 @@ client.plans.update_company_plans(
|
|
|
13736
14152
|
<dl>
|
|
13737
14153
|
<dd>
|
|
13738
14154
|
|
|
13739
|
-
**
|
|
14155
|
+
**company_id:** `String` — company_id
|
|
13740
14156
|
|
|
13741
14157
|
</dd>
|
|
13742
14158
|
</dl>
|
|
@@ -13788,6 +14204,7 @@ client.plans.update_company_plans(
|
|
|
13788
14204
|
client.plans.list_custom_plan_billings(
|
|
13789
14205
|
company_id: "company_id",
|
|
13790
14206
|
plan_id: "plan_id",
|
|
14207
|
+
plan_billing_source: "custom_plan",
|
|
13791
14208
|
status: "active",
|
|
13792
14209
|
statuses: ["active"],
|
|
13793
14210
|
limit: 1000000,
|
|
@@ -13823,6 +14240,14 @@ client.plans.list_custom_plan_billings(
|
|
|
13823
14240
|
<dl>
|
|
13824
14241
|
<dd>
|
|
13825
14242
|
|
|
14243
|
+
**plan_billing_source:** `Schematic::Types::PlanBillingSource` — Filter by the flow that created the billing record. Defaults to custom_plan.
|
|
14244
|
+
|
|
14245
|
+
</dd>
|
|
14246
|
+
</dl>
|
|
14247
|
+
|
|
14248
|
+
<dl>
|
|
14249
|
+
<dd>
|
|
14250
|
+
|
|
13826
14251
|
**status:** `Schematic::Types::CustomPlanBillingStatus` — Filter by billing status
|
|
13827
14252
|
|
|
13828
14253
|
</dd>
|
|
@@ -13867,7 +14292,7 @@ client.plans.list_custom_plan_billings(
|
|
|
13867
14292
|
</dl>
|
|
13868
14293
|
</details>
|
|
13869
14294
|
|
|
13870
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">mark_custom_plan_billing_paid</a>(custom_plan_billing_id
|
|
14295
|
+
<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>
|
|
13871
14296
|
<dl>
|
|
13872
14297
|
<dd>
|
|
13873
14298
|
|
|
@@ -13882,7 +14307,9 @@ client.plans.list_custom_plan_billings(
|
|
|
13882
14307
|
```ruby
|
|
13883
14308
|
client.plans.mark_custom_plan_billing_paid(
|
|
13884
14309
|
custom_plan_billing_id: "custom_plan_billing_id",
|
|
13885
|
-
request: {
|
|
14310
|
+
request: {
|
|
14311
|
+
key: "value"
|
|
14312
|
+
}
|
|
13886
14313
|
)
|
|
13887
14314
|
```
|
|
13888
14315
|
</dd>
|
|
@@ -13926,7 +14353,7 @@ client.plans.mark_custom_plan_billing_paid(
|
|
|
13926
14353
|
</dl>
|
|
13927
14354
|
</details>
|
|
13928
14355
|
|
|
13929
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">retry_custom_plan_billing</a>(custom_plan_billing_id
|
|
14356
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">retry_custom_plan_billing</a>(custom_plan_billing_id:, request) -> Schematic::Plans::Types::RetryCustomPlanBillingResponse</code></summary>
|
|
13930
14357
|
<dl>
|
|
13931
14358
|
<dd>
|
|
13932
14359
|
|
|
@@ -14024,7 +14451,6 @@ client.plans.retry_custom_plan_billing(
|
|
|
14024
14451
|
```ruby
|
|
14025
14452
|
client.plans.create_custom_plan(
|
|
14026
14453
|
company_id: "company_id",
|
|
14027
|
-
description: "description",
|
|
14028
14454
|
name: "name"
|
|
14029
14455
|
)
|
|
14030
14456
|
```
|
|
@@ -14057,6 +14483,14 @@ client.plans.create_custom_plan(
|
|
|
14057
14483
|
<dl>
|
|
14058
14484
|
<dd>
|
|
14059
14485
|
|
|
14486
|
+
**copied_price_id:** `String`
|
|
14487
|
+
|
|
14488
|
+
</dd>
|
|
14489
|
+
</dl>
|
|
14490
|
+
|
|
14491
|
+
<dl>
|
|
14492
|
+
<dd>
|
|
14493
|
+
|
|
14060
14494
|
**description:** `String`
|
|
14061
14495
|
|
|
14062
14496
|
</dd>
|
|
@@ -14301,7 +14735,6 @@ client.plans.list_plans(
|
|
|
14301
14735
|
|
|
14302
14736
|
```ruby
|
|
14303
14737
|
client.plans.create_plan(
|
|
14304
|
-
description: "description",
|
|
14305
14738
|
name: "name",
|
|
14306
14739
|
plan_type: "plan"
|
|
14307
14740
|
)
|
|
@@ -14339,7 +14772,7 @@ client.plans.create_plan(
|
|
|
14339
14772
|
</dl>
|
|
14340
14773
|
</details>
|
|
14341
14774
|
|
|
14342
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">get_plan</a>(plan_id) -> Schematic::Plans::Types::GetPlanResponse</code></summary>
|
|
14775
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">get_plan</a>(plan_id:) -> Schematic::Plans::Types::GetPlanResponse</code></summary>
|
|
14343
14776
|
<dl>
|
|
14344
14777
|
<dd>
|
|
14345
14778
|
|
|
@@ -14398,7 +14831,7 @@ client.plans.get_plan(
|
|
|
14398
14831
|
</dl>
|
|
14399
14832
|
</details>
|
|
14400
14833
|
|
|
14401
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">update_plan</a>(plan_id
|
|
14834
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">update_plan</a>(plan_id:, request) -> Schematic::Plans::Types::UpdatePlanResponse</code></summary>
|
|
14402
14835
|
<dl>
|
|
14403
14836
|
<dd>
|
|
14404
14837
|
|
|
@@ -14457,7 +14890,7 @@ client.plans.update_plan(
|
|
|
14457
14890
|
</dl>
|
|
14458
14891
|
</details>
|
|
14459
14892
|
|
|
14460
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">delete_plan</a>(plan_id) -> Schematic::Plans::Types::DeletePlanResponse</code></summary>
|
|
14893
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">delete_plan</a>(plan_id:) -> Schematic::Plans::Types::DeletePlanResponse</code></summary>
|
|
14461
14894
|
<dl>
|
|
14462
14895
|
<dd>
|
|
14463
14896
|
|
|
@@ -14505,7 +14938,7 @@ client.plans.delete_plan(plan_id: "plan_id")
|
|
|
14505
14938
|
</dl>
|
|
14506
14939
|
</details>
|
|
14507
14940
|
|
|
14508
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">upsert_billing_product_plan</a>(plan_id
|
|
14941
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">upsert_billing_product_plan</a>(plan_id:, request) -> Schematic::Plans::Types::UpsertBillingProductPlanResponse</code></summary>
|
|
14509
14942
|
<dl>
|
|
14510
14943
|
<dd>
|
|
14511
14944
|
|
|
@@ -14580,7 +15013,6 @@ client.plans.upsert_billing_product_plan(
|
|
|
14580
15013
|
```ruby
|
|
14581
15014
|
client.plans.upsert_plan_for_billing_product(
|
|
14582
15015
|
billing_provider: "metronome",
|
|
14583
|
-
description: "description",
|
|
14584
15016
|
external_resource_id: "external_resource_id",
|
|
14585
15017
|
name: "name",
|
|
14586
15018
|
plan_type: "plan"
|
|
@@ -15074,7 +15506,7 @@ client.plans.list_plan_issues(
|
|
|
15074
15506
|
</dl>
|
|
15075
15507
|
</details>
|
|
15076
15508
|
|
|
15077
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">delete_plan_version</a>(
|
|
15509
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">delete_plan_version</a>(plan_version_id:) -> Schematic::Plans::Types::DeletePlanVersionResponse</code></summary>
|
|
15078
15510
|
<dl>
|
|
15079
15511
|
<dd>
|
|
15080
15512
|
|
|
@@ -15088,7 +15520,7 @@ client.plans.list_plan_issues(
|
|
|
15088
15520
|
|
|
15089
15521
|
```ruby
|
|
15090
15522
|
client.plans.delete_plan_version(
|
|
15091
|
-
|
|
15523
|
+
plan_version_id: "plan_version_id",
|
|
15092
15524
|
promote_archived_version: true
|
|
15093
15525
|
)
|
|
15094
15526
|
```
|
|
@@ -15105,7 +15537,7 @@ client.plans.delete_plan_version(
|
|
|
15105
15537
|
<dl>
|
|
15106
15538
|
<dd>
|
|
15107
15539
|
|
|
15108
|
-
**
|
|
15540
|
+
**plan_version_id:** `String` — plan_version_id
|
|
15109
15541
|
|
|
15110
15542
|
</dd>
|
|
15111
15543
|
</dl>
|
|
@@ -15133,7 +15565,7 @@ client.plans.delete_plan_version(
|
|
|
15133
15565
|
</dl>
|
|
15134
15566
|
</details>
|
|
15135
15567
|
|
|
15136
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">publish_plan_version</a>(
|
|
15568
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">publish_plan_version</a>(plan_version_id:, request) -> Schematic::Plans::Types::PublishPlanVersionResponse</code></summary>
|
|
15137
15569
|
<dl>
|
|
15138
15570
|
<dd>
|
|
15139
15571
|
|
|
@@ -15147,7 +15579,7 @@ client.plans.delete_plan_version(
|
|
|
15147
15579
|
|
|
15148
15580
|
```ruby
|
|
15149
15581
|
client.plans.publish_plan_version(
|
|
15150
|
-
|
|
15582
|
+
plan_version_id: "plan_version_id",
|
|
15151
15583
|
excluded_company_ids: ["excluded_company_ids"],
|
|
15152
15584
|
migration_strategy: "immediate"
|
|
15153
15585
|
)
|
|
@@ -15165,7 +15597,7 @@ client.plans.publish_plan_version(
|
|
|
15165
15597
|
<dl>
|
|
15166
15598
|
<dd>
|
|
15167
15599
|
|
|
15168
|
-
**
|
|
15600
|
+
**plan_version_id:** `String` — plan_version_id
|
|
15169
15601
|
|
|
15170
15602
|
</dd>
|
|
15171
15603
|
</dl>
|
|
@@ -15245,6 +15677,22 @@ client.plans.publish_plan_version(
|
|
|
15245
15677
|
<dl>
|
|
15246
15678
|
<dd>
|
|
15247
15679
|
|
|
15680
|
+
**proration_behavior:** `Schematic::Types::MigrationProrationBehavior`
|
|
15681
|
+
|
|
15682
|
+
</dd>
|
|
15683
|
+
</dl>
|
|
15684
|
+
|
|
15685
|
+
<dl>
|
|
15686
|
+
<dd>
|
|
15687
|
+
|
|
15688
|
+
**require_no_migration:** `Internal::Types::Boolean` — Refuse the publish if any company would be migrated onto the new version
|
|
15689
|
+
|
|
15690
|
+
</dd>
|
|
15691
|
+
</dl>
|
|
15692
|
+
|
|
15693
|
+
<dl>
|
|
15694
|
+
<dd>
|
|
15695
|
+
|
|
15248
15696
|
**send_invoice:** `Internal::Types::Boolean` — Whether Stripe emails the invoice when it is finalized. Defaults to true.
|
|
15249
15697
|
|
|
15250
15698
|
</dd>
|
|
@@ -15409,7 +15857,7 @@ client.components.create_component(
|
|
|
15409
15857
|
</dl>
|
|
15410
15858
|
</details>
|
|
15411
15859
|
|
|
15412
|
-
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">get_component</a>(component_id) -> Schematic::Components::Types::GetComponentResponse</code></summary>
|
|
15860
|
+
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">get_component</a>(component_id:) -> Schematic::Components::Types::GetComponentResponse</code></summary>
|
|
15413
15861
|
<dl>
|
|
15414
15862
|
<dd>
|
|
15415
15863
|
|
|
@@ -15457,7 +15905,7 @@ client.components.get_component(component_id: "component_id")
|
|
|
15457
15905
|
</dl>
|
|
15458
15906
|
</details>
|
|
15459
15907
|
|
|
15460
|
-
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">update_component</a>(component_id
|
|
15908
|
+
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">update_component</a>(component_id:, request) -> Schematic::Components::Types::UpdateComponentResponse</code></summary>
|
|
15461
15909
|
<dl>
|
|
15462
15910
|
<dd>
|
|
15463
15911
|
|
|
@@ -15537,7 +15985,7 @@ client.components.update_component(component_id: "component_id")
|
|
|
15537
15985
|
</dl>
|
|
15538
15986
|
</details>
|
|
15539
15987
|
|
|
15540
|
-
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">delete_component</a>(component_id) -> Schematic::Components::Types::DeleteComponentResponse</code></summary>
|
|
15988
|
+
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">delete_component</a>(component_id:) -> Schematic::Components::Types::DeleteComponentResponse</code></summary>
|
|
15541
15989
|
<dl>
|
|
15542
15990
|
<dd>
|
|
15543
15991
|
|
|
@@ -15585,7 +16033,7 @@ client.components.delete_component(component_id: "component_id")
|
|
|
15585
16033
|
</dl>
|
|
15586
16034
|
</details>
|
|
15587
16035
|
|
|
15588
|
-
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">bind_catalog</a>(component_id
|
|
16036
|
+
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">bind_catalog</a>(component_id:, request) -> Schematic::Components::Types::BindCatalogResponse</code></summary>
|
|
15589
16037
|
<dl>
|
|
15590
16038
|
<dd>
|
|
15591
16039
|
|
|
@@ -15782,9 +16230,19 @@ client.components.preview_component_data(
|
|
|
15782
16230
|
<dd>
|
|
15783
16231
|
|
|
15784
16232
|
```ruby
|
|
15785
|
-
client.planbundle.create_custom_plan_bundle(
|
|
15786
|
-
|
|
15787
|
-
|
|
16233
|
+
client.planbundle.create_custom_plan_bundle(
|
|
16234
|
+
billing_product: {
|
|
16235
|
+
charge_type: "free",
|
|
16236
|
+
is_trialable: true
|
|
16237
|
+
},
|
|
16238
|
+
entitlements: [{
|
|
16239
|
+
action: "create"
|
|
16240
|
+
}],
|
|
16241
|
+
plan: {
|
|
16242
|
+
company_id: "company_id",
|
|
16243
|
+
name: "name"
|
|
16244
|
+
}
|
|
16245
|
+
)
|
|
15788
16246
|
```
|
|
15789
16247
|
</dd>
|
|
15790
16248
|
</dl>
|
|
@@ -15856,9 +16314,15 @@ client.planbundle.create_custom_plan_bundle(entitlements: [{
|
|
|
15856
16314
|
<dd>
|
|
15857
16315
|
|
|
15858
16316
|
```ruby
|
|
15859
|
-
client.planbundle.create_plan_bundle(
|
|
15860
|
-
|
|
15861
|
-
|
|
16317
|
+
client.planbundle.create_plan_bundle(
|
|
16318
|
+
entitlements: [{
|
|
16319
|
+
action: "create"
|
|
16320
|
+
}],
|
|
16321
|
+
plan: {
|
|
16322
|
+
name: "name",
|
|
16323
|
+
plan_type: "plan"
|
|
16324
|
+
}
|
|
16325
|
+
)
|
|
15862
16326
|
```
|
|
15863
16327
|
</dd>
|
|
15864
16328
|
</dl>
|
|
@@ -15917,7 +16381,7 @@ client.planbundle.create_plan_bundle(entitlements: [{
|
|
|
15917
16381
|
</dl>
|
|
15918
16382
|
</details>
|
|
15919
16383
|
|
|
15920
|
-
<details><summary><code>client.planbundle.<a href="/lib/schematic/planbundle/client.rb">update_plan_bundle</a>(
|
|
16384
|
+
<details><summary><code>client.planbundle.<a href="/lib/schematic/planbundle/client.rb">update_plan_bundle</a>(plan_id:, request) -> Schematic::Planbundle::Types::UpdatePlanBundleResponse</code></summary>
|
|
15921
16385
|
<dl>
|
|
15922
16386
|
<dd>
|
|
15923
16387
|
|
|
@@ -15931,10 +16395,13 @@ client.planbundle.create_plan_bundle(entitlements: [{
|
|
|
15931
16395
|
|
|
15932
16396
|
```ruby
|
|
15933
16397
|
client.planbundle.update_plan_bundle(
|
|
15934
|
-
|
|
16398
|
+
plan_id: "plan_id",
|
|
15935
16399
|
entitlements: [{
|
|
15936
16400
|
action: "create"
|
|
15937
|
-
}]
|
|
16401
|
+
}],
|
|
16402
|
+
plan: {
|
|
16403
|
+
name: "name"
|
|
16404
|
+
}
|
|
15938
16405
|
)
|
|
15939
16406
|
```
|
|
15940
16407
|
</dd>
|
|
@@ -15950,7 +16417,7 @@ client.planbundle.update_plan_bundle(
|
|
|
15950
16417
|
<dl>
|
|
15951
16418
|
<dd>
|
|
15952
16419
|
|
|
15953
|
-
**
|
|
16420
|
+
**plan_id:** `String` — plan_id
|
|
15954
16421
|
|
|
15955
16422
|
</dd>
|
|
15956
16423
|
</dl>
|
|
@@ -16155,7 +16622,7 @@ client.dataexports.create_data_export(
|
|
|
16155
16622
|
</dl>
|
|
16156
16623
|
</details>
|
|
16157
16624
|
|
|
16158
|
-
<details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">get_data_export</a>(data_export_id) -> Schematic::Dataexports::Types::GetDataExportResponse</code></summary>
|
|
16625
|
+
<details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">get_data_export</a>(data_export_id:) -> Schematic::Dataexports::Types::GetDataExportResponse</code></summary>
|
|
16159
16626
|
<dl>
|
|
16160
16627
|
<dd>
|
|
16161
16628
|
|
|
@@ -16203,7 +16670,7 @@ client.dataexports.get_data_export(data_export_id: "data_export_id")
|
|
|
16203
16670
|
</dl>
|
|
16204
16671
|
</details>
|
|
16205
16672
|
|
|
16206
|
-
<details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">get_data_export_artifact</a>(data_export_id) -> String</code></summary>
|
|
16673
|
+
<details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">get_data_export_artifact</a>(data_export_id:) -> String</code></summary>
|
|
16207
16674
|
<dl>
|
|
16208
16675
|
<dd>
|
|
16209
16676
|
|
|
@@ -16540,7 +17007,7 @@ client.events.create_event(event_type: "flag_check")
|
|
|
16540
17007
|
</dl>
|
|
16541
17008
|
</details>
|
|
16542
17009
|
|
|
16543
|
-
<details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">get_event</a>(event_id) -> Schematic::Events::Types::GetEventResponse</code></summary>
|
|
17010
|
+
<details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">get_event</a>(event_id:) -> Schematic::Events::Types::GetEventResponse</code></summary>
|
|
16544
17011
|
<dl>
|
|
16545
17012
|
<dd>
|
|
16546
17013
|
|
|
@@ -16892,7 +17359,7 @@ client.features.create_feature(
|
|
|
16892
17359
|
</dl>
|
|
16893
17360
|
</details>
|
|
16894
17361
|
|
|
16895
|
-
<details><summary><code>client.features.<a href="/lib/schematic/features/client.rb">get_feature</a>(feature_id) -> Schematic::Features::Types::GetFeatureResponse</code></summary>
|
|
17362
|
+
<details><summary><code>client.features.<a href="/lib/schematic/features/client.rb">get_feature</a>(feature_id:) -> Schematic::Features::Types::GetFeatureResponse</code></summary>
|
|
16896
17363
|
<dl>
|
|
16897
17364
|
<dd>
|
|
16898
17365
|
|
|
@@ -16940,7 +17407,7 @@ client.features.get_feature(feature_id: "feature_id")
|
|
|
16940
17407
|
</dl>
|
|
16941
17408
|
</details>
|
|
16942
17409
|
|
|
16943
|
-
<details><summary><code>client.features.<a href="/lib/schematic/features/client.rb">update_feature</a>(feature_id
|
|
17410
|
+
<details><summary><code>client.features.<a href="/lib/schematic/features/client.rb">update_feature</a>(feature_id:, request) -> Schematic::Features::Types::UpdateFeatureResponse</code></summary>
|
|
16944
17411
|
<dl>
|
|
16945
17412
|
<dd>
|
|
16946
17413
|
|
|
@@ -17076,7 +17543,7 @@ client.features.update_feature(feature_id: "feature_id")
|
|
|
17076
17543
|
</dl>
|
|
17077
17544
|
</details>
|
|
17078
17545
|
|
|
17079
|
-
<details><summary><code>client.features.<a href="/lib/schematic/features/client.rb">delete_feature</a>(feature_id) -> Schematic::Features::Types::DeleteFeatureResponse</code></summary>
|
|
17546
|
+
<details><summary><code>client.features.<a href="/lib/schematic/features/client.rb">delete_feature</a>(feature_id:) -> Schematic::Features::Types::DeleteFeatureResponse</code></summary>
|
|
17080
17547
|
<dl>
|
|
17081
17548
|
<dd>
|
|
17082
17549
|
|
|
@@ -17545,7 +18012,7 @@ client.features.create_flag(
|
|
|
17545
18012
|
</dl>
|
|
17546
18013
|
</details>
|
|
17547
18014
|
|
|
17548
|
-
<details><summary><code>client.features.<a href="/lib/schematic/features/client.rb">get_flag</a>(flag_id) -> Schematic::Features::Types::GetFlagResponse</code></summary>
|
|
18015
|
+
<details><summary><code>client.features.<a href="/lib/schematic/features/client.rb">get_flag</a>(flag_id:) -> Schematic::Features::Types::GetFlagResponse</code></summary>
|
|
17549
18016
|
<dl>
|
|
17550
18017
|
<dd>
|
|
17551
18018
|
|
|
@@ -17593,7 +18060,7 @@ client.features.get_flag(flag_id: "flag_id")
|
|
|
17593
18060
|
</dl>
|
|
17594
18061
|
</details>
|
|
17595
18062
|
|
|
17596
|
-
<details><summary><code>client.features.<a href="/lib/schematic/features/client.rb">update_flag</a>(flag_id
|
|
18063
|
+
<details><summary><code>client.features.<a href="/lib/schematic/features/client.rb">update_flag</a>(flag_id:, request) -> Schematic::Features::Types::UpdateFlagResponse</code></summary>
|
|
17597
18064
|
<dl>
|
|
17598
18065
|
<dd>
|
|
17599
18066
|
|
|
@@ -17656,7 +18123,7 @@ client.features.update_flag(
|
|
|
17656
18123
|
</dl>
|
|
17657
18124
|
</details>
|
|
17658
18125
|
|
|
17659
|
-
<details><summary><code>client.features.<a href="/lib/schematic/features/client.rb">delete_flag</a>(flag_id) -> Schematic::Features::Types::DeleteFlagResponse</code></summary>
|
|
18126
|
+
<details><summary><code>client.features.<a href="/lib/schematic/features/client.rb">delete_flag</a>(flag_id:) -> Schematic::Features::Types::DeleteFlagResponse</code></summary>
|
|
17660
18127
|
<dl>
|
|
17661
18128
|
<dd>
|
|
17662
18129
|
|
|
@@ -17704,7 +18171,7 @@ client.features.delete_flag(flag_id: "flag_id")
|
|
|
17704
18171
|
</dl>
|
|
17705
18172
|
</details>
|
|
17706
18173
|
|
|
17707
|
-
<details><summary><code>client.features.<a href="/lib/schematic/features/client.rb">update_flag_rules</a>(flag_id
|
|
18174
|
+
<details><summary><code>client.features.<a href="/lib/schematic/features/client.rb">update_flag_rules</a>(flag_id:, request) -> Schematic::Features::Types::UpdateFlagRulesResponse</code></summary>
|
|
17708
18175
|
<dl>
|
|
17709
18176
|
<dd>
|
|
17710
18177
|
|
|
@@ -17779,7 +18246,7 @@ client.features.update_flag_rules(
|
|
|
17779
18246
|
</dl>
|
|
17780
18247
|
</details>
|
|
17781
18248
|
|
|
17782
|
-
<details><summary><code>client.features.<a href="/lib/schematic/features/client.rb">check_flag</a>(key
|
|
18249
|
+
<details><summary><code>client.features.<a href="/lib/schematic/features/client.rb">check_flag</a>(key:, request) -> Schematic::Features::Types::CheckFlagResponse</code></summary>
|
|
17783
18250
|
<dl>
|
|
17784
18251
|
<dd>
|
|
17785
18252
|
|
|
@@ -18377,7 +18844,7 @@ client.insights.get_environment_trait_usage_time_series(
|
|
|
18377
18844
|
</details>
|
|
18378
18845
|
|
|
18379
18846
|
## integrationsapi
|
|
18380
|
-
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">run_integration</a>(integration_id) -> Schematic::Integrationsapi::Types::RunIntegrationResponse</code></summary>
|
|
18847
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">run_integration</a>(integration_id:) -> Schematic::Integrationsapi::Types::RunIntegrationResponse</code></summary>
|
|
18381
18848
|
<dl>
|
|
18382
18849
|
<dd>
|
|
18383
18850
|
|
|
@@ -18529,7 +18996,7 @@ client.integrationsapi.list_integrations(
|
|
|
18529
18996
|
</dl>
|
|
18530
18997
|
</details>
|
|
18531
18998
|
|
|
18532
|
-
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">get_integration_webhook_url</a>(type) -> Schematic::Integrationsapi::Types::GetIntegrationWebhookUrlResponse</code></summary>
|
|
18999
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">get_integration_webhook_url</a>(type:) -> Schematic::Integrationsapi::Types::GetIntegrationWebhookUrlResponse</code></summary>
|
|
18533
19000
|
<dl>
|
|
18534
19001
|
<dd>
|
|
18535
19002
|
|
|
@@ -18825,7 +19292,7 @@ client.integrationsapi.install_stripe(type: "clerk")
|
|
|
18825
19292
|
</dl>
|
|
18826
19293
|
</details>
|
|
18827
19294
|
|
|
18828
|
-
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">uninstall_integration</a>(integration_id) -> Schematic::Integrationsapi::Types::UninstallIntegrationResponse</code></summary>
|
|
19295
|
+
<details><summary><code>client.integrationsapi.<a href="/lib/schematic/integrationsapi/client.rb">uninstall_integration</a>(integration_id:) -> Schematic::Integrationsapi::Types::UninstallIntegrationResponse</code></summary>
|
|
18829
19296
|
<dl>
|
|
18830
19297
|
<dd>
|
|
18831
19298
|
|
|
@@ -18960,7 +19427,7 @@ client.licenses.list_licenses(
|
|
|
18960
19427
|
</dl>
|
|
18961
19428
|
</details>
|
|
18962
19429
|
|
|
18963
|
-
<details><summary><code>client.licenses.<a href="/lib/schematic/licenses/client.rb">get_single_license</a>(license_id) -> Schematic::Licenses::Types::GetSingleLicenseResponse</code></summary>
|
|
19430
|
+
<details><summary><code>client.licenses.<a href="/lib/schematic/licenses/client.rb">get_single_license</a>(license_id:) -> Schematic::Licenses::Types::GetSingleLicenseResponse</code></summary>
|
|
18964
19431
|
<dl>
|
|
18965
19432
|
<dd>
|
|
18966
19433
|
|
|
@@ -19161,6 +19628,7 @@ client.plangroups.create_plan_group(
|
|
|
19161
19628
|
checkout_collect_address: true,
|
|
19162
19629
|
checkout_collect_email: true,
|
|
19163
19630
|
checkout_collect_phone: true,
|
|
19631
|
+
checkout_collect_tax_id: true,
|
|
19164
19632
|
enable_tax_collection: true,
|
|
19165
19633
|
opt_in_enabled: true,
|
|
19166
19634
|
ordered_add_ons: [{
|
|
@@ -19213,6 +19681,14 @@ client.plangroups.create_plan_group(
|
|
|
19213
19681
|
<dl>
|
|
19214
19682
|
<dd>
|
|
19215
19683
|
|
|
19684
|
+
**checkout_bundle_purchase_behavior:** `Schematic::Types::CheckoutBundlePurchaseBehavior`
|
|
19685
|
+
|
|
19686
|
+
</dd>
|
|
19687
|
+
</dl>
|
|
19688
|
+
|
|
19689
|
+
<dl>
|
|
19690
|
+
<dd>
|
|
19691
|
+
|
|
19216
19692
|
**checkout_collect_address:** `Internal::Types::Boolean`
|
|
19217
19693
|
|
|
19218
19694
|
</dd>
|
|
@@ -19237,6 +19713,14 @@ client.plangroups.create_plan_group(
|
|
|
19237
19713
|
<dl>
|
|
19238
19714
|
<dd>
|
|
19239
19715
|
|
|
19716
|
+
**checkout_collect_tax_id:** `Internal::Types::Boolean`
|
|
19717
|
+
|
|
19718
|
+
</dd>
|
|
19719
|
+
</dl>
|
|
19720
|
+
|
|
19721
|
+
<dl>
|
|
19722
|
+
<dd>
|
|
19723
|
+
|
|
19240
19724
|
**custom_checkout_fields:** `Internal::Types::Array[Schematic::Types::CheckoutFieldInput]`
|
|
19241
19725
|
|
|
19242
19726
|
</dd>
|
|
@@ -19497,7 +19981,7 @@ client.plangroups.create_plan_group(
|
|
|
19497
19981
|
</dl>
|
|
19498
19982
|
</details>
|
|
19499
19983
|
|
|
19500
|
-
<details><summary><code>client.plangroups.<a href="/lib/schematic/plangroups/client.rb">update_plan_group</a>(plan_group_id
|
|
19984
|
+
<details><summary><code>client.plangroups.<a href="/lib/schematic/plangroups/client.rb">update_plan_group</a>(plan_group_id:, request) -> Schematic::Plangroups::Types::UpdatePlanGroupResponse</code></summary>
|
|
19501
19985
|
<dl>
|
|
19502
19986
|
<dd>
|
|
19503
19987
|
|
|
@@ -19516,6 +20000,7 @@ client.plangroups.update_plan_group(
|
|
|
19516
20000
|
checkout_collect_address: true,
|
|
19517
20001
|
checkout_collect_email: true,
|
|
19518
20002
|
checkout_collect_phone: true,
|
|
20003
|
+
checkout_collect_tax_id: true,
|
|
19519
20004
|
enable_tax_collection: true,
|
|
19520
20005
|
opt_in_enabled: true,
|
|
19521
20006
|
ordered_add_ons: [{
|
|
@@ -19576,6 +20061,14 @@ client.plangroups.update_plan_group(
|
|
|
19576
20061
|
<dl>
|
|
19577
20062
|
<dd>
|
|
19578
20063
|
|
|
20064
|
+
**checkout_bundle_purchase_behavior:** `Schematic::Types::CheckoutBundlePurchaseBehavior`
|
|
20065
|
+
|
|
20066
|
+
</dd>
|
|
20067
|
+
</dl>
|
|
20068
|
+
|
|
20069
|
+
<dl>
|
|
20070
|
+
<dd>
|
|
20071
|
+
|
|
19579
20072
|
**checkout_collect_address:** `Internal::Types::Boolean`
|
|
19580
20073
|
|
|
19581
20074
|
</dd>
|
|
@@ -19600,6 +20093,14 @@ client.plangroups.update_plan_group(
|
|
|
19600
20093
|
<dl>
|
|
19601
20094
|
<dd>
|
|
19602
20095
|
|
|
20096
|
+
**checkout_collect_tax_id:** `Internal::Types::Boolean`
|
|
20097
|
+
|
|
20098
|
+
</dd>
|
|
20099
|
+
</dl>
|
|
20100
|
+
|
|
20101
|
+
<dl>
|
|
20102
|
+
<dd>
|
|
20103
|
+
|
|
19603
20104
|
**custom_checkout_fields:** `Internal::Types::Array[Schematic::Types::CheckoutFieldInput]`
|
|
19604
20105
|
|
|
19605
20106
|
</dd>
|
|
@@ -19947,7 +20448,7 @@ client.planmigrations.list_company_migrations(
|
|
|
19947
20448
|
</dl>
|
|
19948
20449
|
</details>
|
|
19949
20450
|
|
|
19950
|
-
<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>
|
|
20451
|
+
<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>
|
|
19951
20452
|
<dl>
|
|
19952
20453
|
<dd>
|
|
19953
20454
|
|
|
@@ -20172,11 +20673,8 @@ client.planmigrations.list_migrations(
|
|
|
20172
20673
|
|
|
20173
20674
|
```ruby
|
|
20174
20675
|
client.planmigrations.create_migration(
|
|
20175
|
-
company_ids: ["company_ids"],
|
|
20176
|
-
excluded_company_ids: ["excluded_company_ids"],
|
|
20177
20676
|
plan_id: "plan_id",
|
|
20178
20677
|
plan_version_id_to: "plan_version_id_to",
|
|
20179
|
-
plan_version_ids_from: ["plan_version_ids_from"],
|
|
20180
20678
|
strategy: "immediate",
|
|
20181
20679
|
target_plan_type: "plan"
|
|
20182
20680
|
)
|
|
@@ -20234,6 +20732,14 @@ client.planmigrations.create_migration(
|
|
|
20234
20732
|
<dl>
|
|
20235
20733
|
<dd>
|
|
20236
20734
|
|
|
20735
|
+
**proration_behavior:** `Schematic::Types::MigrationProrationBehavior`
|
|
20736
|
+
|
|
20737
|
+
</dd>
|
|
20738
|
+
</dl>
|
|
20739
|
+
|
|
20740
|
+
<dl>
|
|
20741
|
+
<dd>
|
|
20742
|
+
|
|
20237
20743
|
**strategy:** `Schematic::Types::PlanVersionMigrationStrategy`
|
|
20238
20744
|
|
|
20239
20745
|
</dd>
|
|
@@ -20262,7 +20768,7 @@ client.planmigrations.create_migration(
|
|
|
20262
20768
|
</dl>
|
|
20263
20769
|
</details>
|
|
20264
20770
|
|
|
20265
|
-
<details><summary><code>client.planmigrations.<a href="/lib/schematic/planmigrations/client.rb">get_migration</a>(plan_version_migration_id) -> Schematic::Planmigrations::Types::GetMigrationResponse</code></summary>
|
|
20771
|
+
<details><summary><code>client.planmigrations.<a href="/lib/schematic/planmigrations/client.rb">get_migration</a>(plan_version_migration_id:) -> Schematic::Planmigrations::Types::GetMigrationResponse</code></summary>
|
|
20266
20772
|
<dl>
|
|
20267
20773
|
<dd>
|
|
20268
20774
|
|
|
@@ -20310,7 +20816,7 @@ client.planmigrations.get_migration(plan_version_migration_id: "plan_version_mig
|
|
|
20310
20816
|
</dl>
|
|
20311
20817
|
</details>
|
|
20312
20818
|
|
|
20313
|
-
<details><summary><code>client.planmigrations.<a href="/lib/schematic/planmigrations/client.rb">retry_migration</a>(plan_version_migration_id
|
|
20819
|
+
<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>
|
|
20314
20820
|
<dl>
|
|
20315
20821
|
<dd>
|
|
20316
20822
|
|
|
@@ -20460,7 +20966,6 @@ client.planmigrations.count_migrations(
|
|
|
20460
20966
|
|
|
20461
20967
|
```ruby
|
|
20462
20968
|
client.planmigrations.preview_migration(
|
|
20463
|
-
company_ids: ["company_ids"],
|
|
20464
20969
|
plan_id: "plan_id",
|
|
20465
20970
|
plan_version_id_to: "plan_version_id_to",
|
|
20466
20971
|
target_plan_type: "plan"
|
|
@@ -20503,6 +21008,14 @@ client.planmigrations.preview_migration(
|
|
|
20503
21008
|
<dl>
|
|
20504
21009
|
<dd>
|
|
20505
21010
|
|
|
21011
|
+
**plan_version_ids_from:** `Internal::Types::Array[String]`
|
|
21012
|
+
|
|
21013
|
+
</dd>
|
|
21014
|
+
</dl>
|
|
21015
|
+
|
|
21016
|
+
<dl>
|
|
21017
|
+
<dd>
|
|
21018
|
+
|
|
20506
21019
|
**target_plan_type:** `Schematic::Types::PlanType`
|
|
20507
21020
|
|
|
20508
21021
|
</dd>
|
|
@@ -20719,7 +21232,7 @@ client.scheduledcheckout.create_scheduled_checkout(
|
|
|
20719
21232
|
</dl>
|
|
20720
21233
|
</details>
|
|
20721
21234
|
|
|
20722
|
-
<details><summary><code>client.scheduledcheckout.<a href="/lib/schematic/scheduledcheckout/client.rb">get_scheduled_checkout</a>(scheduled_checkout_id) -> Schematic::Scheduledcheckout::Types::GetScheduledCheckoutResponse</code></summary>
|
|
21235
|
+
<details><summary><code>client.scheduledcheckout.<a href="/lib/schematic/scheduledcheckout/client.rb">get_scheduled_checkout</a>(scheduled_checkout_id:) -> Schematic::Scheduledcheckout::Types::GetScheduledCheckoutResponse</code></summary>
|
|
20723
21236
|
<dl>
|
|
20724
21237
|
<dd>
|
|
20725
21238
|
|
|
@@ -20767,7 +21280,7 @@ client.scheduledcheckout.get_scheduled_checkout(scheduled_checkout_id: "schedule
|
|
|
20767
21280
|
</dl>
|
|
20768
21281
|
</details>
|
|
20769
21282
|
|
|
20770
|
-
<details><summary><code>client.scheduledcheckout.<a href="/lib/schematic/scheduledcheckout/client.rb">update_scheduled_checkout</a>(scheduled_checkout_id
|
|
21283
|
+
<details><summary><code>client.scheduledcheckout.<a href="/lib/schematic/scheduledcheckout/client.rb">update_scheduled_checkout</a>(scheduled_checkout_id:, request) -> Schematic::Scheduledcheckout::Types::UpdateScheduledCheckoutResponse</code></summary>
|
|
20771
21284
|
<dl>
|
|
20772
21285
|
<dd>
|
|
20773
21286
|
|
|
@@ -20980,7 +21493,7 @@ client.webhooks.list_webhook_events(
|
|
|
20980
21493
|
</dl>
|
|
20981
21494
|
</details>
|
|
20982
21495
|
|
|
20983
|
-
<details><summary><code>client.webhooks.<a href="/lib/schematic/webhooks/client.rb">get_webhook_event</a>(webhook_event_id) -> Schematic::Webhooks::Types::GetWebhookEventResponse</code></summary>
|
|
21496
|
+
<details><summary><code>client.webhooks.<a href="/lib/schematic/webhooks/client.rb">get_webhook_event</a>(webhook_event_id:) -> Schematic::Webhooks::Types::GetWebhookEventResponse</code></summary>
|
|
20984
21497
|
<dl>
|
|
20985
21498
|
<dd>
|
|
20986
21499
|
|
|
@@ -21266,7 +21779,7 @@ client.webhooks.create_webhook(
|
|
|
21266
21779
|
</dl>
|
|
21267
21780
|
</details>
|
|
21268
21781
|
|
|
21269
|
-
<details><summary><code>client.webhooks.<a href="/lib/schematic/webhooks/client.rb">get_webhook</a>(webhook_id) -> Schematic::Webhooks::Types::GetWebhookResponse</code></summary>
|
|
21782
|
+
<details><summary><code>client.webhooks.<a href="/lib/schematic/webhooks/client.rb">get_webhook</a>(webhook_id:) -> Schematic::Webhooks::Types::GetWebhookResponse</code></summary>
|
|
21270
21783
|
<dl>
|
|
21271
21784
|
<dd>
|
|
21272
21785
|
|
|
@@ -21314,7 +21827,7 @@ client.webhooks.get_webhook(webhook_id: "webhook_id")
|
|
|
21314
21827
|
</dl>
|
|
21315
21828
|
</details>
|
|
21316
21829
|
|
|
21317
|
-
<details><summary><code>client.webhooks.<a href="/lib/schematic/webhooks/client.rb">update_webhook</a>(webhook_id
|
|
21830
|
+
<details><summary><code>client.webhooks.<a href="/lib/schematic/webhooks/client.rb">update_webhook</a>(webhook_id:, request) -> Schematic::Webhooks::Types::UpdateWebhookResponse</code></summary>
|
|
21318
21831
|
<dl>
|
|
21319
21832
|
<dd>
|
|
21320
21833
|
|
|
@@ -21410,7 +21923,7 @@ client.webhooks.update_webhook(webhook_id: "webhook_id")
|
|
|
21410
21923
|
</dl>
|
|
21411
21924
|
</details>
|
|
21412
21925
|
|
|
21413
|
-
<details><summary><code>client.webhooks.<a href="/lib/schematic/webhooks/client.rb">delete_webhook</a>(webhook_id) -> Schematic::Webhooks::Types::DeleteWebhookResponse</code></summary>
|
|
21926
|
+
<details><summary><code>client.webhooks.<a href="/lib/schematic/webhooks/client.rb">delete_webhook</a>(webhook_id:) -> Schematic::Webhooks::Types::DeleteWebhookResponse</code></summary>
|
|
21414
21927
|
<dl>
|
|
21415
21928
|
<dd>
|
|
21416
21929
|
|
|
@@ -21458,7 +21971,7 @@ client.webhooks.delete_webhook(webhook_id: "webhook_id")
|
|
|
21458
21971
|
</dl>
|
|
21459
21972
|
</details>
|
|
21460
21973
|
|
|
21461
|
-
<details><summary><code>client.webhooks.<a href="/lib/schematic/webhooks/client.rb">send_test_webhook_action</a>(webhook_id
|
|
21974
|
+
<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>
|
|
21462
21975
|
<dl>
|
|
21463
21976
|
<dd>
|
|
21464
21977
|
|