@seamapi/types 1.450.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. */
@@ -11457,6 +11467,8 @@ export interface Routes {
11457
11467
  issued_at?: string | undefined;
11458
11468
  /** URL of the Instant Key for mobile key access methods. */
11459
11469
  instant_key_url?: string | undefined;
11470
+ /** Token of the client session associated with the access method. */
11471
+ client_session_token?: string | undefined;
11460
11472
  /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
11461
11473
  is_encoding_required?: boolean | undefined;
11462
11474
  /** The actual PIN code for code access methods. */
@@ -11496,6 +11508,8 @@ export interface Routes {
11496
11508
  issued_at?: string | undefined;
11497
11509
  /** URL of the Instant Key for mobile key access methods. */
11498
11510
  instant_key_url?: string | undefined;
11511
+ /** Token of the client session associated with the access method. */
11512
+ client_session_token?: string | undefined;
11499
11513
  /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
11500
11514
  is_encoding_required?: boolean | undefined;
11501
11515
  /** The actual PIN code for code access methods. */
@@ -48036,10 +48050,16 @@ export interface Routes {
48036
48050
  method: 'POST' | 'PATCH';
48037
48051
  queryParams: {};
48038
48052
  jsonBody: {
48039
- /** ID of the space that you want to update. */
48040
- space_id: string;
48041
48053
  /** Name of the space. */
48042
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;
48043
48063
  };
48044
48064
  commonParams: {};
48045
48065
  formData: {};
@@ -63529,6 +63549,8 @@ export interface Routes {
63529
63549
  access_method_ids: string[];
63530
63550
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
63531
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;
63532
63554
  /** Display name of the Access Grant. */
63533
63555
  display_name: string;
63534
63556
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -63595,6 +63617,8 @@ export interface Routes {
63595
63617
  access_method_ids: string[];
63596
63618
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
63597
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;
63598
63622
  /** Display name of the Access Grant. */
63599
63623
  display_name: string;
63600
63624
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -63657,6 +63681,8 @@ export interface Routes {
63657
63681
  access_method_ids: string[];
63658
63682
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
63659
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;
63660
63686
  /** Display name of the Access Grant. */
63661
63687
  display_name: string;
63662
63688
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -63709,6 +63735,8 @@ export interface Routes {
63709
63735
  issued_at?: string | undefined;
63710
63736
  /** URL of the Instant Key for mobile key access methods. */
63711
63737
  instant_key_url?: string | undefined;
63738
+ /** Token of the client session associated with the access method. */
63739
+ client_session_token?: string | undefined;
63712
63740
  /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
63713
63741
  is_encoding_required?: boolean | undefined;
63714
63742
  /** The actual PIN code for code access methods. */
@@ -63742,6 +63770,8 @@ export interface Routes {
63742
63770
  issued_at?: string | undefined;
63743
63771
  /** URL of the Instant Key for mobile key access methods. */
63744
63772
  instant_key_url?: string | undefined;
63773
+ /** Token of the client session associated with the access method. */
63774
+ client_session_token?: string | undefined;
63745
63775
  /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
63746
63776
  is_encoding_required?: boolean | undefined;
63747
63777
  /** The actual PIN code for code access methods. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.450.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()
@@ -26,6 +26,10 @@ export const access_method = z.object({
26
26
  .url()
27
27
  .optional()
28
28
  .describe('URL of the Instant Key for mobile key access methods.'),
29
+ client_session_token: z
30
+ .string()
31
+ .optional()
32
+ .describe('Token of the client session associated with the access method.'),
29
33
  is_encoding_required: z
30
34
  .boolean()
31
35
  .optional()
@@ -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
  ],
@@ -1950,6 +1957,11 @@ export default {
1950
1957
  format: 'uuid',
1951
1958
  type: 'string',
1952
1959
  },
1960
+ client_session_token: {
1961
+ description:
1962
+ 'Token of the client session associated with the access method.',
1963
+ type: 'string',
1964
+ },
1953
1965
  code: {
1954
1966
  description: 'The actual PIN code for code access methods.',
1955
1967
  type: 'string',
@@ -27630,6 +27642,11 @@ export default {
27630
27642
  type: 'array',
27631
27643
  'x-deprecated': 'Use `space_ids`.',
27632
27644
  },
27645
+ name: {
27646
+ description: 'Name for the access grant.',
27647
+ nullable: true,
27648
+ type: 'string',
27649
+ },
27633
27650
  requested_access_methods: {
27634
27651
  items: {
27635
27652
  properties: {
@@ -28112,6 +28129,11 @@ export default {
28112
28129
  nullable: true,
28113
28130
  type: 'string',
28114
28131
  },
28132
+ name: {
28133
+ description: 'Display name for the access grant.',
28134
+ nullable: true,
28135
+ type: 'string',
28136
+ },
28115
28137
  starts_at: {
28116
28138
  description:
28117
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.',
@@ -28176,6 +28198,11 @@ export default {
28176
28198
  nullable: true,
28177
28199
  type: 'string',
28178
28200
  },
28201
+ name: {
28202
+ description: 'Display name for the access grant.',
28203
+ nullable: true,
28204
+ type: 'string',
28205
+ },
28179
28206
  starts_at: {
28180
28207
  description:
28181
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.',
@@ -32263,6 +32290,7 @@ export default {
32263
32290
  { client_session: [] },
32264
32291
  { pat_with_workspace: [] },
32265
32292
  { console_session_with_workspace: [] },
32293
+ { client_session_with_customer: [] },
32266
32294
  ],
32267
32295
  summary: '/acs/entrances/list',
32268
32296
  tags: ['/acs'],
@@ -32369,6 +32397,7 @@ export default {
32369
32397
  { client_session: [] },
32370
32398
  { pat_with_workspace: [] },
32371
32399
  { console_session_with_workspace: [] },
32400
+ { client_session_with_customer: [] },
32372
32401
  ],
32373
32402
  summary: '/acs/entrances/list',
32374
32403
  tags: ['/acs'],
@@ -47712,6 +47741,7 @@ export default {
47712
47741
  { pat_with_workspace: [] },
47713
47742
  { console_session_with_workspace: [] },
47714
47743
  { api_key: [] },
47744
+ { client_session_with_customer: [] },
47715
47745
  ],
47716
47746
  summary: '/spaces/remove_acs_entrances',
47717
47747
  tags: [],
@@ -47769,6 +47799,7 @@ export default {
47769
47799
  { pat_with_workspace: [] },
47770
47800
  { console_session_with_workspace: [] },
47771
47801
  { api_key: [] },
47802
+ { client_session_with_customer: [] },
47772
47803
  ],
47773
47804
  summary: '/spaces/remove_acs_entrances',
47774
47805
  tags: [],
@@ -47827,6 +47858,7 @@ export default {
47827
47858
  { pat_with_workspace: [] },
47828
47859
  { console_session_with_workspace: [] },
47829
47860
  { api_key: [] },
47861
+ { client_session_with_customer: [] },
47830
47862
  ],
47831
47863
  summary: '/spaces/remove_devices',
47832
47864
  tags: [],
@@ -47883,6 +47915,7 @@ export default {
47883
47915
  { pat_with_workspace: [] },
47884
47916
  { console_session_with_workspace: [] },
47885
47917
  { api_key: [] },
47918
+ { client_session_with_customer: [] },
47886
47919
  ],
47887
47920
  summary: '/spaces/remove_devices',
47888
47921
  tags: [],
@@ -47902,14 +47935,30 @@ export default {
47902
47935
  'application/json': {
47903
47936
  schema: {
47904
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
+ },
47905
47950
  name: { description: 'Name of the space.', type: 'string' },
47906
47951
  space_id: {
47907
47952
  description: 'ID of the space that you want to update.',
47908
47953
  format: 'uuid',
47909
47954
  type: 'string',
47910
47955
  },
47956
+ space_key: {
47957
+ description:
47958
+ 'Unique key of the space that you want to update.',
47959
+ type: 'string',
47960
+ },
47911
47961
  },
47912
- required: ['space_id'],
47913
47962
  type: 'object',
47914
47963
  },
47915
47964
  },
@@ -47938,6 +47987,7 @@ export default {
47938
47987
  { pat_with_workspace: [] },
47939
47988
  { console_session_with_workspace: [] },
47940
47989
  { api_key: [] },
47990
+ { client_session_with_customer: [] },
47941
47991
  ],
47942
47992
  summary: '/spaces/update',
47943
47993
  tags: [],
@@ -47956,14 +48006,30 @@ export default {
47956
48006
  'application/json': {
47957
48007
  schema: {
47958
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
+ },
47959
48021
  name: { description: 'Name of the space.', type: 'string' },
47960
48022
  space_id: {
47961
48023
  description: 'ID of the space that you want to update.',
47962
48024
  format: 'uuid',
47963
48025
  type: 'string',
47964
48026
  },
48027
+ space_key: {
48028
+ description:
48029
+ 'Unique key of the space that you want to update.',
48030
+ type: 'string',
48031
+ },
47965
48032
  },
47966
- required: ['space_id'],
47967
48033
  type: 'object',
47968
48034
  },
47969
48035
  },
@@ -47992,6 +48058,7 @@ export default {
47992
48058
  { pat_with_workspace: [] },
47993
48059
  { console_session_with_workspace: [] },
47994
48060
  { api_key: [] },
48061
+ { client_session_with_customer: [] },
47995
48062
  ],
47996
48063
  summary: '/spaces/update',
47997
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. */
@@ -12864,6 +12874,8 @@ export interface Routes {
12864
12874
  issued_at?: string | undefined
12865
12875
  /** URL of the Instant Key for mobile key access methods. */
12866
12876
  instant_key_url?: string | undefined
12877
+ /** Token of the client session associated with the access method. */
12878
+ client_session_token?: string | undefined
12867
12879
  /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
12868
12880
  is_encoding_required?: boolean | undefined
12869
12881
  /** The actual PIN code for code access methods. */
@@ -12903,6 +12915,8 @@ export interface Routes {
12903
12915
  issued_at?: string | undefined
12904
12916
  /** URL of the Instant Key for mobile key access methods. */
12905
12917
  instant_key_url?: string | undefined
12918
+ /** Token of the client session associated with the access method. */
12919
+ client_session_token?: string | undefined
12906
12920
  /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
12907
12921
  is_encoding_required?: boolean | undefined
12908
12922
  /** The actual PIN code for code access methods. */
@@ -56795,10 +56809,16 @@ export interface Routes {
56795
56809
  method: 'POST' | 'PATCH'
56796
56810
  queryParams: {}
56797
56811
  jsonBody: {
56798
- /** ID of the space that you want to update. */
56799
- space_id: string
56800
56812
  /** Name of the space. */
56801
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
56802
56822
  }
56803
56823
  commonParams: {}
56804
56824
  formData: {}
@@ -74875,6 +74895,8 @@ export interface Routes {
74875
74895
  access_method_ids: string[]
74876
74896
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
74877
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
74878
74900
  /** Display name of the Access Grant. */
74879
74901
  display_name: string
74880
74902
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -74941,6 +74963,8 @@ export interface Routes {
74941
74963
  access_method_ids: string[]
74942
74964
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
74943
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
74944
74968
  /** Display name of the Access Grant. */
74945
74969
  display_name: string
74946
74970
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -75003,6 +75027,8 @@ export interface Routes {
75003
75027
  access_method_ids: string[]
75004
75028
  /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
75005
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
75006
75032
  /** Display name of the Access Grant. */
75007
75033
  display_name: string
75008
75034
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -75055,6 +75081,8 @@ export interface Routes {
75055
75081
  issued_at?: string | undefined
75056
75082
  /** URL of the Instant Key for mobile key access methods. */
75057
75083
  instant_key_url?: string | undefined
75084
+ /** Token of the client session associated with the access method. */
75085
+ client_session_token?: string | undefined
75058
75086
  /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
75059
75087
  is_encoding_required?: boolean | undefined
75060
75088
  /** The actual PIN code for code access methods. */
@@ -75088,6 +75116,8 @@ export interface Routes {
75088
75116
  issued_at?: string | undefined
75089
75117
  /** URL of the Instant Key for mobile key access methods. */
75090
75118
  instant_key_url?: string | undefined
75119
+ /** Token of the client session associated with the access method. */
75120
+ client_session_token?: string | undefined
75091
75121
  /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
75092
75122
  is_encoding_required?: boolean | undefined
75093
75123
  /** The actual PIN code for code access methods. */