@seamapi/types 1.535.0 → 1.536.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.
package/dist/index.cjs CHANGED
@@ -51249,6 +51249,280 @@ var openapi_default = {
51249
51249
  "x-undocumented": "Seam Instant Key only."
51250
51250
  }
51251
51251
  },
51252
+ "/seam/instant_key/v1/preview/get": {
51253
+ get: {
51254
+ operationId: "seamInstantKeyV1PreviewGetGet",
51255
+ requestBody: {
51256
+ content: {
51257
+ "application/json": {
51258
+ schema: {
51259
+ properties: {
51260
+ instant_key_url: {
51261
+ description: "The short code of the instant key to preview.",
51262
+ type: "string"
51263
+ }
51264
+ },
51265
+ required: ["instant_key_url"],
51266
+ type: "object"
51267
+ }
51268
+ }
51269
+ }
51270
+ },
51271
+ responses: {
51272
+ 200: {
51273
+ content: {
51274
+ "application/json": {
51275
+ schema: {
51276
+ properties: {
51277
+ instant_key_preview: {
51278
+ description: "Represents a preview of an Instant Key with hotel, guest, and access information.",
51279
+ properties: {
51280
+ access: {
51281
+ items: {
51282
+ properties: {
51283
+ available: { type: "boolean" },
51284
+ hours: { type: "string" },
51285
+ icon: { type: "string" },
51286
+ location: { type: "string" },
51287
+ name: { type: "string" }
51288
+ },
51289
+ required: ["name", "icon", "available"],
51290
+ type: "object"
51291
+ },
51292
+ type: "array"
51293
+ },
51294
+ created_at: { type: "string" },
51295
+ expires_at: { type: "string" },
51296
+ guest: {
51297
+ properties: {
51298
+ check_in_date: { type: "string" },
51299
+ check_out_date: { type: "string" },
51300
+ email: { type: "string" },
51301
+ first_name: { type: "string" },
51302
+ full_name: { type: "string" },
51303
+ last_name: { type: "string" }
51304
+ },
51305
+ required: [
51306
+ "first_name",
51307
+ "last_name",
51308
+ "full_name",
51309
+ "email",
51310
+ "check_in_date",
51311
+ "check_out_date"
51312
+ ],
51313
+ type: "object"
51314
+ },
51315
+ hotel: {
51316
+ properties: {
51317
+ accent_color: { type: "string" },
51318
+ hotel_name: { type: "string" },
51319
+ logo_url: { type: "string" },
51320
+ primary_color: { type: "string" },
51321
+ secondary_color: { type: "string" },
51322
+ verified: { type: "boolean" }
51323
+ },
51324
+ required: [
51325
+ "hotel_name",
51326
+ "primary_color",
51327
+ "accent_color",
51328
+ "secondary_color",
51329
+ "verified"
51330
+ ],
51331
+ type: "object"
51332
+ },
51333
+ key_status: {
51334
+ enum: ["ready", "expired", "used"],
51335
+ type: "string"
51336
+ },
51337
+ room: {
51338
+ properties: {
51339
+ floor: { format: "float", type: "number" },
51340
+ room_number: { type: "string" },
51341
+ room_type: { type: "string" }
51342
+ },
51343
+ required: ["room_number", "room_type", "floor"],
51344
+ type: "object"
51345
+ },
51346
+ shortcode: { type: "string" },
51347
+ support_email: { type: "string" },
51348
+ support_phone: { type: "string" },
51349
+ updated_at: { type: "string" }
51350
+ },
51351
+ required: [
51352
+ "shortcode",
51353
+ "hotel",
51354
+ "guest",
51355
+ "room",
51356
+ "access",
51357
+ "key_status",
51358
+ "support_phone",
51359
+ "support_email",
51360
+ "created_at",
51361
+ "updated_at",
51362
+ "expires_at"
51363
+ ],
51364
+ type: "object",
51365
+ "x-route-path": "/instant_keys/preview"
51366
+ },
51367
+ ok: { type: "boolean" }
51368
+ },
51369
+ required: ["instant_key_preview", "ok"],
51370
+ type: "object"
51371
+ }
51372
+ }
51373
+ },
51374
+ description: "OK"
51375
+ },
51376
+ 400: { description: "Bad Request" },
51377
+ 401: { description: "Unauthorized" }
51378
+ },
51379
+ security: [{ certified_client: [] }],
51380
+ summary: "/seam/instant_key/v1/preview/get",
51381
+ tags: [],
51382
+ "x-fern-sdk-group-name": ["seam", "instant_key", "v1", "preview"],
51383
+ "x-fern-sdk-method-name": "get",
51384
+ "x-fern-sdk-return-value": "instant_key_preview",
51385
+ "x-response-key": "instant_key_preview",
51386
+ "x-title": "Preview Instant Key",
51387
+ "x-undocumented": "Seam Instant Key only."
51388
+ },
51389
+ post: {
51390
+ operationId: "seamInstantKeyV1PreviewGetPost",
51391
+ requestBody: {
51392
+ content: {
51393
+ "application/json": {
51394
+ schema: {
51395
+ properties: {
51396
+ instant_key_url: {
51397
+ description: "The short code of the instant key to preview.",
51398
+ type: "string"
51399
+ }
51400
+ },
51401
+ required: ["instant_key_url"],
51402
+ type: "object"
51403
+ }
51404
+ }
51405
+ }
51406
+ },
51407
+ responses: {
51408
+ 200: {
51409
+ content: {
51410
+ "application/json": {
51411
+ schema: {
51412
+ properties: {
51413
+ instant_key_preview: {
51414
+ description: "Represents a preview of an Instant Key with hotel, guest, and access information.",
51415
+ properties: {
51416
+ access: {
51417
+ items: {
51418
+ properties: {
51419
+ available: { type: "boolean" },
51420
+ hours: { type: "string" },
51421
+ icon: { type: "string" },
51422
+ location: { type: "string" },
51423
+ name: { type: "string" }
51424
+ },
51425
+ required: ["name", "icon", "available"],
51426
+ type: "object"
51427
+ },
51428
+ type: "array"
51429
+ },
51430
+ created_at: { type: "string" },
51431
+ expires_at: { type: "string" },
51432
+ guest: {
51433
+ properties: {
51434
+ check_in_date: { type: "string" },
51435
+ check_out_date: { type: "string" },
51436
+ email: { type: "string" },
51437
+ first_name: { type: "string" },
51438
+ full_name: { type: "string" },
51439
+ last_name: { type: "string" }
51440
+ },
51441
+ required: [
51442
+ "first_name",
51443
+ "last_name",
51444
+ "full_name",
51445
+ "email",
51446
+ "check_in_date",
51447
+ "check_out_date"
51448
+ ],
51449
+ type: "object"
51450
+ },
51451
+ hotel: {
51452
+ properties: {
51453
+ accent_color: { type: "string" },
51454
+ hotel_name: { type: "string" },
51455
+ logo_url: { type: "string" },
51456
+ primary_color: { type: "string" },
51457
+ secondary_color: { type: "string" },
51458
+ verified: { type: "boolean" }
51459
+ },
51460
+ required: [
51461
+ "hotel_name",
51462
+ "primary_color",
51463
+ "accent_color",
51464
+ "secondary_color",
51465
+ "verified"
51466
+ ],
51467
+ type: "object"
51468
+ },
51469
+ key_status: {
51470
+ enum: ["ready", "expired", "used"],
51471
+ type: "string"
51472
+ },
51473
+ room: {
51474
+ properties: {
51475
+ floor: { format: "float", type: "number" },
51476
+ room_number: { type: "string" },
51477
+ room_type: { type: "string" }
51478
+ },
51479
+ required: ["room_number", "room_type", "floor"],
51480
+ type: "object"
51481
+ },
51482
+ shortcode: { type: "string" },
51483
+ support_email: { type: "string" },
51484
+ support_phone: { type: "string" },
51485
+ updated_at: { type: "string" }
51486
+ },
51487
+ required: [
51488
+ "shortcode",
51489
+ "hotel",
51490
+ "guest",
51491
+ "room",
51492
+ "access",
51493
+ "key_status",
51494
+ "support_phone",
51495
+ "support_email",
51496
+ "created_at",
51497
+ "updated_at",
51498
+ "expires_at"
51499
+ ],
51500
+ type: "object",
51501
+ "x-route-path": "/instant_keys/preview"
51502
+ },
51503
+ ok: { type: "boolean" }
51504
+ },
51505
+ required: ["instant_key_preview", "ok"],
51506
+ type: "object"
51507
+ }
51508
+ }
51509
+ },
51510
+ description: "OK"
51511
+ },
51512
+ 400: { description: "Bad Request" },
51513
+ 401: { description: "Unauthorized" }
51514
+ },
51515
+ security: [{ certified_client: [] }],
51516
+ summary: "/seam/instant_key/v1/preview/get",
51517
+ tags: [],
51518
+ "x-fern-sdk-group-name": ["seam", "instant_key", "v1", "preview"],
51519
+ "x-fern-sdk-method-name": "get",
51520
+ "x-fern-sdk-return-value": "instant_key_preview",
51521
+ "x-response-key": "instant_key_preview",
51522
+ "x-title": "Preview Instant Key",
51523
+ "x-undocumented": "Seam Instant Key only."
51524
+ }
51525
+ },
51252
51526
  "/seam/mobile_sdk/v1/acs/credentials/list": {
51253
51527
  get: {
51254
51528
  description: "Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",