@seamapi/types 1.367.0 → 1.367.2

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). */
@@ -37052,7 +37058,7 @@ export interface Routes {
37052
37058
  };
37053
37059
  '/unstable_locations/add_devices': {
37054
37060
  route: '/unstable_locations/add_devices';
37055
- method: 'POST';
37061
+ method: 'POST' | 'PUT';
37056
37062
  queryParams: {};
37057
37063
  jsonBody: {
37058
37064
  location_id: string;
@@ -37082,6 +37088,8 @@ export interface Routes {
37082
37088
  location_id: string;
37083
37089
  /** Unique identifier for the Seam workspace associated with the location. */
37084
37090
  workspace_id: string;
37091
+ /** Name of the location. */
37092
+ name: string;
37085
37093
  /** Display name of the location. */
37086
37094
  display_name: string;
37087
37095
  /** Geographical location of the location. */
@@ -37122,6 +37130,8 @@ export interface Routes {
37122
37130
  location_id: string;
37123
37131
  /** Unique identifier for the Seam workspace associated with the location. */
37124
37132
  workspace_id: string;
37133
+ /** Name of the location. */
37134
+ name: string;
37125
37135
  /** Display name of the location. */
37126
37136
  display_name: string;
37127
37137
  /** Geographical location of the location. */
@@ -37149,6 +37159,8 @@ export interface Routes {
37149
37159
  location_id: string;
37150
37160
  /** Unique identifier for the Seam workspace associated with the location. */
37151
37161
  workspace_id: string;
37162
+ /** Name of the location. */
37163
+ name: string;
37152
37164
  /** Display name of the location. */
37153
37165
  display_name: string;
37154
37166
  /** Geographical location of the location. */
@@ -37165,19 +37177,19 @@ export interface Routes {
37165
37177
  };
37166
37178
  '/unstable_locations/remove_devices': {
37167
37179
  route: '/unstable_locations/remove_devices';
37168
- method: 'POST';
37180
+ method: 'POST' | 'DELETE';
37169
37181
  queryParams: {};
37170
- jsonBody: {
37182
+ jsonBody: {};
37183
+ commonParams: {
37171
37184
  location_id: string;
37172
37185
  device_ids: string[];
37173
37186
  };
37174
- commonParams: {};
37175
37187
  formData: {};
37176
37188
  jsonResponse: {};
37177
37189
  };
37178
37190
  '/unstable_locations/update': {
37179
37191
  route: '/unstable_locations/update';
37180
- method: 'POST';
37192
+ method: 'POST' | 'PATCH';
37181
37193
  queryParams: {};
37182
37194
  jsonBody: {
37183
37195
  location_id: string;
@@ -37196,6 +37208,8 @@ export interface Routes {
37196
37208
  location_id: string;
37197
37209
  /** Unique identifier for the Seam workspace associated with the location. */
37198
37210
  workspace_id: string;
37211
+ /** Name of the location. */
37212
+ name: string;
37199
37213
  /** Display name of the location. */
37200
37214
  display_name: string;
37201
37215
  /** Geographical location of the location. */
@@ -38943,6 +38957,8 @@ export interface Routes {
38943
38957
  message: string;
38944
38958
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
38945
38959
  warning_code: 'time_zone_does_not_match_location';
38960
+ /**
38961
+ * @deprecated this field is deprecated. */
38946
38962
  misconfigured_acs_entrance_ids?: string[] | undefined;
38947
38963
  }>;
38948
38964
  /** 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.0",
3
+ "version": "1.367.2",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -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
+ >
@@ -16,6 +16,7 @@ export const location = z.object({
16
16
  .describe(
17
17
  'Unique identifier for the Seam workspace associated with the location.',
18
18
  ),
19
+ name: z.string().describe('Name of the location.'),
19
20
  display_name: z.string().describe('Display name of the location.'),
20
21
  geolocation: geolocation
21
22
  .optional()
@@ -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:
@@ -28093,6 +28095,7 @@ export default {
28093
28095
  properties: {
28094
28096
  device_ids: {
28095
28097
  items: { format: 'uuid', type: 'string' },
28098
+ minItems: 1,
28096
28099
  type: 'array',
28097
28100
  },
28098
28101
  location_id: { format: 'uuid', type: 'string' },
@@ -28132,6 +28135,56 @@ export default {
28132
28135
  'x-title': 'Add Location Devices',
28133
28136
  'x-undocumented': 'Experimental locations.',
28134
28137
  },
28138
+ put: {
28139
+ description:
28140
+ 'Add devices to a specific location. If a device already belongs to a location it will be moved.',
28141
+ operationId: 'unstableLocationsAddDevicesPut',
28142
+ requestBody: {
28143
+ content: {
28144
+ 'application/json': {
28145
+ schema: {
28146
+ properties: {
28147
+ device_ids: {
28148
+ items: { format: 'uuid', type: 'string' },
28149
+ minItems: 1,
28150
+ type: 'array',
28151
+ },
28152
+ location_id: { format: 'uuid', type: 'string' },
28153
+ },
28154
+ required: ['location_id', 'device_ids'],
28155
+ type: 'object',
28156
+ },
28157
+ },
28158
+ },
28159
+ },
28160
+ responses: {
28161
+ 200: {
28162
+ content: {
28163
+ 'application/json': {
28164
+ schema: {
28165
+ properties: { ok: { type: 'boolean' } },
28166
+ required: ['ok'],
28167
+ type: 'object',
28168
+ },
28169
+ },
28170
+ },
28171
+ description: 'OK',
28172
+ },
28173
+ 400: { description: 'Bad Request' },
28174
+ 401: { description: 'Unauthorized' },
28175
+ },
28176
+ security: [
28177
+ { pat_with_workspace: [] },
28178
+ { console_session_with_workspace: [] },
28179
+ { api_key: [] },
28180
+ ],
28181
+ summary: '/unstable_locations/add_devices',
28182
+ tags: [],
28183
+ 'x-fern-ignore': true,
28184
+ 'x-response-key': null,
28185
+ 'x-title': 'Add Location Devices',
28186
+ 'x-undocumented': 'Experimental locations.',
28187
+ },
28135
28188
  },
28136
28189
  '/unstable_locations/create': {
28137
28190
  post: {
@@ -28191,6 +28244,10 @@ export default {
28191
28244
  format: 'uuid',
28192
28245
  type: 'string',
28193
28246
  },
28247
+ name: {
28248
+ description: 'Name of the location.',
28249
+ type: 'string',
28250
+ },
28194
28251
  time_zone: {
28195
28252
  description: 'Time zone of the location.',
28196
28253
  type: 'string',
@@ -28205,6 +28262,7 @@ export default {
28205
28262
  required: [
28206
28263
  'location_id',
28207
28264
  'workspace_id',
28265
+ 'name',
28208
28266
  'display_name',
28209
28267
  'created_at',
28210
28268
  ],
@@ -28329,6 +28387,10 @@ export default {
28329
28387
  format: 'uuid',
28330
28388
  type: 'string',
28331
28389
  },
28390
+ name: {
28391
+ description: 'Name of the location.',
28392
+ type: 'string',
28393
+ },
28332
28394
  time_zone: {
28333
28395
  description: 'Time zone of the location.',
28334
28396
  type: 'string',
@@ -28343,6 +28405,7 @@ export default {
28343
28405
  required: [
28344
28406
  'location_id',
28345
28407
  'workspace_id',
28408
+ 'name',
28346
28409
  'display_name',
28347
28410
  'created_at',
28348
28411
  ],
@@ -28413,6 +28476,10 @@ export default {
28413
28476
  format: 'uuid',
28414
28477
  type: 'string',
28415
28478
  },
28479
+ name: {
28480
+ description: 'Name of the location.',
28481
+ type: 'string',
28482
+ },
28416
28483
  time_zone: {
28417
28484
  description: 'Time zone of the location.',
28418
28485
  type: 'string',
@@ -28427,6 +28494,7 @@ export default {
28427
28494
  required: [
28428
28495
  'location_id',
28429
28496
  'workspace_id',
28497
+ 'name',
28430
28498
  'display_name',
28431
28499
  'created_at',
28432
28500
  ],
@@ -28495,6 +28563,10 @@ export default {
28495
28563
  format: 'uuid',
28496
28564
  type: 'string',
28497
28565
  },
28566
+ name: {
28567
+ description: 'Name of the location.',
28568
+ type: 'string',
28569
+ },
28498
28570
  time_zone: {
28499
28571
  description: 'Time zone of the location.',
28500
28572
  type: 'string',
@@ -28509,6 +28581,7 @@ export default {
28509
28581
  required: [
28510
28582
  'location_id',
28511
28583
  'workspace_id',
28584
+ 'name',
28512
28585
  'display_name',
28513
28586
  'created_at',
28514
28587
  ],
@@ -28595,6 +28668,112 @@ export default {
28595
28668
  },
28596
28669
  },
28597
28670
  '/unstable_locations/update': {
28671
+ patch: {
28672
+ description: 'Update an existing location.',
28673
+ operationId: 'unstableLocationsUpdatePatch',
28674
+ requestBody: {
28675
+ content: {
28676
+ 'application/json': {
28677
+ schema: {
28678
+ properties: {
28679
+ geolocation: {
28680
+ properties: {
28681
+ latitude: { format: 'float', type: 'number' },
28682
+ longitude: { format: 'float', type: 'number' },
28683
+ },
28684
+ required: ['latitude', 'longitude'],
28685
+ type: 'object',
28686
+ },
28687
+ location_id: { format: 'uuid', type: 'string' },
28688
+ name: { type: 'string' },
28689
+ time_zone: { type: 'string' },
28690
+ },
28691
+ required: ['location_id'],
28692
+ type: 'object',
28693
+ },
28694
+ },
28695
+ },
28696
+ },
28697
+ responses: {
28698
+ 200: {
28699
+ content: {
28700
+ 'application/json': {
28701
+ schema: {
28702
+ properties: {
28703
+ location: {
28704
+ properties: {
28705
+ created_at: {
28706
+ description:
28707
+ 'Date and time at which the location object was created.',
28708
+ format: 'date-time',
28709
+ type: 'string',
28710
+ },
28711
+ display_name: {
28712
+ description: 'Display name of the location.',
28713
+ type: 'string',
28714
+ },
28715
+ geolocation: {
28716
+ description: 'Geographical location of the location.',
28717
+ properties: {
28718
+ latitude: { format: 'float', type: 'number' },
28719
+ longitude: { format: 'float', type: 'number' },
28720
+ },
28721
+ required: ['latitude', 'longitude'],
28722
+ type: 'object',
28723
+ },
28724
+ location_id: {
28725
+ description: 'Unique identifier for the location.',
28726
+ format: 'uuid',
28727
+ type: 'string',
28728
+ },
28729
+ name: {
28730
+ description: 'Name of the location.',
28731
+ type: 'string',
28732
+ },
28733
+ time_zone: {
28734
+ description: 'Time zone of the location.',
28735
+ type: 'string',
28736
+ },
28737
+ workspace_id: {
28738
+ description:
28739
+ 'Unique identifier for the Seam workspace associated with the location.',
28740
+ format: 'uuid',
28741
+ type: 'string',
28742
+ },
28743
+ },
28744
+ required: [
28745
+ 'location_id',
28746
+ 'workspace_id',
28747
+ 'name',
28748
+ 'display_name',
28749
+ 'created_at',
28750
+ ],
28751
+ type: 'object',
28752
+ },
28753
+ ok: { type: 'boolean' },
28754
+ },
28755
+ required: ['location', 'ok'],
28756
+ type: 'object',
28757
+ },
28758
+ },
28759
+ },
28760
+ description: 'OK',
28761
+ },
28762
+ 400: { description: 'Bad Request' },
28763
+ 401: { description: 'Unauthorized' },
28764
+ },
28765
+ security: [
28766
+ { pat_with_workspace: [] },
28767
+ { console_session_with_workspace: [] },
28768
+ { api_key: [] },
28769
+ ],
28770
+ summary: '/unstable_locations/update',
28771
+ tags: [],
28772
+ 'x-fern-ignore': true,
28773
+ 'x-response-key': 'location',
28774
+ 'x-title': 'Update Location',
28775
+ 'x-undocumented': 'Experimental locations.',
28776
+ },
28598
28777
  post: {
28599
28778
  description: 'Update an existing location.',
28600
28779
  operationId: 'unstableLocationsUpdatePost',
@@ -28653,6 +28832,10 @@ export default {
28653
28832
  format: 'uuid',
28654
28833
  type: 'string',
28655
28834
  },
28835
+ name: {
28836
+ description: 'Name of the location.',
28837
+ type: 'string',
28838
+ },
28656
28839
  time_zone: {
28657
28840
  description: 'Time zone of the location.',
28658
28841
  type: 'string',
@@ -28667,6 +28850,7 @@ export default {
28667
28850
  required: [
28668
28851
  'location_id',
28669
28852
  'workspace_id',
28853
+ 'name',
28670
28854
  'display_name',
28671
28855
  'created_at',
28672
28856
  ],
@@ -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
  >
@@ -45499,7 +45505,7 @@ export interface Routes {
45499
45505
  }
45500
45506
  '/unstable_locations/add_devices': {
45501
45507
  route: '/unstable_locations/add_devices'
45502
- method: 'POST'
45508
+ method: 'POST' | 'PUT'
45503
45509
  queryParams: {}
45504
45510
  jsonBody: {
45505
45511
  location_id: string
@@ -45531,6 +45537,8 @@ export interface Routes {
45531
45537
  location_id: string
45532
45538
  /** Unique identifier for the Seam workspace associated with the location. */
45533
45539
  workspace_id: string
45540
+ /** Name of the location. */
45541
+ name: string
45534
45542
  /** Display name of the location. */
45535
45543
  display_name: string
45536
45544
  /** Geographical location of the location. */
@@ -45573,6 +45581,8 @@ export interface Routes {
45573
45581
  location_id: string
45574
45582
  /** Unique identifier for the Seam workspace associated with the location. */
45575
45583
  workspace_id: string
45584
+ /** Name of the location. */
45585
+ name: string
45576
45586
  /** Display name of the location. */
45577
45587
  display_name: string
45578
45588
  /** Geographical location of the location. */
@@ -45602,6 +45612,8 @@ export interface Routes {
45602
45612
  location_id: string
45603
45613
  /** Unique identifier for the Seam workspace associated with the location. */
45604
45614
  workspace_id: string
45615
+ /** Name of the location. */
45616
+ name: string
45605
45617
  /** Display name of the location. */
45606
45618
  display_name: string
45607
45619
  /** Geographical location of the location. */
@@ -45620,19 +45632,19 @@ export interface Routes {
45620
45632
  }
45621
45633
  '/unstable_locations/remove_devices': {
45622
45634
  route: '/unstable_locations/remove_devices'
45623
- method: 'POST'
45635
+ method: 'POST' | 'DELETE'
45624
45636
  queryParams: {}
45625
- jsonBody: {
45637
+ jsonBody: {}
45638
+ commonParams: {
45626
45639
  location_id: string
45627
45640
  device_ids: string[]
45628
45641
  }
45629
- commonParams: {}
45630
45642
  formData: {}
45631
45643
  jsonResponse: {}
45632
45644
  }
45633
45645
  '/unstable_locations/update': {
45634
45646
  route: '/unstable_locations/update'
45635
- method: 'POST'
45647
+ method: 'POST' | 'PATCH'
45636
45648
  queryParams: {}
45637
45649
  jsonBody: {
45638
45650
  location_id: string
@@ -45653,6 +45665,8 @@ export interface Routes {
45653
45665
  location_id: string
45654
45666
  /** Unique identifier for the Seam workspace associated with the location. */
45655
45667
  workspace_id: string
45668
+ /** Name of the location. */
45669
+ name: string
45656
45670
  /** Display name of the location. */
45657
45671
  display_name: string
45658
45672
  /** Geographical location of the location. */
@@ -47885,6 +47899,8 @@ export interface Routes {
47885
47899
  message: string
47886
47900
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
47887
47901
  warning_code: 'time_zone_does_not_match_location'
47902
+ /**
47903
+ * @deprecated this field is deprecated. */
47888
47904
  misconfigured_acs_entrance_ids?: string[] | undefined
47889
47905
  }
47890
47906
  >