@seamapi/types 1.245.0 → 1.246.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 (10) hide show
  1. package/dist/connect.cjs +151 -33
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +73 -0
  4. package/lib/seam/connect/openapi.d.ts +54 -0
  5. package/lib/seam/connect/openapi.js +136 -18
  6. package/lib/seam/connect/openapi.js.map +1 -1
  7. package/lib/seam/connect/route-types.d.ts +19 -0
  8. package/package.json +2 -2
  9. package/src/lib/seam/connect/openapi.ts +159 -18
  10. package/src/lib/seam/connect/route-types.ts +19 -0
package/dist/connect.d.cts CHANGED
@@ -17562,6 +17562,7 @@ declare const _default: {
17562
17562
  };
17563
17563
  '/acs/users/add_to_access_group': {
17564
17564
  post: {
17565
+ description: string;
17565
17566
  operationId: string;
17566
17567
  requestBody: {
17567
17568
  content: {
@@ -17569,10 +17570,12 @@ declare const _default: {
17569
17570
  schema: {
17570
17571
  properties: {
17571
17572
  acs_access_group_id: {
17573
+ description: string;
17572
17574
  format: string;
17573
17575
  type: string;
17574
17576
  };
17575
17577
  acs_user_id: {
17578
+ description: string;
17576
17579
  format: string;
17577
17580
  type: string;
17578
17581
  };
@@ -17624,8 +17627,10 @@ declare const _default: {
17624
17627
  tags: string[];
17625
17628
  'x-fern-sdk-group-name': string[];
17626
17629
  'x-fern-sdk-method-name': string;
17630
+ 'x-title': string;
17627
17631
  };
17628
17632
  put: {
17633
+ description: string;
17629
17634
  operationId: string;
17630
17635
  requestBody: {
17631
17636
  content: {
@@ -17633,10 +17638,12 @@ declare const _default: {
17633
17638
  schema: {
17634
17639
  properties: {
17635
17640
  acs_access_group_id: {
17641
+ description: string;
17636
17642
  format: string;
17637
17643
  type: string;
17638
17644
  };
17639
17645
  acs_user_id: {
17646
+ description: string;
17640
17647
  format: string;
17641
17648
  type: string;
17642
17649
  };
@@ -17687,10 +17694,12 @@ declare const _default: {
17687
17694
  summary: string;
17688
17695
  tags: string[];
17689
17696
  'x-fern-ignore': boolean;
17697
+ 'x-title': string;
17690
17698
  };
17691
17699
  };
17692
17700
  '/acs/users/create': {
17693
17701
  post: {
17702
+ description: string;
17694
17703
  operationId: string;
17695
17704
  requestBody: {
17696
17705
  content: {
@@ -17698,6 +17707,7 @@ declare const _default: {
17698
17707
  schema: {
17699
17708
  properties: {
17700
17709
  access_schedule: {
17710
+ description: string;
17701
17711
  properties: {
17702
17712
  ends_at: {
17703
17713
  format: string;
@@ -17713,6 +17723,7 @@ declare const _default: {
17713
17723
  };
17714
17724
  acs_access_group_ids: {
17715
17725
  default: never[];
17726
+ description: string;
17716
17727
  items: {
17717
17728
  format: string;
17718
17729
  type: string;
@@ -17720,6 +17731,7 @@ declare const _default: {
17720
17731
  type: string;
17721
17732
  };
17722
17733
  acs_system_id: {
17734
+ description: string;
17723
17735
  format: string;
17724
17736
  type: string;
17725
17737
  };
@@ -17740,6 +17752,7 @@ declare const _default: {
17740
17752
  type: string;
17741
17753
  };
17742
17754
  user_identity_id: {
17755
+ description: string;
17743
17756
  format: string;
17744
17757
  type: string;
17745
17758
  };
@@ -17795,10 +17808,13 @@ declare const _default: {
17795
17808
  'x-fern-sdk-group-name': string[];
17796
17809
  'x-fern-sdk-method-name': string;
17797
17810
  'x-fern-sdk-return-value': string;
17811
+ 'x-response-key': string;
17812
+ 'x-title': string;
17798
17813
  };
17799
17814
  };
17800
17815
  '/acs/users/delete': {
17801
17816
  post: {
17817
+ description: string;
17802
17818
  operationId: string;
17803
17819
  requestBody: {
17804
17820
  content: {
@@ -17806,6 +17822,7 @@ declare const _default: {
17806
17822
  schema: {
17807
17823
  properties: {
17808
17824
  acs_user_id: {
17825
+ description: string;
17809
17826
  format: string;
17810
17827
  type: string;
17811
17828
  };
@@ -17857,10 +17874,12 @@ declare const _default: {
17857
17874
  tags: string[];
17858
17875
  'x-fern-sdk-group-name': string[];
17859
17876
  'x-fern-sdk-method-name': string;
17877
+ 'x-title': string;
17860
17878
  };
17861
17879
  };
17862
17880
  '/acs/users/get': {
17863
17881
  post: {
17882
+ description: string;
17864
17883
  operationId: string;
17865
17884
  requestBody: {
17866
17885
  content: {
@@ -17868,6 +17887,7 @@ declare const _default: {
17868
17887
  schema: {
17869
17888
  properties: {
17870
17889
  acs_user_id: {
17890
+ description: string;
17871
17891
  format: string;
17872
17892
  type: string;
17873
17893
  };
@@ -17923,10 +17943,13 @@ declare const _default: {
17923
17943
  'x-fern-sdk-group-name': string[];
17924
17944
  'x-fern-sdk-method-name': string;
17925
17945
  'x-fern-sdk-return-value': string;
17946
+ 'x-response-key': string;
17947
+ 'x-title': string;
17926
17948
  };
17927
17949
  };
17928
17950
  '/acs/users/list': {
17929
17951
  post: {
17952
+ description: string;
17930
17953
  operationId: string;
17931
17954
  requestBody: {
17932
17955
  content: {
@@ -17934,6 +17957,7 @@ declare const _default: {
17934
17957
  schema: {
17935
17958
  properties: {
17936
17959
  acs_system_id: {
17960
+ description: string;
17937
17961
  format: string;
17938
17962
  type: string;
17939
17963
  };
@@ -17947,13 +17971,16 @@ declare const _default: {
17947
17971
  type: string;
17948
17972
  };
17949
17973
  user_identity_email_address: {
17974
+ description: string;
17950
17975
  type: string;
17951
17976
  };
17952
17977
  user_identity_id: {
17978
+ description: string;
17953
17979
  format: string;
17954
17980
  type: string;
17955
17981
  };
17956
17982
  user_identity_phone_number: {
17983
+ description: string;
17957
17984
  type: string;
17958
17985
  };
17959
17986
  };
@@ -18018,10 +18045,13 @@ declare const _default: {
18018
18045
  'x-fern-sdk-group-name': string[];
18019
18046
  'x-fern-sdk-method-name': string;
18020
18047
  'x-fern-sdk-return-value': string;
18048
+ 'x-response-key': string;
18049
+ 'x-title': string;
18021
18050
  };
18022
18051
  };
18023
18052
  '/acs/users/list_accessible_entrances': {
18024
18053
  post: {
18054
+ description: string;
18025
18055
  operationId: string;
18026
18056
  requestBody: {
18027
18057
  content: {
@@ -18029,6 +18059,7 @@ declare const _default: {
18029
18059
  schema: {
18030
18060
  properties: {
18031
18061
  acs_user_id: {
18062
+ description: string;
18032
18063
  format: string;
18033
18064
  type: string;
18034
18065
  };
@@ -18095,10 +18126,13 @@ declare const _default: {
18095
18126
  'x-fern-sdk-group-name': string[];
18096
18127
  'x-fern-sdk-method-name': string;
18097
18128
  'x-fern-sdk-return-value': string;
18129
+ 'x-response-key': string;
18130
+ 'x-title': string;
18098
18131
  };
18099
18132
  };
18100
18133
  '/acs/users/remove_from_access_group': {
18101
18134
  post: {
18135
+ description: string;
18102
18136
  operationId: string;
18103
18137
  requestBody: {
18104
18138
  content: {
@@ -18106,10 +18140,12 @@ declare const _default: {
18106
18140
  schema: {
18107
18141
  properties: {
18108
18142
  acs_access_group_id: {
18143
+ description: string;
18109
18144
  format: string;
18110
18145
  type: string;
18111
18146
  };
18112
18147
  acs_user_id: {
18148
+ description: string;
18113
18149
  format: string;
18114
18150
  type: string;
18115
18151
  };
@@ -18161,10 +18197,12 @@ declare const _default: {
18161
18197
  tags: string[];
18162
18198
  'x-fern-sdk-group-name': string[];
18163
18199
  'x-fern-sdk-method-name': string;
18200
+ 'x-title': string;
18164
18201
  };
18165
18202
  };
18166
18203
  '/acs/users/revoke_access_to_all_entrances': {
18167
18204
  post: {
18205
+ description: string;
18168
18206
  operationId: string;
18169
18207
  requestBody: {
18170
18208
  content: {
@@ -18172,6 +18210,7 @@ declare const _default: {
18172
18210
  schema: {
18173
18211
  properties: {
18174
18212
  acs_user_id: {
18213
+ description: string;
18175
18214
  format: string;
18176
18215
  type: string;
18177
18216
  };
@@ -18223,10 +18262,12 @@ declare const _default: {
18223
18262
  tags: string[];
18224
18263
  'x-fern-sdk-group-name': string[];
18225
18264
  'x-fern-sdk-method-name': string;
18265
+ 'x-title': string;
18226
18266
  };
18227
18267
  };
18228
18268
  '/acs/users/suspend': {
18229
18269
  post: {
18270
+ description: string;
18230
18271
  operationId: string;
18231
18272
  requestBody: {
18232
18273
  content: {
@@ -18234,6 +18275,7 @@ declare const _default: {
18234
18275
  schema: {
18235
18276
  properties: {
18236
18277
  acs_user_id: {
18278
+ description: string;
18237
18279
  format: string;
18238
18280
  type: string;
18239
18281
  };
@@ -18285,6 +18327,7 @@ declare const _default: {
18285
18327
  tags: string[];
18286
18328
  'x-fern-sdk-group-name': string[];
18287
18329
  'x-fern-sdk-method-name': string;
18330
+ 'x-title': string;
18288
18331
  };
18289
18332
  };
18290
18333
  '/acs/users/unmanaged/get': {
@@ -18482,6 +18525,7 @@ declare const _default: {
18482
18525
  'x-fern-sdk-group-name': string[];
18483
18526
  'x-fern-sdk-method-name': string;
18484
18527
  'x-fern-sdk-return-value': string;
18528
+ 'x-undocumented': string;
18485
18529
  };
18486
18530
  };
18487
18531
  '/acs/users/unmanaged/list': {
@@ -18696,10 +18740,12 @@ declare const _default: {
18696
18740
  'x-fern-sdk-group-name': string[];
18697
18741
  'x-fern-sdk-method-name': string;
18698
18742
  'x-fern-sdk-return-value': string;
18743
+ 'x-undocumented': string;
18699
18744
  };
18700
18745
  };
18701
18746
  '/acs/users/unsuspend': {
18702
18747
  post: {
18748
+ description: string;
18703
18749
  operationId: string;
18704
18750
  requestBody: {
18705
18751
  content: {
@@ -18707,6 +18753,7 @@ declare const _default: {
18707
18753
  schema: {
18708
18754
  properties: {
18709
18755
  acs_user_id: {
18756
+ description: string;
18710
18757
  format: string;
18711
18758
  type: string;
18712
18759
  };
@@ -18758,10 +18805,12 @@ declare const _default: {
18758
18805
  tags: string[];
18759
18806
  'x-fern-sdk-group-name': string[];
18760
18807
  'x-fern-sdk-method-name': string;
18808
+ 'x-title': string;
18761
18809
  };
18762
18810
  };
18763
18811
  '/acs/users/update': {
18764
18812
  patch: {
18813
+ description: string;
18765
18814
  operationId: string;
18766
18815
  requestBody: {
18767
18816
  content: {
@@ -18769,6 +18818,7 @@ declare const _default: {
18769
18818
  schema: {
18770
18819
  properties: {
18771
18820
  access_schedule: {
18821
+ description: string;
18772
18822
  nullable: boolean;
18773
18823
  properties: {
18774
18824
  ends_at: {
@@ -18854,8 +18904,10 @@ declare const _default: {
18854
18904
  summary: string;
18855
18905
  tags: string[];
18856
18906
  'x-fern-ignore': boolean;
18907
+ 'x-title': string;
18857
18908
  };
18858
18909
  post: {
18910
+ description: string;
18859
18911
  operationId: string;
18860
18912
  requestBody: {
18861
18913
  content: {
@@ -18863,6 +18915,7 @@ declare const _default: {
18863
18915
  schema: {
18864
18916
  properties: {
18865
18917
  access_schedule: {
18918
+ description: string;
18866
18919
  nullable: boolean;
18867
18920
  properties: {
18868
18921
  ends_at: {
@@ -18949,6 +19002,7 @@ declare const _default: {
18949
19002
  tags: string[];
18950
19003
  'x-fern-sdk-group-name': string[];
18951
19004
  'x-fern-sdk-method-name': string;
19005
+ 'x-title': string;
18952
19006
  };
18953
19007
  };
18954
19008
  '/action_attempts/get': {
@@ -30641,7 +30695,9 @@ interface Routes {
30641
30695
  queryParams: {};
30642
30696
  jsonBody: {};
30643
30697
  commonParams: {
30698
+ /** ID of the desired `acs_user`. */
30644
30699
  acs_user_id: string;
30700
+ /** ID of the desired access group. */
30645
30701
  acs_access_group_id: string;
30646
30702
  };
30647
30703
  formData: {};
@@ -30652,9 +30708,13 @@ interface Routes {
30652
30708
  method: 'POST';
30653
30709
  queryParams: {};
30654
30710
  jsonBody: {
30711
+ /** ID of the `acs_system` to which to add the new `acs_user`. */
30655
30712
  acs_system_id: string;
30713
+ /** Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. */
30656
30714
  acs_access_group_ids?: string[];
30715
+ /** ID of the user identity with which to associate the new `acs_user`. */
30657
30716
  user_identity_id?: string | undefined;
30717
+ /** `starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems. */
30658
30718
  access_schedule?: {
30659
30719
  starts_at: string;
30660
30720
  ends_at: string;
@@ -30745,6 +30805,7 @@ interface Routes {
30745
30805
  queryParams: {};
30746
30806
  jsonBody: {};
30747
30807
  commonParams: {
30808
+ /** ID of the desired `acs_user`. */
30748
30809
  acs_user_id: string;
30749
30810
  };
30750
30811
  formData: {};
@@ -30756,6 +30817,7 @@ interface Routes {
30756
30817
  queryParams: {};
30757
30818
  jsonBody: {};
30758
30819
  commonParams: {
30820
+ /** ID of the desired `acs_user`. */
30759
30821
  acs_user_id: string;
30760
30822
  };
30761
30823
  formData: {};
@@ -30836,9 +30898,13 @@ interface Routes {
30836
30898
  queryParams: {};
30837
30899
  jsonBody: {};
30838
30900
  commonParams: {
30901
+ /** ID of the user identity for which you want to retrieve all `acs_user`s. */
30839
30902
  user_identity_id?: string | undefined;
30903
+ /** Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). */
30840
30904
  user_identity_phone_number?: string | undefined;
30905
+ /** Email address of the user identity for which you want to retrieve all `acs_user`s. */
30841
30906
  user_identity_email_address?: string | undefined;
30907
+ /** ID of the `acs_system` for which you want to retrieve all `acs_user`s. */
30842
30908
  acs_system_id?: string | undefined;
30843
30909
  limit?: number;
30844
30910
  created_before?: Date | undefined;
@@ -30921,6 +30987,7 @@ interface Routes {
30921
30987
  queryParams: {};
30922
30988
  jsonBody: {};
30923
30989
  commonParams: {
30990
+ /** ID of the desired `acs_user`. */
30924
30991
  acs_user_id: string;
30925
30992
  };
30926
30993
  formData: {};
@@ -30957,7 +31024,9 @@ interface Routes {
30957
31024
  queryParams: {};
30958
31025
  jsonBody: {};
30959
31026
  commonParams: {
31027
+ /** ID of the desired `acs_user`. */
30960
31028
  acs_user_id: string;
31029
+ /** ID of the desired access group. */
30961
31030
  acs_access_group_id: string;
30962
31031
  };
30963
31032
  formData: {};
@@ -30968,6 +31037,7 @@ interface Routes {
30968
31037
  method: 'POST';
30969
31038
  queryParams: {};
30970
31039
  jsonBody: {
31040
+ /** ID of the desired `acs_user`. */
30971
31041
  acs_user_id: string;
30972
31042
  };
30973
31043
  commonParams: {};
@@ -30980,6 +31050,7 @@ interface Routes {
30980
31050
  queryParams: {};
30981
31051
  jsonBody: {};
30982
31052
  commonParams: {
31053
+ /** ID of the desired `acs_user`. */
30983
31054
  acs_user_id: string;
30984
31055
  };
30985
31056
  formData: {};
@@ -31155,6 +31226,7 @@ interface Routes {
31155
31226
  queryParams: {};
31156
31227
  jsonBody: {};
31157
31228
  commonParams: {
31229
+ /** ID of the desired `acs_user`. */
31158
31230
  acs_user_id: string;
31159
31231
  };
31160
31232
  formData: {};
@@ -31165,6 +31237,7 @@ interface Routes {
31165
31237
  method: 'PATCH' | 'POST';
31166
31238
  queryParams: {};
31167
31239
  jsonBody: {
31240
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems. */
31168
31241
  access_schedule?: ({
31169
31242
  starts_at: string;
31170
31243
  ends_at: string;