@seamapi/types 1.84.0 → 1.85.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.
@@ -15,7 +15,7 @@ declare const connect_webview: z.ZodObject<{
15
15
  status: z.ZodEnum<["pending", "failed", "authorized"]>;
16
16
  custom_redirect_url: z.ZodNullable<z.ZodString>;
17
17
  custom_redirect_failure_url: z.ZodNullable<z.ZodString>;
18
- custom_metadata: z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>, Record<string, string | boolean>, Record<string, string | boolean>>;
18
+ custom_metadata: z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNull]>>, Record<string, string | boolean | null>, Record<string, string | boolean | null>>;
19
19
  automatically_manage_new_devices: z.ZodBoolean;
20
20
  wait_for_device_creation: z.ZodBoolean;
21
21
  authorized_at: z.ZodNullable<z.ZodString>;
@@ -34,7 +34,7 @@ declare const connect_webview: z.ZodObject<{
34
34
  login_successful: boolean;
35
35
  custom_redirect_url: string | null;
36
36
  custom_redirect_failure_url: string | null;
37
- custom_metadata: Record<string, string | boolean>;
37
+ custom_metadata: Record<string, string | boolean | null>;
38
38
  automatically_manage_new_devices: boolean;
39
39
  wait_for_device_creation: boolean;
40
40
  authorized_at: string | null;
@@ -54,7 +54,7 @@ declare const connect_webview: z.ZodObject<{
54
54
  login_successful: boolean;
55
55
  custom_redirect_url: string | null;
56
56
  custom_redirect_failure_url: string | null;
57
- custom_metadata: Record<string, string | boolean>;
57
+ custom_metadata: Record<string, string | boolean | null>;
58
58
  automatically_manage_new_devices: boolean;
59
59
  wait_for_device_creation: boolean;
60
60
  authorized_at: string | null;
@@ -63,7 +63,7 @@ declare const connect_webview: z.ZodObject<{
63
63
  }>;
64
64
  type ConnectWebview = z.infer<typeof connect_webview>;
65
65
 
66
- declare const custom_metadata: z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>, Record<string, string | boolean>, Record<string, string | boolean>>;
66
+ declare const custom_metadata: z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNull]>>, Record<string, string | boolean | null>, Record<string, string | boolean | null>>;
67
67
  type CustomMetadata = z.infer<typeof custom_metadata>;
68
68
 
69
69
  declare const schemas_connect_webview: typeof connect_webview;
@@ -589,10 +589,20 @@ declare const _default: {
589
589
  };
590
590
  custom_metadata: {
591
591
  additionalProperties: {
592
+ nullable: boolean;
592
593
  oneOf: ({
593
594
  maxLength: number;
594
595
  type: string;
596
+ format?: never;
597
+ nullable?: never;
598
+ } | {
599
+ type: string;
600
+ maxLength?: never;
601
+ format?: never;
602
+ nullable?: never;
595
603
  } | {
604
+ format: string;
605
+ nullable: boolean;
596
606
  type: string;
597
607
  maxLength?: never;
598
608
  })[];
@@ -660,12 +670,22 @@ declare const _default: {
660
670
  };
661
671
  custom_metadata: {
662
672
  additionalProperties: {
673
+ nullable: boolean;
663
674
  oneOf: ({
664
675
  maxLength: number;
665
676
  type: string;
677
+ format?: never;
678
+ nullable?: never;
666
679
  } | {
667
680
  type: string;
668
681
  maxLength?: never;
682
+ format?: never;
683
+ nullable?: never;
684
+ } | {
685
+ format: string;
686
+ nullable: boolean;
687
+ type: string;
688
+ maxLength?: never;
669
689
  })[];
670
690
  };
671
691
  type: string;
@@ -9940,12 +9960,22 @@ declare const _default: {
9940
9960
  };
9941
9961
  custom_metadata: {
9942
9962
  additionalProperties: {
9963
+ nullable: boolean;
9943
9964
  oneOf: ({
9944
9965
  maxLength: number;
9945
9966
  type: string;
9967
+ format?: never;
9968
+ nullable?: never;
9946
9969
  } | {
9947
9970
  type: string;
9948
9971
  maxLength?: never;
9972
+ format?: never;
9973
+ nullable?: never;
9974
+ } | {
9975
+ format: string;
9976
+ nullable: boolean;
9977
+ type: string;
9978
+ maxLength?: never;
9949
9979
  })[];
9950
9980
  };
9951
9981
  type: string;
@@ -10165,6 +10195,19 @@ declare const _default: {
10165
10195
  'application/json': {
10166
10196
  schema: {
10167
10197
  properties: {
10198
+ custom_metadata_has: {
10199
+ additionalProperties: {
10200
+ oneOf: ({
10201
+ maxLength: number;
10202
+ type: string;
10203
+ } | {
10204
+ type: string;
10205
+ maxLength?: never;
10206
+ })[];
10207
+ };
10208
+ description: string;
10209
+ type: string;
10210
+ };
10168
10211
  user_identifier_key: {
10169
10212
  type: string;
10170
10213
  };
@@ -10416,60 +10459,32 @@ declare const _default: {
10416
10459
  };
10417
10460
  };
10418
10461
  '/connected_accounts/list': {
10419
- get: {
10462
+ post: {
10420
10463
  operationId: string;
10421
- responses: {
10422
- 200: {
10423
- content: {
10424
- 'application/json': {
10425
- schema: {
10426
- properties: {
10427
- connected_accounts: {
10428
- items: {
10429
- $ref: string;
10430
- };
10431
- type: string;
10432
- };
10433
- ok: {
10434
- type: string;
10464
+ requestBody: {
10465
+ content: {
10466
+ 'application/json': {
10467
+ schema: {
10468
+ properties: {
10469
+ custom_metadata_has: {
10470
+ additionalProperties: {
10471
+ oneOf: ({
10472
+ maxLength: number;
10473
+ type: string;
10474
+ } | {
10475
+ type: string;
10476
+ maxLength?: never;
10477
+ })[];
10435
10478
  };
10479
+ description: string;
10480
+ type: string;
10436
10481
  };
10437
- required: string[];
10438
- type: string;
10439
10482
  };
10483
+ type: string;
10440
10484
  };
10441
10485
  };
10442
- description: string;
10443
- };
10444
- 400: {
10445
- description: string;
10446
- };
10447
- 401: {
10448
- description: string;
10449
10486
  };
10450
10487
  };
10451
- security: ({
10452
- access_token: never[];
10453
- seam_workspace: never[];
10454
- seam_client_session_token?: never;
10455
- client_session_token?: never;
10456
- } | {
10457
- seam_client_session_token: never[];
10458
- access_token?: never;
10459
- seam_workspace?: never;
10460
- client_session_token?: never;
10461
- } | {
10462
- client_session_token: never[];
10463
- access_token?: never;
10464
- seam_workspace?: never;
10465
- seam_client_session_token?: never;
10466
- })[];
10467
- summary: string;
10468
- tags: string[];
10469
- 'x-fern-ignore': boolean;
10470
- };
10471
- post: {
10472
- operationId: string;
10473
10488
  responses: {
10474
10489
  200: {
10475
10490
  content: {
@@ -10538,6 +10553,28 @@ declare const _default: {
10538
10553
  format: string;
10539
10554
  type: string;
10540
10555
  };
10556
+ custom_metadata: {
10557
+ additionalProperties: {
10558
+ nullable: boolean;
10559
+ oneOf: ({
10560
+ maxLength: number;
10561
+ type: string;
10562
+ format?: never;
10563
+ nullable?: never;
10564
+ } | {
10565
+ type: string;
10566
+ maxLength?: never;
10567
+ format?: never;
10568
+ nullable?: never;
10569
+ } | {
10570
+ format: string;
10571
+ nullable: boolean;
10572
+ type: string;
10573
+ maxLength?: never;
10574
+ })[];
10575
+ };
10576
+ type: string;
10577
+ };
10541
10578
  };
10542
10579
  required: string[];
10543
10580
  type: string;
@@ -18163,7 +18200,7 @@ interface Routes {
18163
18200
  custom_redirect_failure_url?: string | undefined;
18164
18201
  accepted_providers?: Array<'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'google_nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'seam_bridge' | 'yale_access' | 'hid_cm'> | undefined;
18165
18202
  provider_category?: ('stable' | 'consumer_smartlocks' | 'internal_beta') | undefined;
18166
- custom_metadata?: Record<string, string | boolean> | undefined;
18203
+ custom_metadata?: Record<string, string | boolean | null> | undefined;
18167
18204
  automatically_manage_new_devices?: boolean | undefined;
18168
18205
  wait_for_device_creation?: boolean | undefined;
18169
18206
  };
@@ -18185,7 +18222,7 @@ interface Routes {
18185
18222
  status: 'pending' | 'failed' | 'authorized';
18186
18223
  custom_redirect_url: string | null;
18187
18224
  custom_redirect_failure_url: string | null;
18188
- custom_metadata: Record<string, string | boolean>;
18225
+ custom_metadata: Record<string, string | boolean | null>;
18189
18226
  automatically_manage_new_devices: boolean;
18190
18227
  wait_for_device_creation: boolean;
18191
18228
  authorized_at: string | null;
@@ -18229,7 +18266,7 @@ interface Routes {
18229
18266
  status: 'pending' | 'failed' | 'authorized';
18230
18267
  custom_redirect_url: string | null;
18231
18268
  custom_redirect_failure_url: string | null;
18232
- custom_metadata: Record<string, string | boolean>;
18269
+ custom_metadata: Record<string, string | boolean | null>;
18233
18270
  automatically_manage_new_devices: boolean;
18234
18271
  wait_for_device_creation: boolean;
18235
18272
  authorized_at: string | null;
@@ -18244,6 +18281,8 @@ interface Routes {
18244
18281
  jsonBody: {};
18245
18282
  commonParams: {
18246
18283
  user_identifier_key?: string | undefined;
18284
+ /** Returns devices where the webview's custom_metadata contains all of the provided key/value pairs. */
18285
+ custom_metadata_has?: Record<string, string | boolean> | undefined;
18247
18286
  };
18248
18287
  formData: {};
18249
18288
  jsonResponse: {
@@ -18262,7 +18301,7 @@ interface Routes {
18262
18301
  status: 'pending' | 'failed' | 'authorized';
18263
18302
  custom_redirect_url: string | null;
18264
18303
  custom_redirect_failure_url: string | null;
18265
- custom_metadata: Record<string, string | boolean>;
18304
+ custom_metadata: Record<string, string | boolean | null>;
18266
18305
  automatically_manage_new_devices: boolean;
18267
18306
  wait_for_device_creation: boolean;
18268
18307
  authorized_at: string | null;
@@ -18320,7 +18359,7 @@ interface Routes {
18320
18359
  account_type_display_name: string;
18321
18360
  errors?: any;
18322
18361
  warnings?: any;
18323
- custom_metadata?: Record<string, string | boolean> | undefined;
18362
+ custom_metadata?: Record<string, string | boolean | null> | undefined;
18324
18363
  automatically_manage_new_devices: boolean;
18325
18364
  };
18326
18365
  };
@@ -18330,7 +18369,10 @@ interface Routes {
18330
18369
  method: 'GET' | 'POST';
18331
18370
  queryParams: {};
18332
18371
  jsonBody: {};
18333
- commonParams: {};
18372
+ commonParams: {
18373
+ /** Returns devices where the account's custom_metadata contains all of the provided key/value pairs. */
18374
+ custom_metadata_has?: Record<string, string | boolean> | undefined;
18375
+ };
18334
18376
  formData: {};
18335
18377
  jsonResponse: {
18336
18378
  connected_accounts: Array<{
@@ -18347,7 +18389,7 @@ interface Routes {
18347
18389
  account_type_display_name: string;
18348
18390
  errors?: any;
18349
18391
  warnings?: any;
18350
- custom_metadata?: Record<string, string | boolean> | undefined;
18392
+ custom_metadata?: Record<string, string | boolean | null> | undefined;
18351
18393
  automatically_manage_new_devices: boolean;
18352
18394
  }>;
18353
18395
  };
@@ -18359,6 +18401,7 @@ interface Routes {
18359
18401
  jsonBody: {
18360
18402
  connected_account_id: string;
18361
18403
  automatically_manage_new_devices?: boolean | undefined;
18404
+ custom_metadata?: Record<string, string | boolean | null> | undefined;
18362
18405
  };
18363
18406
  commonParams: {};
18364
18407
  formData: {};
@@ -18377,7 +18420,7 @@ interface Routes {
18377
18420
  account_type_display_name: string;
18378
18421
  errors?: any;
18379
18422
  warnings?: any;
18380
- custom_metadata?: Record<string, string | boolean> | undefined;
18423
+ custom_metadata?: Record<string, string | boolean | null> | undefined;
18381
18424
  automatically_manage_new_devices: boolean;
18382
18425
  };
18383
18426
  };
@@ -515,12 +515,22 @@ declare const _default: {
515
515
  };
516
516
  custom_metadata: {
517
517
  additionalProperties: {
518
+ nullable: boolean;
518
519
  oneOf: ({
519
520
  maxLength: number;
520
521
  type: string;
522
+ format?: never;
523
+ nullable?: never;
521
524
  } | {
522
525
  type: string;
523
526
  maxLength?: never;
527
+ format?: never;
528
+ nullable?: never;
529
+ } | {
530
+ format: string;
531
+ nullable: boolean;
532
+ type: string;
533
+ maxLength?: never;
524
534
  })[];
525
535
  };
526
536
  type: string;
@@ -586,10 +596,20 @@ declare const _default: {
586
596
  };
587
597
  custom_metadata: {
588
598
  additionalProperties: {
599
+ nullable: boolean;
589
600
  oneOf: ({
590
601
  maxLength: number;
591
602
  type: string;
603
+ format?: never;
604
+ nullable?: never;
605
+ } | {
606
+ type: string;
607
+ maxLength?: never;
608
+ format?: never;
609
+ nullable?: never;
592
610
  } | {
611
+ format: string;
612
+ nullable: boolean;
593
613
  type: string;
594
614
  maxLength?: never;
595
615
  })[];
@@ -9866,10 +9886,20 @@ declare const _default: {
9866
9886
  };
9867
9887
  custom_metadata: {
9868
9888
  additionalProperties: {
9889
+ nullable: boolean;
9869
9890
  oneOf: ({
9870
9891
  maxLength: number;
9871
9892
  type: string;
9893
+ format?: never;
9894
+ nullable?: never;
9895
+ } | {
9896
+ type: string;
9897
+ maxLength?: never;
9898
+ format?: never;
9899
+ nullable?: never;
9872
9900
  } | {
9901
+ format: string;
9902
+ nullable: boolean;
9873
9903
  type: string;
9874
9904
  maxLength?: never;
9875
9905
  })[];
@@ -10091,6 +10121,19 @@ declare const _default: {
10091
10121
  'application/json': {
10092
10122
  schema: {
10093
10123
  properties: {
10124
+ custom_metadata_has: {
10125
+ additionalProperties: {
10126
+ oneOf: ({
10127
+ maxLength: number;
10128
+ type: string;
10129
+ } | {
10130
+ type: string;
10131
+ maxLength?: never;
10132
+ })[];
10133
+ };
10134
+ description: string;
10135
+ type: string;
10136
+ };
10094
10137
  user_identifier_key: {
10095
10138
  type: string;
10096
10139
  };
@@ -10342,60 +10385,32 @@ declare const _default: {
10342
10385
  };
10343
10386
  };
10344
10387
  '/connected_accounts/list': {
10345
- get: {
10388
+ post: {
10346
10389
  operationId: string;
10347
- responses: {
10348
- 200: {
10349
- content: {
10350
- 'application/json': {
10351
- schema: {
10352
- properties: {
10353
- connected_accounts: {
10354
- items: {
10355
- $ref: string;
10356
- };
10357
- type: string;
10358
- };
10359
- ok: {
10360
- type: string;
10390
+ requestBody: {
10391
+ content: {
10392
+ 'application/json': {
10393
+ schema: {
10394
+ properties: {
10395
+ custom_metadata_has: {
10396
+ additionalProperties: {
10397
+ oneOf: ({
10398
+ maxLength: number;
10399
+ type: string;
10400
+ } | {
10401
+ type: string;
10402
+ maxLength?: never;
10403
+ })[];
10361
10404
  };
10405
+ description: string;
10406
+ type: string;
10362
10407
  };
10363
- required: string[];
10364
- type: string;
10365
10408
  };
10409
+ type: string;
10366
10410
  };
10367
10411
  };
10368
- description: string;
10369
- };
10370
- 400: {
10371
- description: string;
10372
- };
10373
- 401: {
10374
- description: string;
10375
10412
  };
10376
10413
  };
10377
- security: ({
10378
- access_token: never[];
10379
- seam_workspace: never[];
10380
- seam_client_session_token?: never;
10381
- client_session_token?: never;
10382
- } | {
10383
- seam_client_session_token: never[];
10384
- access_token?: never;
10385
- seam_workspace?: never;
10386
- client_session_token?: never;
10387
- } | {
10388
- client_session_token: never[];
10389
- access_token?: never;
10390
- seam_workspace?: never;
10391
- seam_client_session_token?: never;
10392
- })[];
10393
- summary: string;
10394
- tags: string[];
10395
- 'x-fern-ignore': boolean;
10396
- };
10397
- post: {
10398
- operationId: string;
10399
10414
  responses: {
10400
10415
  200: {
10401
10416
  content: {
@@ -10464,6 +10479,28 @@ declare const _default: {
10464
10479
  format: string;
10465
10480
  type: string;
10466
10481
  };
10482
+ custom_metadata: {
10483
+ additionalProperties: {
10484
+ nullable: boolean;
10485
+ oneOf: ({
10486
+ maxLength: number;
10487
+ type: string;
10488
+ format?: never;
10489
+ nullable?: never;
10490
+ } | {
10491
+ type: string;
10492
+ maxLength?: never;
10493
+ format?: never;
10494
+ nullable?: never;
10495
+ } | {
10496
+ format: string;
10497
+ nullable: boolean;
10498
+ type: string;
10499
+ maxLength?: never;
10500
+ })[];
10501
+ };
10502
+ type: string;
10503
+ };
10467
10504
  };
10468
10505
  required: string[];
10469
10506
  type: string;
@@ -408,7 +408,12 @@ export default {
408
408
  created_at: { format: 'date-time', type: 'string' },
409
409
  custom_metadata: {
410
410
  additionalProperties: {
411
- oneOf: [{ maxLength: 500, type: 'string' }, { type: 'boolean' }],
411
+ nullable: true,
412
+ oneOf: [
413
+ { maxLength: 500, type: 'string' },
414
+ { type: 'boolean' },
415
+ { format: 'null', nullable: true, type: 'string' },
416
+ ],
412
417
  },
413
418
  type: 'object',
414
419
  },
@@ -464,7 +469,12 @@ export default {
464
469
  created_at: { format: 'date-time', type: 'string' },
465
470
  custom_metadata: {
466
471
  additionalProperties: {
467
- oneOf: [{ maxLength: 500, type: 'string' }, { type: 'boolean' }],
472
+ nullable: true,
473
+ oneOf: [
474
+ { maxLength: 500, type: 'string' },
475
+ { type: 'boolean' },
476
+ { format: 'null', nullable: true, type: 'string' },
477
+ ],
468
478
  },
469
479
  type: 'object',
470
480
  },
@@ -7282,9 +7292,11 @@ export default {
7282
7292
  automatically_manage_new_devices: { type: 'boolean' },
7283
7293
  custom_metadata: {
7284
7294
  additionalProperties: {
7295
+ nullable: true,
7285
7296
  oneOf: [
7286
7297
  { maxLength: 500, type: 'string' },
7287
7298
  { type: 'boolean' },
7299
+ { format: 'null', nullable: true, type: 'string' },
7288
7300
  ],
7289
7301
  },
7290
7302
  type: 'object',
@@ -7438,7 +7450,19 @@ export default {
7438
7450
  content: {
7439
7451
  'application/json': {
7440
7452
  schema: {
7441
- properties: { user_identifier_key: { type: 'string' } },
7453
+ properties: {
7454
+ custom_metadata_has: {
7455
+ additionalProperties: {
7456
+ oneOf: [
7457
+ { maxLength: 500, type: 'string' },
7458
+ { type: 'boolean' },
7459
+ ],
7460
+ },
7461
+ description: "Returns devices where the webview's custom_metadata contains all of the provided key/value pairs.",
7462
+ type: 'object',
7463
+ },
7464
+ user_identifier_key: { type: 'string' },
7465
+ },
7442
7466
  type: 'object',
7443
7467
  },
7444
7468
  },
@@ -7609,41 +7633,29 @@ export default {
7609
7633
  },
7610
7634
  },
7611
7635
  '/connected_accounts/list': {
7612
- get: {
7613
- operationId: 'connectedAccountsListGet',
7614
- responses: {
7615
- 200: {
7616
- content: {
7617
- 'application/json': {
7618
- schema: {
7619
- properties: {
7620
- connected_accounts: {
7621
- items: { $ref: '#/components/schemas/connected_account' },
7622
- type: 'array',
7636
+ post: {
7637
+ operationId: 'connectedAccountsListPost',
7638
+ requestBody: {
7639
+ content: {
7640
+ 'application/json': {
7641
+ schema: {
7642
+ properties: {
7643
+ custom_metadata_has: {
7644
+ additionalProperties: {
7645
+ oneOf: [
7646
+ { maxLength: 500, type: 'string' },
7647
+ { type: 'boolean' },
7648
+ ],
7623
7649
  },
7624
- ok: { type: 'boolean' },
7650
+ description: "Returns devices where the account's custom_metadata contains all of the provided key/value pairs.",
7651
+ type: 'object',
7625
7652
  },
7626
- required: ['connected_accounts', 'ok'],
7627
- type: 'object',
7628
7653
  },
7654
+ type: 'object',
7629
7655
  },
7630
7656
  },
7631
- description: 'OK',
7632
7657
  },
7633
- 400: { description: 'Bad Request' },
7634
- 401: { description: 'Unauthorized' },
7635
7658
  },
7636
- security: [
7637
- { access_token: [], seam_workspace: [] },
7638
- { seam_client_session_token: [] },
7639
- { client_session_token: [] },
7640
- ],
7641
- summary: '/connected_accounts/list',
7642
- tags: ['/connected_accounts'],
7643
- 'x-fern-ignore': true,
7644
- },
7645
- post: {
7646
- operationId: 'connectedAccountsListPost',
7647
7659
  responses: {
7648
7660
  200: {
7649
7661
  content: {
@@ -7688,6 +7700,17 @@ export default {
7688
7700
  properties: {
7689
7701
  automatically_manage_new_devices: { type: 'boolean' },
7690
7702
  connected_account_id: { format: 'uuid', type: 'string' },
7703
+ custom_metadata: {
7704
+ additionalProperties: {
7705
+ nullable: true,
7706
+ oneOf: [
7707
+ { maxLength: 500, type: 'string' },
7708
+ { type: 'boolean' },
7709
+ { format: 'null', nullable: true, type: 'string' },
7710
+ ],
7711
+ },
7712
+ type: 'object',
7713
+ },
7691
7714
  },
7692
7715
  required: ['connected_account_id'],
7693
7716
  type: 'object',