schematichq 1.4.12 → 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 (87) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +2 -2
  3. data/.fern/replay.lock +15 -3
  4. data/README.md +1 -1
  5. data/WASM_VERSION +1 -1
  6. data/lib/schematic/accounts/client.rb +63 -0
  7. data/lib/schematic/accounts/types/get_onboarding_state_response.rb +12 -0
  8. data/lib/schematic/accounts/types/update_onboarding_state_request_body.rb +14 -0
  9. data/lib/schematic/accounts/types/update_onboarding_state_response.rb +12 -0
  10. data/lib/schematic/client.rb +1 -1
  11. data/lib/schematic/companies/client.rb +185 -3
  12. data/lib/schematic/companies/types/count_entity_keys_params.rb +15 -0
  13. data/lib/schematic/companies/types/count_entity_keys_request.rb +14 -0
  14. data/lib/schematic/companies/types/count_entity_keys_response.rb +12 -0
  15. data/lib/schematic/companies/types/count_entity_traits_params.rb +15 -0
  16. data/lib/schematic/companies/types/count_entity_traits_request.rb +14 -0
  17. data/lib/schematic/companies/types/count_entity_traits_response.rb +12 -0
  18. data/lib/schematic/companies/types/delete_entity_key_definition_response.rb +12 -0
  19. data/lib/schematic/companies/types/delete_entity_trait_definition_response.rb +12 -0
  20. data/lib/schematic/companies/types/get_entity_trait_definition_usage_response.rb +12 -0
  21. data/lib/schematic/companies/types/list_plan_changes_params.rb +0 -1
  22. data/lib/schematic/companies/types/list_plan_changes_request.rb +0 -1
  23. data/lib/schematic/credits/types/create_credit_bundle_request_body.rb +1 -0
  24. data/lib/schematic/credits/types/update_credit_bundle_details_request_body.rb +1 -0
  25. data/lib/schematic/planbundle/client.rb +3 -3
  26. data/lib/schematic/planbundle/types/update_plan_bundle_request_body.rb +1 -1
  27. data/lib/schematic/plangroups/types/create_plan_group_request_body.rb +2 -0
  28. data/lib/schematic/plangroups/types/update_plan_group_request_body.rb +2 -0
  29. data/lib/schematic/planmigrations/types/create_migration_input.rb +4 -3
  30. data/lib/schematic/planmigrations/types/preview_migration_request_body.rb +2 -1
  31. data/lib/schematic/plans/client.rb +11 -9
  32. data/lib/schematic/plans/types/delete_plan_version_request.rb +1 -1
  33. data/lib/schematic/plans/types/list_custom_plan_billings_params.rb +1 -0
  34. data/lib/schematic/plans/types/list_custom_plan_billings_request.rb +1 -0
  35. data/lib/schematic/plans/types/publish_plan_version_request_body.rb +2 -1
  36. data/lib/schematic/plans/types/update_company_plans_request_body.rb +1 -1
  37. data/lib/schematic/types/billing_collection_method.rb +12 -0
  38. data/lib/schematic/types/billing_credit_bundle_response_data.rb +1 -0
  39. data/lib/schematic/types/billing_credit_bundle_view.rb +1 -0
  40. data/lib/schematic/types/billing_credit_grant_response_data.rb +2 -0
  41. data/lib/schematic/types/billing_credit_view.rb +1 -1
  42. data/lib/schematic/types/billing_plan_credit_grant_response_data.rb +1 -0
  43. data/lib/schematic/types/billing_product_record_response_data.rb +17 -0
  44. data/lib/schematic/types/checkout_bundle_purchase_behavior.rb +12 -0
  45. data/lib/schematic/types/checkout_settings_response_data.rb +2 -0
  46. data/lib/schematic/types/company_billing_checkout_settings.rb +1 -0
  47. data/lib/schematic/types/company_feature_usage_export_metadata.rb +6 -1
  48. data/lib/schematic/types/company_feature_usage_export_metadata_sort_order_direction.rb +12 -0
  49. data/lib/schematic/types/company_feature_usage_export_metadata_visible_columns_item.rb +14 -0
  50. data/lib/schematic/types/company_plan_credit_grant_view.rb +1 -0
  51. data/lib/schematic/types/component_checkout_settings.rb +2 -0
  52. data/lib/schematic/types/create_billing_plan_credit_grant_request_body.rb +1 -0
  53. data/lib/schematic/types/credit_company_grant_view.rb +2 -0
  54. data/lib/schematic/types/custom_plan_billing_response_data.rb +2 -0
  55. data/lib/schematic/types/data_export_metadata.rb +1 -0
  56. data/lib/schematic/types/data_export_type.rb +1 -0
  57. data/lib/schematic/types/entity_trait_definition_usage.rb +14 -0
  58. data/lib/schematic/types/event_export_metadata.rb +16 -0
  59. data/lib/schematic/types/event_export_metadata_event_types_item.rb +14 -0
  60. data/lib/schematic/types/feature_view.rb +1 -1
  61. data/lib/schematic/types/get_onboarding_state_resp.rb +14 -0
  62. data/lib/schematic/types/manage_plan_request.rb +7 -0
  63. data/lib/schematic/types/migration_proration_behavior.rb +12 -0
  64. data/lib/schematic/types/onboarding_milestone.rb +12 -0
  65. data/lib/schematic/types/onboarding_milestone_view.rb +12 -0
  66. data/lib/schematic/types/onboarding_path.rb +12 -0
  67. data/lib/schematic/types/onboarding_requirement.rb +16 -0
  68. data/lib/schematic/types/onboarding_requirement_status.rb +13 -0
  69. data/lib/schematic/types/onboarding_requirement_view.rb +12 -0
  70. data/lib/schematic/types/onboarding_track.rb +12 -0
  71. data/lib/schematic/types/plan_billing_source.rb +12 -0
  72. data/lib/schematic/types/plan_bundle_response_data.rb +1 -0
  73. data/lib/schematic/types/plan_credit_grant_view.rb +1 -0
  74. data/lib/schematic/types/plan_version_migration_preview_response_data.rb +1 -0
  75. data/lib/schematic/types/plan_version_migration_response_data.rb +1 -0
  76. data/lib/schematic/types/preview_subscription_finance_response_data.rb +1 -0
  77. data/lib/schematic/types/test_webhook_response_data.rb +1 -0
  78. data/lib/schematic/types/update_billing_plan_credit_grant_request_body.rb +1 -0
  79. data/lib/schematic/types/upsert_company_request_body.rb +1 -0
  80. data/lib/schematic/types/upsert_user_request_body.rb +1 -0
  81. data/lib/schematic/types/upsert_user_sub_request_body.rb +1 -0
  82. data/lib/schematic/types/who_am_i_response_data.rb +1 -0
  83. data/lib/schematic/version.rb +1 -1
  84. data/lib/schematic/wasm/rulesengine.wasm +0 -0
  85. data/lib/schematic.rb +30 -0
  86. data/reference.md +507 -25
  87. metadata +32 -2
@@ -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
@@ -3,6 +3,7 @@
3
3
  module Schematic
4
4
  module Types
5
5
  class TestWebhookResponseData < Internal::Types::Model
6
+ field :failure_reason, -> { String }, optional: true, nullable: false
6
7
  field :response_code, -> { Integer }, optional: false, nullable: false
7
8
  field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
8
9
  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: 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.12"
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"
@@ -269,6 +279,7 @@ require_relative "schematic/catalogs/types/get_plans_in_catalog_response"
269
279
  require_relative "schematic/types/checkout_subscription"
270
280
  require_relative "schematic/checkout/types/checkout_internal_response"
271
281
  require_relative "schematic/types/billing_credit_ledger_authority"
282
+ require_relative "schematic/types/billing_product_record_response_data"
272
283
  require_relative "schematic/types/credit_currency_price"
273
284
  require_relative "schematic/types/billing_credit_view"
274
285
  require_relative "schematic/types/billing_product_for_subscription_response_data"
@@ -285,6 +296,7 @@ require_relative "schematic/types/condition"
285
296
  require_relative "schematic/types/condition_group"
286
297
  require_relative "schematic/types/custom_plan_activation_strategy"
287
298
  require_relative "schematic/types/custom_plan_billing_status"
299
+ require_relative "schematic/types/plan_billing_source"
288
300
  require_relative "schematic/types/custom_plan_billing_response_data"
289
301
  require_relative "schematic/types/entity_key_definition_response_data"
290
302
  require_relative "schematic/types/entity_key_detail_response_data"
@@ -355,18 +367,26 @@ require_relative "schematic/companies/types/get_active_company_subscription_resp
355
367
  require_relative "schematic/companies/types/upsert_company_trait_response"
356
368
  require_relative "schematic/companies/types/list_entity_key_definitions_params"
357
369
  require_relative "schematic/companies/types/list_entity_key_definitions_response"
370
+ require_relative "schematic/companies/types/delete_entity_key_definition_response"
358
371
  require_relative "schematic/companies/types/count_entity_key_definitions_params"
359
372
  require_relative "schematic/companies/types/count_entity_key_definitions_response"
373
+ require_relative "schematic/companies/types/count_entity_keys_params"
374
+ require_relative "schematic/companies/types/count_entity_keys_response"
360
375
  require_relative "schematic/companies/types/list_entity_trait_definitions_params"
361
376
  require_relative "schematic/companies/types/list_entity_trait_definitions_response"
362
377
  require_relative "schematic/companies/types/get_or_create_entity_trait_definition_response"
363
378
  require_relative "schematic/companies/types/get_entity_trait_definition_response"
364
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"
365
383
  require_relative "schematic/companies/types/count_entity_trait_definitions_params"
366
384
  require_relative "schematic/companies/types/count_entity_trait_definitions_response"
367
385
  require_relative "schematic/companies/types/get_entity_trait_values_params"
368
386
  require_relative "schematic/types/entity_trait_value"
369
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"
370
390
  require_relative "schematic/types/plan_change_action"
371
391
  require_relative "schematic/types/plan_change_base_plan_action"
372
392
  require_relative "schematic/companies/types/list_plan_changes_params"
@@ -499,6 +519,7 @@ require_relative "schematic/components/types/preview_component_data_params"
499
519
  require_relative "schematic/types/billing_product_price_response_data"
500
520
  require_relative "schematic/types/credit_bundle_currency_price"
501
521
  require_relative "schematic/types/billing_credit_bundle_view"
522
+ require_relative "schematic/types/checkout_bundle_purchase_behavior"
502
523
  require_relative "schematic/types/company_plan_invalid_reason"
503
524
  require_relative "schematic/types/custom_plan_config"
504
525
  require_relative "schematic/types/plan_credit_grant_view"
@@ -521,7 +542,11 @@ require_relative "schematic/types/data_export_status"
521
542
  require_relative "schematic/types/data_export_type"
522
543
  require_relative "schematic/dataexports/types/list_data_exports_params"
523
544
  require_relative "schematic/types/audit_log_export_metadata"
545
+ require_relative "schematic/types/company_feature_usage_export_metadata_sort_order_direction"
546
+ require_relative "schematic/types/company_feature_usage_export_metadata_visible_columns_item"
524
547
  require_relative "schematic/types/company_feature_usage_export_metadata"
548
+ require_relative "schematic/types/event_export_metadata_event_types_item"
549
+ require_relative "schematic/types/event_export_metadata"
525
550
  require_relative "schematic/types/data_export_metadata"
526
551
  require_relative "schematic/types/data_export_output_file_type"
527
552
  require_relative "schematic/types/data_export_response_data"
@@ -648,6 +673,7 @@ require_relative "schematic/planmigrations/types/count_company_migrations_params
648
673
  require_relative "schematic/planmigrations/types/count_company_migrations_response"
649
674
  require_relative "schematic/types/plan_version_migration_status"
650
675
  require_relative "schematic/planmigrations/types/list_migrations_params"
676
+ require_relative "schematic/types/migration_proration_behavior"
651
677
  require_relative "schematic/types/plan_version_migration_strategy"
652
678
  require_relative "schematic/types/plan_version_migration_response_data"
653
679
  require_relative "schematic/planmigrations/types/list_migrations_response"
@@ -695,6 +721,7 @@ require_relative "schematic/webhooks/types/send_test_webhook_action_response"
695
721
  require_relative "schematic/webhooks/types/count_webhooks_params"
696
722
  require_relative "schematic/webhooks/types/count_webhooks_response"
697
723
  require_relative "schematic/types/api_error"
724
+ require_relative "schematic/types/billing_collection_method"
698
725
  require_relative "schematic/types/billing_product_pricing"
699
726
  require_relative "schematic/types/billing_subscription_discount"
700
727
  require_relative "schematic/types/capture_raw_event"
@@ -831,6 +858,7 @@ require_relative "schematic/accounts/types/count_audit_logs_request"
831
858
  require_relative "schematic/accounts/types/list_environments_request"
832
859
  require_relative "schematic/accounts/types/create_environment_request_body"
833
860
  require_relative "schematic/accounts/types/update_environment_request_body"
861
+ require_relative "schematic/accounts/types/update_onboarding_state_request_body"
834
862
  require_relative "schematic/billing/client"
835
863
  require_relative "schematic/billing/types/list_coupons_request"
836
864
  require_relative "schematic/billing/types/create_coupon_request_body"
@@ -895,11 +923,13 @@ require_relative "schematic/companies/types/get_or_create_company_membership_req
895
923
  require_relative "schematic/companies/types/get_active_company_subscription_request"
896
924
  require_relative "schematic/companies/types/list_entity_key_definitions_request"
897
925
  require_relative "schematic/companies/types/count_entity_key_definitions_request"
926
+ require_relative "schematic/companies/types/count_entity_keys_request"
898
927
  require_relative "schematic/companies/types/list_entity_trait_definitions_request"
899
928
  require_relative "schematic/companies/types/create_entity_trait_definition_request_body"
900
929
  require_relative "schematic/companies/types/update_entity_trait_definition_request_body"
901
930
  require_relative "schematic/companies/types/count_entity_trait_definitions_request"
902
931
  require_relative "schematic/companies/types/get_entity_trait_values_request"
932
+ require_relative "schematic/companies/types/count_entity_traits_request"
903
933
  require_relative "schematic/companies/types/list_plan_changes_request"
904
934
  require_relative "schematic/companies/types/list_plan_traits_request"
905
935
  require_relative "schematic/companies/types/update_plan_trait_bulk_request_body"