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
|
@@ -21,21 +21,32 @@ module Schematic
|
|
|
21
21
|
# @param max_retries [Integer] The number of times to retry a failed request, defaults to 2.
|
|
22
22
|
# @param timeout [Float] The timeout for the request, defaults to 60.0 seconds.
|
|
23
23
|
# @param headers [Hash] The headers for the request.
|
|
24
|
-
|
|
24
|
+
# @param overridable_headers [Array<String>] The names of the client-level headers a request
|
|
25
|
+
# may replace via `additional_headers`. Holds the API's global headers; SDK metadata and
|
|
26
|
+
# auth headers are absent from it and so stay protected.
|
|
27
|
+
# @param auth_provider [Object, nil] An optional auth provider responding to
|
|
28
|
+
# `auth_headers`. When present its headers are resolved on every request so
|
|
29
|
+
# token-based schemes (e.g. OAuth) can refresh an expired token mid-session.
|
|
30
|
+
def initialize(base_url:, max_retries: 2, timeout: 60.0, headers: {}, overridable_headers: [], auth_provider: nil)
|
|
25
31
|
@base_url = base_url
|
|
26
32
|
@max_retries = max_retries
|
|
27
33
|
@timeout = timeout
|
|
34
|
+
@auth_provider = auth_provider
|
|
28
35
|
@default_headers = {
|
|
29
36
|
"X-Fern-Language": "Ruby",
|
|
30
37
|
"X-Fern-SDK-Name": "schematic",
|
|
31
38
|
"X-Fern-SDK-Version": "0.0.1"
|
|
32
39
|
}.merge(headers)
|
|
40
|
+
@overridable_headers = overridable_headers.to_set { |name| name.to_s.downcase }
|
|
33
41
|
end
|
|
34
42
|
|
|
35
43
|
# @param request [Schematic::Internal::Http::BaseRequest] The HTTP request.
|
|
36
44
|
# @return [HTTP::Response] The HTTP response.
|
|
37
45
|
def send(request)
|
|
38
46
|
url = build_url(request)
|
|
47
|
+
# Resolve auth headers once per request (not per retry) so token-based
|
|
48
|
+
# providers refresh at most once here; static providers are cheap.
|
|
49
|
+
auth_headers = resolve_auth_headers
|
|
39
50
|
attempt = 0
|
|
40
51
|
response = nil
|
|
41
52
|
|
|
@@ -43,8 +54,9 @@ module Schematic
|
|
|
43
54
|
http_request = build_http_request(
|
|
44
55
|
url:,
|
|
45
56
|
method: request.method,
|
|
46
|
-
headers: request.encode_headers(protected_keys:
|
|
47
|
-
body: request.encode_body
|
|
57
|
+
headers: request.encode_headers(protected_keys: protected_header_keys + auth_headers.keys),
|
|
58
|
+
body: request.encode_body,
|
|
59
|
+
auth_headers: auth_headers
|
|
48
60
|
)
|
|
49
61
|
|
|
50
62
|
conn = connect(url)
|
|
@@ -65,6 +77,15 @@ module Schematic
|
|
|
65
77
|
response
|
|
66
78
|
end
|
|
67
79
|
|
|
80
|
+
# The client-level header names that `additional_headers` must not replace: every default
|
|
81
|
+
# header except the API's global headers, which are overridable per request.
|
|
82
|
+
# @return [Array<Symbol, String>] The protected header names.
|
|
83
|
+
def protected_header_keys
|
|
84
|
+
return @default_headers.keys if @overridable_headers.empty?
|
|
85
|
+
|
|
86
|
+
@default_headers.keys.reject { |name| @overridable_headers.include?(name.to_s.downcase) }
|
|
87
|
+
end
|
|
88
|
+
|
|
68
89
|
# Determines if a request should be retried based on the response status code.
|
|
69
90
|
# @param response [Net::HTTPResponse] The HTTP response.
|
|
70
91
|
# @param attempt [Integer] The current retry attempt (0-indexed).
|
|
@@ -152,16 +173,32 @@ module Schematic
|
|
|
152
173
|
return if url.scheme != "http"
|
|
153
174
|
return if LOCALHOST_HOSTS.include?(url.host)
|
|
154
175
|
|
|
155
|
-
raise ArgumentError,
|
|
156
|
-
|
|
176
|
+
raise ArgumentError,
|
|
177
|
+
"Refusing to send request to non-HTTPS URL: #{url}. " \
|
|
178
|
+
"HTTP is only allowed for localhost. Use HTTPS or pass a localhost URL."
|
|
179
|
+
end
|
|
180
|
+
|
|
181
|
+
# Resolves the auth headers to send with the next request. Delegates to the
|
|
182
|
+
# configured auth provider (if any) on every call so that token-based
|
|
183
|
+
# providers (e.g. OAuth client-credentials) can refresh an expired token
|
|
184
|
+
# before the request is sent. Returns an empty hash when no provider is set,
|
|
185
|
+
# which keeps the api-key / basic / bearer / no-auth paths unchanged.
|
|
186
|
+
# @return [Hash] The auth headers for the current request.
|
|
187
|
+
def resolve_auth_headers
|
|
188
|
+
return {} if @auth_provider.nil?
|
|
189
|
+
|
|
190
|
+
@auth_provider.auth_headers
|
|
157
191
|
end
|
|
158
192
|
|
|
159
193
|
# @param url [URI::Generic] The url to the resource.
|
|
160
194
|
# @param method [String] The HTTP method to use.
|
|
161
195
|
# @param headers [Hash] The headers for the request.
|
|
162
196
|
# @param body [String, nil] The body for the request.
|
|
197
|
+
# @param auth_headers [Hash] The auth headers resolved for this request. These
|
|
198
|
+
# take precedence over the static default headers but not over per-request
|
|
199
|
+
# headers, mirroring the previous baked-header precedence.
|
|
163
200
|
# @return [HTTP::Request] The HTTP request.
|
|
164
|
-
def build_http_request(url:, method:, headers: {}, body: nil)
|
|
201
|
+
def build_http_request(url:, method:, headers: {}, body: nil, auth_headers: {})
|
|
165
202
|
request = Net::HTTPGenericRequest.new(
|
|
166
203
|
method,
|
|
167
204
|
!body.nil?,
|
|
@@ -169,13 +206,27 @@ module Schematic
|
|
|
169
206
|
url
|
|
170
207
|
)
|
|
171
208
|
|
|
172
|
-
request_headers = @default_headers.merge(headers)
|
|
209
|
+
request_headers = @default_headers.merge(auth_headers).merge(headers)
|
|
173
210
|
request_headers.each { |name, value| request[name] = value }
|
|
174
211
|
request.body = body if body
|
|
175
212
|
|
|
213
|
+
# Net::HTTP disables its transparent gzip/deflate decoding as soon as an
|
|
214
|
+
# Accept-Encoding header is set explicitly on the request. Re-enable it so
|
|
215
|
+
# that compressed response bodies are still inflated.
|
|
216
|
+
request.extend(DecodeContent) if request_headers.keys.any? { |name| name.to_s.casecmp("accept-encoding").zero? }
|
|
217
|
+
|
|
176
218
|
request
|
|
177
219
|
end
|
|
178
220
|
|
|
221
|
+
# Keeps Net::HTTP's transparent gzip/deflate response decoding enabled
|
|
222
|
+
# even when an Accept-Encoding header is set explicitly on the request.
|
|
223
|
+
# @api private
|
|
224
|
+
module DecodeContent
|
|
225
|
+
def decode_content # rubocop:disable Naming/PredicateMethod
|
|
226
|
+
true
|
|
227
|
+
end
|
|
228
|
+
end
|
|
229
|
+
|
|
179
230
|
# @param query [Hash] The query for the request.
|
|
180
231
|
# @return [String, nil] The encoded query.
|
|
181
232
|
def encode_query(query)
|
|
@@ -5,17 +5,23 @@ module Schematic
|
|
|
5
5
|
class CursorPageIterator
|
|
6
6
|
include Enumerable
|
|
7
7
|
|
|
8
|
+
# The raw HTTP response from the most recent page response.
|
|
9
|
+
# @return [Net::HTTPResponse, nil]
|
|
10
|
+
attr_reader :http_response
|
|
11
|
+
|
|
8
12
|
# Instantiates a CursorPageIterator, an Enumerable class which wraps calls to a cursor-based paginated API and yields pages of items.
|
|
9
13
|
#
|
|
10
14
|
# @param initial_cursor [String] The initial cursor to use when iterating, if any.
|
|
11
15
|
# @param cursor_field [Symbol] The name of the field in API responses to extract the next cursor from.
|
|
12
16
|
# @param block [Proc] A block which is responsible for receiving a cursor to use and returning the given page from the API.
|
|
17
|
+
# The block should return a two-element array: [parsed_page, raw_http_response].
|
|
13
18
|
# @return [Schematic::Internal::CursorPageIterator]
|
|
14
19
|
def initialize(initial_cursor:, cursor_field:, &block)
|
|
15
20
|
@need_initial_load = initial_cursor.nil?
|
|
16
21
|
@cursor = initial_cursor
|
|
17
22
|
@cursor_field = cursor_field
|
|
18
23
|
@get_next_page = block
|
|
24
|
+
@http_response = nil
|
|
19
25
|
end
|
|
20
26
|
|
|
21
27
|
# Iterates over each page returned by the API.
|
|
@@ -37,12 +43,18 @@ module Schematic
|
|
|
37
43
|
|
|
38
44
|
# Retrieves the next page from the API.
|
|
39
45
|
#
|
|
40
|
-
# @return [
|
|
46
|
+
# @return [Object, nil]
|
|
41
47
|
def next_page
|
|
42
48
|
return if !@need_initial_load && @cursor.nil?
|
|
43
49
|
|
|
44
50
|
@need_initial_load = false
|
|
45
|
-
|
|
51
|
+
result = @get_next_page.call(@cursor)
|
|
52
|
+
if result.is_a?(Array)
|
|
53
|
+
fetched_page, raw_response = result
|
|
54
|
+
@http_response = raw_response
|
|
55
|
+
else
|
|
56
|
+
fetched_page = result
|
|
57
|
+
end
|
|
46
58
|
@cursor = fetched_page.send(@cursor_field)
|
|
47
59
|
fetched_page
|
|
48
60
|
end
|
|
@@ -5,6 +5,12 @@ module Schematic
|
|
|
5
5
|
class ItemIterator
|
|
6
6
|
include Enumerable
|
|
7
7
|
|
|
8
|
+
# The raw HTTP response from the most recent page response.
|
|
9
|
+
# @return [Net::HTTPResponse, nil]
|
|
10
|
+
def http_response
|
|
11
|
+
@page_iterator&.http_response
|
|
12
|
+
end
|
|
13
|
+
|
|
8
14
|
# Iterates over each item returned by the API.
|
|
9
15
|
#
|
|
10
16
|
# @param block [Proc] The block which each retrieved item is yielded to.
|
|
@@ -5,6 +5,10 @@ module Schematic
|
|
|
5
5
|
class OffsetPageIterator
|
|
6
6
|
include Enumerable
|
|
7
7
|
|
|
8
|
+
# The raw HTTP response from the most recent page response.
|
|
9
|
+
# @return [Net::HTTPResponse, nil]
|
|
10
|
+
attr_reader :http_response
|
|
11
|
+
|
|
8
12
|
# Instantiates an OffsetPageIterator, an Enumerable class which wraps calls to an offset-based paginated API and yields pages of items from it.
|
|
9
13
|
#
|
|
10
14
|
# @param initial_page [Integer] The initial page to use when iterating, if any.
|
|
@@ -12,6 +16,7 @@ module Schematic
|
|
|
12
16
|
# @param has_next_field [Symbol] The field to pull the boolean of whether a next page exists from, if any.
|
|
13
17
|
# @param step [Boolean] If true, treats the page number as a true offset (i.e. increments the page number by the number of items returned from each call rather than just 1)
|
|
14
18
|
# @param block [Proc] A block which is responsible for receiving a page number to use and returning the given page from the API.
|
|
19
|
+
# The block should return a two-element array: [parsed_page, raw_http_response].
|
|
15
20
|
# @return [Schematic::Internal::OffsetPageIterator]
|
|
16
21
|
def initialize(initial_page:, item_field:, has_next_field:, step:, &block)
|
|
17
22
|
@page_number = initial_page || (step ? 0 : 1)
|
|
@@ -24,6 +29,8 @@ module Schematic
|
|
|
24
29
|
@next_page = nil
|
|
25
30
|
# ...or the actual next page, preloaded, if it doesn't.
|
|
26
31
|
@has_next_page = nil
|
|
32
|
+
|
|
33
|
+
@http_response = nil
|
|
27
34
|
end
|
|
28
35
|
|
|
29
36
|
# Iterates over each page returned by the API.
|
|
@@ -43,7 +50,7 @@ module Schematic
|
|
|
43
50
|
return @has_next_page unless @has_next_page.nil?
|
|
44
51
|
return true if @next_page
|
|
45
52
|
|
|
46
|
-
fetched_page =
|
|
53
|
+
fetched_page = fetch_page(@page_number)
|
|
47
54
|
fetched_page_items = fetched_page&.send(@item_field)
|
|
48
55
|
if fetched_page_items.nil? || fetched_page_items.empty?
|
|
49
56
|
@has_next_page = false
|
|
@@ -61,7 +68,7 @@ module Schematic
|
|
|
61
68
|
this_page = @next_page
|
|
62
69
|
@next_page = nil
|
|
63
70
|
else
|
|
64
|
-
this_page =
|
|
71
|
+
this_page = fetch_page(@page_number)
|
|
65
72
|
end
|
|
66
73
|
|
|
67
74
|
@has_next_page = this_page&.send(@has_next_field) if @has_next_field
|
|
@@ -78,6 +85,19 @@ module Schematic
|
|
|
78
85
|
|
|
79
86
|
this_page
|
|
80
87
|
end
|
|
88
|
+
|
|
89
|
+
private
|
|
90
|
+
|
|
91
|
+
def fetch_page(page_number)
|
|
92
|
+
result = @get_next_page.call(page_number)
|
|
93
|
+
if result.is_a?(Array)
|
|
94
|
+
fetched_page, raw_response = result
|
|
95
|
+
@http_response = raw_response
|
|
96
|
+
fetched_page
|
|
97
|
+
else
|
|
98
|
+
result
|
|
99
|
+
end
|
|
100
|
+
end
|
|
81
101
|
end
|
|
82
102
|
end
|
|
83
103
|
end
|
|
@@ -76,8 +76,8 @@ module Schematic
|
|
|
76
76
|
in Module
|
|
77
77
|
case type
|
|
78
78
|
in ->(t) {
|
|
79
|
-
t.singleton_class.include?(Enum) ||
|
|
80
|
-
t.singleton_class.include?(Union)
|
|
79
|
+
t.singleton_class.included_modules.include?(Enum) ||
|
|
80
|
+
t.singleton_class.included_modules.include?(Union)
|
|
81
81
|
}
|
|
82
82
|
return type.coerce(value, strict: strict)
|
|
83
83
|
else
|
|
@@ -23,17 +23,24 @@ module Schematic
|
|
|
23
23
|
# @option params [Integer, nil] :limit
|
|
24
24
|
# @option params [Integer, nil] :offset
|
|
25
25
|
#
|
|
26
|
+
# @example
|
|
27
|
+
# client.licenses.list_licenses(
|
|
28
|
+
# feature_ids: ["feature_ids"],
|
|
29
|
+
# ids: ["ids"],
|
|
30
|
+
# name: "name",
|
|
31
|
+
# limit: 1000000,
|
|
32
|
+
# offset: 1000000
|
|
33
|
+
# )
|
|
34
|
+
#
|
|
26
35
|
# @return [Schematic::Licenses::Types::ListLicensesResponse]
|
|
27
36
|
def list_licenses(request_options: {}, **params)
|
|
28
37
|
params = Schematic::Internal::Types::Utils.normalize_keys(params)
|
|
29
|
-
query_param_names = %i[feature_ids ids name limit offset]
|
|
30
38
|
query_params = {}
|
|
31
39
|
query_params["feature_ids"] = params[:feature_ids] if params.key?(:feature_ids)
|
|
32
40
|
query_params["ids"] = params[:ids] if params.key?(:ids)
|
|
33
41
|
query_params["name"] = params[:name] if params.key?(:name)
|
|
34
42
|
query_params["limit"] = params[:limit] if params.key?(:limit)
|
|
35
43
|
query_params["offset"] = params[:offset] if params.key?(:offset)
|
|
36
|
-
params.except(*query_param_names)
|
|
37
44
|
|
|
38
45
|
request = Schematic::Internal::JSON::Request.new(
|
|
39
46
|
base_url: request_options[:base_url],
|
|
@@ -65,6 +72,9 @@ module Schematic
|
|
|
65
72
|
# @option request_options [Integer] :timeout_in_seconds
|
|
66
73
|
# @option params [String] :license_id
|
|
67
74
|
#
|
|
75
|
+
# @example
|
|
76
|
+
# client.licenses.get_single_license(license_id: "license_id")
|
|
77
|
+
#
|
|
68
78
|
# @return [Schematic::Licenses::Types::GetSingleLicenseResponse]
|
|
69
79
|
def get_single_license(request_options: {}, **params)
|
|
70
80
|
params = Schematic::Internal::Types::Utils.normalize_keys(params)
|
|
@@ -101,17 +111,24 @@ module Schematic
|
|
|
101
111
|
# @option params [Integer, nil] :limit
|
|
102
112
|
# @option params [Integer, nil] :offset
|
|
103
113
|
#
|
|
114
|
+
# @example
|
|
115
|
+
# client.licenses.count_licenses(
|
|
116
|
+
# feature_ids: ["feature_ids"],
|
|
117
|
+
# ids: ["ids"],
|
|
118
|
+
# name: "name",
|
|
119
|
+
# limit: 1000000,
|
|
120
|
+
# offset: 1000000
|
|
121
|
+
# )
|
|
122
|
+
#
|
|
104
123
|
# @return [Schematic::Licenses::Types::CountLicensesResponse]
|
|
105
124
|
def count_licenses(request_options: {}, **params)
|
|
106
125
|
params = Schematic::Internal::Types::Utils.normalize_keys(params)
|
|
107
|
-
query_param_names = %i[feature_ids ids name limit offset]
|
|
108
126
|
query_params = {}
|
|
109
127
|
query_params["feature_ids"] = params[:feature_ids] if params.key?(:feature_ids)
|
|
110
128
|
query_params["ids"] = params[:ids] if params.key?(:ids)
|
|
111
129
|
query_params["name"] = params[:name] if params.key?(:name)
|
|
112
130
|
query_params["limit"] = params[:limit] if params.key?(:limit)
|
|
113
131
|
query_params["offset"] = params[:offset] if params.key?(:offset)
|
|
114
|
-
params.except(*query_param_names)
|
|
115
132
|
|
|
116
133
|
request = Schematic::Internal::JSON::Request.new(
|
|
117
134
|
base_url: request_options[:base_url],
|
|
@@ -6,9 +6,13 @@ module Schematic
|
|
|
6
6
|
# Input parameters
|
|
7
7
|
class CountLicensesParams < Internal::Types::Model
|
|
8
8
|
field :feature_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
|
|
9
|
+
|
|
9
10
|
field :ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
|
|
11
|
+
|
|
10
12
|
field :limit, -> { Integer }, optional: true, nullable: false
|
|
13
|
+
|
|
11
14
|
field :name, -> { String }, optional: true, nullable: false
|
|
15
|
+
|
|
12
16
|
field :offset, -> { Integer }, optional: true, nullable: false
|
|
13
17
|
end
|
|
14
18
|
end
|
|
@@ -5,9 +5,13 @@ module Schematic
|
|
|
5
5
|
module Types
|
|
6
6
|
class CountLicensesRequest < Internal::Types::Model
|
|
7
7
|
field :feature_ids, -> { String }, optional: true, nullable: false
|
|
8
|
+
|
|
8
9
|
field :ids, -> { String }, optional: true, nullable: false
|
|
10
|
+
|
|
9
11
|
field :name, -> { String }, optional: true, nullable: false
|
|
12
|
+
|
|
10
13
|
field :limit, -> { Integer }, optional: true, nullable: false
|
|
14
|
+
|
|
11
15
|
field :offset, -> { Integer }, optional: true, nullable: false
|
|
12
16
|
end
|
|
13
17
|
end
|
|
@@ -5,6 +5,7 @@ module Schematic
|
|
|
5
5
|
module Types
|
|
6
6
|
class CountLicensesResponse < Internal::Types::Model
|
|
7
7
|
field :data, -> { Schematic::Types::CountResponse }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :params, -> { Schematic::Licenses::Types::CountLicensesParams }, optional: false, nullable: false
|
|
9
10
|
end
|
|
10
11
|
end
|
|
@@ -5,6 +5,7 @@ module Schematic
|
|
|
5
5
|
module Types
|
|
6
6
|
class GetSingleLicenseResponse < Internal::Types::Model
|
|
7
7
|
field :data, -> { Schematic::Types::LicenseResponseData }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
|
|
9
10
|
end
|
|
10
11
|
end
|
|
@@ -6,9 +6,13 @@ module Schematic
|
|
|
6
6
|
# Input parameters
|
|
7
7
|
class ListLicensesParams < Internal::Types::Model
|
|
8
8
|
field :feature_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
|
|
9
|
+
|
|
9
10
|
field :ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
|
|
11
|
+
|
|
10
12
|
field :limit, -> { Integer }, optional: true, nullable: false
|
|
13
|
+
|
|
11
14
|
field :name, -> { String }, optional: true, nullable: false
|
|
15
|
+
|
|
12
16
|
field :offset, -> { Integer }, optional: true, nullable: false
|
|
13
17
|
end
|
|
14
18
|
end
|
|
@@ -5,9 +5,13 @@ module Schematic
|
|
|
5
5
|
module Types
|
|
6
6
|
class ListLicensesRequest < Internal::Types::Model
|
|
7
7
|
field :feature_ids, -> { String }, optional: true, nullable: false
|
|
8
|
+
|
|
8
9
|
field :ids, -> { String }, optional: true, nullable: false
|
|
10
|
+
|
|
9
11
|
field :name, -> { String }, optional: true, nullable: false
|
|
12
|
+
|
|
10
13
|
field :limit, -> { Integer }, optional: true, nullable: false
|
|
14
|
+
|
|
11
15
|
field :offset, -> { Integer }, optional: true, nullable: false
|
|
12
16
|
end
|
|
13
17
|
end
|
|
@@ -5,6 +5,7 @@ module Schematic
|
|
|
5
5
|
module Types
|
|
6
6
|
class ListLicensesResponse < Internal::Types::Model
|
|
7
7
|
field :data, -> { Internal::Types::Array[Schematic::Types::LicenseResponseData] }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :params, -> { Schematic::Licenses::Types::ListLicensesParams }, optional: false, nullable: false
|
|
9
10
|
end
|
|
10
11
|
end
|
|
@@ -18,6 +18,21 @@ module Schematic
|
|
|
18
18
|
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
19
19
|
# @option request_options [Integer] :timeout_in_seconds
|
|
20
20
|
#
|
|
21
|
+
# @example
|
|
22
|
+
# client.planbundle.create_custom_plan_bundle(
|
|
23
|
+
# billing_product: {
|
|
24
|
+
# charge_type: "free",
|
|
25
|
+
# is_trialable: true
|
|
26
|
+
# },
|
|
27
|
+
# entitlements: [{
|
|
28
|
+
# action: "create"
|
|
29
|
+
# }],
|
|
30
|
+
# plan: {
|
|
31
|
+
# company_id: "company_id",
|
|
32
|
+
# name: "name"
|
|
33
|
+
# }
|
|
34
|
+
# )
|
|
35
|
+
#
|
|
21
36
|
# @return [Schematic::Planbundle::Types::CreateCustomPlanBundleResponse]
|
|
22
37
|
def create_custom_plan_bundle(request_options: {}, **params)
|
|
23
38
|
params = Schematic::Internal::Types::Utils.normalize_keys(params)
|
|
@@ -50,6 +65,17 @@ module Schematic
|
|
|
50
65
|
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
51
66
|
# @option request_options [Integer] :timeout_in_seconds
|
|
52
67
|
#
|
|
68
|
+
# @example
|
|
69
|
+
# client.planbundle.create_plan_bundle(
|
|
70
|
+
# entitlements: [{
|
|
71
|
+
# action: "create"
|
|
72
|
+
# }],
|
|
73
|
+
# plan: {
|
|
74
|
+
# name: "name",
|
|
75
|
+
# plan_type: "plan"
|
|
76
|
+
# }
|
|
77
|
+
# )
|
|
78
|
+
#
|
|
53
79
|
# @return [Schematic::Planbundle::Types::CreatePlanBundleResponse]
|
|
54
80
|
def create_plan_bundle(request_options: {}, **params)
|
|
55
81
|
params = Schematic::Internal::Types::Utils.normalize_keys(params)
|
|
@@ -81,19 +107,30 @@ module Schematic
|
|
|
81
107
|
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
82
108
|
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
83
109
|
# @option request_options [Integer] :timeout_in_seconds
|
|
84
|
-
# @option params [String] :
|
|
110
|
+
# @option params [String] :plan_id
|
|
111
|
+
#
|
|
112
|
+
# @example
|
|
113
|
+
# client.planbundle.update_plan_bundle(
|
|
114
|
+
# plan_id: "plan_id",
|
|
115
|
+
# entitlements: [{
|
|
116
|
+
# action: "create"
|
|
117
|
+
# }],
|
|
118
|
+
# plan: {
|
|
119
|
+
# name: "name"
|
|
120
|
+
# }
|
|
121
|
+
# )
|
|
85
122
|
#
|
|
86
123
|
# @return [Schematic::Planbundle::Types::UpdatePlanBundleResponse]
|
|
87
124
|
def update_plan_bundle(request_options: {}, **params)
|
|
88
125
|
params = Schematic::Internal::Types::Utils.normalize_keys(params)
|
|
89
126
|
request_data = Schematic::Planbundle::Types::UpdatePlanBundleRequestBody.new(params).to_h
|
|
90
|
-
non_body_param_names = [
|
|
127
|
+
non_body_param_names = %w[plan_id]
|
|
91
128
|
body = request_data.except(*non_body_param_names)
|
|
92
129
|
|
|
93
130
|
request = Schematic::Internal::JSON::Request.new(
|
|
94
131
|
base_url: request_options[:base_url],
|
|
95
132
|
method: "PUT",
|
|
96
|
-
path: "plan-bundles/#{URI.encode_uri_component(params[:
|
|
133
|
+
path: "plan-bundles/#{URI.encode_uri_component(params[:plan_id].to_s)}",
|
|
97
134
|
body: body,
|
|
98
135
|
request_options: request_options
|
|
99
136
|
)
|
|
@@ -4,10 +4,13 @@ module Schematic
|
|
|
4
4
|
module Planbundle
|
|
5
5
|
module Types
|
|
6
6
|
class CreateCustomPlanBundleRequestBody < Internal::Types::Model
|
|
7
|
-
field :billing_product, -> { Schematic::Types::UpsertBillingProductRequestBody }, optional:
|
|
7
|
+
field :billing_product, -> { Schematic::Types::UpsertBillingProductRequestBody }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :credit_grants, -> { Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody] }, optional: true, nullable: false
|
|
10
|
+
|
|
9
11
|
field :entitlements, -> { Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody] }, optional: false, nullable: false
|
|
10
|
-
|
|
12
|
+
|
|
13
|
+
field :plan, -> { Schematic::Types::CreateCustomPlanBundlePlanRequestBody }, optional: false, nullable: false
|
|
11
14
|
end
|
|
12
15
|
end
|
|
13
16
|
end
|
|
@@ -5,6 +5,7 @@ module Schematic
|
|
|
5
5
|
module Types
|
|
6
6
|
class CreateCustomPlanBundleResponse < Internal::Types::Model
|
|
7
7
|
field :data, -> { Schematic::Types::PlanBundleResponseData }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
|
|
9
10
|
end
|
|
10
11
|
end
|
|
@@ -5,9 +5,12 @@ module Schematic
|
|
|
5
5
|
module Types
|
|
6
6
|
class CreatePlanBundleRequestBody < Internal::Types::Model
|
|
7
7
|
field :billing_product, -> { Schematic::Types::UpsertBillingProductRequestBody }, optional: true, nullable: false
|
|
8
|
+
|
|
8
9
|
field :credit_grants, -> { Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody] }, optional: true, nullable: false
|
|
10
|
+
|
|
9
11
|
field :entitlements, -> { Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody] }, optional: false, nullable: false
|
|
10
|
-
|
|
12
|
+
|
|
13
|
+
field :plan, -> { Schematic::Types::CreatePlanRequestBody }, optional: false, nullable: false
|
|
11
14
|
end
|
|
12
15
|
end
|
|
13
16
|
end
|
|
@@ -5,6 +5,7 @@ module Schematic
|
|
|
5
5
|
module Types
|
|
6
6
|
class CreatePlanBundleResponse < Internal::Types::Model
|
|
7
7
|
field :data, -> { Schematic::Types::PlanBundleResponseData }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
|
|
9
10
|
end
|
|
10
11
|
end
|
|
@@ -4,11 +4,16 @@ module Schematic
|
|
|
4
4
|
module Planbundle
|
|
5
5
|
module Types
|
|
6
6
|
class UpdatePlanBundleRequestBody < Internal::Types::Model
|
|
7
|
-
field :
|
|
7
|
+
field :plan_id, -> { String }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :billing_product, -> { Schematic::Types::UpsertBillingProductRequestBody }, optional: true, nullable: false
|
|
10
|
+
|
|
9
11
|
field :credit_grants, -> { Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody] }, optional: true, nullable: false
|
|
12
|
+
|
|
10
13
|
field :entitlements, -> { Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody] }, optional: false, nullable: false
|
|
11
|
-
|
|
14
|
+
|
|
15
|
+
field :plan, -> { Schematic::Types::UpdatePlanRequestBody }, optional: false, nullable: false
|
|
16
|
+
|
|
12
17
|
field :plan_version_id, -> { String }, optional: true, nullable: false
|
|
13
18
|
end
|
|
14
19
|
end
|
|
@@ -5,6 +5,7 @@ module Schematic
|
|
|
5
5
|
module Types
|
|
6
6
|
class UpdatePlanBundleResponse < Internal::Types::Model
|
|
7
7
|
field :data, -> { Schematic::Types::PlanBundleResponseData }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
|
|
9
10
|
end
|
|
10
11
|
end
|
|
@@ -19,13 +19,14 @@ module Schematic
|
|
|
19
19
|
# @option request_options [Integer] :timeout_in_seconds
|
|
20
20
|
# @option params [Boolean, nil] :include_company_counts
|
|
21
21
|
#
|
|
22
|
+
# @example
|
|
23
|
+
# client.plangroups.get_plan_group(include_company_counts: true)
|
|
24
|
+
#
|
|
22
25
|
# @return [Schematic::Plangroups::Types::GetPlanGroupResponse]
|
|
23
26
|
def get_plan_group(request_options: {}, **params)
|
|
24
27
|
params = Schematic::Internal::Types::Utils.normalize_keys(params)
|
|
25
|
-
query_param_names = %i[include_company_counts]
|
|
26
28
|
query_params = {}
|
|
27
29
|
query_params["include_company_counts"] = params[:include_company_counts] if params.key?(:include_company_counts)
|
|
28
|
-
params.except(*query_param_names)
|
|
29
30
|
|
|
30
31
|
request = Schematic::Internal::JSON::Request.new(
|
|
31
32
|
base_url: request_options[:base_url],
|
|
@@ -56,6 +57,36 @@ module Schematic
|
|
|
56
57
|
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
57
58
|
# @option request_options [Integer] :timeout_in_seconds
|
|
58
59
|
#
|
|
60
|
+
# @example
|
|
61
|
+
# client.plangroups.create_plan_group(
|
|
62
|
+
# add_on_ids: ["add_on_ids"],
|
|
63
|
+
# checkout_collect_address: true,
|
|
64
|
+
# checkout_collect_email: true,
|
|
65
|
+
# checkout_collect_phone: true,
|
|
66
|
+
# checkout_collect_tax_id: true,
|
|
67
|
+
# enable_tax_collection: true,
|
|
68
|
+
# opt_in_enabled: true,
|
|
69
|
+
# ordered_add_ons: [{
|
|
70
|
+
# plan_id: "plan_id"
|
|
71
|
+
# }],
|
|
72
|
+
# ordered_bundle_list: [{
|
|
73
|
+
# bundle_id: "bundleId"
|
|
74
|
+
# }],
|
|
75
|
+
# ordered_plans: [{
|
|
76
|
+
# plan_id: "plan_id"
|
|
77
|
+
# }],
|
|
78
|
+
# prevent_downgrades_when_over_limit: true,
|
|
79
|
+
# prevent_self_service_downgrade: true,
|
|
80
|
+
# proration_behavior: "create_prorations",
|
|
81
|
+
# show_as_monthly_prices: true,
|
|
82
|
+
# show_credits: true,
|
|
83
|
+
# show_feature_description: true,
|
|
84
|
+
# show_hard_limit: true,
|
|
85
|
+
# show_period_toggle: true,
|
|
86
|
+
# show_zero_price_as_free: true,
|
|
87
|
+
# sync_customer_billing_details: true
|
|
88
|
+
# )
|
|
89
|
+
#
|
|
59
90
|
# @return [Schematic::Plangroups::Types::CreatePlanGroupResponse]
|
|
60
91
|
def create_plan_group(request_options: {}, **params)
|
|
61
92
|
params = Schematic::Internal::Types::Utils.normalize_keys(params)
|
|
@@ -89,11 +120,42 @@ module Schematic
|
|
|
89
120
|
# @option request_options [Integer] :timeout_in_seconds
|
|
90
121
|
# @option params [String] :plan_group_id
|
|
91
122
|
#
|
|
123
|
+
# @example
|
|
124
|
+
# client.plangroups.update_plan_group(
|
|
125
|
+
# plan_group_id: "plan_group_id",
|
|
126
|
+
# add_on_ids: ["add_on_ids"],
|
|
127
|
+
# checkout_collect_address: true,
|
|
128
|
+
# checkout_collect_email: true,
|
|
129
|
+
# checkout_collect_phone: true,
|
|
130
|
+
# checkout_collect_tax_id: true,
|
|
131
|
+
# enable_tax_collection: true,
|
|
132
|
+
# opt_in_enabled: true,
|
|
133
|
+
# ordered_add_ons: [{
|
|
134
|
+
# plan_id: "plan_id"
|
|
135
|
+
# }],
|
|
136
|
+
# ordered_bundle_list: [{
|
|
137
|
+
# bundle_id: "bundleId"
|
|
138
|
+
# }],
|
|
139
|
+
# ordered_plans: [{
|
|
140
|
+
# plan_id: "plan_id"
|
|
141
|
+
# }],
|
|
142
|
+
# prevent_downgrades_when_over_limit: true,
|
|
143
|
+
# prevent_self_service_downgrade: true,
|
|
144
|
+
# proration_behavior: "create_prorations",
|
|
145
|
+
# show_as_monthly_prices: true,
|
|
146
|
+
# show_credits: true,
|
|
147
|
+
# show_feature_description: true,
|
|
148
|
+
# show_hard_limit: true,
|
|
149
|
+
# show_period_toggle: true,
|
|
150
|
+
# show_zero_price_as_free: true,
|
|
151
|
+
# sync_customer_billing_details: true
|
|
152
|
+
# )
|
|
153
|
+
#
|
|
92
154
|
# @return [Schematic::Plangroups::Types::UpdatePlanGroupResponse]
|
|
93
155
|
def update_plan_group(request_options: {}, **params)
|
|
94
156
|
params = Schematic::Internal::Types::Utils.normalize_keys(params)
|
|
95
157
|
request_data = Schematic::Plangroups::Types::UpdatePlanGroupRequestBody.new(params).to_h
|
|
96
|
-
non_body_param_names = [
|
|
158
|
+
non_body_param_names = %w[plan_group_id]
|
|
97
159
|
body = request_data.except(*non_body_param_names)
|
|
98
160
|
|
|
99
161
|
request = Schematic::Internal::JSON::Request.new(
|