@seamapi/types 1.444.1 → 1.445.1

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.
Files changed (26) hide show
  1. package/dist/connect.cjs +75 -73
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +114 -125
  4. package/dist/index.cjs +75 -73
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/access-grants/access-grant.js +12 -12
  7. package/lib/seam/connect/models/access-grants/access-method.js +1 -1
  8. package/lib/seam/connect/models/access-grants/requested-access-method.js +1 -1
  9. package/lib/seam/connect/models/connect-webviews/connect-webview.d.ts +3 -0
  10. package/lib/seam/connect/models/connect-webviews/connect-webview.js +4 -0
  11. package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
  12. package/lib/seam/connect/models/events/access-grants.js +6 -6
  13. package/lib/seam/connect/models/events/access-methods.js +1 -1
  14. package/lib/seam/connect/openapi.d.ts +6 -26
  15. package/lib/seam/connect/openapi.js +66 -65
  16. package/lib/seam/connect/openapi.js.map +1 -1
  17. package/lib/seam/connect/route-types.d.ts +105 -99
  18. package/package.json +1 -1
  19. package/src/lib/seam/connect/models/access-grants/access-grant.ts +12 -12
  20. package/src/lib/seam/connect/models/access-grants/access-method.ts +1 -1
  21. package/src/lib/seam/connect/models/access-grants/requested-access-method.ts +1 -1
  22. package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +4 -0
  23. package/src/lib/seam/connect/models/events/access-grants.ts +6 -6
  24. package/src/lib/seam/connect/models/events/access-methods.ts +1 -1
  25. package/src/lib/seam/connect/openapi.ts +71 -65
  26. package/src/lib/seam/connect/route-types.ts +105 -99
@@ -15988,6 +15988,7 @@ declare const connect_webview: z.ZodObject<{
15988
15988
  wait_for_device_creation: z.ZodBoolean;
15989
15989
  authorized_at: z.ZodNullable<z.ZodString>;
15990
15990
  selected_provider: z.ZodNullable<z.ZodString>;
15991
+ customer_key: z.ZodOptional<z.ZodString>;
15991
15992
  }, "strip", z.ZodTypeAny, {
15992
15993
  status: "pending" | "failed" | "authorized";
15993
15994
  workspace_id: string;
@@ -16009,6 +16010,7 @@ declare const connect_webview: z.ZodObject<{
16009
16010
  wait_for_device_creation: boolean;
16010
16011
  authorized_at: string | null;
16011
16012
  selected_provider: string | null;
16013
+ customer_key?: string | undefined;
16012
16014
  }, {
16013
16015
  status: "pending" | "failed" | "authorized";
16014
16016
  workspace_id: string;
@@ -16030,6 +16032,7 @@ declare const connect_webview: z.ZodObject<{
16030
16032
  wait_for_device_creation: boolean;
16031
16033
  authorized_at: string | null;
16032
16034
  selected_provider: string | null;
16035
+ customer_key?: string | undefined;
16033
16036
  }>;
16034
16037
  type ConnectWebview = z.infer<typeof connect_webview>;
16035
16038
 
@@ -31928,6 +31931,10 @@ declare const _default: {
31928
31931
  nullable: boolean;
31929
31932
  type: string;
31930
31933
  };
31934
+ customer_key: {
31935
+ description: string;
31936
+ type: string;
31937
+ };
31931
31938
  device_selection_mode: {
31932
31939
  enum: string[];
31933
31940
  type: string;
@@ -54067,8 +54074,8 @@ declare const _default: {
54067
54074
  description: string;
54068
54075
  type: string;
54069
54076
  };
54070
- customer_id: {
54071
- format: string;
54077
+ customer_key: {
54078
+ description: string;
54072
54079
  type: string;
54073
54080
  };
54074
54081
  device_selection_mode: {
@@ -54461,26 +54468,11 @@ declare const _default: {
54461
54468
  description: string;
54462
54469
  operationId: string;
54463
54470
  parameters: ({
54464
- in: string;
54465
- name: string;
54466
- schema: {
54467
- items: {
54468
- type: string;
54469
- };
54470
- type: string;
54471
- description?: never;
54472
- additionalProperties?: never;
54473
- default?: never;
54474
- format?: never;
54475
- nullable?: never;
54476
- };
54477
- } | {
54478
54471
  in: string;
54479
54472
  name: string;
54480
54473
  schema: {
54481
54474
  description: string;
54482
54475
  type: string;
54483
- items?: never;
54484
54476
  additionalProperties?: never;
54485
54477
  default?: never;
54486
54478
  format?: never;
@@ -54497,7 +54489,6 @@ declare const _default: {
54497
54489
  };
54498
54490
  description: string;
54499
54491
  type: string;
54500
- items?: never;
54501
54492
  default?: never;
54502
54493
  format?: never;
54503
54494
  nullable?: never;
@@ -54510,7 +54501,6 @@ declare const _default: {
54510
54501
  description: string;
54511
54502
  format: string;
54512
54503
  type: string;
54513
- items?: never;
54514
54504
  additionalProperties?: never;
54515
54505
  nullable?: never;
54516
54506
  };
@@ -54521,7 +54511,6 @@ declare const _default: {
54521
54511
  description: string;
54522
54512
  nullable: boolean;
54523
54513
  type: string;
54524
- items?: never;
54525
54514
  additionalProperties?: never;
54526
54515
  default?: never;
54527
54516
  format?: never;
@@ -54616,12 +54605,6 @@ declare const _default: {
54616
54605
  description: string;
54617
54606
  type: string;
54618
54607
  };
54619
- customer_ids: {
54620
- items: {
54621
- type: string;
54622
- };
54623
- type: string;
54624
- };
54625
54608
  limit: {
54626
54609
  default: number;
54627
54610
  description: string;
@@ -86738,41 +86721,41 @@ interface Routes {
86738
86721
  };
86739
86722
  formData: {};
86740
86723
  jsonResponse: {
86741
- /** 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. */
86724
+ /** 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. */
86742
86725
  access_grant: {
86743
- /** ID of the Seam workspace associated with the access grant. */
86726
+ /** ID of the Seam workspace associated with the Access Grant. */
86744
86727
  workspace_id: string;
86745
- /** ID of the access grant. */
86728
+ /** ID of the Access Grant. */
86746
86729
  access_grant_id: string;
86747
- /** ID of user identity to which the access grant gives access. */
86730
+ /** ID of user identity to which the Access Grant gives access. */
86748
86731
  user_identity_id: string;
86749
86732
  /**
86750
86733
  * @deprecated Use `space_ids`. */
86751
86734
  location_ids: string[];
86752
- /** IDs of the spaces to which the access grant gives access. */
86735
+ /** IDs of the spaces to which the Access Grant gives access. */
86753
86736
  space_ids: string[];
86754
- /** Access methods that the user requested for the access grant. */
86737
+ /** Access methods that the user requested for the Access Grant. */
86755
86738
  requested_access_methods: Array<{
86756
86739
  /** Display name of the access method. */
86757
86740
  display_name: string;
86758
86741
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
86759
86742
  mode: 'code' | 'card' | 'mobile_key';
86760
- /** Date and time at which the requested access method was added to the access grant. */
86743
+ /** Date and time at which the requested access method was added to the Access Grant. */
86761
86744
  created_at: string;
86762
86745
  /** IDs of the access methods created for the requested access method. */
86763
86746
  created_access_method_ids: string[];
86764
86747
  }>;
86765
- /** IDs of the access methods created for the access grant. */
86748
+ /** IDs of the access methods created for the Access Grant. */
86766
86749
  access_method_ids: string[];
86767
- /** Display name of the access grant. */
86750
+ /** Display name of the Access Grant. */
86768
86751
  display_name: string;
86769
- /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method. */
86752
+ /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
86770
86753
  instant_key_url?: string | undefined;
86771
- /** Date and time at which the access grant was created. */
86754
+ /** Date and time at which the Access Grant was created. */
86772
86755
  created_at: string;
86773
- /** Date and time at which the access grant starts. */
86756
+ /** Date and time at which the Access Grant starts. */
86774
86757
  starts_at?: string | undefined;
86775
- /** Date and time at which the access grant ends. */
86758
+ /** Date and time at which the Access Grant ends. */
86776
86759
  ends_at?: string | undefined;
86777
86760
  };
86778
86761
  };
@@ -86783,7 +86766,7 @@ interface Routes {
86783
86766
  queryParams: {};
86784
86767
  jsonBody: {};
86785
86768
  commonParams: {
86786
- /** ID of access grant to delete. */
86769
+ /** ID of Access Grant to delete. */
86787
86770
  access_grant_id: string;
86788
86771
  };
86789
86772
  formData: {};
@@ -86795,46 +86778,46 @@ interface Routes {
86795
86778
  queryParams: {};
86796
86779
  jsonBody: {};
86797
86780
  commonParams: {
86798
- /** ID of access grant to get. */
86781
+ /** ID of Access Grant to get. */
86799
86782
  access_grant_id: string;
86800
86783
  };
86801
86784
  formData: {};
86802
86785
  jsonResponse: {
86803
- /** 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. */
86786
+ /** 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. */
86804
86787
  access_grant: {
86805
- /** ID of the Seam workspace associated with the access grant. */
86788
+ /** ID of the Seam workspace associated with the Access Grant. */
86806
86789
  workspace_id: string;
86807
- /** ID of the access grant. */
86790
+ /** ID of the Access Grant. */
86808
86791
  access_grant_id: string;
86809
- /** ID of user identity to which the access grant gives access. */
86792
+ /** ID of user identity to which the Access Grant gives access. */
86810
86793
  user_identity_id: string;
86811
86794
  /**
86812
86795
  * @deprecated Use `space_ids`. */
86813
86796
  location_ids: string[];
86814
- /** IDs of the spaces to which the access grant gives access. */
86797
+ /** IDs of the spaces to which the Access Grant gives access. */
86815
86798
  space_ids: string[];
86816
- /** Access methods that the user requested for the access grant. */
86799
+ /** Access methods that the user requested for the Access Grant. */
86817
86800
  requested_access_methods: Array<{
86818
86801
  /** Display name of the access method. */
86819
86802
  display_name: string;
86820
86803
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
86821
86804
  mode: 'code' | 'card' | 'mobile_key';
86822
- /** Date and time at which the requested access method was added to the access grant. */
86805
+ /** Date and time at which the requested access method was added to the Access Grant. */
86823
86806
  created_at: string;
86824
86807
  /** IDs of the access methods created for the requested access method. */
86825
86808
  created_access_method_ids: string[];
86826
86809
  }>;
86827
- /** IDs of the access methods created for the access grant. */
86810
+ /** IDs of the access methods created for the Access Grant. */
86828
86811
  access_method_ids: string[];
86829
- /** Display name of the access grant. */
86812
+ /** Display name of the Access Grant. */
86830
86813
  display_name: string;
86831
- /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method. */
86814
+ /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
86832
86815
  instant_key_url?: string | undefined;
86833
- /** Date and time at which the access grant was created. */
86816
+ /** Date and time at which the Access Grant was created. */
86834
86817
  created_at: string;
86835
- /** Date and time at which the access grant starts. */
86818
+ /** Date and time at which the Access Grant starts. */
86836
86819
  starts_at?: string | undefined;
86837
- /** Date and time at which the access grant ends. */
86820
+ /** Date and time at which the Access Grant ends. */
86838
86821
  ends_at?: string | undefined;
86839
86822
  };
86840
86823
  };
@@ -86845,54 +86828,54 @@ interface Routes {
86845
86828
  queryParams: {};
86846
86829
  jsonBody: {};
86847
86830
  commonParams: {
86848
- /** ID of user identity to filter list of access grants by. */
86831
+ /** ID of user identity by which you want to filter the list of Access Grants. */
86849
86832
  user_identity_id?: string | undefined;
86850
- /** ID of system to filter list of access grants by. */
86833
+ /** ID of the access system by which you want to filter the list of Access Grants. */
86851
86834
  acs_system_id?: string | undefined;
86852
- /** ID of entrance to filter list of access grants by. */
86835
+ /** ID of the entrance by which you want to filter the list of Access Grants. */
86853
86836
  acs_entrance_id?: string | undefined;
86854
86837
  /**
86855
86838
  * @deprecated Use `space_id`. */
86856
86839
  location_id?: string | undefined;
86857
- /** ID of space to filter list of access grants by. */
86840
+ /** ID of the space by which you want to filter the list of Access Grants. */
86858
86841
  space_id?: string | undefined;
86859
86842
  };
86860
86843
  formData: {};
86861
86844
  jsonResponse: {
86862
86845
  access_grants: Array<{
86863
- /** ID of the Seam workspace associated with the access grant. */
86846
+ /** ID of the Seam workspace associated with the Access Grant. */
86864
86847
  workspace_id: string;
86865
- /** ID of the access grant. */
86848
+ /** ID of the Access Grant. */
86866
86849
  access_grant_id: string;
86867
- /** ID of user identity to which the access grant gives access. */
86850
+ /** ID of user identity to which the Access Grant gives access. */
86868
86851
  user_identity_id: string;
86869
86852
  /**
86870
86853
  * @deprecated Use `space_ids`. */
86871
86854
  location_ids: string[];
86872
- /** IDs of the spaces to which the access grant gives access. */
86855
+ /** IDs of the spaces to which the Access Grant gives access. */
86873
86856
  space_ids: string[];
86874
- /** Access methods that the user requested for the access grant. */
86857
+ /** Access methods that the user requested for the Access Grant. */
86875
86858
  requested_access_methods: Array<{
86876
86859
  /** Display name of the access method. */
86877
86860
  display_name: string;
86878
86861
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
86879
86862
  mode: 'code' | 'card' | 'mobile_key';
86880
- /** Date and time at which the requested access method was added to the access grant. */
86863
+ /** Date and time at which the requested access method was added to the Access Grant. */
86881
86864
  created_at: string;
86882
86865
  /** IDs of the access methods created for the requested access method. */
86883
86866
  created_access_method_ids: string[];
86884
86867
  }>;
86885
- /** IDs of the access methods created for the access grant. */
86868
+ /** IDs of the access methods created for the Access Grant. */
86886
86869
  access_method_ids: string[];
86887
- /** Display name of the access grant. */
86870
+ /** Display name of the Access Grant. */
86888
86871
  display_name: string;
86889
- /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method. */
86872
+ /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
86890
86873
  instant_key_url?: string | undefined;
86891
- /** Date and time at which the access grant was created. */
86874
+ /** Date and time at which the Access Grant was created. */
86892
86875
  created_at: string;
86893
- /** Date and time at which the access grant starts. */
86876
+ /** Date and time at which the Access Grant starts. */
86894
86877
  starts_at?: string | undefined;
86895
- /** Date and time at which the access grant ends. */
86878
+ /** Date and time at which the Access Grant ends. */
86896
86879
  ends_at?: string | undefined;
86897
86880
  }>;
86898
86881
  };
@@ -86903,7 +86886,7 @@ interface Routes {
86903
86886
  queryParams: {};
86904
86887
  jsonBody: {};
86905
86888
  commonParams: {
86906
- /** ID of the access grant to update. */
86889
+ /** ID of the Access Grant to update. */
86907
86890
  access_grant_id: string;
86908
86891
  /** 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. */
86909
86892
  starts_at?: (string | null) | undefined;
@@ -86931,7 +86914,7 @@ interface Routes {
86931
86914
  queryParams: {};
86932
86915
  jsonBody: {};
86933
86916
  commonParams: {
86934
- /** ID of the `acs_encoder` to use to encode the `acs_credential`. */
86917
+ /** ID of the `acs_encoder` to use to encode the `access_method`. */
86935
86918
  acs_encoder_id: string;
86936
86919
  /** ID of the `access_method` to encode onto a card. */
86937
86920
  access_method_id: string;
@@ -88196,7 +88179,7 @@ interface Routes {
88196
88179
  };
88197
88180
  formData: {};
88198
88181
  jsonResponse: {
88199
- /** Represents an access method for an access grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key. */
88182
+ /** Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key. */
88200
88183
  access_method: {
88201
88184
  /** ID of the Seam workspace associated with the access method. */
88202
88185
  workspace_id: string;
@@ -88225,7 +88208,7 @@ interface Routes {
88225
88208
  queryParams: {};
88226
88209
  jsonBody: {};
88227
88210
  commonParams: {
88228
- /** ID of access grant to list access methods for. */
88211
+ /** ID of Access Grant to list access methods for. */
88229
88212
  access_grant_id: string;
88230
88213
  /** ID of the device for which you want to retrieve all access methods. */
88231
88214
  device_id?: string | undefined;
@@ -98194,7 +98177,8 @@ interface Routes {
98194
98177
  custom_redirect_url?: string | undefined;
98195
98178
  /** Alternative URL that you want to redirect the user to on an error. If you do not set this parameter, the Connect Webview falls back to the `custom_redirect_url`. */
98196
98179
  custom_redirect_failure_url?: string | undefined;
98197
- customer_id?: string | undefined;
98180
+ /** Optional unique string key that can be used to identify the customer. If provided, the customer will be created or retrieved based on this key. */
98181
+ customer_key?: string | undefined;
98198
98182
  /** Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters. */
98199
98183
  accepted_providers?: Array<'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'seam_bridge' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'kwikset2' | 'yale_access' | 'hid_cm' | 'google_nest'> | undefined;
98200
98184
  /** Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with the desired `provider_category` filter. */
@@ -98264,6 +98248,8 @@ interface Routes {
98264
98248
  authorized_at: string | null;
98265
98249
  /** Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
98266
98250
  selected_provider: string | null;
98251
+ /** The customer key associated with this webview, if any. */
98252
+ customer_key?: string | undefined;
98267
98253
  };
98268
98254
  };
98269
98255
  };
@@ -98343,6 +98329,8 @@ interface Routes {
98343
98329
  authorized_at: string | null;
98344
98330
  /** Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
98345
98331
  selected_provider: string | null;
98332
+ /** The customer key associated with this webview, if any. */
98333
+ customer_key?: string | undefined;
98346
98334
  };
98347
98335
  };
98348
98336
  };
@@ -98352,7 +98340,6 @@ interface Routes {
98352
98340
  queryParams: {};
98353
98341
  jsonBody: {};
98354
98342
  commonParams: {
98355
- customer_ids?: string[] | undefined;
98356
98343
  /** Your user ID for the user by which you want to filter Connect Webviews. */
98357
98344
  user_identifier_key?: string | undefined;
98358
98345
  /** Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. */
@@ -98406,6 +98393,8 @@ interface Routes {
98406
98393
  authorized_at: string | null;
98407
98394
  /** Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
98408
98395
  selected_provider: string | null;
98396
+ /** The customer key associated with this webview, if any. */
98397
+ customer_key?: string | undefined;
98409
98398
  }>;
98410
98399
  /** Information about the current page of results. */
98411
98400
  pagination: {
@@ -103164,7 +103153,7 @@ interface Routes {
103164
103153
  created_at: string;
103165
103154
  /** Date and time at which the event occurred. */
103166
103155
  occurred_at: string;
103167
- /** ID of the affected access grant. */
103156
+ /** ID of the affected Access Grant. */
103168
103157
  access_grant_id: string;
103169
103158
  event_type: 'access_grant.created';
103170
103159
  } | {
@@ -103176,7 +103165,7 @@ interface Routes {
103176
103165
  created_at: string;
103177
103166
  /** Date and time at which the event occurred. */
103178
103167
  occurred_at: string;
103179
- /** ID of the affected access grant. */
103168
+ /** ID of the affected Access Grant. */
103180
103169
  access_grant_id: string;
103181
103170
  event_type: 'access_grant.deleted';
103182
103171
  } | {
@@ -103188,7 +103177,7 @@ interface Routes {
103188
103177
  created_at: string;
103189
103178
  /** Date and time at which the event occurred. */
103190
103179
  occurred_at: string;
103191
- /** ID of the affected access grant. */
103180
+ /** ID of the affected Access Grant. */
103192
103181
  access_grant_id: string;
103193
103182
  event_type: 'access_grant.access_granted_to_all_doors';
103194
103183
  } | {
@@ -103200,7 +103189,7 @@ interface Routes {
103200
103189
  created_at: string;
103201
103190
  /** Date and time at which the event occurred. */
103202
103191
  occurred_at: string;
103203
- /** ID of the affected access grant. */
103192
+ /** ID of the affected Access Grant. */
103204
103193
  access_grant_id: string;
103205
103194
  event_type: 'access_grant.access_granted_to_door';
103206
103195
  /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
@@ -103214,7 +103203,7 @@ interface Routes {
103214
103203
  created_at: string;
103215
103204
  /** Date and time at which the event occurred. */
103216
103205
  occurred_at: string;
103217
- /** ID of the affected access grant. */
103206
+ /** ID of the affected Access Grant. */
103218
103207
  access_grant_id: string;
103219
103208
  event_type: 'access_grant.access_to_door_lost';
103220
103209
  /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
@@ -104816,7 +104805,7 @@ interface Routes {
104816
104805
  created_at: string;
104817
104806
  /** Date and time at which the event occurred. */
104818
104807
  occurred_at: string;
104819
- /** ID of the affected access grant. */
104808
+ /** ID of the affected Access Grant. */
104820
104809
  access_grant_id: string;
104821
104810
  event_type: 'access_grant.created';
104822
104811
  } | {
@@ -104828,7 +104817,7 @@ interface Routes {
104828
104817
  created_at: string;
104829
104818
  /** Date and time at which the event occurred. */
104830
104819
  occurred_at: string;
104831
- /** ID of the affected access grant. */
104820
+ /** ID of the affected Access Grant. */
104832
104821
  access_grant_id: string;
104833
104822
  event_type: 'access_grant.deleted';
104834
104823
  } | {
@@ -104840,7 +104829,7 @@ interface Routes {
104840
104829
  created_at: string;
104841
104830
  /** Date and time at which the event occurred. */
104842
104831
  occurred_at: string;
104843
- /** ID of the affected access grant. */
104832
+ /** ID of the affected Access Grant. */
104844
104833
  access_grant_id: string;
104845
104834
  event_type: 'access_grant.access_granted_to_all_doors';
104846
104835
  } | {
@@ -104852,7 +104841,7 @@ interface Routes {
104852
104841
  created_at: string;
104853
104842
  /** Date and time at which the event occurred. */
104854
104843
  occurred_at: string;
104855
- /** ID of the affected access grant. */
104844
+ /** ID of the affected Access Grant. */
104856
104845
  access_grant_id: string;
104857
104846
  event_type: 'access_grant.access_granted_to_door';
104858
104847
  /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
@@ -104866,7 +104855,7 @@ interface Routes {
104866
104855
  created_at: string;
104867
104856
  /** Date and time at which the event occurred. */
104868
104857
  occurred_at: string;
104869
- /** ID of the affected access grant. */
104858
+ /** ID of the affected Access Grant. */
104870
104859
  access_grant_id: string;
104871
104860
  event_type: 'access_grant.access_to_door_lost';
104872
104861
  /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
@@ -140225,41 +140214,41 @@ interface Routes {
140225
140214
  };
140226
140215
  formData: {};
140227
140216
  jsonResponse: {
140228
- /** 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. */
140217
+ /** 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. */
140229
140218
  access_grant: {
140230
- /** ID of the Seam workspace associated with the access grant. */
140219
+ /** ID of the Seam workspace associated with the Access Grant. */
140231
140220
  workspace_id: string;
140232
- /** ID of the access grant. */
140221
+ /** ID of the Access Grant. */
140233
140222
  access_grant_id: string;
140234
- /** ID of user identity to which the access grant gives access. */
140223
+ /** ID of user identity to which the Access Grant gives access. */
140235
140224
  user_identity_id: string;
140236
140225
  /**
140237
140226
  * @deprecated Use `space_ids`. */
140238
140227
  location_ids: string[];
140239
- /** IDs of the spaces to which the access grant gives access. */
140228
+ /** IDs of the spaces to which the Access Grant gives access. */
140240
140229
  space_ids: string[];
140241
- /** Access methods that the user requested for the access grant. */
140230
+ /** Access methods that the user requested for the Access Grant. */
140242
140231
  requested_access_methods: Array<{
140243
140232
  /** Display name of the access method. */
140244
140233
  display_name: string;
140245
140234
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
140246
140235
  mode: 'code' | 'card' | 'mobile_key';
140247
- /** Date and time at which the requested access method was added to the access grant. */
140236
+ /** Date and time at which the requested access method was added to the Access Grant. */
140248
140237
  created_at: string;
140249
140238
  /** IDs of the access methods created for the requested access method. */
140250
140239
  created_access_method_ids: string[];
140251
140240
  }>;
140252
- /** IDs of the access methods created for the access grant. */
140241
+ /** IDs of the access methods created for the Access Grant. */
140253
140242
  access_method_ids: string[];
140254
- /** Display name of the access grant. */
140243
+ /** Display name of the Access Grant. */
140255
140244
  display_name: string;
140256
- /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method. */
140245
+ /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
140257
140246
  instant_key_url?: string | undefined;
140258
- /** Date and time at which the access grant was created. */
140247
+ /** Date and time at which the Access Grant was created. */
140259
140248
  created_at: string;
140260
- /** Date and time at which the access grant starts. */
140249
+ /** Date and time at which the Access Grant starts. */
140261
140250
  starts_at?: string | undefined;
140262
- /** Date and time at which the access grant ends. */
140251
+ /** Date and time at which the Access Grant ends. */
140263
140252
  ends_at?: string | undefined;
140264
140253
  };
140265
140254
  };
@@ -140287,41 +140276,41 @@ interface Routes {
140287
140276
  };
140288
140277
  formData: {};
140289
140278
  jsonResponse: {
140290
- /** 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. */
140279
+ /** 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. */
140291
140280
  access_grant: {
140292
- /** ID of the Seam workspace associated with the access grant. */
140281
+ /** ID of the Seam workspace associated with the Access Grant. */
140293
140282
  workspace_id: string;
140294
- /** ID of the access grant. */
140283
+ /** ID of the Access Grant. */
140295
140284
  access_grant_id: string;
140296
- /** ID of user identity to which the access grant gives access. */
140285
+ /** ID of user identity to which the Access Grant gives access. */
140297
140286
  user_identity_id: string;
140298
140287
  /**
140299
140288
  * @deprecated Use `space_ids`. */
140300
140289
  location_ids: string[];
140301
- /** IDs of the spaces to which the access grant gives access. */
140290
+ /** IDs of the spaces to which the Access Grant gives access. */
140302
140291
  space_ids: string[];
140303
- /** Access methods that the user requested for the access grant. */
140292
+ /** Access methods that the user requested for the Access Grant. */
140304
140293
  requested_access_methods: Array<{
140305
140294
  /** Display name of the access method. */
140306
140295
  display_name: string;
140307
140296
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
140308
140297
  mode: 'code' | 'card' | 'mobile_key';
140309
- /** Date and time at which the requested access method was added to the access grant. */
140298
+ /** Date and time at which the requested access method was added to the Access Grant. */
140310
140299
  created_at: string;
140311
140300
  /** IDs of the access methods created for the requested access method. */
140312
140301
  created_access_method_ids: string[];
140313
140302
  }>;
140314
- /** IDs of the access methods created for the access grant. */
140303
+ /** IDs of the access methods created for the Access Grant. */
140315
140304
  access_method_ids: string[];
140316
- /** Display name of the access grant. */
140305
+ /** Display name of the Access Grant. */
140317
140306
  display_name: string;
140318
- /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method. */
140307
+ /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
140319
140308
  instant_key_url?: string | undefined;
140320
- /** Date and time at which the access grant was created. */
140309
+ /** Date and time at which the Access Grant was created. */
140321
140310
  created_at: string;
140322
- /** Date and time at which the access grant starts. */
140311
+ /** Date and time at which the Access Grant starts. */
140323
140312
  starts_at?: string | undefined;
140324
- /** Date and time at which the access grant ends. */
140313
+ /** Date and time at which the Access Grant ends. */
140325
140314
  ends_at?: string | undefined;
140326
140315
  };
140327
140316
  };
@@ -140347,39 +140336,39 @@ interface Routes {
140347
140336
  formData: {};
140348
140337
  jsonResponse: {
140349
140338
  access_grants: Array<{
140350
- /** ID of the Seam workspace associated with the access grant. */
140339
+ /** ID of the Seam workspace associated with the Access Grant. */
140351
140340
  workspace_id: string;
140352
- /** ID of the access grant. */
140341
+ /** ID of the Access Grant. */
140353
140342
  access_grant_id: string;
140354
- /** ID of user identity to which the access grant gives access. */
140343
+ /** ID of user identity to which the Access Grant gives access. */
140355
140344
  user_identity_id: string;
140356
140345
  /**
140357
140346
  * @deprecated Use `space_ids`. */
140358
140347
  location_ids: string[];
140359
- /** IDs of the spaces to which the access grant gives access. */
140348
+ /** IDs of the spaces to which the Access Grant gives access. */
140360
140349
  space_ids: string[];
140361
- /** Access methods that the user requested for the access grant. */
140350
+ /** Access methods that the user requested for the Access Grant. */
140362
140351
  requested_access_methods: Array<{
140363
140352
  /** Display name of the access method. */
140364
140353
  display_name: string;
140365
140354
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
140366
140355
  mode: 'code' | 'card' | 'mobile_key';
140367
- /** Date and time at which the requested access method was added to the access grant. */
140356
+ /** Date and time at which the requested access method was added to the Access Grant. */
140368
140357
  created_at: string;
140369
140358
  /** IDs of the access methods created for the requested access method. */
140370
140359
  created_access_method_ids: string[];
140371
140360
  }>;
140372
- /** IDs of the access methods created for the access grant. */
140361
+ /** IDs of the access methods created for the Access Grant. */
140373
140362
  access_method_ids: string[];
140374
- /** Display name of the access grant. */
140363
+ /** Display name of the Access Grant. */
140375
140364
  display_name: string;
140376
- /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method. */
140365
+ /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
140377
140366
  instant_key_url?: string | undefined;
140378
- /** Date and time at which the access grant was created. */
140367
+ /** Date and time at which the Access Grant was created. */
140379
140368
  created_at: string;
140380
- /** Date and time at which the access grant starts. */
140369
+ /** Date and time at which the Access Grant starts. */
140381
140370
  starts_at?: string | undefined;
140382
- /** Date and time at which the access grant ends. */
140371
+ /** Date and time at which the Access Grant ends. */
140383
140372
  ends_at?: string | undefined;
140384
140373
  }>;
140385
140374
  };
@@ -140407,7 +140396,7 @@ interface Routes {
140407
140396
  };
140408
140397
  formData: {};
140409
140398
  jsonResponse: {
140410
- /** Represents an access method for an access grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key. */
140399
+ /** Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key. */
140411
140400
  access_method: {
140412
140401
  /** ID of the Seam workspace associated with the access method. */
140413
140402
  workspace_id: string;