@seamapi/types 1.1002.0 → 1.1003.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.
@@ -6941,8 +6941,7 @@ export type Routes = {
6941
6941
  route: '/access_codes/unmanaged/convert_to_managed';
6942
6942
  method: 'POST' | 'PATCH';
6943
6943
  queryParams: {};
6944
- jsonBody: {};
6945
- commonParams: {
6944
+ jsonBody: {
6946
6945
  /** ID of the unmanaged access code that you want to convert to a managed access code. */
6947
6946
  access_code_id: string;
6948
6947
  /** Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed. */
@@ -6954,6 +6953,7 @@ export type Routes = {
6954
6953
  /** */
6955
6954
  sync?: boolean;
6956
6955
  };
6956
+ commonParams: {};
6957
6957
  formData: {};
6958
6958
  jsonResponse: {};
6959
6959
  maxDuration: undefined;
@@ -9524,8 +9524,7 @@ export type Routes = {
9524
9524
  route: '/access_codes/unmanaged/update';
9525
9525
  method: 'PATCH' | 'POST';
9526
9526
  queryParams: {};
9527
- jsonBody: {};
9528
- commonParams: {
9527
+ jsonBody: {
9529
9528
  /** ID of the unmanaged access code that you want to update. */
9530
9529
  access_code_id: string;
9531
9530
  is_managed: boolean;
@@ -9536,6 +9535,7 @@ export type Routes = {
9536
9535
  /** Indicates whether to force the unmanaged access code update. */
9537
9536
  force?: boolean | undefined;
9538
9537
  };
9538
+ commonParams: {};
9539
9539
  formData: {};
9540
9540
  jsonResponse: {};
9541
9541
  maxDuration: undefined;
@@ -11390,8 +11390,7 @@ export type Routes = {
11390
11390
  route: '/access_grants/create';
11391
11391
  method: 'POST';
11392
11392
  queryParams: {};
11393
- jsonBody: {};
11394
- commonParams: ({
11393
+ jsonBody: ({
11395
11394
  /** ID of user identity for whom access is being granted. */
11396
11395
  user_identity_id: string;
11397
11396
  } | {
@@ -11451,6 +11450,7 @@ export type Routes = {
11451
11450
  /** ID of the customization profile to apply to the Access Grant and its access methods. */
11452
11451
  customization_profile_id?: string | undefined;
11453
11452
  };
11453
+ commonParams: {};
11454
11454
  formData: {};
11455
11455
  jsonResponse: {
11456
11456
  /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
@@ -14511,8 +14511,7 @@ export type Routes = {
14511
14511
  route: '/access_grants/request_access_methods';
14512
14512
  method: 'POST';
14513
14513
  queryParams: {};
14514
- jsonBody: {};
14515
- commonParams: {
14514
+ jsonBody: {
14516
14515
  /** ID of the Access Grant to add access methods to. */
14517
14516
  access_grant_id: string;
14518
14517
  /** Array of requested access methods to add to the access grant. */
@@ -14525,6 +14524,7 @@ export type Routes = {
14525
14524
  instant_key_max_use_count?: number | undefined;
14526
14525
  }[];
14527
14526
  };
14527
+ commonParams: {};
14528
14528
  formData: {};
14529
14529
  jsonResponse: {
14530
14530
  /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
@@ -15121,8 +15121,7 @@ export type Routes = {
15121
15121
  route: '/access_grants/update';
15122
15122
  method: 'POST' | 'PATCH';
15123
15123
  queryParams: {};
15124
- jsonBody: {};
15125
- commonParams: {
15124
+ jsonBody: {
15126
15125
  /** Display name for the access grant. */
15127
15126
  name?: (string | null) | undefined;
15128
15127
  /** ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`. */
@@ -15134,6 +15133,7 @@ export type Routes = {
15134
15133
  /** Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
15135
15134
  ends_at?: (string | null) | undefined;
15136
15135
  };
15136
+ commonParams: {};
15137
15137
  formData: {};
15138
15138
  jsonResponse: {};
15139
15139
  maxDuration: undefined;
@@ -15142,13 +15142,13 @@ export type Routes = {
15142
15142
  route: '/access_methods/assign_card';
15143
15143
  method: 'POST';
15144
15144
  queryParams: {};
15145
- jsonBody: {};
15146
- commonParams: {
15145
+ jsonBody: {
15147
15146
  /** ID of the `access_method` to assign the credential to. */
15148
15147
  access_method_id: string;
15149
15148
  /** Card number of the credential to assign. */
15150
15149
  card_number: string;
15151
15150
  };
15151
+ commonParams: {};
15152
15152
  formData: {};
15153
15153
  jsonResponse: {
15154
15154
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -16957,13 +16957,13 @@ export type Routes = {
16957
16957
  route: '/access_methods/encode';
16958
16958
  method: 'POST';
16959
16959
  queryParams: {};
16960
- jsonBody: {};
16961
- commonParams: {
16960
+ jsonBody: {
16962
16961
  /** ID of the `acs_encoder` to use to encode the `access_method`. */
16963
16962
  acs_encoder_id: string;
16964
16963
  /** ID of the `access_method` to encode onto a card. */
16965
16964
  access_method_id: string;
16966
16965
  };
16966
+ commonParams: {};
16967
16967
  formData: {};
16968
16968
  jsonResponse: {
16969
16969
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -21335,13 +21335,13 @@ export type Routes = {
21335
21335
  route: '/access_methods/unlock_door';
21336
21336
  method: 'POST';
21337
21337
  queryParams: {};
21338
- jsonBody: {};
21339
- commonParams: {
21338
+ jsonBody: {
21340
21339
  /** ID of the cloud_key `access_method` to use for the unlock operation. */
21341
21340
  access_method_id: string;
21342
21341
  /** ID of the entrance to unlock. */
21343
21342
  acs_entrance_id: string;
21344
21343
  };
21344
+ commonParams: {};
21345
21345
  formData: {};
21346
21346
  jsonResponse: {
21347
21347
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -23414,8 +23414,7 @@ export type Routes = {
23414
23414
  route: '/acs/access_groups/add_user';
23415
23415
  method: 'PUT' | 'POST';
23416
23416
  queryParams: {};
23417
- jsonBody: {};
23418
- commonParams: {
23417
+ jsonBody: {
23419
23418
  /** ID of the access group to which you want to add an access system user. */
23420
23419
  acs_access_group_id: string;
23421
23420
  /** ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. */
@@ -23423,6 +23422,7 @@ export type Routes = {
23423
23422
  /** ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */
23424
23423
  user_identity_id?: string | undefined;
23425
23424
  };
23425
+ commonParams: {};
23426
23426
  formData: {};
23427
23427
  jsonResponse: {};
23428
23428
  maxDuration: undefined;
@@ -24716,8 +24716,7 @@ export type Routes = {
24716
24716
  route: '/acs/credential_provisioning_automations/launch';
24717
24717
  method: 'POST';
24718
24718
  queryParams: {};
24719
- jsonBody: {};
24720
- commonParams: {
24719
+ jsonBody: {
24721
24720
  /** ID of the user identity for which you want to launch a credential provisioning automation. */
24722
24721
  user_identity_id: string;
24723
24722
  /** Access system ID of the credential manager for which you want to launch a credential provisioning automation. */
@@ -24729,6 +24728,7 @@ export type Routes = {
24729
24728
  /** ID of the associated access system user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. */
24730
24729
  credential_manager_acs_user_id?: string | undefined;
24731
24730
  };
24731
+ commonParams: {};
24732
24732
  formData: {};
24733
24733
  jsonResponse: {
24734
24734
  /**
@@ -24923,8 +24923,7 @@ export type Routes = {
24923
24923
  route: '/acs/credentials/create';
24924
24924
  method: 'POST';
24925
24925
  queryParams: {};
24926
- jsonBody: {};
24927
- commonParams: {
24926
+ jsonBody: {
24928
24927
  /** ACS system ID of the credential manager for the new credential. */
24929
24928
  credential_manager_acs_system_id?: string | undefined;
24930
24929
  /** ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. */
@@ -24979,6 +24978,7 @@ export type Routes = {
24979
24978
  /** Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
24980
24979
  ends_at?: string | undefined;
24981
24980
  };
24981
+ commonParams: {};
24982
24982
  formData: {};
24983
24983
  jsonResponse: {
24984
24984
  /** Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems).
@@ -25146,8 +25146,7 @@ export type Routes = {
25146
25146
  route: '/acs/credentials/create_offline_code';
25147
25147
  method: 'POST';
25148
25148
  queryParams: {};
25149
- jsonBody: {};
25150
- commonParams: {
25149
+ jsonBody: {
25151
25150
  /** ID of the access system user to whom the new credential belongs. */
25152
25151
  acs_user_id: string;
25153
25152
  /** IDs of the [`acs_entrance`s](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) for which the new credential grants access. */
@@ -25159,6 +25158,7 @@ export type Routes = {
25159
25158
  /** Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
25160
25159
  ends_at?: string | undefined;
25161
25160
  };
25161
+ commonParams: {};
25162
25162
  formData: {};
25163
25163
  jsonResponse: {
25164
25164
  /** Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems).
@@ -26605,8 +26605,7 @@ export type Routes = {
26605
26605
  route: '/acs/encoders/encode_credential';
26606
26606
  method: 'POST';
26607
26607
  queryParams: {};
26608
- jsonBody: {};
26609
- commonParams: {
26608
+ jsonBody: {
26610
26609
  /** ID of the `acs_encoder` to use to encode the `acs_credential`. */
26611
26610
  acs_encoder_id: string;
26612
26611
  /** ID of the `acs_credential` to encode onto a card. */
@@ -26614,6 +26613,7 @@ export type Routes = {
26614
26613
  /** ID of the `access_method` to encode onto a card. */
26615
26614
  access_method_id?: string | undefined;
26616
26615
  };
26616
+ commonParams: {};
26617
26617
  formData: {};
26618
26618
  jsonResponse: {
26619
26619
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -28508,8 +28508,7 @@ export type Routes = {
28508
28508
  route: '/acs/encoders/scan_credential';
28509
28509
  method: 'POST';
28510
28510
  queryParams: {};
28511
- jsonBody: {};
28512
- commonParams: {
28511
+ jsonBody: {
28513
28512
  /** ID of the encoder to use for the scan. */
28514
28513
  acs_encoder_id: string;
28515
28514
  /** Salto KS-specific metadata for the scan action. */
@@ -28518,6 +28517,7 @@ export type Routes = {
28518
28517
  detect_new_tags?: boolean;
28519
28518
  } | undefined;
28520
28519
  };
28520
+ commonParams: {};
28521
28521
  formData: {};
28522
28522
  jsonResponse: {
28523
28523
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -30307,8 +30307,7 @@ export type Routes = {
30307
30307
  route: '/acs/encoders/scan_to_assign_credential';
30308
30308
  method: 'POST';
30309
30309
  queryParams: {};
30310
- jsonBody: {};
30311
- commonParams: {
30310
+ jsonBody: {
30312
30311
  /** ID of the `acs_encoder` to use to scan the credential. */
30313
30312
  acs_encoder_id: string;
30314
30313
  /** ID of the `acs_user` to assign the scanned credential to. */
@@ -30321,6 +30320,7 @@ export type Routes = {
30321
30320
  detect_new_tags?: boolean;
30322
30321
  } | undefined;
30323
30322
  };
30323
+ commonParams: {};
30324
30324
  formData: {};
30325
30325
  jsonResponse: {
30326
30326
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -32848,13 +32848,13 @@ export type Routes = {
32848
32848
  route: '/acs/entrances/unlock';
32849
32849
  method: 'POST';
32850
32850
  queryParams: {};
32851
- jsonBody: {};
32852
- commonParams: {
32851
+ jsonBody: {
32853
32852
  /** ID of the entrance to unlock. */
32854
32853
  acs_entrance_id: string;
32855
32854
  /** ID of the cloud_key credential to use for the unlock operation. */
32856
32855
  acs_credential_id: string;
32857
32856
  };
32857
+ commonParams: {};
32858
32858
  formData: {};
32859
32859
  jsonResponse: {
32860
32860
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -35148,8 +35148,7 @@ export type Routes = {
35148
35148
  route: '/acs/systems/report_devices';
35149
35149
  method: 'POST';
35150
35150
  queryParams: {};
35151
- jsonBody: {};
35152
- commonParams: {
35151
+ jsonBody: {
35153
35152
  /** ID of the ACS system to report resources for */
35154
35153
  acs_system_id: string;
35155
35154
  /** Array of ACS encoders to report */
@@ -35176,6 +35175,7 @@ export type Routes = {
35176
35175
  };
35177
35176
  }[] | undefined;
35178
35177
  };
35178
+ commonParams: {};
35179
35179
  formData: {};
35180
35180
  jsonResponse: {};
35181
35181
  maxDuration: undefined;
@@ -35184,13 +35184,13 @@ export type Routes = {
35184
35184
  route: '/acs/users/add_to_access_group';
35185
35185
  method: 'PUT' | 'POST';
35186
35186
  queryParams: {};
35187
- jsonBody: {};
35188
- commonParams: {
35187
+ jsonBody: {
35189
35188
  /** ID of the access system user that you want to add to an access group. */
35190
35189
  acs_user_id: string;
35191
35190
  /** ID of the access group to which you want to add an access system user. */
35192
35191
  acs_access_group_id: string;
35193
35192
  };
35193
+ commonParams: {};
35194
35194
  formData: {};
35195
35195
  jsonResponse: {};
35196
35196
  maxDuration: undefined;
@@ -36367,8 +36367,7 @@ export type Routes = {
36367
36367
  route: '/acs/users/suspend';
36368
36368
  method: 'POST';
36369
36369
  queryParams: {};
36370
- jsonBody: {};
36371
- commonParams: {
36370
+ jsonBody: {
36372
36371
  /** ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
36373
36372
  acs_user_id?: string | undefined;
36374
36373
  /** ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
@@ -36376,6 +36375,7 @@ export type Routes = {
36376
36375
  /** ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
36377
36376
  acs_system_id?: string | undefined;
36378
36377
  };
36378
+ commonParams: {};
36379
36379
  formData: {};
36380
36380
  jsonResponse: {};
36381
36381
  maxDuration: undefined;
@@ -36951,8 +36951,7 @@ export type Routes = {
36951
36951
  route: '/acs/users/unsuspend';
36952
36952
  method: 'POST';
36953
36953
  queryParams: {};
36954
- jsonBody: {};
36955
- commonParams: {
36954
+ jsonBody: {
36956
36955
  /** ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
36957
36956
  acs_user_id?: string | undefined;
36958
36957
  /** ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
@@ -36960,6 +36959,7 @@ export type Routes = {
36960
36959
  /** ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id. */
36961
36960
  acs_system_id?: string | undefined;
36962
36961
  };
36962
+ commonParams: {};
36963
36963
  formData: {};
36964
36964
  jsonResponse: {};
36965
36965
  maxDuration: undefined;
@@ -40834,8 +40834,7 @@ export type Routes = {
40834
40834
  route: '/client_sessions/grant_access';
40835
40835
  method: 'PATCH' | 'POST';
40836
40836
  queryParams: {};
40837
- jsonBody: {};
40838
- commonParams: {
40837
+ jsonBody: {
40839
40838
  /** ID of the client session to which you want to grant access to resources. */
40840
40839
  client_session_id?: string | undefined;
40841
40840
  /** Your user ID for the user that you want to associate with the client session. */
@@ -40850,6 +40849,7 @@ export type Routes = {
40850
40849
  /** ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. */
40851
40850
  user_identity_id?: string | undefined;
40852
40851
  };
40852
+ commonParams: {};
40853
40853
  formData: {};
40854
40854
  jsonResponse: {
40855
40855
  /** Represents a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
@@ -40944,11 +40944,11 @@ export type Routes = {
40944
40944
  route: '/client_sessions/revoke';
40945
40945
  method: 'POST';
40946
40946
  queryParams: {};
40947
- jsonBody: {};
40948
- commonParams: {
40947
+ jsonBody: {
40949
40948
  /** ID of the client session that you want to revoke. */
40950
40949
  client_session_id: string;
40951
40950
  };
40951
+ commonParams: {};
40952
40952
  formData: {};
40953
40953
  jsonResponse: {};
40954
40954
  maxDuration: undefined;
@@ -41884,8 +41884,7 @@ export type Routes = {
41884
41884
  route: '/customers/create_portal';
41885
41885
  method: 'POST';
41886
41886
  queryParams: {};
41887
- jsonBody: {};
41888
- commonParams: {
41887
+ jsonBody: {
41889
41888
  features?: {
41890
41889
  /** Configuration for the connect accounts feature. */
41891
41890
  connect?: {
@@ -42331,6 +42330,7 @@ export type Routes = {
42331
42330
  }[] | undefined;
42332
42331
  } | undefined;
42333
42332
  };
42333
+ commonParams: {};
42334
42334
  formData: {};
42335
42335
  jsonResponse: {
42336
42336
  /** Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.
@@ -42423,8 +42423,7 @@ export type Routes = {
42423
42423
  route: '/customers/push_data';
42424
42424
  method: 'POST';
42425
42425
  queryParams: {};
42426
- jsonBody: {};
42427
- commonParams: {
42426
+ jsonBody: {
42428
42427
  /** Your unique identifier for the customer. */
42429
42428
  customer_key: string;
42430
42429
  /** List of general spaces or areas. */
@@ -42737,6 +42736,7 @@ export type Routes = {
42737
42736
  listing_keys?: string[] | undefined;
42738
42737
  }[] | undefined;
42739
42738
  };
42739
+ commonParams: {};
42740
42740
  formData: {};
42741
42741
  jsonResponse: {};
42742
42742
  maxDuration: undefined;
@@ -42745,13 +42745,13 @@ export type Routes = {
42745
42745
  route: '/customers/reservations/create_deep_link';
42746
42746
  method: 'POST';
42747
42747
  queryParams: {};
42748
- jsonBody: {};
42749
- commonParams: {
42748
+ jsonBody: {
42750
42749
  /** The customer_key identifying the customer who owns the reservation. */
42751
42750
  customer_key: string;
42752
42751
  /** The key of the reservation to create a deep link for. */
42753
42752
  reservation_key: string;
42754
42753
  };
42754
+ commonParams: {};
42755
42755
  formData: {};
42756
42756
  jsonResponse: {
42757
42757
  deep_link: {
@@ -45903,8 +45903,7 @@ export type Routes = {
45903
45903
  route: '/devices/report_provider_metadata';
45904
45904
  method: 'POST';
45905
45905
  queryParams: {};
45906
- jsonBody: {};
45907
- commonParams: {
45906
+ jsonBody: {
45908
45907
  /** Array of devices with provider metadata to update */
45909
45908
  devices: {
45910
45909
  /** ID of the device to update */
@@ -45926,6 +45925,7 @@ export type Routes = {
45926
45925
  } | undefined;
45927
45926
  }[];
45928
45927
  };
45928
+ commonParams: {};
45929
45929
  formData: {};
45930
45930
  jsonResponse: {};
45931
45931
  maxDuration: undefined;
@@ -47038,8 +47038,7 @@ export type Routes = {
47038
47038
  route: '/devices/unmanaged/update';
47039
47039
  method: 'POST' | 'PATCH';
47040
47040
  queryParams: {};
47041
- jsonBody: {};
47042
- commonParams: {
47041
+ jsonBody: {
47043
47042
  /** ID of the unmanaged device that you want to update. */
47044
47043
  device_id: string;
47045
47044
  /** Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed. */
@@ -47049,6 +47048,7 @@ export type Routes = {
47049
47048
  [x: string]: string | boolean | null;
47050
47049
  } | undefined;
47051
47050
  };
47051
+ commonParams: {};
47052
47052
  formData: {};
47053
47053
  jsonResponse: {};
47054
47054
  maxDuration: undefined;
@@ -47057,8 +47057,7 @@ export type Routes = {
47057
47057
  route: '/devices/update';
47058
47058
  method: 'POST' | 'PATCH';
47059
47059
  queryParams: {};
47060
- jsonBody: {};
47061
- commonParams: {
47060
+ jsonBody: {
47062
47061
  /** ID of the device that you want to update. */
47063
47062
  device_id: string;
47064
47063
  properties?: {
@@ -47076,6 +47075,7 @@ export type Routes = {
47076
47075
  /** Indicates whether the device's [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is enabled. Set to `false` to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use. */
47077
47076
  backup_access_code_pool_enabled?: boolean | undefined;
47078
47077
  };
47078
+ commonParams: {};
47079
47079
  formData: {};
47080
47080
  jsonResponse: {};
47081
47081
  maxDuration: undefined;
@@ -77989,11 +77989,11 @@ export type Routes = {
77989
77989
  route: '/seam/console/v1/lynx_migration/migrate_property';
77990
77990
  method: 'POST';
77991
77991
  queryParams: {};
77992
- jsonBody: {};
77993
- commonParams: {
77992
+ jsonBody: {
77994
77993
  /** ID of the space (property) to migrate. */
77995
77994
  space_id: string;
77996
77995
  };
77996
+ commonParams: {};
77997
77997
  formData: {};
77998
77998
  jsonResponse: {
77999
77999
  lynx_migration_property_run: {
@@ -78801,13 +78801,13 @@ export type Routes = {
78801
78801
  route: '/seam/console/v1/workspace/feature_flags/update';
78802
78802
  method: 'POST';
78803
78803
  queryParams: {};
78804
- jsonBody: {};
78805
- commonParams: {
78804
+ jsonBody: {
78806
78805
  /** Name of the workspace feature flag to update. */
78807
78806
  feature_flag_name: 'RESERVATION_LEGACY' | 'EXPERIMENTAL_DASHBOARD_API_ENABLED' | 'ICAL_CONNECTOR' | 'VISIONLINE_SERIALIZE_BRIDGE_REQUESTS' | 'SALTO_KS_ENTRANCES_ONLY_FOR_SPACES' | 'MANAGE_DEVICES_CONFIRMATION_MODAL' | 'RECLAIM_ORPHANED_BACKUP_ACCESS_CODES' | 'RECONCILE_ORPHANED_SMARTTHINGS_ACCESS_CODES' | 'LYNX_MIGRATION_ENABLED' | 'AURORA_CUSTOMER_FILTER_ENABLED' | 'AUTOMATION_IMMINENT_CHECK_IN_QUEUE' | 'ACCESS_METHOD_DEADLINE_ERRORS' | 'GUARD_MATERIALIZATION_ON_UNREACHABLE_DEVICE' | 'TARGETED_ACCESS_GRANT_ISSUANCE';
78808
78807
  /** Whether the feature flag should be enabled for the workspace. */
78809
78808
  enabled: boolean;
78810
78809
  };
78810
+ commonParams: {};
78811
78811
  formData: {};
78812
78812
  jsonResponse: {
78813
78813
  feature_flag: {
@@ -79011,13 +79011,13 @@ export type Routes = {
79011
79011
  route: '/seam/customer/v1/access_grants/update';
79012
79012
  method: 'POST' | 'PATCH';
79013
79013
  queryParams: {};
79014
- jsonBody: {};
79015
- commonParams: {
79014
+ jsonBody: {
79016
79015
  /** ID of the Access Grant to update. */
79017
79016
  access_grant_id: string;
79018
79017
  /** Array of location IDs to associate with the access grant. */
79019
79018
  space_ids: string[];
79020
79019
  };
79020
+ commonParams: {};
79021
79021
  formData: {};
79022
79022
  jsonResponse: {};
79023
79023
  maxDuration: undefined;
@@ -79026,13 +79026,13 @@ export type Routes = {
79026
79026
  route: '/seam/customer/v1/access_methods/encode';
79027
79027
  method: 'POST';
79028
79028
  queryParams: {};
79029
- jsonBody: {};
79030
- commonParams: {
79029
+ jsonBody: {
79031
79030
  /** ID of the encoder to use for encoding the access method. */
79032
79031
  acs_encoder_id: string;
79033
79032
  /** ID of the access method to encode onto a card. */
79034
79033
  access_method_id: string;
79035
79034
  };
79035
+ commonParams: {};
79036
79036
  formData: {};
79037
79037
  jsonResponse: {
79038
79038
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -81323,8 +81323,7 @@ export type Routes = {
81323
81323
  route: '/seam/customer/v1/connectors/sync';
81324
81324
  method: 'POST';
81325
81325
  queryParams: {};
81326
- jsonBody: {};
81327
- commonParams: {
81326
+ jsonBody: {
81328
81327
  /** ID of the connector to sync */
81329
81328
  connector_id: string;
81330
81329
  /** Type of the connector to sync */
@@ -81336,6 +81335,7 @@ export type Routes = {
81336
81335
  /** Unique provider resource key of the connector to sync */
81337
81336
  unique_provider_resource_key?: (string | null) | undefined;
81338
81337
  };
81338
+ commonParams: {};
81339
81339
  formData: {};
81340
81340
  jsonResponse: {
81341
81341
  connector_sync: {
@@ -81605,11 +81605,11 @@ export type Routes = {
81605
81605
  route: '/seam/customer/v1/customers/open_portal';
81606
81606
  method: 'POST';
81607
81607
  queryParams: {};
81608
- jsonBody: {};
81609
- commonParams: {
81608
+ jsonBody: {
81610
81609
  /** The customer key to open a portal for. */
81611
81610
  customer_key: string;
81612
81611
  };
81612
+ commonParams: {};
81613
81613
  formData: {};
81614
81614
  jsonResponse: {
81615
81615
  /** Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.
@@ -85829,8 +85829,7 @@ export type Routes = {
85829
85829
  route: '/seam/customer/v1/spaces/push_common_areas';
85830
85830
  method: 'POST';
85831
85831
  queryParams: {};
85832
- jsonBody: {};
85833
- commonParams: {
85832
+ jsonBody: {
85834
85833
  common_areas?: {
85835
85834
  name: string;
85836
85835
  }[] | undefined;
@@ -85841,6 +85840,7 @@ export type Routes = {
85841
85840
  }[];
85842
85841
  }[] | undefined;
85843
85842
  };
85843
+ commonParams: {};
85844
85844
  formData: {};
85845
85845
  jsonResponse: {};
85846
85846
  maxDuration: undefined;
@@ -110732,11 +110732,11 @@ export type Routes = {
110732
110732
  route: '/unstable_partner/building_blocks/connect_accounts';
110733
110733
  method: 'POST';
110734
110734
  queryParams: {};
110735
- jsonBody: {};
110736
- commonParams: {
110735
+ jsonBody: {
110737
110736
  /** Customer key for which you want to connect accounts. */
110738
110737
  customer_key: string;
110739
110738
  };
110739
+ commonParams: {};
110740
110740
  formData: {};
110741
110741
  jsonResponse: {
110742
110742
  /** Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.
@@ -110825,11 +110825,11 @@ export type Routes = {
110825
110825
  route: '/unstable_partner/building_blocks/manage_devices';
110826
110826
  method: 'POST';
110827
110827
  queryParams: {};
110828
- jsonBody: {};
110829
- commonParams: {
110828
+ jsonBody: {
110830
110829
  /** Customer key for which you want to manage devices. */
110831
110830
  customer_key: string;
110832
110831
  };
110832
+ commonParams: {};
110833
110833
  formData: {};
110834
110834
  jsonResponse: {
110835
110835
  /** Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.
@@ -110856,8 +110856,7 @@ export type Routes = {
110856
110856
  route: '/unstable_partner/building_blocks/organize_spaces';
110857
110857
  method: 'POST';
110858
110858
  queryParams: {};
110859
- jsonBody: {};
110860
- commonParams: {
110859
+ jsonBody: {
110861
110860
  /** Customer key for which you want to organize spaces. */
110862
110861
  customer_key: string;
110863
110862
  /** Optional list of spaces that you want to include in the new building block magic link. */
@@ -110890,6 +110889,7 @@ export type Routes = {
110890
110889
  } | undefined;
110891
110890
  }[] | undefined;
110892
110891
  };
110892
+ commonParams: {};
110893
110893
  formData: {};
110894
110894
  jsonResponse: {
110895
110895
  /** Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.
@@ -110916,8 +110916,7 @@ export type Routes = {
110916
110916
  route: '/user_identities/add_acs_user';
110917
110917
  method: 'POST' | 'PUT';
110918
110918
  queryParams: {};
110919
- jsonBody: {};
110920
- commonParams: {
110919
+ jsonBody: {
110921
110920
  /** ID of the user identity to which you want to add an access system user. */
110922
110921
  user_identity_id?: string | undefined;
110923
110922
  /** Key of the user identity to which you want to add an access system user. */
@@ -110925,6 +110924,7 @@ export type Routes = {
110925
110924
  /** ID of the access system user that you want to add to the user identity. */
110926
110925
  acs_user_id: string;
110927
110926
  };
110927
+ commonParams: {};
110928
110928
  formData: {};
110929
110929
  jsonResponse: {};
110930
110930
  maxDuration: undefined;
@@ -110933,8 +110933,7 @@ export type Routes = {
110933
110933
  route: '/user_identities/create';
110934
110934
  method: 'POST';
110935
110935
  queryParams: {};
110936
- jsonBody: {};
110937
- commonParams: {
110936
+ jsonBody: {
110938
110937
  /** Unique key for the new user identity. */
110939
110938
  user_identity_key?: (string | null) | undefined;
110940
110939
  /** Unique email address for the new user identity. */
@@ -110946,6 +110945,7 @@ export type Routes = {
110946
110945
  /** List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity. */
110947
110946
  acs_system_ids?: string[] | undefined;
110948
110947
  };
110948
+ commonParams: {};
110949
110949
  formData: {};
110950
110950
  jsonResponse: {
110951
110951
  /** Represents a [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */
@@ -111058,8 +111058,7 @@ export type Routes = {
111058
111058
  route: '/user_identities/enrollment_automations/launch';
111059
111059
  method: 'POST';
111060
111060
  queryParams: {};
111061
- jsonBody: {};
111062
- commonParams: {
111061
+ jsonBody: {
111063
111062
  /** ID of the user identity for which you want to launch an enrollment automation. */
111064
111063
  user_identity_id: string;
111065
111064
  /** ID of the desired access system that serves as the credential manager for the enrollment automation. */
@@ -111071,6 +111070,7 @@ export type Routes = {
111071
111070
  /** ID of the associated access system user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. */
111072
111071
  credential_manager_acs_user_id?: string | undefined;
111073
111072
  };
111073
+ commonParams: {};
111074
111074
  formData: {};
111075
111075
  jsonResponse: {
111076
111076
  /** Represents an [enrollment automation](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/capability-guides/mobile-access/). */
@@ -111119,14 +111119,14 @@ export type Routes = {
111119
111119
  route: '/user_identities/generate_instant_key';
111120
111120
  method: 'POST';
111121
111121
  queryParams: {};
111122
- jsonBody: {};
111123
- commonParams: {
111122
+ jsonBody: {
111124
111123
  customization_profile_id?: string | undefined;
111125
111124
  /** ID of the user identity for which you want to generate an instant key. */
111126
111125
  user_identity_id: string;
111127
111126
  /** Maximum number of times the instant key can be used. Default: 1. */
111128
111127
  max_use_count?: number;
111129
111128
  };
111129
+ commonParams: {};
111130
111130
  formData: {};
111131
111131
  jsonResponse: {
111132
111132
  /** Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app.
@@ -111232,13 +111232,13 @@ export type Routes = {
111232
111232
  route: '/user_identities/grant_access_to_device';
111233
111233
  method: 'PUT' | 'POST';
111234
111234
  queryParams: {};
111235
- jsonBody: {};
111236
- commonParams: {
111235
+ jsonBody: {
111237
111236
  /** ID of the user identity that you want to grant access to a device. */
111238
111237
  user_identity_id: string;
111239
111238
  /** ID of the managed device to which you want to grant access to the user identity. */
111240
111239
  device_id: string;
111241
111240
  };
111241
+ commonParams: {};
111242
111242
  formData: {};
111243
111243
  jsonResponse: {};
111244
111244
  maxDuration: undefined;