@seamapi/types 1.497.0 → 1.499.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.
@@ -20145,6 +20145,22 @@ export type Routes = {
20145
20145
  message: string;
20146
20146
  }[];
20147
20147
  }[] | undefined;
20148
+ noise_thresholds?: {
20149
+ /** Unique identifier for the noise threshold. */
20150
+ noise_threshold_id: string;
20151
+ /** Unique identifier for the device that contains the noise threshold. */
20152
+ device_id: string;
20153
+ /** Name of the noise threshold. */
20154
+ name: string;
20155
+ /** Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors). */
20156
+ noise_threshold_nrs?: number | undefined;
20157
+ /** Time at which the noise threshold should become active daily. */
20158
+ starts_daily_at: string;
20159
+ /** Time at which the noise threshold should become inactive daily. */
20160
+ ends_daily_at: string;
20161
+ /** Noise level in decibels for the noise threshold. */
20162
+ noise_threshold_decibels: number;
20163
+ }[] | undefined;
20148
20164
  };
20149
20165
  };
20150
20166
  };
@@ -25249,6 +25265,10 @@ export type Routes = {
25249
25265
  acs_entrance_ids?: string[] | undefined;
25250
25266
  /** String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`. */
25251
25267
  search?: string | undefined;
25268
+ /** Maximum number of records to return per page. */
25269
+ limit?: number;
25270
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
25271
+ page_cursor?: (string | undefined) | null;
25252
25272
  };
25253
25273
  formData: {};
25254
25274
  jsonResponse: {
@@ -25360,6 +25380,15 @@ export type Routes = {
25360
25380
  /** Indicates whether the ACS entrance can be unlocked with pin codes. */
25361
25381
  can_unlock_with_code?: boolean | undefined;
25362
25382
  }[];
25383
+ /** Information about the current page of results. */
25384
+ pagination: {
25385
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
25386
+ next_page_cursor: string | null;
25387
+ /** Indicates whether there is another page of results after this one. */
25388
+ has_next_page: boolean;
25389
+ /** URL to get the next page of results. */
25390
+ next_page_url: string | null;
25391
+ };
25363
25392
  };
25364
25393
  };
25365
25394
  '/acs/entrances/list_credentials_with_access': {
@@ -86082,6 +86111,22 @@ export type Routes = {
86082
86111
  message: string;
86083
86112
  }[];
86084
86113
  }[] | undefined;
86114
+ noise_thresholds?: {
86115
+ /** Unique identifier for the noise threshold. */
86116
+ noise_threshold_id: string;
86117
+ /** Unique identifier for the device that contains the noise threshold. */
86118
+ device_id: string;
86119
+ /** Name of the noise threshold. */
86120
+ name: string;
86121
+ /** Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors). */
86122
+ noise_threshold_nrs?: number | undefined;
86123
+ /** Time at which the noise threshold should become active daily. */
86124
+ starts_daily_at: string;
86125
+ /** Time at which the noise threshold should become inactive daily. */
86126
+ ends_daily_at: string;
86127
+ /** Noise level in decibels for the noise threshold. */
86128
+ noise_threshold_decibels: number;
86129
+ }[] | undefined;
86085
86130
  };
86086
86131
  };
86087
86132
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.497.0",
3
+ "version": "1.499.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -22,6 +22,7 @@ import { device } from './devices/index.js'
22
22
  import { unmanaged_device } from './devices/unmanaged-device.js'
23
23
  import { seam_event } from './events/seam-event.js'
24
24
  import { instant_key } from './instant-keys/instant-key.js'
25
+ import { noise_threshold } from './noise-sensors/noise-threshold.js'
25
26
  import { space } from './spaces/index.js'
26
27
  import {
27
28
  thermostat_daily_program,
@@ -88,6 +89,7 @@ export const workspaces_batch = z
88
89
  unmanaged_access_codes: unmanaged_access_code.array().optional(),
89
90
  thermostat_daily_programs: thermostat_daily_program.array().optional(),
90
91
  thermostat_schedules: thermostat_schedule.array().optional(),
92
+ noise_thresholds: noise_threshold.array().optional(),
91
93
  })
92
94
  .describe('A batch of workspace resources.')
93
95
 
@@ -124,6 +126,7 @@ export const batch = z
124
126
  unmanaged_access_codes: unmanaged_access_code.array().optional(),
125
127
  thermostat_daily_programs: thermostat_daily_program.array().optional(),
126
128
  thermostat_schedules: thermostat_schedule.array().optional(),
129
+ noise_thresholds: noise_threshold.array().optional(),
127
130
  })
128
131
  .describe('A batch of workspace resources.')
129
132
 
@@ -29281,6 +29281,12 @@ export default {
29281
29281
  items: { $ref: '#/components/schemas/instant_key' },
29282
29282
  type: 'array',
29283
29283
  },
29284
+ noise_thresholds: {
29285
+ items: {
29286
+ $ref: '#/components/schemas/noise_threshold',
29287
+ },
29288
+ type: 'array',
29289
+ },
29284
29290
  spaces: {
29285
29291
  items: { $ref: '#/components/schemas/space' },
29286
29292
  type: 'array',
@@ -29490,6 +29496,12 @@ export default {
29490
29496
  items: { $ref: '#/components/schemas/instant_key' },
29491
29497
  type: 'array',
29492
29498
  },
29499
+ noise_thresholds: {
29500
+ items: {
29501
+ $ref: '#/components/schemas/noise_threshold',
29502
+ },
29503
+ type: 'array',
29504
+ },
29493
29505
  spaces: {
29494
29506
  items: { $ref: '#/components/schemas/space' },
29495
29507
  type: 'array',
@@ -33333,6 +33345,27 @@ export default {
33333
33345
  type: 'string',
33334
33346
  },
33335
33347
  },
33348
+ {
33349
+ in: 'query',
33350
+ name: 'limit',
33351
+ schema: {
33352
+ default: 900,
33353
+ description: 'Maximum number of records to return per page.',
33354
+ exclusiveMinimum: true,
33355
+ minimum: 0,
33356
+ type: 'integer',
33357
+ },
33358
+ },
33359
+ {
33360
+ in: 'query',
33361
+ name: 'page_cursor',
33362
+ schema: {
33363
+ description:
33364
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
33365
+ nullable: true,
33366
+ type: 'string',
33367
+ },
33368
+ },
33336
33369
  ],
33337
33370
  responses: {
33338
33371
  200: {
@@ -33345,8 +33378,9 @@ export default {
33345
33378
  type: 'array',
33346
33379
  },
33347
33380
  ok: { type: 'boolean' },
33381
+ pagination: { $ref: '#/components/schemas/pagination' },
33348
33382
  },
33349
- required: ['acs_entrances', 'ok'],
33383
+ required: ['acs_entrances', 'pagination', 'ok'],
33350
33384
  type: 'object',
33351
33385
  },
33352
33386
  },
@@ -33416,6 +33450,14 @@ export default {
33416
33450
  format: 'uuid',
33417
33451
  type: 'string',
33418
33452
  },
33453
+ limit: {
33454
+ default: 900,
33455
+ description:
33456
+ 'Maximum number of records to return per page.',
33457
+ exclusiveMinimum: true,
33458
+ minimum: 0,
33459
+ type: 'integer',
33460
+ },
33419
33461
  location_id: {
33420
33462
  deprecated: true,
33421
33463
  format: 'uuid',
@@ -33423,6 +33465,12 @@ export default {
33423
33465
  type: 'string',
33424
33466
  'x-deprecated': 'Use `space_id`.',
33425
33467
  },
33468
+ page_cursor: {
33469
+ description:
33470
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
33471
+ nullable: true,
33472
+ type: 'string',
33473
+ },
33426
33474
  search: {
33427
33475
  description:
33428
33476
  'String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`.',
@@ -33452,8 +33500,9 @@ export default {
33452
33500
  type: 'array',
33453
33501
  },
33454
33502
  ok: { type: 'boolean' },
33503
+ pagination: { $ref: '#/components/schemas/pagination' },
33455
33504
  },
33456
- required: ['acs_entrances', 'ok'],
33505
+ required: ['acs_entrances', 'pagination', 'ok'],
33457
33506
  type: 'object',
33458
33507
  },
33459
33508
  },
@@ -56857,6 +56906,12 @@ export default {
56857
56906
  items: { $ref: '#/components/schemas/instant_key' },
56858
56907
  type: 'array',
56859
56908
  },
56909
+ noise_thresholds: {
56910
+ items: {
56911
+ $ref: '#/components/schemas/noise_threshold',
56912
+ },
56913
+ type: 'array',
56914
+ },
56860
56915
  spaces: {
56861
56916
  items: { $ref: '#/components/schemas/space' },
56862
56917
  type: 'array',
@@ -57044,6 +57099,12 @@ export default {
57044
57099
  items: { $ref: '#/components/schemas/instant_key' },
57045
57100
  type: 'array',
57046
57101
  },
57102
+ noise_thresholds: {
57103
+ items: {
57104
+ $ref: '#/components/schemas/noise_threshold',
57105
+ },
57106
+ type: 'array',
57107
+ },
57047
57108
  spaces: {
57048
57109
  items: { $ref: '#/components/schemas/space' },
57049
57110
  type: 'array',
@@ -23364,6 +23364,24 @@ export type Routes = {
23364
23364
  }[]
23365
23365
  }[]
23366
23366
  | undefined
23367
+ noise_thresholds?:
23368
+ | {
23369
+ /** Unique identifier for the noise threshold. */
23370
+ noise_threshold_id: string
23371
+ /** Unique identifier for the device that contains the noise threshold. */
23372
+ device_id: string
23373
+ /** Name of the noise threshold. */
23374
+ name: string
23375
+ /** Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors). */
23376
+ noise_threshold_nrs?: number | undefined
23377
+ /** Time at which the noise threshold should become active daily. */
23378
+ starts_daily_at: string
23379
+ /** Time at which the noise threshold should become inactive daily. */
23380
+ ends_daily_at: string
23381
+ /** Noise level in decibels for the noise threshold. */
23382
+ noise_threshold_decibels: number
23383
+ }[]
23384
+ | undefined
23367
23385
  }
23368
23386
  }
23369
23387
  }
@@ -29258,6 +29276,10 @@ export type Routes = {
29258
29276
  acs_entrance_ids?: string[] | undefined
29259
29277
  /** String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`. */
29260
29278
  search?: string | undefined
29279
+ /** Maximum number of records to return per page. */
29280
+ limit?: number
29281
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
29282
+ page_cursor?: (string | undefined) | null
29261
29283
  }
29262
29284
  formData: {}
29263
29285
  jsonResponse: {
@@ -29394,6 +29416,15 @@ export type Routes = {
29394
29416
  /** Indicates whether the ACS entrance can be unlocked with pin codes. */
29395
29417
  can_unlock_with_code?: boolean | undefined
29396
29418
  }[]
29419
+ /** Information about the current page of results. */
29420
+ pagination: {
29421
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
29422
+ next_page_cursor: string | null
29423
+ /** Indicates whether there is another page of results after this one. */
29424
+ has_next_page: boolean
29425
+ /** URL to get the next page of results. */
29426
+ next_page_url: string | null
29427
+ }
29397
29428
  }
29398
29429
  }
29399
29430
  '/acs/entrances/list_credentials_with_access': {
@@ -102154,6 +102185,24 @@ export type Routes = {
102154
102185
  }[]
102155
102186
  }[]
102156
102187
  | undefined
102188
+ noise_thresholds?:
102189
+ | {
102190
+ /** Unique identifier for the noise threshold. */
102191
+ noise_threshold_id: string
102192
+ /** Unique identifier for the device that contains the noise threshold. */
102193
+ device_id: string
102194
+ /** Name of the noise threshold. */
102195
+ name: string
102196
+ /** Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors). */
102197
+ noise_threshold_nrs?: number | undefined
102198
+ /** Time at which the noise threshold should become active daily. */
102199
+ starts_daily_at: string
102200
+ /** Time at which the noise threshold should become inactive daily. */
102201
+ ends_daily_at: string
102202
+ /** Noise level in decibels for the noise threshold. */
102203
+ noise_threshold_decibels: number
102204
+ }[]
102205
+ | undefined
102157
102206
  }
102158
102207
  }
102159
102208
  }