@seamapi/types 1.781.0 → 1.783.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.
@@ -10785,6 +10785,8 @@ export type Routes = {
10785
10785
  device_count: number;
10786
10786
  /** Number of entrances in the space. */
10787
10787
  acs_entrance_count: number;
10788
+ /** Customer key associated with the space. */
10789
+ customer_key?: string | undefined;
10788
10790
  /** */
10789
10791
  parent_space_id?: string | undefined;
10790
10792
  /** */
@@ -15101,6 +15103,8 @@ export type Routes = {
15101
15103
  device_count: number;
15102
15104
  /** Number of entrances in the space. */
15103
15105
  acs_entrance_count: number;
15106
+ /** Customer key associated with the space. */
15107
+ customer_key?: string | undefined;
15104
15108
  /** */
15105
15109
  parent_space_id?: string | undefined;
15106
15110
  /** */
@@ -66730,6 +66734,8 @@ export type Routes = {
66730
66734
  device_count: number;
66731
66735
  /** Number of entrances in the space. */
66732
66736
  acs_entrance_count: number;
66737
+ /** Customer key associated with the space. */
66738
+ customer_key?: string | undefined;
66733
66739
  /** */
66734
66740
  parent_space_id?: string | undefined;
66735
66741
  /** */
@@ -66770,6 +66776,8 @@ export type Routes = {
66770
66776
  device_count: number;
66771
66777
  /** Number of entrances in the space. */
66772
66778
  acs_entrance_count: number;
66779
+ /** Customer key associated with the space. */
66780
+ customer_key?: string | undefined;
66773
66781
  /** */
66774
66782
  parent_space_id?: string | undefined;
66775
66783
  /** */
@@ -67791,6 +67799,8 @@ export type Routes = {
67791
67799
  device_count: number;
67792
67800
  /** Number of entrances in the space. */
67793
67801
  acs_entrance_count: number;
67802
+ /** Customer key associated with the space. */
67803
+ customer_key?: string | undefined;
67794
67804
  /** */
67795
67805
  parent_space_id?: string | undefined;
67796
67806
  /** */
@@ -67844,6 +67854,8 @@ export type Routes = {
67844
67854
  device_count: number;
67845
67855
  /** Number of entrances in the space. */
67846
67856
  acs_entrance_count: number;
67857
+ /** Customer key associated with the space. */
67858
+ customer_key?: string | undefined;
67847
67859
  /** */
67848
67860
  parent_space_id?: string | undefined;
67849
67861
  /** */
@@ -67886,6 +67898,8 @@ export type Routes = {
67886
67898
  device_count: number;
67887
67899
  /** Number of entrances in the space. */
67888
67900
  acs_entrance_count: number;
67901
+ /** Customer key associated with the space. */
67902
+ customer_key?: string | undefined;
67889
67903
  /** */
67890
67904
  parent_space_id?: string | undefined;
67891
67905
  /** */
@@ -69722,12 +69736,16 @@ export type Routes = {
69722
69736
  commonParams: {
69723
69737
  /** Customer key for which you want to list spaces. */
69724
69738
  customer_key?: string | undefined;
69725
- /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. */
69739
+ /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`. */
69726
69740
  search?: string | undefined;
69727
69741
  /** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
69728
69742
  connected_account_id?: string | undefined;
69729
69743
  /** Filter spaces by space_key. */
69730
69744
  space_key?: string | undefined;
69745
+ /** Maximum number of records to return per page. */
69746
+ limit?: number;
69747
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
69748
+ page_cursor?: (string | undefined) | null;
69731
69749
  };
69732
69750
  formData: {};
69733
69751
  jsonResponse: {
@@ -69748,11 +69766,22 @@ export type Routes = {
69748
69766
  device_count: number;
69749
69767
  /** Number of entrances in the space. */
69750
69768
  acs_entrance_count: number;
69769
+ /** Customer key associated with the space. */
69770
+ customer_key?: string | undefined;
69751
69771
  /** */
69752
69772
  parent_space_id?: string | undefined;
69753
69773
  /** */
69754
69774
  parent_space_key?: string | undefined;
69755
69775
  }[];
69776
+ /** Information about the current page of results. */
69777
+ pagination: {
69778
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
69779
+ next_page_cursor: string | null;
69780
+ /** Indicates whether there is another page of results after this one. */
69781
+ has_next_page: boolean;
69782
+ /** URL to get the next page of results. */
69783
+ next_page_url: string | null;
69784
+ };
69756
69785
  };
69757
69786
  maxDuration: undefined;
69758
69787
  };
@@ -69825,6 +69854,8 @@ export type Routes = {
69825
69854
  device_count: number;
69826
69855
  /** Number of entrances in the space. */
69827
69856
  acs_entrance_count: number;
69857
+ /** Customer key associated with the space. */
69858
+ customer_key?: string | undefined;
69828
69859
  /** */
69829
69860
  parent_space_id?: string | undefined;
69830
69861
  /** */
@@ -94983,6 +95014,8 @@ export type Routes = {
94983
95014
  device_count: number;
94984
95015
  /** Number of entrances in the space. */
94985
95016
  acs_entrance_count: number;
95017
+ /** Customer key associated with the space. */
95018
+ customer_key?: string | undefined;
94986
95019
  /** */
94987
95020
  parent_space_id?: string | undefined;
94988
95021
  /** */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.781.0",
3
+ "version": "1.783.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -20,6 +20,10 @@ export const space = z.object({
20
20
  .describe('Date and time at which the space was created.'),
21
21
  device_count: z.number().describe('Number of devices in the space.'),
22
22
  acs_entrance_count: z.number().describe('Number of entrances in the space.'),
23
+ customer_key: z
24
+ .string()
25
+ .optional()
26
+ .describe('Customer key associated with the space.'),
23
27
  parent_space_id: z.string().uuid().optional().describe(`
24
28
  ---
25
29
  undocumented: Only used internally.
@@ -25394,6 +25394,10 @@ export default {
25394
25394
  format: 'date-time',
25395
25395
  type: 'string',
25396
25396
  },
25397
+ customer_key: {
25398
+ description: 'Customer key associated with the space.',
25399
+ type: 'string',
25400
+ },
25397
25401
  device_count: {
25398
25402
  description: 'Number of devices in the space.',
25399
25403
  format: 'float',
@@ -72936,7 +72940,7 @@ export default {
72936
72940
  name: 'search',
72937
72941
  schema: {
72938
72942
  description:
72939
- 'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.',
72943
+ 'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`.',
72940
72944
  minLength: 1,
72941
72945
  type: 'string',
72942
72946
  },
@@ -72961,6 +72965,26 @@ export default {
72961
72965
  type: 'string',
72962
72966
  },
72963
72967
  },
72968
+ {
72969
+ in: 'query',
72970
+ name: 'limit',
72971
+ schema: {
72972
+ default: 500,
72973
+ description: 'Maximum number of records to return per page.',
72974
+ format: 'float',
72975
+ type: 'number',
72976
+ },
72977
+ },
72978
+ {
72979
+ in: 'query',
72980
+ name: 'page_cursor',
72981
+ schema: {
72982
+ description:
72983
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
72984
+ nullable: true,
72985
+ type: 'string',
72986
+ },
72987
+ },
72964
72988
  ],
72965
72989
  responses: {
72966
72990
  200: {
@@ -72969,12 +72993,13 @@ export default {
72969
72993
  schema: {
72970
72994
  properties: {
72971
72995
  ok: { type: 'boolean' },
72996
+ pagination: { $ref: '#/components/schemas/pagination' },
72972
72997
  spaces: {
72973
72998
  items: { $ref: '#/components/schemas/space' },
72974
72999
  type: 'array',
72975
73000
  },
72976
73001
  },
72977
- required: ['spaces', 'ok'],
73002
+ required: ['spaces', 'pagination', 'ok'],
72978
73003
  type: 'object',
72979
73004
  },
72980
73005
  },
@@ -73020,9 +73045,22 @@ export default {
73020
73045
  'Customer key for which you want to list spaces.',
73021
73046
  type: 'string',
73022
73047
  },
73048
+ limit: {
73049
+ default: 500,
73050
+ description:
73051
+ 'Maximum number of records to return per page.',
73052
+ format: 'float',
73053
+ type: 'number',
73054
+ },
73055
+ page_cursor: {
73056
+ description:
73057
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
73058
+ nullable: true,
73059
+ type: 'string',
73060
+ },
73023
73061
  search: {
73024
73062
  description:
73025
- 'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.',
73063
+ 'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`.',
73026
73064
  minLength: 1,
73027
73065
  type: 'string',
73028
73066
  },
@@ -73043,12 +73081,13 @@ export default {
73043
73081
  schema: {
73044
73082
  properties: {
73045
73083
  ok: { type: 'boolean' },
73084
+ pagination: { $ref: '#/components/schemas/pagination' },
73046
73085
  spaces: {
73047
73086
  items: { $ref: '#/components/schemas/space' },
73048
73087
  type: 'array',
73049
73088
  },
73050
73089
  },
73051
- required: ['spaces', 'ok'],
73090
+ required: ['spaces', 'pagination', 'ok'],
73052
73091
  type: 'object',
73053
73092
  },
73054
73093
  },
@@ -12224,6 +12224,8 @@ export type Routes = {
12224
12224
  device_count: number
12225
12225
  /** Number of entrances in the space. */
12226
12226
  acs_entrance_count: number
12227
+ /** Customer key associated with the space. */
12228
+ customer_key?: string | undefined
12227
12229
  /** */
12228
12230
  parent_space_id?: string | undefined
12229
12231
  /** */
@@ -17329,6 +17331,8 @@ export type Routes = {
17329
17331
  device_count: number
17330
17332
  /** Number of entrances in the space. */
17331
17333
  acs_entrance_count: number
17334
+ /** Customer key associated with the space. */
17335
+ customer_key?: string | undefined
17332
17336
  /** */
17333
17337
  parent_space_id?: string | undefined
17334
17338
  /** */
@@ -79317,6 +79321,8 @@ export type Routes = {
79317
79321
  device_count: number
79318
79322
  /** Number of entrances in the space. */
79319
79323
  acs_entrance_count: number
79324
+ /** Customer key associated with the space. */
79325
+ customer_key?: string | undefined
79320
79326
  /** */
79321
79327
  parent_space_id?: string | undefined
79322
79328
  /** */
@@ -79357,6 +79363,8 @@ export type Routes = {
79357
79363
  device_count: number
79358
79364
  /** Number of entrances in the space. */
79359
79365
  acs_entrance_count: number
79366
+ /** Customer key associated with the space. */
79367
+ customer_key?: string | undefined
79360
79368
  /** */
79361
79369
  parent_space_id?: string | undefined
79362
79370
  /** */
@@ -80487,6 +80495,8 @@ export type Routes = {
80487
80495
  device_count: number
80488
80496
  /** Number of entrances in the space. */
80489
80497
  acs_entrance_count: number
80498
+ /** Customer key associated with the space. */
80499
+ customer_key?: string | undefined
80490
80500
  /** */
80491
80501
  parent_space_id?: string | undefined
80492
80502
  /** */
@@ -80542,6 +80552,8 @@ export type Routes = {
80542
80552
  device_count: number
80543
80553
  /** Number of entrances in the space. */
80544
80554
  acs_entrance_count: number
80555
+ /** Customer key associated with the space. */
80556
+ customer_key?: string | undefined
80545
80557
  /** */
80546
80558
  parent_space_id?: string | undefined
80547
80559
  /** */
@@ -80603,6 +80615,8 @@ export type Routes = {
80603
80615
  device_count: number
80604
80616
  /** Number of entrances in the space. */
80605
80617
  acs_entrance_count: number
80618
+ /** Customer key associated with the space. */
80619
+ customer_key?: string | undefined
80606
80620
  /** */
80607
80621
  parent_space_id?: string | undefined
80608
80622
  /** */
@@ -82908,12 +82922,16 @@ export type Routes = {
82908
82922
  commonParams: {
82909
82923
  /** Customer key for which you want to list spaces. */
82910
82924
  customer_key?: string | undefined
82911
- /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. */
82925
+ /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`. */
82912
82926
  search?: string | undefined
82913
82927
  /** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
82914
82928
  connected_account_id?: string | undefined
82915
82929
  /** Filter spaces by space_key. */
82916
82930
  space_key?: string | undefined
82931
+ /** Maximum number of records to return per page. */
82932
+ limit?: number
82933
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
82934
+ page_cursor?: (string | undefined) | null
82917
82935
  }
82918
82936
  formData: {}
82919
82937
  jsonResponse: {
@@ -82934,11 +82952,22 @@ export type Routes = {
82934
82952
  device_count: number
82935
82953
  /** Number of entrances in the space. */
82936
82954
  acs_entrance_count: number
82955
+ /** Customer key associated with the space. */
82956
+ customer_key?: string | undefined
82937
82957
  /** */
82938
82958
  parent_space_id?: string | undefined
82939
82959
  /** */
82940
82960
  parent_space_key?: string | undefined
82941
82961
  }[]
82962
+ /** Information about the current page of results. */
82963
+ pagination: {
82964
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
82965
+ next_page_cursor: string | null
82966
+ /** Indicates whether there is another page of results after this one. */
82967
+ has_next_page: boolean
82968
+ /** URL to get the next page of results. */
82969
+ next_page_url: string | null
82970
+ }
82942
82971
  }
82943
82972
  maxDuration: undefined
82944
82973
  }
@@ -83011,6 +83040,8 @@ export type Routes = {
83011
83040
  device_count: number
83012
83041
  /** Number of entrances in the space. */
83013
83042
  acs_entrance_count: number
83043
+ /** Customer key associated with the space. */
83044
+ customer_key?: string | undefined
83014
83045
  /** */
83015
83046
  parent_space_id?: string | undefined
83016
83047
  /** */
@@ -112896,6 +112927,8 @@ export type Routes = {
112896
112927
  device_count: number
112897
112928
  /** Number of entrances in the space. */
112898
112929
  acs_entrance_count: number
112930
+ /** Customer key associated with the space. */
112931
+ customer_key?: string | undefined
112899
112932
  /** */
112900
112933
  parent_space_id?: string | undefined
112901
112934
  /** */