@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.
@@ -30656,6 +30656,31 @@ declare const batch: z.ZodObject<{
30656
30656
  max_override_period_minutes?: number | null | undefined;
30657
30657
  is_override_allowed?: boolean | undefined;
30658
30658
  }>, "many">>;
30659
+ noise_thresholds: z.ZodOptional<z.ZodArray<z.ZodObject<{
30660
+ noise_threshold_id: z.ZodString;
30661
+ device_id: z.ZodString;
30662
+ name: z.ZodString;
30663
+ noise_threshold_nrs: z.ZodOptional<z.ZodNumber>;
30664
+ starts_daily_at: z.ZodString;
30665
+ ends_daily_at: z.ZodString;
30666
+ noise_threshold_decibels: z.ZodNumber;
30667
+ }, "strip", z.ZodTypeAny, {
30668
+ name: string;
30669
+ device_id: string;
30670
+ noise_threshold_id: string;
30671
+ starts_daily_at: string;
30672
+ ends_daily_at: string;
30673
+ noise_threshold_decibels: number;
30674
+ noise_threshold_nrs?: number | undefined;
30675
+ }, {
30676
+ name: string;
30677
+ device_id: string;
30678
+ noise_threshold_id: string;
30679
+ starts_daily_at: string;
30680
+ ends_daily_at: string;
30681
+ noise_threshold_decibels: number;
30682
+ noise_threshold_nrs?: number | undefined;
30683
+ }>, "many">>;
30659
30684
  }, "strip", z.ZodTypeAny, {
30660
30685
  batch_type: "spaces" | "access_grants" | "access_methods" | "workspaces";
30661
30686
  thermostat_daily_programs?: {
@@ -34490,6 +34515,15 @@ declare const batch: z.ZodObject<{
34490
34515
  max_override_period_minutes?: number | null | undefined;
34491
34516
  is_override_allowed?: boolean | undefined;
34492
34517
  }[] | undefined;
34518
+ noise_thresholds?: {
34519
+ name: string;
34520
+ device_id: string;
34521
+ noise_threshold_id: string;
34522
+ starts_daily_at: string;
34523
+ ends_daily_at: string;
34524
+ noise_threshold_decibels: number;
34525
+ noise_threshold_nrs?: number | undefined;
34526
+ }[] | undefined;
34493
34527
  }, {
34494
34528
  batch_type: "spaces" | "access_grants" | "access_methods" | "workspaces";
34495
34529
  thermostat_daily_programs?: {
@@ -38324,6 +38358,15 @@ declare const batch: z.ZodObject<{
38324
38358
  max_override_period_minutes?: number | null | undefined;
38325
38359
  is_override_allowed?: boolean | undefined;
38326
38360
  }[] | undefined;
38361
+ noise_thresholds?: {
38362
+ name: string;
38363
+ device_id: string;
38364
+ noise_threshold_id: string;
38365
+ starts_daily_at: string;
38366
+ ends_daily_at: string;
38367
+ noise_threshold_decibels: number;
38368
+ noise_threshold_nrs?: number | undefined;
38369
+ }[] | undefined;
38327
38370
  }>;
38328
38371
  type Batch = z.infer<typeof batch>;
38329
38372
 
@@ -69116,6 +69159,12 @@ declare const _default: {
69116
69159
  };
69117
69160
  type: string;
69118
69161
  };
69162
+ noise_thresholds: {
69163
+ items: {
69164
+ $ref: string;
69165
+ };
69166
+ type: string;
69167
+ };
69119
69168
  spaces: {
69120
69169
  items: {
69121
69170
  $ref: string;
@@ -69361,6 +69410,12 @@ declare const _default: {
69361
69410
  };
69362
69411
  type: string;
69363
69412
  };
69413
+ noise_thresholds: {
69414
+ items: {
69415
+ $ref: string;
69416
+ };
69417
+ type: string;
69418
+ };
69364
69419
  spaces: {
69365
69420
  items: {
69366
69421
  $ref: string;
@@ -73731,6 +73786,9 @@ declare const _default: {
73731
73786
  'x-deprecated'?: never;
73732
73787
  items?: never;
73733
73788
  minLength?: never;
73789
+ default?: never;
73790
+ exclusiveMinimum?: never;
73791
+ minimum?: never;
73734
73792
  };
73735
73793
  } | {
73736
73794
  in: string;
@@ -73744,6 +73802,9 @@ declare const _default: {
73744
73802
  description?: never;
73745
73803
  items?: never;
73746
73804
  minLength?: never;
73805
+ default?: never;
73806
+ exclusiveMinimum?: never;
73807
+ minimum?: never;
73747
73808
  };
73748
73809
  } | {
73749
73810
  in: string;
@@ -73760,6 +73821,9 @@ declare const _default: {
73760
73821
  nullable?: never;
73761
73822
  'x-deprecated'?: never;
73762
73823
  minLength?: never;
73824
+ default?: never;
73825
+ exclusiveMinimum?: never;
73826
+ minimum?: never;
73763
73827
  };
73764
73828
  } | {
73765
73829
  in: string;
@@ -73773,6 +73837,41 @@ declare const _default: {
73773
73837
  nullable?: never;
73774
73838
  'x-deprecated'?: never;
73775
73839
  items?: never;
73840
+ default?: never;
73841
+ exclusiveMinimum?: never;
73842
+ minimum?: never;
73843
+ };
73844
+ } | {
73845
+ in: string;
73846
+ name: string;
73847
+ schema: {
73848
+ default: number;
73849
+ description: string;
73850
+ exclusiveMinimum: boolean;
73851
+ minimum: number;
73852
+ type: string;
73853
+ format?: never;
73854
+ deprecated?: never;
73855
+ nullable?: never;
73856
+ 'x-deprecated'?: never;
73857
+ items?: never;
73858
+ minLength?: never;
73859
+ };
73860
+ } | {
73861
+ in: string;
73862
+ name: string;
73863
+ schema: {
73864
+ description: string;
73865
+ nullable: boolean;
73866
+ type: string;
73867
+ format?: never;
73868
+ deprecated?: never;
73869
+ 'x-deprecated'?: never;
73870
+ items?: never;
73871
+ minLength?: never;
73872
+ default?: never;
73873
+ exclusiveMinimum?: never;
73874
+ minimum?: never;
73776
73875
  };
73777
73876
  })[];
73778
73877
  responses: {
@@ -73790,6 +73889,9 @@ declare const _default: {
73790
73889
  ok: {
73791
73890
  type: string;
73792
73891
  };
73892
+ pagination: {
73893
+ $ref: string;
73894
+ };
73793
73895
  };
73794
73896
  required: string[];
73795
73897
  type: string;
@@ -73885,6 +73987,13 @@ declare const _default: {
73885
73987
  format: string;
73886
73988
  type: string;
73887
73989
  };
73990
+ limit: {
73991
+ default: number;
73992
+ description: string;
73993
+ exclusiveMinimum: boolean;
73994
+ minimum: number;
73995
+ type: string;
73996
+ };
73888
73997
  location_id: {
73889
73998
  deprecated: boolean;
73890
73999
  format: string;
@@ -73892,6 +74001,11 @@ declare const _default: {
73892
74001
  type: string;
73893
74002
  'x-deprecated': string;
73894
74003
  };
74004
+ page_cursor: {
74005
+ description: string;
74006
+ nullable: boolean;
74007
+ type: string;
74008
+ };
73895
74009
  search: {
73896
74010
  description: string;
73897
74011
  minLength: number;
@@ -73923,6 +74037,9 @@ declare const _default: {
73923
74037
  ok: {
73924
74038
  type: string;
73925
74039
  };
74040
+ pagination: {
74041
+ $ref: string;
74042
+ };
73926
74043
  };
73927
74044
  required: string[];
73928
74045
  type: string;
@@ -99649,6 +99766,12 @@ declare const _default: {
99649
99766
  };
99650
99767
  type: string;
99651
99768
  };
99769
+ noise_thresholds: {
99770
+ items: {
99771
+ $ref: string;
99772
+ };
99773
+ type: string;
99774
+ };
99652
99775
  spaces: {
99653
99776
  items: {
99654
99777
  $ref: string;
@@ -99876,6 +99999,12 @@ declare const _default: {
99876
99999
  };
99877
100000
  type: string;
99878
100001
  };
100002
+ noise_thresholds: {
100003
+ items: {
100004
+ $ref: string;
100005
+ };
100006
+ type: string;
100007
+ };
99879
100008
  spaces: {
99880
100009
  items: {
99881
100010
  $ref: string;
@@ -120673,6 +120802,22 @@ type Routes = {
120673
120802
  message: string;
120674
120803
  }[];
120675
120804
  }[] | undefined;
120805
+ noise_thresholds?: {
120806
+ /** Unique identifier for the noise threshold. */
120807
+ noise_threshold_id: string;
120808
+ /** Unique identifier for the device that contains the noise threshold. */
120809
+ device_id: string;
120810
+ /** Name of the noise threshold. */
120811
+ name: string;
120812
+ /** 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). */
120813
+ noise_threshold_nrs?: number | undefined;
120814
+ /** Time at which the noise threshold should become active daily. */
120815
+ starts_daily_at: string;
120816
+ /** Time at which the noise threshold should become inactive daily. */
120817
+ ends_daily_at: string;
120818
+ /** Noise level in decibels for the noise threshold. */
120819
+ noise_threshold_decibels: number;
120820
+ }[] | undefined;
120676
120821
  };
120677
120822
  };
120678
120823
  };
@@ -125777,6 +125922,10 @@ type Routes = {
125777
125922
  acs_entrance_ids?: string[] | undefined;
125778
125923
  /** String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`. */
125779
125924
  search?: string | undefined;
125925
+ /** Maximum number of records to return per page. */
125926
+ limit?: number;
125927
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
125928
+ page_cursor?: (string | undefined) | null;
125780
125929
  };
125781
125930
  formData: {};
125782
125931
  jsonResponse: {
@@ -125888,6 +126037,15 @@ type Routes = {
125888
126037
  /** Indicates whether the ACS entrance can be unlocked with pin codes. */
125889
126038
  can_unlock_with_code?: boolean | undefined;
125890
126039
  }[];
126040
+ /** Information about the current page of results. */
126041
+ pagination: {
126042
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
126043
+ next_page_cursor: string | null;
126044
+ /** Indicates whether there is another page of results after this one. */
126045
+ has_next_page: boolean;
126046
+ /** URL to get the next page of results. */
126047
+ next_page_url: string | null;
126048
+ };
125891
126049
  };
125892
126050
  };
125893
126051
  '/acs/entrances/list_credentials_with_access': {
@@ -186610,6 +186768,22 @@ type Routes = {
186610
186768
  message: string;
186611
186769
  }[];
186612
186770
  }[] | undefined;
186771
+ noise_thresholds?: {
186772
+ /** Unique identifier for the noise threshold. */
186773
+ noise_threshold_id: string;
186774
+ /** Unique identifier for the device that contains the noise threshold. */
186775
+ device_id: string;
186776
+ /** Name of the noise threshold. */
186777
+ name: string;
186778
+ /** 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). */
186779
+ noise_threshold_nrs?: number | undefined;
186780
+ /** Time at which the noise threshold should become active daily. */
186781
+ starts_daily_at: string;
186782
+ /** Time at which the noise threshold should become inactive daily. */
186783
+ ends_daily_at: string;
186784
+ /** Noise level in decibels for the noise threshold. */
186785
+ noise_threshold_decibels: number;
186786
+ }[] | undefined;
186613
186787
  };
186614
186788
  };
186615
186789
  };
package/dist/index.cjs CHANGED
@@ -5139,6 +5139,28 @@ var instant_key = zod.z.object({
5139
5139
 
5140
5140
  There\u2019s no app to install, nor account to create. Your user just taps a link and gets a lightweight, native-feeling experience using iOS App Clip or Instant Apps on Android. Further, Instant Keys work offline, so even in areas with poor cellular or Wi-Fi, like elevator banks or concrete-walled hallways, the Instant Keys still work.
5141
5141
  `);
5142
+ var noise_threshold = zod.z.object({
5143
+ noise_threshold_id: zod.z.string().uuid().describe("Unique identifier for the noise threshold."),
5144
+ device_id: zod.z.string().uuid().describe(
5145
+ "Unique identifier for the device that contains the noise threshold."
5146
+ ),
5147
+ name: zod.z.string().describe("Name of the noise threshold."),
5148
+ noise_threshold_nrs: zod.z.number().optional().describe(
5149
+ "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)."
5150
+ ),
5151
+ starts_daily_at: zod.z.string().describe("Time at which the noise threshold should become active daily."),
5152
+ // TODO: zoned_time
5153
+ ends_daily_at: zod.z.string().describe(
5154
+ "Time at which the noise threshold should become inactive daily."
5155
+ ),
5156
+ // TODO: zoned_time
5157
+ noise_threshold_decibels: zod.z.number().describe("Noise level in decibels for the noise threshold.")
5158
+ }).describe(`
5159
+ ---
5160
+ route_path: /noise_sensors/noise_thresholds
5161
+ ---
5162
+ Represents a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.
5163
+ `);
5142
5164
  var space = zod.z.object({
5143
5165
  space_id: zod.z.string().uuid().describe("ID of the space."),
5144
5166
  workspace_id: zod.z.string().uuid().describe(
@@ -5341,7 +5363,8 @@ zod.z.object({
5341
5363
  access_codes: access_code.array().optional(),
5342
5364
  unmanaged_access_codes: unmanaged_access_code.array().optional(),
5343
5365
  thermostat_daily_programs: thermostat_daily_program.array().optional(),
5344
- thermostat_schedules: thermostat_schedule.array().optional()
5366
+ thermostat_schedules: thermostat_schedule.array().optional(),
5367
+ noise_thresholds: noise_threshold.array().optional()
5345
5368
  }).describe("A batch of workspace resources.");
5346
5369
  var batch = zod.z.object({
5347
5370
  batch_type: zod.z.enum([
@@ -5374,7 +5397,8 @@ var batch = zod.z.object({
5374
5397
  access_codes: access_code.array().optional(),
5375
5398
  unmanaged_access_codes: unmanaged_access_code.array().optional(),
5376
5399
  thermostat_daily_programs: thermostat_daily_program.array().optional(),
5377
- thermostat_schedules: thermostat_schedule.array().optional()
5400
+ thermostat_schedules: thermostat_schedule.array().optional(),
5401
+ noise_thresholds: noise_threshold.array().optional()
5378
5402
  }).describe("A batch of workspace resources.");
5379
5403
  var bridge = zod.z.object({
5380
5404
  bridge_id: zod.z.string().uuid().describe("ID of Seam Bridge."),
@@ -5469,28 +5493,6 @@ var customization_profile = zod.z.object({
5469
5493
  ---
5470
5494
  A customization profile.
5471
5495
  `);
5472
- var noise_threshold = zod.z.object({
5473
- noise_threshold_id: zod.z.string().uuid().describe("Unique identifier for the noise threshold."),
5474
- device_id: zod.z.string().uuid().describe(
5475
- "Unique identifier for the device that contains the noise threshold."
5476
- ),
5477
- name: zod.z.string().describe("Name of the noise threshold."),
5478
- noise_threshold_nrs: zod.z.number().optional().describe(
5479
- "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)."
5480
- ),
5481
- starts_daily_at: zod.z.string().describe("Time at which the noise threshold should become active daily."),
5482
- // TODO: zoned_time
5483
- ends_daily_at: zod.z.string().describe(
5484
- "Time at which the noise threshold should become inactive daily."
5485
- ),
5486
- // TODO: zoned_time
5487
- noise_threshold_decibels: zod.z.number().describe("Noise level in decibels for the noise threshold.")
5488
- }).describe(`
5489
- ---
5490
- route_path: /noise_sensors/noise_thresholds
5491
- ---
5492
- Represents a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.
5493
- `);
5494
5496
  var pagination = zod.z.object({
5495
5497
  next_page_cursor: zod.z.string().base64().nullable().describe(
5496
5498
  "Opaque value that can be used to select the next page of results via the `page_cursor` parameter."
@@ -31940,6 +31942,12 @@ var openapi_default = {
31940
31942
  items: { $ref: "#/components/schemas/instant_key" },
31941
31943
  type: "array"
31942
31944
  },
31945
+ noise_thresholds: {
31946
+ items: {
31947
+ $ref: "#/components/schemas/noise_threshold"
31948
+ },
31949
+ type: "array"
31950
+ },
31943
31951
  spaces: {
31944
31952
  items: { $ref: "#/components/schemas/space" },
31945
31953
  type: "array"
@@ -32147,6 +32155,12 @@ var openapi_default = {
32147
32155
  items: { $ref: "#/components/schemas/instant_key" },
32148
32156
  type: "array"
32149
32157
  },
32158
+ noise_thresholds: {
32159
+ items: {
32160
+ $ref: "#/components/schemas/noise_threshold"
32161
+ },
32162
+ type: "array"
32163
+ },
32150
32164
  spaces: {
32151
32165
  items: { $ref: "#/components/schemas/space" },
32152
32166
  type: "array"
@@ -35799,6 +35813,26 @@ var openapi_default = {
35799
35813
  minLength: 1,
35800
35814
  type: "string"
35801
35815
  }
35816
+ },
35817
+ {
35818
+ in: "query",
35819
+ name: "limit",
35820
+ schema: {
35821
+ default: 900,
35822
+ description: "Maximum number of records to return per page.",
35823
+ exclusiveMinimum: true,
35824
+ minimum: 0,
35825
+ type: "integer"
35826
+ }
35827
+ },
35828
+ {
35829
+ in: "query",
35830
+ name: "page_cursor",
35831
+ schema: {
35832
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
35833
+ nullable: true,
35834
+ type: "string"
35835
+ }
35802
35836
  }
35803
35837
  ],
35804
35838
  responses: {
@@ -35811,9 +35845,10 @@ var openapi_default = {
35811
35845
  items: { $ref: "#/components/schemas/acs_entrance" },
35812
35846
  type: "array"
35813
35847
  },
35814
- ok: { type: "boolean" }
35848
+ ok: { type: "boolean" },
35849
+ pagination: { $ref: "#/components/schemas/pagination" }
35815
35850
  },
35816
- required: ["acs_entrances", "ok"],
35851
+ required: ["acs_entrances", "pagination", "ok"],
35817
35852
  type: "object"
35818
35853
  }
35819
35854
  }
@@ -35876,6 +35911,13 @@ var openapi_default = {
35876
35911
  format: "uuid",
35877
35912
  type: "string"
35878
35913
  },
35914
+ limit: {
35915
+ default: 900,
35916
+ description: "Maximum number of records to return per page.",
35917
+ exclusiveMinimum: true,
35918
+ minimum: 0,
35919
+ type: "integer"
35920
+ },
35879
35921
  location_id: {
35880
35922
  deprecated: true,
35881
35923
  format: "uuid",
@@ -35883,6 +35925,11 @@ var openapi_default = {
35883
35925
  type: "string",
35884
35926
  "x-deprecated": "Use `space_id`."
35885
35927
  },
35928
+ page_cursor: {
35929
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
35930
+ nullable: true,
35931
+ type: "string"
35932
+ },
35886
35933
  search: {
35887
35934
  description: "String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`.",
35888
35935
  minLength: 1,
@@ -35909,9 +35956,10 @@ var openapi_default = {
35909
35956
  items: { $ref: "#/components/schemas/acs_entrance" },
35910
35957
  type: "array"
35911
35958
  },
35912
- ok: { type: "boolean" }
35959
+ ok: { type: "boolean" },
35960
+ pagination: { $ref: "#/components/schemas/pagination" }
35913
35961
  },
35914
- required: ["acs_entrances", "ok"],
35962
+ required: ["acs_entrances", "pagination", "ok"],
35915
35963
  type: "object"
35916
35964
  }
35917
35965
  }
@@ -58125,6 +58173,12 @@ var openapi_default = {
58125
58173
  items: { $ref: "#/components/schemas/instant_key" },
58126
58174
  type: "array"
58127
58175
  },
58176
+ noise_thresholds: {
58177
+ items: {
58178
+ $ref: "#/components/schemas/noise_threshold"
58179
+ },
58180
+ type: "array"
58181
+ },
58128
58182
  spaces: {
58129
58183
  items: { $ref: "#/components/schemas/space" },
58130
58184
  type: "array"
@@ -58312,6 +58366,12 @@ var openapi_default = {
58312
58366
  items: { $ref: "#/components/schemas/instant_key" },
58313
58367
  type: "array"
58314
58368
  },
58369
+ noise_thresholds: {
58370
+ items: {
58371
+ $ref: "#/components/schemas/noise_threshold"
58372
+ },
58373
+ type: "array"
58374
+ },
58315
58375
  spaces: {
58316
58376
  items: { $ref: "#/components/schemas/space" },
58317
58377
  type: "array"