@seamapi/types 1.460.1 → 1.461.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.
@@ -9955,6 +9955,8 @@ export interface Routes {
9955
9955
  location_ids?: string[] | undefined;
9956
9956
  /** Set of IDs of existing spaces to which access is being granted. */
9957
9957
  space_ids?: string[] | undefined;
9958
+ /** Set of keys of existing spaces to which access is being granted. */
9959
+ space_keys?: string[] | undefined;
9958
9960
  /** When used, creates a new location with the given entrances and devices, and gives the user access to this location. */
9959
9961
  location?: {
9960
9962
  /** Name of the location. */
@@ -32528,6 +32530,35 @@ export interface Routes {
32528
32530
  }>;
32529
32531
  };
32530
32532
  };
32533
+ '/instant_keys/list': {
32534
+ route: '/instant_keys/list';
32535
+ method: 'GET' | 'POST';
32536
+ queryParams: {};
32537
+ jsonBody: {};
32538
+ commonParams: {
32539
+ /** ID of the user identity by which you want to filter the list of Instant Keys. */
32540
+ user_identity_id?: string | undefined;
32541
+ };
32542
+ formData: {};
32543
+ jsonResponse: {
32544
+ instant_keys: Array<{
32545
+ /** ID of the Instant Key. */
32546
+ instant_key_id: string;
32547
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Instant Key. */
32548
+ workspace_id: string;
32549
+ /** Date and time at which the Instant Key was created. */
32550
+ created_at: string;
32551
+ /** Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app. */
32552
+ instant_key_url: string;
32553
+ /** ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) associated with the Instant Key. */
32554
+ client_session_id: string;
32555
+ /** ID of the user identity associated with the Instant Key. */
32556
+ user_identity_id: string;
32557
+ /** Date and time at which the Instant Key expires. */
32558
+ expires_at: string;
32559
+ }>;
32560
+ };
32561
+ };
32531
32562
  '/locks/get': {
32532
32563
  route: '/locks/get';
32533
32564
  method: 'GET' | 'POST';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.460.1",
3
+ "version": "1.461.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -28054,6 +28054,12 @@ export default {
28054
28054
  items: { format: 'uuid', type: 'string' },
28055
28055
  type: 'array',
28056
28056
  },
28057
+ space_keys: {
28058
+ description:
28059
+ 'Set of keys of existing spaces to which access is being granted.',
28060
+ items: { type: 'string' },
28061
+ type: 'array',
28062
+ },
28057
28063
  starts_at: {
28058
28064
  description:
28059
28065
  'Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
@@ -42806,6 +42812,115 @@ export default {
42806
42812
  'x-title': 'List Events',
42807
42813
  },
42808
42814
  },
42815
+ '/instant_keys/list': {
42816
+ get: {
42817
+ description:
42818
+ 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
42819
+ operationId: 'instantKeysListGet',
42820
+ parameters: [
42821
+ {
42822
+ in: 'query',
42823
+ name: 'user_identity_id',
42824
+ schema: {
42825
+ description:
42826
+ 'ID of the user identity by which you want to filter the list of Instant Keys.',
42827
+ format: 'uuid',
42828
+ type: 'string',
42829
+ },
42830
+ },
42831
+ ],
42832
+ responses: {
42833
+ 200: {
42834
+ content: {
42835
+ 'application/json': {
42836
+ schema: {
42837
+ properties: {
42838
+ instant_keys: {
42839
+ items: { $ref: '#/components/schemas/instant_key' },
42840
+ type: 'array',
42841
+ },
42842
+ ok: { type: 'boolean' },
42843
+ },
42844
+ required: ['instant_keys', 'ok'],
42845
+ type: 'object',
42846
+ },
42847
+ },
42848
+ },
42849
+ description: 'OK',
42850
+ },
42851
+ 400: { description: 'Bad Request' },
42852
+ 401: { description: 'Unauthorized' },
42853
+ },
42854
+ security: [
42855
+ { api_key: [] },
42856
+ { pat_with_workspace: [] },
42857
+ { console_session_with_workspace: [] },
42858
+ ],
42859
+ summary: '/instant_keys/list',
42860
+ tags: [],
42861
+ 'x-fern-sdk-group-name': ['instant_keys'],
42862
+ 'x-fern-sdk-method-name': 'list',
42863
+ 'x-fern-sdk-return-value': 'instant_keys',
42864
+ 'x-response-key': 'instant_keys',
42865
+ 'x-title': 'List Instant Keys',
42866
+ },
42867
+ post: {
42868
+ description:
42869
+ 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
42870
+ operationId: 'instantKeysListPost',
42871
+ requestBody: {
42872
+ content: {
42873
+ 'application/json': {
42874
+ schema: {
42875
+ properties: {
42876
+ user_identity_id: {
42877
+ description:
42878
+ 'ID of the user identity by which you want to filter the list of Instant Keys.',
42879
+ format: 'uuid',
42880
+ type: 'string',
42881
+ },
42882
+ },
42883
+ type: 'object',
42884
+ },
42885
+ },
42886
+ },
42887
+ },
42888
+ responses: {
42889
+ 200: {
42890
+ content: {
42891
+ 'application/json': {
42892
+ schema: {
42893
+ properties: {
42894
+ instant_keys: {
42895
+ items: { $ref: '#/components/schemas/instant_key' },
42896
+ type: 'array',
42897
+ },
42898
+ ok: { type: 'boolean' },
42899
+ },
42900
+ required: ['instant_keys', 'ok'],
42901
+ type: 'object',
42902
+ },
42903
+ },
42904
+ },
42905
+ description: 'OK',
42906
+ },
42907
+ 400: { description: 'Bad Request' },
42908
+ 401: { description: 'Unauthorized' },
42909
+ },
42910
+ security: [
42911
+ { api_key: [] },
42912
+ { pat_with_workspace: [] },
42913
+ { console_session_with_workspace: [] },
42914
+ ],
42915
+ summary: '/instant_keys/list',
42916
+ tags: [],
42917
+ 'x-fern-sdk-group-name': ['instant_keys'],
42918
+ 'x-fern-sdk-method-name': 'list',
42919
+ 'x-fern-sdk-return-value': 'instant_keys',
42920
+ 'x-response-key': 'instant_keys',
42921
+ 'x-title': 'List Instant Keys',
42922
+ },
42923
+ },
42809
42924
  '/locks/get': {
42810
42925
  get: {
42811
42926
  description:
@@ -11177,6 +11177,8 @@ export interface Routes {
11177
11177
  location_ids?: string[] | undefined
11178
11178
  /** Set of IDs of existing spaces to which access is being granted. */
11179
11179
  space_ids?: string[] | undefined
11180
+ /** Set of keys of existing spaces to which access is being granted. */
11181
+ space_keys?: string[] | undefined
11180
11182
  /** When used, creates a new location with the given entrances and devices, and gives the user access to this location. */
11181
11183
  location?:
11182
11184
  | {
@@ -38401,6 +38403,35 @@ export interface Routes {
38401
38403
  >
38402
38404
  }
38403
38405
  }
38406
+ '/instant_keys/list': {
38407
+ route: '/instant_keys/list'
38408
+ method: 'GET' | 'POST'
38409
+ queryParams: {}
38410
+ jsonBody: {}
38411
+ commonParams: {
38412
+ /** ID of the user identity by which you want to filter the list of Instant Keys. */
38413
+ user_identity_id?: string | undefined
38414
+ }
38415
+ formData: {}
38416
+ jsonResponse: {
38417
+ instant_keys: Array<{
38418
+ /** ID of the Instant Key. */
38419
+ instant_key_id: string
38420
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Instant Key. */
38421
+ workspace_id: string
38422
+ /** Date and time at which the Instant Key was created. */
38423
+ created_at: string
38424
+ /** Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app. */
38425
+ instant_key_url: string
38426
+ /** ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) associated with the Instant Key. */
38427
+ client_session_id: string
38428
+ /** ID of the user identity associated with the Instant Key. */
38429
+ user_identity_id: string
38430
+ /** Date and time at which the Instant Key expires. */
38431
+ expires_at: string
38432
+ }>
38433
+ }
38434
+ }
38404
38435
  '/locks/get': {
38405
38436
  route: '/locks/get'
38406
38437
  method: 'GET' | 'POST'