@seamapi/types 1.54.0 → 1.56.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.
@@ -2263,6 +2263,12 @@ declare const _default: {
2263
2263
  };
2264
2264
  properties: {
2265
2265
  properties: {
2266
+ battery_level: {
2267
+ description: string;
2268
+ maximum: number;
2269
+ minimum: number;
2270
+ type: string;
2271
+ };
2266
2272
  image_alt_text: {
2267
2273
  type: string;
2268
2274
  };
@@ -2290,6 +2296,10 @@ declare const _default: {
2290
2296
  online: {
2291
2297
  type: string;
2292
2298
  };
2299
+ online_access_codes_enabled: {
2300
+ description: string;
2301
+ type: string;
2302
+ };
2293
2303
  };
2294
2304
  required: string[];
2295
2305
  type: string;
@@ -2392,6 +2402,11 @@ declare const _default: {
2392
2402
  scheme: string;
2393
2403
  type: string;
2394
2404
  };
2405
+ pat_without_workspace: {
2406
+ bearerFormat: string;
2407
+ scheme: string;
2408
+ type: string;
2409
+ };
2395
2410
  seam_client_session_token: {
2396
2411
  in: string;
2397
2412
  name: string;
@@ -5918,24 +5933,24 @@ declare const _default: {
5918
5933
  };
5919
5934
  security: ({
5920
5935
  api_key: never[];
5921
- access_token?: never;
5922
- user_session?: never;
5923
5936
  client_session?: never;
5937
+ pat_with_workspace?: never;
5938
+ console_session?: never;
5924
5939
  } | {
5925
- access_token: never[];
5940
+ client_session: never[];
5926
5941
  api_key?: never;
5927
- user_session?: never;
5928
- client_session?: never;
5942
+ pat_with_workspace?: never;
5943
+ console_session?: never;
5929
5944
  } | {
5930
- user_session: never[];
5945
+ pat_with_workspace: never[];
5931
5946
  api_key?: never;
5932
- access_token?: never;
5933
5947
  client_session?: never;
5948
+ console_session?: never;
5934
5949
  } | {
5935
- client_session: never[];
5950
+ console_session: never[];
5936
5951
  api_key?: never;
5937
- access_token?: never;
5938
- user_session?: never;
5952
+ client_session?: never;
5953
+ pat_with_workspace?: never;
5939
5954
  })[];
5940
5955
  summary: string;
5941
5956
  tags: never[];
@@ -9965,6 +9980,9 @@ declare const _default: {
9965
9980
  action_attempt: {
9966
9981
  $ref: string;
9967
9982
  };
9983
+ noise_threshold: {
9984
+ $ref: string;
9985
+ };
9968
9986
  ok: {
9969
9987
  type: string;
9970
9988
  };
@@ -13286,6 +13304,75 @@ declare const _default: {
13286
13304
  'x-fern-sdk-return-value': string;
13287
13305
  };
13288
13306
  };
13307
+ '/workspaces/create': {
13308
+ post: {
13309
+ operationId: string;
13310
+ requestBody: {
13311
+ content: {
13312
+ 'application/json': {
13313
+ schema: {
13314
+ properties: {
13315
+ connect_partner_name: {
13316
+ description: string;
13317
+ type: string;
13318
+ };
13319
+ is_sandbox: {
13320
+ default: boolean;
13321
+ type: string;
13322
+ };
13323
+ name: {
13324
+ type: string;
13325
+ };
13326
+ webview_logo_shape: {
13327
+ enum: string[];
13328
+ type: string;
13329
+ };
13330
+ webview_primary_button_color: {
13331
+ type: string;
13332
+ };
13333
+ };
13334
+ required: string[];
13335
+ type: string;
13336
+ };
13337
+ };
13338
+ };
13339
+ };
13340
+ responses: {
13341
+ 200: {
13342
+ content: {
13343
+ 'application/json': {
13344
+ schema: {
13345
+ properties: {
13346
+ ok: {
13347
+ type: string;
13348
+ };
13349
+ workspace: {
13350
+ $ref: string;
13351
+ };
13352
+ };
13353
+ required: string[];
13354
+ type: string;
13355
+ };
13356
+ };
13357
+ };
13358
+ description: string;
13359
+ };
13360
+ 400: {
13361
+ description: string;
13362
+ };
13363
+ 401: {
13364
+ description: string;
13365
+ };
13366
+ };
13367
+ security: {
13368
+ pat_without_workspace: never[];
13369
+ }[];
13370
+ summary: string;
13371
+ tags: string[];
13372
+ 'x-fern-sdk-group-name': string[];
13373
+ 'x-fern-sdk-method-name': string;
13374
+ };
13375
+ };
13289
13376
  '/workspaces/get': {
13290
13377
  get: {
13291
13378
  operationId: string;
@@ -14545,10 +14632,10 @@ interface Routes {
14545
14632
  jsonResponse: {
14546
14633
  acs_system: {
14547
14634
  acs_system_id: string;
14548
- external_type: 'pti_site' | 'alta_org' | 'salto_site' | 'brivo_system' | 'hid_cm_org';
14635
+ external_type: 'pti_site' | 'alta_org' | 'salto_site' | 'brivo_system' | 'hid_cm_org' | 'visionline_system' | 'assa_abloy_cs_system_user';
14549
14636
  external_type_display_name: string;
14550
14637
  /** deprecated: use external_type */
14551
- system_type: 'pti_site' | 'alta_org' | 'salto_site' | 'brivo_system' | 'hid_cm_org';
14638
+ system_type: 'pti_site' | 'alta_org' | 'salto_site' | 'brivo_system' | 'hid_cm_org' | 'visionline_system' | 'assa_abloy_cs_system_user';
14552
14639
  /** deprecated: use external_type_display_name */
14553
14640
  system_type_display_name: string;
14554
14641
  name: string;
@@ -14570,10 +14657,10 @@ interface Routes {
14570
14657
  jsonResponse: {
14571
14658
  acs_systems: Array<{
14572
14659
  acs_system_id: string;
14573
- external_type: 'pti_site' | 'alta_org' | 'salto_site' | 'brivo_system' | 'hid_cm_org';
14660
+ external_type: 'pti_site' | 'alta_org' | 'salto_site' | 'brivo_system' | 'hid_cm_org' | 'visionline_system' | 'assa_abloy_cs_system_user';
14574
14661
  external_type_display_name: string;
14575
14662
  /** deprecated: use external_type */
14576
- system_type: 'pti_site' | 'alta_org' | 'salto_site' | 'brivo_system' | 'hid_cm_org';
14663
+ system_type: 'pti_site' | 'alta_org' | 'salto_site' | 'brivo_system' | 'hid_cm_org' | 'visionline_system' | 'assa_abloy_cs_system_user';
14577
14664
  /** deprecated: use external_type_display_name */
14578
14665
  system_type_display_name: string;
14579
14666
  name: string;
@@ -14967,7 +15054,7 @@ interface Routes {
14967
15054
  device_selection_mode?: ('none' | 'single' | 'multiple') | undefined;
14968
15055
  custom_redirect_url?: string | undefined;
14969
15056
  custom_redirect_failure_url?: string | undefined;
14970
- 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' | 'seam_passport' | 'visionline' | 'yale_access' | 'hid_cm'> | undefined;
15057
+ 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' | 'seam_passport' | 'visionline' | 'assaabloy_credential_service' | 'yale_access' | 'hid_cm'> | undefined;
14971
15058
  provider_category?: ('stable' | 'consumer_smartlocks' | 'internal_beta') | undefined;
14972
15059
  custom_metadata?: Record<string, string | number | null | boolean> | undefined;
14973
15060
  automatically_manage_new_devices?: boolean | undefined;
@@ -16113,6 +16200,10 @@ interface Routes {
16113
16200
  display_name: string;
16114
16201
  manufacturer_display_name: string;
16115
16202
  };
16203
+ /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
16204
+ battery_level?: number | undefined;
16205
+ /** Indicates whether it is currently possible to use online access codes for the device. */
16206
+ online_access_codes_enabled?: boolean | undefined;
16116
16207
  };
16117
16208
  };
16118
16209
  };
@@ -16171,6 +16262,10 @@ interface Routes {
16171
16262
  display_name: string;
16172
16263
  manufacturer_display_name: string;
16173
16264
  };
16265
+ /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
16266
+ battery_level?: number | undefined;
16267
+ /** Indicates whether it is currently possible to use online access codes for the device. */
16268
+ online_access_codes_enabled?: boolean | undefined;
16174
16269
  };
16175
16270
  }>;
16176
16271
  };
@@ -18169,6 +18264,15 @@ interface Routes {
18169
18264
  message: string;
18170
18265
  };
18171
18266
  };
18267
+ noise_threshold: {
18268
+ noise_threshold_id: string;
18269
+ device_id: string;
18270
+ name: string;
18271
+ noise_threshold_nrs?: number | undefined;
18272
+ starts_daily_at: string;
18273
+ ends_daily_at: string;
18274
+ noise_threshold_decibels: number;
18275
+ };
18172
18276
  };
18173
18277
  };
18174
18278
  '/noise_sensors/noise_thresholds/delete': {
@@ -20071,6 +20175,29 @@ interface Routes {
20071
20175
  }>;
20072
20176
  };
20073
20177
  };
20178
+ '/workspaces/create': {
20179
+ route: '/workspaces/create';
20180
+ method: 'POST';
20181
+ queryParams: {};
20182
+ jsonBody: {
20183
+ name: string;
20184
+ /** The name shown inside the connect webview */
20185
+ connect_partner_name: string;
20186
+ is_sandbox?: boolean;
20187
+ webview_primary_button_color?: string | undefined;
20188
+ webview_logo_shape?: ('circle' | 'square') | undefined;
20189
+ };
20190
+ commonParams: {};
20191
+ formData: {};
20192
+ jsonResponse: {
20193
+ workspace: {
20194
+ workspace_id: string;
20195
+ name: string;
20196
+ connect_partner_name: string | null;
20197
+ is_sandbox: boolean;
20198
+ };
20199
+ };
20200
+ };
20074
20201
  '/workspaces/get': {
20075
20202
  route: '/workspaces/get';
20076
20203
  method: 'GET' | 'POST';
@@ -2186,6 +2186,12 @@ declare const _default: {
2186
2186
  };
2187
2187
  properties: {
2188
2188
  properties: {
2189
+ battery_level: {
2190
+ description: string;
2191
+ maximum: number;
2192
+ minimum: number;
2193
+ type: string;
2194
+ };
2189
2195
  image_alt_text: {
2190
2196
  type: string;
2191
2197
  };
@@ -2213,6 +2219,10 @@ declare const _default: {
2213
2219
  online: {
2214
2220
  type: string;
2215
2221
  };
2222
+ online_access_codes_enabled: {
2223
+ description: string;
2224
+ type: string;
2225
+ };
2216
2226
  };
2217
2227
  required: string[];
2218
2228
  type: string;
@@ -2315,6 +2325,11 @@ declare const _default: {
2315
2325
  scheme: string;
2316
2326
  type: string;
2317
2327
  };
2328
+ pat_without_workspace: {
2329
+ bearerFormat: string;
2330
+ scheme: string;
2331
+ type: string;
2332
+ };
2318
2333
  seam_client_session_token: {
2319
2334
  in: string;
2320
2335
  name: string;
@@ -5841,24 +5856,24 @@ declare const _default: {
5841
5856
  };
5842
5857
  security: ({
5843
5858
  api_key: never[];
5844
- access_token?: never;
5845
- user_session?: never;
5846
5859
  client_session?: never;
5860
+ pat_with_workspace?: never;
5861
+ console_session?: never;
5847
5862
  } | {
5848
- access_token: never[];
5863
+ client_session: never[];
5849
5864
  api_key?: never;
5850
- user_session?: never;
5851
- client_session?: never;
5865
+ pat_with_workspace?: never;
5866
+ console_session?: never;
5852
5867
  } | {
5853
- user_session: never[];
5868
+ pat_with_workspace: never[];
5854
5869
  api_key?: never;
5855
- access_token?: never;
5856
5870
  client_session?: never;
5871
+ console_session?: never;
5857
5872
  } | {
5858
- client_session: never[];
5873
+ console_session: never[];
5859
5874
  api_key?: never;
5860
- access_token?: never;
5861
- user_session?: never;
5875
+ client_session?: never;
5876
+ pat_with_workspace?: never;
5862
5877
  })[];
5863
5878
  summary: string;
5864
5879
  tags: never[];
@@ -9888,6 +9903,9 @@ declare const _default: {
9888
9903
  action_attempt: {
9889
9904
  $ref: string;
9890
9905
  };
9906
+ noise_threshold: {
9907
+ $ref: string;
9908
+ };
9891
9909
  ok: {
9892
9910
  type: string;
9893
9911
  };
@@ -13209,6 +13227,75 @@ declare const _default: {
13209
13227
  'x-fern-sdk-return-value': string;
13210
13228
  };
13211
13229
  };
13230
+ '/workspaces/create': {
13231
+ post: {
13232
+ operationId: string;
13233
+ requestBody: {
13234
+ content: {
13235
+ 'application/json': {
13236
+ schema: {
13237
+ properties: {
13238
+ connect_partner_name: {
13239
+ description: string;
13240
+ type: string;
13241
+ };
13242
+ is_sandbox: {
13243
+ default: boolean;
13244
+ type: string;
13245
+ };
13246
+ name: {
13247
+ type: string;
13248
+ };
13249
+ webview_logo_shape: {
13250
+ enum: string[];
13251
+ type: string;
13252
+ };
13253
+ webview_primary_button_color: {
13254
+ type: string;
13255
+ };
13256
+ };
13257
+ required: string[];
13258
+ type: string;
13259
+ };
13260
+ };
13261
+ };
13262
+ };
13263
+ responses: {
13264
+ 200: {
13265
+ content: {
13266
+ 'application/json': {
13267
+ schema: {
13268
+ properties: {
13269
+ ok: {
13270
+ type: string;
13271
+ };
13272
+ workspace: {
13273
+ $ref: string;
13274
+ };
13275
+ };
13276
+ required: string[];
13277
+ type: string;
13278
+ };
13279
+ };
13280
+ };
13281
+ description: string;
13282
+ };
13283
+ 400: {
13284
+ description: string;
13285
+ };
13286
+ 401: {
13287
+ description: string;
13288
+ };
13289
+ };
13290
+ security: {
13291
+ pat_without_workspace: never[];
13292
+ }[];
13293
+ summary: string;
13294
+ tags: string[];
13295
+ 'x-fern-sdk-group-name': string[];
13296
+ 'x-fern-sdk-method-name': string;
13297
+ };
13298
+ };
13212
13299
  '/workspaces/get': {
13213
13300
  get: {
13214
13301
  operationId: string;
@@ -177,6 +177,8 @@ export default {
177
177
  'salto_site',
178
178
  'brivo_system',
179
179
  'hid_cm_org',
180
+ 'visionline_system',
181
+ 'assa_abloy_cs_system_user',
180
182
  ],
181
183
  type: 'string',
182
184
  },
@@ -190,6 +192,8 @@ export default {
190
192
  'salto_site',
191
193
  'brivo_system',
192
194
  'hid_cm_org',
195
+ 'visionline_system',
196
+ 'assa_abloy_cs_system_user',
193
197
  ],
194
198
  type: 'string',
195
199
  },
@@ -1740,6 +1744,12 @@ export default {
1740
1744
  is_managed: { enum: [false], type: 'boolean' },
1741
1745
  properties: {
1742
1746
  properties: {
1747
+ battery_level: {
1748
+ description: 'Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.',
1749
+ maximum: 1,
1750
+ minimum: 0,
1751
+ type: 'number',
1752
+ },
1743
1753
  image_alt_text: { type: 'string' },
1744
1754
  image_url: { type: 'string' },
1745
1755
  manufacturer: { type: 'string' },
@@ -1753,6 +1763,10 @@ export default {
1753
1763
  },
1754
1764
  name: { type: 'string' },
1755
1765
  online: { type: 'boolean' },
1766
+ online_access_codes_enabled: {
1767
+ description: 'Indicates whether it is currently possible to use online access codes for the device.',
1768
+ type: 'boolean',
1769
+ },
1756
1770
  },
1757
1771
  required: ['name', 'online', 'model'],
1758
1772
  type: 'object',
@@ -1842,6 +1856,11 @@ export default {
1842
1856
  scheme: 'bearer',
1843
1857
  type: 'http',
1844
1858
  },
1859
+ pat_without_workspace: {
1860
+ bearerFormat: 'API Token',
1861
+ scheme: 'bearer',
1862
+ type: 'http',
1863
+ },
1845
1864
  seam_client_session_token: {
1846
1865
  in: 'header',
1847
1866
  name: 'seam-client-session-token',
@@ -4208,9 +4227,9 @@ export default {
4208
4227
  },
4209
4228
  security: [
4210
4229
  { api_key: [] },
4211
- { access_token: [] },
4212
- { user_session: [] },
4213
4230
  { client_session: [] },
4231
+ { pat_with_workspace: [] },
4232
+ { console_session: [] },
4214
4233
  ],
4215
4234
  summary: '/acs/entrances/list',
4216
4235
  tags: [],
@@ -5466,6 +5485,7 @@ export default {
5466
5485
  'wyze',
5467
5486
  'seam_passport',
5468
5487
  'visionline',
5488
+ 'assaabloy_credential_service',
5469
5489
  'yale_access',
5470
5490
  'hid_cm',
5471
5491
  ],
@@ -7391,9 +7411,12 @@ export default {
7391
7411
  action_attempt: {
7392
7412
  $ref: '#/components/schemas/action_attempt',
7393
7413
  },
7414
+ noise_threshold: {
7415
+ $ref: '#/components/schemas/noise_threshold',
7416
+ },
7394
7417
  ok: { type: 'boolean' },
7395
7418
  },
7396
- required: ['action_attempt', 'ok'],
7419
+ required: ['action_attempt', 'noise_threshold', 'ok'],
7397
7420
  type: 'object',
7398
7421
  },
7399
7422
  },
@@ -9646,6 +9669,58 @@ export default {
9646
9669
  'x-fern-sdk-return-value': 'webhooks',
9647
9670
  },
9648
9671
  },
9672
+ '/workspaces/create': {
9673
+ post: {
9674
+ operationId: 'workspacesCreatePost',
9675
+ requestBody: {
9676
+ content: {
9677
+ 'application/json': {
9678
+ schema: {
9679
+ properties: {
9680
+ connect_partner_name: {
9681
+ description: 'The name shown inside the connect webview',
9682
+ type: 'string',
9683
+ },
9684
+ is_sandbox: { default: false, type: 'boolean' },
9685
+ name: { type: 'string' },
9686
+ webview_logo_shape: {
9687
+ enum: ['circle', 'square'],
9688
+ type: 'string',
9689
+ },
9690
+ webview_primary_button_color: { type: 'string' },
9691
+ },
9692
+ required: ['name', 'connect_partner_name'],
9693
+ type: 'object',
9694
+ },
9695
+ },
9696
+ },
9697
+ },
9698
+ responses: {
9699
+ 200: {
9700
+ content: {
9701
+ 'application/json': {
9702
+ schema: {
9703
+ properties: {
9704
+ ok: { type: 'boolean' },
9705
+ workspace: { $ref: '#/components/schemas/workspace' },
9706
+ },
9707
+ required: ['workspace', 'ok'],
9708
+ type: 'object',
9709
+ },
9710
+ },
9711
+ },
9712
+ description: 'OK',
9713
+ },
9714
+ 400: { description: 'Bad Request' },
9715
+ 401: { description: 'Unauthorized' },
9716
+ },
9717
+ security: [{ pat_without_workspace: [] }],
9718
+ summary: '/workspaces/create',
9719
+ tags: ['/workspaces'],
9720
+ 'x-fern-sdk-group-name': ['workspaces'],
9721
+ 'x-fern-sdk-method-name': 'create',
9722
+ },
9723
+ },
9649
9724
  '/workspaces/get': {
9650
9725
  get: {
9651
9726
  operationId: 'workspacesGetGet',