@seamapi/types 1.480.0 → 1.482.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.
@@ -26037,12 +26037,14 @@ declare const _default: {
26037
26037
  };
26038
26038
  user_identity_id: {
26039
26039
  description: string;
26040
+ format: string;
26040
26041
  type: string;
26041
26042
  };
26042
26043
  user_identity_ids: {
26043
26044
  deprecated: boolean;
26044
26045
  description: string;
26045
26046
  items: {
26047
+ format: string;
26046
26048
  type: string;
26047
26049
  };
26048
26050
  maxItems: number;
@@ -26154,12 +26156,14 @@ declare const _default: {
26154
26156
  };
26155
26157
  user_identity_id: {
26156
26158
  description: string;
26159
+ format: string;
26157
26160
  type: string;
26158
26161
  };
26159
26162
  user_identity_ids: {
26160
26163
  deprecated: boolean;
26161
26164
  description: string;
26162
26165
  items: {
26166
+ format: string;
26163
26167
  type: string;
26164
26168
  };
26165
26169
  maxItems: number;
@@ -26357,14 +26361,23 @@ declare const _default: {
26357
26361
  get: {
26358
26362
  description: string;
26359
26363
  operationId: string;
26360
- parameters: {
26364
+ parameters: ({
26361
26365
  in: string;
26362
26366
  name: string;
26363
26367
  schema: {
26364
26368
  description: string;
26369
+ format: string;
26365
26370
  type: string;
26366
26371
  };
26367
- }[];
26372
+ } | {
26373
+ in: string;
26374
+ name: string;
26375
+ schema: {
26376
+ description: string;
26377
+ type: string;
26378
+ format?: never;
26379
+ };
26380
+ })[];
26368
26381
  responses: {
26369
26382
  200: {
26370
26383
  content: {
@@ -26431,6 +26444,7 @@ declare const _default: {
26431
26444
  properties: {
26432
26445
  client_session_id: {
26433
26446
  description: string;
26447
+ format: string;
26434
26448
  type: string;
26435
26449
  };
26436
26450
  user_identifier_key: {
@@ -26535,12 +26549,14 @@ declare const _default: {
26535
26549
  };
26536
26550
  user_identity_id: {
26537
26551
  description: string;
26552
+ format: string;
26538
26553
  type: string;
26539
26554
  };
26540
26555
  user_identity_ids: {
26541
26556
  deprecated: boolean;
26542
26557
  description: string;
26543
26558
  items: {
26559
+ format: string;
26544
26560
  type: string;
26545
26561
  };
26546
26562
  maxItems: number;
@@ -37970,6 +37986,7 @@ declare const _default: {
37970
37986
  required: boolean;
37971
37987
  schema: {
37972
37988
  description: string;
37989
+ format: string;
37973
37990
  type: string;
37974
37991
  };
37975
37992
  }[];
@@ -38075,6 +38092,7 @@ declare const _default: {
38075
38092
  properties: {
38076
38093
  customer_portal_id: {
38077
38094
  description: string;
38095
+ format: string;
38078
38096
  type: string;
38079
38097
  };
38080
38098
  };
@@ -38664,6 +38682,7 @@ declare const _default: {
38664
38682
  items: {
38665
38683
  properties: {
38666
38684
  acs_entrance_id: {
38685
+ format: string;
38667
38686
  type: string;
38668
38687
  };
38669
38688
  name: {
@@ -38679,6 +38698,7 @@ declare const _default: {
38679
38698
  items: {
38680
38699
  properties: {
38681
38700
  device_id: {
38701
+ format: string;
38682
38702
  type: string;
38683
38703
  };
38684
38704
  device_type: {
@@ -38773,6 +38793,7 @@ declare const _default: {
38773
38793
  items: {
38774
38794
  properties: {
38775
38795
  acs_entrance_id: {
38796
+ format: string;
38776
38797
  type: string;
38777
38798
  };
38778
38799
  name: {
@@ -38788,6 +38809,7 @@ declare const _default: {
38788
38809
  items: {
38789
38810
  properties: {
38790
38811
  device_id: {
38812
+ format: string;
38791
38813
  type: string;
38792
38814
  };
38793
38815
  device_type: {
@@ -47800,32 +47822,22 @@ declare const _default: {
47800
47822
  };
47801
47823
  };
47802
47824
  security: ({
47803
- client_session: never[];
47804
- client_session_with_customer?: never;
47805
- pat_with_workspace?: never;
47806
- console_session_with_workspace?: never;
47807
- api_key?: never;
47808
- } | {
47809
47825
  client_session_with_customer: never[];
47810
- client_session?: never;
47811
47826
  pat_with_workspace?: never;
47812
47827
  console_session_with_workspace?: never;
47813
47828
  api_key?: never;
47814
47829
  } | {
47815
47830
  pat_with_workspace: never[];
47816
- client_session?: never;
47817
47831
  client_session_with_customer?: never;
47818
47832
  console_session_with_workspace?: never;
47819
47833
  api_key?: never;
47820
47834
  } | {
47821
47835
  console_session_with_workspace: never[];
47822
- client_session?: never;
47823
47836
  client_session_with_customer?: never;
47824
47837
  pat_with_workspace?: never;
47825
47838
  api_key?: never;
47826
47839
  } | {
47827
47840
  api_key: never[];
47828
- client_session?: never;
47829
47841
  client_session_with_customer?: never;
47830
47842
  pat_with_workspace?: never;
47831
47843
  console_session_with_workspace?: never;
@@ -47914,32 +47926,22 @@ declare const _default: {
47914
47926
  };
47915
47927
  };
47916
47928
  security: ({
47917
- client_session: never[];
47918
- client_session_with_customer?: never;
47919
- pat_with_workspace?: never;
47920
- console_session_with_workspace?: never;
47921
- api_key?: never;
47922
- } | {
47923
47929
  client_session_with_customer: never[];
47924
- client_session?: never;
47925
47930
  pat_with_workspace?: never;
47926
47931
  console_session_with_workspace?: never;
47927
47932
  api_key?: never;
47928
47933
  } | {
47929
47934
  pat_with_workspace: never[];
47930
- client_session?: never;
47931
47935
  client_session_with_customer?: never;
47932
47936
  console_session_with_workspace?: never;
47933
47937
  api_key?: never;
47934
47938
  } | {
47935
47939
  console_session_with_workspace: never[];
47936
- client_session?: never;
47937
47940
  client_session_with_customer?: never;
47938
47941
  pat_with_workspace?: never;
47939
47942
  api_key?: never;
47940
47943
  } | {
47941
47944
  api_key: never[];
47942
- client_session?: never;
47943
47945
  client_session_with_customer?: never;
47944
47946
  pat_with_workspace?: never;
47945
47947
  console_session_with_workspace?: never;
@@ -48033,32 +48035,22 @@ declare const _default: {
48033
48035
  };
48034
48036
  };
48035
48037
  security: ({
48036
- client_session: never[];
48037
- client_session_with_customer?: never;
48038
- pat_with_workspace?: never;
48039
- console_session_with_workspace?: never;
48040
- api_key?: never;
48041
- } | {
48042
48038
  client_session_with_customer: never[];
48043
- client_session?: never;
48044
48039
  pat_with_workspace?: never;
48045
48040
  console_session_with_workspace?: never;
48046
48041
  api_key?: never;
48047
48042
  } | {
48048
48043
  pat_with_workspace: never[];
48049
- client_session?: never;
48050
48044
  client_session_with_customer?: never;
48051
48045
  console_session_with_workspace?: never;
48052
48046
  api_key?: never;
48053
48047
  } | {
48054
48048
  console_session_with_workspace: never[];
48055
- client_session?: never;
48056
48049
  client_session_with_customer?: never;
48057
48050
  pat_with_workspace?: never;
48058
48051
  api_key?: never;
48059
48052
  } | {
48060
48053
  api_key: never[];
48061
- client_session?: never;
48062
48054
  client_session_with_customer?: never;
48063
48055
  pat_with_workspace?: never;
48064
48056
  console_session_with_workspace?: never;
@@ -48141,32 +48133,22 @@ declare const _default: {
48141
48133
  };
48142
48134
  };
48143
48135
  security: ({
48144
- client_session: never[];
48145
- client_session_with_customer?: never;
48146
- pat_with_workspace?: never;
48147
- console_session_with_workspace?: never;
48148
- api_key?: never;
48149
- } | {
48150
48136
  client_session_with_customer: never[];
48151
- client_session?: never;
48152
48137
  pat_with_workspace?: never;
48153
48138
  console_session_with_workspace?: never;
48154
48139
  api_key?: never;
48155
48140
  } | {
48156
48141
  pat_with_workspace: never[];
48157
- client_session?: never;
48158
48142
  client_session_with_customer?: never;
48159
48143
  console_session_with_workspace?: never;
48160
48144
  api_key?: never;
48161
48145
  } | {
48162
48146
  console_session_with_workspace: never[];
48163
- client_session?: never;
48164
48147
  client_session_with_customer?: never;
48165
48148
  pat_with_workspace?: never;
48166
48149
  api_key?: never;
48167
48150
  } | {
48168
48151
  api_key: never[];
48169
- client_session?: never;
48170
48152
  client_session_with_customer?: never;
48171
48153
  pat_with_workspace?: never;
48172
48154
  console_session_with_workspace?: never;
@@ -48247,32 +48229,22 @@ declare const _default: {
48247
48229
  };
48248
48230
  };
48249
48231
  security: ({
48250
- client_session: never[];
48251
- client_session_with_customer?: never;
48252
- pat_with_workspace?: never;
48253
- console_session_with_workspace?: never;
48254
- api_key?: never;
48255
- } | {
48256
48232
  client_session_with_customer: never[];
48257
- client_session?: never;
48258
48233
  pat_with_workspace?: never;
48259
48234
  console_session_with_workspace?: never;
48260
48235
  api_key?: never;
48261
48236
  } | {
48262
48237
  pat_with_workspace: never[];
48263
- client_session?: never;
48264
48238
  client_session_with_customer?: never;
48265
48239
  console_session_with_workspace?: never;
48266
48240
  api_key?: never;
48267
48241
  } | {
48268
48242
  console_session_with_workspace: never[];
48269
- client_session?: never;
48270
48243
  client_session_with_customer?: never;
48271
48244
  pat_with_workspace?: never;
48272
48245
  api_key?: never;
48273
48246
  } | {
48274
48247
  api_key: never[];
48275
- client_session?: never;
48276
48248
  client_session_with_customer?: never;
48277
48249
  pat_with_workspace?: never;
48278
48250
  console_session_with_workspace?: never;
@@ -48342,32 +48314,22 @@ declare const _default: {
48342
48314
  };
48343
48315
  };
48344
48316
  security: ({
48345
- client_session: never[];
48346
- client_session_with_customer?: never;
48347
- pat_with_workspace?: never;
48348
- console_session_with_workspace?: never;
48349
- api_key?: never;
48350
- } | {
48351
48317
  client_session_with_customer: never[];
48352
- client_session?: never;
48353
48318
  pat_with_workspace?: never;
48354
48319
  console_session_with_workspace?: never;
48355
48320
  api_key?: never;
48356
48321
  } | {
48357
48322
  pat_with_workspace: never[];
48358
- client_session?: never;
48359
48323
  client_session_with_customer?: never;
48360
48324
  console_session_with_workspace?: never;
48361
48325
  api_key?: never;
48362
48326
  } | {
48363
48327
  console_session_with_workspace: never[];
48364
- client_session?: never;
48365
48328
  client_session_with_customer?: never;
48366
48329
  pat_with_workspace?: never;
48367
48330
  api_key?: never;
48368
48331
  } | {
48369
48332
  api_key: never[];
48370
- client_session?: never;
48371
48333
  client_session_with_customer?: never;
48372
48334
  pat_with_workspace?: never;
48373
48335
  console_session_with_workspace?: never;
@@ -48434,32 +48396,22 @@ declare const _default: {
48434
48396
  };
48435
48397
  };
48436
48398
  security: ({
48437
- client_session: never[];
48438
- client_session_with_customer?: never;
48439
- pat_with_workspace?: never;
48440
- console_session_with_workspace?: never;
48441
- api_key?: never;
48442
- } | {
48443
48399
  client_session_with_customer: never[];
48444
- client_session?: never;
48445
48400
  pat_with_workspace?: never;
48446
48401
  console_session_with_workspace?: never;
48447
48402
  api_key?: never;
48448
48403
  } | {
48449
48404
  pat_with_workspace: never[];
48450
- client_session?: never;
48451
48405
  client_session_with_customer?: never;
48452
48406
  console_session_with_workspace?: never;
48453
48407
  api_key?: never;
48454
48408
  } | {
48455
48409
  console_session_with_workspace: never[];
48456
- client_session?: never;
48457
48410
  client_session_with_customer?: never;
48458
48411
  pat_with_workspace?: never;
48459
48412
  api_key?: never;
48460
48413
  } | {
48461
48414
  api_key: never[];
48462
- client_session?: never;
48463
48415
  client_session_with_customer?: never;
48464
48416
  pat_with_workspace?: never;
48465
48417
  console_session_with_workspace?: never;
@@ -48502,32 +48454,22 @@ declare const _default: {
48502
48454
  };
48503
48455
  };
48504
48456
  security: ({
48505
- client_session: never[];
48506
- client_session_with_customer?: never;
48507
- pat_with_workspace?: never;
48508
- console_session_with_workspace?: never;
48509
- api_key?: never;
48510
- } | {
48511
48457
  client_session_with_customer: never[];
48512
- client_session?: never;
48513
48458
  pat_with_workspace?: never;
48514
48459
  console_session_with_workspace?: never;
48515
48460
  api_key?: never;
48516
48461
  } | {
48517
48462
  pat_with_workspace: never[];
48518
- client_session?: never;
48519
48463
  client_session_with_customer?: never;
48520
48464
  console_session_with_workspace?: never;
48521
48465
  api_key?: never;
48522
48466
  } | {
48523
48467
  console_session_with_workspace: never[];
48524
- client_session?: never;
48525
48468
  client_session_with_customer?: never;
48526
48469
  pat_with_workspace?: never;
48527
48470
  api_key?: never;
48528
48471
  } | {
48529
48472
  api_key: never[];
48530
- client_session?: never;
48531
48473
  client_session_with_customer?: never;
48532
48474
  pat_with_workspace?: never;
48533
48475
  console_session_with_workspace?: never;
@@ -32788,12 +32788,13 @@ export default {
32788
32788
  },
32789
32789
  user_identity_id: {
32790
32790
  description: 'ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.',
32791
+ format: 'uuid',
32791
32792
  type: 'string',
32792
32793
  },
32793
32794
  user_identity_ids: {
32794
32795
  deprecated: true,
32795
32796
  description: 'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
32796
- items: { type: 'string' },
32797
+ items: { format: 'uuid', type: 'string' },
32797
32798
  maxItems: 1,
32798
32799
  minItems: 1,
32799
32800
  type: 'array',
@@ -32878,12 +32879,13 @@ export default {
32878
32879
  },
32879
32880
  user_identity_id: {
32880
32881
  description: 'ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.',
32882
+ format: 'uuid',
32881
32883
  type: 'string',
32882
32884
  },
32883
32885
  user_identity_ids: {
32884
32886
  deprecated: true,
32885
32887
  description: 'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
32886
- items: { type: 'string' },
32888
+ items: { format: 'uuid', type: 'string' },
32887
32889
  maxItems: 1,
32888
32890
  minItems: 1,
32889
32891
  type: 'array',
@@ -33034,6 +33036,7 @@ export default {
33034
33036
  name: 'client_session_id',
33035
33037
  schema: {
33036
33038
  description: 'ID of the client session that you want to get.',
33039
+ format: 'uuid',
33037
33040
  type: 'string',
33038
33041
  },
33039
33042
  },
@@ -33091,6 +33094,7 @@ export default {
33091
33094
  properties: {
33092
33095
  client_session_id: {
33093
33096
  description: 'ID of the client session that you want to get.',
33097
+ format: 'uuid',
33094
33098
  type: 'string',
33095
33099
  },
33096
33100
  user_identifier_key: {
@@ -33170,12 +33174,13 @@ export default {
33170
33174
  },
33171
33175
  user_identity_id: {
33172
33176
  description: 'ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session).',
33177
+ format: 'uuid',
33173
33178
  type: 'string',
33174
33179
  },
33175
33180
  user_identity_ids: {
33176
33181
  deprecated: true,
33177
33182
  description: 'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
33178
- items: { type: 'string' },
33183
+ items: { format: 'uuid', type: 'string' },
33179
33184
  maxItems: 1,
33180
33185
  minItems: 1,
33181
33186
  type: 'array',
@@ -44037,7 +44042,11 @@ export default {
44037
44042
  in: 'query',
44038
44043
  name: 'customer_portal_id',
44039
44044
  required: true,
44040
- schema: { description: 'Customer portal ID.', type: 'string' },
44045
+ schema: {
44046
+ description: 'Customer portal ID.',
44047
+ format: 'uuid',
44048
+ type: 'string',
44049
+ },
44041
44050
  },
44042
44051
  ],
44043
44052
  responses: {
@@ -44124,6 +44133,7 @@ export default {
44124
44133
  properties: {
44125
44134
  customer_portal_id: {
44126
44135
  description: 'Customer portal ID.',
44136
+ format: 'uuid',
44127
44137
  type: 'string',
44128
44138
  },
44129
44139
  },
@@ -44633,7 +44643,10 @@ export default {
44633
44643
  acs_entrances: {
44634
44644
  items: {
44635
44645
  properties: {
44636
- acs_entrance_id: { type: 'string' },
44646
+ acs_entrance_id: {
44647
+ format: 'uuid',
44648
+ type: 'string',
44649
+ },
44637
44650
  name: { type: 'string' },
44638
44651
  },
44639
44652
  required: ['acs_entrance_id', 'name'],
@@ -44644,7 +44657,7 @@ export default {
44644
44657
  devices: {
44645
44658
  items: {
44646
44659
  properties: {
44647
- device_id: { type: 'string' },
44660
+ device_id: { format: 'uuid', type: 'string' },
44648
44661
  device_type: {
44649
44662
  enum: ['lock', 'thermostat', 'sensor'],
44650
44663
  type: 'string',
@@ -44729,7 +44742,10 @@ export default {
44729
44742
  acs_entrances: {
44730
44743
  items: {
44731
44744
  properties: {
44732
- acs_entrance_id: { type: 'string' },
44745
+ acs_entrance_id: {
44746
+ format: 'uuid',
44747
+ type: 'string',
44748
+ },
44733
44749
  name: { type: 'string' },
44734
44750
  },
44735
44751
  required: ['acs_entrance_id', 'name'],
@@ -44740,7 +44756,7 @@ export default {
44740
44756
  devices: {
44741
44757
  items: {
44742
44758
  properties: {
44743
- device_id: { type: 'string' },
44759
+ device_id: { format: 'uuid', type: 'string' },
44744
44760
  device_type: {
44745
44761
  enum: ['lock', 'thermostat', 'sensor'],
44746
44762
  type: 'string',
@@ -51855,7 +51871,6 @@ export default {
51855
51871
  401: { description: 'Unauthorized' },
51856
51872
  },
51857
51873
  security: [
51858
- { client_session: [] },
51859
51874
  { client_session_with_customer: [] },
51860
51875
  { pat_with_workspace: [] },
51861
51876
  { console_session_with_workspace: [] },
@@ -51927,7 +51942,6 @@ export default {
51927
51942
  401: { description: 'Unauthorized' },
51928
51943
  },
51929
51944
  security: [
51930
- { client_session: [] },
51931
51945
  { client_session_with_customer: [] },
51932
51946
  { pat_with_workspace: [] },
51933
51947
  { console_session_with_workspace: [] },
@@ -52002,7 +52016,6 @@ export default {
52002
52016
  401: { description: 'Unauthorized' },
52003
52017
  },
52004
52018
  security: [
52005
- { client_session: [] },
52006
52019
  { client_session_with_customer: [] },
52007
52020
  { pat_with_workspace: [] },
52008
52021
  { console_session_with_workspace: [] },
@@ -52069,7 +52082,6 @@ export default {
52069
52082
  401: { description: 'Unauthorized' },
52070
52083
  },
52071
52084
  security: [
52072
- { client_session: [] },
52073
52085
  { client_session_with_customer: [] },
52074
52086
  { pat_with_workspace: [] },
52075
52087
  { console_session_with_workspace: [] },
@@ -52134,7 +52146,6 @@ export default {
52134
52146
  401: { description: 'Unauthorized' },
52135
52147
  },
52136
52148
  security: [
52137
- { client_session: [] },
52138
52149
  { client_session_with_customer: [] },
52139
52150
  { pat_with_workspace: [] },
52140
52151
  { console_session_with_workspace: [] },
@@ -52187,7 +52198,6 @@ export default {
52187
52198
  401: { description: 'Unauthorized' },
52188
52199
  },
52189
52200
  security: [
52190
- { client_session: [] },
52191
52201
  { client_session_with_customer: [] },
52192
52202
  { pat_with_workspace: [] },
52193
52203
  { console_session_with_workspace: [] },
@@ -52237,7 +52247,6 @@ export default {
52237
52247
  401: { description: 'Unauthorized' },
52238
52248
  },
52239
52249
  security: [
52240
- { client_session: [] },
52241
52250
  { client_session_with_customer: [] },
52242
52251
  { pat_with_workspace: [] },
52243
52252
  { console_session_with_workspace: [] },
@@ -52273,7 +52282,6 @@ export default {
52273
52282
  401: { description: 'Unauthorized' },
52274
52283
  },
52275
52284
  security: [
52276
- { client_session: [] },
52277
52285
  { client_session_with_customer: [] },
52278
52286
  { pat_with_workspace: [] },
52279
52287
  { console_session_with_workspace: [] },