@seamapi/types 1.1148.0 → 1.1150.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.
@@ -58660,7 +58660,7 @@ const openapi: OpenAPISpec = {
58660
58660
  '/events/get': {
58661
58661
  get: {
58662
58662
  description:
58663
- 'Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place.',
58663
+ 'Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place. Events older than 90 days are not returned.',
58664
58664
  operationId: 'eventsGetGet',
58665
58665
  parameters: [
58666
58666
  {
@@ -58735,7 +58735,7 @@ const openapi: OpenAPISpec = {
58735
58735
  '/events/list': {
58736
58736
  get: {
58737
58737
  description:
58738
- 'Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place.',
58738
+ 'Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place. Only events from the last 90 days are returned.',
58739
58739
  operationId: 'eventsListGet',
58740
58740
  parameters: [
58741
58741
  {
@@ -58761,7 +58761,7 @@ const openapi: OpenAPISpec = {
58761
58761
  name: 'since',
58762
58762
  schema: {
58763
58763
  description:
58764
- 'Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`.',
58764
+ 'Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a `since` older than 90 days is treated as 90 days ago.',
58765
58765
  type: 'string',
58766
58766
  },
58767
58767
  },
@@ -58770,7 +58770,7 @@ const openapi: OpenAPISpec = {
58770
58770
  name: 'between',
58771
58771
  schema: {
58772
58772
  description:
58773
- 'Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.',
58773
+ 'Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a lower timestamp older than 90 days is treated as 90 days ago.',
58774
58774
  items: { type: 'string' },
58775
58775
  maxItems: 2,
58776
58776
  minItems: 2,
@@ -63983,6 +63983,499 @@ const openapi: OpenAPISpec = {
63983
63983
  'x-undocumented': 'Internal endpoint for Console',
63984
63984
  },
63985
63985
  },
63986
+ '/seam/console/v1/workspace/list_access_codes_for_today': {
63987
+ get: {
63988
+ description:
63989
+ "Lists the managed time-bound access codes that start, and those that end,\nduring the viewer's day, in time order, with the total of each.",
63990
+ operationId: 'seamConsoleV1WorkspaceListAccessCodesForTodayGet',
63991
+ parameters: [
63992
+ {
63993
+ in: 'query',
63994
+ name: 'customer_key',
63995
+ schema: {
63996
+ description:
63997
+ 'Customer key for which you want to list access codes.',
63998
+ minLength: 1,
63999
+ type: 'string',
64000
+ },
64001
+ },
64002
+ {
64003
+ in: 'query',
64004
+ name: 'starts_at',
64005
+ schema: {
64006
+ description:
64007
+ "Start of the viewer's day, inclusive. Pass with `ends_at`; defaults to the start of the current UTC day.",
64008
+ format: 'date-time',
64009
+ type: 'string',
64010
+ },
64011
+ },
64012
+ {
64013
+ in: 'query',
64014
+ name: 'ends_at',
64015
+ schema: {
64016
+ description:
64017
+ "End of the viewer's day, exclusive. Pass with `starts_at`; defaults to the end of the current UTC day.",
64018
+ format: 'date-time',
64019
+ type: 'string',
64020
+ },
64021
+ },
64022
+ {
64023
+ in: 'query',
64024
+ name: 'limit',
64025
+ schema: {
64026
+ default: 50,
64027
+ description:
64028
+ 'Maximum number of starting, and of ending, access codes to return.',
64029
+ exclusiveMinimum: true,
64030
+ maximum: 200,
64031
+ minimum: 0,
64032
+ type: 'integer',
64033
+ },
64034
+ },
64035
+ ],
64036
+ responses: {
64037
+ '200': {
64038
+ content: {
64039
+ 'application/json': {
64040
+ schema: {
64041
+ properties: {
64042
+ access_codes_for_today: {
64043
+ properties: {
64044
+ ending: {
64045
+ items: {
64046
+ properties: {
64047
+ access_code_id: {
64048
+ format: 'uuid',
64049
+ type: 'string',
64050
+ },
64051
+ code: { nullable: true, type: 'string' },
64052
+ device_id: { format: 'uuid', type: 'string' },
64053
+ device_name: { type: 'string' },
64054
+ ends_at: {
64055
+ format: 'date-time',
64056
+ nullable: true,
64057
+ type: 'string',
64058
+ },
64059
+ name: { nullable: true, type: 'string' },
64060
+ starts_at: {
64061
+ format: 'date-time',
64062
+ nullable: true,
64063
+ type: 'string',
64064
+ },
64065
+ status: {
64066
+ enum: [
64067
+ 'setting',
64068
+ 'set',
64069
+ 'unset',
64070
+ 'removing',
64071
+ 'unknown',
64072
+ ],
64073
+ type: 'string',
64074
+ },
64075
+ },
64076
+ required: [
64077
+ 'access_code_id',
64078
+ 'code',
64079
+ 'name',
64080
+ 'device_id',
64081
+ 'device_name',
64082
+ 'starts_at',
64083
+ 'ends_at',
64084
+ 'status',
64085
+ ],
64086
+ type: 'object',
64087
+ },
64088
+ type: 'array',
64089
+ },
64090
+ ending_count: { type: 'integer' },
64091
+ starting: {
64092
+ items: {
64093
+ properties: {
64094
+ access_code_id: {
64095
+ format: 'uuid',
64096
+ type: 'string',
64097
+ },
64098
+ code: { nullable: true, type: 'string' },
64099
+ device_id: { format: 'uuid', type: 'string' },
64100
+ device_name: { type: 'string' },
64101
+ ends_at: {
64102
+ format: 'date-time',
64103
+ nullable: true,
64104
+ type: 'string',
64105
+ },
64106
+ name: { nullable: true, type: 'string' },
64107
+ starts_at: {
64108
+ format: 'date-time',
64109
+ nullable: true,
64110
+ type: 'string',
64111
+ },
64112
+ status: {
64113
+ enum: [
64114
+ 'setting',
64115
+ 'set',
64116
+ 'unset',
64117
+ 'removing',
64118
+ 'unknown',
64119
+ ],
64120
+ type: 'string',
64121
+ },
64122
+ },
64123
+ required: [
64124
+ 'access_code_id',
64125
+ 'code',
64126
+ 'name',
64127
+ 'device_id',
64128
+ 'device_name',
64129
+ 'starts_at',
64130
+ 'ends_at',
64131
+ 'status',
64132
+ ],
64133
+ type: 'object',
64134
+ },
64135
+ type: 'array',
64136
+ },
64137
+ starting_count: { type: 'integer' },
64138
+ },
64139
+ required: [
64140
+ 'starting_count',
64141
+ 'starting',
64142
+ 'ending_count',
64143
+ 'ending',
64144
+ ],
64145
+ type: 'object',
64146
+ },
64147
+ ok: { type: 'boolean' },
64148
+ },
64149
+ required: ['access_codes_for_today', 'ok'],
64150
+ type: 'object',
64151
+ },
64152
+ },
64153
+ },
64154
+ description: 'OK',
64155
+ },
64156
+ '400': { description: 'Bad Request' },
64157
+ '401': { description: 'Unauthorized' },
64158
+ },
64159
+ security: [{ console_session_with_workspace: [] }],
64160
+ summary: '/seam/console/v1/workspace/list_access_codes_for_today',
64161
+ tags: [],
64162
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'workspace'],
64163
+ 'x-fern-sdk-method-name': 'list_access_codes_for_today',
64164
+ 'x-fern-sdk-return-value': 'access_codes_for_today',
64165
+ 'x-response-key': 'access_codes_for_today',
64166
+ 'x-title': 'List Access Codes for Today',
64167
+ 'x-undocumented': 'Internal endpoint for Console',
64168
+ },
64169
+ },
64170
+ '/seam/console/v1/workspace/list_attention_items': {
64171
+ get: {
64172
+ description:
64173
+ 'Lists the devices with errors and the managed access codes that failed to\nreach their device in the last 7 days, newest first, with the total of each.',
64174
+ operationId: 'seamConsoleV1WorkspaceListAttentionItemsGet',
64175
+ parameters: [
64176
+ {
64177
+ in: 'query',
64178
+ name: 'customer_key',
64179
+ schema: {
64180
+ description:
64181
+ 'Customer key for which you want to list attention items.',
64182
+ minLength: 1,
64183
+ type: 'string',
64184
+ },
64185
+ },
64186
+ {
64187
+ in: 'query',
64188
+ name: 'limit',
64189
+ schema: {
64190
+ default: 5,
64191
+ description:
64192
+ 'Maximum number of devices, and of access codes, to return.',
64193
+ exclusiveMinimum: true,
64194
+ maximum: 50,
64195
+ minimum: 0,
64196
+ type: 'integer',
64197
+ },
64198
+ },
64199
+ ],
64200
+ responses: {
64201
+ '200': {
64202
+ content: {
64203
+ 'application/json': {
64204
+ schema: {
64205
+ properties: {
64206
+ attention_items: {
64207
+ properties: {
64208
+ access_code_count: { type: 'integer' },
64209
+ access_codes: {
64210
+ items: {
64211
+ properties: {
64212
+ access_code_id: {
64213
+ format: 'uuid',
64214
+ type: 'string',
64215
+ },
64216
+ code: { nullable: true, type: 'string' },
64217
+ device_id: { format: 'uuid', type: 'string' },
64218
+ device_name: { type: 'string' },
64219
+ error: {
64220
+ properties: {
64221
+ error_code: { type: 'string' },
64222
+ message: { type: 'string' },
64223
+ },
64224
+ required: ['error_code', 'message'],
64225
+ type: 'object',
64226
+ },
64227
+ name: { nullable: true, type: 'string' },
64228
+ },
64229
+ required: [
64230
+ 'access_code_id',
64231
+ 'code',
64232
+ 'name',
64233
+ 'device_id',
64234
+ 'device_name',
64235
+ 'error',
64236
+ ],
64237
+ type: 'object',
64238
+ },
64239
+ type: 'array',
64240
+ },
64241
+ device_count: { type: 'integer' },
64242
+ devices: {
64243
+ items: {
64244
+ properties: {
64245
+ device_id: { format: 'uuid', type: 'string' },
64246
+ display_name: { type: 'string' },
64247
+ error: {
64248
+ properties: {
64249
+ error_code: { type: 'string' },
64250
+ message: { type: 'string' },
64251
+ },
64252
+ required: ['error_code', 'message'],
64253
+ type: 'object',
64254
+ },
64255
+ },
64256
+ required: ['device_id', 'display_name', 'error'],
64257
+ type: 'object',
64258
+ },
64259
+ type: 'array',
64260
+ },
64261
+ },
64262
+ required: [
64263
+ 'device_count',
64264
+ 'devices',
64265
+ 'access_code_count',
64266
+ 'access_codes',
64267
+ ],
64268
+ type: 'object',
64269
+ },
64270
+ ok: { type: 'boolean' },
64271
+ },
64272
+ required: ['attention_items', 'ok'],
64273
+ type: 'object',
64274
+ },
64275
+ },
64276
+ },
64277
+ description: 'OK',
64278
+ },
64279
+ '400': { description: 'Bad Request' },
64280
+ '401': { description: 'Unauthorized' },
64281
+ },
64282
+ security: [{ console_session_with_workspace: [] }],
64283
+ summary: '/seam/console/v1/workspace/list_attention_items',
64284
+ tags: [],
64285
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'workspace'],
64286
+ 'x-fern-sdk-method-name': 'list_attention_items',
64287
+ 'x-fern-sdk-return-value': 'attention_items',
64288
+ 'x-response-key': 'attention_items',
64289
+ 'x-title': 'List Workspace Attention Items',
64290
+ 'x-undocumented': 'Internal endpoint for Console',
64291
+ },
64292
+ },
64293
+ '/seam/console/v1/workspace/list_reservations_for_today': {
64294
+ get: {
64295
+ description:
64296
+ "Lists the reservations that check in, and those that check out, during the\nviewer's day, in time order, with the total of each.",
64297
+ operationId: 'seamConsoleV1WorkspaceListReservationsForTodayGet',
64298
+ parameters: [
64299
+ {
64300
+ in: 'query',
64301
+ name: 'customer_key',
64302
+ schema: {
64303
+ description:
64304
+ 'Customer key for which you want to list reservations.',
64305
+ minLength: 1,
64306
+ type: 'string',
64307
+ },
64308
+ },
64309
+ {
64310
+ in: 'query',
64311
+ name: 'starts_at',
64312
+ schema: {
64313
+ description:
64314
+ "Start of the viewer's day, inclusive. Pass with `ends_at`; defaults to the start of the current UTC day.",
64315
+ format: 'date-time',
64316
+ type: 'string',
64317
+ },
64318
+ },
64319
+ {
64320
+ in: 'query',
64321
+ name: 'ends_at',
64322
+ schema: {
64323
+ description:
64324
+ "End of the viewer's day, exclusive. Pass with `starts_at`; defaults to the end of the current UTC day.",
64325
+ format: 'date-time',
64326
+ type: 'string',
64327
+ },
64328
+ },
64329
+ {
64330
+ in: 'query',
64331
+ name: 'limit',
64332
+ schema: {
64333
+ default: 50,
64334
+ description:
64335
+ 'Maximum number of check-ins, and of check-outs, to return.',
64336
+ exclusiveMinimum: true,
64337
+ maximum: 200,
64338
+ minimum: 0,
64339
+ type: 'integer',
64340
+ },
64341
+ },
64342
+ ],
64343
+ responses: {
64344
+ '200': {
64345
+ content: {
64346
+ 'application/json': {
64347
+ schema: {
64348
+ properties: {
64349
+ ok: { type: 'boolean' },
64350
+ reservations_for_today: {
64351
+ properties: {
64352
+ check_in_count: { type: 'integer' },
64353
+ check_ins: {
64354
+ items: {
64355
+ properties: {
64356
+ ends_at: {
64357
+ format: 'date-time',
64358
+ nullable: true,
64359
+ type: 'string',
64360
+ },
64361
+ guest_name: { nullable: true, type: 'string' },
64362
+ name: { nullable: true, type: 'string' },
64363
+ reservation_id: {
64364
+ format: 'uuid',
64365
+ type: 'string',
64366
+ },
64367
+ reservation_key: { type: 'string' },
64368
+ space: {
64369
+ nullable: true,
64370
+ properties: {
64371
+ name: { nullable: true, type: 'string' },
64372
+ space_id: {
64373
+ format: 'uuid',
64374
+ nullable: true,
64375
+ type: 'string',
64376
+ },
64377
+ },
64378
+ required: ['space_id', 'name'],
64379
+ type: 'object',
64380
+ },
64381
+ starts_at: {
64382
+ format: 'date-time',
64383
+ nullable: true,
64384
+ type: 'string',
64385
+ },
64386
+ },
64387
+ required: [
64388
+ 'reservation_id',
64389
+ 'reservation_key',
64390
+ 'guest_name',
64391
+ 'name',
64392
+ 'starts_at',
64393
+ 'ends_at',
64394
+ 'space',
64395
+ ],
64396
+ type: 'object',
64397
+ },
64398
+ type: 'array',
64399
+ },
64400
+ check_out_count: { type: 'integer' },
64401
+ check_outs: {
64402
+ items: {
64403
+ properties: {
64404
+ ends_at: {
64405
+ format: 'date-time',
64406
+ nullable: true,
64407
+ type: 'string',
64408
+ },
64409
+ guest_name: { nullable: true, type: 'string' },
64410
+ name: { nullable: true, type: 'string' },
64411
+ reservation_id: {
64412
+ format: 'uuid',
64413
+ type: 'string',
64414
+ },
64415
+ reservation_key: { type: 'string' },
64416
+ space: {
64417
+ nullable: true,
64418
+ properties: {
64419
+ name: { nullable: true, type: 'string' },
64420
+ space_id: {
64421
+ format: 'uuid',
64422
+ nullable: true,
64423
+ type: 'string',
64424
+ },
64425
+ },
64426
+ required: ['space_id', 'name'],
64427
+ type: 'object',
64428
+ },
64429
+ starts_at: {
64430
+ format: 'date-time',
64431
+ nullable: true,
64432
+ type: 'string',
64433
+ },
64434
+ },
64435
+ required: [
64436
+ 'reservation_id',
64437
+ 'reservation_key',
64438
+ 'guest_name',
64439
+ 'name',
64440
+ 'starts_at',
64441
+ 'ends_at',
64442
+ 'space',
64443
+ ],
64444
+ type: 'object',
64445
+ },
64446
+ type: 'array',
64447
+ },
64448
+ },
64449
+ required: [
64450
+ 'check_in_count',
64451
+ 'check_ins',
64452
+ 'check_out_count',
64453
+ 'check_outs',
64454
+ ],
64455
+ type: 'object',
64456
+ },
64457
+ },
64458
+ required: ['reservations_for_today', 'ok'],
64459
+ type: 'object',
64460
+ },
64461
+ },
64462
+ },
64463
+ description: 'OK',
64464
+ },
64465
+ '400': { description: 'Bad Request' },
64466
+ '401': { description: 'Unauthorized' },
64467
+ },
64468
+ security: [{ console_session_with_workspace: [] }],
64469
+ summary: '/seam/console/v1/workspace/list_reservations_for_today',
64470
+ tags: [],
64471
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'workspace'],
64472
+ 'x-fern-sdk-method-name': 'list_reservations_for_today',
64473
+ 'x-fern-sdk-return-value': 'reservations_for_today',
64474
+ 'x-response-key': 'reservations_for_today',
64475
+ 'x-title': 'List Reservations for Today',
64476
+ 'x-undocumented': 'Internal endpoint for Console',
64477
+ },
64478
+ },
63986
64479
  '/seam/customer/v1/access_grants/list': {
63987
64480
  get: {
63988
64481
  description: 'Gets an Access Grant.',
@@ -68027,7 +68520,7 @@ const openapi: OpenAPISpec = {
68027
68520
  required: false,
68028
68521
  schema: {
68029
68522
  description:
68030
- 'Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`.',
68523
+ 'Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a `since` older than 90 days is treated as 90 days ago.',
68031
68524
  type: 'string',
68032
68525
  },
68033
68526
  },
@@ -68037,7 +68530,7 @@ const openapi: OpenAPISpec = {
68037
68530
  required: false,
68038
68531
  schema: {
68039
68532
  description:
68040
- 'Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.',
68533
+ 'Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a lower timestamp older than 90 days is treated as 90 days ago.',
68041
68534
  items: { type: 'string' },
68042
68535
  maxItems: 2,
68043
68536
  minItems: 2,