schematichq 1.4.13 → 1.4.14

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.
Files changed (72) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +2 -2
  3. data/.fern/replay.lock +9 -3
  4. data/WASM_VERSION +1 -1
  5. data/lib/schematic/accounts/client.rb +63 -0
  6. data/lib/schematic/accounts/types/get_onboarding_state_response.rb +12 -0
  7. data/lib/schematic/accounts/types/update_onboarding_state_request_body.rb +14 -0
  8. data/lib/schematic/accounts/types/update_onboarding_state_response.rb +12 -0
  9. data/lib/schematic/client.rb +1 -1
  10. data/lib/schematic/companies/client.rb +109 -3
  11. data/lib/schematic/companies/types/count_entity_traits_params.rb +15 -0
  12. data/lib/schematic/companies/types/count_entity_traits_request.rb +14 -0
  13. data/lib/schematic/companies/types/count_entity_traits_response.rb +12 -0
  14. data/lib/schematic/companies/types/delete_entity_trait_definition_response.rb +12 -0
  15. data/lib/schematic/companies/types/get_entity_trait_definition_usage_response.rb +12 -0
  16. data/lib/schematic/companies/types/list_plan_changes_params.rb +0 -1
  17. data/lib/schematic/companies/types/list_plan_changes_request.rb +0 -1
  18. data/lib/schematic/credits/types/create_credit_bundle_request_body.rb +1 -0
  19. data/lib/schematic/credits/types/update_credit_bundle_details_request_body.rb +1 -0
  20. data/lib/schematic/planbundle/client.rb +3 -3
  21. data/lib/schematic/planbundle/types/update_plan_bundle_request_body.rb +1 -1
  22. data/lib/schematic/plangroups/types/create_plan_group_request_body.rb +2 -0
  23. data/lib/schematic/plangroups/types/update_plan_group_request_body.rb +2 -0
  24. data/lib/schematic/planmigrations/types/create_migration_input.rb +4 -3
  25. data/lib/schematic/planmigrations/types/preview_migration_request_body.rb +2 -1
  26. data/lib/schematic/plans/client.rb +11 -9
  27. data/lib/schematic/plans/types/delete_plan_version_request.rb +1 -1
  28. data/lib/schematic/plans/types/list_custom_plan_billings_params.rb +1 -0
  29. data/lib/schematic/plans/types/list_custom_plan_billings_request.rb +1 -0
  30. data/lib/schematic/plans/types/publish_plan_version_request_body.rb +2 -1
  31. data/lib/schematic/plans/types/update_company_plans_request_body.rb +1 -1
  32. data/lib/schematic/types/billing_collection_method.rb +12 -0
  33. data/lib/schematic/types/billing_credit_bundle_response_data.rb +1 -0
  34. data/lib/schematic/types/billing_credit_bundle_view.rb +1 -0
  35. data/lib/schematic/types/billing_credit_grant_response_data.rb +2 -0
  36. data/lib/schematic/types/billing_plan_credit_grant_response_data.rb +1 -0
  37. data/lib/schematic/types/checkout_bundle_purchase_behavior.rb +12 -0
  38. data/lib/schematic/types/checkout_settings_response_data.rb +2 -0
  39. data/lib/schematic/types/company_billing_checkout_settings.rb +1 -0
  40. data/lib/schematic/types/company_feature_usage_export_metadata.rb +2 -0
  41. data/lib/schematic/types/company_plan_credit_grant_view.rb +1 -0
  42. data/lib/schematic/types/component_checkout_settings.rb +2 -0
  43. data/lib/schematic/types/create_billing_plan_credit_grant_request_body.rb +1 -0
  44. data/lib/schematic/types/credit_company_grant_view.rb +2 -0
  45. data/lib/schematic/types/custom_plan_billing_response_data.rb +2 -0
  46. data/lib/schematic/types/entity_trait_definition_usage.rb +14 -0
  47. data/lib/schematic/types/get_onboarding_state_resp.rb +14 -0
  48. data/lib/schematic/types/manage_plan_request.rb +7 -0
  49. data/lib/schematic/types/migration_proration_behavior.rb +12 -0
  50. data/lib/schematic/types/onboarding_milestone.rb +12 -0
  51. data/lib/schematic/types/onboarding_milestone_view.rb +12 -0
  52. data/lib/schematic/types/onboarding_path.rb +12 -0
  53. data/lib/schematic/types/onboarding_requirement.rb +16 -0
  54. data/lib/schematic/types/onboarding_requirement_status.rb +13 -0
  55. data/lib/schematic/types/onboarding_requirement_view.rb +12 -0
  56. data/lib/schematic/types/onboarding_track.rb +12 -0
  57. data/lib/schematic/types/plan_billing_source.rb +12 -0
  58. data/lib/schematic/types/plan_bundle_response_data.rb +1 -0
  59. data/lib/schematic/types/plan_credit_grant_view.rb +1 -0
  60. data/lib/schematic/types/plan_version_migration_preview_response_data.rb +1 -0
  61. data/lib/schematic/types/plan_version_migration_response_data.rb +1 -0
  62. data/lib/schematic/types/preview_subscription_finance_response_data.rb +1 -0
  63. data/lib/schematic/types/update_billing_plan_credit_grant_request_body.rb +1 -0
  64. data/lib/schematic/types/upsert_company_request_body.rb +1 -0
  65. data/lib/schematic/types/upsert_user_request_body.rb +1 -0
  66. data/lib/schematic/types/upsert_user_sub_request_body.rb +1 -0
  67. data/lib/schematic/types/who_am_i_response_data.rb +1 -0
  68. data/lib/schematic/version.rb +1 -1
  69. data/lib/schematic/wasm/rulesengine.wasm +0 -0
  70. data/lib/schematic.rb +21 -0
  71. data/reference.md +382 -25
  72. metadata +23 -2
@@ -4,7 +4,7 @@ module Schematic
4
4
  module Plans
5
5
  module Types
6
6
  class PublishPlanVersionRequestBody < Internal::Types::Model
7
- field :plan_id, -> { String }, optional: false, nullable: false
7
+ field :plan_version_id, -> { String }, optional: false, nullable: false
8
8
  field :activation_strategy, -> { Schematic::Types::CustomPlanActivationStrategy }, optional: true, nullable: false
9
9
  field :address, -> { Schematic::Types::CustomerBillingAddress }, optional: true, nullable: false
10
10
  field :coupon_external_id, -> { String }, optional: true, nullable: false
@@ -14,6 +14,7 @@ module Schematic
14
14
  field :excluded_company_ids, -> { Internal::Types::Array[String] }, optional: false, nullable: false
15
15
  field :migration_strategy, -> { Schematic::Types::PlanVersionMigrationStrategy }, optional: false, nullable: false
16
16
  field :phone, -> { String }, optional: true, nullable: false
17
+ field :proration_behavior, -> { Schematic::Types::MigrationProrationBehavior }, optional: true, nullable: false
17
18
  field :send_invoice, -> { Internal::Types::Boolean }, optional: true, nullable: false
18
19
  field :tax_id, -> { Schematic::Types::TaxIdInput }, optional: true, nullable: false
19
20
  end
@@ -4,7 +4,7 @@ module Schematic
4
4
  module Plans
5
5
  module Types
6
6
  class UpdateCompanyPlansRequestBody < Internal::Types::Model
7
- field :company_plan_id, -> { String }, optional: false, nullable: false
7
+ field :company_id, -> { String }, optional: false, nullable: false
8
8
  field :add_on_ids, -> { Internal::Types::Array[String] }, optional: false, nullable: false
9
9
  field :base_plan_id, -> { String }, optional: true, nullable: false
10
10
  end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Types
5
+ module BillingCollectionMethod
6
+ extend Schematic::Internal::Types::Enum
7
+
8
+ CHARGE_AUTOMATICALLY = "charge_automatically"
9
+ SEND_INVOICE = "send_invoice"
10
+ end
11
+ end
12
+ end
@@ -5,6 +5,7 @@ module Schematic
5
5
  class BillingCreditBundleResponseData < Internal::Types::Model
6
6
  field :billing_invoice_id, -> { String }, optional: true, nullable: false
7
7
  field :bundle_type, -> { String }, optional: false, nullable: false
8
+ field :compatible_plan_ids, -> { Internal::Types::Array[String] }, optional: false, nullable: false
8
9
  field :created_at, -> { String }, optional: false, nullable: false
9
10
  field :credit_description, -> { String }, optional: true, nullable: false
10
11
  field :credit_icon, -> { String }, optional: true, nullable: false
@@ -4,6 +4,7 @@ module Schematic
4
4
  module Types
5
5
  class BillingCreditBundleView < Internal::Types::Model
6
6
  field :bundle_type, -> { String }, optional: false, nullable: false
7
+ field :compatible_plan_ids, -> { Internal::Types::Array[String] }, optional: false, nullable: false
7
8
  field :created_at, -> { String }, optional: false, nullable: false
8
9
  field :credit_description, -> { String }, optional: true, nullable: false
9
10
  field :credit_icon, -> { String }, optional: true, nullable: false
@@ -4,6 +4,7 @@ module Schematic
4
4
  module Types
5
5
  class BillingCreditGrantResponseData < Internal::Types::Model
6
6
  field :company_id, -> { String }, optional: false, nullable: false
7
+ field :company_license_id, -> { String }, optional: true, nullable: false
7
8
  field :company_name, -> { String }, optional: false, nullable: false
8
9
  field :created_at, -> { String }, optional: false, nullable: false
9
10
  field :credit_icon, -> { String }, optional: true, nullable: false
@@ -13,6 +14,7 @@ module Schematic
13
14
  field :expires_at, -> { String }, optional: true, nullable: false
14
15
  field :grant_reason, -> { Schematic::Types::BillingCreditGrantReason }, optional: false, nullable: false
15
16
  field :id, -> { String }, optional: false, nullable: false
17
+ field :license_name, -> { String }, optional: true, nullable: false
16
18
  field :plan_id, -> { String }, optional: true, nullable: false
17
19
  field :plan_name, -> { String }, optional: true, nullable: false
18
20
  field :price, -> { Schematic::Types::BillingPriceResponseData }, optional: true, nullable: false
@@ -14,6 +14,7 @@ module Schematic
14
14
  field :auto_topup_threshold_credits, -> { Integer }, optional: true, nullable: false
15
15
  field :auto_topup_threshold_percent, -> { Integer }, optional: true, nullable: false
16
16
  field :can_buy_bundles, -> { Internal::Types::Boolean }, optional: false, nullable: false
17
+ field :company_credit_amount, -> { Integer }, optional: false, nullable: false
17
18
  field :created_at, -> { String }, optional: false, nullable: false
18
19
  field :credit, -> { Schematic::Types::BillingCreditResponseData }, optional: true, nullable: false
19
20
  field :credit_amount, -> { Integer }, optional: false, nullable: false
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Types
5
+ module CheckoutBundlePurchaseBehavior
6
+ extend Schematic::Internal::Types::Enum
7
+
8
+ INDIVIDUAL = "individual"
9
+ QUANTITY = "quantity"
10
+ end
11
+ end
12
+ end
@@ -3,9 +3,11 @@
3
3
  module Schematic
4
4
  module Types
5
5
  class CheckoutSettingsResponseData < Internal::Types::Model
6
+ field :bundle_purchase_behavior, -> { Schematic::Types::CheckoutBundlePurchaseBehavior }, optional: false, nullable: false
6
7
  field :collect_address, -> { Internal::Types::Boolean }, optional: false, nullable: false
7
8
  field :collect_email, -> { Internal::Types::Boolean }, optional: false, nullable: false
8
9
  field :collect_phone, -> { Internal::Types::Boolean }, optional: false, nullable: false
10
+ field :collect_tax_id, -> { Internal::Types::Boolean }, optional: false, nullable: false
9
11
  field :opt_in_enabled, -> { Internal::Types::Boolean }, optional: false, nullable: false
10
12
  field :opt_in_text, -> { String }, optional: true, nullable: false
11
13
  field :opt_in_title, -> { String }, optional: true, nullable: false
@@ -6,6 +6,7 @@ module Schematic
6
6
  field :collect_address, -> { Internal::Types::Boolean }, optional: false, nullable: false
7
7
  field :collect_email, -> { Internal::Types::Boolean }, optional: false, nullable: false
8
8
  field :collect_phone, -> { Internal::Types::Boolean }, optional: false, nullable: false
9
+ field :collect_tax_id, -> { Internal::Types::Boolean }, optional: false, nullable: false
9
10
  end
10
11
  end
11
12
  end
@@ -5,6 +5,8 @@ module Schematic
5
5
  class CompanyFeatureUsageExportMetadata < Internal::Types::Model
6
6
  field :company_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
7
7
  field :credit_type_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
8
+ field :entity_key_definition_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
9
+ field :entity_trait_definition_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
8
10
  field :feature_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
9
11
  field :has_scheduled_downgrade, -> { Internal::Types::Boolean }, optional: true, nullable: false
10
12
  field :monetized_subscriptions, -> { Internal::Types::Boolean }, optional: true, nullable: false
@@ -17,6 +17,7 @@ module Schematic
17
17
  field :company_auto_topup_amount, -> { Integer }, optional: true, nullable: false
18
18
  field :company_auto_topup_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
19
19
  field :company_auto_topup_threshold_credits, -> { Integer }, optional: true, nullable: false
20
+ field :company_credit_amount, -> { Integer }, optional: false, nullable: false
20
21
  field :created_at, -> { String }, optional: false, nullable: false
21
22
  field :credit, -> { Schematic::Types::BillingCreditView }, optional: true, nullable: false
22
23
  field :credit_amount, -> { Integer }, optional: false, nullable: false
@@ -3,9 +3,11 @@
3
3
  module Schematic
4
4
  module Types
5
5
  class ComponentCheckoutSettings < Internal::Types::Model
6
+ field :bundle_purchase_behavior, -> { Schematic::Types::CheckoutBundlePurchaseBehavior }, optional: false, nullable: false
6
7
  field :collect_address, -> { Internal::Types::Boolean }, optional: false, nullable: false
7
8
  field :collect_email, -> { Internal::Types::Boolean }, optional: false, nullable: false
8
9
  field :collect_phone, -> { Internal::Types::Boolean }, optional: false, nullable: false
10
+ field :collect_tax_id, -> { Internal::Types::Boolean }, optional: false, nullable: false
9
11
  field :proration_behavior, -> { Schematic::Types::ProrationBehavior }, optional: false, nullable: false
10
12
  field :tax_collection_enabled, -> { Internal::Types::Boolean }, optional: false, nullable: false
11
13
  end
@@ -15,6 +15,7 @@ module Schematic
15
15
  field :auto_topup_threshold_credits, -> { Integer }, optional: true, nullable: false
16
16
  field :auto_topup_threshold_percent, -> { Integer }, optional: true, nullable: false
17
17
  field :can_buy_bundles, -> { Internal::Types::Boolean }, optional: true, nullable: false
18
+ field :company_credit_amount, -> { Integer }, optional: true, nullable: false
18
19
  field :credit_amount, -> { Integer }, optional: false, nullable: false
19
20
  field :credit_id, -> { String }, optional: false, nullable: false
20
21
  field :expiry_type, -> { Schematic::Types::BillingCreditExpiryType }, optional: true, nullable: false
@@ -6,6 +6,7 @@ module Schematic
6
6
  field :billing_credit_bundle_id, -> { String }, optional: true, nullable: false
7
7
  field :billing_credit_id, -> { String }, optional: false, nullable: false
8
8
  field :company_id, -> { String }, optional: false, nullable: false
9
+ field :company_license_id, -> { String }, optional: true, nullable: false
9
10
  field :company_name, -> { String }, optional: false, nullable: false
10
11
  field :created_at, -> { String }, optional: false, nullable: false
11
12
  field :credit_description, -> { String }, optional: false, nullable: false
@@ -19,6 +20,7 @@ module Schematic
19
20
  field :expiry_unit_count, -> { Integer }, optional: true, nullable: false
20
21
  field :grant_reason, -> { Schematic::Types::BillingCreditGrantReason }, optional: false, nullable: false
21
22
  field :id, -> { String }, optional: false, nullable: false
23
+ field :license_name, -> { String }, optional: true, nullable: false
22
24
  field :plan_id, -> { String }, optional: true, nullable: false
23
25
  field :plan_name, -> { String }, optional: true, nullable: false
24
26
  field :plural_name, -> { String }, optional: true, nullable: false
@@ -4,12 +4,14 @@ module Schematic
4
4
  module Types
5
5
  class CustomPlanBillingResponseData < Internal::Types::Model
6
6
  field :activation_strategy, -> { Schematic::Types::CustomPlanActivationStrategy }, optional: false, nullable: false
7
+ field :billing_cycle_anchor, -> { String }, optional: true, nullable: false
7
8
  field :company_id, -> { String }, optional: false, nullable: false
8
9
  field :created_at, -> { String }, optional: false, nullable: false
9
10
  field :days_until_due, -> { Integer }, optional: false, nullable: false
10
11
  field :external_invoice_id, -> { String }, optional: true, nullable: false
11
12
  field :id, -> { String }, optional: false, nullable: false
12
13
  field :paid_at, -> { String }, optional: true, nullable: false
14
+ field :plan_billing_source, -> { Schematic::Types::PlanBillingSource }, optional: false, nullable: false
13
15
  field :plan_id, -> { String }, optional: false, nullable: false
14
16
  field :published_at, -> { String }, optional: true, nullable: false
15
17
  field :send_invoice, -> { Internal::Types::Boolean }, optional: false, nullable: false
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Types
5
+ class EntityTraitDefinitionUsage < Internal::Types::Model
6
+ field :checkout_field_config_count, -> { Integer }, optional: false, nullable: false
7
+ field :company_override_count, -> { Integer }, optional: false, nullable: false
8
+ field :feature_count, -> { Integer }, optional: false, nullable: false
9
+ field :plan_entitlement_count, -> { Integer }, optional: false, nullable: false
10
+ field :plan_trait_count, -> { Integer }, optional: false, nullable: false
11
+ field :rule_condition_count, -> { Integer }, optional: false, nullable: false
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Types
5
+ class GetOnboardingStateResp < Internal::Types::Model
6
+ field :environment_id, -> { String }, optional: true, nullable: false
7
+ field :milestones, -> { Internal::Types::Array[Schematic::Types::OnboardingMilestoneView] }, optional: false, nullable: false
8
+ field :path, -> { Schematic::Types::OnboardingPath }, optional: true, nullable: false
9
+ field :requirements, -> { Internal::Types::Array[Schematic::Types::OnboardingRequirementView] }, optional: false, nullable: false
10
+ field :suggested_next, -> { Internal::Types::Array[Schematic::Types::OnboardingRequirement] }, optional: false, nullable: false
11
+ field :track, -> { Schematic::Types::OnboardingTrack }, optional: true, nullable: false
12
+ end
13
+ end
14
+ end
@@ -3,20 +3,27 @@
3
3
  module Schematic
4
4
  module Types
5
5
  class ManagePlanRequest < Internal::Types::Model
6
+ field :activate_on_payment, -> { Internal::Types::Boolean }, optional: true, nullable: false
6
7
  field :add_on_selections, -> { Internal::Types::Array[Schematic::Types::PlanSelection] }, optional: false, nullable: false
7
8
  field :base_plan_id, -> { String }, optional: true, nullable: false
8
9
  field :base_plan_price_id, -> { String }, optional: true, nullable: false
9
10
  field :base_plan_version_id, -> { String }, optional: true, nullable: false
11
+ field :billing_cycle_anchor, -> { String }, optional: true, nullable: false
12
+ field :billing_email, -> { String }, optional: true, nullable: false
10
13
  field :billing_entity_id, -> { String }, optional: true, nullable: false
11
14
  field :cancel_immediately, -> { Internal::Types::Boolean }, optional: true, nullable: false
15
+ field :collection_method, -> { Schematic::Types::BillingCollectionMethod }, optional: true, nullable: false
12
16
  field :company_id, -> { String }, optional: false, nullable: false
13
17
  field :coupon_external_id, -> { String }, optional: true, nullable: false
14
18
  field :credit_bundles, -> { Internal::Types::Array[Schematic::Types::UpdateCreditBundleRequestBody] }, optional: false, nullable: false
15
19
  field :custom_field_values, -> { Internal::Types::Array[Schematic::Types::CheckoutFieldValue] }, optional: false, nullable: false
20
+ field :days_until_due, -> { Integer }, optional: true, nullable: false
16
21
  field :pay_in_advance_entitlements, -> { Internal::Types::Array[Schematic::Types::UpdatePayInAdvanceRequestBody] }, optional: false, nullable: false
17
22
  field :payment_method_external_id, -> { String }, optional: true, nullable: false
18
23
  field :promo_code, -> { String }, optional: true, nullable: false
19
24
  field :prorate, -> { Internal::Types::Boolean }, optional: true, nullable: false
25
+ field :prorate_first_period, -> { Internal::Types::Boolean }, optional: true, nullable: false
26
+ field :send_invoice, -> { Internal::Types::Boolean }, optional: true, nullable: false
20
27
  field :trial_end, -> { String }, optional: true, nullable: false
21
28
  end
22
29
  end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Types
5
+ module MigrationProrationBehavior
6
+ extend Schematic::Internal::Types::Enum
7
+
8
+ ALWAYS_INVOICE = "always_invoice"
9
+ CREATE_PRORATIONS = "create_prorations"
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Types
5
+ module OnboardingMilestone
6
+ extend Schematic::Internal::Types::Enum
7
+
8
+ EVALUATED = "evaluated"
9
+ IMPLEMENTED = "implemented"
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Types
5
+ class OnboardingMilestoneView < Internal::Types::Model
6
+ field :id, -> { Schematic::Types::OnboardingMilestone }, optional: false, nullable: false
7
+ field :missing, -> { Internal::Types::Array[Schematic::Types::OnboardingRequirement] }, optional: false, nullable: false
8
+ field :progress, -> { Integer }, optional: false, nullable: false
9
+ field :reached_at, -> { String }, optional: true, nullable: false
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Types
5
+ module OnboardingPath
6
+ extend Schematic::Internal::Types::Enum
7
+
8
+ AGENT = "agent"
9
+ APP = "app"
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Types
5
+ module OnboardingRequirement
6
+ extend Schematic::Internal::Types::Enum
7
+
8
+ CONNECT_BILLING = "connect_billing"
9
+ CREATE_API_KEY = "create_api_key"
10
+ FIRST_FLAG_CHECK = "first_flag_check"
11
+ IMPORT_COMPANIES = "import_companies"
12
+ MODEL_PACKAGING = "model_packaging"
13
+ SEND_EVENTS = "send_events"
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Types
5
+ module OnboardingRequirementStatus
6
+ extend Schematic::Internal::Types::Enum
7
+
8
+ AVAILABLE = "available"
9
+ BLOCKED = "blocked"
10
+ COMPLETE = "complete"
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Types
5
+ class OnboardingRequirementView < Internal::Types::Model
6
+ field :blocked_by, -> { Internal::Types::Array[Schematic::Types::OnboardingRequirement] }, optional: true, nullable: false
7
+ field :id, -> { Schematic::Types::OnboardingRequirement }, optional: false, nullable: false
8
+ field :satisfied_by, -> { String }, optional: true, nullable: false
9
+ field :status, -> { Schematic::Types::OnboardingRequirementStatus }, optional: false, nullable: false
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Types
5
+ module OnboardingTrack
6
+ extend Schematic::Internal::Types::Enum
7
+
8
+ CATALOG = "catalog"
9
+ SINGLE_PLAN = "single_plan"
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Types
5
+ module PlanBillingSource
6
+ extend Schematic::Internal::Types::Enum
7
+
8
+ CUSTOM_PLAN = "custom_plan"
9
+ MANAGE_PLAN = "manage_plan"
10
+ end
11
+ end
12
+ end
@@ -7,6 +7,7 @@ module Schematic
7
7
  field :credit_grants, -> { Internal::Types::Array[Schematic::Types::BillingPlanCreditGrantResponseData] }, optional: true, nullable: false
8
8
  field :entitlements, -> { Internal::Types::Array[Schematic::Types::PlanEntitlementResponseData] }, optional: true, nullable: false
9
9
  field :plan, -> { Schematic::Types::PlanResponseData }, optional: true, nullable: false
10
+ field :plan_version, -> { Schematic::Types::PlanVersionResponseData }, optional: true, nullable: false
10
11
  end
11
12
  end
12
13
  end
@@ -14,6 +14,7 @@ module Schematic
14
14
  field :billing_credit_auto_topup_threshold_credits, -> { Integer }, optional: true, nullable: false
15
15
  field :billing_credit_auto_topup_threshold_percent, -> { Integer }, optional: true, nullable: false
16
16
  field :billing_credit_can_buy_bundles, -> { Internal::Types::Boolean }, optional: false, nullable: false
17
+ field :company_credit_amount, -> { Integer }, optional: false, nullable: false
17
18
  field :created_at, -> { String }, optional: false, nullable: false
18
19
  field :credit, -> { Schematic::Types::BillingCreditView }, optional: true, nullable: false
19
20
  field :credit_amount, -> { Integer }, optional: false, nullable: false
@@ -4,6 +4,7 @@ module Schematic
4
4
  module Types
5
5
  class PlanVersionMigrationPreviewResponseData < Internal::Types::Model
6
6
  field :companies, -> { Internal::Types::Array[Schematic::Types::PlanVersionMigrationPreviewCompanyResponseData] }, optional: false, nullable: false
7
+ field :has_billing_changes, -> { Internal::Types::Boolean }, optional: false, nullable: false
7
8
  end
8
9
  end
9
10
  end
@@ -13,6 +13,7 @@ module Schematic
13
13
  field :plan_version_id_from, -> { String }, optional: true, nullable: false
14
14
  field :plan_version_id_to, -> { String }, optional: false, nullable: false
15
15
  field :plan_version_ids_from, -> { Internal::Types::Array[String] }, optional: false, nullable: false
16
+ field :proration_behavior, -> { Schematic::Types::MigrationProrationBehavior }, optional: true, nullable: false
16
17
  field :skipped_companies, -> { Integer }, optional: false, nullable: false
17
18
  field :started_at, -> { String }, optional: true, nullable: false
18
19
  field :status, -> { Schematic::Types::PlanVersionMigrationStatus }, optional: false, nullable: false
@@ -4,6 +4,7 @@ module Schematic
4
4
  module Types
5
5
  class PreviewSubscriptionFinanceResponseData < Internal::Types::Model
6
6
  field :amount_off, -> { Integer }, optional: false, nullable: false
7
+ field :discount_amount, -> { Integer }, optional: false, nullable: false
7
8
  field :discounts, -> { Internal::Types::Array[Schematic::Types::PreviewSubscriptionDiscountResponseData] }, optional: false, nullable: false
8
9
  field :due_now, -> { Integer }, optional: false, nullable: false
9
10
  field :new_charges, -> { Integer }, optional: false, nullable: false
@@ -15,6 +15,7 @@ module Schematic
15
15
  field :auto_topup_threshold_credits, -> { Integer }, optional: true, nullable: false
16
16
  field :auto_topup_threshold_percent, -> { Integer }, optional: true, nullable: false
17
17
  field :can_buy_bundles, -> { Internal::Types::Boolean }, optional: true, nullable: false
18
+ field :company_credit_amount, -> { Integer }, optional: true, nullable: false
18
19
  field :credit_amount, -> { Integer }, optional: true, nullable: false
19
20
  field :expiry_type, -> { Schematic::Types::BillingCreditExpiryType }, optional: true, nullable: false
20
21
  field :expiry_unit, -> { Schematic::Types::BillingCreditExpiryUnit }, optional: true, nullable: false
@@ -10,6 +10,7 @@ module Schematic
10
10
  field :last_seen_at, -> { String }, optional: true, nullable: false
11
11
  field :name, -> { String }, optional: true, nullable: false
12
12
  field :prevent_key_remap, -> { Internal::Types::Boolean }, optional: true, nullable: false
13
+ field :remove_keys, -> { Internal::Types::Array[String] }, optional: true, nullable: false
13
14
  field :traits, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
14
15
  field :update_only, -> { Internal::Types::Boolean }, optional: true, nullable: false
15
16
  end
@@ -11,6 +11,7 @@ module Schematic
11
11
  field :keys, -> { Internal::Types::Hash[String, String] }, optional: false, nullable: false
12
12
  field :last_seen_at, -> { String }, optional: true, nullable: false
13
13
  field :name, -> { String }, optional: true, nullable: false
14
+ field :remove_keys, -> { Internal::Types::Array[String] }, optional: true, nullable: false
14
15
  field :traits, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
15
16
  field :update_only, -> { Internal::Types::Boolean }, optional: true, nullable: false
16
17
  end
@@ -9,6 +9,7 @@ module Schematic
9
9
  field :keys, -> { Internal::Types::Hash[String, String] }, optional: false, nullable: false
10
10
  field :last_seen_at, -> { String }, optional: true, nullable: false
11
11
  field :name, -> { String }, optional: true, nullable: false
12
+ field :remove_keys, -> { Internal::Types::Array[String] }, optional: true, nullable: false
12
13
  field :traits, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
13
14
  field :update_only, -> { Internal::Types::Boolean }, optional: true, nullable: false
14
15
  end
@@ -9,6 +9,7 @@ module Schematic
9
9
  field :api_key_id, -> { String }, optional: true, nullable: false
10
10
  field :environment_id, -> { String }, optional: true, nullable: false
11
11
  field :environments, -> { Internal::Types::Array[Schematic::Types::EnvironmentResponseData] }, optional: false, nullable: false
12
+ field :onboarding_complete, -> { Internal::Types::Boolean }, optional: false, nullable: false
12
13
  field :stripe_user_id, -> { String }, optional: true, nullable: false
13
14
  field :user_id, -> { String }, optional: true, nullable: false
14
15
  field :user_name, -> { String }, optional: true, nullable: false
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Schematic
4
- VERSION = "1.4.13"
4
+ VERSION = "1.4.14"
5
5
  end
Binary file
data/lib/schematic.rb CHANGED
@@ -76,6 +76,16 @@ require_relative "schematic/accounts/types/create_environment_response"
76
76
  require_relative "schematic/accounts/types/get_environment_response"
77
77
  require_relative "schematic/accounts/types/update_environment_response"
78
78
  require_relative "schematic/accounts/types/delete_environment_response"
79
+ require_relative "schematic/types/onboarding_milestone"
80
+ require_relative "schematic/types/onboarding_requirement"
81
+ require_relative "schematic/types/onboarding_milestone_view"
82
+ require_relative "schematic/types/onboarding_path"
83
+ require_relative "schematic/types/onboarding_requirement_status"
84
+ require_relative "schematic/types/onboarding_requirement_view"
85
+ require_relative "schematic/types/onboarding_track"
86
+ require_relative "schematic/types/get_onboarding_state_resp"
87
+ require_relative "schematic/accounts/types/get_onboarding_state_response"
88
+ require_relative "schematic/accounts/types/update_onboarding_state_response"
79
89
  require_relative "schematic/types/quickstart_resp"
80
90
  require_relative "schematic/accounts/types/quickstart_response"
81
91
  require_relative "schematic/types/who_am_i_response_data"
@@ -286,6 +296,7 @@ require_relative "schematic/types/condition"
286
296
  require_relative "schematic/types/condition_group"
287
297
  require_relative "schematic/types/custom_plan_activation_strategy"
288
298
  require_relative "schematic/types/custom_plan_billing_status"
299
+ require_relative "schematic/types/plan_billing_source"
289
300
  require_relative "schematic/types/custom_plan_billing_response_data"
290
301
  require_relative "schematic/types/entity_key_definition_response_data"
291
302
  require_relative "schematic/types/entity_key_detail_response_data"
@@ -366,11 +377,16 @@ require_relative "schematic/companies/types/list_entity_trait_definitions_respon
366
377
  require_relative "schematic/companies/types/get_or_create_entity_trait_definition_response"
367
378
  require_relative "schematic/companies/types/get_entity_trait_definition_response"
368
379
  require_relative "schematic/companies/types/update_entity_trait_definition_response"
380
+ require_relative "schematic/companies/types/delete_entity_trait_definition_response"
381
+ require_relative "schematic/types/entity_trait_definition_usage"
382
+ require_relative "schematic/companies/types/get_entity_trait_definition_usage_response"
369
383
  require_relative "schematic/companies/types/count_entity_trait_definitions_params"
370
384
  require_relative "schematic/companies/types/count_entity_trait_definitions_response"
371
385
  require_relative "schematic/companies/types/get_entity_trait_values_params"
372
386
  require_relative "schematic/types/entity_trait_value"
373
387
  require_relative "schematic/companies/types/get_entity_trait_values_response"
388
+ require_relative "schematic/companies/types/count_entity_traits_params"
389
+ require_relative "schematic/companies/types/count_entity_traits_response"
374
390
  require_relative "schematic/types/plan_change_action"
375
391
  require_relative "schematic/types/plan_change_base_plan_action"
376
392
  require_relative "schematic/companies/types/list_plan_changes_params"
@@ -503,6 +519,7 @@ require_relative "schematic/components/types/preview_component_data_params"
503
519
  require_relative "schematic/types/billing_product_price_response_data"
504
520
  require_relative "schematic/types/credit_bundle_currency_price"
505
521
  require_relative "schematic/types/billing_credit_bundle_view"
522
+ require_relative "schematic/types/checkout_bundle_purchase_behavior"
506
523
  require_relative "schematic/types/company_plan_invalid_reason"
507
524
  require_relative "schematic/types/custom_plan_config"
508
525
  require_relative "schematic/types/plan_credit_grant_view"
@@ -656,6 +673,7 @@ require_relative "schematic/planmigrations/types/count_company_migrations_params
656
673
  require_relative "schematic/planmigrations/types/count_company_migrations_response"
657
674
  require_relative "schematic/types/plan_version_migration_status"
658
675
  require_relative "schematic/planmigrations/types/list_migrations_params"
676
+ require_relative "schematic/types/migration_proration_behavior"
659
677
  require_relative "schematic/types/plan_version_migration_strategy"
660
678
  require_relative "schematic/types/plan_version_migration_response_data"
661
679
  require_relative "schematic/planmigrations/types/list_migrations_response"
@@ -703,6 +721,7 @@ require_relative "schematic/webhooks/types/send_test_webhook_action_response"
703
721
  require_relative "schematic/webhooks/types/count_webhooks_params"
704
722
  require_relative "schematic/webhooks/types/count_webhooks_response"
705
723
  require_relative "schematic/types/api_error"
724
+ require_relative "schematic/types/billing_collection_method"
706
725
  require_relative "schematic/types/billing_product_pricing"
707
726
  require_relative "schematic/types/billing_subscription_discount"
708
727
  require_relative "schematic/types/capture_raw_event"
@@ -839,6 +858,7 @@ require_relative "schematic/accounts/types/count_audit_logs_request"
839
858
  require_relative "schematic/accounts/types/list_environments_request"
840
859
  require_relative "schematic/accounts/types/create_environment_request_body"
841
860
  require_relative "schematic/accounts/types/update_environment_request_body"
861
+ require_relative "schematic/accounts/types/update_onboarding_state_request_body"
842
862
  require_relative "schematic/billing/client"
843
863
  require_relative "schematic/billing/types/list_coupons_request"
844
864
  require_relative "schematic/billing/types/create_coupon_request_body"
@@ -909,6 +929,7 @@ require_relative "schematic/companies/types/create_entity_trait_definition_reque
909
929
  require_relative "schematic/companies/types/update_entity_trait_definition_request_body"
910
930
  require_relative "schematic/companies/types/count_entity_trait_definitions_request"
911
931
  require_relative "schematic/companies/types/get_entity_trait_values_request"
932
+ require_relative "schematic/companies/types/count_entity_traits_request"
912
933
  require_relative "schematic/companies/types/list_plan_changes_request"
913
934
  require_relative "schematic/companies/types/list_plan_traits_request"
914
935
  require_relative "schematic/companies/types/update_plan_trait_bulk_request_body"