@seamapi/types 1.1159.0 → 1.1161.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.
@@ -50212,7 +50212,7 @@ const openapi = {
50212
50212
  },
50213
50213
  '/devices/delete': {
50214
50214
  delete: {
50215
- description: 'Deletes a specified [device](https://www.seam.co/docs/core-concepts/devices).',
50215
+ description: 'Unmanages a specified [device](https://www.seam.co/docs/core-concepts/devices), the same as [`/devices/update`](https://www.seam.co/docs/api/devices/update) with `is_managed: false`. The device is no longer billed and stops appearing in `/devices/list`, but keeps syncing and can be managed again with [`/devices/unmanaged/update`](https://www.seam.co/docs/api/devices/unmanaged/update).',
50216
50216
  operationId: 'devicesDeleteDelete',
50217
50217
  parameters: [
50218
50218
  {
@@ -50249,12 +50249,12 @@ const openapi = {
50249
50249
  ],
50250
50250
  summary: '/devices/delete',
50251
50251
  tags: ['/devices'],
50252
- 'x-deprecated': 'Deleting a device is no longer supported and will be removed.',
50252
+ 'x-deprecated': 'Deleting a device is no longer supported. Use `/devices/update` with `is_managed: false` to unmanage the device instead.',
50253
50253
  'x-fern-sdk-group-name': ['devices'],
50254
50254
  'x-fern-sdk-method-name': 'delete',
50255
50255
  'x-response-key': null,
50256
50256
  'x-title': 'Delete a Device',
50257
- 'x-undocumented': 'Deleting a device is no longer supported and will be removed.',
50257
+ 'x-undocumented': 'Deleting a device is no longer supported. Unmanage the device instead.',
50258
50258
  },
50259
50259
  },
50260
50260
  '/devices/get': {
@@ -56023,6 +56023,509 @@ const openapi = {
56023
56023
  'x-undocumented': 'Internal endpoint for Console',
56024
56024
  },
56025
56025
  },
56026
+ '/seam/console/v1/credits/checkout/start': {
56027
+ post: {
56028
+ description: "Starts the Stripe Checkout for the first purchase of a monthly token package, or resumes the organization's pending one.",
56029
+ operationId: 'seamConsoleV1CreditsCheckoutStartPost',
56030
+ requestBody: {
56031
+ content: {
56032
+ 'application/json': {
56033
+ schema: {
56034
+ properties: {
56035
+ cancel_url: { format: 'uri', type: 'string' },
56036
+ organization_id: { format: 'uuid', type: 'string' },
56037
+ package_quantity: {
56038
+ exclusiveMinimum: true,
56039
+ minimum: 0,
56040
+ type: 'integer',
56041
+ },
56042
+ success_url: { format: 'uri', type: 'string' },
56043
+ },
56044
+ required: [
56045
+ 'organization_id',
56046
+ 'package_quantity',
56047
+ 'success_url',
56048
+ 'cancel_url',
56049
+ ],
56050
+ type: 'object',
56051
+ },
56052
+ },
56053
+ },
56054
+ },
56055
+ responses: {
56056
+ '200': {
56057
+ content: {
56058
+ 'application/json': {
56059
+ schema: {
56060
+ properties: {
56061
+ checkout_url: { format: 'uri', type: 'string' },
56062
+ credit_subscription_id: { format: 'uuid', type: 'string' },
56063
+ ok: { type: 'boolean' },
56064
+ },
56065
+ required: ['checkout_url', 'credit_subscription_id', 'ok'],
56066
+ type: 'object',
56067
+ },
56068
+ },
56069
+ },
56070
+ description: 'OK',
56071
+ },
56072
+ '400': { description: 'Bad Request' },
56073
+ '401': { description: 'Unauthorized' },
56074
+ },
56075
+ security: [{ console_session_without_workspace: [] }],
56076
+ summary: '/seam/console/v1/credits/checkout/start',
56077
+ tags: [],
56078
+ 'x-fern-sdk-group-name': [
56079
+ 'seam',
56080
+ 'console',
56081
+ 'v1',
56082
+ 'credits',
56083
+ 'checkout',
56084
+ ],
56085
+ 'x-fern-sdk-method-name': 'start',
56086
+ 'x-response-key': null,
56087
+ 'x-title': 'Start a Credit Subscription Checkout',
56088
+ 'x-undocumented': 'Internal endpoint for Console',
56089
+ },
56090
+ },
56091
+ '/seam/console/v1/credits/get': {
56092
+ post: {
56093
+ description: "Returns the organization's credit subscription and its token usage for the subscription's current period.",
56094
+ operationId: 'seamConsoleV1CreditsGetPost',
56095
+ requestBody: {
56096
+ content: {
56097
+ 'application/json': {
56098
+ schema: {
56099
+ properties: {
56100
+ organization_id: { format: 'uuid', type: 'string' },
56101
+ },
56102
+ required: ['organization_id'],
56103
+ type: 'object',
56104
+ },
56105
+ },
56106
+ },
56107
+ },
56108
+ responses: {
56109
+ '200': {
56110
+ content: {
56111
+ 'application/json': {
56112
+ schema: {
56113
+ properties: {
56114
+ credits: {
56115
+ properties: {
56116
+ credit_subscription: {
56117
+ nullable: true,
56118
+ properties: {
56119
+ canceled_at: {
56120
+ format: 'date-time',
56121
+ nullable: true,
56122
+ type: 'string',
56123
+ },
56124
+ credit_subscription_id: {
56125
+ format: 'uuid',
56126
+ type: 'string',
56127
+ },
56128
+ current_period_ends_at: {
56129
+ format: 'date-time',
56130
+ nullable: true,
56131
+ type: 'string',
56132
+ },
56133
+ current_period_started_at: {
56134
+ format: 'date-time',
56135
+ nullable: true,
56136
+ type: 'string',
56137
+ },
56138
+ package_quantity: {
56139
+ format: 'float',
56140
+ type: 'number',
56141
+ },
56142
+ past_due_since: {
56143
+ format: 'date-time',
56144
+ nullable: true,
56145
+ type: 'string',
56146
+ },
56147
+ price_cents: { format: 'float', type: 'number' },
56148
+ status: { type: 'string' },
56149
+ },
56150
+ required: [
56151
+ 'credit_subscription_id',
56152
+ 'status',
56153
+ 'package_quantity',
56154
+ 'price_cents',
56155
+ 'current_period_started_at',
56156
+ 'current_period_ends_at',
56157
+ 'past_due_since',
56158
+ 'canceled_at',
56159
+ ],
56160
+ type: 'object',
56161
+ },
56162
+ is_test_mode: { type: 'boolean' },
56163
+ usage: {
56164
+ nullable: true,
56165
+ properties: {
56166
+ breakdown: {
56167
+ items: {
56168
+ properties: {
56169
+ billable_action: { type: 'string' },
56170
+ count: { format: 'float', type: 'number' },
56171
+ label: { type: 'string' },
56172
+ token_weight: {
56173
+ format: 'float',
56174
+ type: 'number',
56175
+ },
56176
+ tokens: { format: 'float', type: 'number' },
56177
+ },
56178
+ required: [
56179
+ 'billable_action',
56180
+ 'label',
56181
+ 'count',
56182
+ 'token_weight',
56183
+ 'tokens',
56184
+ ],
56185
+ type: 'object',
56186
+ },
56187
+ type: 'array',
56188
+ },
56189
+ connectivity: {
56190
+ items: {
56191
+ properties: {
56192
+ device_months: {
56193
+ format: 'float',
56194
+ type: 'number',
56195
+ },
56196
+ label: { type: 'string' },
56197
+ metric: { type: 'string' },
56198
+ tokens: { format: 'float', type: 'number' },
56199
+ },
56200
+ required: [
56201
+ 'metric',
56202
+ 'label',
56203
+ 'device_months',
56204
+ 'tokens',
56205
+ ],
56206
+ type: 'object',
56207
+ },
56208
+ type: 'array',
56209
+ },
56210
+ estimated_extra_cents: {
56211
+ format: 'float',
56212
+ type: 'number',
56213
+ },
56214
+ extra_cents_per_token: {
56215
+ format: 'float',
56216
+ type: 'number',
56217
+ },
56218
+ extra_tokens: { format: 'float', type: 'number' },
56219
+ package_tokens: { format: 'float', type: 'number' },
56220
+ percent_used: { format: 'float', type: 'number' },
56221
+ period_ends_at: {
56222
+ format: 'date-time',
56223
+ type: 'string',
56224
+ },
56225
+ period_started_at: {
56226
+ format: 'date-time',
56227
+ type: 'string',
56228
+ },
56229
+ remaining_tokens: {
56230
+ format: 'float',
56231
+ type: 'number',
56232
+ },
56233
+ used_tokens: { format: 'float', type: 'number' },
56234
+ },
56235
+ required: [
56236
+ 'period_started_at',
56237
+ 'period_ends_at',
56238
+ 'package_tokens',
56239
+ 'used_tokens',
56240
+ 'remaining_tokens',
56241
+ 'extra_tokens',
56242
+ 'extra_cents_per_token',
56243
+ 'estimated_extra_cents',
56244
+ 'percent_used',
56245
+ 'breakdown',
56246
+ 'connectivity',
56247
+ ],
56248
+ type: 'object',
56249
+ },
56250
+ },
56251
+ required: [
56252
+ 'is_test_mode',
56253
+ 'credit_subscription',
56254
+ 'usage',
56255
+ ],
56256
+ type: 'object',
56257
+ },
56258
+ ok: { type: 'boolean' },
56259
+ },
56260
+ required: ['credits', 'ok'],
56261
+ type: 'object',
56262
+ },
56263
+ },
56264
+ },
56265
+ description: 'OK',
56266
+ },
56267
+ '400': { description: 'Bad Request' },
56268
+ '401': { description: 'Unauthorized' },
56269
+ },
56270
+ security: [{ console_session_without_workspace: [] }],
56271
+ summary: '/seam/console/v1/credits/get',
56272
+ tags: [],
56273
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'credits'],
56274
+ 'x-fern-sdk-method-name': 'get',
56275
+ 'x-fern-sdk-return-value': 'credits',
56276
+ 'x-response-key': 'credits',
56277
+ 'x-title': "Get an Organization's Credits",
56278
+ 'x-undocumented': 'Internal endpoint for Console',
56279
+ },
56280
+ },
56281
+ '/seam/console/v1/credits/invoices/list': {
56282
+ post: {
56283
+ description: "Lists the organization's most recent token package invoices, newest first.",
56284
+ operationId: 'seamConsoleV1CreditsInvoicesListPost',
56285
+ requestBody: {
56286
+ content: {
56287
+ 'application/json': {
56288
+ schema: {
56289
+ properties: {
56290
+ organization_id: { format: 'uuid', type: 'string' },
56291
+ },
56292
+ required: ['organization_id'],
56293
+ type: 'object',
56294
+ },
56295
+ },
56296
+ },
56297
+ },
56298
+ responses: {
56299
+ '200': {
56300
+ content: {
56301
+ 'application/json': {
56302
+ schema: {
56303
+ properties: {
56304
+ invoices: {
56305
+ items: {
56306
+ properties: {
56307
+ hosted_invoice_url: {
56308
+ nullable: true,
56309
+ type: 'string',
56310
+ },
56311
+ invoice_id: { type: 'string' },
56312
+ issued_at: { format: 'date-time', type: 'string' },
56313
+ period_ends_at: {
56314
+ format: 'date-time',
56315
+ type: 'string',
56316
+ },
56317
+ period_started_at: {
56318
+ format: 'date-time',
56319
+ type: 'string',
56320
+ },
56321
+ status: { type: 'string' },
56322
+ total_cents: { format: 'float', type: 'number' },
56323
+ },
56324
+ required: [
56325
+ 'invoice_id',
56326
+ 'period_started_at',
56327
+ 'period_ends_at',
56328
+ 'total_cents',
56329
+ 'status',
56330
+ 'hosted_invoice_url',
56331
+ 'issued_at',
56332
+ ],
56333
+ type: 'object',
56334
+ },
56335
+ type: 'array',
56336
+ },
56337
+ ok: { type: 'boolean' },
56338
+ },
56339
+ required: ['invoices', 'ok'],
56340
+ type: 'object',
56341
+ },
56342
+ },
56343
+ },
56344
+ description: 'OK',
56345
+ },
56346
+ '400': { description: 'Bad Request' },
56347
+ '401': { description: 'Unauthorized' },
56348
+ },
56349
+ security: [{ console_session_without_workspace: [] }],
56350
+ summary: '/seam/console/v1/credits/invoices/list',
56351
+ tags: [],
56352
+ 'x-fern-sdk-group-name': [
56353
+ 'seam',
56354
+ 'console',
56355
+ 'v1',
56356
+ 'credits',
56357
+ 'invoices',
56358
+ ],
56359
+ 'x-fern-sdk-method-name': 'list',
56360
+ 'x-fern-sdk-return-value': 'invoices',
56361
+ 'x-response-key': 'invoices',
56362
+ 'x-title': 'List Credit Invoices',
56363
+ 'x-undocumented': 'Internal endpoint for Console',
56364
+ },
56365
+ },
56366
+ '/seam/console/v1/credits/packages/list': {
56367
+ post: {
56368
+ description: "Lists the purchasable monthly token packages and the package recommended for the organization's trailing 30 days of usage.",
56369
+ operationId: 'seamConsoleV1CreditsPackagesListPost',
56370
+ requestBody: {
56371
+ content: {
56372
+ 'application/json': {
56373
+ schema: {
56374
+ properties: {
56375
+ organization_id: { format: 'uuid', type: 'string' },
56376
+ },
56377
+ required: ['organization_id'],
56378
+ type: 'object',
56379
+ },
56380
+ },
56381
+ },
56382
+ },
56383
+ responses: {
56384
+ '200': {
56385
+ content: {
56386
+ 'application/json': {
56387
+ schema: {
56388
+ properties: {
56389
+ ok: { type: 'boolean' },
56390
+ packages: {
56391
+ items: {
56392
+ properties: {
56393
+ extra_cents_per_token: {
56394
+ format: 'float',
56395
+ type: 'number',
56396
+ },
56397
+ included_cents_per_token: {
56398
+ format: 'float',
56399
+ type: 'number',
56400
+ },
56401
+ package_quantity: { format: 'float', type: 'number' },
56402
+ price_cents: { format: 'float', type: 'number' },
56403
+ },
56404
+ required: [
56405
+ 'package_quantity',
56406
+ 'price_cents',
56407
+ 'included_cents_per_token',
56408
+ 'extra_cents_per_token',
56409
+ ],
56410
+ type: 'object',
56411
+ },
56412
+ type: 'array',
56413
+ },
56414
+ recommendation_basis: {
56415
+ properties: {
56416
+ trailing_30_day_tokens: {
56417
+ format: 'float',
56418
+ type: 'number',
56419
+ },
56420
+ },
56421
+ required: ['trailing_30_day_tokens'],
56422
+ type: 'object',
56423
+ },
56424
+ recommended_package_quantity: {
56425
+ format: 'float',
56426
+ type: 'number',
56427
+ },
56428
+ },
56429
+ required: [
56430
+ 'packages',
56431
+ 'recommended_package_quantity',
56432
+ 'recommendation_basis',
56433
+ 'ok',
56434
+ ],
56435
+ type: 'object',
56436
+ },
56437
+ },
56438
+ },
56439
+ description: 'OK',
56440
+ },
56441
+ '400': { description: 'Bad Request' },
56442
+ '401': { description: 'Unauthorized' },
56443
+ },
56444
+ security: [{ console_session_without_workspace: [] }],
56445
+ summary: '/seam/console/v1/credits/packages/list',
56446
+ tags: [],
56447
+ 'x-fern-sdk-group-name': [
56448
+ 'seam',
56449
+ 'console',
56450
+ 'v1',
56451
+ 'credits',
56452
+ 'packages',
56453
+ ],
56454
+ 'x-fern-sdk-method-name': 'list',
56455
+ 'x-fern-sdk-return-value': 'packages',
56456
+ 'x-response-key': 'packages',
56457
+ 'x-title': 'List Credit Packages',
56458
+ 'x-undocumented': 'Internal endpoint for Console',
56459
+ },
56460
+ },
56461
+ '/seam/console/v1/credits/purchases/get': {
56462
+ post: {
56463
+ description: 'Advances a pending credit subscription purchase and returns its status.',
56464
+ operationId: 'seamConsoleV1CreditsPurchasesGetPost',
56465
+ requestBody: {
56466
+ content: {
56467
+ 'application/json': {
56468
+ schema: {
56469
+ properties: {
56470
+ credit_subscription_id: { format: 'uuid', type: 'string' },
56471
+ organization_id: { format: 'uuid', type: 'string' },
56472
+ },
56473
+ required: ['organization_id', 'credit_subscription_id'],
56474
+ type: 'object',
56475
+ },
56476
+ },
56477
+ },
56478
+ },
56479
+ responses: {
56480
+ '200': {
56481
+ content: {
56482
+ 'application/json': {
56483
+ schema: {
56484
+ properties: {
56485
+ ok: { type: 'boolean' },
56486
+ purchase: {
56487
+ properties: {
56488
+ failure_reason: { nullable: true, type: 'string' },
56489
+ hosted_invoice_url: { nullable: true, type: 'string' },
56490
+ package_quantity: { format: 'float', type: 'number' },
56491
+ status: { type: 'string' },
56492
+ },
56493
+ required: [
56494
+ 'status',
56495
+ 'package_quantity',
56496
+ 'hosted_invoice_url',
56497
+ 'failure_reason',
56498
+ ],
56499
+ type: 'object',
56500
+ },
56501
+ },
56502
+ required: ['purchase', 'ok'],
56503
+ type: 'object',
56504
+ },
56505
+ },
56506
+ },
56507
+ description: 'OK',
56508
+ },
56509
+ '400': { description: 'Bad Request' },
56510
+ '401': { description: 'Unauthorized' },
56511
+ },
56512
+ security: [{ console_session_without_workspace: [] }],
56513
+ summary: '/seam/console/v1/credits/purchases/get',
56514
+ tags: [],
56515
+ 'x-fern-sdk-group-name': [
56516
+ 'seam',
56517
+ 'console',
56518
+ 'v1',
56519
+ 'credits',
56520
+ 'purchases',
56521
+ ],
56522
+ 'x-fern-sdk-method-name': 'get',
56523
+ 'x-fern-sdk-return-value': 'purchase',
56524
+ 'x-response-key': 'purchase',
56525
+ 'x-title': 'Get a Credit Purchase',
56526
+ 'x-undocumented': 'Internal endpoint for Console',
56527
+ },
56528
+ },
56026
56529
  '/seam/console/v1/get_resource_locator': {
56027
56530
  get: {
56028
56531
  description: 'Returns the type and system information of a resource given its UUID.',