@seamapi/types 1.1168.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.
|
@@ -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
|
},
|
|
@@ -61860,6 +61897,7 @@ const openapi: OpenAPISpec = {
|
|
|
61860
61897
|
usage: {
|
|
61861
61898
|
nullable: true,
|
|
61862
61899
|
properties: {
|
|
61900
|
+
as_of: { format: 'date-time', type: 'string' },
|
|
61863
61901
|
breakdown: {
|
|
61864
61902
|
items: {
|
|
61865
61903
|
properties: {
|
|
@@ -61930,6 +61968,7 @@ const openapi: OpenAPISpec = {
|
|
|
61930
61968
|
used_tokens: { format: 'float', type: 'number' },
|
|
61931
61969
|
},
|
|
61932
61970
|
required: [
|
|
61971
|
+
'as_of',
|
|
61933
61972
|
'period_started_at',
|
|
61934
61973
|
'period_ends_at',
|
|
61935
61974
|
'package_tokens',
|
|
@@ -62297,7 +62336,37 @@ const openapi: OpenAPISpec = {
|
|
|
62297
62336
|
nullable: true,
|
|
62298
62337
|
type: 'string',
|
|
62299
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
|
+
},
|
|
62300
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
|
+
},
|
|
62301
62370
|
status: { type: 'string' },
|
|
62302
62371
|
},
|
|
62303
62372
|
required: [
|
|
@@ -62309,6 +62378,10 @@ const openapi: OpenAPISpec = {
|
|
|
62309
62378
|
'current_period_ends_at',
|
|
62310
62379
|
'past_due_since',
|
|
62311
62380
|
'canceled_at',
|
|
62381
|
+
'scheduled_package_quantity',
|
|
62382
|
+
'scheduled_price_cents',
|
|
62383
|
+
'scheduled_change_at',
|
|
62384
|
+
'pending_upgrade',
|
|
62312
62385
|
],
|
|
62313
62386
|
type: 'object',
|
|
62314
62387
|
},
|
|
@@ -62340,6 +62413,298 @@ const openapi: OpenAPISpec = {
|
|
|
62340
62413
|
'x-undocumented': 'Internal endpoint for Console',
|
|
62341
62414
|
},
|
|
62342
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
|
+
},
|
|
62343
62708
|
'/seam/console/v1/credits/subscription/resume': {
|
|
62344
62709
|
post: {
|
|
62345
62710
|
description:
|
|
@@ -62391,7 +62756,37 @@ const openapi: OpenAPISpec = {
|
|
|
62391
62756
|
nullable: true,
|
|
62392
62757
|
type: 'string',
|
|
62393
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
|
+
},
|
|
62394
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
|
+
},
|
|
62395
62790
|
status: { type: 'string' },
|
|
62396
62791
|
},
|
|
62397
62792
|
required: [
|
|
@@ -62403,6 +62798,10 @@ const openapi: OpenAPISpec = {
|
|
|
62403
62798
|
'current_period_ends_at',
|
|
62404
62799
|
'past_due_since',
|
|
62405
62800
|
'canceled_at',
|
|
62801
|
+
'scheduled_package_quantity',
|
|
62802
|
+
'scheduled_price_cents',
|
|
62803
|
+
'scheduled_change_at',
|
|
62804
|
+
'pending_upgrade',
|
|
62406
62805
|
],
|
|
62407
62806
|
type: 'object',
|
|
62408
62807
|
},
|
|
@@ -62434,6 +62833,231 @@ const openapi: OpenAPISpec = {
|
|
|
62434
62833
|
'x-undocumented': 'Internal endpoint for Console',
|
|
62435
62834
|
},
|
|
62436
62835
|
},
|
|
62836
|
+
'/seam/console/v1/credits/usage/get': {
|
|
62837
|
+
post: {
|
|
62838
|
+
description:
|
|
62839
|
+
"Returns the organization's credit usage for the current subscription period (or the trailing 30 days without a subscription), broken down by workspace, by action and by day.",
|
|
62840
|
+
operationId: 'seamConsoleV1CreditsUsageGetPost',
|
|
62841
|
+
requestBody: {
|
|
62842
|
+
content: {
|
|
62843
|
+
'application/json': {
|
|
62844
|
+
schema: {
|
|
62845
|
+
properties: {
|
|
62846
|
+
organization_id: { format: 'uuid', type: 'string' },
|
|
62847
|
+
},
|
|
62848
|
+
required: ['organization_id'],
|
|
62849
|
+
type: 'object',
|
|
62850
|
+
},
|
|
62851
|
+
},
|
|
62852
|
+
},
|
|
62853
|
+
},
|
|
62854
|
+
responses: {
|
|
62855
|
+
'200': {
|
|
62856
|
+
content: {
|
|
62857
|
+
'application/json': {
|
|
62858
|
+
schema: {
|
|
62859
|
+
properties: {
|
|
62860
|
+
ok: { type: 'boolean' },
|
|
62861
|
+
usage: {
|
|
62862
|
+
properties: {
|
|
62863
|
+
as_of: { format: 'date-time', type: 'string' },
|
|
62864
|
+
by_category: {
|
|
62865
|
+
items: {
|
|
62866
|
+
properties: {
|
|
62867
|
+
credits: { format: 'float', type: 'number' },
|
|
62868
|
+
credits_per_unit: {
|
|
62869
|
+
format: 'float',
|
|
62870
|
+
type: 'number',
|
|
62871
|
+
},
|
|
62872
|
+
key: { type: 'string' },
|
|
62873
|
+
kind: {
|
|
62874
|
+
enum: ['connectivity', 'action'],
|
|
62875
|
+
type: 'string',
|
|
62876
|
+
},
|
|
62877
|
+
label: { type: 'string' },
|
|
62878
|
+
percent_of_total: {
|
|
62879
|
+
format: 'float',
|
|
62880
|
+
type: 'number',
|
|
62881
|
+
},
|
|
62882
|
+
quantity: { format: 'float', type: 'number' },
|
|
62883
|
+
},
|
|
62884
|
+
required: [
|
|
62885
|
+
'kind',
|
|
62886
|
+
'key',
|
|
62887
|
+
'label',
|
|
62888
|
+
'quantity',
|
|
62889
|
+
'credits_per_unit',
|
|
62890
|
+
'credits',
|
|
62891
|
+
'percent_of_total',
|
|
62892
|
+
],
|
|
62893
|
+
type: 'object',
|
|
62894
|
+
},
|
|
62895
|
+
nullable: true,
|
|
62896
|
+
type: 'array',
|
|
62897
|
+
},
|
|
62898
|
+
by_workspace: {
|
|
62899
|
+
items: {
|
|
62900
|
+
properties: {
|
|
62901
|
+
actions: {
|
|
62902
|
+
items: {
|
|
62903
|
+
properties: {
|
|
62904
|
+
billable_action: { type: 'string' },
|
|
62905
|
+
count: { format: 'float', type: 'number' },
|
|
62906
|
+
credits: {
|
|
62907
|
+
format: 'float',
|
|
62908
|
+
type: 'number',
|
|
62909
|
+
},
|
|
62910
|
+
label: { type: 'string' },
|
|
62911
|
+
},
|
|
62912
|
+
required: [
|
|
62913
|
+
'billable_action',
|
|
62914
|
+
'label',
|
|
62915
|
+
'count',
|
|
62916
|
+
'credits',
|
|
62917
|
+
],
|
|
62918
|
+
type: 'object',
|
|
62919
|
+
},
|
|
62920
|
+
type: 'array',
|
|
62921
|
+
},
|
|
62922
|
+
connectivity: {
|
|
62923
|
+
items: {
|
|
62924
|
+
properties: {
|
|
62925
|
+
credits: {
|
|
62926
|
+
format: 'float',
|
|
62927
|
+
type: 'number',
|
|
62928
|
+
},
|
|
62929
|
+
credits_per_device_month: {
|
|
62930
|
+
format: 'float',
|
|
62931
|
+
type: 'number',
|
|
62932
|
+
},
|
|
62933
|
+
device_months: {
|
|
62934
|
+
format: 'float',
|
|
62935
|
+
type: 'number',
|
|
62936
|
+
},
|
|
62937
|
+
label: { type: 'string' },
|
|
62938
|
+
metric: { type: 'string' },
|
|
62939
|
+
},
|
|
62940
|
+
required: [
|
|
62941
|
+
'metric',
|
|
62942
|
+
'label',
|
|
62943
|
+
'device_months',
|
|
62944
|
+
'credits_per_device_month',
|
|
62945
|
+
'credits',
|
|
62946
|
+
],
|
|
62947
|
+
type: 'object',
|
|
62948
|
+
},
|
|
62949
|
+
type: 'array',
|
|
62950
|
+
},
|
|
62951
|
+
credits: { format: 'float', type: 'number' },
|
|
62952
|
+
percent_of_total: {
|
|
62953
|
+
format: 'float',
|
|
62954
|
+
type: 'number',
|
|
62955
|
+
},
|
|
62956
|
+
workspace_id: { nullable: true, type: 'string' },
|
|
62957
|
+
workspace_name: {
|
|
62958
|
+
nullable: true,
|
|
62959
|
+
type: 'string',
|
|
62960
|
+
},
|
|
62961
|
+
},
|
|
62962
|
+
required: [
|
|
62963
|
+
'workspace_id',
|
|
62964
|
+
'workspace_name',
|
|
62965
|
+
'connectivity',
|
|
62966
|
+
'actions',
|
|
62967
|
+
'credits',
|
|
62968
|
+
'percent_of_total',
|
|
62969
|
+
],
|
|
62970
|
+
type: 'object',
|
|
62971
|
+
},
|
|
62972
|
+
nullable: true,
|
|
62973
|
+
type: 'array',
|
|
62974
|
+
},
|
|
62975
|
+
daily: {
|
|
62976
|
+
items: {
|
|
62977
|
+
properties: {
|
|
62978
|
+
action_credits: {
|
|
62979
|
+
format: 'float',
|
|
62980
|
+
type: 'number',
|
|
62981
|
+
},
|
|
62982
|
+
connectivity_credits: {
|
|
62983
|
+
format: 'float',
|
|
62984
|
+
type: 'number',
|
|
62985
|
+
},
|
|
62986
|
+
date: { type: 'string' },
|
|
62987
|
+
previous_period_credits: {
|
|
62988
|
+
format: 'float',
|
|
62989
|
+
nullable: true,
|
|
62990
|
+
type: 'number',
|
|
62991
|
+
},
|
|
62992
|
+
},
|
|
62993
|
+
required: [
|
|
62994
|
+
'date',
|
|
62995
|
+
'connectivity_credits',
|
|
62996
|
+
'action_credits',
|
|
62997
|
+
'previous_period_credits',
|
|
62998
|
+
],
|
|
62999
|
+
type: 'object',
|
|
63000
|
+
},
|
|
63001
|
+
nullable: true,
|
|
63002
|
+
type: 'array',
|
|
63003
|
+
},
|
|
63004
|
+
is_daily_connectivity_included: { type: 'boolean' },
|
|
63005
|
+
package_credits: {
|
|
63006
|
+
format: 'float',
|
|
63007
|
+
nullable: true,
|
|
63008
|
+
type: 'number',
|
|
63009
|
+
},
|
|
63010
|
+
period_ends_at: { format: 'date-time', type: 'string' },
|
|
63011
|
+
period_started_at: {
|
|
63012
|
+
format: 'date-time',
|
|
63013
|
+
type: 'string',
|
|
63014
|
+
},
|
|
63015
|
+
source: {
|
|
63016
|
+
enum: ['metronome', 'estimate'],
|
|
63017
|
+
type: 'string',
|
|
63018
|
+
},
|
|
63019
|
+
used_credits: {
|
|
63020
|
+
format: 'float',
|
|
63021
|
+
nullable: true,
|
|
63022
|
+
type: 'number',
|
|
63023
|
+
},
|
|
63024
|
+
},
|
|
63025
|
+
required: [
|
|
63026
|
+
'source',
|
|
63027
|
+
'as_of',
|
|
63028
|
+
'period_started_at',
|
|
63029
|
+
'period_ends_at',
|
|
63030
|
+
'package_credits',
|
|
63031
|
+
'used_credits',
|
|
63032
|
+
'by_workspace',
|
|
63033
|
+
'by_category',
|
|
63034
|
+
'daily',
|
|
63035
|
+
'is_daily_connectivity_included',
|
|
63036
|
+
],
|
|
63037
|
+
type: 'object',
|
|
63038
|
+
},
|
|
63039
|
+
},
|
|
63040
|
+
required: ['usage', 'ok'],
|
|
63041
|
+
type: 'object',
|
|
63042
|
+
},
|
|
63043
|
+
},
|
|
63044
|
+
},
|
|
63045
|
+
description: 'OK',
|
|
63046
|
+
},
|
|
63047
|
+
'400': { description: 'Bad Request' },
|
|
63048
|
+
'401': { description: 'Unauthorized' },
|
|
63049
|
+
},
|
|
63050
|
+
security: [{ console_session_without_workspace: [] }],
|
|
63051
|
+
summary: '/seam/console/v1/credits/usage/get',
|
|
63052
|
+
tags: [],
|
|
63053
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'credits', 'usage'],
|
|
63054
|
+
'x-fern-sdk-method-name': 'get',
|
|
63055
|
+
'x-fern-sdk-return-value': 'usage',
|
|
63056
|
+
'x-response-key': 'usage',
|
|
63057
|
+
'x-title': "Get an Organization's Credit Usage in Detail",
|
|
63058
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
63059
|
+
},
|
|
63060
|
+
},
|
|
62437
63061
|
'/seam/console/v1/get_resource_locator': {
|
|
62438
63062
|
get: {
|
|
62439
63063
|
description:
|