@seamapi/types 1.1169.0 → 1.1171.0

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.
@@ -91562,6 +91562,23 @@ export type Routes = {
91562
91562
  current_period_ends_at: string | null;
91563
91563
  past_due_since: string | null;
91564
91564
  canceled_at: string | null;
91565
+ scheduled_package_quantity: number | null;
91566
+ scheduled_price_cents: number | null;
91567
+ scheduled_change_at: string | null;
91568
+ pending_upgrade: {
91569
+ package_quantity: number;
91570
+ hosted_invoice_url: string | null;
91571
+ } | null;
91572
+ } | null;
91573
+ trial: {
91574
+ trial_started_at: string;
91575
+ trial_ends_at: string;
91576
+ is_active: boolean;
91577
+ is_suspended: boolean;
91578
+ trial_credits: number;
91579
+ used_credits: number | null;
91580
+ remaining_credits: number | null;
91581
+ is_credits_used_up: boolean;
91565
91582
  } | null;
91566
91583
  usage: {
91567
91584
  as_of: string;
@@ -91635,6 +91652,7 @@ export type Routes = {
91635
91652
  recommended_package_quantity: number;
91636
91653
  recommendation_basis: {
91637
91654
  trailing_30_day_tokens: number | null;
91655
+ is_projected_from_trial: boolean;
91638
91656
  };
91639
91657
  };
91640
91658
  maxDuration: undefined;
@@ -91680,6 +91698,80 @@ export type Routes = {
91680
91698
  current_period_ends_at: string | null;
91681
91699
  past_due_since: string | null;
91682
91700
  canceled_at: string | null;
91701
+ scheduled_package_quantity: number | null;
91702
+ scheduled_price_cents: number | null;
91703
+ scheduled_change_at: string | null;
91704
+ pending_upgrade: {
91705
+ package_quantity: number;
91706
+ hosted_invoice_url: string | null;
91707
+ } | null;
91708
+ };
91709
+ };
91710
+ maxDuration: undefined;
91711
+ };
91712
+ '/seam/console/v1/credits/subscription/change': {
91713
+ route: '/seam/console/v1/credits/subscription/change';
91714
+ method: 'POST';
91715
+ queryParams: {};
91716
+ jsonBody: {
91717
+ organization_id: string;
91718
+ package_quantity: number;
91719
+ };
91720
+ commonParams: {};
91721
+ formData: {};
91722
+ jsonResponse: {
91723
+ credit_subscription: {
91724
+ credit_subscription_id: string;
91725
+ status: string;
91726
+ package_quantity: number;
91727
+ price_cents: number;
91728
+ current_period_started_at: string | null;
91729
+ current_period_ends_at: string | null;
91730
+ past_due_since: string | null;
91731
+ canceled_at: string | null;
91732
+ scheduled_package_quantity: number | null;
91733
+ scheduled_price_cents: number | null;
91734
+ scheduled_change_at: string | null;
91735
+ pending_upgrade: {
91736
+ package_quantity: number;
91737
+ hosted_invoice_url: string | null;
91738
+ } | null;
91739
+ };
91740
+ change: {
91741
+ kind: 'upgrade' | 'downgrade';
91742
+ status: 'applied' | 'scheduled' | 'awaiting_authentication' | 'processing';
91743
+ hosted_invoice_url: string | null;
91744
+ carried_credits: number | null;
91745
+ };
91746
+ };
91747
+ maxDuration: undefined;
91748
+ };
91749
+ '/seam/console/v1/credits/subscription/change/cancel': {
91750
+ route: '/seam/console/v1/credits/subscription/change/cancel';
91751
+ method: 'POST';
91752
+ queryParams: {};
91753
+ jsonBody: {
91754
+ organization_id: string;
91755
+ };
91756
+ commonParams: {};
91757
+ formData: {};
91758
+ jsonResponse: {
91759
+ credit_subscription: {
91760
+ credit_subscription_id: string;
91761
+ status: string;
91762
+ package_quantity: number;
91763
+ price_cents: number;
91764
+ current_period_started_at: string | null;
91765
+ current_period_ends_at: string | null;
91766
+ past_due_since: string | null;
91767
+ canceled_at: string | null;
91768
+ scheduled_package_quantity: number | null;
91769
+ scheduled_price_cents: number | null;
91770
+ scheduled_change_at: string | null;
91771
+ pending_upgrade: {
91772
+ package_quantity: number;
91773
+ hosted_invoice_url: string | null;
91774
+ } | null;
91683
91775
  };
91684
91776
  };
91685
91777
  maxDuration: undefined;
@@ -91703,6 +91795,13 @@ export type Routes = {
91703
91795
  current_period_ends_at: string | null;
91704
91796
  past_due_since: string | null;
91705
91797
  canceled_at: string | null;
91798
+ scheduled_package_quantity: number | null;
91799
+ scheduled_price_cents: number | null;
91800
+ scheduled_change_at: string | null;
91801
+ pending_upgrade: {
91802
+ package_quantity: number;
91803
+ hosted_invoice_url: string | null;
91804
+ } | null;
91706
91805
  };
91707
91806
  };
91708
91807
  maxDuration: undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1169.0",
3
+ "version": "1.1171.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -61841,7 +61841,40 @@ const openapi: OpenAPISpec = {
61841
61841
  nullable: true,
61842
61842
  type: 'string',
61843
61843
  },
61844
+ pending_upgrade: {
61845
+ nullable: true,
61846
+ properties: {
61847
+ hosted_invoice_url: {
61848
+ nullable: true,
61849
+ type: 'string',
61850
+ },
61851
+ package_quantity: {
61852
+ format: 'float',
61853
+ type: 'number',
61854
+ },
61855
+ },
61856
+ required: [
61857
+ 'package_quantity',
61858
+ 'hosted_invoice_url',
61859
+ ],
61860
+ type: 'object',
61861
+ },
61844
61862
  price_cents: { format: 'float', type: 'number' },
61863
+ scheduled_change_at: {
61864
+ format: 'date-time',
61865
+ nullable: true,
61866
+ type: 'string',
61867
+ },
61868
+ scheduled_package_quantity: {
61869
+ format: 'float',
61870
+ nullable: true,
61871
+ type: 'number',
61872
+ },
61873
+ scheduled_price_cents: {
61874
+ format: 'float',
61875
+ nullable: true,
61876
+ type: 'number',
61877
+ },
61845
61878
  status: { type: 'string' },
61846
61879
  },
61847
61880
  required: [
@@ -61853,10 +61886,52 @@ const openapi: OpenAPISpec = {
61853
61886
  'current_period_ends_at',
61854
61887
  'past_due_since',
61855
61888
  'canceled_at',
61889
+ 'scheduled_package_quantity',
61890
+ 'scheduled_price_cents',
61891
+ 'scheduled_change_at',
61892
+ 'pending_upgrade',
61856
61893
  ],
61857
61894
  type: 'object',
61858
61895
  },
61859
61896
  is_test_mode: { type: 'boolean' },
61897
+ trial: {
61898
+ nullable: true,
61899
+ properties: {
61900
+ is_active: { type: 'boolean' },
61901
+ is_credits_used_up: { type: 'boolean' },
61902
+ is_suspended: { type: 'boolean' },
61903
+ remaining_credits: {
61904
+ format: 'float',
61905
+ nullable: true,
61906
+ type: 'number',
61907
+ },
61908
+ trial_credits: { format: 'float', type: 'number' },
61909
+ trial_ends_at: {
61910
+ format: 'date-time',
61911
+ type: 'string',
61912
+ },
61913
+ trial_started_at: {
61914
+ format: 'date-time',
61915
+ type: 'string',
61916
+ },
61917
+ used_credits: {
61918
+ format: 'float',
61919
+ nullable: true,
61920
+ type: 'number',
61921
+ },
61922
+ },
61923
+ required: [
61924
+ 'trial_started_at',
61925
+ 'trial_ends_at',
61926
+ 'is_active',
61927
+ 'is_suspended',
61928
+ 'trial_credits',
61929
+ 'used_credits',
61930
+ 'remaining_credits',
61931
+ 'is_credits_used_up',
61932
+ ],
61933
+ type: 'object',
61934
+ },
61860
61935
  usage: {
61861
61936
  nullable: true,
61862
61937
  properties: {
@@ -61950,6 +62025,7 @@ const openapi: OpenAPISpec = {
61950
62025
  required: [
61951
62026
  'is_test_mode',
61952
62027
  'credit_subscription',
62028
+ 'trial',
61953
62029
  'usage',
61954
62030
  ],
61955
62031
  type: 'object',
@@ -62125,13 +62201,17 @@ const openapi: OpenAPISpec = {
62125
62201
  },
62126
62202
  recommendation_basis: {
62127
62203
  properties: {
62204
+ is_projected_from_trial: { type: 'boolean' },
62128
62205
  trailing_30_day_tokens: {
62129
62206
  format: 'float',
62130
62207
  nullable: true,
62131
62208
  type: 'number',
62132
62209
  },
62133
62210
  },
62134
- required: ['trailing_30_day_tokens'],
62211
+ required: [
62212
+ 'trailing_30_day_tokens',
62213
+ 'is_projected_from_trial',
62214
+ ],
62135
62215
  type: 'object',
62136
62216
  },
62137
62217
  recommended_package_quantity: {
@@ -62299,7 +62379,37 @@ const openapi: OpenAPISpec = {
62299
62379
  nullable: true,
62300
62380
  type: 'string',
62301
62381
  },
62382
+ pending_upgrade: {
62383
+ nullable: true,
62384
+ properties: {
62385
+ hosted_invoice_url: {
62386
+ nullable: true,
62387
+ type: 'string',
62388
+ },
62389
+ package_quantity: {
62390
+ format: 'float',
62391
+ type: 'number',
62392
+ },
62393
+ },
62394
+ required: ['package_quantity', 'hosted_invoice_url'],
62395
+ type: 'object',
62396
+ },
62302
62397
  price_cents: { format: 'float', type: 'number' },
62398
+ scheduled_change_at: {
62399
+ format: 'date-time',
62400
+ nullable: true,
62401
+ type: 'string',
62402
+ },
62403
+ scheduled_package_quantity: {
62404
+ format: 'float',
62405
+ nullable: true,
62406
+ type: 'number',
62407
+ },
62408
+ scheduled_price_cents: {
62409
+ format: 'float',
62410
+ nullable: true,
62411
+ type: 'number',
62412
+ },
62303
62413
  status: { type: 'string' },
62304
62414
  },
62305
62415
  required: [
@@ -62311,6 +62421,10 @@ const openapi: OpenAPISpec = {
62311
62421
  'current_period_ends_at',
62312
62422
  'past_due_since',
62313
62423
  'canceled_at',
62424
+ 'scheduled_package_quantity',
62425
+ 'scheduled_price_cents',
62426
+ 'scheduled_change_at',
62427
+ 'pending_upgrade',
62314
62428
  ],
62315
62429
  type: 'object',
62316
62430
  },
@@ -62342,6 +62456,298 @@ const openapi: OpenAPISpec = {
62342
62456
  'x-undocumented': 'Internal endpoint for Console',
62343
62457
  },
62344
62458
  },
62459
+ '/seam/console/v1/credits/subscription/change': {
62460
+ post: {
62461
+ description:
62462
+ 'Upgrades to a larger package immediately, charging its full price and carrying the unused credits over, or schedules a downgrade to a smaller package for the end of the current period.',
62463
+ operationId: 'seamConsoleV1CreditsSubscriptionChangePost',
62464
+ requestBody: {
62465
+ content: {
62466
+ 'application/json': {
62467
+ schema: {
62468
+ properties: {
62469
+ organization_id: { format: 'uuid', type: 'string' },
62470
+ package_quantity: {
62471
+ exclusiveMinimum: true,
62472
+ minimum: 0,
62473
+ type: 'integer',
62474
+ },
62475
+ },
62476
+ required: ['organization_id', 'package_quantity'],
62477
+ type: 'object',
62478
+ },
62479
+ },
62480
+ },
62481
+ },
62482
+ responses: {
62483
+ '200': {
62484
+ content: {
62485
+ 'application/json': {
62486
+ schema: {
62487
+ properties: {
62488
+ change: {
62489
+ properties: {
62490
+ carried_credits: {
62491
+ format: 'float',
62492
+ nullable: true,
62493
+ type: 'number',
62494
+ },
62495
+ hosted_invoice_url: { nullable: true, type: 'string' },
62496
+ kind: {
62497
+ enum: ['upgrade', 'downgrade'],
62498
+ type: 'string',
62499
+ },
62500
+ status: {
62501
+ enum: [
62502
+ 'applied',
62503
+ 'scheduled',
62504
+ 'awaiting_authentication',
62505
+ 'processing',
62506
+ ],
62507
+ type: 'string',
62508
+ },
62509
+ },
62510
+ required: [
62511
+ 'kind',
62512
+ 'status',
62513
+ 'hosted_invoice_url',
62514
+ 'carried_credits',
62515
+ ],
62516
+ type: 'object',
62517
+ },
62518
+ credit_subscription: {
62519
+ properties: {
62520
+ canceled_at: {
62521
+ format: 'date-time',
62522
+ nullable: true,
62523
+ type: 'string',
62524
+ },
62525
+ credit_subscription_id: {
62526
+ format: 'uuid',
62527
+ type: 'string',
62528
+ },
62529
+ current_period_ends_at: {
62530
+ format: 'date-time',
62531
+ nullable: true,
62532
+ type: 'string',
62533
+ },
62534
+ current_period_started_at: {
62535
+ format: 'date-time',
62536
+ nullable: true,
62537
+ type: 'string',
62538
+ },
62539
+ package_quantity: { format: 'float', type: 'number' },
62540
+ past_due_since: {
62541
+ format: 'date-time',
62542
+ nullable: true,
62543
+ type: 'string',
62544
+ },
62545
+ pending_upgrade: {
62546
+ nullable: true,
62547
+ properties: {
62548
+ hosted_invoice_url: {
62549
+ nullable: true,
62550
+ type: 'string',
62551
+ },
62552
+ package_quantity: {
62553
+ format: 'float',
62554
+ type: 'number',
62555
+ },
62556
+ },
62557
+ required: ['package_quantity', 'hosted_invoice_url'],
62558
+ type: 'object',
62559
+ },
62560
+ price_cents: { format: 'float', type: 'number' },
62561
+ scheduled_change_at: {
62562
+ format: 'date-time',
62563
+ nullable: true,
62564
+ type: 'string',
62565
+ },
62566
+ scheduled_package_quantity: {
62567
+ format: 'float',
62568
+ nullable: true,
62569
+ type: 'number',
62570
+ },
62571
+ scheduled_price_cents: {
62572
+ format: 'float',
62573
+ nullable: true,
62574
+ type: 'number',
62575
+ },
62576
+ status: { type: 'string' },
62577
+ },
62578
+ required: [
62579
+ 'credit_subscription_id',
62580
+ 'status',
62581
+ 'package_quantity',
62582
+ 'price_cents',
62583
+ 'current_period_started_at',
62584
+ 'current_period_ends_at',
62585
+ 'past_due_since',
62586
+ 'canceled_at',
62587
+ 'scheduled_package_quantity',
62588
+ 'scheduled_price_cents',
62589
+ 'scheduled_change_at',
62590
+ 'pending_upgrade',
62591
+ ],
62592
+ type: 'object',
62593
+ },
62594
+ ok: { type: 'boolean' },
62595
+ },
62596
+ required: ['credit_subscription', 'change', 'ok'],
62597
+ type: 'object',
62598
+ },
62599
+ },
62600
+ },
62601
+ description: 'OK',
62602
+ },
62603
+ '400': { description: 'Bad Request' },
62604
+ '401': { description: 'Unauthorized' },
62605
+ },
62606
+ security: [{ console_session_without_workspace: [] }],
62607
+ summary: '/seam/console/v1/credits/subscription/change',
62608
+ tags: [],
62609
+ 'x-fern-sdk-group-name': [
62610
+ 'seam',
62611
+ 'console',
62612
+ 'v1',
62613
+ 'credits',
62614
+ 'subscription',
62615
+ ],
62616
+ 'x-fern-sdk-method-name': 'change',
62617
+ 'x-response-key': null,
62618
+ 'x-title': "Change a Credit Subscription's Package",
62619
+ 'x-undocumented': 'Internal endpoint for Console',
62620
+ },
62621
+ },
62622
+ '/seam/console/v1/credits/subscription/change/cancel': {
62623
+ post: {
62624
+ description:
62625
+ 'Undoes a package downgrade that has not taken effect yet, so the credit subscription keeps its current package.',
62626
+ operationId: 'seamConsoleV1CreditsSubscriptionChangeCancelPost',
62627
+ requestBody: {
62628
+ content: {
62629
+ 'application/json': {
62630
+ schema: {
62631
+ properties: {
62632
+ organization_id: { format: 'uuid', type: 'string' },
62633
+ },
62634
+ required: ['organization_id'],
62635
+ type: 'object',
62636
+ },
62637
+ },
62638
+ },
62639
+ },
62640
+ responses: {
62641
+ '200': {
62642
+ content: {
62643
+ 'application/json': {
62644
+ schema: {
62645
+ properties: {
62646
+ credit_subscription: {
62647
+ properties: {
62648
+ canceled_at: {
62649
+ format: 'date-time',
62650
+ nullable: true,
62651
+ type: 'string',
62652
+ },
62653
+ credit_subscription_id: {
62654
+ format: 'uuid',
62655
+ type: 'string',
62656
+ },
62657
+ current_period_ends_at: {
62658
+ format: 'date-time',
62659
+ nullable: true,
62660
+ type: 'string',
62661
+ },
62662
+ current_period_started_at: {
62663
+ format: 'date-time',
62664
+ nullable: true,
62665
+ type: 'string',
62666
+ },
62667
+ package_quantity: { format: 'float', type: 'number' },
62668
+ past_due_since: {
62669
+ format: 'date-time',
62670
+ nullable: true,
62671
+ type: 'string',
62672
+ },
62673
+ pending_upgrade: {
62674
+ nullable: true,
62675
+ properties: {
62676
+ hosted_invoice_url: {
62677
+ nullable: true,
62678
+ type: 'string',
62679
+ },
62680
+ package_quantity: {
62681
+ format: 'float',
62682
+ type: 'number',
62683
+ },
62684
+ },
62685
+ required: ['package_quantity', 'hosted_invoice_url'],
62686
+ type: 'object',
62687
+ },
62688
+ price_cents: { format: 'float', type: 'number' },
62689
+ scheduled_change_at: {
62690
+ format: 'date-time',
62691
+ nullable: true,
62692
+ type: 'string',
62693
+ },
62694
+ scheduled_package_quantity: {
62695
+ format: 'float',
62696
+ nullable: true,
62697
+ type: 'number',
62698
+ },
62699
+ scheduled_price_cents: {
62700
+ format: 'float',
62701
+ nullable: true,
62702
+ type: 'number',
62703
+ },
62704
+ status: { type: 'string' },
62705
+ },
62706
+ required: [
62707
+ 'credit_subscription_id',
62708
+ 'status',
62709
+ 'package_quantity',
62710
+ 'price_cents',
62711
+ 'current_period_started_at',
62712
+ 'current_period_ends_at',
62713
+ 'past_due_since',
62714
+ 'canceled_at',
62715
+ 'scheduled_package_quantity',
62716
+ 'scheduled_price_cents',
62717
+ 'scheduled_change_at',
62718
+ 'pending_upgrade',
62719
+ ],
62720
+ type: 'object',
62721
+ },
62722
+ ok: { type: 'boolean' },
62723
+ },
62724
+ required: ['credit_subscription', 'ok'],
62725
+ type: 'object',
62726
+ },
62727
+ },
62728
+ },
62729
+ description: 'OK',
62730
+ },
62731
+ '400': { description: 'Bad Request' },
62732
+ '401': { description: 'Unauthorized' },
62733
+ },
62734
+ security: [{ console_session_without_workspace: [] }],
62735
+ summary: '/seam/console/v1/credits/subscription/change/cancel',
62736
+ tags: [],
62737
+ 'x-fern-sdk-group-name': [
62738
+ 'seam',
62739
+ 'console',
62740
+ 'v1',
62741
+ 'credits',
62742
+ 'subscription',
62743
+ 'change',
62744
+ ],
62745
+ 'x-fern-sdk-method-name': 'cancel',
62746
+ 'x-response-key': null,
62747
+ 'x-title': 'Cancel a Scheduled Credit Package Change',
62748
+ 'x-undocumented': 'Internal endpoint for Console',
62749
+ },
62750
+ },
62345
62751
  '/seam/console/v1/credits/subscription/resume': {
62346
62752
  post: {
62347
62753
  description:
@@ -62393,7 +62799,37 @@ const openapi: OpenAPISpec = {
62393
62799
  nullable: true,
62394
62800
  type: 'string',
62395
62801
  },
62802
+ pending_upgrade: {
62803
+ nullable: true,
62804
+ properties: {
62805
+ hosted_invoice_url: {
62806
+ nullable: true,
62807
+ type: 'string',
62808
+ },
62809
+ package_quantity: {
62810
+ format: 'float',
62811
+ type: 'number',
62812
+ },
62813
+ },
62814
+ required: ['package_quantity', 'hosted_invoice_url'],
62815
+ type: 'object',
62816
+ },
62396
62817
  price_cents: { format: 'float', type: 'number' },
62818
+ scheduled_change_at: {
62819
+ format: 'date-time',
62820
+ nullable: true,
62821
+ type: 'string',
62822
+ },
62823
+ scheduled_package_quantity: {
62824
+ format: 'float',
62825
+ nullable: true,
62826
+ type: 'number',
62827
+ },
62828
+ scheduled_price_cents: {
62829
+ format: 'float',
62830
+ nullable: true,
62831
+ type: 'number',
62832
+ },
62397
62833
  status: { type: 'string' },
62398
62834
  },
62399
62835
  required: [
@@ -62405,6 +62841,10 @@ const openapi: OpenAPISpec = {
62405
62841
  'current_period_ends_at',
62406
62842
  'past_due_since',
62407
62843
  'canceled_at',
62844
+ 'scheduled_package_quantity',
62845
+ 'scheduled_price_cents',
62846
+ 'scheduled_change_at',
62847
+ 'pending_upgrade',
62408
62848
  ],
62409
62849
  type: 'object',
62410
62850
  },