@seamapi/types 1.1169.0 → 1.1170.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,13 @@ 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;
91565
91572
  } | null;
91566
91573
  usage: {
91567
91574
  as_of: string;
@@ -91680,6 +91687,80 @@ export type Routes = {
91680
91687
  current_period_ends_at: string | null;
91681
91688
  past_due_since: string | null;
91682
91689
  canceled_at: string | null;
91690
+ scheduled_package_quantity: number | null;
91691
+ scheduled_price_cents: number | null;
91692
+ scheduled_change_at: string | null;
91693
+ pending_upgrade: {
91694
+ package_quantity: number;
91695
+ hosted_invoice_url: string | null;
91696
+ } | null;
91697
+ };
91698
+ };
91699
+ maxDuration: undefined;
91700
+ };
91701
+ '/seam/console/v1/credits/subscription/change': {
91702
+ route: '/seam/console/v1/credits/subscription/change';
91703
+ method: 'POST';
91704
+ queryParams: {};
91705
+ jsonBody: {
91706
+ organization_id: string;
91707
+ package_quantity: number;
91708
+ };
91709
+ commonParams: {};
91710
+ formData: {};
91711
+ jsonResponse: {
91712
+ credit_subscription: {
91713
+ credit_subscription_id: string;
91714
+ status: string;
91715
+ package_quantity: number;
91716
+ price_cents: number;
91717
+ current_period_started_at: string | null;
91718
+ current_period_ends_at: string | null;
91719
+ past_due_since: string | null;
91720
+ canceled_at: string | null;
91721
+ scheduled_package_quantity: number | null;
91722
+ scheduled_price_cents: number | null;
91723
+ scheduled_change_at: string | null;
91724
+ pending_upgrade: {
91725
+ package_quantity: number;
91726
+ hosted_invoice_url: string | null;
91727
+ } | null;
91728
+ };
91729
+ change: {
91730
+ kind: 'upgrade' | 'downgrade';
91731
+ status: 'applied' | 'scheduled' | 'awaiting_authentication' | 'processing';
91732
+ hosted_invoice_url: string | null;
91733
+ carried_credits: number | null;
91734
+ };
91735
+ };
91736
+ maxDuration: undefined;
91737
+ };
91738
+ '/seam/console/v1/credits/subscription/change/cancel': {
91739
+ route: '/seam/console/v1/credits/subscription/change/cancel';
91740
+ method: 'POST';
91741
+ queryParams: {};
91742
+ jsonBody: {
91743
+ organization_id: string;
91744
+ };
91745
+ commonParams: {};
91746
+ formData: {};
91747
+ jsonResponse: {
91748
+ credit_subscription: {
91749
+ credit_subscription_id: string;
91750
+ status: string;
91751
+ package_quantity: number;
91752
+ price_cents: number;
91753
+ current_period_started_at: string | null;
91754
+ current_period_ends_at: string | null;
91755
+ past_due_since: string | null;
91756
+ canceled_at: string | null;
91757
+ scheduled_package_quantity: number | null;
91758
+ scheduled_price_cents: number | null;
91759
+ scheduled_change_at: string | null;
91760
+ pending_upgrade: {
91761
+ package_quantity: number;
91762
+ hosted_invoice_url: string | null;
91763
+ } | null;
91683
91764
  };
91684
91765
  };
91685
91766
  maxDuration: undefined;
@@ -91703,6 +91784,13 @@ export type Routes = {
91703
91784
  current_period_ends_at: string | null;
91704
91785
  past_due_since: string | null;
91705
91786
  canceled_at: string | null;
91787
+ scheduled_package_quantity: number | null;
91788
+ scheduled_price_cents: number | null;
91789
+ scheduled_change_at: string | null;
91790
+ pending_upgrade: {
91791
+ package_quantity: number;
91792
+ hosted_invoice_url: string | null;
91793
+ } | null;
91706
91794
  };
91707
91795
  };
91708
91796
  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.1170.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,6 +61886,10 @@ 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
  },
@@ -62299,7 +62336,37 @@ const openapi: OpenAPISpec = {
62299
62336
  nullable: true,
62300
62337
  type: 'string',
62301
62338
  },
62339
+ pending_upgrade: {
62340
+ nullable: true,
62341
+ properties: {
62342
+ hosted_invoice_url: {
62343
+ nullable: true,
62344
+ type: 'string',
62345
+ },
62346
+ package_quantity: {
62347
+ format: 'float',
62348
+ type: 'number',
62349
+ },
62350
+ },
62351
+ required: ['package_quantity', 'hosted_invoice_url'],
62352
+ type: 'object',
62353
+ },
62302
62354
  price_cents: { format: 'float', type: 'number' },
62355
+ scheduled_change_at: {
62356
+ format: 'date-time',
62357
+ nullable: true,
62358
+ type: 'string',
62359
+ },
62360
+ scheduled_package_quantity: {
62361
+ format: 'float',
62362
+ nullable: true,
62363
+ type: 'number',
62364
+ },
62365
+ scheduled_price_cents: {
62366
+ format: 'float',
62367
+ nullable: true,
62368
+ type: 'number',
62369
+ },
62303
62370
  status: { type: 'string' },
62304
62371
  },
62305
62372
  required: [
@@ -62311,6 +62378,10 @@ const openapi: OpenAPISpec = {
62311
62378
  'current_period_ends_at',
62312
62379
  'past_due_since',
62313
62380
  'canceled_at',
62381
+ 'scheduled_package_quantity',
62382
+ 'scheduled_price_cents',
62383
+ 'scheduled_change_at',
62384
+ 'pending_upgrade',
62314
62385
  ],
62315
62386
  type: 'object',
62316
62387
  },
@@ -62342,6 +62413,298 @@ const openapi: OpenAPISpec = {
62342
62413
  'x-undocumented': 'Internal endpoint for Console',
62343
62414
  },
62344
62415
  },
62416
+ '/seam/console/v1/credits/subscription/change': {
62417
+ post: {
62418
+ description:
62419
+ '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.',
62420
+ operationId: 'seamConsoleV1CreditsSubscriptionChangePost',
62421
+ requestBody: {
62422
+ content: {
62423
+ 'application/json': {
62424
+ schema: {
62425
+ properties: {
62426
+ organization_id: { format: 'uuid', type: 'string' },
62427
+ package_quantity: {
62428
+ exclusiveMinimum: true,
62429
+ minimum: 0,
62430
+ type: 'integer',
62431
+ },
62432
+ },
62433
+ required: ['organization_id', 'package_quantity'],
62434
+ type: 'object',
62435
+ },
62436
+ },
62437
+ },
62438
+ },
62439
+ responses: {
62440
+ '200': {
62441
+ content: {
62442
+ 'application/json': {
62443
+ schema: {
62444
+ properties: {
62445
+ change: {
62446
+ properties: {
62447
+ carried_credits: {
62448
+ format: 'float',
62449
+ nullable: true,
62450
+ type: 'number',
62451
+ },
62452
+ hosted_invoice_url: { nullable: true, type: 'string' },
62453
+ kind: {
62454
+ enum: ['upgrade', 'downgrade'],
62455
+ type: 'string',
62456
+ },
62457
+ status: {
62458
+ enum: [
62459
+ 'applied',
62460
+ 'scheduled',
62461
+ 'awaiting_authentication',
62462
+ 'processing',
62463
+ ],
62464
+ type: 'string',
62465
+ },
62466
+ },
62467
+ required: [
62468
+ 'kind',
62469
+ 'status',
62470
+ 'hosted_invoice_url',
62471
+ 'carried_credits',
62472
+ ],
62473
+ type: 'object',
62474
+ },
62475
+ credit_subscription: {
62476
+ properties: {
62477
+ canceled_at: {
62478
+ format: 'date-time',
62479
+ nullable: true,
62480
+ type: 'string',
62481
+ },
62482
+ credit_subscription_id: {
62483
+ format: 'uuid',
62484
+ type: 'string',
62485
+ },
62486
+ current_period_ends_at: {
62487
+ format: 'date-time',
62488
+ nullable: true,
62489
+ type: 'string',
62490
+ },
62491
+ current_period_started_at: {
62492
+ format: 'date-time',
62493
+ nullable: true,
62494
+ type: 'string',
62495
+ },
62496
+ package_quantity: { format: 'float', type: 'number' },
62497
+ past_due_since: {
62498
+ format: 'date-time',
62499
+ nullable: true,
62500
+ type: 'string',
62501
+ },
62502
+ pending_upgrade: {
62503
+ nullable: true,
62504
+ properties: {
62505
+ hosted_invoice_url: {
62506
+ nullable: true,
62507
+ type: 'string',
62508
+ },
62509
+ package_quantity: {
62510
+ format: 'float',
62511
+ type: 'number',
62512
+ },
62513
+ },
62514
+ required: ['package_quantity', 'hosted_invoice_url'],
62515
+ type: 'object',
62516
+ },
62517
+ price_cents: { format: 'float', type: 'number' },
62518
+ scheduled_change_at: {
62519
+ format: 'date-time',
62520
+ nullable: true,
62521
+ type: 'string',
62522
+ },
62523
+ scheduled_package_quantity: {
62524
+ format: 'float',
62525
+ nullable: true,
62526
+ type: 'number',
62527
+ },
62528
+ scheduled_price_cents: {
62529
+ format: 'float',
62530
+ nullable: true,
62531
+ type: 'number',
62532
+ },
62533
+ status: { type: 'string' },
62534
+ },
62535
+ required: [
62536
+ 'credit_subscription_id',
62537
+ 'status',
62538
+ 'package_quantity',
62539
+ 'price_cents',
62540
+ 'current_period_started_at',
62541
+ 'current_period_ends_at',
62542
+ 'past_due_since',
62543
+ 'canceled_at',
62544
+ 'scheduled_package_quantity',
62545
+ 'scheduled_price_cents',
62546
+ 'scheduled_change_at',
62547
+ 'pending_upgrade',
62548
+ ],
62549
+ type: 'object',
62550
+ },
62551
+ ok: { type: 'boolean' },
62552
+ },
62553
+ required: ['credit_subscription', 'change', 'ok'],
62554
+ type: 'object',
62555
+ },
62556
+ },
62557
+ },
62558
+ description: 'OK',
62559
+ },
62560
+ '400': { description: 'Bad Request' },
62561
+ '401': { description: 'Unauthorized' },
62562
+ },
62563
+ security: [{ console_session_without_workspace: [] }],
62564
+ summary: '/seam/console/v1/credits/subscription/change',
62565
+ tags: [],
62566
+ 'x-fern-sdk-group-name': [
62567
+ 'seam',
62568
+ 'console',
62569
+ 'v1',
62570
+ 'credits',
62571
+ 'subscription',
62572
+ ],
62573
+ 'x-fern-sdk-method-name': 'change',
62574
+ 'x-response-key': null,
62575
+ 'x-title': "Change a Credit Subscription's Package",
62576
+ 'x-undocumented': 'Internal endpoint for Console',
62577
+ },
62578
+ },
62579
+ '/seam/console/v1/credits/subscription/change/cancel': {
62580
+ post: {
62581
+ description:
62582
+ 'Undoes a package downgrade that has not taken effect yet, so the credit subscription keeps its current package.',
62583
+ operationId: 'seamConsoleV1CreditsSubscriptionChangeCancelPost',
62584
+ requestBody: {
62585
+ content: {
62586
+ 'application/json': {
62587
+ schema: {
62588
+ properties: {
62589
+ organization_id: { format: 'uuid', type: 'string' },
62590
+ },
62591
+ required: ['organization_id'],
62592
+ type: 'object',
62593
+ },
62594
+ },
62595
+ },
62596
+ },
62597
+ responses: {
62598
+ '200': {
62599
+ content: {
62600
+ 'application/json': {
62601
+ schema: {
62602
+ properties: {
62603
+ credit_subscription: {
62604
+ properties: {
62605
+ canceled_at: {
62606
+ format: 'date-time',
62607
+ nullable: true,
62608
+ type: 'string',
62609
+ },
62610
+ credit_subscription_id: {
62611
+ format: 'uuid',
62612
+ type: 'string',
62613
+ },
62614
+ current_period_ends_at: {
62615
+ format: 'date-time',
62616
+ nullable: true,
62617
+ type: 'string',
62618
+ },
62619
+ current_period_started_at: {
62620
+ format: 'date-time',
62621
+ nullable: true,
62622
+ type: 'string',
62623
+ },
62624
+ package_quantity: { format: 'float', type: 'number' },
62625
+ past_due_since: {
62626
+ format: 'date-time',
62627
+ nullable: true,
62628
+ type: 'string',
62629
+ },
62630
+ pending_upgrade: {
62631
+ nullable: true,
62632
+ properties: {
62633
+ hosted_invoice_url: {
62634
+ nullable: true,
62635
+ type: 'string',
62636
+ },
62637
+ package_quantity: {
62638
+ format: 'float',
62639
+ type: 'number',
62640
+ },
62641
+ },
62642
+ required: ['package_quantity', 'hosted_invoice_url'],
62643
+ type: 'object',
62644
+ },
62645
+ price_cents: { format: 'float', type: 'number' },
62646
+ scheduled_change_at: {
62647
+ format: 'date-time',
62648
+ nullable: true,
62649
+ type: 'string',
62650
+ },
62651
+ scheduled_package_quantity: {
62652
+ format: 'float',
62653
+ nullable: true,
62654
+ type: 'number',
62655
+ },
62656
+ scheduled_price_cents: {
62657
+ format: 'float',
62658
+ nullable: true,
62659
+ type: 'number',
62660
+ },
62661
+ status: { type: 'string' },
62662
+ },
62663
+ required: [
62664
+ 'credit_subscription_id',
62665
+ 'status',
62666
+ 'package_quantity',
62667
+ 'price_cents',
62668
+ 'current_period_started_at',
62669
+ 'current_period_ends_at',
62670
+ 'past_due_since',
62671
+ 'canceled_at',
62672
+ 'scheduled_package_quantity',
62673
+ 'scheduled_price_cents',
62674
+ 'scheduled_change_at',
62675
+ 'pending_upgrade',
62676
+ ],
62677
+ type: 'object',
62678
+ },
62679
+ ok: { type: 'boolean' },
62680
+ },
62681
+ required: ['credit_subscription', 'ok'],
62682
+ type: 'object',
62683
+ },
62684
+ },
62685
+ },
62686
+ description: 'OK',
62687
+ },
62688
+ '400': { description: 'Bad Request' },
62689
+ '401': { description: 'Unauthorized' },
62690
+ },
62691
+ security: [{ console_session_without_workspace: [] }],
62692
+ summary: '/seam/console/v1/credits/subscription/change/cancel',
62693
+ tags: [],
62694
+ 'x-fern-sdk-group-name': [
62695
+ 'seam',
62696
+ 'console',
62697
+ 'v1',
62698
+ 'credits',
62699
+ 'subscription',
62700
+ 'change',
62701
+ ],
62702
+ 'x-fern-sdk-method-name': 'cancel',
62703
+ 'x-response-key': null,
62704
+ 'x-title': 'Cancel a Scheduled Credit Package Change',
62705
+ 'x-undocumented': 'Internal endpoint for Console',
62706
+ },
62707
+ },
62345
62708
  '/seam/console/v1/credits/subscription/resume': {
62346
62709
  post: {
62347
62710
  description:
@@ -62393,7 +62756,37 @@ const openapi: OpenAPISpec = {
62393
62756
  nullable: true,
62394
62757
  type: 'string',
62395
62758
  },
62759
+ pending_upgrade: {
62760
+ nullable: true,
62761
+ properties: {
62762
+ hosted_invoice_url: {
62763
+ nullable: true,
62764
+ type: 'string',
62765
+ },
62766
+ package_quantity: {
62767
+ format: 'float',
62768
+ type: 'number',
62769
+ },
62770
+ },
62771
+ required: ['package_quantity', 'hosted_invoice_url'],
62772
+ type: 'object',
62773
+ },
62396
62774
  price_cents: { format: 'float', type: 'number' },
62775
+ scheduled_change_at: {
62776
+ format: 'date-time',
62777
+ nullable: true,
62778
+ type: 'string',
62779
+ },
62780
+ scheduled_package_quantity: {
62781
+ format: 'float',
62782
+ nullable: true,
62783
+ type: 'number',
62784
+ },
62785
+ scheduled_price_cents: {
62786
+ format: 'float',
62787
+ nullable: true,
62788
+ type: 'number',
62789
+ },
62397
62790
  status: { type: 'string' },
62398
62791
  },
62399
62792
  required: [
@@ -62405,6 +62798,10 @@ const openapi: OpenAPISpec = {
62405
62798
  'current_period_ends_at',
62406
62799
  'past_due_since',
62407
62800
  'canceled_at',
62801
+ 'scheduled_package_quantity',
62802
+ 'scheduled_price_cents',
62803
+ 'scheduled_change_at',
62804
+ 'pending_upgrade',
62408
62805
  ],
62409
62806
  type: 'object',
62410
62807
  },
@@ -109421,6 +109421,13 @@ export type Routes = {
109421
109421
  current_period_ends_at: string | null
109422
109422
  past_due_since: string | null
109423
109423
  canceled_at: string | null
109424
+ scheduled_package_quantity: number | null
109425
+ scheduled_price_cents: number | null
109426
+ scheduled_change_at: string | null
109427
+ pending_upgrade: {
109428
+ package_quantity: number
109429
+ hosted_invoice_url: string | null
109430
+ } | null
109424
109431
  } | null
109425
109432
  usage: {
109426
109433
  as_of: string
@@ -109539,6 +109546,81 @@ export type Routes = {
109539
109546
  current_period_ends_at: string | null
109540
109547
  past_due_since: string | null
109541
109548
  canceled_at: string | null
109549
+ scheduled_package_quantity: number | null
109550
+ scheduled_price_cents: number | null
109551
+ scheduled_change_at: string | null
109552
+ pending_upgrade: {
109553
+ package_quantity: number
109554
+ hosted_invoice_url: string | null
109555
+ } | null
109556
+ }
109557
+ }
109558
+ maxDuration: undefined
109559
+ }
109560
+ '/seam/console/v1/credits/subscription/change': {
109561
+ route: '/seam/console/v1/credits/subscription/change'
109562
+ method: 'POST'
109563
+ queryParams: {}
109564
+ jsonBody: {
109565
+ organization_id: string
109566
+ package_quantity: number
109567
+ }
109568
+ commonParams: {}
109569
+ formData: {}
109570
+ jsonResponse: {
109571
+ credit_subscription: {
109572
+ credit_subscription_id: string
109573
+ status: string
109574
+ package_quantity: number
109575
+ price_cents: number
109576
+ current_period_started_at: string | null
109577
+ current_period_ends_at: string | null
109578
+ past_due_since: string | null
109579
+ canceled_at: string | null
109580
+ scheduled_package_quantity: number | null
109581
+ scheduled_price_cents: number | null
109582
+ scheduled_change_at: string | null
109583
+ pending_upgrade: {
109584
+ package_quantity: number
109585
+ hosted_invoice_url: string | null
109586
+ } | null
109587
+ }
109588
+ change: {
109589
+ kind: 'upgrade' | 'downgrade'
109590
+ status:
109591
+ 'applied' | 'scheduled' | 'awaiting_authentication' | 'processing'
109592
+ hosted_invoice_url: string | null
109593
+ carried_credits: number | null
109594
+ }
109595
+ }
109596
+ maxDuration: undefined
109597
+ }
109598
+ '/seam/console/v1/credits/subscription/change/cancel': {
109599
+ route: '/seam/console/v1/credits/subscription/change/cancel'
109600
+ method: 'POST'
109601
+ queryParams: {}
109602
+ jsonBody: {
109603
+ organization_id: string
109604
+ }
109605
+ commonParams: {}
109606
+ formData: {}
109607
+ jsonResponse: {
109608
+ credit_subscription: {
109609
+ credit_subscription_id: string
109610
+ status: string
109611
+ package_quantity: number
109612
+ price_cents: number
109613
+ current_period_started_at: string | null
109614
+ current_period_ends_at: string | null
109615
+ past_due_since: string | null
109616
+ canceled_at: string | null
109617
+ scheduled_package_quantity: number | null
109618
+ scheduled_price_cents: number | null
109619
+ scheduled_change_at: string | null
109620
+ pending_upgrade: {
109621
+ package_quantity: number
109622
+ hosted_invoice_url: string | null
109623
+ } | null
109542
109624
  }
109543
109625
  }
109544
109626
  maxDuration: undefined
@@ -109562,6 +109644,13 @@ export type Routes = {
109562
109644
  current_period_ends_at: string | null
109563
109645
  past_due_since: string | null
109564
109646
  canceled_at: string | null
109647
+ scheduled_package_quantity: number | null
109648
+ scheduled_price_cents: number | null
109649
+ scheduled_change_at: string | null
109650
+ pending_upgrade: {
109651
+ package_quantity: number
109652
+ hosted_invoice_url: string | null
109653
+ } | null
109565
109654
  }
109566
109655
  }
109567
109656
  maxDuration: undefined