@seamapi/types 1.758.0 → 1.760.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.
@@ -11732,6 +11732,13 @@ export type Routes = {
11732
11732
  created_at: string;
11733
11733
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11734
11734
  warning_code: 'accessory_keypad_setup_required';
11735
+ } | {
11736
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11737
+ message: string;
11738
+ /** Date and time at which Seam created the warning. */
11739
+ created_at: string;
11740
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11741
+ warning_code: 'unreliable_online_status';
11735
11742
  } | {
11736
11743
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11737
11744
  message: string;
@@ -13055,6 +13062,10 @@ export type Routes = {
13055
13062
  acs_entrance_id?: string | undefined;
13056
13063
  /** Filter unmanaged Access Grants by reservation_key. */
13057
13064
  reservation_key?: string | undefined;
13065
+ /** Numerical limit on the number of unmanaged access grants to return. */
13066
+ limit?: number;
13067
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
13068
+ page_cursor?: (string | undefined) | null;
13058
13069
  };
13059
13070
  formData: {};
13060
13071
  jsonResponse: {
@@ -13207,6 +13218,15 @@ export type Routes = {
13207
13218
  /** ID of user identity to which the Access Grant gives access. */
13208
13219
  user_identity_id?: string | undefined;
13209
13220
  }[];
13221
+ /** Information about the current page of results. */
13222
+ pagination: {
13223
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
13224
+ next_page_cursor: string | null;
13225
+ /** Indicates whether there is another page of results after this one. */
13226
+ has_next_page: boolean;
13227
+ /** URL to get the next page of results. */
13228
+ next_page_url: string | null;
13229
+ };
13210
13230
  };
13211
13231
  maxDuration: undefined;
13212
13232
  };
@@ -15949,6 +15969,13 @@ export type Routes = {
15949
15969
  created_at: string;
15950
15970
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15951
15971
  warning_code: 'accessory_keypad_setup_required';
15972
+ } | {
15973
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15974
+ message: string;
15975
+ /** Date and time at which Seam created the warning. */
15976
+ created_at: string;
15977
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15978
+ warning_code: 'unreliable_online_status';
15952
15979
  } | {
15953
15980
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15954
15981
  message: string;
@@ -32095,6 +32122,13 @@ export type Routes = {
32095
32122
  created_at: string;
32096
32123
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32097
32124
  warning_code: 'accessory_keypad_setup_required';
32125
+ } | {
32126
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32127
+ message: string;
32128
+ /** Date and time at which Seam created the warning. */
32129
+ created_at: string;
32130
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32131
+ warning_code: 'unreliable_online_status';
32098
32132
  } | {
32099
32133
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32100
32134
  message: string;
@@ -33451,6 +33485,13 @@ export type Routes = {
33451
33485
  created_at: string;
33452
33486
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33453
33487
  warning_code: 'accessory_keypad_setup_required';
33488
+ } | {
33489
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33490
+ message: string;
33491
+ /** Date and time at which Seam created the warning. */
33492
+ created_at: string;
33493
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33494
+ warning_code: 'unreliable_online_status';
33454
33495
  } | {
33455
33496
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33456
33497
  message: string;
@@ -33988,6 +34029,13 @@ export type Routes = {
33988
34029
  created_at: string;
33989
34030
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33990
34031
  warning_code: 'accessory_keypad_setup_required';
34032
+ } | {
34033
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
34034
+ message: string;
34035
+ /** Date and time at which Seam created the warning. */
34036
+ created_at: string;
34037
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
34038
+ warning_code: 'unreliable_online_status';
33991
34039
  } | {
33992
34040
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33993
34041
  message: string;
@@ -34461,6 +34509,13 @@ export type Routes = {
34461
34509
  created_at: string;
34462
34510
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
34463
34511
  warning_code: 'accessory_keypad_setup_required';
34512
+ } | {
34513
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
34514
+ message: string;
34515
+ /** Date and time at which Seam created the warning. */
34516
+ created_at: string;
34517
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
34518
+ warning_code: 'unreliable_online_status';
34464
34519
  } | {
34465
34520
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
34466
34521
  message: string;
@@ -41593,6 +41648,13 @@ export type Routes = {
41593
41648
  created_at: string;
41594
41649
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41595
41650
  warning_code: 'accessory_keypad_setup_required';
41651
+ } | {
41652
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41653
+ message: string;
41654
+ /** Date and time at which Seam created the warning. */
41655
+ created_at: string;
41656
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41657
+ warning_code: 'unreliable_online_status';
41596
41658
  } | {
41597
41659
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41598
41660
  message: string;
@@ -42899,6 +42961,13 @@ export type Routes = {
42899
42961
  created_at: string;
42900
42962
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
42901
42963
  warning_code: 'accessory_keypad_setup_required';
42964
+ } | {
42965
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
42966
+ message: string;
42967
+ /** Date and time at which Seam created the warning. */
42968
+ created_at: string;
42969
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
42970
+ warning_code: 'unreliable_online_status';
42902
42971
  } | {
42903
42972
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
42904
42973
  message: string;
@@ -44255,6 +44324,13 @@ export type Routes = {
44255
44324
  created_at: string;
44256
44325
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
44257
44326
  warning_code: 'accessory_keypad_setup_required';
44327
+ } | {
44328
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
44329
+ message: string;
44330
+ /** Date and time at which Seam created the warning. */
44331
+ created_at: string;
44332
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
44333
+ warning_code: 'unreliable_online_status';
44258
44334
  } | {
44259
44335
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
44260
44336
  message: string;
@@ -45560,6 +45636,13 @@ export type Routes = {
45560
45636
  created_at: string;
45561
45637
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
45562
45638
  warning_code: 'accessory_keypad_setup_required';
45639
+ } | {
45640
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
45641
+ message: string;
45642
+ /** Date and time at which Seam created the warning. */
45643
+ created_at: string;
45644
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
45645
+ warning_code: 'unreliable_online_status';
45563
45646
  } | {
45564
45647
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
45565
45648
  message: string;
@@ -52022,6 +52105,13 @@ export type Routes = {
52022
52105
  created_at: string;
52023
52106
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
52024
52107
  warning_code: 'accessory_keypad_setup_required';
52108
+ } | {
52109
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
52110
+ message: string;
52111
+ /** Date and time at which Seam created the warning. */
52112
+ created_at: string;
52113
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
52114
+ warning_code: 'unreliable_online_status';
52025
52115
  } | {
52026
52116
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
52027
52117
  message: string;
@@ -53327,6 +53417,13 @@ export type Routes = {
53327
53417
  created_at: string;
53328
53418
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
53329
53419
  warning_code: 'accessory_keypad_setup_required';
53420
+ } | {
53421
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
53422
+ message: string;
53423
+ /** Date and time at which Seam created the warning. */
53424
+ created_at: string;
53425
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
53426
+ warning_code: 'unreliable_online_status';
53330
53427
  } | {
53331
53428
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
53332
53429
  message: string;
@@ -65894,6 +65991,13 @@ export type Routes = {
65894
65991
  created_at: string;
65895
65992
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
65896
65993
  warning_code: 'accessory_keypad_setup_required';
65994
+ } | {
65995
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
65996
+ message: string;
65997
+ /** Date and time at which Seam created the warning. */
65998
+ created_at: string;
65999
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66000
+ warning_code: 'unreliable_online_status';
65897
66001
  } | {
65898
66002
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
65899
66003
  message: string;
@@ -71793,6 +71897,13 @@ export type Routes = {
71793
71897
  created_at: string;
71794
71898
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
71795
71899
  warning_code: 'accessory_keypad_setup_required';
71900
+ } | {
71901
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
71902
+ message: string;
71903
+ /** Date and time at which Seam created the warning. */
71904
+ created_at: string;
71905
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
71906
+ warning_code: 'unreliable_online_status';
71796
71907
  } | {
71797
71908
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
71798
71909
  message: string;
@@ -75715,6 +75826,13 @@ export type Routes = {
75715
75826
  created_at: string;
75716
75827
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
75717
75828
  warning_code: 'accessory_keypad_setup_required';
75829
+ } | {
75830
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
75831
+ message: string;
75832
+ /** Date and time at which Seam created the warning. */
75833
+ created_at: string;
75834
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
75835
+ warning_code: 'unreliable_online_status';
75718
75836
  } | {
75719
75837
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
75720
75838
  message: string;
@@ -77020,6 +77138,13 @@ export type Routes = {
77020
77138
  created_at: string;
77021
77139
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
77022
77140
  warning_code: 'accessory_keypad_setup_required';
77141
+ } | {
77142
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
77143
+ message: string;
77144
+ /** Date and time at which Seam created the warning. */
77145
+ created_at: string;
77146
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
77147
+ warning_code: 'unreliable_online_status';
77023
77148
  } | {
77024
77149
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
77025
77150
  message: string;
@@ -84371,6 +84496,13 @@ export type Routes = {
84371
84496
  created_at: string;
84372
84497
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
84373
84498
  warning_code: 'accessory_keypad_setup_required';
84499
+ } | {
84500
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
84501
+ message: string;
84502
+ /** Date and time at which Seam created the warning. */
84503
+ created_at: string;
84504
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
84505
+ warning_code: 'unreliable_online_status';
84374
84506
  } | {
84375
84507
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
84376
84508
  message: string;
@@ -85678,6 +85810,13 @@ export type Routes = {
85678
85810
  created_at: string;
85679
85811
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85680
85812
  warning_code: 'accessory_keypad_setup_required';
85813
+ } | {
85814
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85815
+ message: string;
85816
+ /** Date and time at which Seam created the warning. */
85817
+ created_at: string;
85818
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85819
+ warning_code: 'unreliable_online_status';
85681
85820
  } | {
85682
85821
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85683
85822
  message: string;
@@ -87963,6 +88102,13 @@ export type Routes = {
87963
88102
  created_at: string;
87964
88103
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
87965
88104
  warning_code: 'accessory_keypad_setup_required';
88105
+ } | {
88106
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
88107
+ message: string;
88108
+ /** Date and time at which Seam created the warning. */
88109
+ created_at: string;
88110
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
88111
+ warning_code: 'unreliable_online_status';
87966
88112
  } | {
87967
88113
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
87968
88114
  message: string;
@@ -90671,6 +90817,13 @@ export type Routes = {
90671
90817
  created_at: string;
90672
90818
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
90673
90819
  warning_code: 'accessory_keypad_setup_required';
90820
+ } | {
90821
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
90822
+ message: string;
90823
+ /** Date and time at which Seam created the warning. */
90824
+ created_at: string;
90825
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
90826
+ warning_code: 'unreliable_online_status';
90674
90827
  } | {
90675
90828
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
90676
90829
  message: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.758.0",
3
+ "version": "1.760.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -463,6 +463,17 @@ const accessory_keypad_setup_required = common_device_warning.extend({
463
463
  Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app.
464
464
  `)
465
465
 
466
+ const unreliable_online_status = common_device_warning.extend({
467
+ warning_code: z
468
+ .literal('unreliable_online_status')
469
+ .describe(warning_code_description),
470
+ }).describe(`
471
+ ---
472
+ variant_group_key: locks
473
+ ---
474
+ Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status.
475
+ `)
476
+
466
477
  const max_access_codes_reached = common_device_warning.extend({
467
478
  warning_code: z
468
479
  .literal('max_access_codes_reached')
@@ -506,6 +517,7 @@ const device_warning = z.discriminatedUnion('warning_code', [
506
517
  hub_required_for_additional_capabilities,
507
518
  keynest_unsupported_locker,
508
519
  accessory_keypad_setup_required,
520
+ unreliable_online_status,
509
521
  max_access_codes_reached,
510
522
  ])
511
523
 
@@ -560,6 +572,7 @@ const _device_warning_map = z.object({
560
572
  accessory_keypad_setup_required: accessory_keypad_setup_required
561
573
  .optional()
562
574
  .nullable(),
575
+ unreliable_online_status: unreliable_online_status.optional().nullable(),
563
576
  max_access_codes_reached: max_access_codes_reached.optional().nullable(),
564
577
  })
565
578
 
@@ -14694,6 +14694,32 @@ export default {
14694
14694
  type: 'object',
14695
14695
  'x-variant-group-key': 'locks',
14696
14696
  },
14697
+ {
14698
+ description:
14699
+ 'Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status.',
14700
+ properties: {
14701
+ created_at: {
14702
+ description:
14703
+ 'Date and time at which Seam created the warning.',
14704
+ format: 'date-time',
14705
+ type: 'string',
14706
+ },
14707
+ message: {
14708
+ description:
14709
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
14710
+ type: 'string',
14711
+ },
14712
+ warning_code: {
14713
+ description:
14714
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
14715
+ enum: ['unreliable_online_status'],
14716
+ type: 'string',
14717
+ },
14718
+ },
14719
+ required: ['message', 'created_at', 'warning_code'],
14720
+ type: 'object',
14721
+ 'x-variant-group-key': 'locks',
14722
+ },
14697
14723
  {
14698
14724
  description:
14699
14725
  'Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones.',
@@ -30296,6 +30322,32 @@ export default {
30296
30322
  type: 'object',
30297
30323
  'x-variant-group-key': 'locks',
30298
30324
  },
30325
+ {
30326
+ description:
30327
+ 'Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status.',
30328
+ properties: {
30329
+ created_at: {
30330
+ description:
30331
+ 'Date and time at which Seam created the warning.',
30332
+ format: 'date-time',
30333
+ type: 'string',
30334
+ },
30335
+ message: {
30336
+ description:
30337
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
30338
+ type: 'string',
30339
+ },
30340
+ warning_code: {
30341
+ description:
30342
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
30343
+ enum: ['unreliable_online_status'],
30344
+ type: 'string',
30345
+ },
30346
+ },
30347
+ required: ['message', 'created_at', 'warning_code'],
30348
+ type: 'object',
30349
+ 'x-variant-group-key': 'locks',
30350
+ },
30299
30351
  {
30300
30352
  description:
30301
30353
  'Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones.',
@@ -36106,6 +36158,27 @@ export default {
36106
36158
  type: 'string',
36107
36159
  },
36108
36160
  },
36161
+ {
36162
+ in: 'query',
36163
+ name: 'limit',
36164
+ schema: {
36165
+ default: 500,
36166
+ description:
36167
+ 'Numerical limit on the number of unmanaged access grants to return.',
36168
+ format: 'float',
36169
+ type: 'number',
36170
+ },
36171
+ },
36172
+ {
36173
+ in: 'query',
36174
+ name: 'page_cursor',
36175
+ schema: {
36176
+ description:
36177
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
36178
+ nullable: true,
36179
+ type: 'string',
36180
+ },
36181
+ },
36109
36182
  ],
36110
36183
  responses: {
36111
36184
  200: {
@@ -36687,8 +36760,9 @@ export default {
36687
36760
  type: 'array',
36688
36761
  },
36689
36762
  ok: { type: 'boolean' },
36763
+ pagination: { $ref: '#/components/schemas/pagination' },
36690
36764
  },
36691
- required: ['access_grants', 'ok'],
36765
+ required: ['access_grants', 'pagination', 'ok'],
36692
36766
  type: 'object',
36693
36767
  },
36694
36768
  },
@@ -36733,6 +36807,19 @@ export default {
36733
36807
  format: 'uuid',
36734
36808
  type: 'string',
36735
36809
  },
36810
+ limit: {
36811
+ default: 500,
36812
+ description:
36813
+ 'Numerical limit on the number of unmanaged access grants to return.',
36814
+ format: 'float',
36815
+ type: 'number',
36816
+ },
36817
+ page_cursor: {
36818
+ description:
36819
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
36820
+ nullable: true,
36821
+ type: 'string',
36822
+ },
36736
36823
  reservation_key: {
36737
36824
  description:
36738
36825
  'Filter unmanaged Access Grants by reservation_key.',
@@ -37330,8 +37417,9 @@ export default {
37330
37417
  type: 'array',
37331
37418
  },
37332
37419
  ok: { type: 'boolean' },
37420
+ pagination: { $ref: '#/components/schemas/pagination' },
37333
37421
  },
37334
- required: ['access_grants', 'ok'],
37422
+ required: ['access_grants', 'pagination', 'ok'],
37335
37423
  type: 'object',
37336
37424
  },
37337
37425
  },