schematichq 1.4.15 → 1.4.16

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 (30) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +3 -3
  3. data/.fern/replay.lock +9 -3
  4. data/WASM_VERSION +1 -1
  5. data/lib/schematic/accounts/types/update_onboarding_state_request_body.rb +2 -0
  6. data/lib/schematic/client.rb +1 -1
  7. data/lib/schematic/planmigrations/client.rb +80 -5
  8. data/lib/schematic/planmigrations/types/cancel_migration_response.rb +13 -0
  9. data/lib/schematic/planmigrations/types/complete_migration_now_request_body.rb +13 -0
  10. data/lib/schematic/planmigrations/types/complete_migration_now_response.rb +13 -0
  11. data/lib/schematic/plans/client.rb +1 -1
  12. data/lib/schematic/plans/types/publish_plan_version_request_body.rb +4 -0
  13. data/lib/schematic/plans/types/retry_custom_plan_billing_request_body.rb +4 -0
  14. data/lib/schematic/types/company_detail_response_data.rb +2 -0
  15. data/lib/schematic/types/credit_lease_response_data.rb +2 -0
  16. data/lib/schematic/types/custom_plan_billing_response_data.rb +2 -0
  17. data/lib/schematic/types/get_onboarding_state_resp.rb +10 -0
  18. data/lib/schematic/types/onboarding_requirement.rb +1 -0
  19. data/lib/schematic/types/onboarding_stripe_import.rb +13 -0
  20. data/lib/schematic/types/pending_migration_response_data.rb +19 -0
  21. data/lib/schematic/types/plan_version_company_migration_response_data.rb +2 -0
  22. data/lib/schematic/types/plan_version_company_migration_status.rb +1 -0
  23. data/lib/schematic/types/plan_version_migration_response_data.rb +2 -0
  24. data/lib/schematic/types/plan_version_migration_status.rb +1 -0
  25. data/lib/schematic/types/plan_version_migration_strategy.rb +1 -0
  26. data/lib/schematic/version.rb +1 -1
  27. data/lib/schematic/wasm/rulesengine.wasm +0 -0
  28. data/lib/schematic.rb +5 -0
  29. data/reference.md +150 -6
  30. metadata +7 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3cc95c686f2516a628954240526a67616f6800b689c81027928ad9a80eaaf7d8
4
- data.tar.gz: 66d631a1f844b8614adb22d01f0a751294b43461a3fa61d7ff5dfac4a4ce9e73
3
+ metadata.gz: 2d7cf8e8c416c5cb5a10b19fdd2bcb74bc66b6ee297bcdb15429f28b60d5a974
4
+ data.tar.gz: 9d08a1d5e659ccd95d60815be4738d9bc547bf591d3a169f38fade148b2a9fcf
5
5
  SHA512:
6
- metadata.gz: 7c6dde7661718ca2910e5f5da9341fa34aeec30dd3e7118a4c735df19136365b57543ebe127e8c8e486047161d296c9012d47a9c8e1a1afe88416a9ae877fc5b
7
- data.tar.gz: db55e6a017355bd9fd28ed55c0f9112f2fa6a64a389262bbac02c3dd3b8c63f596aa0ed980067ab7ffe3ab10f5a0d4cc70346b3733ea3fdac027aa4d2fc8d265
6
+ metadata.gz: d04aa693e161abe87bbf4ea333ae8ad2de0dc83f57455cf344454dd6ef70a90f7abacaaa84813dfc7ebd391de60bd60f55060fcecbcba0a6689b456ec180913b
7
+ data.tar.gz: e63eee1fa25dca3f70f9c9fd21ed1330b93cf7e77d3f6e6ab8194e9813fad6f394332511142a3bc7b30dcf3b64a01de21d73c8596dc0cfffa590034eee80fec4
data/.fern/metadata.json CHANGED
@@ -13,10 +13,10 @@
13
13
  "webrick": ">= 1.0"
14
14
  }
15
15
  },
16
- "originGitCommit": "008b7147a27272499bf4b17fa96d4357ca3b62e9",
16
+ "originGitCommit": "686551a0297d2f37075b3586b030ff32be5c94f7",
17
17
  "originGitCommitIsDirty": false,
18
18
  "invokedBy": "ci",
19
- "requestedVersion": "1.4.15",
19
+ "requestedVersion": "1.4.16",
20
20
  "ciProvider": "github",
21
- "sdkVersion": "1.4.15"
21
+ "sdkVersion": "1.4.16"
22
22
  }
data/.fern/replay.lock CHANGED
@@ -72,14 +72,20 @@ generations:
72
72
  cli_version: unknown
73
73
  generator_versions:
74
74
  fernapi/fern-ruby-sdk: 1.23.2
75
- current_generation: a8692cf0b5fbf1bf984d1f70375e08731b5f5482
75
+ - commit_sha: 67f9937764d88f96352beba4a48e64bd6cd13afb
76
+ tree_hash: dfe7c09296aa8a8b6a52b8ce71be1c5752722cc0
77
+ timestamp: 2026-08-31T10:02:30.491Z
78
+ cli_version: unknown
79
+ generator_versions:
80
+ fernapi/fern-ruby-sdk: 1.23.2
81
+ current_generation: 67f9937764d88f96352beba4a48e64bd6cd13afb
76
82
  patches:
77
83
  - id: patch-5da692c2
78
84
  content_hash: sha256:e652287219a0a709e16112ced444e6472c6fa8bdfe888edf868caaf9769a9472
79
85
  original_commit: 5da692c20aef08577d900f9a860b5f78a549418e
80
86
  original_message: inject host time into datastream wasm rules engine (SCHY-471)
81
87
  original_author: Christopher Brady <chris@schematichq.com>
82
- base_generation: a8692cf0b5fbf1bf984d1f70375e08731b5f5482
88
+ base_generation: 67f9937764d88f96352beba4a48e64bd6cd13afb
83
89
  files:
84
90
  - test/rules_engine_clock_test.rb
85
91
  patch_content: |
@@ -247,7 +253,7 @@ patches:
247
253
  original_commit: ee61788c5a83fce5dd5768b2536391459550d176
248
254
  original_message: fix rubocop offenses in clock regression test (SCHY-471)
249
255
  original_author: Christopher Brady <chris@schematichq.com>
250
- base_generation: a8692cf0b5fbf1bf984d1f70375e08731b5f5482
256
+ base_generation: 67f9937764d88f96352beba4a48e64bd6cd13afb
251
257
  files:
252
258
  - test/rules_engine_clock_test.rb
253
259
  patch_content: |
data/WASM_VERSION CHANGED
@@ -1 +1 @@
1
- 0.7.0
1
+ 0.7.1
@@ -4,6 +4,8 @@ module Schematic
4
4
  module Accounts
5
5
  module Types
6
6
  class UpdateOnboardingStateRequestBody < Internal::Types::Model
7
+ field :dismissed, -> { Internal::Types::Boolean }, optional: true, nullable: false
8
+
7
9
  field :path, -> { Schematic::Types::OnboardingPath }, optional: true, nullable: false
8
10
 
9
11
  field :pricing_page_url, -> { String }, optional: true, nullable: false
@@ -42,7 +42,7 @@ module Schematic
42
42
  @raw_client = Schematic::Internal::Http::RawClient.new(
43
43
  base_url: base_url || Schematic::Environment::DEFAULT,
44
44
  headers: {
45
- "User-Agent" => "schematichq/1.4.15",
45
+ "User-Agent" => "schematichq/1.4.16",
46
46
  "X-Fern-Language" => "Ruby",
47
47
  "X-Schematic-Api-Key" => api_key.to_s
48
48
  },
@@ -27,7 +27,7 @@ module Schematic
27
27
  # client.planmigrations.list_company_migrations(
28
28
  # migration_id: "migration_id",
29
29
  # q: "q",
30
- # status: "completed",
30
+ # status: "cancelled",
31
31
  # limit: 1000000,
32
32
  # offset: 1000000
33
33
  # )
@@ -115,7 +115,7 @@ module Schematic
115
115
  # client.planmigrations.count_company_migrations(
116
116
  # migration_id: "migration_id",
117
117
  # q: "q",
118
- # status: "completed",
118
+ # status: "cancelled",
119
119
  # limit: 1000000,
120
120
  # offset: 1000000
121
121
  # )
@@ -166,7 +166,7 @@ module Schematic
166
166
  # @example
167
167
  # client.planmigrations.list_migrations(
168
168
  # plan_version_id: "plan_version_id",
169
- # status: "completed",
169
+ # status: "cancelled",
170
170
  # limit: 1000000,
171
171
  # offset: 1000000
172
172
  # )
@@ -213,7 +213,7 @@ module Schematic
213
213
  # client.planmigrations.create_migration(
214
214
  # plan_id: "plan_id",
215
215
  # plan_version_id_to: "plan_version_id_to",
216
- # strategy: "immediate",
216
+ # strategy: "end_of_billing_period",
217
217
  # target_plan_type: "plan"
218
218
  # )
219
219
  #
@@ -276,6 +276,81 @@ module Schematic
276
276
  end
277
277
  end
278
278
 
279
+ # @param request_options [Hash]
280
+ # @param params [Hash]
281
+ # @option request_options [String] :base_url
282
+ # @option request_options [Hash{String => Object}] :additional_headers
283
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
284
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
285
+ # @option request_options [Integer] :timeout_in_seconds
286
+ # @option params [String] :plan_version_migration_id
287
+ #
288
+ # @example
289
+ # client.planmigrations.cancel_migration(plan_version_migration_id: "plan_version_migration_id")
290
+ #
291
+ # @return [Schematic::Planmigrations::Types::CancelMigrationResponse]
292
+ def cancel_migration(request_options: {}, **params)
293
+ params = Schematic::Internal::Types::Utils.normalize_keys(params)
294
+ request = Schematic::Internal::JSON::Request.new(
295
+ base_url: request_options[:base_url],
296
+ method: "POST",
297
+ path: "plan-version-migrations/#{URI.encode_uri_component(params[:plan_version_migration_id].to_s)}/cancel",
298
+ request_options: request_options
299
+ )
300
+ begin
301
+ response = @client.send(request)
302
+ rescue Net::HTTPRequestTimeout
303
+ raise Schematic::Errors::TimeoutError
304
+ end
305
+ code = response.code.to_i
306
+ if code.between?(200, 299)
307
+ Schematic::Planmigrations::Types::CancelMigrationResponse.load(response.body)
308
+ else
309
+ error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
310
+ raise error_class.new(response.body, code: code)
311
+ end
312
+ end
313
+
314
+ # @param request_options [Hash]
315
+ # @param params [Schematic::Planmigrations::Types::CompleteMigrationNowRequestBody]
316
+ # @option request_options [String] :base_url
317
+ # @option request_options [Hash{String => Object}] :additional_headers
318
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
319
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
320
+ # @option request_options [Integer] :timeout_in_seconds
321
+ # @option params [String] :plan_version_migration_id
322
+ #
323
+ # @example
324
+ # client.planmigrations.complete_migration_now(plan_version_migration_id: "plan_version_migration_id")
325
+ #
326
+ # @return [Schematic::Planmigrations::Types::CompleteMigrationNowResponse]
327
+ def complete_migration_now(request_options: {}, **params)
328
+ params = Schematic::Internal::Types::Utils.normalize_keys(params)
329
+ request_data = Schematic::Planmigrations::Types::CompleteMigrationNowRequestBody.new(params).to_h
330
+ non_body_param_names = %w[plan_version_migration_id]
331
+ body = request_data.except(*non_body_param_names)
332
+
333
+ request = Schematic::Internal::JSON::Request.new(
334
+ base_url: request_options[:base_url],
335
+ method: "POST",
336
+ path: "plan-version-migrations/#{URI.encode_uri_component(params[:plan_version_migration_id].to_s)}/complete-now",
337
+ body: body,
338
+ request_options: request_options
339
+ )
340
+ begin
341
+ response = @client.send(request)
342
+ rescue Net::HTTPRequestTimeout
343
+ raise Schematic::Errors::TimeoutError
344
+ end
345
+ code = response.code.to_i
346
+ if code.between?(200, 299)
347
+ Schematic::Planmigrations::Types::CompleteMigrationNowResponse.load(response.body)
348
+ else
349
+ error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
350
+ raise error_class.new(response.body, code: code)
351
+ end
352
+ end
353
+
279
354
  # @param request_options [Hash]
280
355
  # @param params [Schematic::Planmigrations::Types::RetryMigrationRequestBody]
281
356
  # @option request_options [String] :base_url
@@ -334,7 +409,7 @@ module Schematic
334
409
  # @example
335
410
  # client.planmigrations.count_migrations(
336
411
  # plan_version_id: "plan_version_id",
337
- # status: "completed",
412
+ # status: "cancelled",
338
413
  # limit: 1000000,
339
414
  # offset: 1000000
340
415
  # )
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Planmigrations
5
+ module Types
6
+ class CancelMigrationResponse < Internal::Types::Model
7
+ field :data, -> { Schematic::Types::PlanVersionMigrationResponseData }, optional: false, nullable: false
8
+
9
+ field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
10
+ end
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Planmigrations
5
+ module Types
6
+ class CompleteMigrationNowRequestBody < Internal::Types::Model
7
+ field :plan_version_migration_id, -> { String }, optional: false, nullable: false
8
+
9
+ field :proration_behavior, -> { Schematic::Types::MigrationProrationBehavior }, optional: true, nullable: false
10
+ end
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Planmigrations
5
+ module Types
6
+ class CompleteMigrationNowResponse < Internal::Types::Model
7
+ field :data, -> { Schematic::Types::PlanVersionMigrationResponseData }, optional: false, nullable: false
8
+
9
+ field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
10
+ end
11
+ end
12
+ end
13
+ end
@@ -856,7 +856,7 @@ module Schematic
856
856
  # client.plans.publish_plan_version(
857
857
  # plan_version_id: "plan_version_id",
858
858
  # excluded_company_ids: ["excluded_company_ids"],
859
- # migration_strategy: "immediate"
859
+ # migration_strategy: "end_of_billing_period"
860
860
  # )
861
861
  #
862
862
  # @return [Schematic::Plans::Types::PublishPlanVersionResponse]
@@ -10,6 +10,8 @@ module Schematic
10
10
 
11
11
  field :address, -> { Schematic::Types::CustomerBillingAddress }, optional: true, nullable: false
12
12
 
13
+ field :billing_cycle_anchor, -> { String }, optional: true, nullable: false
14
+
13
15
  field :coupon_external_id, -> { String }, optional: true, nullable: false
14
16
 
15
17
  field :custom_field_values, -> { Internal::Types::Array[Schematic::Types::CheckoutFieldValue] }, optional: true, nullable: false
@@ -24,6 +26,8 @@ module Schematic
24
26
 
25
27
  field :phone, -> { String }, optional: true, nullable: false
26
28
 
29
+ field :prorate_first_period, -> { Internal::Types::Boolean }, optional: true, nullable: false
30
+
27
31
  field :proration_behavior, -> { Schematic::Types::MigrationProrationBehavior }, optional: true, nullable: false
28
32
 
29
33
  field :require_no_migration, -> { Internal::Types::Boolean }, optional: true, nullable: false
@@ -8,10 +8,14 @@ module Schematic
8
8
 
9
9
  field :activation_strategy, -> { Schematic::Types::CustomPlanActivationStrategy }, optional: true, nullable: false
10
10
 
11
+ field :billing_cycle_anchor, -> { String }, optional: true, nullable: false
12
+
11
13
  field :customer_email, -> { String }, optional: false, nullable: false
12
14
 
13
15
  field :days_until_due, -> { Integer }, optional: true, nullable: false
14
16
 
17
+ field :prorate_first_period, -> { Internal::Types::Boolean }, optional: true, nullable: false
18
+
15
19
  field :send_invoice, -> { Internal::Types::Boolean }, optional: true, nullable: false
16
20
  end
17
21
  end
@@ -37,6 +37,8 @@ module Schematic
37
37
 
38
38
  field :payment_methods, -> { Internal::Types::Array[Schematic::Types::PaymentMethodResponseData] }, optional: false, nullable: false
39
39
 
40
+ field :pending_migration, -> { Schematic::Types::PendingMigrationResponseData }, optional: true, nullable: false
41
+
40
42
  field :plan, -> { Schematic::Types::CompanyPlanWithBillingSubView }, optional: true, nullable: false
41
43
 
42
44
  field :plans, -> { Internal::Types::Array[Schematic::Types::GenericPreviewObject] }, optional: false, nullable: false
@@ -17,6 +17,8 @@ module Schematic
17
17
 
18
18
  field :released_at, -> { String }, optional: true, nullable: false
19
19
 
20
+ field :tracked_amount, -> { Integer }, optional: false, nullable: false
21
+
20
22
  field :updated_at, -> { String }, optional: false, nullable: false
21
23
  end
22
24
  end
@@ -23,6 +23,8 @@ module Schematic
23
23
 
24
24
  field :plan_id, -> { String }, optional: false, nullable: false
25
25
 
26
+ field :prorate_first_period, -> { Internal::Types::Boolean }, optional: true, nullable: false
27
+
26
28
  field :published_at, -> { String }, optional: true, nullable: false
27
29
 
28
30
  field :send_invoice, -> { Internal::Types::Boolean }, optional: false, nullable: false
@@ -3,17 +3,27 @@
3
3
  module Schematic
4
4
  module Types
5
5
  class GetOnboardingStateResp < Internal::Types::Model
6
+ field :agent_connected_at, -> { String }, optional: true, nullable: false
7
+
8
+ field :dismissed_at, -> { String }, optional: true, nullable: false
9
+
6
10
  field :environment_id, -> { String }, optional: true, nullable: false
7
11
 
8
12
  field :milestones, -> { Internal::Types::Array[Schematic::Types::OnboardingMilestoneView] }, optional: false, nullable: false
9
13
 
10
14
  field :path, -> { Schematic::Types::OnboardingPath }, optional: true, nullable: false
11
15
 
16
+ field :pricing_page_url, -> { String }, optional: true, nullable: false
17
+
12
18
  field :requirements, -> { Internal::Types::Array[Schematic::Types::OnboardingRequirementView] }, optional: false, nullable: false
13
19
 
20
+ field :stripe_import, -> { Schematic::Types::OnboardingStripeImport }, optional: true, nullable: false
21
+
14
22
  field :suggested_next, -> { Internal::Types::Array[Schematic::Types::OnboardingRequirement] }, optional: false, nullable: false
15
23
 
16
24
  field :track, -> { Schematic::Types::OnboardingTrack }, optional: true, nullable: false
25
+
26
+ field :website_url, -> { String }, optional: true, nullable: false
17
27
  end
18
28
  end
19
29
  end
@@ -5,6 +5,7 @@ module Schematic
5
5
  module OnboardingRequirement
6
6
  extend Schematic::Internal::Types::Enum
7
7
 
8
+ CONNECT_AGENT = "connect_agent"
8
9
  CONNECT_BILLING = "connect_billing"
9
10
  CREATE_API_KEY = "create_api_key"
10
11
  FIRST_FLAG_CHECK = "first_flag_check"
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Types
5
+ module OnboardingStripeImport
6
+ extend Schematic::Internal::Types::Enum
7
+
8
+ COMPLETE = "complete"
9
+ NOT_STARTED = "not_started"
10
+ RUNNING = "running"
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Schematic
4
+ module Types
5
+ class PendingMigrationResponseData < Internal::Types::Model
6
+ field :migration_id, -> { String }, optional: false, nullable: false
7
+
8
+ field :scheduled_for, -> { String }, optional: true, nullable: false
9
+
10
+ field :to_plan_id, -> { String }, optional: false, nullable: false
11
+
12
+ field :to_plan_name, -> { String }, optional: false, nullable: false
13
+
14
+ field :to_plan_version_id, -> { String }, optional: false, nullable: false
15
+
16
+ field :to_plan_version_number, -> { Integer }, optional: true, nullable: false
17
+ end
18
+ end
19
+ end
@@ -21,6 +21,8 @@ module Schematic
21
21
 
22
22
  field :plan_version_id_from, -> { String }, optional: true, nullable: false
23
23
 
24
+ field :scheduled_for, -> { String }, optional: true, nullable: false
25
+
24
26
  field :started_at, -> { String }, optional: true, nullable: false
25
27
 
26
28
  field :status, -> { Schematic::Types::PlanVersionCompanyMigrationStatus }, optional: false, nullable: false
@@ -5,6 +5,7 @@ module Schematic
5
5
  module PlanVersionCompanyMigrationStatus
6
6
  extend Schematic::Internal::Types::Enum
7
7
 
8
+ CANCELLED = "cancelled"
8
9
  COMPLETED = "completed"
9
10
  FAILED = "failed"
10
11
  IN_PROGRESS = "in_progress"
@@ -15,6 +15,8 @@ module Schematic
15
15
 
16
16
  field :id, -> { String }, optional: false, nullable: false
17
17
 
18
+ field :next_due_at, -> { String }, optional: true, nullable: false
19
+
18
20
  field :plan_id, -> { String }, optional: false, nullable: false
19
21
 
20
22
  field :plan_version_id_from, -> { String }, optional: true, nullable: false
@@ -5,6 +5,7 @@ module Schematic
5
5
  module PlanVersionMigrationStatus
6
6
  extend Schematic::Internal::Types::Enum
7
7
 
8
+ CANCELLED = "cancelled"
8
9
  COMPLETED = "completed"
9
10
  FAILED = "failed"
10
11
  IN_PROGRESS = "in_progress"
@@ -5,6 +5,7 @@ module Schematic
5
5
  module PlanVersionMigrationStrategy
6
6
  extend Schematic::Internal::Types::Enum
7
7
 
8
+ END_OF_BILLING_PERIOD = "end_of_billing_period"
8
9
  IMMEDIATE = "immediate"
9
10
  LEAVE = "leave"
10
11
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Schematic
4
- VERSION = "1.4.15"
4
+ VERSION = "1.4.16"
5
5
  end
Binary file
data/lib/schematic.rb CHANGED
@@ -82,6 +82,7 @@ require_relative "schematic/types/onboarding_milestone_view"
82
82
  require_relative "schematic/types/onboarding_path"
83
83
  require_relative "schematic/types/onboarding_requirement_status"
84
84
  require_relative "schematic/types/onboarding_requirement_view"
85
+ require_relative "schematic/types/onboarding_stripe_import"
85
86
  require_relative "schematic/types/onboarding_track"
86
87
  require_relative "schematic/types/get_onboarding_state_resp"
87
88
  require_relative "schematic/accounts/types/get_onboarding_state_response"
@@ -303,6 +304,7 @@ require_relative "schematic/types/entity_key_detail_response_data"
303
304
  require_relative "schematic/types/entity_trait_detail_response_data"
304
305
  require_relative "schematic/types/warning_tier"
305
306
  require_relative "schematic/types/feature_entitlement"
307
+ require_relative "schematic/types/pending_migration_response_data"
306
308
  require_relative "schematic/types/rule"
307
309
  require_relative "schematic/types/scheduled_downgrade_response_data"
308
310
  require_relative "schematic/types/company_detail_response_data"
@@ -683,6 +685,8 @@ require_relative "schematic/types/plan_version_migration_response_data"
683
685
  require_relative "schematic/planmigrations/types/list_migrations_response"
684
686
  require_relative "schematic/planmigrations/types/create_migration_response"
685
687
  require_relative "schematic/planmigrations/types/get_migration_response"
688
+ require_relative "schematic/planmigrations/types/cancel_migration_response"
689
+ require_relative "schematic/planmigrations/types/complete_migration_now_response"
686
690
  require_relative "schematic/planmigrations/types/retry_migration_response"
687
691
  require_relative "schematic/planmigrations/types/count_migrations_params"
688
692
  require_relative "schematic/planmigrations/types/count_migrations_response"
@@ -1028,6 +1032,7 @@ require_relative "schematic/planmigrations/types/list_company_migrations_request
1028
1032
  require_relative "schematic/planmigrations/types/count_company_migrations_request"
1029
1033
  require_relative "schematic/planmigrations/types/list_migrations_request"
1030
1034
  require_relative "schematic/planmigrations/types/create_migration_input"
1035
+ require_relative "schematic/planmigrations/types/complete_migration_now_request_body"
1031
1036
  require_relative "schematic/planmigrations/types/retry_migration_request_body"
1032
1037
  require_relative "schematic/planmigrations/types/count_migrations_request"
1033
1038
  require_relative "schematic/planmigrations/types/preview_migration_request_body"
data/reference.md CHANGED
@@ -1273,6 +1273,14 @@ client.accounts.update_onboarding_state
1273
1273
  <dl>
1274
1274
  <dd>
1275
1275
 
1276
+ **dismissed:** `Internal::Types::Boolean`
1277
+
1278
+ </dd>
1279
+ </dl>
1280
+
1281
+ <dl>
1282
+ <dd>
1283
+
1276
1284
  **path:** `Schematic::Types::OnboardingPath`
1277
1285
 
1278
1286
  </dd>
@@ -14400,6 +14408,14 @@ client.plans.retry_custom_plan_billing(
14400
14408
  <dl>
14401
14409
  <dd>
14402
14410
 
14411
+ **billing_cycle_anchor:** `String` — The date the subscription's billing period renews on. Only honored when the retry creates a subscription.
14412
+
14413
+ </dd>
14414
+ </dl>
14415
+
14416
+ <dl>
14417
+ <dd>
14418
+
14403
14419
  **customer_email:** `String`
14404
14420
 
14405
14421
  </dd>
@@ -14416,6 +14432,14 @@ client.plans.retry_custom_plan_billing(
14416
14432
  <dl>
14417
14433
  <dd>
14418
14434
 
14435
+ **prorate_first_period:** `Internal::Types::Boolean` — When true, the partial period between the subscription starting and its renewal date is billed pro rata straight away. When false that period is free and no invoice is raised until the renewal date. Only applies alongside billing_cycle_anchor. Defaults to true.
14436
+
14437
+ </dd>
14438
+ </dl>
14439
+
14440
+ <dl>
14441
+ <dd>
14442
+
14419
14443
  **send_invoice:** `Internal::Types::Boolean` — Whether Stripe emails the invoice when it is finalized. Defaults to true.
14420
14444
 
14421
14445
  </dd>
@@ -15581,7 +15605,7 @@ client.plans.delete_plan_version(
15581
15605
  client.plans.publish_plan_version(
15582
15606
  plan_version_id: "plan_version_id",
15583
15607
  excluded_company_ids: ["excluded_company_ids"],
15584
- migration_strategy: "immediate"
15608
+ migration_strategy: "end_of_billing_period"
15585
15609
  )
15586
15610
  ```
15587
15611
  </dd>
@@ -15621,6 +15645,14 @@ client.plans.publish_plan_version(
15621
15645
  <dl>
15622
15646
  <dd>
15623
15647
 
15648
+ **billing_cycle_anchor:** `String` — The date the subscription's billing period renews on. Only honored on a first publish that starts a subscription.
15649
+
15650
+ </dd>
15651
+ </dl>
15652
+
15653
+ <dl>
15654
+ <dd>
15655
+
15624
15656
  **coupon_external_id:** `String`
15625
15657
 
15626
15658
  </dd>
@@ -15677,6 +15709,14 @@ client.plans.publish_plan_version(
15677
15709
  <dl>
15678
15710
  <dd>
15679
15711
 
15712
+ **prorate_first_period:** `Internal::Types::Boolean` — When true, the partial period between the subscription starting and its renewal date is billed pro rata straight away. When false that period is free and no invoice is raised until the renewal date. Only applies alongside billing_cycle_anchor. Defaults to true.
15713
+
15714
+ </dd>
15715
+ </dl>
15716
+
15717
+ <dl>
15718
+ <dd>
15719
+
15680
15720
  **proration_behavior:** `Schematic::Types::MigrationProrationBehavior`
15681
15721
 
15682
15722
  </dd>
@@ -20378,7 +20418,7 @@ client.plangroups.update_plan_group(
20378
20418
  client.planmigrations.list_company_migrations(
20379
20419
  migration_id: "migration_id",
20380
20420
  q: "q",
20381
- status: "completed",
20421
+ status: "cancelled",
20382
20422
  limit: 1000000,
20383
20423
  offset: 1000000
20384
20424
  )
@@ -20512,7 +20552,7 @@ client.planmigrations.retry_company_migration(plan_version_company_migration_id:
20512
20552
  client.planmigrations.count_company_migrations(
20513
20553
  migration_id: "migration_id",
20514
20554
  q: "q",
20515
- status: "completed",
20555
+ status: "cancelled",
20516
20556
  limit: 1000000,
20517
20557
  offset: 1000000
20518
20558
  )
@@ -20597,7 +20637,7 @@ client.planmigrations.count_company_migrations(
20597
20637
  ```ruby
20598
20638
  client.planmigrations.list_migrations(
20599
20639
  plan_version_id: "plan_version_id",
20600
- status: "completed",
20640
+ status: "cancelled",
20601
20641
  limit: 1000000,
20602
20642
  offset: 1000000
20603
20643
  )
@@ -20675,7 +20715,7 @@ client.planmigrations.list_migrations(
20675
20715
  client.planmigrations.create_migration(
20676
20716
  plan_id: "plan_id",
20677
20717
  plan_version_id_to: "plan_version_id_to",
20678
- strategy: "immediate",
20718
+ strategy: "end_of_billing_period",
20679
20719
  target_plan_type: "plan"
20680
20720
  )
20681
20721
  ```
@@ -20812,6 +20852,110 @@ client.planmigrations.get_migration(plan_version_migration_id: "plan_version_mig
20812
20852
  </dl>
20813
20853
 
20814
20854
 
20855
+ </dd>
20856
+ </dl>
20857
+ </details>
20858
+
20859
+ <details><summary><code>client.planmigrations.<a href="/lib/schematic/planmigrations/client.rb">cancel_migration</a>(plan_version_migration_id:) -> Schematic::Planmigrations::Types::CancelMigrationResponse</code></summary>
20860
+ <dl>
20861
+ <dd>
20862
+
20863
+ #### 🔌 Usage
20864
+
20865
+ <dl>
20866
+ <dd>
20867
+
20868
+ <dl>
20869
+ <dd>
20870
+
20871
+ ```ruby
20872
+ client.planmigrations.cancel_migration(plan_version_migration_id: "plan_version_migration_id")
20873
+ ```
20874
+ </dd>
20875
+ </dl>
20876
+ </dd>
20877
+ </dl>
20878
+
20879
+ #### ⚙️ Parameters
20880
+
20881
+ <dl>
20882
+ <dd>
20883
+
20884
+ <dl>
20885
+ <dd>
20886
+
20887
+ **plan_version_migration_id:** `String` — plan_version_migration_id
20888
+
20889
+ </dd>
20890
+ </dl>
20891
+
20892
+ <dl>
20893
+ <dd>
20894
+
20895
+ **request_options:** `Schematic::Planmigrations::RequestOptions`
20896
+
20897
+ </dd>
20898
+ </dl>
20899
+ </dd>
20900
+ </dl>
20901
+
20902
+
20903
+ </dd>
20904
+ </dl>
20905
+ </details>
20906
+
20907
+ <details><summary><code>client.planmigrations.<a href="/lib/schematic/planmigrations/client.rb">complete_migration_now</a>(plan_version_migration_id:, request) -> Schematic::Planmigrations::Types::CompleteMigrationNowResponse</code></summary>
20908
+ <dl>
20909
+ <dd>
20910
+
20911
+ #### 🔌 Usage
20912
+
20913
+ <dl>
20914
+ <dd>
20915
+
20916
+ <dl>
20917
+ <dd>
20918
+
20919
+ ```ruby
20920
+ client.planmigrations.complete_migration_now(plan_version_migration_id: "plan_version_migration_id")
20921
+ ```
20922
+ </dd>
20923
+ </dl>
20924
+ </dd>
20925
+ </dl>
20926
+
20927
+ #### ⚙️ Parameters
20928
+
20929
+ <dl>
20930
+ <dd>
20931
+
20932
+ <dl>
20933
+ <dd>
20934
+
20935
+ **plan_version_migration_id:** `String` — plan_version_migration_id
20936
+
20937
+ </dd>
20938
+ </dl>
20939
+
20940
+ <dl>
20941
+ <dd>
20942
+
20943
+ **proration_behavior:** `Schematic::Types::MigrationProrationBehavior`
20944
+
20945
+ </dd>
20946
+ </dl>
20947
+
20948
+ <dl>
20949
+ <dd>
20950
+
20951
+ **request_options:** `Schematic::Planmigrations::RequestOptions`
20952
+
20953
+ </dd>
20954
+ </dl>
20955
+ </dd>
20956
+ </dl>
20957
+
20958
+
20815
20959
  </dd>
20816
20960
  </dl>
20817
20961
  </details>
@@ -20890,7 +21034,7 @@ client.planmigrations.retry_migration(
20890
21034
  ```ruby
20891
21035
  client.planmigrations.count_migrations(
20892
21036
  plan_version_id: "plan_version_id",
20893
- status: "completed",
21037
+ status: "cancelled",
20894
21038
  limit: 1000000,
20895
21039
  offset: 1000000
20896
21040
  )
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: schematichq
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.15
4
+ version: 1.4.16
5
5
  platform: ruby
6
6
  authors:
7
7
  - Schematic
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2026-08-25 00:00:00.000000000 Z
11
+ date: 2026-09-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: wasmtime
@@ -569,6 +569,9 @@ files:
569
569
  - lib/schematic/plangroups/types/update_plan_group_request_body.rb
570
570
  - lib/schematic/plangroups/types/update_plan_group_response.rb
571
571
  - lib/schematic/planmigrations/client.rb
572
+ - lib/schematic/planmigrations/types/cancel_migration_response.rb
573
+ - lib/schematic/planmigrations/types/complete_migration_now_request_body.rb
574
+ - lib/schematic/planmigrations/types/complete_migration_now_response.rb
572
575
  - lib/schematic/planmigrations/types/count_company_migrations_params.rb
573
576
  - lib/schematic/planmigrations/types/count_company_migrations_request.rb
574
577
  - lib/schematic/planmigrations/types/count_company_migrations_response.rb
@@ -932,11 +935,13 @@ files:
932
935
  - lib/schematic/types/onboarding_requirement.rb
933
936
  - lib/schematic/types/onboarding_requirement_status.rb
934
937
  - lib/schematic/types/onboarding_requirement_view.rb
938
+ - lib/schematic/types/onboarding_stripe_import.rb
935
939
  - lib/schematic/types/onboarding_track.rb
936
940
  - lib/schematic/types/orb_integration_config.rb
937
941
  - lib/schematic/types/ordered_plans_in_group.rb
938
942
  - lib/schematic/types/payment_method_request_body.rb
939
943
  - lib/schematic/types/payment_method_response_data.rb
944
+ - lib/schematic/types/pending_migration_response_data.rb
940
945
  - lib/schematic/types/plan_billing_source.rb
941
946
  - lib/schematic/types/plan_bundle_action.rb
942
947
  - lib/schematic/types/plan_bundle_credit_grant_request_body.rb