@seamapi/types 1.451.0 → 1.452.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.
@@ -9933,6 +9933,8 @@ export interface Routes {
9933
9933
  full_name?: (string | null) | undefined;
9934
9934
  };
9935
9935
  }) & {
9936
+ /** Name for the access grant. */
9937
+ name?: (string | undefined) | null;
9936
9938
  /** Unique key for the access grant within the workspace. */
9937
9939
  access_grant_key?: string | undefined;
9938
9940
  /**
@@ -9996,6 +9998,8 @@ export interface Routes {
9996
9998
  access_method_ids: string[];
9997
9999
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
9998
10000
  client_session_token?: string | undefined;
10001
+ /** Name of the Access Grant. If not provided, the display name will be computed. */
10002
+ name: string | null;
9999
10003
  /** Display name of the Access Grant. */
10000
10004
  display_name: string;
10001
10005
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -10065,6 +10069,8 @@ export interface Routes {
10065
10069
  access_method_ids: string[];
10066
10070
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
10067
10071
  client_session_token?: string | undefined;
10072
+ /** Name of the Access Grant. If not provided, the display name will be computed. */
10073
+ name: string | null;
10068
10074
  /** Display name of the Access Grant. */
10069
10075
  display_name: string;
10070
10076
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -10129,6 +10135,8 @@ export interface Routes {
10129
10135
  access_method_ids: string[];
10130
10136
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
10131
10137
  client_session_token?: string | undefined;
10138
+ /** Name of the Access Grant. If not provided, the display name will be computed. */
10139
+ name: string | null;
10132
10140
  /** Display name of the Access Grant. */
10133
10141
  display_name: string;
10134
10142
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -10148,6 +10156,8 @@ export interface Routes {
10148
10156
  queryParams: {};
10149
10157
  jsonBody: {};
10150
10158
  commonParams: {
10159
+ /** Display name for the access grant. */
10160
+ name?: (string | null) | undefined;
10151
10161
  /** ID of the Access Grant to update. */
10152
10162
  access_grant_id: string;
10153
10163
  /** Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -48040,10 +48050,16 @@ export interface Routes {
48040
48050
  method: 'POST' | 'PATCH';
48041
48051
  queryParams: {};
48042
48052
  jsonBody: {
48043
- /** ID of the space that you want to update. */
48044
- space_id: string;
48045
48053
  /** Name of the space. */
48046
48054
  name?: string | undefined;
48055
+ /** ID of the space that you want to update. */
48056
+ space_id?: string | undefined;
48057
+ /** Unique key of the space that you want to update. */
48058
+ space_key?: string | undefined;
48059
+ /** IDs of the devices that you want to set for the space. If specified, this will replace all existing devices. */
48060
+ device_ids?: string[] | undefined;
48061
+ /** IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances. */
48062
+ acs_entrance_ids?: string[] | undefined;
48047
48063
  };
48048
48064
  commonParams: {};
48049
48065
  formData: {};
@@ -63533,6 +63549,8 @@ export interface Routes {
63533
63549
  access_method_ids: string[];
63534
63550
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
63535
63551
  client_session_token?: string | undefined;
63552
+ /** Name of the Access Grant. If not provided, the display name will be computed. */
63553
+ name: string | null;
63536
63554
  /** Display name of the Access Grant. */
63537
63555
  display_name: string;
63538
63556
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -63599,6 +63617,8 @@ export interface Routes {
63599
63617
  access_method_ids: string[];
63600
63618
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
63601
63619
  client_session_token?: string | undefined;
63620
+ /** Name of the Access Grant. If not provided, the display name will be computed. */
63621
+ name: string | null;
63602
63622
  /** Display name of the Access Grant. */
63603
63623
  display_name: string;
63604
63624
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -63661,6 +63681,8 @@ export interface Routes {
63661
63681
  access_method_ids: string[];
63662
63682
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
63663
63683
  client_session_token?: string | undefined;
63684
+ /** Name of the Access Grant. If not provided, the display name will be computed. */
63685
+ name: string | null;
63664
63686
  /** Display name of the Access Grant. */
63665
63687
  display_name: string;
63666
63688
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.451.0",
3
+ "version": "1.452.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -36,6 +36,12 @@ export const access_grant = z.object({
36
36
  .describe(
37
37
  'Client Session Token. Only returned if the Access Grant has a mobile_key access method.',
38
38
  ),
39
+ name: z
40
+ .string()
41
+ .nullable()
42
+ .describe(
43
+ 'Name of the Access Grant. If not provided, the display name will be computed.',
44
+ ),
39
45
  display_name: z.string().describe('Display name of the Access Grant.'),
40
46
  instant_key_url: z
41
47
  .string()
@@ -1864,6 +1864,12 @@ export default {
1864
1864
  type: 'array',
1865
1865
  'x-deprecated': 'Use `space_ids`.',
1866
1866
  },
1867
+ name: {
1868
+ description:
1869
+ 'Name of the Access Grant. If not provided, the display name will be computed.',
1870
+ nullable: true,
1871
+ type: 'string',
1872
+ },
1867
1873
  requested_access_methods: {
1868
1874
  description:
1869
1875
  'Access methods that the user requested for the Access Grant.',
@@ -1934,6 +1940,7 @@ export default {
1934
1940
  'space_ids',
1935
1941
  'requested_access_methods',
1936
1942
  'access_method_ids',
1943
+ 'name',
1937
1944
  'display_name',
1938
1945
  'created_at',
1939
1946
  ],
@@ -27635,6 +27642,11 @@ export default {
27635
27642
  type: 'array',
27636
27643
  'x-deprecated': 'Use `space_ids`.',
27637
27644
  },
27645
+ name: {
27646
+ description: 'Name for the access grant.',
27647
+ nullable: true,
27648
+ type: 'string',
27649
+ },
27638
27650
  requested_access_methods: {
27639
27651
  items: {
27640
27652
  properties: {
@@ -28117,6 +28129,11 @@ export default {
28117
28129
  nullable: true,
28118
28130
  type: 'string',
28119
28131
  },
28132
+ name: {
28133
+ description: 'Display name for the access grant.',
28134
+ nullable: true,
28135
+ type: 'string',
28136
+ },
28120
28137
  starts_at: {
28121
28138
  description:
28122
28139
  'Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
@@ -28181,6 +28198,11 @@ export default {
28181
28198
  nullable: true,
28182
28199
  type: 'string',
28183
28200
  },
28201
+ name: {
28202
+ description: 'Display name for the access grant.',
28203
+ nullable: true,
28204
+ type: 'string',
28205
+ },
28184
28206
  starts_at: {
28185
28207
  description:
28186
28208
  'Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
@@ -32268,6 +32290,7 @@ export default {
32268
32290
  { client_session: [] },
32269
32291
  { pat_with_workspace: [] },
32270
32292
  { console_session_with_workspace: [] },
32293
+ { client_session_with_customer: [] },
32271
32294
  ],
32272
32295
  summary: '/acs/entrances/list',
32273
32296
  tags: ['/acs'],
@@ -32374,6 +32397,7 @@ export default {
32374
32397
  { client_session: [] },
32375
32398
  { pat_with_workspace: [] },
32376
32399
  { console_session_with_workspace: [] },
32400
+ { client_session_with_customer: [] },
32377
32401
  ],
32378
32402
  summary: '/acs/entrances/list',
32379
32403
  tags: ['/acs'],
@@ -47717,6 +47741,7 @@ export default {
47717
47741
  { pat_with_workspace: [] },
47718
47742
  { console_session_with_workspace: [] },
47719
47743
  { api_key: [] },
47744
+ { client_session_with_customer: [] },
47720
47745
  ],
47721
47746
  summary: '/spaces/remove_acs_entrances',
47722
47747
  tags: [],
@@ -47774,6 +47799,7 @@ export default {
47774
47799
  { pat_with_workspace: [] },
47775
47800
  { console_session_with_workspace: [] },
47776
47801
  { api_key: [] },
47802
+ { client_session_with_customer: [] },
47777
47803
  ],
47778
47804
  summary: '/spaces/remove_acs_entrances',
47779
47805
  tags: [],
@@ -47832,6 +47858,7 @@ export default {
47832
47858
  { pat_with_workspace: [] },
47833
47859
  { console_session_with_workspace: [] },
47834
47860
  { api_key: [] },
47861
+ { client_session_with_customer: [] },
47835
47862
  ],
47836
47863
  summary: '/spaces/remove_devices',
47837
47864
  tags: [],
@@ -47888,6 +47915,7 @@ export default {
47888
47915
  { pat_with_workspace: [] },
47889
47916
  { console_session_with_workspace: [] },
47890
47917
  { api_key: [] },
47918
+ { client_session_with_customer: [] },
47891
47919
  ],
47892
47920
  summary: '/spaces/remove_devices',
47893
47921
  tags: [],
@@ -47907,14 +47935,30 @@ export default {
47907
47935
  'application/json': {
47908
47936
  schema: {
47909
47937
  properties: {
47938
+ acs_entrance_ids: {
47939
+ description:
47940
+ 'IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances.',
47941
+ items: { format: 'uuid', type: 'string' },
47942
+ type: 'array',
47943
+ },
47944
+ device_ids: {
47945
+ description:
47946
+ 'IDs of the devices that you want to set for the space. If specified, this will replace all existing devices.',
47947
+ items: { format: 'uuid', type: 'string' },
47948
+ type: 'array',
47949
+ },
47910
47950
  name: { description: 'Name of the space.', type: 'string' },
47911
47951
  space_id: {
47912
47952
  description: 'ID of the space that you want to update.',
47913
47953
  format: 'uuid',
47914
47954
  type: 'string',
47915
47955
  },
47956
+ space_key: {
47957
+ description:
47958
+ 'Unique key of the space that you want to update.',
47959
+ type: 'string',
47960
+ },
47916
47961
  },
47917
- required: ['space_id'],
47918
47962
  type: 'object',
47919
47963
  },
47920
47964
  },
@@ -47943,6 +47987,7 @@ export default {
47943
47987
  { pat_with_workspace: [] },
47944
47988
  { console_session_with_workspace: [] },
47945
47989
  { api_key: [] },
47990
+ { client_session_with_customer: [] },
47946
47991
  ],
47947
47992
  summary: '/spaces/update',
47948
47993
  tags: [],
@@ -47961,14 +48006,30 @@ export default {
47961
48006
  'application/json': {
47962
48007
  schema: {
47963
48008
  properties: {
48009
+ acs_entrance_ids: {
48010
+ description:
48011
+ 'IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances.',
48012
+ items: { format: 'uuid', type: 'string' },
48013
+ type: 'array',
48014
+ },
48015
+ device_ids: {
48016
+ description:
48017
+ 'IDs of the devices that you want to set for the space. If specified, this will replace all existing devices.',
48018
+ items: { format: 'uuid', type: 'string' },
48019
+ type: 'array',
48020
+ },
47964
48021
  name: { description: 'Name of the space.', type: 'string' },
47965
48022
  space_id: {
47966
48023
  description: 'ID of the space that you want to update.',
47967
48024
  format: 'uuid',
47968
48025
  type: 'string',
47969
48026
  },
48027
+ space_key: {
48028
+ description:
48029
+ 'Unique key of the space that you want to update.',
48030
+ type: 'string',
48031
+ },
47970
48032
  },
47971
- required: ['space_id'],
47972
48033
  type: 'object',
47973
48034
  },
47974
48035
  },
@@ -47997,6 +48058,7 @@ export default {
47997
48058
  { pat_with_workspace: [] },
47998
48059
  { console_session_with_workspace: [] },
47999
48060
  { api_key: [] },
48061
+ { client_session_with_customer: [] },
48000
48062
  ],
48001
48063
  summary: '/spaces/update',
48002
48064
  tags: [],
@@ -11155,6 +11155,8 @@ export interface Routes {
11155
11155
  }
11156
11156
  }
11157
11157
  ) & {
11158
+ /** Name for the access grant. */
11159
+ name?: (string | undefined) | null
11158
11160
  /** Unique key for the access grant within the workspace. */
11159
11161
  access_grant_key?: string | undefined
11160
11162
  /**
@@ -11220,6 +11222,8 @@ export interface Routes {
11220
11222
  access_method_ids: string[]
11221
11223
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
11222
11224
  client_session_token?: string | undefined
11225
+ /** Name of the Access Grant. If not provided, the display name will be computed. */
11226
+ name: string | null
11223
11227
  /** Display name of the Access Grant. */
11224
11228
  display_name: string
11225
11229
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -11291,6 +11295,8 @@ export interface Routes {
11291
11295
  access_method_ids: string[]
11292
11296
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
11293
11297
  client_session_token?: string | undefined
11298
+ /** Name of the Access Grant. If not provided, the display name will be computed. */
11299
+ name: string | null
11294
11300
  /** Display name of the Access Grant. */
11295
11301
  display_name: string
11296
11302
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -11355,6 +11361,8 @@ export interface Routes {
11355
11361
  access_method_ids: string[]
11356
11362
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
11357
11363
  client_session_token?: string | undefined
11364
+ /** Name of the Access Grant. If not provided, the display name will be computed. */
11365
+ name: string | null
11358
11366
  /** Display name of the Access Grant. */
11359
11367
  display_name: string
11360
11368
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -11374,6 +11382,8 @@ export interface Routes {
11374
11382
  queryParams: {}
11375
11383
  jsonBody: {}
11376
11384
  commonParams: {
11385
+ /** Display name for the access grant. */
11386
+ name?: (string | null) | undefined
11377
11387
  /** ID of the Access Grant to update. */
11378
11388
  access_grant_id: string
11379
11389
  /** Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -56799,10 +56809,16 @@ export interface Routes {
56799
56809
  method: 'POST' | 'PATCH'
56800
56810
  queryParams: {}
56801
56811
  jsonBody: {
56802
- /** ID of the space that you want to update. */
56803
- space_id: string
56804
56812
  /** Name of the space. */
56805
56813
  name?: string | undefined
56814
+ /** ID of the space that you want to update. */
56815
+ space_id?: string | undefined
56816
+ /** Unique key of the space that you want to update. */
56817
+ space_key?: string | undefined
56818
+ /** IDs of the devices that you want to set for the space. If specified, this will replace all existing devices. */
56819
+ device_ids?: string[] | undefined
56820
+ /** IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances. */
56821
+ acs_entrance_ids?: string[] | undefined
56806
56822
  }
56807
56823
  commonParams: {}
56808
56824
  formData: {}
@@ -74879,6 +74895,8 @@ export interface Routes {
74879
74895
  access_method_ids: string[]
74880
74896
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
74881
74897
  client_session_token?: string | undefined
74898
+ /** Name of the Access Grant. If not provided, the display name will be computed. */
74899
+ name: string | null
74882
74900
  /** Display name of the Access Grant. */
74883
74901
  display_name: string
74884
74902
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -74945,6 +74963,8 @@ export interface Routes {
74945
74963
  access_method_ids: string[]
74946
74964
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
74947
74965
  client_session_token?: string | undefined
74966
+ /** Name of the Access Grant. If not provided, the display name will be computed. */
74967
+ name: string | null
74948
74968
  /** Display name of the Access Grant. */
74949
74969
  display_name: string
74950
74970
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -75007,6 +75027,8 @@ export interface Routes {
75007
75027
  access_method_ids: string[]
75008
75028
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
75009
75029
  client_session_token?: string | undefined
75030
+ /** Name of the Access Grant. If not provided, the display name will be computed. */
75031
+ name: string | null
75010
75032
  /** Display name of the Access Grant. */
75011
75033
  display_name: string
75012
75034
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */