@seamapi/types 1.1192.0 → 1.1194.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.
@@ -16525,6 +16525,13 @@ export type Routes = {
16525
16525
  message: string;
16526
16526
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
16527
16527
  warning_code: 'salto_ks_subscription_limit_almost_reached';
16528
+ } | {
16529
+ /** Date and time at which Seam created the warning. */
16530
+ created_at: string;
16531
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
16532
+ message: string;
16533
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
16534
+ warning_code: 'salto_ks_custom_pins_not_supported';
16528
16535
  } | {
16529
16536
  /** Date and time at which Seam created the warning. */
16530
16537
  created_at: string;
@@ -41406,6 +41413,13 @@ export type Routes = {
41406
41413
  message: string;
41407
41414
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41408
41415
  warning_code: 'salto_ks_subscription_limit_almost_reached';
41416
+ } | {
41417
+ /** Date and time at which Seam created the warning. */
41418
+ created_at: string;
41419
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41420
+ message: string;
41421
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41422
+ warning_code: 'salto_ks_custom_pins_not_supported';
41409
41423
  } | {
41410
41424
  /** Date and time at which Seam created the warning. */
41411
41425
  created_at: string;
@@ -41582,6 +41596,13 @@ export type Routes = {
41582
41596
  message: string;
41583
41597
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41584
41598
  warning_code: 'salto_ks_subscription_limit_almost_reached';
41599
+ } | {
41600
+ /** Date and time at which Seam created the warning. */
41601
+ created_at: string;
41602
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41603
+ message: string;
41604
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41605
+ warning_code: 'salto_ks_custom_pins_not_supported';
41585
41606
  } | {
41586
41607
  /** Date and time at which Seam created the warning. */
41587
41608
  created_at: string;
@@ -41754,6 +41775,13 @@ export type Routes = {
41754
41775
  message: string;
41755
41776
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41756
41777
  warning_code: 'salto_ks_subscription_limit_almost_reached';
41778
+ } | {
41779
+ /** Date and time at which Seam created the warning. */
41780
+ created_at: string;
41781
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41782
+ message: string;
41783
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41784
+ warning_code: 'salto_ks_custom_pins_not_supported';
41757
41785
  } | {
41758
41786
  /** Date and time at which Seam created the warning. */
41759
41787
  created_at: string;
@@ -104837,6 +104865,25 @@ export type Routes = {
104837
104865
  jsonResponse: {};
104838
104866
  maxDuration: undefined;
104839
104867
  };
104868
+ '/seam/customer/v1/connector_customers/delete': {
104869
+ route: '/seam/customer/v1/connector_customers/delete';
104870
+ method: 'POST';
104871
+ queryParams: {};
104872
+ jsonBody: {
104873
+ /** ID of the connector customer to delete. */
104874
+ connector_customer_id: string;
104875
+ };
104876
+ commonParams: {};
104877
+ formData: {};
104878
+ jsonResponse: {
104879
+ connector_customer: {
104880
+ connector_customer_id: string;
104881
+ connector_id: string;
104882
+ status: 'deleted';
104883
+ };
104884
+ };
104885
+ maxDuration: undefined;
104886
+ };
104840
104887
  '/seam/customer/v1/connector_customers/list': {
104841
104888
  route: '/seam/customer/v1/connector_customers/list';
104842
104889
  method: 'GET' | 'POST';
@@ -117833,6 +117880,13 @@ export type Routes = {
117833
117880
  message: string;
117834
117881
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
117835
117882
  warning_code: 'salto_ks_subscription_limit_almost_reached';
117883
+ } | {
117884
+ /** Date and time at which Seam created the warning. */
117885
+ created_at: string;
117886
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
117887
+ message: string;
117888
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
117889
+ warning_code: 'salto_ks_custom_pins_not_supported';
117836
117890
  } | {
117837
117891
  /** Date and time at which Seam created the warning. */
117838
117892
  created_at: string;
@@ -169176,6 +169230,13 @@ export type Routes = {
169176
169230
  message: string;
169177
169231
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
169178
169232
  warning_code: 'salto_ks_subscription_limit_almost_reached';
169233
+ } | {
169234
+ /** Date and time at which Seam created the warning. */
169235
+ created_at: string;
169236
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
169237
+ message: string;
169238
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
169239
+ warning_code: 'salto_ks_custom_pins_not_supported';
169179
169240
  } | {
169180
169241
  /** Date and time at which Seam created the warning. */
169181
169242
  created_at: string;
@@ -173288,6 +173349,13 @@ export type Routes = {
173288
173349
  message: string;
173289
173350
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
173290
173351
  warning_code: 'salto_ks_subscription_limit_almost_reached';
173352
+ } | {
173353
+ /** Date and time at which Seam created the warning. */
173354
+ created_at: string;
173355
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
173356
+ message: string;
173357
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
173358
+ warning_code: 'salto_ks_custom_pins_not_supported';
173291
173359
  } | {
173292
173360
  /** Date and time at which Seam created the warning. */
173293
173361
  created_at: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1192.0",
3
+ "version": "1.1194.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -223,6 +223,16 @@ const salto_ks_subscription_limit_almost_reached = common_acs_system_warning
223
223
  'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue.',
224
224
  )
225
225
 
226
+ const salto_ks_custom_pins_not_supported = common_acs_system_warning
227
+ .extend({
228
+ warning_code: z
229
+ .literal('salto_ks_custom_pins_not_supported')
230
+ .describe(warning_code_description),
231
+ })
232
+ .describe(
233
+ "Indicates that the Salto KS site does not accept custom PIN codes, either because its Salto subscription does not include the Custom PIN feature or because Custom PIN is turned off in the site's settings. Salto KS generates every PIN on the site, so a PIN code requested on an access grant or reservation is replaced with a Salto-generated one. The message says which of the two applies.",
234
+ )
235
+
226
236
  const time_zone_does_not_match_location = common_acs_system_warning
227
237
  .extend({
228
238
  warning_code: z
@@ -267,6 +277,7 @@ const unknown_issue_with_acs_system = common_acs_system_warning.extend({
267
277
  const acs_system_warning = z
268
278
  .discriminatedUnion('warning_code', [
269
279
  salto_ks_subscription_limit_almost_reached,
280
+ salto_ks_custom_pins_not_supported,
270
281
  time_zone_does_not_match_location,
271
282
  setup_required,
272
283
  unknown_issue_with_acs_system,
@@ -278,6 +289,8 @@ const acs_system_warning = z
278
289
  const _acs_system_warning_map = z.object({
279
290
  salto_ks_subscription_limit_almost_reached:
280
291
  salto_ks_subscription_limit_almost_reached.optional(),
292
+ salto_ks_custom_pins_not_supported:
293
+ salto_ks_custom_pins_not_supported.optional(),
281
294
  time_zone_does_not_match_location:
282
295
  time_zone_does_not_match_location.optional(),
283
296
  setup_required: setup_required.optional(),
@@ -5416,6 +5416,31 @@ const openapi: OpenAPISpec = {
5416
5416
  required: ['created_at', 'message', 'warning_code'],
5417
5417
  type: 'object',
5418
5418
  },
5419
+ {
5420
+ description:
5421
+ "Indicates that the Salto KS site does not accept custom PIN codes, either because its Salto subscription does not include the Custom PIN feature or because Custom PIN is turned off in the site's settings. Salto KS generates every PIN on the site, so a PIN code requested on an access grant or reservation is replaced with a Salto-generated one. The message says which of the two applies.",
5422
+ properties: {
5423
+ created_at: {
5424
+ description:
5425
+ 'Date and time at which Seam created the warning.',
5426
+ format: 'date-time',
5427
+ type: 'string',
5428
+ },
5429
+ message: {
5430
+ description:
5431
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
5432
+ type: 'string',
5433
+ },
5434
+ warning_code: {
5435
+ description:
5436
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5437
+ enum: ['salto_ks_custom_pins_not_supported'],
5438
+ type: 'string',
5439
+ },
5440
+ },
5441
+ required: ['created_at', 'message', 'warning_code'],
5442
+ type: 'object',
5443
+ },
5419
5444
  {
5420
5445
  description:
5421
5446
  'Indicates the [access control system](https://www.seam.co/docs/low-level-apis/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://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
@@ -69804,6 +69829,75 @@ const openapi: OpenAPISpec = {
69804
69829
  'x-undocumented': 'Internal endpoint for customer portals.',
69805
69830
  },
69806
69831
  },
69832
+ '/seam/customer/v1/connector_customers/delete': {
69833
+ post: {
69834
+ description:
69835
+ "Removes one customer from a connector and deactivates that customer's connection. The connector and its other customers are kept, even when this was the connector's last customer. Reservations, spaces, and other resources already synced for the customer are not deleted.",
69836
+ operationId: 'seamCustomerV1ConnectorCustomersDeletePost',
69837
+ requestBody: {
69838
+ content: {
69839
+ 'application/json': {
69840
+ schema: {
69841
+ properties: {
69842
+ connector_customer_id: {
69843
+ description: 'ID of the connector customer to delete.',
69844
+ format: 'uuid',
69845
+ type: 'string',
69846
+ },
69847
+ },
69848
+ required: ['connector_customer_id'],
69849
+ type: 'object',
69850
+ },
69851
+ },
69852
+ },
69853
+ },
69854
+ responses: {
69855
+ '200': {
69856
+ content: {
69857
+ 'application/json': {
69858
+ schema: {
69859
+ properties: {
69860
+ connector_customer: {
69861
+ properties: {
69862
+ connector_customer_id: { type: 'string' },
69863
+ connector_id: { type: 'string' },
69864
+ status: { enum: ['deleted'], type: 'string' },
69865
+ },
69866
+ required: [
69867
+ 'connector_customer_id',
69868
+ 'connector_id',
69869
+ 'status',
69870
+ ],
69871
+ type: 'object',
69872
+ },
69873
+ ok: { type: 'boolean' },
69874
+ },
69875
+ required: ['connector_customer', 'ok'],
69876
+ type: 'object',
69877
+ },
69878
+ },
69879
+ },
69880
+ description: 'OK',
69881
+ },
69882
+ '400': { description: 'Bad Request' },
69883
+ '401': { description: 'Unauthorized' },
69884
+ },
69885
+ security: [{ api_key: [] }, { console_session_with_workspace: [] }],
69886
+ summary: '/seam/customer/v1/connector_customers/delete',
69887
+ tags: [],
69888
+ 'x-fern-sdk-group-name': [
69889
+ 'seam',
69890
+ 'customer',
69891
+ 'v1',
69892
+ 'connector_customers',
69893
+ ],
69894
+ 'x-fern-sdk-method-name': 'delete',
69895
+ 'x-fern-sdk-return-value': 'connector_customer',
69896
+ 'x-response-key': 'connector_customer',
69897
+ 'x-title': 'Delete Connector Customer',
69898
+ 'x-undocumented': 'Internal endpoint for Console.',
69899
+ },
69900
+ },
69807
69901
  '/seam/customer/v1/connector_customers/list': {
69808
69902
  get: {
69809
69903
  description: 'Lists connector customers for a given connector.',
@@ -19230,6 +19230,14 @@ export type Routes = {
19230
19230
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19231
19231
  warning_code: 'salto_ks_subscription_limit_almost_reached'
19232
19232
  }
19233
+ | {
19234
+ /** Date and time at which Seam created the warning. */
19235
+ created_at: string
19236
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19237
+ message: string
19238
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19239
+ warning_code: 'salto_ks_custom_pins_not_supported'
19240
+ }
19233
19241
  | {
19234
19242
  /** Date and time at which Seam created the warning. */
19235
19243
  created_at: string
@@ -48334,6 +48342,14 @@ export type Routes = {
48334
48342
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
48335
48343
  warning_code: 'salto_ks_subscription_limit_almost_reached'
48336
48344
  }
48345
+ | {
48346
+ /** Date and time at which Seam created the warning. */
48347
+ created_at: string
48348
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
48349
+ message: string
48350
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
48351
+ warning_code: 'salto_ks_custom_pins_not_supported'
48352
+ }
48337
48353
  | {
48338
48354
  /** Date and time at which Seam created the warning. */
48339
48355
  created_at: string
@@ -48568,6 +48584,14 @@ export type Routes = {
48568
48584
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
48569
48585
  warning_code: 'salto_ks_subscription_limit_almost_reached'
48570
48586
  }
48587
+ | {
48588
+ /** Date and time at which Seam created the warning. */
48589
+ created_at: string
48590
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
48591
+ message: string
48592
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
48593
+ warning_code: 'salto_ks_custom_pins_not_supported'
48594
+ }
48571
48595
  | {
48572
48596
  /** Date and time at which Seam created the warning. */
48573
48597
  created_at: string
@@ -48798,6 +48822,14 @@ export type Routes = {
48798
48822
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
48799
48823
  warning_code: 'salto_ks_subscription_limit_almost_reached'
48800
48824
  }
48825
+ | {
48826
+ /** Date and time at which Seam created the warning. */
48827
+ created_at: string
48828
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
48829
+ message: string
48830
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
48831
+ warning_code: 'salto_ks_custom_pins_not_supported'
48832
+ }
48801
48833
  | {
48802
48834
  /** Date and time at which Seam created the warning. */
48803
48835
  created_at: string
@@ -125275,6 +125307,25 @@ export type Routes = {
125275
125307
  jsonResponse: {}
125276
125308
  maxDuration: undefined
125277
125309
  }
125310
+ '/seam/customer/v1/connector_customers/delete': {
125311
+ route: '/seam/customer/v1/connector_customers/delete'
125312
+ method: 'POST'
125313
+ queryParams: {}
125314
+ jsonBody: {
125315
+ /** ID of the connector customer to delete. */
125316
+ connector_customer_id: string
125317
+ }
125318
+ commonParams: {}
125319
+ formData: {}
125320
+ jsonResponse: {
125321
+ connector_customer: {
125322
+ connector_customer_id: string
125323
+ connector_id: string
125324
+ status: 'deleted'
125325
+ }
125326
+ }
125327
+ maxDuration: undefined
125328
+ }
125278
125329
  '/seam/customer/v1/connector_customers/list': {
125279
125330
  route: '/seam/customer/v1/connector_customers/list'
125280
125331
  method: 'GET' | 'POST'
@@ -140913,6 +140964,14 @@ export type Routes = {
140913
140964
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
140914
140965
  warning_code: 'salto_ks_subscription_limit_almost_reached'
140915
140966
  }
140967
+ | {
140968
+ /** Date and time at which Seam created the warning. */
140969
+ created_at: string
140970
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
140971
+ message: string
140972
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
140973
+ warning_code: 'salto_ks_custom_pins_not_supported'
140974
+ }
140916
140975
  | {
140917
140976
  /** Date and time at which Seam created the warning. */
140918
140977
  created_at: string
@@ -201111,6 +201170,14 @@ export type Routes = {
201111
201170
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
201112
201171
  warning_code: 'salto_ks_subscription_limit_almost_reached'
201113
201172
  }
201173
+ | {
201174
+ /** Date and time at which Seam created the warning. */
201175
+ created_at: string
201176
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
201177
+ message: string
201178
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
201179
+ warning_code: 'salto_ks_custom_pins_not_supported'
201180
+ }
201114
201181
  | {
201115
201182
  /** Date and time at which Seam created the warning. */
201116
201183
  created_at: string
@@ -206159,6 +206226,14 @@ export type Routes = {
206159
206226
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
206160
206227
  warning_code: 'salto_ks_subscription_limit_almost_reached'
206161
206228
  }
206229
+ | {
206230
+ /** Date and time at which Seam created the warning. */
206231
+ created_at: string
206232
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
206233
+ message: string
206234
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
206235
+ warning_code: 'salto_ks_custom_pins_not_supported'
206236
+ }
206162
206237
  | {
206163
206238
  /** Date and time at which Seam created the warning. */
206164
206239
  created_at: string