From 59f93bccbb71d42a3edfb98bbcaaa8c3a5ed097e Mon Sep 17 00:00:00 2001 From: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Date: Mon, 18 May 2026 11:18:15 +0000 Subject: [PATCH] SDK regeneration --- .fern/metadata.json | 2 +- Gemfile.lock | 2 +- lib/schematic.rb | 15 +- .../create_billing_price_request_body.rb | 1 + lib/schematic/client.rb | 10 +- lib/schematic/entitlements/client.rb | 8 +- .../types/count_feature_usage_params.rb | 1 + .../types/count_feature_usage_request.rb | 1 + ...ng_linked_plan_entitlement_request_body.rb | 4 + .../create_plan_entitlement_request_body.rb | 4 + .../types/list_feature_usage_params.rb | 1 + .../types/list_feature_usage_request.rb | 1 + .../update_plan_entitlement_request_body.rb | 4 + lib/schematic/planbundle/client.rb | 32 + .../create_custom_plan_bundle_request_body.rb | 13 + .../create_custom_plan_bundle_response.rb | 12 + .../types/billing_price_response_data.rb | 1 + lib/schematic/types/billing_price_view.rb | 1 + ..._product_for_subscription_response_data.rb | 1 + .../billing_product_price_response_data.rb | 1 + .../company_plan_detail_response_data.rb | 1 + ...te_custom_plan_bundle_plan_request_body.rb | 12 + ...eate_entitlement_in_bundle_request_body.rb | 4 + .../types/currency_price_request_body.rb | 3 + ...titlement_currency_prices_response_data.rb | 1 + .../types/feature_company_response_data.rb | 1 + .../types/feature_usage_response_data.rb | 1 + .../types/plan_currency_price_request_body.rb | 1 + .../plan_currency_prices_response_data.rb | 1 + .../types/plan_detail_response_data.rb | 1 + .../types/plan_entitlement_response_data.rb | 1 + .../plan_group_plan_detail_response_data.rb | 1 + .../types/plan_view_public_response_data.rb | 1 + .../upsert_billing_product_request_body.rb | 2 + .../usage_based_entitlement_request_body.rb | 4 + .../usage_based_entitlement_response_data.rb | 1 + reference.md | 710 +++++++++++------- 37 files changed, 585 insertions(+), 276 deletions(-) create mode 100644 lib/schematic/planbundle/types/create_custom_plan_bundle_request_body.rb create mode 100644 lib/schematic/planbundle/types/create_custom_plan_bundle_response.rb create mode 100644 lib/schematic/types/create_custom_plan_bundle_plan_request_body.rb diff --git a/.fern/metadata.json b/.fern/metadata.json index 0f1c010..82d6fbf 100644 --- a/.fern/metadata.json +++ b/.fern/metadata.json @@ -13,6 +13,6 @@ "webrick": ">= 1.0" } }, - "originGitCommit": "4fd82021eff164a6f2484d4504850c46fe8f4a95", + "originGitCommit": "a0658700ca9b3d362ce6594c0740c41d9286e429", "sdkVersion": "1.4.1" } \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock index 6504fc7..9b1f365 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -42,7 +42,7 @@ GEM reline (0.6.3) io-console (~> 0.5) rexml (3.4.4) - rubocop (1.86.1) + rubocop (1.86.2) json (~> 2.3) language_server-protocol (~> 3.17.0.2) lint_roller (~> 1.1.0) diff --git a/lib/schematic.rb b/lib/schematic.rb index 6c36499..607861b 100644 --- a/lib/schematic.rb +++ b/lib/schematic.rb @@ -450,6 +450,10 @@ require_relative "schematic/types/stripe_embed_info" require_relative "schematic/types/component_preview_response_data" require_relative "schematic/components/types/preview_component_data_response" +require_relative "schematic/types/plan_bundle_response_data" +require_relative "schematic/planbundle/types/create_custom_plan_bundle_response" +require_relative "schematic/planbundle/types/create_plan_bundle_response" +require_relative "schematic/planbundle/types/update_plan_bundle_response" require_relative "schematic/types/data_export_output_file_type" require_relative "schematic/types/data_export_status" require_relative "schematic/types/data_export_type" @@ -535,9 +539,6 @@ require_relative "schematic/types/integrations_data_set_response_data" require_relative "schematic/integrationsapi/types/load_sample_data_set_v_2_response" require_relative "schematic/integrationsapi/types/uninstall_integration_response" -require_relative "schematic/types/plan_bundle_response_data" -require_relative "schematic/planbundle/types/create_plan_bundle_response" -require_relative "schematic/planbundle/types/update_plan_bundle_response" require_relative "schematic/plangroups/types/get_plan_group_params" require_relative "schematic/types/checkout_settings_response_data" require_relative "schematic/types/component_settings_response_data" @@ -624,6 +625,7 @@ require_relative "schematic/types/credit_auto_topup_amount_type" require_relative "schematic/types/create_billing_plan_credit_grant_request_body" require_relative "schematic/types/create_billing_price_tier_request_body" +require_relative "schematic/types/create_custom_plan_bundle_plan_request_body" require_relative "schematic/types/create_price_tier_request_body" require_relative "schematic/types/currency_price_request_body" require_relative "schematic/types/create_entitlement_in_bundle_request_body" @@ -827,6 +829,10 @@ require_relative "schematic/components/types/update_component_request_body" require_relative "schematic/components/types/count_components_request" require_relative "schematic/components/types/preview_component_data_request" +require_relative "schematic/planbundle/client" +require_relative "schematic/planbundle/types/create_custom_plan_bundle_request_body" +require_relative "schematic/planbundle/types/create_plan_bundle_request_body" +require_relative "schematic/planbundle/types/update_plan_bundle_request_body" require_relative "schematic/dataexports/client" require_relative "schematic/dataexports/types/create_data_export_request_body" require_relative "schematic/events/client" @@ -852,9 +858,6 @@ require_relative "schematic/integrationsapi/client" require_relative "schematic/integrationsapi/types/list_integrations_request" require_relative "schematic/integrationsapi/types/start_data_import_request_body" -require_relative "schematic/planbundle/client" -require_relative "schematic/planbundle/types/create_plan_bundle_request_body" -require_relative "schematic/planbundle/types/update_plan_bundle_request_body" require_relative "schematic/plangroups/client" require_relative "schematic/plangroups/types/get_plan_group_request" require_relative "schematic/plangroups/types/create_plan_group_request_body" diff --git a/lib/schematic/billing/types/create_billing_price_request_body.rb b/lib/schematic/billing/types/create_billing_price_request_body.rb index 81de55e..5a5b3b2 100644 --- a/lib/schematic/billing/types/create_billing_price_request_body.rb +++ b/lib/schematic/billing/types/create_billing_price_request_body.rb @@ -8,6 +8,7 @@ class CreateBillingPriceRequestBody < Internal::Types::Model field :currency, -> { String }, optional: false, nullable: false field :external_account_id, -> { String }, optional: false, nullable: false field :interval, -> { String }, optional: false, nullable: false + field :interval_count, -> { Integer }, optional: true, nullable: false field :is_active, -> { Internal::Types::Boolean }, optional: false, nullable: false field :meter_id, -> { String }, optional: true, nullable: false field :nickname, -> { String }, optional: true, nullable: false diff --git a/lib/schematic/client.rb b/lib/schematic/client.rb index 73dbc53..f9e60e1 100644 --- a/lib/schematic/client.rb +++ b/lib/schematic/client.rb @@ -57,6 +57,11 @@ def components @components ||= Schematic::Components::Client.new(client: @raw_client) end + # @return [Schematic::Planbundle::Client] + def planbundle + @planbundle ||= Schematic::Planbundle::Client.new(client: @raw_client) + end + # @return [Schematic::Dataexports::Client] def dataexports @dataexports ||= Schematic::Dataexports::Client.new(client: @raw_client) @@ -82,11 +87,6 @@ def integrationsapi @integrationsapi ||= Schematic::Integrationsapi::Client.new(client: @raw_client) end - # @return [Schematic::Planbundle::Client] - def planbundle - @planbundle ||= Schematic::Planbundle::Client.new(client: @raw_client) - end - # @return [Schematic::Plangroups::Client] def plangroups @plangroups ||= Schematic::Plangroups::Client.new(client: @raw_client) diff --git a/lib/schematic/entitlements/client.rb b/lib/schematic/entitlements/client.rb index c9c425a..dc0b9fd 100644 --- a/lib/schematic/entitlements/client.rb +++ b/lib/schematic/entitlements/client.rb @@ -350,6 +350,7 @@ def count_feature_companies(request_options: {}, **params) # @option params [Hash[String, String], nil] :company_keys # @option params [String, nil] :feature_ids # @option params [Boolean, nil] :include_usage_aggregation + # @option params [Schematic::Types::BillingProviderType, nil] :managed_by # @option params [String, nil] :q # @option params [Boolean, nil] :without_negative_entitlements # @option params [Integer, nil] :limit @@ -358,12 +359,13 @@ def count_feature_companies(request_options: {}, **params) # @return [Schematic::Entitlements::Types::ListFeatureUsageResponse] def list_feature_usage(request_options: {}, **params) params = Schematic::Internal::Types::Utils.normalize_keys(params) - query_param_names = %i[company_id company_keys feature_ids include_usage_aggregation q without_negative_entitlements limit offset] + query_param_names = %i[company_id company_keys feature_ids include_usage_aggregation managed_by q without_negative_entitlements limit offset] query_params = {} query_params["company_id"] = params[:company_id] if params.key?(:company_id) query_params["company_keys"] = params[:company_keys] if params.key?(:company_keys) query_params["feature_ids"] = params[:feature_ids] if params.key?(:feature_ids) query_params["include_usage_aggregation"] = params[:include_usage_aggregation] if params.key?(:include_usage_aggregation) + query_params["managed_by"] = params[:managed_by] if params.key?(:managed_by) query_params["q"] = params[:q] if params.key?(:q) query_params["without_negative_entitlements"] = params[:without_negative_entitlements] if params.key?(:without_negative_entitlements) query_params["limit"] = params[:limit] if params.key?(:limit) @@ -448,6 +450,7 @@ def get_feature_usage_time_series(request_options: {}, **params) # @option params [Hash[String, String], nil] :company_keys # @option params [String, nil] :feature_ids # @option params [Boolean, nil] :include_usage_aggregation + # @option params [Schematic::Types::BillingProviderType, nil] :managed_by # @option params [String, nil] :q # @option params [Boolean, nil] :without_negative_entitlements # @option params [Integer, nil] :limit @@ -456,12 +459,13 @@ def get_feature_usage_time_series(request_options: {}, **params) # @return [Schematic::Entitlements::Types::CountFeatureUsageResponse] def count_feature_usage(request_options: {}, **params) params = Schematic::Internal::Types::Utils.normalize_keys(params) - query_param_names = %i[company_id company_keys feature_ids include_usage_aggregation q without_negative_entitlements limit offset] + query_param_names = %i[company_id company_keys feature_ids include_usage_aggregation managed_by q without_negative_entitlements limit offset] query_params = {} query_params["company_id"] = params[:company_id] if params.key?(:company_id) query_params["company_keys"] = params[:company_keys] if params.key?(:company_keys) query_params["feature_ids"] = params[:feature_ids] if params.key?(:feature_ids) query_params["include_usage_aggregation"] = params[:include_usage_aggregation] if params.key?(:include_usage_aggregation) + query_params["managed_by"] = params[:managed_by] if params.key?(:managed_by) query_params["q"] = params[:q] if params.key?(:q) query_params["without_negative_entitlements"] = params[:without_negative_entitlements] if params.key?(:without_negative_entitlements) query_params["limit"] = params[:limit] if params.key?(:limit) diff --git a/lib/schematic/entitlements/types/count_feature_usage_params.rb b/lib/schematic/entitlements/types/count_feature_usage_params.rb index 65e853b..8e76c34 100644 --- a/lib/schematic/entitlements/types/count_feature_usage_params.rb +++ b/lib/schematic/entitlements/types/count_feature_usage_params.rb @@ -10,6 +10,7 @@ class CountFeatureUsageParams < Internal::Types::Model field :feature_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false field :include_usage_aggregation, -> { Internal::Types::Boolean }, optional: true, nullable: false field :limit, -> { Integer }, optional: true, nullable: false + field :managed_by, -> { Schematic::Types::BillingProviderType }, optional: true, nullable: false field :offset, -> { Integer }, optional: true, nullable: false field :q, -> { String }, optional: true, nullable: false field :without_negative_entitlements, -> { Internal::Types::Boolean }, optional: true, nullable: false diff --git a/lib/schematic/entitlements/types/count_feature_usage_request.rb b/lib/schematic/entitlements/types/count_feature_usage_request.rb index dd38bea..3b3541c 100644 --- a/lib/schematic/entitlements/types/count_feature_usage_request.rb +++ b/lib/schematic/entitlements/types/count_feature_usage_request.rb @@ -8,6 +8,7 @@ class CountFeatureUsageRequest < Internal::Types::Model field :company_keys, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false field :feature_ids, -> { String }, optional: true, nullable: false field :include_usage_aggregation, -> { Internal::Types::Boolean }, optional: true, nullable: false + field :managed_by, -> { Schematic::Types::BillingProviderType }, optional: true, nullable: false field :q, -> { String }, optional: true, nullable: false field :without_negative_entitlements, -> { Internal::Types::Boolean }, optional: true, nullable: false field :limit, -> { Integer }, optional: true, nullable: false diff --git a/lib/schematic/entitlements/types/create_billing_linked_plan_entitlement_request_body.rb b/lib/schematic/entitlements/types/create_billing_linked_plan_entitlement_request_body.rb index eadcf0f..8cddac5 100644 --- a/lib/schematic/entitlements/types/create_billing_linked_plan_entitlement_request_body.rb +++ b/lib/schematic/entitlements/types/create_billing_linked_plan_entitlement_request_body.rb @@ -23,6 +23,10 @@ class CreateBillingLinkedPlanEntitlementRequestBody < Internal::Types::Model field :plan_version_id, -> { String }, optional: true, nullable: false field :price_behavior, -> { Schematic::Types::EntitlementPriceBehavior }, optional: true, nullable: false field :price_tiers, -> { Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody] }, optional: true, nullable: false + field :quarterly_metered_price_id, -> { String }, optional: true, nullable: false + field :quarterly_price_tiers, -> { Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody] }, optional: true, nullable: false + field :quarterly_unit_price, -> { Integer }, optional: true, nullable: false + field :quarterly_unit_price_decimal, -> { String }, optional: true, nullable: false field :soft_limit, -> { Integer }, optional: true, nullable: false field :tier_mode, -> { Schematic::Types::BillingTiersMode }, optional: true, nullable: false field :value_bool, -> { Internal::Types::Boolean }, optional: true, nullable: false diff --git a/lib/schematic/entitlements/types/create_plan_entitlement_request_body.rb b/lib/schematic/entitlements/types/create_plan_entitlement_request_body.rb index a7913ea..d58dd2d 100644 --- a/lib/schematic/entitlements/types/create_plan_entitlement_request_body.rb +++ b/lib/schematic/entitlements/types/create_plan_entitlement_request_body.rb @@ -21,6 +21,10 @@ class CreatePlanEntitlementRequestBody < Internal::Types::Model field :plan_version_id, -> { String }, optional: true, nullable: false field :price_behavior, -> { Schematic::Types::EntitlementPriceBehavior }, optional: true, nullable: false field :price_tiers, -> { Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody] }, optional: true, nullable: false + field :quarterly_metered_price_id, -> { String }, optional: true, nullable: false + field :quarterly_price_tiers, -> { Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody] }, optional: true, nullable: false + field :quarterly_unit_price, -> { Integer }, optional: true, nullable: false + field :quarterly_unit_price_decimal, -> { String }, optional: true, nullable: false field :soft_limit, -> { Integer }, optional: true, nullable: false field :tier_mode, -> { Schematic::Types::BillingTiersMode }, optional: true, nullable: false field :value_bool, -> { Internal::Types::Boolean }, optional: true, nullable: false diff --git a/lib/schematic/entitlements/types/list_feature_usage_params.rb b/lib/schematic/entitlements/types/list_feature_usage_params.rb index 2349f9f..c25df34 100644 --- a/lib/schematic/entitlements/types/list_feature_usage_params.rb +++ b/lib/schematic/entitlements/types/list_feature_usage_params.rb @@ -10,6 +10,7 @@ class ListFeatureUsageParams < Internal::Types::Model field :feature_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false field :include_usage_aggregation, -> { Internal::Types::Boolean }, optional: true, nullable: false field :limit, -> { Integer }, optional: true, nullable: false + field :managed_by, -> { Schematic::Types::BillingProviderType }, optional: true, nullable: false field :offset, -> { Integer }, optional: true, nullable: false field :q, -> { String }, optional: true, nullable: false field :without_negative_entitlements, -> { Internal::Types::Boolean }, optional: true, nullable: false diff --git a/lib/schematic/entitlements/types/list_feature_usage_request.rb b/lib/schematic/entitlements/types/list_feature_usage_request.rb index 0aa4d93..214d23b 100644 --- a/lib/schematic/entitlements/types/list_feature_usage_request.rb +++ b/lib/schematic/entitlements/types/list_feature_usage_request.rb @@ -8,6 +8,7 @@ class ListFeatureUsageRequest < Internal::Types::Model field :company_keys, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false field :feature_ids, -> { String }, optional: true, nullable: false field :include_usage_aggregation, -> { Internal::Types::Boolean }, optional: true, nullable: false + field :managed_by, -> { Schematic::Types::BillingProviderType }, optional: true, nullable: false field :q, -> { String }, optional: true, nullable: false field :without_negative_entitlements, -> { Internal::Types::Boolean }, optional: true, nullable: false field :limit, -> { Integer }, optional: true, nullable: false diff --git a/lib/schematic/entitlements/types/update_plan_entitlement_request_body.rb b/lib/schematic/entitlements/types/update_plan_entitlement_request_body.rb index 37b0abe..457e4e9 100644 --- a/lib/schematic/entitlements/types/update_plan_entitlement_request_body.rb +++ b/lib/schematic/entitlements/types/update_plan_entitlement_request_body.rb @@ -19,6 +19,10 @@ class UpdatePlanEntitlementRequestBody < Internal::Types::Model field :overage_billing_product_id, -> { String }, optional: true, nullable: false field :price_behavior, -> { Schematic::Types::EntitlementPriceBehavior }, optional: true, nullable: false field :price_tiers, -> { Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody] }, optional: true, nullable: false + field :quarterly_metered_price_id, -> { String }, optional: true, nullable: false + field :quarterly_price_tiers, -> { Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody] }, optional: true, nullable: false + field :quarterly_unit_price, -> { Integer }, optional: true, nullable: false + field :quarterly_unit_price_decimal, -> { String }, optional: true, nullable: false field :soft_limit, -> { Integer }, optional: true, nullable: false field :tier_mode, -> { Schematic::Types::BillingTiersMode }, optional: true, nullable: false field :value_bool, -> { Internal::Types::Boolean }, optional: true, nullable: false diff --git a/lib/schematic/planbundle/client.rb b/lib/schematic/planbundle/client.rb index 2f51318..f7b7abf 100644 --- a/lib/schematic/planbundle/client.rb +++ b/lib/schematic/planbundle/client.rb @@ -10,6 +10,38 @@ def initialize(client:) @client = client end + # @param request_options [Hash] + # @param params [Schematic::Planbundle::Types::CreateCustomPlanBundleRequestBody] + # @option request_options [String] :base_url + # @option request_options [Hash{String => Object}] :additional_headers + # @option request_options [Hash{String => Object}] :additional_query_parameters + # @option request_options [Hash{String => Object}] :additional_body_parameters + # @option request_options [Integer] :timeout_in_seconds + # + # @return [Schematic::Planbundle::Types::CreateCustomPlanBundleResponse] + def create_custom_plan_bundle(request_options: {}, **params) + params = Schematic::Internal::Types::Utils.normalize_keys(params) + request = Schematic::Internal::JSON::Request.new( + base_url: request_options[:base_url], + method: "POST", + path: "custom-plan-bundles", + body: Schematic::Planbundle::Types::CreateCustomPlanBundleRequestBody.new(params).to_h, + request_options: request_options + ) + begin + response = @client.send(request) + rescue Net::HTTPRequestTimeout + raise Schematic::Errors::TimeoutError + end + code = response.code.to_i + if code.between?(200, 299) + Schematic::Planbundle::Types::CreateCustomPlanBundleResponse.load(response.body) + else + error_class = Schematic::Errors::ResponseError.subclass_for_code(code) + raise error_class.new(response.body, code: code) + end + end + # @param request_options [Hash] # @param params [Schematic::Planbundle::Types::CreatePlanBundleRequestBody] # @option request_options [String] :base_url diff --git a/lib/schematic/planbundle/types/create_custom_plan_bundle_request_body.rb b/lib/schematic/planbundle/types/create_custom_plan_bundle_request_body.rb new file mode 100644 index 0000000..b4963c0 --- /dev/null +++ b/lib/schematic/planbundle/types/create_custom_plan_bundle_request_body.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +module Schematic + module Planbundle + module Types + class CreateCustomPlanBundleRequestBody < Internal::Types::Model + field :billing_product, -> { Schematic::Types::UpsertBillingProductRequestBody }, optional: true, nullable: false + field :entitlements, -> { Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody] }, optional: false, nullable: false + field :plan, -> { Schematic::Types::CreateCustomPlanBundlePlanRequestBody }, optional: true, nullable: false + end + end + end +end diff --git a/lib/schematic/planbundle/types/create_custom_plan_bundle_response.rb b/lib/schematic/planbundle/types/create_custom_plan_bundle_response.rb new file mode 100644 index 0000000..bc90c66 --- /dev/null +++ b/lib/schematic/planbundle/types/create_custom_plan_bundle_response.rb @@ -0,0 +1,12 @@ +# frozen_string_literal: true + +module Schematic + module Planbundle + module Types + class CreateCustomPlanBundleResponse < Internal::Types::Model + field :data, -> { Schematic::Types::PlanBundleResponseData }, optional: false, nullable: false + field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false + end + end + end +end diff --git a/lib/schematic/types/billing_price_response_data.rb b/lib/schematic/types/billing_price_response_data.rb index 4601a82..f90048c 100644 --- a/lib/schematic/types/billing_price_response_data.rb +++ b/lib/schematic/types/billing_price_response_data.rb @@ -7,6 +7,7 @@ class BillingPriceResponseData < Internal::Types::Model field :external_price_id, -> { String }, optional: false, nullable: false field :id, -> { String }, optional: false, nullable: false field :interval, -> { Schematic::Types::BillingProductPriceInterval }, optional: false, nullable: false + field :interval_count, -> { Integer }, optional: false, nullable: false field :nickname, -> { String }, optional: true, nullable: false field :price, -> { Integer }, optional: false, nullable: false field :price_decimal, -> { String }, optional: true, nullable: false diff --git a/lib/schematic/types/billing_price_view.rb b/lib/schematic/types/billing_price_view.rb index 7820b40..c4966b0 100644 --- a/lib/schematic/types/billing_price_view.rb +++ b/lib/schematic/types/billing_price_view.rb @@ -8,6 +8,7 @@ class BillingPriceView < Internal::Types::Model field :currency, -> { String }, optional: false, nullable: false field :id, -> { String }, optional: false, nullable: false field :interval, -> { Schematic::Types::BillingProductPriceInterval }, optional: false, nullable: false + field :interval_count, -> { Integer }, optional: false, nullable: false field :is_active, -> { Internal::Types::Boolean }, optional: false, nullable: false field :meter_event_name, -> { String }, optional: true, nullable: false field :meter_event_payload_key, -> { String }, optional: true, nullable: false diff --git a/lib/schematic/types/billing_product_for_subscription_response_data.rb b/lib/schematic/types/billing_product_for_subscription_response_data.rb index 6c94379..d64ac9d 100644 --- a/lib/schematic/types/billing_product_for_subscription_response_data.rb +++ b/lib/schematic/types/billing_product_for_subscription_response_data.rb @@ -11,6 +11,7 @@ class BillingProductForSubscriptionResponseData < Internal::Types::Model field :external_id, -> { String }, optional: false, nullable: false field :id, -> { String }, optional: false, nullable: false field :interval, -> { String }, optional: false, nullable: false + field :interval_count, -> { Integer }, optional: true, nullable: false field :meter_id, -> { String }, optional: true, nullable: false field :name, -> { String }, optional: false, nullable: false field :package_size, -> { Integer }, optional: false, nullable: false diff --git a/lib/schematic/types/billing_product_price_response_data.rb b/lib/schematic/types/billing_product_price_response_data.rb index 6bcf3e2..50f452f 100644 --- a/lib/schematic/types/billing_product_price_response_data.rb +++ b/lib/schematic/types/billing_product_price_response_data.rb @@ -8,6 +8,7 @@ class BillingProductPriceResponseData < Internal::Types::Model field :currency, -> { String }, optional: false, nullable: false field :id, -> { String }, optional: false, nullable: false field :interval, -> { Schematic::Types::BillingProductPriceInterval }, optional: false, nullable: false + field :interval_count, -> { Integer }, optional: false, nullable: false field :is_active, -> { Internal::Types::Boolean }, optional: false, nullable: false field :meter_id, -> { String }, optional: true, nullable: false field :nickname, -> { String }, optional: true, nullable: false diff --git a/lib/schematic/types/company_plan_detail_response_data.rb b/lib/schematic/types/company_plan_detail_response_data.rb index 09d5da0..286a161 100644 --- a/lib/schematic/types/company_plan_detail_response_data.rb +++ b/lib/schematic/types/company_plan_detail_response_data.rb @@ -36,6 +36,7 @@ class CompanyPlanDetailResponseData < Internal::Types::Model field :name, -> { String }, optional: false, nullable: false field :one_time_price, -> { Schematic::Types::BillingPriceResponseData }, optional: true, nullable: false field :plan_type, -> { Schematic::Types::PlanType }, optional: false, nullable: false + field :quarterly_price, -> { Schematic::Types::BillingPriceResponseData }, optional: true, nullable: false field :trial_days, -> { Integer }, optional: true, nullable: false field :updated_at, -> { String }, optional: false, nullable: false field :usage_violations, -> { Internal::Types::Array[Schematic::Types::FeatureUsageResponseData] }, optional: false, nullable: false diff --git a/lib/schematic/types/create_custom_plan_bundle_plan_request_body.rb b/lib/schematic/types/create_custom_plan_bundle_plan_request_body.rb new file mode 100644 index 0000000..5036c67 --- /dev/null +++ b/lib/schematic/types/create_custom_plan_bundle_plan_request_body.rb @@ -0,0 +1,12 @@ +# frozen_string_literal: true + +module Schematic + module Types + class CreateCustomPlanBundlePlanRequestBody < Internal::Types::Model + field :company_id, -> { String }, optional: false, nullable: false + field :description, -> { String }, optional: false, nullable: false + field :icon, -> { Schematic::Types::PlanIcon }, optional: true, nullable: false + field :name, -> { String }, optional: false, nullable: false + end + end +end diff --git a/lib/schematic/types/create_entitlement_in_bundle_request_body.rb b/lib/schematic/types/create_entitlement_in_bundle_request_body.rb index a45aee1..cb00548 100644 --- a/lib/schematic/types/create_entitlement_in_bundle_request_body.rb +++ b/lib/schematic/types/create_entitlement_in_bundle_request_body.rb @@ -20,6 +20,10 @@ class CreateEntitlementInBundleRequestBody < Internal::Types::Model field :plan_version_id, -> { String }, optional: true, nullable: false field :price_behavior, -> { Schematic::Types::EntitlementPriceBehavior }, optional: true, nullable: false field :price_tiers, -> { Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody] }, optional: true, nullable: false + field :quarterly_metered_price_id, -> { String }, optional: true, nullable: false + field :quarterly_price_tiers, -> { Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody] }, optional: true, nullable: false + field :quarterly_unit_price, -> { Integer }, optional: true, nullable: false + field :quarterly_unit_price_decimal, -> { String }, optional: true, nullable: false field :soft_limit, -> { Integer }, optional: true, nullable: false field :tier_mode, -> { Schematic::Types::BillingTiersMode }, optional: true, nullable: false field :value_bool, -> { Internal::Types::Boolean }, optional: true, nullable: false diff --git a/lib/schematic/types/currency_price_request_body.rb b/lib/schematic/types/currency_price_request_body.rb index 310baf8..6f3d85a 100644 --- a/lib/schematic/types/currency_price_request_body.rb +++ b/lib/schematic/types/currency_price_request_body.rb @@ -7,6 +7,9 @@ class CurrencyPriceRequestBody < Internal::Types::Model field :monthly_price_tiers, -> { Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody] }, optional: true, nullable: false field :monthly_unit_price, -> { Integer }, optional: true, nullable: false field :monthly_unit_price_decimal, -> { String }, optional: true, nullable: false + field :quarterly_price_tiers, -> { Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody] }, optional: true, nullable: false + field :quarterly_unit_price, -> { Integer }, optional: true, nullable: false + field :quarterly_unit_price_decimal, -> { String }, optional: true, nullable: false field :yearly_price_tiers, -> { Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody] }, optional: true, nullable: false field :yearly_unit_price, -> { Integer }, optional: true, nullable: false field :yearly_unit_price_decimal, -> { String }, optional: true, nullable: false diff --git a/lib/schematic/types/entitlement_currency_prices_response_data.rb b/lib/schematic/types/entitlement_currency_prices_response_data.rb index 1799954..afa23b3 100644 --- a/lib/schematic/types/entitlement_currency_prices_response_data.rb +++ b/lib/schematic/types/entitlement_currency_prices_response_data.rb @@ -5,6 +5,7 @@ module Types class EntitlementCurrencyPricesResponseData < Internal::Types::Model field :currency, -> { String }, optional: false, nullable: false field :monthly_price, -> { Schematic::Types::BillingPriceView }, optional: true, nullable: false + field :quarterly_price, -> { Schematic::Types::BillingPriceView }, optional: true, nullable: false field :yearly_price, -> { Schematic::Types::BillingPriceView }, optional: true, nullable: false end end diff --git a/lib/schematic/types/feature_company_response_data.rb b/lib/schematic/types/feature_company_response_data.rb index b6f2b1f..c0b0523 100644 --- a/lib/schematic/types/feature_company_response_data.rb +++ b/lib/schematic/types/feature_company_response_data.rb @@ -36,6 +36,7 @@ class FeatureCompanyResponseData < Internal::Types::Model field :plan, -> { Schematic::Types::PlanResponseData }, optional: true, nullable: false field :plan_entitlement, -> { Schematic::Types::PlanEntitlementResponseData }, optional: true, nullable: false field :price_behavior, -> { Schematic::Types::EntitlementPriceBehavior }, optional: true, nullable: false + field :quarterly_usage_based_price, -> { Schematic::Types::BillingPriceView }, optional: true, nullable: false field :soft_limit, -> { Integer }, optional: true, nullable: false field :usage, -> { Integer }, optional: true, nullable: false field :yearly_usage_based_price, -> { Schematic::Types::BillingPriceView }, optional: true, nullable: false diff --git a/lib/schematic/types/feature_usage_response_data.rb b/lib/schematic/types/feature_usage_response_data.rb index 1d6b103..54afc99 100644 --- a/lib/schematic/types/feature_usage_response_data.rb +++ b/lib/schematic/types/feature_usage_response_data.rb @@ -34,6 +34,7 @@ class FeatureUsageResponseData < Internal::Types::Model field :plan, -> { Schematic::Types::PlanResponseData }, optional: true, nullable: false field :plan_entitlement, -> { Schematic::Types::PlanEntitlementResponseData }, optional: true, nullable: false field :price_behavior, -> { Schematic::Types::EntitlementPriceBehavior }, optional: true, nullable: false + field :quarterly_usage_based_price, -> { Schematic::Types::BillingPriceView }, optional: true, nullable: false field :soft_limit, -> { Integer }, optional: true, nullable: false field :usage, -> { Integer }, optional: true, nullable: false field :yearly_usage_based_price, -> { Schematic::Types::BillingPriceView }, optional: true, nullable: false diff --git a/lib/schematic/types/plan_currency_price_request_body.rb b/lib/schematic/types/plan_currency_price_request_body.rb index 94d4ec2..30ea894 100644 --- a/lib/schematic/types/plan_currency_price_request_body.rb +++ b/lib/schematic/types/plan_currency_price_request_body.rb @@ -6,6 +6,7 @@ class PlanCurrencyPriceRequestBody < Internal::Types::Model field :currency, -> { String }, optional: false, nullable: false field :monthly_price, -> { Integer }, optional: true, nullable: false field :one_time_price, -> { Integer }, optional: true, nullable: false + field :quarterly_price, -> { Integer }, optional: true, nullable: false field :yearly_price, -> { Integer }, optional: true, nullable: false end end diff --git a/lib/schematic/types/plan_currency_prices_response_data.rb b/lib/schematic/types/plan_currency_prices_response_data.rb index fd2617b..5731c3a 100644 --- a/lib/schematic/types/plan_currency_prices_response_data.rb +++ b/lib/schematic/types/plan_currency_prices_response_data.rb @@ -6,6 +6,7 @@ class PlanCurrencyPricesResponseData < Internal::Types::Model field :currency, -> { String }, optional: false, nullable: false field :monthly_price, -> { Schematic::Types::BillingPriceResponseData }, optional: true, nullable: false field :one_time_price, -> { Schematic::Types::BillingPriceResponseData }, optional: true, nullable: false + field :quarterly_price, -> { Schematic::Types::BillingPriceResponseData }, optional: true, nullable: false field :yearly_price, -> { Schematic::Types::BillingPriceResponseData }, optional: true, nullable: false end end diff --git a/lib/schematic/types/plan_detail_response_data.rb b/lib/schematic/types/plan_detail_response_data.rb index 31572bc..2c3ed7d 100644 --- a/lib/schematic/types/plan_detail_response_data.rb +++ b/lib/schematic/types/plan_detail_response_data.rb @@ -28,6 +28,7 @@ class PlanDetailResponseData < Internal::Types::Model field :name, -> { String }, optional: false, nullable: false field :one_time_price, -> { Schematic::Types::BillingPriceResponseData }, optional: true, nullable: false field :plan_type, -> { Schematic::Types::PlanType }, optional: false, nullable: false + field :quarterly_price, -> { Schematic::Types::BillingPriceResponseData }, optional: true, nullable: false field :trial_days, -> { Integer }, optional: true, nullable: false field :updated_at, -> { String }, optional: false, nullable: false field :versions, -> { Internal::Types::Array[Schematic::Types::PlanVersionResponseData] }, optional: false, nullable: false diff --git a/lib/schematic/types/plan_entitlement_response_data.rb b/lib/schematic/types/plan_entitlement_response_data.rb index 80fee2d..e43b2f2 100644 --- a/lib/schematic/types/plan_entitlement_response_data.rb +++ b/lib/schematic/types/plan_entitlement_response_data.rb @@ -13,6 +13,7 @@ class PlanEntitlementResponseData < Internal::Types::Model field :feature_id, -> { String }, optional: false, nullable: false field :id, -> { String }, optional: false, nullable: false field :metered_monthly_price, -> { Schematic::Types::BillingPriceView }, optional: true, nullable: false + field :metered_quarterly_price, -> { Schematic::Types::BillingPriceView }, optional: true, nullable: false field :metered_yearly_price, -> { Schematic::Types::BillingPriceView }, optional: true, nullable: false field :metric_period, -> { Schematic::Types::MetricPeriod }, optional: true, nullable: false field :metric_period_month_reset, -> { Schematic::Types::MetricPeriodMonthReset }, optional: true, nullable: false diff --git a/lib/schematic/types/plan_group_plan_detail_response_data.rb b/lib/schematic/types/plan_group_plan_detail_response_data.rb index 6428637..3a926b6 100644 --- a/lib/schematic/types/plan_group_plan_detail_response_data.rb +++ b/lib/schematic/types/plan_group_plan_detail_response_data.rb @@ -32,6 +32,7 @@ class PlanGroupPlanDetailResponseData < Internal::Types::Model field :name, -> { String }, optional: false, nullable: false field :one_time_price, -> { Schematic::Types::BillingPriceResponseData }, optional: true, nullable: false field :plan_type, -> { Schematic::Types::PlanType }, optional: false, nullable: false + field :quarterly_price, -> { Schematic::Types::BillingPriceResponseData }, optional: true, nullable: false field :trial_days, -> { Integer }, optional: true, nullable: false field :updated_at, -> { String }, optional: false, nullable: false field :versions, -> { Internal::Types::Array[Schematic::Types::PlanVersionResponseData] }, optional: false, nullable: false diff --git a/lib/schematic/types/plan_view_public_response_data.rb b/lib/schematic/types/plan_view_public_response_data.rb index f1ecd09..1bafd84 100644 --- a/lib/schematic/types/plan_view_public_response_data.rb +++ b/lib/schematic/types/plan_view_public_response_data.rb @@ -33,6 +33,7 @@ class PlanViewPublicResponseData < Internal::Types::Model field :name, -> { String }, optional: false, nullable: false field :one_time_price, -> { Schematic::Types::BillingPriceResponseData }, optional: true, nullable: false field :plan_type, -> { Schematic::Types::PlanType }, optional: false, nullable: false + field :quarterly_price, -> { Schematic::Types::BillingPriceResponseData }, optional: true, nullable: false field :trial_days, -> { Integer }, optional: true, nullable: false field :updated_at, -> { String }, optional: false, nullable: false field :versions, -> { Internal::Types::Array[Schematic::Types::PlanVersionResponseData] }, optional: false, nullable: false diff --git a/lib/schematic/types/upsert_billing_product_request_body.rb b/lib/schematic/types/upsert_billing_product_request_body.rb index e28630c..5522aff 100644 --- a/lib/schematic/types/upsert_billing_product_request_body.rb +++ b/lib/schematic/types/upsert_billing_product_request_body.rb @@ -12,6 +12,8 @@ class UpsertBillingProductRequestBody < Internal::Types::Model field :monthly_price_id, -> { String }, optional: true, nullable: false field :one_time_price, -> { Integer }, optional: true, nullable: false field :one_time_price_id, -> { String }, optional: true, nullable: false + field :quarterly_price, -> { Integer }, optional: true, nullable: false + field :quarterly_price_id, -> { String }, optional: true, nullable: false field :trial_days, -> { Integer }, optional: true, nullable: false field :yearly_price, -> { Integer }, optional: true, nullable: false field :yearly_price_id, -> { String }, optional: true, nullable: false diff --git a/lib/schematic/types/usage_based_entitlement_request_body.rb b/lib/schematic/types/usage_based_entitlement_request_body.rb index 13679cc..583cb67 100644 --- a/lib/schematic/types/usage_based_entitlement_request_body.rb +++ b/lib/schematic/types/usage_based_entitlement_request_body.rb @@ -14,6 +14,10 @@ class UsageBasedEntitlementRequestBody < Internal::Types::Model field :overage_billing_product_id, -> { String }, optional: true, nullable: false field :price_behavior, -> { Schematic::Types::EntitlementPriceBehavior }, optional: true, nullable: false field :price_tiers, -> { Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody] }, optional: true, nullable: false + field :quarterly_metered_price_id, -> { String }, optional: true, nullable: false + field :quarterly_price_tiers, -> { Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody] }, optional: true, nullable: false + field :quarterly_unit_price, -> { Integer }, optional: true, nullable: false + field :quarterly_unit_price_decimal, -> { String }, optional: true, nullable: false field :soft_limit, -> { Integer }, optional: true, nullable: false field :tier_mode, -> { Schematic::Types::BillingTiersMode }, optional: true, nullable: false field :yearly_metered_price_id, -> { String }, optional: true, nullable: false diff --git a/lib/schematic/types/usage_based_entitlement_response_data.rb b/lib/schematic/types/usage_based_entitlement_response_data.rb index b71eaa9..8831415 100644 --- a/lib/schematic/types/usage_based_entitlement_response_data.rb +++ b/lib/schematic/types/usage_based_entitlement_response_data.rb @@ -11,6 +11,7 @@ class UsageBasedEntitlementResponseData < Internal::Types::Model field :metric_period_month_reset, -> { Schematic::Types::MetricPeriodMonthReset }, optional: true, nullable: false field :monthly_usage_based_price, -> { Schematic::Types::BillingPriceView }, optional: true, nullable: false field :price_behavior, -> { Schematic::Types::EntitlementPriceBehavior }, optional: true, nullable: false + field :quarterly_usage_based_price, -> { Schematic::Types::BillingPriceView }, optional: true, nullable: false field :value_bool, -> { Internal::Types::Boolean }, optional: true, nullable: false field :value_numeric, -> { Integer }, optional: true, nullable: false field :value_type, -> { Schematic::Types::EntitlementValueType }, optional: false, nullable: false diff --git a/reference.md b/reference.md index d7d3ef4..b7940e0 100644 --- a/reference.md +++ b/reference.md @@ -2492,6 +2492,14 @@ client.billing.upsert_billing_price(
+**interval_count:** `Integer` + +
+
+ +
+
+ **is_active:** `Internal::Types::Boolean`
@@ -10009,6 +10017,7 @@ client.entitlements.list_feature_usage( company_id: "company_id", feature_ids: ["feature_ids"], include_usage_aggregation: true, + managed_by: "orb", q: "q", without_negative_entitlements: true, limit: 1000000, @@ -10060,6 +10069,14 @@ client.entitlements.list_feature_usage(
+**managed_by:** `Schematic::Types::BillingProviderType` — Filter for features managed by a billing provider, or by Schematic (no billing provider) + +
+
+ +
+
+ **q:** `String`
@@ -10207,6 +10224,7 @@ client.entitlements.count_feature_usage( company_id: "company_id", feature_ids: ["feature_ids"], include_usage_aggregation: true, + managed_by: "orb", q: "q", without_negative_entitlements: true, limit: 1000000, @@ -10258,6 +10276,14 @@ client.entitlements.count_feature_usage(
+**managed_by:** `Schematic::Types::BillingProviderType` — Filter for features managed by a billing provider, or by Schematic (no billing provider) + +
+
+ +
+
+ **q:** `String`
@@ -10764,6 +10790,38 @@ client.entitlements.create_plan_entitlement(
+**quarterly_metered_price_id:** `String` + +
+
+ +
+
+ +**quarterly_price_tiers:** `Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody]` + +
+
+ +
+
+ +**quarterly_unit_price:** `Integer` + +
+
+ +
+
+ +**quarterly_unit_price_decimal:** `String` + +
+
+ +
+
+ **soft_limit:** `Integer`
@@ -11063,6 +11121,38 @@ client.entitlements.update_plan_entitlement(
+**quarterly_metered_price_id:** `String` + +
+
+ +
+
+ +**quarterly_price_tiers:** `Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody]` + +
+
+ +
+
+ +**quarterly_unit_price:** `Integer` + +
+
+ +
+
+ +**quarterly_unit_price_decimal:** `String` + +
+
+ +
+
+ **soft_limit:** `Integer`
@@ -11397,6 +11487,38 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
+**quarterly_metered_price_id:** `String` + +
+
+ +
+
+ +**quarterly_price_tiers:** `Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody]` + +
+
+ +
+
+ +**quarterly_unit_price:** `Integer` + +
+
+ +
+
+ +**quarterly_unit_price_decimal:** `String` + +
+
+ +
+
+ **soft_limit:** `Integer`
@@ -13645,8 +13767,8 @@ client.components.preview_component_data(
-## dataexports -
client.dataexports.create_data_export(request) -> Schematic::Dataexports::Types::CreateDataExportResponse +## planbundle +
client.planbundle.create_custom_plan_bundle(request) -> Schematic::Planbundle::Types::CreateCustomPlanBundleResponse
@@ -13659,11 +13781,9 @@ client.components.preview_component_data(
```ruby -client.dataexports.create_data_export( - export_type: "company-feature-usage", - metadata: "metadata", - output_file_type: "csv" -) +client.planbundle.create_custom_plan_bundle(entitlements: [{ + action: "create" +}]) ```
@@ -13678,7 +13798,7 @@ client.dataexports.create_data_export(
-**export_type:** `String` +**billing_product:** `Schematic::Types::UpsertBillingProductRequestBody`
@@ -13686,7 +13806,7 @@ client.dataexports.create_data_export(
-**metadata:** `String` +**entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
@@ -13694,7 +13814,7 @@ client.dataexports.create_data_export(
-**output_file_type:** `String` +**plan:** `Schematic::Types::CreateCustomPlanBundlePlanRequestBody`
@@ -13702,7 +13822,7 @@ client.dataexports.create_data_export(
-**request_options:** `Schematic::Dataexports::RequestOptions` +**request_options:** `Schematic::Planbundle::RequestOptions`
@@ -13714,7 +13834,7 @@ client.dataexports.create_data_export(
-
client.dataexports.get_data_export_artifact(data_export_id) -> String +
client.planbundle.create_plan_bundle(request) -> Schematic::Planbundle::Types::CreatePlanBundleResponse
@@ -13727,7 +13847,9 @@ client.dataexports.create_data_export(
```ruby -client.dataexports.get_data_export_artifact(data_export_id: "data_export_id") +client.planbundle.create_plan_bundle(entitlements: [{ + action: "create" +}]) ```
@@ -13742,7 +13864,7 @@ client.dataexports.get_data_export_artifact(data_export_id: "data_export_id")
-**data_export_id:** `String` — data_export_id +**billing_product:** `Schematic::Types::UpsertBillingProductRequestBody`
@@ -13750,50 +13872,31 @@ client.dataexports.get_data_export_artifact(data_export_id: "data_export_id")
-**request_options:** `Schematic::Dataexports::RequestOptions` +**credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
- -
- - - -
- -## events -
client.events.create_event_batch(request) -> Schematic::Events::Types::CreateEventBatchResponse
-#### 🔌 Usage - -
-
+**entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]` + +
+
-```ruby -client.events.create_event_batch(events: [{ - event_type: "flag_check" -}]) -``` -
-
+**plan:** `Schematic::Types::CreatePlanRequestBody` +
-#### ⚙️ Parameters -
-
-
- -**events:** `Internal::Types::Array[Schematic::Types::CreateEventRequestBody]` +**traits:** `Internal::Types::Array[Schematic::Types::UpdatePlanTraitTraitRequestBody]`
@@ -13801,7 +13904,7 @@ client.events.create_event_batch(events: [{
-**request_options:** `Schematic::Events::RequestOptions` +**request_options:** `Schematic::Planbundle::RequestOptions`
@@ -13813,7 +13916,7 @@ client.events.create_event_batch(events: [{
-
client.events.get_event_summaries() -> Schematic::Events::Types::GetEventSummariesResponse +
client.planbundle.update_plan_bundle(plan_bundle_id, request) -> Schematic::Planbundle::Types::UpdatePlanBundleResponse
@@ -13826,11 +13929,11 @@ client.events.create_event_batch(events: [{
```ruby -client.events.get_event_summaries( - q: "q", - event_subtypes: ["event_subtypes"], - limit: 1000000, - offset: 1000000 +client.planbundle.update_plan_bundle( + plan_bundle_id: "plan_bundle_id", + entitlements: [{ + action: "create" + }] ) ```
@@ -13846,7 +13949,7 @@ client.events.get_event_summaries(
-**q:** `String` +**plan_bundle_id:** `String` — plan_bundle_id
@@ -13854,7 +13957,7 @@ client.events.get_event_summaries(
-**event_subtypes:** `String` +**billing_product:** `Schematic::Types::UpsertBillingProductRequestBody`
@@ -13862,7 +13965,7 @@ client.events.get_event_summaries(
-**limit:** `Integer` — Page limit (default 100) +**credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
@@ -13870,7 +13973,7 @@ client.events.get_event_summaries(
-**offset:** `Integer` — Page offset (default 0) +**entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
@@ -13878,7 +13981,31 @@ client.events.get_event_summaries(
-**request_options:** `Schematic::Events::RequestOptions` +**plan:** `Schematic::Types::UpdatePlanRequestBody` + +
+
+ +
+
+ +**plan_version_id:** `String` + +
+
+ +
+
+ +**traits:** `Internal::Types::Array[Schematic::Types::UpdatePlanTraitTraitRequestBody]` + +
+
+ +
+
+ +**request_options:** `Schematic::Planbundle::RequestOptions`
@@ -13890,7 +14017,8 @@ client.events.get_event_summaries(
-
client.events.list_events() -> Schematic::Events::Types::ListEventsResponse +## dataexports +
client.dataexports.create_data_export(request) -> Schematic::Dataexports::Types::CreateDataExportResponse
@@ -13903,15 +14031,10 @@ client.events.get_event_summaries(
```ruby -client.events.list_events( - company_id: "company_id", - event_subtype: "event_subtype", - event_types: ["flag_check"], - flag_id: "flag_id", - idempotency_key: "idempotency_key", - user_id: "user_id", - limit: 1000000, - offset: 1000000 +client.dataexports.create_data_export( + export_type: "company-feature-usage", + metadata: "metadata", + output_file_type: "csv" ) ```
@@ -13927,7 +14050,7 @@ client.events.list_events(
-**company_id:** `String` +**export_type:** `String`
@@ -13935,7 +14058,7 @@ client.events.list_events(
-**event_subtype:** `String` +**metadata:** `String`
@@ -13943,7 +14066,7 @@ client.events.list_events(
-**event_types:** `Schematic::Types::EventType` +**output_file_type:** `String`
@@ -13951,32 +14074,281 @@ client.events.list_events(
-**flag_id:** `String` +**request_options:** `Schematic::Dataexports::RequestOptions`
+ +
-
-
-**idempotency_key:** `String` -
+
+
client.dataexports.get_data_export_artifact(data_export_id) -> String
-**user_id:** `String` - -
-
+#### 🔌 Usage
-**limit:** `Integer` — Page limit (default 100) - +
+
+ +```ruby +client.dataexports.get_data_export_artifact(data_export_id: "data_export_id") +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**data_export_id:** `String` — data_export_id + +
+
+ +
+
+ +**request_options:** `Schematic::Dataexports::RequestOptions` + +
+
+
+
+ + + +
+ + +## events +
client.events.create_event_batch(request) -> Schematic::Events::Types::CreateEventBatchResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.events.create_event_batch(events: [{ + event_type: "flag_check" +}]) +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**events:** `Internal::Types::Array[Schematic::Types::CreateEventRequestBody]` + +
+
+ +
+
+ +**request_options:** `Schematic::Events::RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.events.get_event_summaries() -> Schematic::Events::Types::GetEventSummariesResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.events.get_event_summaries( + q: "q", + event_subtypes: ["event_subtypes"], + limit: 1000000, + offset: 1000000 +) +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**q:** `String` + +
+
+ +
+
+ +**event_subtypes:** `String` + +
+
+ +
+
+ +**limit:** `Integer` — Page limit (default 100) + +
+
+ +
+
+ +**offset:** `Integer` — Page offset (default 0) + +
+
+ +
+
+ +**request_options:** `Schematic::Events::RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.events.list_events() -> Schematic::Events::Types::ListEventsResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.events.list_events( + company_id: "company_id", + event_subtype: "event_subtype", + event_types: ["flag_check"], + flag_id: "flag_id", + idempotency_key: "idempotency_key", + user_id: "user_id", + limit: 1000000, + offset: 1000000 +) +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**company_id:** `String` + +
+
+ +
+
+ +**event_subtype:** `String` + +
+
+ +
+
+ +**event_types:** `Schematic::Types::EventType` + +
+
+ +
+
+ +**flag_id:** `String` + +
+
+ +
+
+ +**idempotency_key:** `String` + +
+
+ +
+
+ +**user_id:** `String` + +
+
+ +
+
+ +**limit:** `Integer` — Page limit (default 100) +
@@ -16236,190 +16608,6 @@ client.integrationsapi.uninstall_integration(integration_id: "integration_id")
-
-
-
- -## planbundle -
client.planbundle.create_plan_bundle(request) -> Schematic::Planbundle::Types::CreatePlanBundleResponse -
-
- -#### 🔌 Usage - -
-
- -
-
- -```ruby -client.planbundle.create_plan_bundle(entitlements: [{ - action: "create" -}]) -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**billing_product:** `Schematic::Types::UpsertBillingProductRequestBody` - -
-
- -
-
- -**credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]` - -
-
- -
-
- -**entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]` - -
-
- -
-
- -**plan:** `Schematic::Types::CreatePlanRequestBody` - -
-
- -
-
- -**traits:** `Internal::Types::Array[Schematic::Types::UpdatePlanTraitTraitRequestBody]` - -
-
- -
-
- -**request_options:** `Schematic::Planbundle::RequestOptions` - -
-
-
-
- - -
-
-
- -
client.planbundle.update_plan_bundle(plan_bundle_id, request) -> Schematic::Planbundle::Types::UpdatePlanBundleResponse -
-
- -#### 🔌 Usage - -
-
- -
-
- -```ruby -client.planbundle.update_plan_bundle( - plan_bundle_id: "plan_bundle_id", - entitlements: [{ - action: "create" - }] -) -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**plan_bundle_id:** `String` — plan_bundle_id - -
-
- -
-
- -**billing_product:** `Schematic::Types::UpsertBillingProductRequestBody` - -
-
- -
-
- -**credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]` - -
-
- -
-
- -**entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]` - -
-
- -
-
- -**plan:** `Schematic::Types::UpdatePlanRequestBody` - -
-
- -
-
- -**plan_version_id:** `String` - -
-
- -
-
- -**traits:** `Internal::Types::Array[Schematic::Types::UpdatePlanTraitTraitRequestBody]` - -
-
- -
-
- -**request_options:** `Schematic::Planbundle::RequestOptions` - -
-
-
-
- -