@seamapi/types 1.61.0 → 1.63.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.
@@ -2325,6 +2325,22 @@ declare const _default: {
2325
2325
  };
2326
2326
  properties: {
2327
2327
  properties: {
2328
+ battery: {
2329
+ description: string;
2330
+ properties: {
2331
+ level: {
2332
+ maximum: number;
2333
+ minimum: number;
2334
+ type: string;
2335
+ };
2336
+ status: {
2337
+ enum: string[];
2338
+ type: string;
2339
+ };
2340
+ };
2341
+ required: string[];
2342
+ type: string;
2343
+ };
2328
2344
  battery_level: {
2329
2345
  description: string;
2330
2346
  maximum: number;
@@ -2332,20 +2348,38 @@ declare const _default: {
2332
2348
  type: string;
2333
2349
  };
2334
2350
  image_alt_text: {
2351
+ description: string;
2335
2352
  type: string;
2336
2353
  };
2337
2354
  image_url: {
2355
+ description: string;
2356
+ format: string;
2338
2357
  type: string;
2339
2358
  };
2340
2359
  manufacturer: {
2360
+ description: string;
2341
2361
  type: string;
2342
2362
  };
2343
2363
  model: {
2344
2364
  properties: {
2365
+ accessory_keypad_supported: {
2366
+ description: string;
2367
+ type: string;
2368
+ };
2345
2369
  display_name: {
2370
+ description: string;
2346
2371
  type: string;
2347
2372
  };
2348
2373
  manufacturer_display_name: {
2374
+ description: string;
2375
+ type: string;
2376
+ };
2377
+ offline_access_codes_supported: {
2378
+ description: string;
2379
+ type: string;
2380
+ };
2381
+ online_access_codes_supported: {
2382
+ description: string;
2349
2383
  type: string;
2350
2384
  };
2351
2385
  };
@@ -2353,9 +2387,15 @@ declare const _default: {
2353
2387
  type: string;
2354
2388
  };
2355
2389
  name: {
2390
+ description: string;
2391
+ type: string;
2392
+ };
2393
+ offline_access_codes_enabled: {
2394
+ description: string;
2356
2395
  type: string;
2357
2396
  };
2358
2397
  online: {
2398
+ description: string;
2359
2399
  type: string;
2360
2400
  };
2361
2401
  online_access_codes_enabled: {
@@ -2484,6 +2524,11 @@ declare const _default: {
2484
2524
  scheme: string;
2485
2525
  type: string;
2486
2526
  };
2527
+ user_session_without_workspace: {
2528
+ bearerFormat: string;
2529
+ scheme: string;
2530
+ type: string;
2531
+ };
2487
2532
  };
2488
2533
  };
2489
2534
  info: {
@@ -6187,6 +6232,80 @@ declare const _default: {
6187
6232
  'x-fern-sdk-method-name': string;
6188
6233
  };
6189
6234
  };
6235
+ '/acs/entrances/grant_access': {
6236
+ post: {
6237
+ operationId: string;
6238
+ requestBody: {
6239
+ content: {
6240
+ 'application/json': {
6241
+ schema: {
6242
+ properties: {
6243
+ acs_entrance_id: {
6244
+ format: string;
6245
+ type: string;
6246
+ };
6247
+ acs_user_id: {
6248
+ format: string;
6249
+ type: string;
6250
+ };
6251
+ };
6252
+ required: string[];
6253
+ type: string;
6254
+ };
6255
+ };
6256
+ };
6257
+ };
6258
+ responses: {
6259
+ 200: {
6260
+ content: {
6261
+ 'application/json': {
6262
+ schema: {
6263
+ properties: {
6264
+ ok: {
6265
+ type: string;
6266
+ };
6267
+ };
6268
+ required: string[];
6269
+ type: string;
6270
+ };
6271
+ };
6272
+ };
6273
+ description: string;
6274
+ };
6275
+ 400: {
6276
+ description: string;
6277
+ };
6278
+ 401: {
6279
+ description: string;
6280
+ };
6281
+ };
6282
+ security: ({
6283
+ api_key: never[];
6284
+ client_session?: never;
6285
+ pat_with_workspace?: never;
6286
+ console_session?: never;
6287
+ } | {
6288
+ client_session: never[];
6289
+ api_key?: never;
6290
+ pat_with_workspace?: never;
6291
+ console_session?: never;
6292
+ } | {
6293
+ pat_with_workspace: never[];
6294
+ api_key?: never;
6295
+ client_session?: never;
6296
+ console_session?: never;
6297
+ } | {
6298
+ console_session: never[];
6299
+ api_key?: never;
6300
+ client_session?: never;
6301
+ pat_with_workspace?: never;
6302
+ })[];
6303
+ summary: string;
6304
+ tags: never[];
6305
+ 'x-fern-sdk-group-name': string[];
6306
+ 'x-fern-sdk-method-name': string;
6307
+ };
6308
+ };
6190
6309
  '/acs/entrances/list': {
6191
6310
  post: {
6192
6311
  operationId: string;
@@ -13900,20 +14019,47 @@ declare const _default: {
13900
14019
  };
13901
14020
  };
13902
14021
  security: ({
13903
- access_token: never[];
13904
- seam_workspace: never[];
13905
- seam_client_session_token?: never;
13906
- client_session_token?: never;
14022
+ pat_with_workspace: never[];
14023
+ pat_without_workspace?: never;
14024
+ user_session?: never;
14025
+ user_session_without_workspace?: never;
14026
+ api_key?: never;
14027
+ client_session?: never;
13907
14028
  } | {
13908
- seam_client_session_token: never[];
13909
- access_token?: never;
13910
- seam_workspace?: never;
13911
- client_session_token?: never;
14029
+ pat_without_workspace: never[];
14030
+ pat_with_workspace?: never;
14031
+ user_session?: never;
14032
+ user_session_without_workspace?: never;
14033
+ api_key?: never;
14034
+ client_session?: never;
13912
14035
  } | {
13913
- client_session_token: never[];
13914
- access_token?: never;
13915
- seam_workspace?: never;
13916
- seam_client_session_token?: never;
14036
+ user_session: never[];
14037
+ pat_with_workspace?: never;
14038
+ pat_without_workspace?: never;
14039
+ user_session_without_workspace?: never;
14040
+ api_key?: never;
14041
+ client_session?: never;
14042
+ } | {
14043
+ user_session_without_workspace: never[];
14044
+ pat_with_workspace?: never;
14045
+ pat_without_workspace?: never;
14046
+ user_session?: never;
14047
+ api_key?: never;
14048
+ client_session?: never;
14049
+ } | {
14050
+ api_key: never[];
14051
+ pat_with_workspace?: never;
14052
+ pat_without_workspace?: never;
14053
+ user_session?: never;
14054
+ user_session_without_workspace?: never;
14055
+ client_session?: never;
14056
+ } | {
14057
+ client_session: never[];
14058
+ pat_with_workspace?: never;
14059
+ pat_without_workspace?: never;
14060
+ user_session?: never;
14061
+ user_session_without_workspace?: never;
14062
+ api_key?: never;
13917
14063
  })[];
13918
14064
  summary: string;
13919
14065
  tags: string[];
@@ -13952,20 +14098,47 @@ declare const _default: {
13952
14098
  };
13953
14099
  };
13954
14100
  security: ({
13955
- access_token: never[];
13956
- seam_workspace: never[];
13957
- seam_client_session_token?: never;
13958
- client_session_token?: never;
14101
+ pat_with_workspace: never[];
14102
+ pat_without_workspace?: never;
14103
+ user_session?: never;
14104
+ user_session_without_workspace?: never;
14105
+ api_key?: never;
14106
+ client_session?: never;
13959
14107
  } | {
13960
- seam_client_session_token: never[];
13961
- access_token?: never;
13962
- seam_workspace?: never;
13963
- client_session_token?: never;
14108
+ pat_without_workspace: never[];
14109
+ pat_with_workspace?: never;
14110
+ user_session?: never;
14111
+ user_session_without_workspace?: never;
14112
+ api_key?: never;
14113
+ client_session?: never;
13964
14114
  } | {
13965
- client_session_token: never[];
13966
- access_token?: never;
13967
- seam_workspace?: never;
13968
- seam_client_session_token?: never;
14115
+ user_session: never[];
14116
+ pat_with_workspace?: never;
14117
+ pat_without_workspace?: never;
14118
+ user_session_without_workspace?: never;
14119
+ api_key?: never;
14120
+ client_session?: never;
14121
+ } | {
14122
+ user_session_without_workspace: never[];
14123
+ pat_with_workspace?: never;
14124
+ pat_without_workspace?: never;
14125
+ user_session?: never;
14126
+ api_key?: never;
14127
+ client_session?: never;
14128
+ } | {
14129
+ api_key: never[];
14130
+ pat_with_workspace?: never;
14131
+ pat_without_workspace?: never;
14132
+ user_session?: never;
14133
+ user_session_without_workspace?: never;
14134
+ client_session?: never;
14135
+ } | {
14136
+ client_session: never[];
14137
+ pat_with_workspace?: never;
14138
+ pat_without_workspace?: never;
14139
+ user_session?: never;
14140
+ user_session_without_workspace?: never;
14141
+ api_key?: never;
13969
14142
  })[];
13970
14143
  summary: string;
13971
14144
  tags: string[];
@@ -15000,6 +15173,18 @@ interface Routes {
15000
15173
  };
15001
15174
  };
15002
15175
  };
15176
+ '/acs/entrances/grant_access': {
15177
+ route: '/acs/entrances/grant_access';
15178
+ method: 'POST';
15179
+ queryParams: {};
15180
+ jsonBody: {
15181
+ acs_entrance_id: string;
15182
+ acs_user_id: string;
15183
+ };
15184
+ commonParams: {};
15185
+ formData: {};
15186
+ jsonResponse: {};
15187
+ };
15003
15188
  '/acs/entrances/list': {
15004
15189
  route: '/acs/entrances/list';
15005
15190
  method: 'GET' | 'POST';
@@ -16659,19 +16844,39 @@ interface Routes {
16659
16844
  created_at: string;
16660
16845
  is_managed: false;
16661
16846
  properties: {
16847
+ /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
16662
16848
  name: string;
16849
+ /** Indicates whether the device is online. */
16663
16850
  online: boolean;
16851
+ /** Manufacturer of the device. */
16664
16852
  manufacturer?: string | undefined;
16853
+ /** Image URL for the device. */
16665
16854
  image_url?: string | undefined;
16855
+ /** Alt text for the device image. */
16666
16856
  image_alt_text?: string | undefined;
16667
- model: {
16668
- display_name: string;
16669
- manufacturer_display_name: string;
16670
- };
16671
16857
  /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
16672
16858
  battery_level?: number | undefined;
16859
+ /** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
16860
+ battery?: {
16861
+ level: number;
16862
+ status: 'critical' | 'low' | 'good' | 'full';
16863
+ } | undefined;
16673
16864
  /** Indicates whether it is currently possible to use online access codes for the device. */
16674
16865
  online_access_codes_enabled?: boolean | undefined;
16866
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
16867
+ offline_access_codes_enabled?: boolean | undefined;
16868
+ model: {
16869
+ /** Display name of the device model. */
16870
+ display_name: string;
16871
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
16872
+ manufacturer_display_name: string;
16873
+ /** Indicates whether the device supports offline access codes. */
16874
+ offline_access_codes_supported?: boolean | undefined;
16875
+ /** Indicates whether the device supports online access codes. */
16876
+ online_access_codes_supported?: boolean | undefined;
16877
+ /** Indicates whether the device supports an accessory keypad. */
16878
+ accessory_keypad_supported?: boolean | undefined;
16879
+ };
16675
16880
  };
16676
16881
  };
16677
16882
  };
@@ -16721,19 +16926,39 @@ interface Routes {
16721
16926
  created_at: string;
16722
16927
  is_managed: false;
16723
16928
  properties: {
16929
+ /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
16724
16930
  name: string;
16931
+ /** Indicates whether the device is online. */
16725
16932
  online: boolean;
16933
+ /** Manufacturer of the device. */
16726
16934
  manufacturer?: string | undefined;
16935
+ /** Image URL for the device. */
16727
16936
  image_url?: string | undefined;
16937
+ /** Alt text for the device image. */
16728
16938
  image_alt_text?: string | undefined;
16729
- model: {
16730
- display_name: string;
16731
- manufacturer_display_name: string;
16732
- };
16733
16939
  /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
16734
16940
  battery_level?: number | undefined;
16941
+ /** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
16942
+ battery?: {
16943
+ level: number;
16944
+ status: 'critical' | 'low' | 'good' | 'full';
16945
+ } | undefined;
16735
16946
  /** Indicates whether it is currently possible to use online access codes for the device. */
16736
16947
  online_access_codes_enabled?: boolean | undefined;
16948
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
16949
+ offline_access_codes_enabled?: boolean | undefined;
16950
+ model: {
16951
+ /** Display name of the device model. */
16952
+ display_name: string;
16953
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
16954
+ manufacturer_display_name: string;
16955
+ /** Indicates whether the device supports offline access codes. */
16956
+ offline_access_codes_supported?: boolean | undefined;
16957
+ /** Indicates whether the device supports online access codes. */
16958
+ online_access_codes_supported?: boolean | undefined;
16959
+ /** Indicates whether the device supports an accessory keypad. */
16960
+ accessory_keypad_supported?: boolean | undefined;
16961
+ };
16737
16962
  };
16738
16963
  }>;
16739
16964
  };
@@ -2248,6 +2248,22 @@ declare const _default: {
2248
2248
  };
2249
2249
  properties: {
2250
2250
  properties: {
2251
+ battery: {
2252
+ description: string;
2253
+ properties: {
2254
+ level: {
2255
+ maximum: number;
2256
+ minimum: number;
2257
+ type: string;
2258
+ };
2259
+ status: {
2260
+ enum: string[];
2261
+ type: string;
2262
+ };
2263
+ };
2264
+ required: string[];
2265
+ type: string;
2266
+ };
2251
2267
  battery_level: {
2252
2268
  description: string;
2253
2269
  maximum: number;
@@ -2255,20 +2271,38 @@ declare const _default: {
2255
2271
  type: string;
2256
2272
  };
2257
2273
  image_alt_text: {
2274
+ description: string;
2258
2275
  type: string;
2259
2276
  };
2260
2277
  image_url: {
2278
+ description: string;
2279
+ format: string;
2261
2280
  type: string;
2262
2281
  };
2263
2282
  manufacturer: {
2283
+ description: string;
2264
2284
  type: string;
2265
2285
  };
2266
2286
  model: {
2267
2287
  properties: {
2288
+ accessory_keypad_supported: {
2289
+ description: string;
2290
+ type: string;
2291
+ };
2268
2292
  display_name: {
2293
+ description: string;
2269
2294
  type: string;
2270
2295
  };
2271
2296
  manufacturer_display_name: {
2297
+ description: string;
2298
+ type: string;
2299
+ };
2300
+ offline_access_codes_supported: {
2301
+ description: string;
2302
+ type: string;
2303
+ };
2304
+ online_access_codes_supported: {
2305
+ description: string;
2272
2306
  type: string;
2273
2307
  };
2274
2308
  };
@@ -2276,9 +2310,15 @@ declare const _default: {
2276
2310
  type: string;
2277
2311
  };
2278
2312
  name: {
2313
+ description: string;
2314
+ type: string;
2315
+ };
2316
+ offline_access_codes_enabled: {
2317
+ description: string;
2279
2318
  type: string;
2280
2319
  };
2281
2320
  online: {
2321
+ description: string;
2282
2322
  type: string;
2283
2323
  };
2284
2324
  online_access_codes_enabled: {
@@ -2407,6 +2447,11 @@ declare const _default: {
2407
2447
  scheme: string;
2408
2448
  type: string;
2409
2449
  };
2450
+ user_session_without_workspace: {
2451
+ bearerFormat: string;
2452
+ scheme: string;
2453
+ type: string;
2454
+ };
2410
2455
  };
2411
2456
  };
2412
2457
  info: {
@@ -6110,6 +6155,80 @@ declare const _default: {
6110
6155
  'x-fern-sdk-method-name': string;
6111
6156
  };
6112
6157
  };
6158
+ '/acs/entrances/grant_access': {
6159
+ post: {
6160
+ operationId: string;
6161
+ requestBody: {
6162
+ content: {
6163
+ 'application/json': {
6164
+ schema: {
6165
+ properties: {
6166
+ acs_entrance_id: {
6167
+ format: string;
6168
+ type: string;
6169
+ };
6170
+ acs_user_id: {
6171
+ format: string;
6172
+ type: string;
6173
+ };
6174
+ };
6175
+ required: string[];
6176
+ type: string;
6177
+ };
6178
+ };
6179
+ };
6180
+ };
6181
+ responses: {
6182
+ 200: {
6183
+ content: {
6184
+ 'application/json': {
6185
+ schema: {
6186
+ properties: {
6187
+ ok: {
6188
+ type: string;
6189
+ };
6190
+ };
6191
+ required: string[];
6192
+ type: string;
6193
+ };
6194
+ };
6195
+ };
6196
+ description: string;
6197
+ };
6198
+ 400: {
6199
+ description: string;
6200
+ };
6201
+ 401: {
6202
+ description: string;
6203
+ };
6204
+ };
6205
+ security: ({
6206
+ api_key: never[];
6207
+ client_session?: never;
6208
+ pat_with_workspace?: never;
6209
+ console_session?: never;
6210
+ } | {
6211
+ client_session: never[];
6212
+ api_key?: never;
6213
+ pat_with_workspace?: never;
6214
+ console_session?: never;
6215
+ } | {
6216
+ pat_with_workspace: never[];
6217
+ api_key?: never;
6218
+ client_session?: never;
6219
+ console_session?: never;
6220
+ } | {
6221
+ console_session: never[];
6222
+ api_key?: never;
6223
+ client_session?: never;
6224
+ pat_with_workspace?: never;
6225
+ })[];
6226
+ summary: string;
6227
+ tags: never[];
6228
+ 'x-fern-sdk-group-name': string[];
6229
+ 'x-fern-sdk-method-name': string;
6230
+ };
6231
+ };
6113
6232
  '/acs/entrances/list': {
6114
6233
  post: {
6115
6234
  operationId: string;
@@ -13823,20 +13942,47 @@ declare const _default: {
13823
13942
  };
13824
13943
  };
13825
13944
  security: ({
13826
- access_token: never[];
13827
- seam_workspace: never[];
13828
- seam_client_session_token?: never;
13829
- client_session_token?: never;
13945
+ pat_with_workspace: never[];
13946
+ pat_without_workspace?: never;
13947
+ user_session?: never;
13948
+ user_session_without_workspace?: never;
13949
+ api_key?: never;
13950
+ client_session?: never;
13830
13951
  } | {
13831
- seam_client_session_token: never[];
13832
- access_token?: never;
13833
- seam_workspace?: never;
13834
- client_session_token?: never;
13952
+ pat_without_workspace: never[];
13953
+ pat_with_workspace?: never;
13954
+ user_session?: never;
13955
+ user_session_without_workspace?: never;
13956
+ api_key?: never;
13957
+ client_session?: never;
13835
13958
  } | {
13836
- client_session_token: never[];
13837
- access_token?: never;
13838
- seam_workspace?: never;
13839
- seam_client_session_token?: never;
13959
+ user_session: never[];
13960
+ pat_with_workspace?: never;
13961
+ pat_without_workspace?: never;
13962
+ user_session_without_workspace?: never;
13963
+ api_key?: never;
13964
+ client_session?: never;
13965
+ } | {
13966
+ user_session_without_workspace: never[];
13967
+ pat_with_workspace?: never;
13968
+ pat_without_workspace?: never;
13969
+ user_session?: never;
13970
+ api_key?: never;
13971
+ client_session?: never;
13972
+ } | {
13973
+ api_key: never[];
13974
+ pat_with_workspace?: never;
13975
+ pat_without_workspace?: never;
13976
+ user_session?: never;
13977
+ user_session_without_workspace?: never;
13978
+ client_session?: never;
13979
+ } | {
13980
+ client_session: never[];
13981
+ pat_with_workspace?: never;
13982
+ pat_without_workspace?: never;
13983
+ user_session?: never;
13984
+ user_session_without_workspace?: never;
13985
+ api_key?: never;
13840
13986
  })[];
13841
13987
  summary: string;
13842
13988
  tags: string[];
@@ -13875,20 +14021,47 @@ declare const _default: {
13875
14021
  };
13876
14022
  };
13877
14023
  security: ({
13878
- access_token: never[];
13879
- seam_workspace: never[];
13880
- seam_client_session_token?: never;
13881
- client_session_token?: never;
14024
+ pat_with_workspace: never[];
14025
+ pat_without_workspace?: never;
14026
+ user_session?: never;
14027
+ user_session_without_workspace?: never;
14028
+ api_key?: never;
14029
+ client_session?: never;
13882
14030
  } | {
13883
- seam_client_session_token: never[];
13884
- access_token?: never;
13885
- seam_workspace?: never;
13886
- client_session_token?: never;
14031
+ pat_without_workspace: never[];
14032
+ pat_with_workspace?: never;
14033
+ user_session?: never;
14034
+ user_session_without_workspace?: never;
14035
+ api_key?: never;
14036
+ client_session?: never;
13887
14037
  } | {
13888
- client_session_token: never[];
13889
- access_token?: never;
13890
- seam_workspace?: never;
13891
- seam_client_session_token?: never;
14038
+ user_session: never[];
14039
+ pat_with_workspace?: never;
14040
+ pat_without_workspace?: never;
14041
+ user_session_without_workspace?: never;
14042
+ api_key?: never;
14043
+ client_session?: never;
14044
+ } | {
14045
+ user_session_without_workspace: never[];
14046
+ pat_with_workspace?: never;
14047
+ pat_without_workspace?: never;
14048
+ user_session?: never;
14049
+ api_key?: never;
14050
+ client_session?: never;
14051
+ } | {
14052
+ api_key: never[];
14053
+ pat_with_workspace?: never;
14054
+ pat_without_workspace?: never;
14055
+ user_session?: never;
14056
+ user_session_without_workspace?: never;
14057
+ client_session?: never;
14058
+ } | {
14059
+ client_session: never[];
14060
+ pat_with_workspace?: never;
14061
+ pat_without_workspace?: never;
14062
+ user_session?: never;
14063
+ user_session_without_workspace?: never;
14064
+ api_key?: never;
13892
14065
  })[];
13893
14066
  summary: string;
13894
14067
  tags: string[];