@seamapi/types 1.60.1 → 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.
@@ -229,7 +229,7 @@ export default {
229
229
  },
230
230
  email_address: { format: 'email', type: 'string' },
231
231
  external_type: {
232
- enum: ['pti_user', 'brivo_user', 'hid_cm_user'],
232
+ enum: ['pti_user', 'brivo_user', 'hid_cm_user', 'salto_site_user'],
233
233
  type: 'string',
234
234
  },
235
235
  external_type_display_name: { type: 'string' },
@@ -451,6 +451,7 @@ export default {
451
451
  properties: {
452
452
  account_type: { type: 'string' },
453
453
  account_type_display_name: { type: 'string' },
454
+ automatically_manage_new_devices: { type: 'boolean' },
454
455
  connected_account_id: { format: 'uuid', type: 'string' },
455
456
  created_at: { format: 'date-time', type: 'string' },
456
457
  custom_metadata: {
@@ -478,7 +479,10 @@ export default {
478
479
  },
479
480
  warnings: { nullable: true },
480
481
  },
481
- required: ['account_type_display_name'],
482
+ required: [
483
+ 'account_type_display_name',
484
+ 'automatically_manage_new_devices',
485
+ ],
482
486
  type: 'object',
483
487
  },
484
488
  device: {
@@ -1796,25 +1800,75 @@ export default {
1796
1800
  is_managed: { enum: [false], type: 'boolean' },
1797
1801
  properties: {
1798
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
+ },
1799
1815
  battery_level: {
1800
1816
  description: 'Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.',
1801
1817
  maximum: 1,
1802
1818
  minimum: 0,
1803
1819
  type: 'number',
1804
1820
  },
1805
- image_alt_text: { type: 'string' },
1806
- image_url: { type: 'string' },
1807
- 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
+ },
1808
1834
  model: {
1809
1835
  properties: {
1810
- display_name: { type: 'string' },
1811
- 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
+ },
1812
1856
  },
1813
1857
  required: ['display_name', 'manufacturer_display_name'],
1814
1858
  type: 'object',
1815
1859
  },
1816
- name: { type: 'string' },
1817
- 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
+ },
1818
1872
  online_access_codes_enabled: {
1819
1873
  description: 'Indicates whether it is currently possible to use online access codes for the device.',
1820
1874
  type: 'boolean',
@@ -1924,6 +1978,11 @@ export default {
1924
1978
  scheme: 'bearer',
1925
1979
  type: 'http',
1926
1980
  },
1981
+ user_session_without_workspace: {
1982
+ bearerFormat: 'User Session Token',
1983
+ scheme: 'bearer',
1984
+ type: 'http',
1985
+ },
1927
1986
  },
1928
1987
  },
1929
1988
  info: { title: 'Seam Connect', version: '1.0.0' },
@@ -2516,9 +2575,10 @@ export default {
2516
2575
  401: { description: 'Unauthorized' },
2517
2576
  },
2518
2577
  security: [
2519
- { access_token: [], seam_workspace: [] },
2520
- { seam_client_session_token: [] },
2521
- { client_session_token: [] },
2578
+ { client_session: [] },
2579
+ { pat_with_workspace: [] },
2580
+ { console_session: [] },
2581
+ { api_key: [] },
2522
2582
  ],
2523
2583
  summary: '/access_codes/unmanaged/convert_to_managed',
2524
2584
  tags: ['/access_codes'],
@@ -2560,9 +2620,10 @@ export default {
2560
2620
  401: { description: 'Unauthorized' },
2561
2621
  },
2562
2622
  security: [
2563
- { access_token: [], seam_workspace: [] },
2564
- { seam_client_session_token: [] },
2565
- { client_session_token: [] },
2623
+ { client_session: [] },
2624
+ { pat_with_workspace: [] },
2625
+ { console_session: [] },
2626
+ { api_key: [] },
2566
2627
  ],
2567
2628
  summary: '/access_codes/unmanaged/convert_to_managed',
2568
2629
  tags: ['/access_codes'],
@@ -2609,9 +2670,10 @@ export default {
2609
2670
  401: { description: 'Unauthorized' },
2610
2671
  },
2611
2672
  security: [
2612
- { access_token: [], seam_workspace: [] },
2613
- { seam_client_session_token: [] },
2614
- { client_session_token: [] },
2673
+ { client_session: [] },
2674
+ { pat_with_workspace: [] },
2675
+ { console_session: [] },
2676
+ { api_key: [] },
2615
2677
  ],
2616
2678
  summary: '/access_codes/unmanaged/delete',
2617
2679
  tags: ['/access_codes'],
@@ -2659,9 +2721,10 @@ export default {
2659
2721
  401: { description: 'Unauthorized' },
2660
2722
  },
2661
2723
  security: [
2662
- { access_token: [], seam_workspace: [] },
2663
- { seam_client_session_token: [] },
2664
- { client_session_token: [] },
2724
+ { client_session: [] },
2725
+ { pat_with_workspace: [] },
2726
+ { console_session: [] },
2727
+ { api_key: [] },
2665
2728
  ],
2666
2729
  summary: '/access_codes/unmanaged/get',
2667
2730
  tags: ['/access_codes'],
@@ -2712,9 +2775,10 @@ export default {
2712
2775
  401: { description: 'Unauthorized' },
2713
2776
  },
2714
2777
  security: [
2715
- { access_token: [], seam_workspace: [] },
2716
- { seam_client_session_token: [] },
2717
- { client_session_token: [] },
2778
+ { client_session: [] },
2779
+ { pat_with_workspace: [] },
2780
+ { console_session: [] },
2781
+ { api_key: [] },
2718
2782
  ],
2719
2783
  summary: '/access_codes/unmanaged/list',
2720
2784
  tags: ['/access_codes'],
@@ -2760,9 +2824,10 @@ export default {
2760
2824
  401: { description: 'Unauthorized' },
2761
2825
  },
2762
2826
  security: [
2763
- { access_token: [], seam_workspace: [] },
2764
- { seam_client_session_token: [] },
2765
- { client_session_token: [] },
2827
+ { client_session: [] },
2828
+ { pat_with_workspace: [] },
2829
+ { console_session: [] },
2830
+ { api_key: [] },
2766
2831
  ],
2767
2832
  summary: '/access_codes/unmanaged/update',
2768
2833
  tags: ['/access_codes'],
@@ -2804,9 +2869,10 @@ export default {
2804
2869
  401: { description: 'Unauthorized' },
2805
2870
  },
2806
2871
  security: [
2807
- { access_token: [], seam_workspace: [] },
2808
- { seam_client_session_token: [] },
2809
- { client_session_token: [] },
2872
+ { client_session: [] },
2873
+ { pat_with_workspace: [] },
2874
+ { console_session: [] },
2875
+ { api_key: [] },
2810
2876
  ],
2811
2877
  summary: '/access_codes/unmanaged/update',
2812
2878
  tags: ['/access_codes'],
@@ -3074,9 +3140,10 @@ export default {
3074
3140
  401: { description: 'Unauthorized' },
3075
3141
  },
3076
3142
  security: [
3077
- { access_token: [], seam_workspace: [] },
3078
- { seam_client_session_token: [] },
3079
- { client_session_token: [] },
3143
+ { client_session: [] },
3144
+ { pat_with_workspace: [] },
3145
+ { console_session: [] },
3146
+ { api_key: [] },
3080
3147
  ],
3081
3148
  summary: '/acs/access_groups/add_user',
3082
3149
  tags: [],
@@ -3116,9 +3183,10 @@ export default {
3116
3183
  401: { description: 'Unauthorized' },
3117
3184
  },
3118
3185
  security: [
3119
- { access_token: [], seam_workspace: [] },
3120
- { seam_client_session_token: [] },
3121
- { client_session_token: [] },
3186
+ { client_session: [] },
3187
+ { pat_with_workspace: [] },
3188
+ { console_session: [] },
3189
+ { api_key: [] },
3122
3190
  ],
3123
3191
  summary: '/acs/access_groups/add_user',
3124
3192
  tags: [],
@@ -3163,9 +3231,10 @@ export default {
3163
3231
  401: { description: 'Unauthorized' },
3164
3232
  },
3165
3233
  security: [
3166
- { access_token: [], seam_workspace: [] },
3167
- { seam_client_session_token: [] },
3168
- { client_session_token: [] },
3234
+ { client_session: [] },
3235
+ { pat_with_workspace: [] },
3236
+ { console_session: [] },
3237
+ { api_key: [] },
3169
3238
  ],
3170
3239
  summary: '/acs/access_groups/get',
3171
3240
  tags: [],
@@ -3261,9 +3330,10 @@ export default {
3261
3330
  401: { description: 'Unauthorized' },
3262
3331
  },
3263
3332
  security: [
3264
- { access_token: [], seam_workspace: [] },
3265
- { seam_client_session_token: [] },
3266
- { client_session_token: [] },
3333
+ { client_session: [] },
3334
+ { pat_with_workspace: [] },
3335
+ { console_session: [] },
3336
+ { api_key: [] },
3267
3337
  ],
3268
3338
  summary: '/acs/access_groups/list_users',
3269
3339
  tags: [],
@@ -6077,6 +6147,56 @@ export default {
6077
6147
  'x-fern-sdk-return-value': 'connected_accounts',
6078
6148
  },
6079
6149
  },
6150
+ '/connected_accounts/update': {
6151
+ post: {
6152
+ operationId: 'connectedAccountsUpdatePost',
6153
+ requestBody: {
6154
+ content: {
6155
+ 'application/json': {
6156
+ schema: {
6157
+ properties: {
6158
+ automatically_manage_new_devices: { type: 'boolean' },
6159
+ connected_account_id: { format: 'uuid', type: 'string' },
6160
+ },
6161
+ required: ['connected_account_id'],
6162
+ type: 'object',
6163
+ },
6164
+ },
6165
+ },
6166
+ },
6167
+ responses: {
6168
+ 200: {
6169
+ content: {
6170
+ 'application/json': {
6171
+ schema: {
6172
+ properties: {
6173
+ connected_account: {
6174
+ $ref: '#/components/schemas/connected_account',
6175
+ },
6176
+ ok: { type: 'boolean' },
6177
+ },
6178
+ required: ['connected_account', 'ok'],
6179
+ type: 'object',
6180
+ },
6181
+ },
6182
+ },
6183
+ description: 'OK',
6184
+ },
6185
+ 400: { description: 'Bad Request' },
6186
+ 401: { description: 'Unauthorized' },
6187
+ },
6188
+ security: [
6189
+ { pat_with_workspace: [] },
6190
+ { console_session: [] },
6191
+ { api_key: [] },
6192
+ ],
6193
+ summary: '/connected_accounts/update',
6194
+ tags: ['/connected_accounts'],
6195
+ 'x-fern-sdk-group-name': ['connected_accounts'],
6196
+ 'x-fern-sdk-method-name': 'update',
6197
+ 'x-fern-sdk-return-value': 'connected_account',
6198
+ },
6199
+ },
6080
6200
  '/devices/delete': {
6081
6201
  post: {
6082
6202
  operationId: 'devicesDeletePost',
@@ -9993,9 +10113,12 @@ export default {
9993
10113
  401: { description: 'Unauthorized' },
9994
10114
  },
9995
10115
  security: [
9996
- { access_token: [], seam_workspace: [] },
9997
- { seam_client_session_token: [] },
9998
- { 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: [] },
9999
10122
  ],
10000
10123
  summary: '/workspaces/list',
10001
10124
  tags: ['/workspaces'],
@@ -10026,9 +10149,12 @@ export default {
10026
10149
  401: { description: 'Unauthorized' },
10027
10150
  },
10028
10151
  security: [
10029
- { access_token: [], seam_workspace: [] },
10030
- { seam_client_session_token: [] },
10031
- { 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: [] },
10032
10158
  ],
10033
10159
  summary: '/workspaces/list',
10034
10160
  tags: ['/workspaces'],