@seamapi/types 1.445.0 → 1.446.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.
Files changed (30) hide show
  1. package/dist/connect.cjs +148 -103
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +230 -135
  4. package/dist/index.cjs +148 -103
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/access-grants/access-grant.d.ts +3 -0
  7. package/lib/seam/connect/models/access-grants/access-grant.js +16 -12
  8. package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
  9. package/lib/seam/connect/models/access-grants/access-method.js +1 -1
  10. package/lib/seam/connect/models/access-grants/requested-access-method.js +1 -1
  11. package/lib/seam/connect/models/batches/batch.d.ts +5 -0
  12. package/lib/seam/connect/models/batches/spaces.d.ts +5 -0
  13. package/lib/seam/connect/models/events/access-grants.js +6 -6
  14. package/lib/seam/connect/models/events/access-methods.js +1 -1
  15. package/lib/seam/connect/models/spaces/space.d.ts +3 -0
  16. package/lib/seam/connect/models/spaces/space.js +4 -0
  17. package/lib/seam/connect/models/spaces/space.js.map +1 -1
  18. package/lib/seam/connect/openapi.d.ts +86 -38
  19. package/lib/seam/connect/openapi.js +140 -96
  20. package/lib/seam/connect/openapi.js.map +1 -1
  21. package/lib/seam/connect/route-types.d.ts +133 -97
  22. package/package.json +1 -1
  23. package/src/lib/seam/connect/models/access-grants/access-grant.ts +16 -12
  24. package/src/lib/seam/connect/models/access-grants/access-method.ts +1 -1
  25. package/src/lib/seam/connect/models/access-grants/requested-access-method.ts +1 -1
  26. package/src/lib/seam/connect/models/events/access-grants.ts +6 -6
  27. package/src/lib/seam/connect/models/events/access-methods.ts +1 -1
  28. package/src/lib/seam/connect/models/spaces/space.ts +4 -0
  29. package/src/lib/seam/connect/openapi.ts +147 -96
  30. package/src/lib/seam/connect/route-types.ts +144 -104
@@ -3603,6 +3603,7 @@ type UnmanagedAccessCode = z.infer<typeof unmanaged_access_code>;
3603
3603
  declare const access_grant: z.ZodObject<{
3604
3604
  workspace_id: z.ZodString;
3605
3605
  access_grant_id: z.ZodString;
3606
+ access_grant_key: z.ZodOptional<z.ZodString>;
3606
3607
  user_identity_id: z.ZodString;
3607
3608
  location_ids: z.ZodArray<z.ZodString, "many">;
3608
3609
  space_ids: z.ZodArray<z.ZodString, "many">;
@@ -3645,6 +3646,7 @@ declare const access_grant: z.ZodObject<{
3645
3646
  access_method_ids: string[];
3646
3647
  starts_at?: string | undefined;
3647
3648
  ends_at?: string | undefined;
3649
+ access_grant_key?: string | undefined;
3648
3650
  instant_key_url?: string | undefined;
3649
3651
  }, {
3650
3652
  display_name: string;
@@ -3663,6 +3665,7 @@ declare const access_grant: z.ZodObject<{
3663
3665
  access_method_ids: string[];
3664
3666
  starts_at?: string | undefined;
3665
3667
  ends_at?: string | undefined;
3668
+ access_grant_key?: string | undefined;
3666
3669
  instant_key_url?: string | undefined;
3667
3670
  }>;
3668
3671
  type AccessGrant = z.infer<typeof access_grant>;
@@ -10124,6 +10127,7 @@ declare const batch: z.ZodObject<{
10124
10127
  spaces: z.ZodOptional<z.ZodArray<z.ZodObject<{
10125
10128
  space_id: z.ZodString;
10126
10129
  workspace_id: z.ZodString;
10130
+ space_key: z.ZodOptional<z.ZodString>;
10127
10131
  name: z.ZodString;
10128
10132
  display_name: z.ZodString;
10129
10133
  created_at: z.ZodString;
@@ -10137,6 +10141,7 @@ declare const batch: z.ZodObject<{
10137
10141
  space_id: string;
10138
10142
  device_count: number;
10139
10143
  acs_entrance_count: number;
10144
+ space_key?: string | undefined;
10140
10145
  }, {
10141
10146
  name: string;
10142
10147
  display_name: string;
@@ -10145,6 +10150,7 @@ declare const batch: z.ZodObject<{
10145
10150
  space_id: string;
10146
10151
  device_count: number;
10147
10152
  acs_entrance_count: number;
10153
+ space_key?: string | undefined;
10148
10154
  }>, "many">>;
10149
10155
  devices: z.ZodOptional<z.ZodArray<z.ZodObject<{
10150
10156
  device_id: z.ZodString;
@@ -14403,6 +14409,7 @@ declare const batch: z.ZodObject<{
14403
14409
  space_id: string;
14404
14410
  device_count: number;
14405
14411
  acs_entrance_count: number;
14412
+ space_key?: string | undefined;
14406
14413
  }[] | undefined;
14407
14414
  devices?: {
14408
14415
  display_name: string;
@@ -15103,6 +15110,7 @@ declare const batch: z.ZodObject<{
15103
15110
  space_id: string;
15104
15111
  device_count: number;
15105
15112
  acs_entrance_count: number;
15113
+ space_key?: string | undefined;
15106
15114
  }[] | undefined;
15107
15115
  devices?: {
15108
15116
  display_name: string;
@@ -27583,6 +27591,7 @@ type MagicLink = z.infer<typeof magic_link>;
27583
27591
  declare const space: z.ZodObject<{
27584
27592
  space_id: z.ZodString;
27585
27593
  workspace_id: z.ZodString;
27594
+ space_key: z.ZodOptional<z.ZodString>;
27586
27595
  name: z.ZodString;
27587
27596
  display_name: z.ZodString;
27588
27597
  created_at: z.ZodString;
@@ -27596,6 +27605,7 @@ declare const space: z.ZodObject<{
27596
27605
  space_id: string;
27597
27606
  device_count: number;
27598
27607
  acs_entrance_count: number;
27608
+ space_key?: string | undefined;
27599
27609
  }, {
27600
27610
  name: string;
27601
27611
  display_name: string;
@@ -27604,6 +27614,7 @@ declare const space: z.ZodObject<{
27604
27614
  space_id: string;
27605
27615
  device_count: number;
27606
27616
  acs_entrance_count: number;
27617
+ space_key?: string | undefined;
27607
27618
  }>;
27608
27619
  type Space = z.infer<typeof space>;
27609
27620
 
@@ -28410,6 +28421,10 @@ declare const _default: {
28410
28421
  format: string;
28411
28422
  type: string;
28412
28423
  };
28424
+ access_grant_key: {
28425
+ description: string;
28426
+ type: string;
28427
+ };
28413
28428
  access_method_ids: {
28414
28429
  description: string;
28415
28430
  items: {
@@ -39107,6 +39122,10 @@ declare const _default: {
39107
39122
  format: string;
39108
39123
  type: string;
39109
39124
  };
39125
+ space_key: {
39126
+ description: string;
39127
+ type: string;
39128
+ };
39110
39129
  workspace_id: {
39111
39130
  description: string;
39112
39131
  format: string;
@@ -44333,6 +44352,10 @@ declare const _default: {
44333
44352
  type?: never;
44334
44353
  } | {
44335
44354
  properties: {
44355
+ access_grant_key: {
44356
+ description: string;
44357
+ type: string;
44358
+ };
44336
44359
  acs_entrance_ids: {
44337
44360
  default: never[];
44338
44361
  description: string;
@@ -44632,16 +44655,6 @@ declare const _default: {
44632
44655
  get: {
44633
44656
  description: string;
44634
44657
  operationId: string;
44635
- parameters: {
44636
- in: string;
44637
- name: string;
44638
- required: boolean;
44639
- schema: {
44640
- description: string;
44641
- format: string;
44642
- type: string;
44643
- };
44644
- }[];
44645
44658
  responses: {
44646
44659
  200: {
44647
44660
  content: {
@@ -44706,15 +44719,28 @@ declare const _default: {
44706
44719
  content: {
44707
44720
  'application/json': {
44708
44721
  schema: {
44709
- properties: {
44710
- access_grant_id: {
44711
- description: string;
44712
- format: string;
44713
- type: string;
44722
+ oneOf: ({
44723
+ properties: {
44724
+ access_grant_id: {
44725
+ description: string;
44726
+ format: string;
44727
+ type: string;
44728
+ };
44729
+ access_grant_key?: never;
44714
44730
  };
44715
- };
44716
- required: string[];
44717
- type: string;
44731
+ required: string[];
44732
+ type: string;
44733
+ } | {
44734
+ properties: {
44735
+ access_grant_key: {
44736
+ description: string;
44737
+ type: string;
44738
+ };
44739
+ access_grant_id?: never;
44740
+ };
44741
+ required: string[];
44742
+ type: string;
44743
+ })[];
44718
44744
  };
44719
44745
  };
44720
44746
  };
@@ -44801,6 +44827,16 @@ declare const _default: {
44801
44827
  'x-deprecated': string;
44802
44828
  description?: never;
44803
44829
  };
44830
+ } | {
44831
+ in: string;
44832
+ name: string;
44833
+ schema: {
44834
+ description: string;
44835
+ type: string;
44836
+ format?: never;
44837
+ deprecated?: never;
44838
+ 'x-deprecated'?: never;
44839
+ };
44804
44840
  })[];
44805
44841
  responses: {
44806
44842
  200: {
@@ -44870,6 +44906,10 @@ declare const _default: {
44870
44906
  'application/json': {
44871
44907
  schema: {
44872
44908
  properties: {
44909
+ access_grant_key: {
44910
+ description: string;
44911
+ type: string;
44912
+ };
44873
44913
  acs_entrance_id: {
44874
44914
  description: string;
44875
44915
  format: string;
@@ -65555,6 +65595,10 @@ declare const _default: {
65555
65595
  description: string;
65556
65596
  type: string;
65557
65597
  };
65598
+ space_key: {
65599
+ description: string;
65600
+ type: string;
65601
+ };
65558
65602
  };
65559
65603
  required: string[];
65560
65604
  type: string;
@@ -65748,16 +65792,6 @@ declare const _default: {
65748
65792
  get: {
65749
65793
  description: string;
65750
65794
  operationId: string;
65751
- parameters: {
65752
- in: string;
65753
- name: string;
65754
- required: boolean;
65755
- schema: {
65756
- description: string;
65757
- format: string;
65758
- type: string;
65759
- };
65760
- }[];
65761
65795
  responses: {
65762
65796
  200: {
65763
65797
  content: {
@@ -65814,15 +65848,28 @@ declare const _default: {
65814
65848
  content: {
65815
65849
  'application/json': {
65816
65850
  schema: {
65817
- properties: {
65818
- space_id: {
65819
- description: string;
65820
- format: string;
65821
- type: string;
65851
+ oneOf: ({
65852
+ properties: {
65853
+ space_id: {
65854
+ description: string;
65855
+ format: string;
65856
+ type: string;
65857
+ };
65858
+ space_key?: never;
65822
65859
  };
65823
- };
65824
- required: string[];
65825
- type: string;
65860
+ required: string[];
65861
+ type: string;
65862
+ } | {
65863
+ properties: {
65864
+ space_key: {
65865
+ description: string;
65866
+ type: string;
65867
+ };
65868
+ space_id?: never;
65869
+ };
65870
+ required: string[];
65871
+ type: string;
65872
+ })[];
65826
65873
  };
65827
65874
  };
65828
65875
  };
@@ -66104,7 +66151,7 @@ declare const _default: {
66104
66151
  get: {
66105
66152
  description: string;
66106
66153
  operationId: string;
66107
- parameters: {
66154
+ parameters: ({
66108
66155
  in: string;
66109
66156
  name: string;
66110
66157
  schema: {
@@ -66112,7 +66159,15 @@ declare const _default: {
66112
66159
  minLength: number;
66113
66160
  type: string;
66114
66161
  };
66115
- }[];
66162
+ } | {
66163
+ in: string;
66164
+ name: string;
66165
+ schema: {
66166
+ description: string;
66167
+ type: string;
66168
+ minLength?: never;
66169
+ };
66170
+ })[];
66116
66171
  responses: {
66117
66172
  200: {
66118
66173
  content: {
@@ -66178,6 +66233,10 @@ declare const _default: {
66178
66233
  minLength: number;
66179
66234
  type: string;
66180
66235
  };
66236
+ space_key: {
66237
+ description: string;
66238
+ type: string;
66239
+ };
66181
66240
  };
66182
66241
  type: string;
66183
66242
  };
@@ -86690,6 +86749,8 @@ interface Routes {
86690
86749
  full_name?: (string | null) | undefined;
86691
86750
  };
86692
86751
  }) & {
86752
+ /** Unique key for the access grant within the workspace. */
86753
+ access_grant_key?: string | undefined;
86693
86754
  /**
86694
86755
  * @deprecated Use `space_ids`. */
86695
86756
  location_ids?: string[] | undefined;
@@ -86721,41 +86782,43 @@ interface Routes {
86721
86782
  };
86722
86783
  formData: {};
86723
86784
  jsonResponse: {
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. */
86785
+ /** 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. */
86725
86786
  access_grant: {
86726
- /** ID of the Seam workspace associated with the access grant. */
86787
+ /** ID of the Seam workspace associated with the Access Grant. */
86727
86788
  workspace_id: string;
86728
- /** ID of the access grant. */
86789
+ /** ID of the Access Grant. */
86729
86790
  access_grant_id: string;
86730
- /** ID of user identity to which the access grant gives access. */
86791
+ /** Unique key for the access grant within the workspace. */
86792
+ access_grant_key?: string | undefined;
86793
+ /** ID of user identity to which the Access Grant gives access. */
86731
86794
  user_identity_id: string;
86732
86795
  /**
86733
86796
  * @deprecated Use `space_ids`. */
86734
86797
  location_ids: string[];
86735
- /** IDs of the spaces to which the access grant gives access. */
86798
+ /** IDs of the spaces to which the Access Grant gives access. */
86736
86799
  space_ids: string[];
86737
- /** Access methods that the user requested for the access grant. */
86800
+ /** Access methods that the user requested for the Access Grant. */
86738
86801
  requested_access_methods: Array<{
86739
86802
  /** Display name of the access method. */
86740
86803
  display_name: string;
86741
86804
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
86742
86805
  mode: 'code' | 'card' | 'mobile_key';
86743
- /** Date and time at which the requested access method was added to the access grant. */
86806
+ /** Date and time at which the requested access method was added to the Access Grant. */
86744
86807
  created_at: string;
86745
86808
  /** IDs of the access methods created for the requested access method. */
86746
86809
  created_access_method_ids: string[];
86747
86810
  }>;
86748
- /** IDs of the access methods created for the access grant. */
86811
+ /** IDs of the access methods created for the Access Grant. */
86749
86812
  access_method_ids: string[];
86750
- /** Display name of the access grant. */
86813
+ /** Display name of the Access Grant. */
86751
86814
  display_name: string;
86752
- /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method. */
86815
+ /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
86753
86816
  instant_key_url?: string | undefined;
86754
- /** Date and time at which the access grant was created. */
86817
+ /** Date and time at which the Access Grant was created. */
86755
86818
  created_at: string;
86756
- /** Date and time at which the access grant starts. */
86819
+ /** Date and time at which the Access Grant starts. */
86757
86820
  starts_at?: string | undefined;
86758
- /** Date and time at which the access grant ends. */
86821
+ /** Date and time at which the Access Grant ends. */
86759
86822
  ends_at?: string | undefined;
86760
86823
  };
86761
86824
  };
@@ -86766,7 +86829,7 @@ interface Routes {
86766
86829
  queryParams: {};
86767
86830
  jsonBody: {};
86768
86831
  commonParams: {
86769
- /** ID of access grant to delete. */
86832
+ /** ID of Access Grant to delete. */
86770
86833
  access_grant_id: string;
86771
86834
  };
86772
86835
  formData: {};
@@ -86778,46 +86841,51 @@ interface Routes {
86778
86841
  queryParams: {};
86779
86842
  jsonBody: {};
86780
86843
  commonParams: {
86781
- /** ID of access grant to get. */
86844
+ /** ID of Access Grant to get. */
86782
86845
  access_grant_id: string;
86846
+ } | {
86847
+ /** Unique key of Access Grant to get. */
86848
+ access_grant_key: string;
86783
86849
  };
86784
86850
  formData: {};
86785
86851
  jsonResponse: {
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. */
86852
+ /** 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. */
86787
86853
  access_grant: {
86788
- /** ID of the Seam workspace associated with the access grant. */
86854
+ /** ID of the Seam workspace associated with the Access Grant. */
86789
86855
  workspace_id: string;
86790
- /** ID of the access grant. */
86856
+ /** ID of the Access Grant. */
86791
86857
  access_grant_id: string;
86792
- /** ID of user identity to which the access grant gives access. */
86858
+ /** Unique key for the access grant within the workspace. */
86859
+ access_grant_key?: string | undefined;
86860
+ /** ID of user identity to which the Access Grant gives access. */
86793
86861
  user_identity_id: string;
86794
86862
  /**
86795
86863
  * @deprecated Use `space_ids`. */
86796
86864
  location_ids: string[];
86797
- /** IDs of the spaces to which the access grant gives access. */
86865
+ /** IDs of the spaces to which the Access Grant gives access. */
86798
86866
  space_ids: string[];
86799
- /** Access methods that the user requested for the access grant. */
86867
+ /** Access methods that the user requested for the Access Grant. */
86800
86868
  requested_access_methods: Array<{
86801
86869
  /** Display name of the access method. */
86802
86870
  display_name: string;
86803
86871
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
86804
86872
  mode: 'code' | 'card' | 'mobile_key';
86805
- /** Date and time at which the requested access method was added to the access grant. */
86873
+ /** Date and time at which the requested access method was added to the Access Grant. */
86806
86874
  created_at: string;
86807
86875
  /** IDs of the access methods created for the requested access method. */
86808
86876
  created_access_method_ids: string[];
86809
86877
  }>;
86810
- /** IDs of the access methods created for the access grant. */
86878
+ /** IDs of the access methods created for the Access Grant. */
86811
86879
  access_method_ids: string[];
86812
- /** Display name of the access grant. */
86880
+ /** Display name of the Access Grant. */
86813
86881
  display_name: string;
86814
- /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method. */
86882
+ /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
86815
86883
  instant_key_url?: string | undefined;
86816
- /** Date and time at which the access grant was created. */
86884
+ /** Date and time at which the Access Grant was created. */
86817
86885
  created_at: string;
86818
- /** Date and time at which the access grant starts. */
86886
+ /** Date and time at which the Access Grant starts. */
86819
86887
  starts_at?: string | undefined;
86820
- /** Date and time at which the access grant ends. */
86888
+ /** Date and time at which the Access Grant ends. */
86821
86889
  ends_at?: string | undefined;
86822
86890
  };
86823
86891
  };
@@ -86828,54 +86896,58 @@ interface Routes {
86828
86896
  queryParams: {};
86829
86897
  jsonBody: {};
86830
86898
  commonParams: {
86831
- /** ID of user identity to filter list of access grants by. */
86899
+ /** ID of user identity by which you want to filter the list of Access Grants. */
86832
86900
  user_identity_id?: string | undefined;
86833
- /** ID of system to filter list of access grants by. */
86901
+ /** ID of the access system by which you want to filter the list of Access Grants. */
86834
86902
  acs_system_id?: string | undefined;
86835
- /** ID of entrance to filter list of access grants by. */
86903
+ /** ID of the entrance by which you want to filter the list of Access Grants. */
86836
86904
  acs_entrance_id?: string | undefined;
86837
86905
  /**
86838
86906
  * @deprecated Use `space_id`. */
86839
86907
  location_id?: string | undefined;
86840
- /** ID of space to filter list of access grants by. */
86908
+ /** ID of the space by which you want to filter the list of Access Grants. */
86841
86909
  space_id?: string | undefined;
86910
+ /** Filter Access Grants by access_grant_key. */
86911
+ access_grant_key?: string | undefined;
86842
86912
  };
86843
86913
  formData: {};
86844
86914
  jsonResponse: {
86845
86915
  access_grants: Array<{
86846
- /** ID of the Seam workspace associated with the access grant. */
86916
+ /** ID of the Seam workspace associated with the Access Grant. */
86847
86917
  workspace_id: string;
86848
- /** ID of the access grant. */
86918
+ /** ID of the Access Grant. */
86849
86919
  access_grant_id: string;
86850
- /** ID of user identity to which the access grant gives access. */
86920
+ /** Unique key for the access grant within the workspace. */
86921
+ access_grant_key?: string | undefined;
86922
+ /** ID of user identity to which the Access Grant gives access. */
86851
86923
  user_identity_id: string;
86852
86924
  /**
86853
86925
  * @deprecated Use `space_ids`. */
86854
86926
  location_ids: string[];
86855
- /** IDs of the spaces to which the access grant gives access. */
86927
+ /** IDs of the spaces to which the Access Grant gives access. */
86856
86928
  space_ids: string[];
86857
- /** Access methods that the user requested for the access grant. */
86929
+ /** Access methods that the user requested for the Access Grant. */
86858
86930
  requested_access_methods: Array<{
86859
86931
  /** Display name of the access method. */
86860
86932
  display_name: string;
86861
86933
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
86862
86934
  mode: 'code' | 'card' | 'mobile_key';
86863
- /** Date and time at which the requested access method was added to the access grant. */
86935
+ /** Date and time at which the requested access method was added to the Access Grant. */
86864
86936
  created_at: string;
86865
86937
  /** IDs of the access methods created for the requested access method. */
86866
86938
  created_access_method_ids: string[];
86867
86939
  }>;
86868
- /** IDs of the access methods created for the access grant. */
86940
+ /** IDs of the access methods created for the Access Grant. */
86869
86941
  access_method_ids: string[];
86870
- /** Display name of the access grant. */
86942
+ /** Display name of the Access Grant. */
86871
86943
  display_name: string;
86872
- /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method. */
86944
+ /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
86873
86945
  instant_key_url?: string | undefined;
86874
- /** Date and time at which the access grant was created. */
86946
+ /** Date and time at which the Access Grant was created. */
86875
86947
  created_at: string;
86876
- /** Date and time at which the access grant starts. */
86948
+ /** Date and time at which the Access Grant starts. */
86877
86949
  starts_at?: string | undefined;
86878
- /** Date and time at which the access grant ends. */
86950
+ /** Date and time at which the Access Grant ends. */
86879
86951
  ends_at?: string | undefined;
86880
86952
  }>;
86881
86953
  };
@@ -86886,7 +86958,7 @@ interface Routes {
86886
86958
  queryParams: {};
86887
86959
  jsonBody: {};
86888
86960
  commonParams: {
86889
- /** ID of the access grant to update. */
86961
+ /** ID of the Access Grant to update. */
86890
86962
  access_grant_id: string;
86891
86963
  /** 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. */
86892
86964
  starts_at?: (string | null) | undefined;
@@ -86914,7 +86986,7 @@ interface Routes {
86914
86986
  queryParams: {};
86915
86987
  jsonBody: {};
86916
86988
  commonParams: {
86917
- /** ID of the `acs_encoder` to use to encode the `acs_credential`. */
86989
+ /** ID of the `acs_encoder` to use to encode the `access_method`. */
86918
86990
  acs_encoder_id: string;
86919
86991
  /** ID of the `access_method` to encode onto a card. */
86920
86992
  access_method_id: string;
@@ -88179,7 +88251,7 @@ interface Routes {
88179
88251
  };
88180
88252
  formData: {};
88181
88253
  jsonResponse: {
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. */
88254
+ /** 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. */
88183
88255
  access_method: {
88184
88256
  /** ID of the Seam workspace associated with the access method. */
88185
88257
  workspace_id: string;
@@ -88208,7 +88280,7 @@ interface Routes {
88208
88280
  queryParams: {};
88209
88281
  jsonBody: {};
88210
88282
  commonParams: {
88211
- /** ID of access grant to list access methods for. */
88283
+ /** ID of Access Grant to list access methods for. */
88212
88284
  access_grant_id: string;
88213
88285
  /** ID of the device for which you want to retrieve all access methods. */
88214
88286
  device_id?: string | undefined;
@@ -103153,7 +103225,7 @@ interface Routes {
103153
103225
  created_at: string;
103154
103226
  /** Date and time at which the event occurred. */
103155
103227
  occurred_at: string;
103156
- /** ID of the affected access grant. */
103228
+ /** ID of the affected Access Grant. */
103157
103229
  access_grant_id: string;
103158
103230
  event_type: 'access_grant.created';
103159
103231
  } | {
@@ -103165,7 +103237,7 @@ interface Routes {
103165
103237
  created_at: string;
103166
103238
  /** Date and time at which the event occurred. */
103167
103239
  occurred_at: string;
103168
- /** ID of the affected access grant. */
103240
+ /** ID of the affected Access Grant. */
103169
103241
  access_grant_id: string;
103170
103242
  event_type: 'access_grant.deleted';
103171
103243
  } | {
@@ -103177,7 +103249,7 @@ interface Routes {
103177
103249
  created_at: string;
103178
103250
  /** Date and time at which the event occurred. */
103179
103251
  occurred_at: string;
103180
- /** ID of the affected access grant. */
103252
+ /** ID of the affected Access Grant. */
103181
103253
  access_grant_id: string;
103182
103254
  event_type: 'access_grant.access_granted_to_all_doors';
103183
103255
  } | {
@@ -103189,7 +103261,7 @@ interface Routes {
103189
103261
  created_at: string;
103190
103262
  /** Date and time at which the event occurred. */
103191
103263
  occurred_at: string;
103192
- /** ID of the affected access grant. */
103264
+ /** ID of the affected Access Grant. */
103193
103265
  access_grant_id: string;
103194
103266
  event_type: 'access_grant.access_granted_to_door';
103195
103267
  /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
@@ -103203,7 +103275,7 @@ interface Routes {
103203
103275
  created_at: string;
103204
103276
  /** Date and time at which the event occurred. */
103205
103277
  occurred_at: string;
103206
- /** ID of the affected access grant. */
103278
+ /** ID of the affected Access Grant. */
103207
103279
  access_grant_id: string;
103208
103280
  event_type: 'access_grant.access_to_door_lost';
103209
103281
  /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
@@ -104805,7 +104877,7 @@ interface Routes {
104805
104877
  created_at: string;
104806
104878
  /** Date and time at which the event occurred. */
104807
104879
  occurred_at: string;
104808
- /** ID of the affected access grant. */
104880
+ /** ID of the affected Access Grant. */
104809
104881
  access_grant_id: string;
104810
104882
  event_type: 'access_grant.created';
104811
104883
  } | {
@@ -104817,7 +104889,7 @@ interface Routes {
104817
104889
  created_at: string;
104818
104890
  /** Date and time at which the event occurred. */
104819
104891
  occurred_at: string;
104820
- /** ID of the affected access grant. */
104892
+ /** ID of the affected Access Grant. */
104821
104893
  access_grant_id: string;
104822
104894
  event_type: 'access_grant.deleted';
104823
104895
  } | {
@@ -104829,7 +104901,7 @@ interface Routes {
104829
104901
  created_at: string;
104830
104902
  /** Date and time at which the event occurred. */
104831
104903
  occurred_at: string;
104832
- /** ID of the affected access grant. */
104904
+ /** ID of the affected Access Grant. */
104833
104905
  access_grant_id: string;
104834
104906
  event_type: 'access_grant.access_granted_to_all_doors';
104835
104907
  } | {
@@ -104841,7 +104913,7 @@ interface Routes {
104841
104913
  created_at: string;
104842
104914
  /** Date and time at which the event occurred. */
104843
104915
  occurred_at: string;
104844
- /** ID of the affected access grant. */
104916
+ /** ID of the affected Access Grant. */
104845
104917
  access_grant_id: string;
104846
104918
  event_type: 'access_grant.access_granted_to_door';
104847
104919
  /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
@@ -104855,7 +104927,7 @@ interface Routes {
104855
104927
  created_at: string;
104856
104928
  /** Date and time at which the event occurred. */
104857
104929
  occurred_at: string;
104858
- /** ID of the affected access grant. */
104930
+ /** ID of the affected Access Grant. */
104859
104931
  access_grant_id: string;
104860
104932
  event_type: 'access_grant.access_to_door_lost';
104861
104933
  /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
@@ -123331,6 +123403,8 @@ interface Routes {
123331
123403
  jsonBody: {
123332
123404
  /** Name of the space that you want to create. */
123333
123405
  name: string;
123406
+ /** Unique key for the space within the workspace. */
123407
+ space_key?: string | undefined;
123334
123408
  /** IDs of the devices that you want to add to the new space. */
123335
123409
  device_ids?: string[] | undefined;
123336
123410
  /** IDs of the entrances that you want to add to the new space. */
@@ -123345,6 +123419,8 @@ interface Routes {
123345
123419
  space_id: string;
123346
123420
  /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
123347
123421
  workspace_id: string;
123422
+ /** Unique key for the space within the workspace. */
123423
+ space_key?: string | undefined;
123348
123424
  /** Name of the space. */
123349
123425
  name: string;
123350
123426
  /** Display name for the space. */
@@ -123378,6 +123454,9 @@ interface Routes {
123378
123454
  commonParams: {
123379
123455
  /** ID of the space that you want to get. */
123380
123456
  space_id: string;
123457
+ } | {
123458
+ /** Unique key of the space that you want to get. */
123459
+ space_key: string;
123381
123460
  };
123382
123461
  formData: {};
123383
123462
  jsonResponse: {
@@ -123387,6 +123466,8 @@ interface Routes {
123387
123466
  space_id: string;
123388
123467
  /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
123389
123468
  workspace_id: string;
123469
+ /** Unique key for the space within the workspace. */
123470
+ space_key?: string | undefined;
123390
123471
  /** Name of the space. */
123391
123472
  name: string;
123392
123473
  /** Display name for the space. */
@@ -123421,6 +123502,8 @@ interface Routes {
123421
123502
  space_id: string;
123422
123503
  /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
123423
123504
  workspace_id: string;
123505
+ /** Unique key for the space within the workspace. */
123506
+ space_key?: string | undefined;
123424
123507
  /** Name of the space. */
123425
123508
  name: string;
123426
123509
  /** Display name for the space. */
@@ -124699,6 +124782,8 @@ interface Routes {
124699
124782
  commonParams: {
124700
124783
  /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. */
124701
124784
  search?: string | undefined;
124785
+ /** Filter spaces by space_key. */
124786
+ space_key?: string | undefined;
124702
124787
  };
124703
124788
  formData: {};
124704
124789
  jsonResponse: {
@@ -124707,6 +124792,8 @@ interface Routes {
124707
124792
  space_id: string;
124708
124793
  /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
124709
124794
  workspace_id: string;
124795
+ /** Unique key for the space within the workspace. */
124796
+ space_key?: string | undefined;
124710
124797
  /** Name of the space. */
124711
124798
  name: string;
124712
124799
  /** Display name for the space. */
@@ -124767,6 +124854,8 @@ interface Routes {
124767
124854
  space_id: string;
124768
124855
  /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
124769
124856
  workspace_id: string;
124857
+ /** Unique key for the space within the workspace. */
124858
+ space_key?: string | undefined;
124770
124859
  /** Name of the space. */
124771
124860
  name: string;
124772
124861
  /** Display name for the space. */
@@ -140214,41 +140303,43 @@ interface Routes {
140214
140303
  };
140215
140304
  formData: {};
140216
140305
  jsonResponse: {
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. */
140306
+ /** 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. */
140218
140307
  access_grant: {
140219
- /** ID of the Seam workspace associated with the access grant. */
140308
+ /** ID of the Seam workspace associated with the Access Grant. */
140220
140309
  workspace_id: string;
140221
- /** ID of the access grant. */
140310
+ /** ID of the Access Grant. */
140222
140311
  access_grant_id: string;
140223
- /** ID of user identity to which the access grant gives access. */
140312
+ /** Unique key for the access grant within the workspace. */
140313
+ access_grant_key?: string | undefined;
140314
+ /** ID of user identity to which the Access Grant gives access. */
140224
140315
  user_identity_id: string;
140225
140316
  /**
140226
140317
  * @deprecated Use `space_ids`. */
140227
140318
  location_ids: string[];
140228
- /** IDs of the spaces to which the access grant gives access. */
140319
+ /** IDs of the spaces to which the Access Grant gives access. */
140229
140320
  space_ids: string[];
140230
- /** Access methods that the user requested for the access grant. */
140321
+ /** Access methods that the user requested for the Access Grant. */
140231
140322
  requested_access_methods: Array<{
140232
140323
  /** Display name of the access method. */
140233
140324
  display_name: string;
140234
140325
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
140235
140326
  mode: 'code' | 'card' | 'mobile_key';
140236
- /** Date and time at which the requested access method was added to the access grant. */
140327
+ /** Date and time at which the requested access method was added to the Access Grant. */
140237
140328
  created_at: string;
140238
140329
  /** IDs of the access methods created for the requested access method. */
140239
140330
  created_access_method_ids: string[];
140240
140331
  }>;
140241
- /** IDs of the access methods created for the access grant. */
140332
+ /** IDs of the access methods created for the Access Grant. */
140242
140333
  access_method_ids: string[];
140243
- /** Display name of the access grant. */
140334
+ /** Display name of the Access Grant. */
140244
140335
  display_name: string;
140245
- /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method. */
140336
+ /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
140246
140337
  instant_key_url?: string | undefined;
140247
- /** Date and time at which the access grant was created. */
140338
+ /** Date and time at which the Access Grant was created. */
140248
140339
  created_at: string;
140249
- /** Date and time at which the access grant starts. */
140340
+ /** Date and time at which the Access Grant starts. */
140250
140341
  starts_at?: string | undefined;
140251
- /** Date and time at which the access grant ends. */
140342
+ /** Date and time at which the Access Grant ends. */
140252
140343
  ends_at?: string | undefined;
140253
140344
  };
140254
140345
  };
@@ -140276,41 +140367,43 @@ interface Routes {
140276
140367
  };
140277
140368
  formData: {};
140278
140369
  jsonResponse: {
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. */
140370
+ /** 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. */
140280
140371
  access_grant: {
140281
- /** ID of the Seam workspace associated with the access grant. */
140372
+ /** ID of the Seam workspace associated with the Access Grant. */
140282
140373
  workspace_id: string;
140283
- /** ID of the access grant. */
140374
+ /** ID of the Access Grant. */
140284
140375
  access_grant_id: string;
140285
- /** ID of user identity to which the access grant gives access. */
140376
+ /** Unique key for the access grant within the workspace. */
140377
+ access_grant_key?: string | undefined;
140378
+ /** ID of user identity to which the Access Grant gives access. */
140286
140379
  user_identity_id: string;
140287
140380
  /**
140288
140381
  * @deprecated Use `space_ids`. */
140289
140382
  location_ids: string[];
140290
- /** IDs of the spaces to which the access grant gives access. */
140383
+ /** IDs of the spaces to which the Access Grant gives access. */
140291
140384
  space_ids: string[];
140292
- /** Access methods that the user requested for the access grant. */
140385
+ /** Access methods that the user requested for the Access Grant. */
140293
140386
  requested_access_methods: Array<{
140294
140387
  /** Display name of the access method. */
140295
140388
  display_name: string;
140296
140389
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
140297
140390
  mode: 'code' | 'card' | 'mobile_key';
140298
- /** Date and time at which the requested access method was added to the access grant. */
140391
+ /** Date and time at which the requested access method was added to the Access Grant. */
140299
140392
  created_at: string;
140300
140393
  /** IDs of the access methods created for the requested access method. */
140301
140394
  created_access_method_ids: string[];
140302
140395
  }>;
140303
- /** IDs of the access methods created for the access grant. */
140396
+ /** IDs of the access methods created for the Access Grant. */
140304
140397
  access_method_ids: string[];
140305
- /** Display name of the access grant. */
140398
+ /** Display name of the Access Grant. */
140306
140399
  display_name: string;
140307
- /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method. */
140400
+ /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
140308
140401
  instant_key_url?: string | undefined;
140309
- /** Date and time at which the access grant was created. */
140402
+ /** Date and time at which the Access Grant was created. */
140310
140403
  created_at: string;
140311
- /** Date and time at which the access grant starts. */
140404
+ /** Date and time at which the Access Grant starts. */
140312
140405
  starts_at?: string | undefined;
140313
- /** Date and time at which the access grant ends. */
140406
+ /** Date and time at which the Access Grant ends. */
140314
140407
  ends_at?: string | undefined;
140315
140408
  };
140316
140409
  };
@@ -140336,39 +140429,41 @@ interface Routes {
140336
140429
  formData: {};
140337
140430
  jsonResponse: {
140338
140431
  access_grants: Array<{
140339
- /** ID of the Seam workspace associated with the access grant. */
140432
+ /** ID of the Seam workspace associated with the Access Grant. */
140340
140433
  workspace_id: string;
140341
- /** ID of the access grant. */
140434
+ /** ID of the Access Grant. */
140342
140435
  access_grant_id: string;
140343
- /** ID of user identity to which the access grant gives access. */
140436
+ /** Unique key for the access grant within the workspace. */
140437
+ access_grant_key?: string | undefined;
140438
+ /** ID of user identity to which the Access Grant gives access. */
140344
140439
  user_identity_id: string;
140345
140440
  /**
140346
140441
  * @deprecated Use `space_ids`. */
140347
140442
  location_ids: string[];
140348
- /** IDs of the spaces to which the access grant gives access. */
140443
+ /** IDs of the spaces to which the Access Grant gives access. */
140349
140444
  space_ids: string[];
140350
- /** Access methods that the user requested for the access grant. */
140445
+ /** Access methods that the user requested for the Access Grant. */
140351
140446
  requested_access_methods: Array<{
140352
140447
  /** Display name of the access method. */
140353
140448
  display_name: string;
140354
140449
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
140355
140450
  mode: 'code' | 'card' | 'mobile_key';
140356
- /** Date and time at which the requested access method was added to the access grant. */
140451
+ /** Date and time at which the requested access method was added to the Access Grant. */
140357
140452
  created_at: string;
140358
140453
  /** IDs of the access methods created for the requested access method. */
140359
140454
  created_access_method_ids: string[];
140360
140455
  }>;
140361
- /** IDs of the access methods created for the access grant. */
140456
+ /** IDs of the access methods created for the Access Grant. */
140362
140457
  access_method_ids: string[];
140363
- /** Display name of the access grant. */
140458
+ /** Display name of the Access Grant. */
140364
140459
  display_name: string;
140365
- /** Instant Key URL. Only returned if the access grant has a single mobile_key access_method. */
140460
+ /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
140366
140461
  instant_key_url?: string | undefined;
140367
- /** Date and time at which the access grant was created. */
140462
+ /** Date and time at which the Access Grant was created. */
140368
140463
  created_at: string;
140369
- /** Date and time at which the access grant starts. */
140464
+ /** Date and time at which the Access Grant starts. */
140370
140465
  starts_at?: string | undefined;
140371
- /** Date and time at which the access grant ends. */
140466
+ /** Date and time at which the Access Grant ends. */
140372
140467
  ends_at?: string | undefined;
140373
140468
  }>;
140374
140469
  };
@@ -140396,7 +140491,7 @@ interface Routes {
140396
140491
  };
140397
140492
  formData: {};
140398
140493
  jsonResponse: {
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. */
140494
+ /** 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. */
140400
140495
  access_method: {
140401
140496
  /** ID of the Seam workspace associated with the access method. */
140402
140497
  workspace_id: string;