@seamapi/types 1.13.0 → 1.15.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.
@@ -87,6 +87,9 @@ declare const _default: {
87
87
  is_backup_access_code_available: {
88
88
  type: string;
89
89
  };
90
+ is_external_modification_allowed: {
91
+ type: string;
92
+ };
90
93
  is_managed: {
91
94
  enum: boolean[];
92
95
  type: string;
@@ -2630,6 +2633,9 @@ declare const _default: {
2630
2633
  format: string;
2631
2634
  type: string;
2632
2635
  };
2636
+ user_identifier_key: {
2637
+ type: string;
2638
+ };
2633
2639
  };
2634
2640
  type: string;
2635
2641
  };
@@ -3570,6 +3576,9 @@ declare const _default: {
3570
3576
  ends_at: {
3571
3577
  type: string;
3572
3578
  };
3579
+ is_managed: {
3580
+ type: string;
3581
+ };
3573
3582
  name: {
3574
3583
  type: string;
3575
3584
  };
@@ -3677,6 +3686,9 @@ declare const _default: {
3677
3686
  ends_at: {
3678
3687
  type: string;
3679
3688
  };
3689
+ is_managed: {
3690
+ type: string;
3691
+ };
3680
3692
  name: {
3681
3693
  type: string;
3682
3694
  };
@@ -4440,7 +4452,7 @@ declare const _default: {
4440
4452
  'x-fern-sdk-method-name': string;
4441
4453
  };
4442
4454
  };
4443
- '/acs/systems/get': {
4455
+ '/acs/credentials/create': {
4444
4456
  post: {
4445
4457
  operationId: string;
4446
4458
  requestBody: {
@@ -4448,10 +4460,19 @@ declare const _default: {
4448
4460
  'application/json': {
4449
4461
  schema: {
4450
4462
  properties: {
4451
- acs_system_id: {
4463
+ acs_user_id: {
4452
4464
  format: string;
4453
4465
  type: string;
4454
4466
  };
4467
+ code: {
4468
+ oneOf: ({
4469
+ pattern: string;
4470
+ type: string;
4471
+ } | {
4472
+ pattern?: never;
4473
+ type?: never;
4474
+ })[];
4475
+ };
4455
4476
  };
4456
4477
  required: string[];
4457
4478
  type: string;
@@ -4465,8 +4486,35 @@ declare const _default: {
4465
4486
  'application/json': {
4466
4487
  schema: {
4467
4488
  properties: {
4468
- acs_system: {
4469
- $ref: string;
4489
+ acs_credential: {
4490
+ properties: {
4491
+ acs_credential_id: {
4492
+ format: string;
4493
+ type: string;
4494
+ };
4495
+ acs_system_id: {
4496
+ format: string;
4497
+ type: string;
4498
+ };
4499
+ acs_user_id: {
4500
+ format: string;
4501
+ type: string;
4502
+ };
4503
+ code: {
4504
+ nullable: boolean;
4505
+ type: string;
4506
+ };
4507
+ created_at: {
4508
+ format: string;
4509
+ type: string;
4510
+ };
4511
+ workspace_id: {
4512
+ format: string;
4513
+ type: string;
4514
+ };
4515
+ };
4516
+ required: string[];
4517
+ type: string;
4470
4518
  };
4471
4519
  ok: {
4472
4520
  type: string;
@@ -4508,18 +4556,221 @@ declare const _default: {
4508
4556
  'x-fern-sdk-method-name': string;
4509
4557
  };
4510
4558
  };
4511
- '/acs/systems/list': {
4512
- get: {
4559
+ '/acs/credentials/delete': {
4560
+ post: {
4513
4561
  operationId: string;
4562
+ requestBody: {
4563
+ content: {
4564
+ 'application/json': {
4565
+ schema: {
4566
+ properties: {
4567
+ acs_credential_id: {
4568
+ format: string;
4569
+ type: string;
4570
+ };
4571
+ };
4572
+ required: string[];
4573
+ type: string;
4574
+ };
4575
+ };
4576
+ };
4577
+ };
4514
4578
  responses: {
4515
4579
  200: {
4516
4580
  content: {
4517
4581
  'application/json': {
4518
4582
  schema: {
4519
4583
  properties: {
4520
- acs_systems: {
4584
+ ok: {
4585
+ type: string;
4586
+ };
4587
+ };
4588
+ required: string[];
4589
+ type: string;
4590
+ };
4591
+ };
4592
+ };
4593
+ description: string;
4594
+ };
4595
+ 400: {
4596
+ description: string;
4597
+ };
4598
+ 401: {
4599
+ description: string;
4600
+ };
4601
+ };
4602
+ security: ({
4603
+ access_token: never[];
4604
+ seam_workspace: never[];
4605
+ seam_client_session_token?: never;
4606
+ client_session_token?: never;
4607
+ } | {
4608
+ seam_client_session_token: never[];
4609
+ access_token?: never;
4610
+ seam_workspace?: never;
4611
+ client_session_token?: never;
4612
+ } | {
4613
+ client_session_token: never[];
4614
+ access_token?: never;
4615
+ seam_workspace?: never;
4616
+ seam_client_session_token?: never;
4617
+ })[];
4618
+ summary: string;
4619
+ tags: never[];
4620
+ 'x-fern-sdk-group-name': string[];
4621
+ 'x-fern-sdk-method-name': string;
4622
+ };
4623
+ };
4624
+ '/acs/credentials/get': {
4625
+ post: {
4626
+ operationId: string;
4627
+ requestBody: {
4628
+ content: {
4629
+ 'application/json': {
4630
+ schema: {
4631
+ properties: {
4632
+ acs_credentials_id: {
4633
+ format: string;
4634
+ type: string;
4635
+ };
4636
+ };
4637
+ required: string[];
4638
+ type: string;
4639
+ };
4640
+ };
4641
+ };
4642
+ };
4643
+ responses: {
4644
+ 200: {
4645
+ content: {
4646
+ 'application/json': {
4647
+ schema: {
4648
+ properties: {
4649
+ acs_credential: {
4650
+ properties: {
4651
+ acs_credential_id: {
4652
+ format: string;
4653
+ type: string;
4654
+ };
4655
+ acs_system_id: {
4656
+ format: string;
4657
+ type: string;
4658
+ };
4659
+ acs_user_id: {
4660
+ format: string;
4661
+ type: string;
4662
+ };
4663
+ code: {
4664
+ nullable: boolean;
4665
+ type: string;
4666
+ };
4667
+ created_at: {
4668
+ format: string;
4669
+ type: string;
4670
+ };
4671
+ workspace_id: {
4672
+ format: string;
4673
+ type: string;
4674
+ };
4675
+ };
4676
+ required: string[];
4677
+ type: string;
4678
+ };
4679
+ ok: {
4680
+ type: string;
4681
+ };
4682
+ };
4683
+ required: string[];
4684
+ type: string;
4685
+ };
4686
+ };
4687
+ };
4688
+ description: string;
4689
+ };
4690
+ 400: {
4691
+ description: string;
4692
+ };
4693
+ 401: {
4694
+ description: string;
4695
+ };
4696
+ };
4697
+ security: ({
4698
+ access_token: never[];
4699
+ seam_workspace: never[];
4700
+ seam_client_session_token?: never;
4701
+ client_session_token?: never;
4702
+ } | {
4703
+ seam_client_session_token: never[];
4704
+ access_token?: never;
4705
+ seam_workspace?: never;
4706
+ client_session_token?: never;
4707
+ } | {
4708
+ client_session_token: never[];
4709
+ access_token?: never;
4710
+ seam_workspace?: never;
4711
+ seam_client_session_token?: never;
4712
+ })[];
4713
+ summary: string;
4714
+ tags: never[];
4715
+ 'x-fern-sdk-group-name': string[];
4716
+ 'x-fern-sdk-method-name': string;
4717
+ };
4718
+ };
4719
+ '/acs/credentials/list': {
4720
+ post: {
4721
+ operationId: string;
4722
+ requestBody: {
4723
+ content: {
4724
+ 'application/json': {
4725
+ schema: {
4726
+ properties: {
4727
+ acs_user_id: {
4728
+ format: string;
4729
+ type: string;
4730
+ };
4731
+ };
4732
+ required: string[];
4733
+ type: string;
4734
+ };
4735
+ };
4736
+ };
4737
+ };
4738
+ responses: {
4739
+ 200: {
4740
+ content: {
4741
+ 'application/json': {
4742
+ schema: {
4743
+ properties: {
4744
+ acs_credentials: {
4521
4745
  items: {
4522
- $ref: string;
4746
+ properties: {
4747
+ acs_credential_id: {
4748
+ format: string;
4749
+ type: string;
4750
+ };
4751
+ acs_system_id: {
4752
+ format: string;
4753
+ type: string;
4754
+ };
4755
+ acs_user_id: {
4756
+ format: string;
4757
+ type: string;
4758
+ };
4759
+ code: {
4760
+ nullable: boolean;
4761
+ type: string;
4762
+ };
4763
+ created_at: {
4764
+ format: string;
4765
+ type: string;
4766
+ };
4767
+ workspace_id: {
4768
+ format: string;
4769
+ type: string;
4770
+ };
4771
+ };
4772
+ required: string[];
4773
+ type: string;
4523
4774
  };
4524
4775
  type: string;
4525
4776
  };
@@ -4559,10 +4810,96 @@ declare const _default: {
4559
4810
  })[];
4560
4811
  summary: string;
4561
4812
  tags: never[];
4562
- 'x-fern-ignore': boolean;
4813
+ 'x-fern-sdk-group-name': string[];
4814
+ 'x-fern-sdk-method-name': string;
4815
+ };
4816
+ };
4817
+ '/acs/systems/get': {
4818
+ post: {
4819
+ operationId: string;
4820
+ requestBody: {
4821
+ content: {
4822
+ 'application/json': {
4823
+ schema: {
4824
+ properties: {
4825
+ acs_system_id: {
4826
+ format: string;
4827
+ type: string;
4828
+ };
4829
+ };
4830
+ required: string[];
4831
+ type: string;
4832
+ };
4833
+ };
4834
+ };
4835
+ };
4836
+ responses: {
4837
+ 200: {
4838
+ content: {
4839
+ 'application/json': {
4840
+ schema: {
4841
+ properties: {
4842
+ acs_system: {
4843
+ $ref: string;
4844
+ };
4845
+ ok: {
4846
+ type: string;
4847
+ };
4848
+ };
4849
+ required: string[];
4850
+ type: string;
4851
+ };
4852
+ };
4853
+ };
4854
+ description: string;
4855
+ };
4856
+ 400: {
4857
+ description: string;
4858
+ };
4859
+ 401: {
4860
+ description: string;
4861
+ };
4862
+ };
4863
+ security: ({
4864
+ access_token: never[];
4865
+ seam_workspace: never[];
4866
+ seam_client_session_token?: never;
4867
+ client_session_token?: never;
4868
+ } | {
4869
+ seam_client_session_token: never[];
4870
+ access_token?: never;
4871
+ seam_workspace?: never;
4872
+ client_session_token?: never;
4873
+ } | {
4874
+ client_session_token: never[];
4875
+ access_token?: never;
4876
+ seam_workspace?: never;
4877
+ seam_client_session_token?: never;
4878
+ })[];
4879
+ summary: string;
4880
+ tags: never[];
4881
+ 'x-fern-sdk-group-name': string[];
4882
+ 'x-fern-sdk-method-name': string;
4563
4883
  };
4884
+ };
4885
+ '/acs/systems/list': {
4564
4886
  post: {
4565
4887
  operationId: string;
4888
+ requestBody: {
4889
+ content: {
4890
+ 'application/json': {
4891
+ schema: {
4892
+ properties: {
4893
+ connected_account_id: {
4894
+ format: string;
4895
+ type: string;
4896
+ };
4897
+ };
4898
+ type: string;
4899
+ };
4900
+ };
4901
+ };
4902
+ };
4566
4903
  responses: {
4567
4904
  200: {
4568
4905
  content: {
@@ -6707,6 +7044,9 @@ declare const _default: {
6707
7044
  enum: string[];
6708
7045
  type: string;
6709
7046
  };
7047
+ user_identifier_key: {
7048
+ type: string;
7049
+ };
6710
7050
  };
6711
7051
  type: string;
6712
7052
  };
@@ -6986,6 +7326,9 @@ declare const _default: {
6986
7326
  enum: string[];
6987
7327
  type: string;
6988
7328
  };
7329
+ user_identifier_key: {
7330
+ type: string;
7331
+ };
6989
7332
  };
6990
7333
  type: string;
6991
7334
  };
@@ -7883,6 +8226,9 @@ declare const _default: {
7883
8226
  enum: string[];
7884
8227
  type: string;
7885
8228
  };
8229
+ user_identifier_key: {
8230
+ type: string;
8231
+ };
7886
8232
  };
7887
8233
  type: string;
7888
8234
  };
@@ -9590,6 +9936,9 @@ declare const _default: {
9590
9936
  enum: string[];
9591
9937
  type: string;
9592
9938
  };
9939
+ user_identifier_key: {
9940
+ type: string;
9941
+ };
9593
9942
  };
9594
9943
  type: string;
9595
9944
  };
@@ -10388,6 +10737,7 @@ interface Routes {
10388
10737
  is_backup_access_code_available: boolean;
10389
10738
  is_backup?: boolean | undefined;
10390
10739
  pulled_backup_access_code_id?: (string | null) | undefined;
10740
+ is_external_modification_allowed: boolean;
10391
10741
  };
10392
10742
  };
10393
10743
  };
@@ -10429,6 +10779,7 @@ interface Routes {
10429
10779
  is_backup_access_code_available: boolean;
10430
10780
  is_backup?: boolean | undefined;
10431
10781
  pulled_backup_access_code_id?: (string | null) | undefined;
10782
+ is_external_modification_allowed: boolean;
10432
10783
  }>;
10433
10784
  };
10434
10785
  };
@@ -10515,6 +10866,7 @@ interface Routes {
10515
10866
  is_backup_access_code_available: boolean;
10516
10867
  is_backup?: boolean | undefined;
10517
10868
  pulled_backup_access_code_id?: (string | null) | undefined;
10869
+ is_external_modification_allowed: boolean;
10518
10870
  };
10519
10871
  };
10520
10872
  };
@@ -10526,6 +10878,7 @@ interface Routes {
10526
10878
  commonParams: {
10527
10879
  device_id?: string | undefined;
10528
10880
  access_code_ids?: string[] | undefined;
10881
+ user_identifier_key?: string | undefined;
10529
10882
  };
10530
10883
  formData: {};
10531
10884
  jsonResponse: {
@@ -10548,6 +10901,7 @@ interface Routes {
10548
10901
  is_backup_access_code_available: boolean;
10549
10902
  is_backup?: boolean | undefined;
10550
10903
  pulled_backup_access_code_id?: (string | null) | undefined;
10904
+ is_external_modification_allowed: boolean;
10551
10905
  }>;
10552
10906
  };
10553
10907
  };
@@ -10580,6 +10934,7 @@ interface Routes {
10580
10934
  is_backup_access_code_available: boolean;
10581
10935
  is_backup?: boolean | undefined;
10582
10936
  pulled_backup_access_code_id?: (string | null) | undefined;
10937
+ is_external_modification_allowed: boolean;
10583
10938
  };
10584
10939
  };
10585
10940
  };
@@ -10750,6 +11105,7 @@ interface Routes {
10750
11105
  access_code_id: string;
10751
11106
  device_id?: string | undefined;
10752
11107
  type?: ('ongoing' | 'time_bound') | undefined;
11108
+ is_managed?: boolean | undefined;
10753
11109
  };
10754
11110
  commonParams: {};
10755
11111
  formData: {};
@@ -10912,6 +11268,78 @@ interface Routes {
10912
11268
  formData: {};
10913
11269
  jsonResponse: {};
10914
11270
  };
11271
+ '/acs/credentials/create': {
11272
+ route: '/acs/credentials/create';
11273
+ method: 'POST';
11274
+ queryParams: {};
11275
+ jsonBody: {};
11276
+ commonParams: {
11277
+ acs_user_id: string;
11278
+ code?: string | undefined;
11279
+ };
11280
+ formData: {};
11281
+ jsonResponse: {
11282
+ acs_credential: {
11283
+ acs_credential_id: string;
11284
+ acs_user_id: string;
11285
+ acs_system_id: string;
11286
+ code: string | null;
11287
+ created_at: string;
11288
+ workspace_id: string;
11289
+ };
11290
+ };
11291
+ };
11292
+ '/acs/credentials/delete': {
11293
+ route: '/acs/credentials/delete';
11294
+ method: 'DELETE' | 'POST';
11295
+ queryParams: {};
11296
+ jsonBody: {};
11297
+ commonParams: {
11298
+ acs_credential_id: string;
11299
+ };
11300
+ formData: {};
11301
+ jsonResponse: {};
11302
+ };
11303
+ '/acs/credentials/get': {
11304
+ route: '/acs/credentials/get';
11305
+ method: 'GET' | 'POST';
11306
+ queryParams: {};
11307
+ jsonBody: {};
11308
+ commonParams: {
11309
+ acs_credentials_id: string;
11310
+ };
11311
+ formData: {};
11312
+ jsonResponse: {
11313
+ acs_credential: {
11314
+ acs_credential_id: string;
11315
+ acs_user_id: string;
11316
+ acs_system_id: string;
11317
+ code: string | null;
11318
+ created_at: string;
11319
+ workspace_id: string;
11320
+ };
11321
+ };
11322
+ };
11323
+ '/acs/credentials/list': {
11324
+ route: '/acs/credentials/list';
11325
+ method: 'GET' | 'POST';
11326
+ queryParams: {};
11327
+ jsonBody: {};
11328
+ commonParams: {
11329
+ acs_user_id: string;
11330
+ };
11331
+ formData: {};
11332
+ jsonResponse: {
11333
+ acs_credentials: Array<{
11334
+ acs_credential_id: string;
11335
+ acs_user_id: string;
11336
+ acs_system_id: string;
11337
+ code: string | null;
11338
+ created_at: string;
11339
+ workspace_id: string;
11340
+ }>;
11341
+ };
11342
+ };
10915
11343
  '/acs/systems/get': {
10916
11344
  route: '/acs/systems/get';
10917
11345
  method: 'GET' | 'POST';
@@ -10936,7 +11364,9 @@ interface Routes {
10936
11364
  method: 'GET' | 'POST';
10937
11365
  queryParams: {};
10938
11366
  jsonBody: {};
10939
- commonParams: {};
11367
+ commonParams: {
11368
+ connected_account_id?: string | undefined;
11369
+ };
10940
11370
  formData: {};
10941
11371
  jsonResponse: {
10942
11372
  acs_systems: Array<{
@@ -11247,7 +11677,7 @@ interface Routes {
11247
11677
  device_selection_mode?: ('none' | 'single' | 'multiple') | undefined;
11248
11678
  custom_redirect_url?: string | undefined;
11249
11679
  custom_redirect_failure_url?: string | undefined;
11250
- accepted_providers?: Array<'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'yale_access'> | undefined;
11680
+ 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' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'yale_access'> | undefined;
11251
11681
  provider_category?: ('stable' | 'consumer_smartlocks' | 'internal_beta') | undefined;
11252
11682
  custom_metadata?: Record<string, string | number | null | boolean> | undefined;
11253
11683
  automatically_manage_new_devices?: boolean | undefined;
@@ -11837,6 +12267,7 @@ interface Routes {
11837
12267
  device_ids?: string[] | undefined;
11838
12268
  limit?: number;
11839
12269
  created_before?: string | undefined;
12270
+ user_identifier_key?: string | undefined;
11840
12271
  };
11841
12272
  formData: {};
11842
12273
  jsonResponse: {
@@ -12301,6 +12732,7 @@ interface Routes {
12301
12732
  device_ids?: string[] | undefined;
12302
12733
  limit?: number;
12303
12734
  created_before?: string | undefined;
12735
+ user_identifier_key?: string | undefined;
12304
12736
  };
12305
12737
  formData: {};
12306
12738
  jsonResponse: {
@@ -12519,6 +12951,7 @@ interface Routes {
12519
12951
  device_ids?: string[] | undefined;
12520
12952
  limit?: number;
12521
12953
  created_before?: string | undefined;
12954
+ user_identifier_key?: string | undefined;
12522
12955
  };
12523
12956
  formData: {};
12524
12957
  jsonResponse: {
@@ -13375,6 +13808,7 @@ interface Routes {
13375
13808
  device_ids?: string[] | undefined;
13376
13809
  limit?: number;
13377
13810
  created_before?: string | undefined;
13811
+ user_identifier_key?: string | undefined;
13378
13812
  };
13379
13813
  formData: {};
13380
13814
  jsonResponse: {