@seamapi/types 1.370.3 → 1.372.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.
@@ -15006,6 +15006,10 @@ export interface Routes {
15006
15006
  user_identifier_key?: string | undefined;
15007
15007
  /** Returns accounts whose custom_metadata contains all of the provided key/value pairs. */
15008
15008
  custom_metadata_has?: Record<string, string | boolean> | undefined;
15009
+ /** Maximum number of records to return per page. */
15010
+ limit?: number;
15011
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
15012
+ page_cursor?: (string | undefined) | null;
15009
15013
  };
15010
15014
  formData: {};
15011
15015
  jsonResponse: {
@@ -15081,6 +15085,15 @@ export interface Routes {
15081
15085
  custom_metadata: Record<string, string | boolean>;
15082
15086
  automatically_manage_new_devices: boolean;
15083
15087
  }>;
15088
+ /** Information about the current page of results. */
15089
+ pagination: {
15090
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
15091
+ next_page_cursor: string | null;
15092
+ /** Indicates whether there is another page of results after this one. */
15093
+ has_next_page: boolean;
15094
+ /** URL to get the next page of results. */
15095
+ next_page_url: string | null;
15096
+ };
15084
15097
  };
15085
15098
  };
15086
15099
  '/connected_accounts/update': {
@@ -33962,11 +33975,11 @@ export interface Routes {
33962
33975
  /** ID of the Connect Webview by which to filter devices. */
33963
33976
  connect_webview_id?: string | undefined;
33964
33977
  /** Device type by which to filter devices. */
33965
- 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' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat') | ('ios_phone' | 'android_phone')) | undefined;
33978
+ device_type?: ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat') | undefined;
33966
33979
  /** Array of device types by which to filter devices. */
33967
- device_types?: Array<('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' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat') | ('ios_phone' | 'android_phone')> | undefined;
33980
+ device_types?: Array<'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat'> | undefined;
33968
33981
  /** Manufacturer by which to filter devices. */
33969
- manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo' | 'akiles' | 'tado') | undefined;
33982
+ manufacturer?: ('ecobee' | 'nest' | 'honeywell_resideo' | 'tado') | undefined;
33970
33983
  /** Array of device IDs by which to filter devices. */
33971
33984
  device_ids?: string[] | undefined;
33972
33985
  /** Numerical limit on the number of devices to return. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.370.3",
3
+ "version": "1.372.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -92,7 +92,7 @@
92
92
  "zod": "^3.24.0"
93
93
  },
94
94
  "devDependencies": {
95
- "@seamapi/blueprint": "^0.37.1",
95
+ "@seamapi/blueprint": "^0.38.0",
96
96
  "@types/node": "^20.8.10",
97
97
  "concurrently": "^8.2.0",
98
98
  "del-cli": "^5.0.0",
@@ -22305,6 +22305,20 @@ export default {
22305
22305
  'Returns accounts whose custom_metadata contains all of the provided key/value pairs.',
22306
22306
  type: 'object',
22307
22307
  },
22308
+ limit: {
22309
+ default: 11_000,
22310
+ description:
22311
+ 'Maximum number of records to return per page.',
22312
+ exclusiveMinimum: true,
22313
+ minimum: 0,
22314
+ type: 'integer',
22315
+ },
22316
+ page_cursor: {
22317
+ description:
22318
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
22319
+ nullable: true,
22320
+ type: 'string',
22321
+ },
22308
22322
  user_identifier_key: {
22309
22323
  description:
22310
22324
  'Returns accounts that can be accessed by the provided user_identifier_key.',
@@ -22327,8 +22341,9 @@ export default {
22327
22341
  type: 'array',
22328
22342
  },
22329
22343
  ok: { type: 'boolean' },
22344
+ pagination: { $ref: '#/components/schemas/pagination' },
22330
22345
  },
22331
- required: ['connected_accounts', 'ok'],
22346
+ required: ['connected_accounts', 'pagination', 'ok'],
22332
22347
  type: 'object',
22333
22348
  },
22334
22349
  },
@@ -26944,115 +26959,25 @@ export default {
26944
26959
  },
26945
26960
  device_type: {
26946
26961
  description: 'Device type by which to filter devices.',
26947
- oneOf: [
26948
- {
26949
- enum: [
26950
- 'akuvox_lock',
26951
- 'august_lock',
26952
- 'brivo_access_point',
26953
- 'butterflymx_panel',
26954
- 'avigilon_alta_entry',
26955
- 'doorking_lock',
26956
- 'genie_door',
26957
- 'igloo_lock',
26958
- 'linear_lock',
26959
- 'lockly_lock',
26960
- 'kwikset_lock',
26961
- 'nuki_lock',
26962
- 'salto_lock',
26963
- 'schlage_lock',
26964
- 'seam_relay',
26965
- 'smartthings_lock',
26966
- 'wyze_lock',
26967
- 'yale_lock',
26968
- 'two_n_intercom',
26969
- 'controlbyweb_device',
26970
- 'ttlock_lock',
26971
- 'igloohome_lock',
26972
- 'hubitat_lock',
26973
- 'four_suites_door',
26974
- 'dormakaba_oracode_door',
26975
- 'tedee_lock',
26976
- 'akiles_lock',
26977
- ],
26978
- type: 'string',
26979
- },
26980
- {
26981
- enum: ['noiseaware_activity_zone', 'minut_sensor'],
26982
- type: 'string',
26983
- },
26984
- {
26985
- enum: [
26986
- 'ecobee_thermostat',
26987
- 'nest_thermostat',
26988
- 'honeywell_resideo_thermostat',
26989
- 'tado_thermostat',
26990
- ],
26991
- type: 'string',
26992
- },
26993
- {
26994
- description: 'Type of phone.',
26995
- enum: ['ios_phone', 'android_phone'],
26996
- type: 'string',
26997
- },
26962
+ enum: [
26963
+ 'ecobee_thermostat',
26964
+ 'nest_thermostat',
26965
+ 'honeywell_resideo_thermostat',
26966
+ 'tado_thermostat',
26998
26967
  ],
26968
+ type: 'string',
26999
26969
  },
27000
26970
  device_types: {
27001
26971
  description:
27002
26972
  'Array of device types by which to filter devices.',
27003
26973
  items: {
27004
- oneOf: [
27005
- {
27006
- enum: [
27007
- 'akuvox_lock',
27008
- 'august_lock',
27009
- 'brivo_access_point',
27010
- 'butterflymx_panel',
27011
- 'avigilon_alta_entry',
27012
- 'doorking_lock',
27013
- 'genie_door',
27014
- 'igloo_lock',
27015
- 'linear_lock',
27016
- 'lockly_lock',
27017
- 'kwikset_lock',
27018
- 'nuki_lock',
27019
- 'salto_lock',
27020
- 'schlage_lock',
27021
- 'seam_relay',
27022
- 'smartthings_lock',
27023
- 'wyze_lock',
27024
- 'yale_lock',
27025
- 'two_n_intercom',
27026
- 'controlbyweb_device',
27027
- 'ttlock_lock',
27028
- 'igloohome_lock',
27029
- 'hubitat_lock',
27030
- 'four_suites_door',
27031
- 'dormakaba_oracode_door',
27032
- 'tedee_lock',
27033
- 'akiles_lock',
27034
- ],
27035
- type: 'string',
27036
- },
27037
- {
27038
- enum: ['noiseaware_activity_zone', 'minut_sensor'],
27039
- type: 'string',
27040
- },
27041
- {
27042
- enum: [
27043
- 'ecobee_thermostat',
27044
- 'nest_thermostat',
27045
- 'honeywell_resideo_thermostat',
27046
- 'tado_thermostat',
27047
- ],
27048
- type: 'string',
27049
- },
27050
- {
27051
- description: 'Type of phone.',
27052
- enum: ['ios_phone', 'android_phone'],
27053
- type: 'string',
27054
- },
26974
+ enum: [
26975
+ 'ecobee_thermostat',
26976
+ 'nest_thermostat',
26977
+ 'honeywell_resideo_thermostat',
26978
+ 'tado_thermostat',
27055
26979
  ],
26980
+ type: 'string',
27056
26981
  },
27057
26982
  type: 'array',
27058
26983
  },
@@ -27105,44 +27030,7 @@ export default {
27105
27030
  },
27106
27031
  manufacturer: {
27107
27032
  description: 'Manufacturer by which to filter devices.',
27108
- enum: [
27109
- 'akuvox',
27110
- 'august',
27111
- 'avigilon_alta',
27112
- 'brivo',
27113
- 'butterflymx',
27114
- 'doorking',
27115
- 'four_suites',
27116
- 'genie',
27117
- 'igloo',
27118
- 'keywe',
27119
- 'kwikset',
27120
- 'linear',
27121
- 'lockly',
27122
- 'nuki',
27123
- 'philia',
27124
- 'salto',
27125
- 'samsung',
27126
- 'schlage',
27127
- 'seam',
27128
- 'unknown',
27129
- 'wyze',
27130
- 'yale',
27131
- 'minut',
27132
- 'two_n',
27133
- 'ttlock',
27134
- 'nest',
27135
- 'igloohome',
27136
- 'ecobee',
27137
- 'hubitat',
27138
- 'controlbyweb',
27139
- 'smartthings',
27140
- 'dormakaba_oracode',
27141
- 'tedee',
27142
- 'honeywell_resideo',
27143
- 'akiles',
27144
- 'tado',
27145
- ],
27033
+ enum: ['ecobee', 'nest', 'honeywell_resideo', 'tado'],
27146
27034
  type: 'string',
27147
27035
  },
27148
27036
  unstable_location_id: {
@@ -17673,6 +17673,10 @@ export interface Routes {
17673
17673
  user_identifier_key?: string | undefined
17674
17674
  /** Returns accounts whose custom_metadata contains all of the provided key/value pairs. */
17675
17675
  custom_metadata_has?: Record<string, string | boolean> | undefined
17676
+ /** Maximum number of records to return per page. */
17677
+ limit?: number
17678
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
17679
+ page_cursor?: (string | undefined) | null
17676
17680
  }
17677
17681
  formData: {}
17678
17682
  jsonResponse: {
@@ -17758,6 +17762,15 @@ export interface Routes {
17758
17762
  custom_metadata: Record<string, string | boolean>
17759
17763
  automatically_manage_new_devices: boolean
17760
17764
  }>
17765
+ /** Information about the current page of results. */
17766
+ pagination: {
17767
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
17768
+ next_page_cursor: string | null
17769
+ /** Indicates whether there is another page of results after this one. */
17770
+ has_next_page: boolean
17771
+ /** URL to get the next page of results. */
17772
+ next_page_url: string | null
17773
+ }
17761
17774
  }
17762
17775
  }
17763
17776
  '/connected_accounts/update': {
@@ -41320,127 +41333,24 @@ export interface Routes {
41320
41333
  /** Device type by which to filter devices. */
41321
41334
  device_type?:
41322
41335
  | (
41323
- | (
41324
- | 'akuvox_lock'
41325
- | 'august_lock'
41326
- | 'brivo_access_point'
41327
- | 'butterflymx_panel'
41328
- | 'avigilon_alta_entry'
41329
- | 'doorking_lock'
41330
- | 'genie_door'
41331
- | 'igloo_lock'
41332
- | 'linear_lock'
41333
- | 'lockly_lock'
41334
- | 'kwikset_lock'
41335
- | 'nuki_lock'
41336
- | 'salto_lock'
41337
- | 'schlage_lock'
41338
- | 'seam_relay'
41339
- | 'smartthings_lock'
41340
- | 'wyze_lock'
41341
- | 'yale_lock'
41342
- | 'two_n_intercom'
41343
- | 'controlbyweb_device'
41344
- | 'ttlock_lock'
41345
- | 'igloohome_lock'
41346
- | 'hubitat_lock'
41347
- | 'four_suites_door'
41348
- | 'dormakaba_oracode_door'
41349
- | 'tedee_lock'
41350
- | 'akiles_lock'
41351
- )
41352
- | ('noiseaware_activity_zone' | 'minut_sensor')
41353
- | (
41354
- | 'ecobee_thermostat'
41355
- | 'nest_thermostat'
41356
- | 'honeywell_resideo_thermostat'
41357
- | 'tado_thermostat'
41358
- )
41359
- | ('ios_phone' | 'android_phone')
41336
+ | 'ecobee_thermostat'
41337
+ | 'nest_thermostat'
41338
+ | 'honeywell_resideo_thermostat'
41339
+ | 'tado_thermostat'
41360
41340
  )
41361
41341
  | undefined
41362
41342
  /** Array of device types by which to filter devices. */
41363
41343
  device_types?:
41364
41344
  | Array<
41365
- | (
41366
- | 'akuvox_lock'
41367
- | 'august_lock'
41368
- | 'brivo_access_point'
41369
- | 'butterflymx_panel'
41370
- | 'avigilon_alta_entry'
41371
- | 'doorking_lock'
41372
- | 'genie_door'
41373
- | 'igloo_lock'
41374
- | 'linear_lock'
41375
- | 'lockly_lock'
41376
- | 'kwikset_lock'
41377
- | 'nuki_lock'
41378
- | 'salto_lock'
41379
- | 'schlage_lock'
41380
- | 'seam_relay'
41381
- | 'smartthings_lock'
41382
- | 'wyze_lock'
41383
- | 'yale_lock'
41384
- | 'two_n_intercom'
41385
- | 'controlbyweb_device'
41386
- | 'ttlock_lock'
41387
- | 'igloohome_lock'
41388
- | 'hubitat_lock'
41389
- | 'four_suites_door'
41390
- | 'dormakaba_oracode_door'
41391
- | 'tedee_lock'
41392
- | 'akiles_lock'
41393
- )
41394
- | ('noiseaware_activity_zone' | 'minut_sensor')
41395
- | (
41396
- | 'ecobee_thermostat'
41397
- | 'nest_thermostat'
41398
- | 'honeywell_resideo_thermostat'
41399
- | 'tado_thermostat'
41400
- )
41401
- | ('ios_phone' | 'android_phone')
41345
+ | 'ecobee_thermostat'
41346
+ | 'nest_thermostat'
41347
+ | 'honeywell_resideo_thermostat'
41348
+ | 'tado_thermostat'
41402
41349
  >
41403
41350
  | undefined
41404
41351
  /** Manufacturer by which to filter devices. */
41405
41352
  manufacturer?:
41406
- | (
41407
- | 'akuvox'
41408
- | 'august'
41409
- | 'avigilon_alta'
41410
- | 'brivo'
41411
- | 'butterflymx'
41412
- | 'doorking'
41413
- | 'four_suites'
41414
- | 'genie'
41415
- | 'igloo'
41416
- | 'keywe'
41417
- | 'kwikset'
41418
- | 'linear'
41419
- | 'lockly'
41420
- | 'nuki'
41421
- | 'philia'
41422
- | 'salto'
41423
- | 'samsung'
41424
- | 'schlage'
41425
- | 'seam'
41426
- | 'unknown'
41427
- | 'wyze'
41428
- | 'yale'
41429
- | 'minut'
41430
- | 'two_n'
41431
- | 'ttlock'
41432
- | 'nest'
41433
- | 'igloohome'
41434
- | 'ecobee'
41435
- | 'hubitat'
41436
- | 'controlbyweb'
41437
- | 'smartthings'
41438
- | 'dormakaba_oracode'
41439
- | 'tedee'
41440
- | 'honeywell_resideo'
41441
- | 'akiles'
41442
- | 'tado'
41443
- )
41353
+ | ('ecobee' | 'nest' | 'honeywell_resideo' | 'tado')
41444
41354
  | undefined
41445
41355
  /** Array of device IDs by which to filter devices. */
41446
41356
  device_ids?: string[] | undefined