@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.
@@ -961,6 +961,18 @@ export interface Routes {
961
961
  };
962
962
  };
963
963
  };
964
+ '/acs/entrances/grant_access': {
965
+ route: '/acs/entrances/grant_access';
966
+ method: 'POST';
967
+ queryParams: {};
968
+ jsonBody: {
969
+ acs_entrance_id: string;
970
+ acs_user_id: string;
971
+ };
972
+ commonParams: {};
973
+ formData: {};
974
+ jsonResponse: {};
975
+ };
964
976
  '/acs/entrances/list': {
965
977
  route: '/acs/entrances/list';
966
978
  method: 'GET' | 'POST';
@@ -2620,19 +2632,39 @@ export interface Routes {
2620
2632
  created_at: string;
2621
2633
  is_managed: false;
2622
2634
  properties: {
2635
+ /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
2623
2636
  name: string;
2637
+ /** Indicates whether the device is online. */
2624
2638
  online: boolean;
2639
+ /** Manufacturer of the device. */
2625
2640
  manufacturer?: string | undefined;
2641
+ /** Image URL for the device. */
2626
2642
  image_url?: string | undefined;
2643
+ /** Alt text for the device image. */
2627
2644
  image_alt_text?: string | undefined;
2628
- model: {
2629
- display_name: string;
2630
- manufacturer_display_name: string;
2631
- };
2632
2645
  /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
2633
2646
  battery_level?: number | undefined;
2647
+ /** 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. */
2648
+ battery?: {
2649
+ level: number;
2650
+ status: 'critical' | 'low' | 'good' | 'full';
2651
+ } | undefined;
2634
2652
  /** Indicates whether it is currently possible to use online access codes for the device. */
2635
2653
  online_access_codes_enabled?: boolean | undefined;
2654
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
2655
+ offline_access_codes_enabled?: boolean | undefined;
2656
+ model: {
2657
+ /** Display name of the device model. */
2658
+ display_name: string;
2659
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
2660
+ manufacturer_display_name: string;
2661
+ /** Indicates whether the device supports offline access codes. */
2662
+ offline_access_codes_supported?: boolean | undefined;
2663
+ /** Indicates whether the device supports online access codes. */
2664
+ online_access_codes_supported?: boolean | undefined;
2665
+ /** Indicates whether the device supports an accessory keypad. */
2666
+ accessory_keypad_supported?: boolean | undefined;
2667
+ };
2636
2668
  };
2637
2669
  };
2638
2670
  };
@@ -2682,19 +2714,39 @@ export interface Routes {
2682
2714
  created_at: string;
2683
2715
  is_managed: false;
2684
2716
  properties: {
2717
+ /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
2685
2718
  name: string;
2719
+ /** Indicates whether the device is online. */
2686
2720
  online: boolean;
2721
+ /** Manufacturer of the device. */
2687
2722
  manufacturer?: string | undefined;
2723
+ /** Image URL for the device. */
2688
2724
  image_url?: string | undefined;
2725
+ /** Alt text for the device image. */
2689
2726
  image_alt_text?: string | undefined;
2690
- model: {
2691
- display_name: string;
2692
- manufacturer_display_name: string;
2693
- };
2694
2727
  /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
2695
2728
  battery_level?: number | undefined;
2729
+ /** 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. */
2730
+ battery?: {
2731
+ level: number;
2732
+ status: 'critical' | 'low' | 'good' | 'full';
2733
+ } | undefined;
2696
2734
  /** Indicates whether it is currently possible to use online access codes for the device. */
2697
2735
  online_access_codes_enabled?: boolean | undefined;
2736
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
2737
+ offline_access_codes_enabled?: boolean | undefined;
2738
+ model: {
2739
+ /** Display name of the device model. */
2740
+ display_name: string;
2741
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
2742
+ manufacturer_display_name: string;
2743
+ /** Indicates whether the device supports offline access codes. */
2744
+ offline_access_codes_supported?: boolean | undefined;
2745
+ /** Indicates whether the device supports online access codes. */
2746
+ online_access_codes_supported?: boolean | undefined;
2747
+ /** Indicates whether the device supports an accessory keypad. */
2748
+ accessory_keypad_supported?: boolean | undefined;
2749
+ };
2698
2750
  };
2699
2751
  }>;
2700
2752
  };
@@ -27,48 +27,88 @@ export declare const unmanaged_device: z.ZodObject<{
27
27
  warning_code: string;
28
28
  }>, "many">;
29
29
  is_managed: z.ZodLiteral<false>;
30
- properties: z.ZodObject<{
31
- name: z.ZodString;
30
+ properties: z.ZodObject<Pick<{
32
31
  online: z.ZodBoolean;
33
- manufacturer: z.ZodOptional<z.ZodString>;
34
- image_url: z.ZodOptional<z.ZodString>;
35
- image_alt_text: z.ZodOptional<z.ZodString>;
32
+ name: z.ZodString;
36
33
  model: z.ZodObject<{
37
34
  display_name: z.ZodString;
38
35
  manufacturer_display_name: z.ZodString;
36
+ offline_access_codes_supported: z.ZodOptional<z.ZodBoolean>;
37
+ online_access_codes_supported: z.ZodOptional<z.ZodBoolean>;
38
+ accessory_keypad_supported: z.ZodOptional<z.ZodBoolean>;
39
39
  }, "strip", z.ZodTypeAny, {
40
40
  display_name: string;
41
41
  manufacturer_display_name: string;
42
+ offline_access_codes_supported?: boolean | undefined;
43
+ online_access_codes_supported?: boolean | undefined;
44
+ accessory_keypad_supported?: boolean | undefined;
42
45
  }, {
43
46
  display_name: string;
44
47
  manufacturer_display_name: string;
48
+ offline_access_codes_supported?: boolean | undefined;
49
+ online_access_codes_supported?: boolean | undefined;
50
+ accessory_keypad_supported?: boolean | undefined;
45
51
  }>;
52
+ has_direct_power: z.ZodOptional<z.ZodBoolean>;
46
53
  battery_level: z.ZodOptional<z.ZodNumber>;
54
+ battery: z.ZodOptional<z.ZodObject<{
55
+ level: z.ZodNumber;
56
+ status: z.ZodEnum<["critical", "low", "good", "full"]>;
57
+ }, "strip", z.ZodTypeAny, {
58
+ status: "low" | "full" | "critical" | "good";
59
+ level: number;
60
+ }, {
61
+ status: "low" | "full" | "critical" | "good";
62
+ level: number;
63
+ }>>;
64
+ manufacturer: z.ZodOptional<z.ZodString>;
65
+ image_url: z.ZodOptional<z.ZodString>;
66
+ image_alt_text: z.ZodOptional<z.ZodString>;
67
+ serial_number: z.ZodOptional<z.ZodString>;
47
68
  online_access_codes_enabled: z.ZodOptional<z.ZodBoolean>;
48
- }, "strip", z.ZodTypeAny, {
69
+ offline_access_codes_enabled: z.ZodOptional<z.ZodBoolean>;
70
+ supports_accessory_keypad: z.ZodOptional<z.ZodBoolean>;
71
+ supports_offline_access_codes: z.ZodOptional<z.ZodBoolean>;
72
+ }, "name" | "online" | "battery" | "model" | "battery_level" | "image_url" | "manufacturer" | "image_alt_text" | "online_access_codes_enabled" | "offline_access_codes_enabled">, "strip", z.ZodTypeAny, {
49
73
  name: string;
50
74
  online: boolean;
51
75
  model: {
52
76
  display_name: string;
53
77
  manufacturer_display_name: string;
78
+ offline_access_codes_supported?: boolean | undefined;
79
+ online_access_codes_supported?: boolean | undefined;
80
+ accessory_keypad_supported?: boolean | undefined;
54
81
  };
55
- manufacturer?: string | undefined;
82
+ battery?: {
83
+ status: "low" | "full" | "critical" | "good";
84
+ level: number;
85
+ } | undefined;
86
+ battery_level?: number | undefined;
56
87
  image_url?: string | undefined;
88
+ manufacturer?: string | undefined;
57
89
  image_alt_text?: string | undefined;
58
- battery_level?: number | undefined;
59
90
  online_access_codes_enabled?: boolean | undefined;
91
+ offline_access_codes_enabled?: boolean | undefined;
60
92
  }, {
61
93
  name: string;
62
94
  online: boolean;
63
95
  model: {
64
96
  display_name: string;
65
97
  manufacturer_display_name: string;
98
+ offline_access_codes_supported?: boolean | undefined;
99
+ online_access_codes_supported?: boolean | undefined;
100
+ accessory_keypad_supported?: boolean | undefined;
66
101
  };
67
- manufacturer?: string | undefined;
102
+ battery?: {
103
+ status: "low" | "full" | "critical" | "good";
104
+ level: number;
105
+ } | undefined;
106
+ battery_level?: number | undefined;
68
107
  image_url?: string | undefined;
108
+ manufacturer?: string | undefined;
69
109
  image_alt_text?: string | undefined;
70
- battery_level?: number | undefined;
71
110
  online_access_codes_enabled?: boolean | undefined;
111
+ offline_access_codes_enabled?: boolean | undefined;
72
112
  }>;
73
113
  }, "strip", z.ZodTypeAny, {
74
114
  connected_account_id: string;
@@ -82,12 +122,20 @@ export declare const unmanaged_device: z.ZodObject<{
82
122
  model: {
83
123
  display_name: string;
84
124
  manufacturer_display_name: string;
125
+ offline_access_codes_supported?: boolean | undefined;
126
+ online_access_codes_supported?: boolean | undefined;
127
+ accessory_keypad_supported?: boolean | undefined;
85
128
  };
86
- manufacturer?: string | undefined;
129
+ battery?: {
130
+ status: "low" | "full" | "critical" | "good";
131
+ level: number;
132
+ } | undefined;
133
+ battery_level?: number | undefined;
87
134
  image_url?: string | undefined;
135
+ manufacturer?: string | undefined;
88
136
  image_alt_text?: string | undefined;
89
- battery_level?: number | undefined;
90
137
  online_access_codes_enabled?: boolean | undefined;
138
+ offline_access_codes_enabled?: boolean | undefined;
91
139
  };
92
140
  device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
93
141
  capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
@@ -111,12 +159,20 @@ export declare const unmanaged_device: z.ZodObject<{
111
159
  model: {
112
160
  display_name: string;
113
161
  manufacturer_display_name: string;
162
+ offline_access_codes_supported?: boolean | undefined;
163
+ online_access_codes_supported?: boolean | undefined;
164
+ accessory_keypad_supported?: boolean | undefined;
114
165
  };
115
- manufacturer?: string | undefined;
166
+ battery?: {
167
+ status: "low" | "full" | "critical" | "good";
168
+ level: number;
169
+ } | undefined;
170
+ battery_level?: number | undefined;
116
171
  image_url?: string | undefined;
172
+ manufacturer?: string | undefined;
117
173
  image_alt_text?: string | undefined;
118
- battery_level?: number | undefined;
119
174
  online_access_codes_enabled?: boolean | undefined;
175
+ offline_access_codes_enabled?: boolean | undefined;
120
176
  };
121
177
  device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
122
178
  capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
@@ -1,5 +1,5 @@
1
1
  import { z } from 'zod';
2
- import { managed_device } from './managed-device.js';
2
+ import { common_device_properties, managed_device } from './managed-device.js';
3
3
  export const unmanaged_device = managed_device
4
4
  .pick({
5
5
  device_id: true,
@@ -13,27 +13,17 @@ export const unmanaged_device = managed_device
13
13
  })
14
14
  .extend({
15
15
  is_managed: z.literal(false),
16
- // todo: should pick from the managed_device schema instead of re-defining
17
- properties: z.object({
18
- name: z.string(),
19
- online: z.boolean(),
20
- manufacturer: z.string().optional(),
21
- image_url: z.string().optional(),
22
- image_alt_text: z.string().optional(),
23
- model: z.object({
24
- display_name: z.string(),
25
- manufacturer_display_name: z.string(),
26
- }),
27
- battery_level: z
28
- .number()
29
- .min(0)
30
- .max(1)
31
- .optional()
32
- .describe('Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.'),
33
- online_access_codes_enabled: z
34
- .boolean()
35
- .describe('Indicates whether it is currently possible to use online access codes for the device.')
36
- .optional(),
16
+ properties: common_device_properties.pick({
17
+ name: true,
18
+ online: true,
19
+ manufacturer: true,
20
+ image_url: true,
21
+ image_alt_text: true,
22
+ battery_level: true,
23
+ battery: true,
24
+ online_access_codes_enabled: true,
25
+ offline_access_codes_enabled: true,
26
+ model: true,
37
27
  }),
38
28
  });
39
29
  //# sourceMappingURL=unmanaged-device.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"unmanaged-device.js","sourceRoot":"","sources":["../../../../../../src/lib/seam/connect/unstable/models/devices/unmanaged-device.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEpD,MAAM,CAAC,MAAM,gBAAgB,GAAG,cAAc;KAC3C,IAAI,CAAC;IACJ,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,oBAAoB,EAAE,IAAI;IAC1B,sBAAsB,EAAE,IAAI;IAC5B,YAAY,EAAE,IAAI;IAClB,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,IAAI;IACd,UAAU,EAAE,IAAI;CACjB,CAAC;KACD,MAAM,CAAC;IACN,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5B,0EAA0E;IAC1E,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;QACnB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACnC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACrC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;YACd,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;YACxB,yBAAyB,EAAE,CAAC,CAAC,MAAM,EAAE;SACtC,CAAC;QACF,aAAa,EAAE,CAAC;aACb,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,EAAE;aACV,QAAQ,CACP,0FAA0F,CAC3F;QACH,2BAA2B,EAAE,CAAC;aAC3B,OAAO,EAAE;aACT,QAAQ,CACP,uFAAuF,CACxF;aACA,QAAQ,EAAE;KACd,CAAC;CACH,CAAC,CAAA"}
1
+ {"version":3,"file":"unmanaged-device.js","sourceRoot":"","sources":["../../../../../../src/lib/seam/connect/unstable/models/devices/unmanaged-device.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,wBAAwB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAE9E,MAAM,CAAC,MAAM,gBAAgB,GAAG,cAAc;KAC3C,IAAI,CAAC;IACJ,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,oBAAoB,EAAE,IAAI;IAC1B,sBAAsB,EAAE,IAAI;IAC5B,YAAY,EAAE,IAAI;IAClB,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,IAAI;IACd,UAAU,EAAE,IAAI;CACjB,CAAC;KACD,MAAM,CAAC;IACN,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5B,UAAU,EAAE,wBAAwB,CAAC,IAAI,CAAC;QACxC,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,IAAI;QACZ,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,cAAc,EAAE,IAAI;QACpB,aAAa,EAAE,IAAI;QACnB,OAAO,EAAE,IAAI;QACb,2BAA2B,EAAE,IAAI;QACjC,4BAA4B,EAAE,IAAI;QAClC,KAAK,EAAE,IAAI;KACZ,CAAC;CACH,CAAC,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.61.0",
3
+ "version": "1.63.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -1851,6 +1851,19 @@ export default {
1851
1851
  is_managed: { enum: [false], type: 'boolean' },
1852
1852
  properties: {
1853
1853
  properties: {
1854
+ battery: {
1855
+ description:
1856
+ '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.',
1857
+ properties: {
1858
+ level: { maximum: 1, minimum: 0, type: 'number' },
1859
+ status: {
1860
+ enum: ['critical', 'low', 'good', 'full'],
1861
+ type: 'string',
1862
+ },
1863
+ },
1864
+ required: ['level', 'status'],
1865
+ type: 'object',
1866
+ },
1854
1867
  battery_level: {
1855
1868
  description:
1856
1869
  'Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.',
@@ -1858,19 +1871,63 @@ export default {
1858
1871
  minimum: 0,
1859
1872
  type: 'number',
1860
1873
  },
1861
- image_alt_text: { type: 'string' },
1862
- image_url: { type: 'string' },
1863
- manufacturer: { type: 'string' },
1874
+ image_alt_text: {
1875
+ description: 'Alt text for the device image.',
1876
+ type: 'string',
1877
+ },
1878
+ image_url: {
1879
+ description: 'Image URL for the device.',
1880
+ format: 'uri',
1881
+ type: 'string',
1882
+ },
1883
+ manufacturer: {
1884
+ description: 'Manufacturer of the device.',
1885
+ type: 'string',
1886
+ },
1864
1887
  model: {
1865
1888
  properties: {
1866
- display_name: { type: 'string' },
1867
- manufacturer_display_name: { type: 'string' },
1889
+ accessory_keypad_supported: {
1890
+ description:
1891
+ 'Indicates whether the device supports an accessory keypad.',
1892
+ type: 'boolean',
1893
+ },
1894
+ display_name: {
1895
+ description: 'Display name of the device model.',
1896
+ type: 'string',
1897
+ },
1898
+ manufacturer_display_name: {
1899
+ description:
1900
+ 'Display name that corresponds to the manufacturer-specific terminology for the device.',
1901
+ type: 'string',
1902
+ },
1903
+ offline_access_codes_supported: {
1904
+ description:
1905
+ 'Indicates whether the device supports offline access codes.',
1906
+ type: 'boolean',
1907
+ },
1908
+ online_access_codes_supported: {
1909
+ description:
1910
+ 'Indicates whether the device supports online access codes.',
1911
+ type: 'boolean',
1912
+ },
1868
1913
  },
1869
1914
  required: ['display_name', 'manufacturer_display_name'],
1870
1915
  type: 'object',
1871
1916
  },
1872
- name: { type: 'string' },
1873
- online: { type: 'boolean' },
1917
+ name: {
1918
+ description:
1919
+ 'Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
1920
+ type: 'string',
1921
+ },
1922
+ offline_access_codes_enabled: {
1923
+ description:
1924
+ 'Indicates whether it is currently possible to use offline access codes for the device.',
1925
+ type: 'boolean',
1926
+ },
1927
+ online: {
1928
+ description: 'Indicates whether the device is online.',
1929
+ type: 'boolean',
1930
+ },
1874
1931
  online_access_codes_enabled: {
1875
1932
  description:
1876
1933
  'Indicates whether it is currently possible to use online access codes for the device.',
@@ -1983,6 +2040,11 @@ export default {
1983
2040
  scheme: 'bearer',
1984
2041
  type: 'http',
1985
2042
  },
2043
+ user_session_without_workspace: {
2044
+ bearerFormat: 'User Session Token',
2045
+ scheme: 'bearer',
2046
+ type: 'http',
2047
+ },
1986
2048
  },
1987
2049
  },
1988
2050
  info: { title: 'Seam Connect', version: '1.0.0' },
@@ -4426,6 +4488,51 @@ export default {
4426
4488
  'x-fern-sdk-method-name': 'get',
4427
4489
  },
4428
4490
  },
4491
+ '/acs/entrances/grant_access': {
4492
+ post: {
4493
+ operationId: 'acsEntrancesGrantAccessPost',
4494
+ requestBody: {
4495
+ content: {
4496
+ 'application/json': {
4497
+ schema: {
4498
+ properties: {
4499
+ acs_entrance_id: { format: 'uuid', type: 'string' },
4500
+ acs_user_id: { format: 'uuid', type: 'string' },
4501
+ },
4502
+ required: ['acs_entrance_id', 'acs_user_id'],
4503
+ type: 'object',
4504
+ },
4505
+ },
4506
+ },
4507
+ },
4508
+ responses: {
4509
+ 200: {
4510
+ content: {
4511
+ 'application/json': {
4512
+ schema: {
4513
+ properties: { ok: { type: 'boolean' } },
4514
+ required: ['ok'],
4515
+ type: 'object',
4516
+ },
4517
+ },
4518
+ },
4519
+ description: 'OK',
4520
+ },
4521
+ 400: { description: 'Bad Request' },
4522
+ 401: { description: 'Unauthorized' },
4523
+ },
4524
+ security: [
4525
+ { api_key: [] },
4526
+ { client_session: [] },
4527
+ { pat_with_workspace: [] },
4528
+ { console_session: [] },
4529
+ ],
4530
+ summary: '/acs/entrances/grant_access',
4531
+ tags: [],
4532
+ 'x-fern-sdk-group-name': ['acs', 'entrances'],
4533
+ 'x-fern-sdk-method-name': 'grant_access',
4534
+ },
4535
+ },
4429
4536
  '/acs/entrances/list': {
4430
4537
  post: {
4431
4538
  operationId: 'acsEntrancesListPost',
@@ -10117,9 +10224,12 @@ export default {
10117
10224
  401: { description: 'Unauthorized' },
10118
10225
  },
10119
10226
  security: [
10120
- { access_token: [], seam_workspace: [] },
10121
- { seam_client_session_token: [] },
10122
- { client_session_token: [] },
10227
+ { pat_with_workspace: [] },
10228
+ { pat_without_workspace: [] },
10229
+ { user_session: [] },
10230
+ { user_session_without_workspace: [] },
10231
+ { api_key: [] },
10232
+ { client_session: [] },
10123
10233
  ],
10124
10234
  summary: '/workspaces/list',
10125
10235
  tags: ['/workspaces'],
@@ -10150,9 +10260,12 @@ export default {
10150
10260
  401: { description: 'Unauthorized' },
10151
10261
  },
10152
10262
  security: [
10153
- { access_token: [], seam_workspace: [] },
10154
- { seam_client_session_token: [] },
10155
- { client_session_token: [] },
10263
+ { pat_with_workspace: [] },
10264
+ { pat_without_workspace: [] },
10265
+ { user_session: [] },
10266
+ { user_session_without_workspace: [] },
10267
+ { api_key: [] },
10268
+ { client_session: [] },
10156
10269
  ],
10157
10270
  summary: '/workspaces/list',
10158
10271
  tags: ['/workspaces'],
@@ -996,6 +996,18 @@ export interface Routes {
996
996
  }
997
997
  }
998
998
  }
999
+ '/acs/entrances/grant_access': {
1000
+ route: '/acs/entrances/grant_access'
1001
+ method: 'POST'
1002
+ queryParams: {}
1003
+ jsonBody: {
1004
+ acs_entrance_id: string
1005
+ acs_user_id: string
1006
+ }
1007
+ commonParams: {}
1008
+ formData: {}
1009
+ jsonResponse: {}
1010
+ }
999
1011
  '/acs/entrances/list': {
1000
1012
  route: '/acs/entrances/list'
1001
1013
  method: 'GET' | 'POST'
@@ -3270,19 +3282,41 @@ export interface Routes {
3270
3282
  created_at: string
3271
3283
  is_managed: false
3272
3284
  properties: {
3285
+ /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
3273
3286
  name: string
3287
+ /** Indicates whether the device is online. */
3274
3288
  online: boolean
3289
+ /** Manufacturer of the device. */
3275
3290
  manufacturer?: string | undefined
3291
+ /** Image URL for the device. */
3276
3292
  image_url?: string | undefined
3293
+ /** Alt text for the device image. */
3277
3294
  image_alt_text?: string | undefined
3278
- model: {
3279
- display_name: string
3280
- manufacturer_display_name: string
3281
- }
3282
3295
  /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
3283
3296
  battery_level?: number | undefined
3297
+ /** 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. */
3298
+ battery?:
3299
+ | {
3300
+ level: number
3301
+ status: 'critical' | 'low' | 'good' | 'full'
3302
+ }
3303
+ | undefined
3284
3304
  /** Indicates whether it is currently possible to use online access codes for the device. */
3285
3305
  online_access_codes_enabled?: boolean | undefined
3306
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
3307
+ offline_access_codes_enabled?: boolean | undefined
3308
+ model: {
3309
+ /** Display name of the device model. */
3310
+ display_name: string
3311
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
3312
+ manufacturer_display_name: string
3313
+ /** Indicates whether the device supports offline access codes. */
3314
+ offline_access_codes_supported?: boolean | undefined
3315
+ /** Indicates whether the device supports online access codes. */
3316
+ online_access_codes_supported?: boolean | undefined
3317
+ /** Indicates whether the device supports an accessory keypad. */
3318
+ accessory_keypad_supported?: boolean | undefined
3319
+ }
3286
3320
  }
3287
3321
  }
3288
3322
  }
@@ -3462,19 +3496,41 @@ export interface Routes {
3462
3496
  created_at: string
3463
3497
  is_managed: false
3464
3498
  properties: {
3499
+ /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
3465
3500
  name: string
3501
+ /** Indicates whether the device is online. */
3466
3502
  online: boolean
3503
+ /** Manufacturer of the device. */
3467
3504
  manufacturer?: string | undefined
3505
+ /** Image URL for the device. */
3468
3506
  image_url?: string | undefined
3507
+ /** Alt text for the device image. */
3469
3508
  image_alt_text?: string | undefined
3470
- model: {
3471
- display_name: string
3472
- manufacturer_display_name: string
3473
- }
3474
3509
  /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
3475
3510
  battery_level?: number | undefined
3511
+ /** 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. */
3512
+ battery?:
3513
+ | {
3514
+ level: number
3515
+ status: 'critical' | 'low' | 'good' | 'full'
3516
+ }
3517
+ | undefined
3476
3518
  /** Indicates whether it is currently possible to use online access codes for the device. */
3477
3519
  online_access_codes_enabled?: boolean | undefined
3520
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
3521
+ offline_access_codes_enabled?: boolean | undefined
3522
+ model: {
3523
+ /** Display name of the device model. */
3524
+ display_name: string
3525
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
3526
+ manufacturer_display_name: string
3527
+ /** Indicates whether the device supports offline access codes. */
3528
+ offline_access_codes_supported?: boolean | undefined
3529
+ /** Indicates whether the device supports online access codes. */
3530
+ online_access_codes_supported?: boolean | undefined
3531
+ /** Indicates whether the device supports an accessory keypad. */
3532
+ accessory_keypad_supported?: boolean | undefined
3533
+ }
3478
3534
  }
3479
3535
  }>
3480
3536
  }