@seamapi/types 1.61.0 → 1.62.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: {
@@ -13900,20 +13945,47 @@ declare const _default: {
13900
13945
  };
13901
13946
  };
13902
13947
  security: ({
13903
- access_token: never[];
13904
- seam_workspace: never[];
13905
- seam_client_session_token?: never;
13906
- client_session_token?: never;
13948
+ pat_with_workspace: never[];
13949
+ pat_without_workspace?: never;
13950
+ user_session?: never;
13951
+ user_session_without_workspace?: never;
13952
+ api_key?: never;
13953
+ client_session?: never;
13907
13954
  } | {
13908
- seam_client_session_token: never[];
13909
- access_token?: never;
13910
- seam_workspace?: never;
13911
- client_session_token?: never;
13955
+ pat_without_workspace: never[];
13956
+ pat_with_workspace?: never;
13957
+ user_session?: never;
13958
+ user_session_without_workspace?: never;
13959
+ api_key?: never;
13960
+ client_session?: never;
13912
13961
  } | {
13913
- client_session_token: never[];
13914
- access_token?: never;
13915
- seam_workspace?: never;
13916
- seam_client_session_token?: never;
13962
+ user_session: never[];
13963
+ pat_with_workspace?: never;
13964
+ pat_without_workspace?: never;
13965
+ user_session_without_workspace?: never;
13966
+ api_key?: never;
13967
+ client_session?: never;
13968
+ } | {
13969
+ user_session_without_workspace: never[];
13970
+ pat_with_workspace?: never;
13971
+ pat_without_workspace?: never;
13972
+ user_session?: never;
13973
+ api_key?: never;
13974
+ client_session?: never;
13975
+ } | {
13976
+ api_key: never[];
13977
+ pat_with_workspace?: never;
13978
+ pat_without_workspace?: never;
13979
+ user_session?: never;
13980
+ user_session_without_workspace?: never;
13981
+ client_session?: never;
13982
+ } | {
13983
+ client_session: never[];
13984
+ pat_with_workspace?: never;
13985
+ pat_without_workspace?: never;
13986
+ user_session?: never;
13987
+ user_session_without_workspace?: never;
13988
+ api_key?: never;
13917
13989
  })[];
13918
13990
  summary: string;
13919
13991
  tags: string[];
@@ -13952,20 +14024,47 @@ declare const _default: {
13952
14024
  };
13953
14025
  };
13954
14026
  security: ({
13955
- access_token: never[];
13956
- seam_workspace: never[];
13957
- seam_client_session_token?: never;
13958
- client_session_token?: never;
14027
+ pat_with_workspace: never[];
14028
+ pat_without_workspace?: never;
14029
+ user_session?: never;
14030
+ user_session_without_workspace?: never;
14031
+ api_key?: never;
14032
+ client_session?: never;
13959
14033
  } | {
13960
- seam_client_session_token: never[];
13961
- access_token?: never;
13962
- seam_workspace?: never;
13963
- client_session_token?: never;
14034
+ pat_without_workspace: never[];
14035
+ pat_with_workspace?: never;
14036
+ user_session?: never;
14037
+ user_session_without_workspace?: never;
14038
+ api_key?: never;
14039
+ client_session?: never;
13964
14040
  } | {
13965
- client_session_token: never[];
13966
- access_token?: never;
13967
- seam_workspace?: never;
13968
- seam_client_session_token?: never;
14041
+ user_session: never[];
14042
+ pat_with_workspace?: never;
14043
+ pat_without_workspace?: never;
14044
+ user_session_without_workspace?: never;
14045
+ api_key?: never;
14046
+ client_session?: never;
14047
+ } | {
14048
+ user_session_without_workspace: never[];
14049
+ pat_with_workspace?: never;
14050
+ pat_without_workspace?: never;
14051
+ user_session?: never;
14052
+ api_key?: never;
14053
+ client_session?: never;
14054
+ } | {
14055
+ api_key: never[];
14056
+ pat_with_workspace?: never;
14057
+ pat_without_workspace?: never;
14058
+ user_session?: never;
14059
+ user_session_without_workspace?: never;
14060
+ client_session?: never;
14061
+ } | {
14062
+ client_session: never[];
14063
+ pat_with_workspace?: never;
14064
+ pat_without_workspace?: never;
14065
+ user_session?: never;
14066
+ user_session_without_workspace?: never;
14067
+ api_key?: never;
13969
14068
  })[];
13970
14069
  summary: string;
13971
14070
  tags: string[];
@@ -16659,19 +16758,39 @@ interface Routes {
16659
16758
  created_at: string;
16660
16759
  is_managed: false;
16661
16760
  properties: {
16761
+ /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
16662
16762
  name: string;
16763
+ /** Indicates whether the device is online. */
16663
16764
  online: boolean;
16765
+ /** Manufacturer of the device. */
16664
16766
  manufacturer?: string | undefined;
16767
+ /** Image URL for the device. */
16665
16768
  image_url?: string | undefined;
16769
+ /** Alt text for the device image. */
16666
16770
  image_alt_text?: string | undefined;
16667
- model: {
16668
- display_name: string;
16669
- manufacturer_display_name: string;
16670
- };
16671
16771
  /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
16672
16772
  battery_level?: number | undefined;
16773
+ /** 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. */
16774
+ battery?: {
16775
+ level: number;
16776
+ status: 'critical' | 'low' | 'good' | 'full';
16777
+ } | undefined;
16673
16778
  /** Indicates whether it is currently possible to use online access codes for the device. */
16674
16779
  online_access_codes_enabled?: boolean | undefined;
16780
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
16781
+ offline_access_codes_enabled?: boolean | undefined;
16782
+ model: {
16783
+ /** Display name of the device model. */
16784
+ display_name: string;
16785
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
16786
+ manufacturer_display_name: string;
16787
+ /** Indicates whether the device supports offline access codes. */
16788
+ offline_access_codes_supported?: boolean | undefined;
16789
+ /** Indicates whether the device supports online access codes. */
16790
+ online_access_codes_supported?: boolean | undefined;
16791
+ /** Indicates whether the device supports an accessory keypad. */
16792
+ accessory_keypad_supported?: boolean | undefined;
16793
+ };
16675
16794
  };
16676
16795
  };
16677
16796
  };
@@ -16721,19 +16840,39 @@ interface Routes {
16721
16840
  created_at: string;
16722
16841
  is_managed: false;
16723
16842
  properties: {
16843
+ /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
16724
16844
  name: string;
16845
+ /** Indicates whether the device is online. */
16725
16846
  online: boolean;
16847
+ /** Manufacturer of the device. */
16726
16848
  manufacturer?: string | undefined;
16849
+ /** Image URL for the device. */
16727
16850
  image_url?: string | undefined;
16851
+ /** Alt text for the device image. */
16728
16852
  image_alt_text?: string | undefined;
16729
- model: {
16730
- display_name: string;
16731
- manufacturer_display_name: string;
16732
- };
16733
16853
  /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
16734
16854
  battery_level?: number | undefined;
16855
+ /** 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. */
16856
+ battery?: {
16857
+ level: number;
16858
+ status: 'critical' | 'low' | 'good' | 'full';
16859
+ } | undefined;
16735
16860
  /** Indicates whether it is currently possible to use online access codes for the device. */
16736
16861
  online_access_codes_enabled?: boolean | undefined;
16862
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
16863
+ offline_access_codes_enabled?: boolean | undefined;
16864
+ model: {
16865
+ /** Display name of the device model. */
16866
+ display_name: string;
16867
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
16868
+ manufacturer_display_name: string;
16869
+ /** Indicates whether the device supports offline access codes. */
16870
+ offline_access_codes_supported?: boolean | undefined;
16871
+ /** Indicates whether the device supports online access codes. */
16872
+ online_access_codes_supported?: boolean | undefined;
16873
+ /** Indicates whether the device supports an accessory keypad. */
16874
+ accessory_keypad_supported?: boolean | undefined;
16875
+ };
16737
16876
  };
16738
16877
  }>;
16739
16878
  };
@@ -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: {
@@ -13823,20 +13868,47 @@ declare const _default: {
13823
13868
  };
13824
13869
  };
13825
13870
  security: ({
13826
- access_token: never[];
13827
- seam_workspace: never[];
13828
- seam_client_session_token?: never;
13829
- client_session_token?: never;
13871
+ pat_with_workspace: never[];
13872
+ pat_without_workspace?: never;
13873
+ user_session?: never;
13874
+ user_session_without_workspace?: never;
13875
+ api_key?: never;
13876
+ client_session?: never;
13830
13877
  } | {
13831
- seam_client_session_token: never[];
13832
- access_token?: never;
13833
- seam_workspace?: never;
13834
- client_session_token?: never;
13878
+ pat_without_workspace: never[];
13879
+ pat_with_workspace?: never;
13880
+ user_session?: never;
13881
+ user_session_without_workspace?: never;
13882
+ api_key?: never;
13883
+ client_session?: never;
13835
13884
  } | {
13836
- client_session_token: never[];
13837
- access_token?: never;
13838
- seam_workspace?: never;
13839
- seam_client_session_token?: never;
13885
+ user_session: never[];
13886
+ pat_with_workspace?: never;
13887
+ pat_without_workspace?: never;
13888
+ user_session_without_workspace?: never;
13889
+ api_key?: never;
13890
+ client_session?: never;
13891
+ } | {
13892
+ user_session_without_workspace: never[];
13893
+ pat_with_workspace?: never;
13894
+ pat_without_workspace?: never;
13895
+ user_session?: never;
13896
+ api_key?: never;
13897
+ client_session?: never;
13898
+ } | {
13899
+ api_key: never[];
13900
+ pat_with_workspace?: never;
13901
+ pat_without_workspace?: never;
13902
+ user_session?: never;
13903
+ user_session_without_workspace?: never;
13904
+ client_session?: never;
13905
+ } | {
13906
+ client_session: never[];
13907
+ pat_with_workspace?: never;
13908
+ pat_without_workspace?: never;
13909
+ user_session?: never;
13910
+ user_session_without_workspace?: never;
13911
+ api_key?: never;
13840
13912
  })[];
13841
13913
  summary: string;
13842
13914
  tags: string[];
@@ -13875,20 +13947,47 @@ declare const _default: {
13875
13947
  };
13876
13948
  };
13877
13949
  security: ({
13878
- access_token: never[];
13879
- seam_workspace: never[];
13880
- seam_client_session_token?: never;
13881
- client_session_token?: never;
13950
+ pat_with_workspace: never[];
13951
+ pat_without_workspace?: never;
13952
+ user_session?: never;
13953
+ user_session_without_workspace?: never;
13954
+ api_key?: never;
13955
+ client_session?: never;
13882
13956
  } | {
13883
- seam_client_session_token: never[];
13884
- access_token?: never;
13885
- seam_workspace?: never;
13886
- client_session_token?: never;
13957
+ pat_without_workspace: never[];
13958
+ pat_with_workspace?: never;
13959
+ user_session?: never;
13960
+ user_session_without_workspace?: never;
13961
+ api_key?: never;
13962
+ client_session?: never;
13887
13963
  } | {
13888
- client_session_token: never[];
13889
- access_token?: never;
13890
- seam_workspace?: never;
13891
- seam_client_session_token?: never;
13964
+ user_session: never[];
13965
+ pat_with_workspace?: never;
13966
+ pat_without_workspace?: never;
13967
+ user_session_without_workspace?: never;
13968
+ api_key?: never;
13969
+ client_session?: never;
13970
+ } | {
13971
+ user_session_without_workspace: never[];
13972
+ pat_with_workspace?: never;
13973
+ pat_without_workspace?: never;
13974
+ user_session?: never;
13975
+ api_key?: never;
13976
+ client_session?: never;
13977
+ } | {
13978
+ api_key: never[];
13979
+ pat_with_workspace?: never;
13980
+ pat_without_workspace?: never;
13981
+ user_session?: never;
13982
+ user_session_without_workspace?: never;
13983
+ client_session?: never;
13984
+ } | {
13985
+ client_session: never[];
13986
+ pat_with_workspace?: never;
13987
+ pat_without_workspace?: never;
13988
+ user_session?: never;
13989
+ user_session_without_workspace?: never;
13990
+ api_key?: never;
13892
13991
  })[];
13893
13992
  summary: string;
13894
13993
  tags: string[];
@@ -1800,25 +1800,75 @@ export default {
1800
1800
  is_managed: { enum: [false], type: 'boolean' },
1801
1801
  properties: {
1802
1802
  properties: {
1803
+ battery: {
1804
+ description: '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.',
1805
+ properties: {
1806
+ level: { maximum: 1, minimum: 0, type: 'number' },
1807
+ status: {
1808
+ enum: ['critical', 'low', 'good', 'full'],
1809
+ type: 'string',
1810
+ },
1811
+ },
1812
+ required: ['level', 'status'],
1813
+ type: 'object',
1814
+ },
1803
1815
  battery_level: {
1804
1816
  description: 'Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.',
1805
1817
  maximum: 1,
1806
1818
  minimum: 0,
1807
1819
  type: 'number',
1808
1820
  },
1809
- image_alt_text: { type: 'string' },
1810
- image_url: { type: 'string' },
1811
- manufacturer: { type: 'string' },
1821
+ image_alt_text: {
1822
+ description: 'Alt text for the device image.',
1823
+ type: 'string',
1824
+ },
1825
+ image_url: {
1826
+ description: 'Image URL for the device.',
1827
+ format: 'uri',
1828
+ type: 'string',
1829
+ },
1830
+ manufacturer: {
1831
+ description: 'Manufacturer of the device.',
1832
+ type: 'string',
1833
+ },
1812
1834
  model: {
1813
1835
  properties: {
1814
- display_name: { type: 'string' },
1815
- manufacturer_display_name: { type: 'string' },
1836
+ accessory_keypad_supported: {
1837
+ description: 'Indicates whether the device supports an accessory keypad.',
1838
+ type: 'boolean',
1839
+ },
1840
+ display_name: {
1841
+ description: 'Display name of the device model.',
1842
+ type: 'string',
1843
+ },
1844
+ manufacturer_display_name: {
1845
+ description: 'Display name that corresponds to the manufacturer-specific terminology for the device.',
1846
+ type: 'string',
1847
+ },
1848
+ offline_access_codes_supported: {
1849
+ description: 'Indicates whether the device supports offline access codes.',
1850
+ type: 'boolean',
1851
+ },
1852
+ online_access_codes_supported: {
1853
+ description: 'Indicates whether the device supports online access codes.',
1854
+ type: 'boolean',
1855
+ },
1816
1856
  },
1817
1857
  required: ['display_name', 'manufacturer_display_name'],
1818
1858
  type: 'object',
1819
1859
  },
1820
- name: { type: 'string' },
1821
- online: { type: 'boolean' },
1860
+ name: {
1861
+ description: 'Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
1862
+ type: 'string',
1863
+ },
1864
+ offline_access_codes_enabled: {
1865
+ description: 'Indicates whether it is currently possible to use offline access codes for the device.',
1866
+ type: 'boolean',
1867
+ },
1868
+ online: {
1869
+ description: 'Indicates whether the device is online.',
1870
+ type: 'boolean',
1871
+ },
1822
1872
  online_access_codes_enabled: {
1823
1873
  description: 'Indicates whether it is currently possible to use online access codes for the device.',
1824
1874
  type: 'boolean',
@@ -1928,6 +1978,11 @@ export default {
1928
1978
  scheme: 'bearer',
1929
1979
  type: 'http',
1930
1980
  },
1981
+ user_session_without_workspace: {
1982
+ bearerFormat: 'User Session Token',
1983
+ scheme: 'bearer',
1984
+ type: 'http',
1985
+ },
1931
1986
  },
1932
1987
  },
1933
1988
  info: { title: 'Seam Connect', version: '1.0.0' },
@@ -10058,9 +10113,12 @@ export default {
10058
10113
  401: { description: 'Unauthorized' },
10059
10114
  },
10060
10115
  security: [
10061
- { access_token: [], seam_workspace: [] },
10062
- { seam_client_session_token: [] },
10063
- { client_session_token: [] },
10116
+ { pat_with_workspace: [] },
10117
+ { pat_without_workspace: [] },
10118
+ { user_session: [] },
10119
+ { user_session_without_workspace: [] },
10120
+ { api_key: [] },
10121
+ { client_session: [] },
10064
10122
  ],
10065
10123
  summary: '/workspaces/list',
10066
10124
  tags: ['/workspaces'],
@@ -10091,9 +10149,12 @@ export default {
10091
10149
  401: { description: 'Unauthorized' },
10092
10150
  },
10093
10151
  security: [
10094
- { access_token: [], seam_workspace: [] },
10095
- { seam_client_session_token: [] },
10096
- { client_session_token: [] },
10152
+ { pat_with_workspace: [] },
10153
+ { pat_without_workspace: [] },
10154
+ { user_session: [] },
10155
+ { user_session_without_workspace: [] },
10156
+ { api_key: [] },
10157
+ { client_session: [] },
10097
10158
  ],
10098
10159
  summary: '/workspaces/list',
10099
10160
  tags: ['/workspaces'],