@seamapi/types 1.367.1 → 1.368.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.
@@ -10857,6 +10857,8 @@ export interface Routes {
10857
10857
  message: string;
10858
10858
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
10859
10859
  warning_code: 'time_zone_does_not_match_location';
10860
+ /**
10861
+ * @deprecated this field is deprecated. */
10860
10862
  misconfigured_acs_entrance_ids?: string[] | undefined;
10861
10863
  }>;
10862
10864
  /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
@@ -10984,6 +10986,8 @@ export interface Routes {
10984
10986
  message: string;
10985
10987
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
10986
10988
  warning_code: 'time_zone_does_not_match_location';
10989
+ /**
10990
+ * @deprecated this field is deprecated. */
10987
10991
  misconfigured_acs_entrance_ids?: string[] | undefined;
10988
10992
  }>;
10989
10993
  /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
@@ -11111,6 +11115,8 @@ export interface Routes {
11111
11115
  message: string;
11112
11116
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11113
11117
  warning_code: 'time_zone_does_not_match_location';
11118
+ /**
11119
+ * @deprecated this field is deprecated. */
11114
11120
  misconfigured_acs_entrance_ids?: string[] | undefined;
11115
11121
  }>;
11116
11122
  /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
@@ -16006,6 +16012,30 @@ export interface Routes {
16006
16012
  }>;
16007
16013
  };
16008
16014
  };
16015
+ '/devices/simulate/access_code_lock': {
16016
+ route: '/devices/simulate/access_code_lock';
16017
+ method: 'POST';
16018
+ queryParams: {};
16019
+ jsonBody: {
16020
+ device_id: string;
16021
+ access_code_id: string;
16022
+ };
16023
+ commonParams: {};
16024
+ formData: {};
16025
+ jsonResponse: {};
16026
+ };
16027
+ '/devices/simulate/access_code_unlock': {
16028
+ route: '/devices/simulate/access_code_unlock';
16029
+ method: 'POST';
16030
+ queryParams: {};
16031
+ jsonBody: {
16032
+ device_id: string;
16033
+ access_code_id: string;
16034
+ };
16035
+ commonParams: {};
16036
+ formData: {};
16037
+ jsonResponse: {};
16038
+ };
16009
16039
  '/devices/simulate/connect': {
16010
16040
  route: '/devices/simulate/connect';
16011
16041
  method: 'POST';
@@ -38951,6 +38981,8 @@ export interface Routes {
38951
38981
  message: string;
38952
38982
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
38953
38983
  warning_code: 'time_zone_does_not_match_location';
38984
+ /**
38985
+ * @deprecated this field is deprecated. */
38954
38986
  misconfigured_acs_entrance_ids?: string[] | undefined;
38955
38987
  }>;
38956
38988
  /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.367.1",
3
+ "version": "1.368.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -89,7 +89,7 @@
89
89
  "npm": ">= 9.0.0"
90
90
  },
91
91
  "peerDependencies": {
92
- "zod": "^3.21.4"
92
+ "zod": "^3.24.0"
93
93
  },
94
94
  "devDependencies": {
95
95
  "@seamapi/blueprint": "^0.37.1",
@@ -111,6 +111,6 @@
111
111
  "tsx": "^4.6.2",
112
112
  "typedoc": "^0.25.2",
113
113
  "typescript": "~5.3.3",
114
- "zod": "^3.21.4"
114
+ "zod": "^3.24.0"
115
115
  }
116
116
  }
@@ -186,7 +186,16 @@ const time_zone_does_not_match_location = common_acs_system_warning
186
186
  warning_code: z
187
187
  .literal('time_zone_does_not_match_location')
188
188
  .describe(warning_code_description),
189
- misconfigured_acs_entrance_ids: z.array(z.string().uuid()).optional(),
189
+ misconfigured_acs_entrance_ids: z
190
+ .array(z.string().uuid())
191
+ .optional()
192
+ .describe(
193
+ `
194
+ ---
195
+ deprecated: this field is deprecated.
196
+ ---
197
+ `,
198
+ ),
190
199
  })
191
200
  .describe(
192
201
  'Indicates the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
@@ -54,3 +54,50 @@ export const acs_user_pending_modification = z.discriminatedUnion(
54
54
  acs_access_group_membership_pending_modification,
55
55
  ],
56
56
  )
57
+
58
+ export type AcsUserPendingModification = z.infer<
59
+ typeof acs_user_pending_modification
60
+ >
61
+
62
+ const acs_user_pending_modifications_map = z.object({
63
+ 'profile.full_name': common_pending_modification
64
+ .extend({
65
+ modification_code: z.literal('profile'),
66
+ modified_from: z.object({
67
+ full_name: z.string().nullable(),
68
+ }),
69
+ modified_to: z.object({
70
+ full_name: z.string().nullable(),
71
+ }),
72
+ })
73
+ .optional()
74
+ .nullable(),
75
+ 'profile.email_address': common_pending_modification
76
+ .extend({
77
+ modification_code: z.literal('profile'),
78
+ modified_from: z.object({
79
+ email_address: z.string().email().nullable(),
80
+ }),
81
+ modified_to: z.object({
82
+ email_address: z.string().email().nullable(),
83
+ }),
84
+ })
85
+ .optional()
86
+ .nullable(),
87
+ 'profile.phone_number': common_pending_modification
88
+ .extend({
89
+ modification_code: z.literal('profile'),
90
+ modified_from: z.object({
91
+ phone_number: phone_number.nullable(),
92
+ }),
93
+ modified_to: z.object({
94
+ phone_number: phone_number.nullable(),
95
+ }),
96
+ })
97
+ .optional()
98
+ .nullable(),
99
+ })
100
+
101
+ export type AcsUserPendingModificationsMap = z.infer<
102
+ typeof acs_user_pending_modifications_map
103
+ >
@@ -2169,8 +2169,10 @@ export default {
2169
2169
  type: 'string',
2170
2170
  },
2171
2171
  misconfigured_acs_entrance_ids: {
2172
+ deprecated: true,
2172
2173
  items: { format: 'uuid', type: 'string' },
2173
2174
  type: 'array',
2175
+ 'x-deprecated': 'this field is deprecated.',
2174
2176
  },
2175
2177
  warning_code: {
2176
2178
  description:
@@ -22604,6 +22606,96 @@ export default {
22604
22606
  'x-response-key': 'device_providers',
22605
22607
  },
22606
22608
  },
22609
+ '/devices/simulate/access_code_lock': {
22610
+ post: {
22611
+ operationId: 'devicesSimulateAccessCodeLockPost',
22612
+ requestBody: {
22613
+ content: {
22614
+ 'application/json': {
22615
+ schema: {
22616
+ properties: {
22617
+ access_code_id: { format: 'uuid', type: 'string' },
22618
+ device_id: { format: 'uuid', type: 'string' },
22619
+ },
22620
+ required: ['device_id', 'access_code_id'],
22621
+ type: 'object',
22622
+ },
22623
+ },
22624
+ },
22625
+ },
22626
+ responses: {
22627
+ 200: {
22628
+ content: {
22629
+ 'application/json': {
22630
+ schema: {
22631
+ properties: { ok: { type: 'boolean' } },
22632
+ required: ['ok'],
22633
+ type: 'object',
22634
+ },
22635
+ },
22636
+ },
22637
+ description: 'OK',
22638
+ },
22639
+ 400: { description: 'Bad Request' },
22640
+ 401: { description: 'Unauthorized' },
22641
+ },
22642
+ security: [
22643
+ { api_key: [] },
22644
+ { pat_with_workspace: [] },
22645
+ { console_session_with_workspace: [] },
22646
+ ],
22647
+ summary: '/devices/simulate/access_code_lock',
22648
+ tags: ['/devices'],
22649
+ 'x-fern-sdk-group-name': ['devices', 'simulate'],
22650
+ 'x-fern-sdk-method-name': 'access_code_lock',
22651
+ 'x-response-key': null,
22652
+ },
22653
+ },
22654
+ '/devices/simulate/access_code_unlock': {
22655
+ post: {
22656
+ operationId: 'devicesSimulateAccessCodeUnlockPost',
22657
+ requestBody: {
22658
+ content: {
22659
+ 'application/json': {
22660
+ schema: {
22661
+ properties: {
22662
+ access_code_id: { format: 'uuid', type: 'string' },
22663
+ device_id: { format: 'uuid', type: 'string' },
22664
+ },
22665
+ required: ['device_id', 'access_code_id'],
22666
+ type: 'object',
22667
+ },
22668
+ },
22669
+ },
22670
+ },
22671
+ responses: {
22672
+ 200: {
22673
+ content: {
22674
+ 'application/json': {
22675
+ schema: {
22676
+ properties: { ok: { type: 'boolean' } },
22677
+ required: ['ok'],
22678
+ type: 'object',
22679
+ },
22680
+ },
22681
+ },
22682
+ description: 'OK',
22683
+ },
22684
+ 400: { description: 'Bad Request' },
22685
+ 401: { description: 'Unauthorized' },
22686
+ },
22687
+ security: [
22688
+ { api_key: [] },
22689
+ { pat_with_workspace: [] },
22690
+ { console_session_with_workspace: [] },
22691
+ ],
22692
+ summary: '/devices/simulate/access_code_unlock',
22693
+ tags: ['/devices'],
22694
+ 'x-fern-sdk-group-name': ['devices', 'simulate'],
22695
+ 'x-fern-sdk-method-name': 'access_code_unlock',
22696
+ 'x-response-key': null,
22697
+ },
22698
+ },
22607
22699
  '/devices/simulate/connect': {
22608
22700
  post: {
22609
22701
  operationId: 'devicesSimulateConnectPost',
@@ -26094,6 +26186,7 @@ export default {
26094
26186
  401: { description: 'Unauthorized' },
26095
26187
  },
26096
26188
  security: [
26189
+ { client_session: [] },
26097
26190
  { pat_with_workspace: [] },
26098
26191
  { console_session_with_workspace: [] },
26099
26192
  { api_key: [] },
@@ -26150,6 +26243,7 @@ export default {
26150
26243
  401: { description: 'Unauthorized' },
26151
26244
  },
26152
26245
  security: [
26246
+ { client_session: [] },
26153
26247
  { pat_with_workspace: [] },
26154
26248
  { console_session_with_workspace: [] },
26155
26249
  { api_key: [] },
@@ -27964,6 +28058,7 @@ export default {
27964
28058
  { pat_with_workspace: [] },
27965
28059
  { console_session_with_workspace: [] },
27966
28060
  { api_key: [] },
28061
+ { client_session: [] },
27967
28062
  ],
27968
28063
  summary: '/thermostats/update_climate_preset',
27969
28064
  tags: ['/thermostats'],
@@ -28072,6 +28167,7 @@ export default {
28072
28167
  { pat_with_workspace: [] },
28073
28168
  { console_session_with_workspace: [] },
28074
28169
  { api_key: [] },
28170
+ { client_session: [] },
28075
28171
  ],
28076
28172
  summary: '/thermostats/update_climate_preset',
28077
28173
  tags: ['/thermostats'],
@@ -12828,6 +12828,8 @@ export interface Routes {
12828
12828
  message: string
12829
12829
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
12830
12830
  warning_code: 'time_zone_does_not_match_location'
12831
+ /**
12832
+ * @deprecated this field is deprecated. */
12831
12833
  misconfigured_acs_entrance_ids?: string[] | undefined
12832
12834
  }
12833
12835
  >
@@ -12999,6 +13001,8 @@ export interface Routes {
12999
13001
  message: string
13000
13002
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13001
13003
  warning_code: 'time_zone_does_not_match_location'
13004
+ /**
13005
+ * @deprecated this field is deprecated. */
13002
13006
  misconfigured_acs_entrance_ids?: string[] | undefined
13003
13007
  }
13004
13008
  >
@@ -13170,6 +13174,8 @@ export interface Routes {
13170
13174
  message: string
13171
13175
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13172
13176
  warning_code: 'time_zone_does_not_match_location'
13177
+ /**
13178
+ * @deprecated this field is deprecated. */
13173
13179
  misconfigured_acs_entrance_ids?: string[] | undefined
13174
13180
  }
13175
13181
  >
@@ -19331,6 +19337,30 @@ export interface Routes {
19331
19337
  }>
19332
19338
  }
19333
19339
  }
19340
+ '/devices/simulate/access_code_lock': {
19341
+ route: '/devices/simulate/access_code_lock'
19342
+ method: 'POST'
19343
+ queryParams: {}
19344
+ jsonBody: {
19345
+ device_id: string
19346
+ access_code_id: string
19347
+ }
19348
+ commonParams: {}
19349
+ formData: {}
19350
+ jsonResponse: {}
19351
+ }
19352
+ '/devices/simulate/access_code_unlock': {
19353
+ route: '/devices/simulate/access_code_unlock'
19354
+ method: 'POST'
19355
+ queryParams: {}
19356
+ jsonBody: {
19357
+ device_id: string
19358
+ access_code_id: string
19359
+ }
19360
+ commonParams: {}
19361
+ formData: {}
19362
+ jsonResponse: {}
19363
+ }
19334
19364
  '/devices/simulate/connect': {
19335
19365
  route: '/devices/simulate/connect'
19336
19366
  method: 'POST'
@@ -47893,6 +47923,8 @@ export interface Routes {
47893
47923
  message: string
47894
47924
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
47895
47925
  warning_code: 'time_zone_does_not_match_location'
47926
+ /**
47927
+ * @deprecated this field is deprecated. */
47896
47928
  misconfigured_acs_entrance_ids?: string[] | undefined
47897
47929
  }
47898
47930
  >