@seamapi/types 1.508.0 → 1.510.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 (12) hide show
  1. package/dist/connect.cjs +96 -0
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +161 -89
  4. package/dist/index.cjs +96 -0
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/openapi.d.ts +145 -89
  7. package/lib/seam/connect/openapi.js +96 -0
  8. package/lib/seam/connect/openapi.js.map +1 -1
  9. package/lib/seam/connect/route-types.d.ts +16 -0
  10. package/package.json +1 -1
  11. package/src/lib/seam/connect/openapi.ts +106 -0
  12. package/src/lib/seam/connect/route-types.ts +16 -0
package/dist/connect.d.cts CHANGED
@@ -73316,6 +73316,22 @@ declare const _default: {
73316
73316
  description: string;
73317
73317
  operationId: string;
73318
73318
  parameters: ({
73319
+ in: string;
73320
+ name: string;
73321
+ schema: {
73322
+ description: string;
73323
+ type: string;
73324
+ format?: never;
73325
+ deprecated?: never;
73326
+ nullable?: never;
73327
+ 'x-deprecated'?: never;
73328
+ items?: never;
73329
+ minLength?: never;
73330
+ default?: never;
73331
+ exclusiveMinimum?: never;
73332
+ minimum?: never;
73333
+ };
73334
+ } | {
73319
73335
  in: string;
73320
73336
  name: string;
73321
73337
  schema: {
@@ -73528,6 +73544,10 @@ declare const _default: {
73528
73544
  format: string;
73529
73545
  type: string;
73530
73546
  };
73547
+ customer_key: {
73548
+ description: string;
73549
+ type: string;
73550
+ };
73531
73551
  limit: {
73532
73552
  default: number;
73533
73553
  description: string;
@@ -73946,7 +73966,15 @@ declare const _default: {
73946
73966
  get: {
73947
73967
  description: string;
73948
73968
  operationId: string;
73949
- parameters: {
73969
+ parameters: ({
73970
+ in: string;
73971
+ name: string;
73972
+ schema: {
73973
+ description: string;
73974
+ type: string;
73975
+ format?: never;
73976
+ };
73977
+ } | {
73950
73978
  in: string;
73951
73979
  name: string;
73952
73980
  schema: {
@@ -73954,7 +73982,7 @@ declare const _default: {
73954
73982
  format: string;
73955
73983
  type: string;
73956
73984
  };
73957
- }[];
73985
+ })[];
73958
73986
  responses: {
73959
73987
  200: {
73960
73988
  content: {
@@ -74027,6 +74055,10 @@ declare const _default: {
74027
74055
  format: string;
74028
74056
  type: string;
74029
74057
  };
74058
+ customer_key: {
74059
+ description: string;
74060
+ type: string;
74061
+ };
74030
74062
  };
74031
74063
  type: string;
74032
74064
  };
@@ -78328,6 +78360,10 @@ declare const _default: {
78328
78360
  description: string;
78329
78361
  type: string;
78330
78362
  };
78363
+ customer_key: {
78364
+ description: string;
78365
+ type: string;
78366
+ };
78331
78367
  limit: {
78332
78368
  default: number;
78333
78369
  description: string;
@@ -81161,6 +81197,24 @@ declare const _default: {
81161
81197
  'x-deprecated'?: never;
81162
81198
  minLength?: never;
81163
81199
  };
81200
+ } | {
81201
+ in: string;
81202
+ name: string;
81203
+ schema: {
81204
+ description: string;
81205
+ type: string;
81206
+ items?: never;
81207
+ format?: never;
81208
+ oneOf?: never;
81209
+ enum?: never;
81210
+ default?: never;
81211
+ additionalProperties?: never;
81212
+ nullable?: never;
81213
+ 'x-undocumented'?: never;
81214
+ deprecated?: never;
81215
+ 'x-deprecated'?: never;
81216
+ minLength?: never;
81217
+ };
81164
81218
  } | {
81165
81219
  in: string;
81166
81220
  name: string;
@@ -81287,24 +81341,6 @@ declare const _default: {
81287
81341
  'x-deprecated'?: never;
81288
81342
  minLength?: never;
81289
81343
  };
81290
- } | {
81291
- in: string;
81292
- name: string;
81293
- schema: {
81294
- description: string;
81295
- type: string;
81296
- items?: never;
81297
- format?: never;
81298
- oneOf?: never;
81299
- enum?: never;
81300
- default?: never;
81301
- additionalProperties?: never;
81302
- nullable?: never;
81303
- 'x-undocumented'?: never;
81304
- deprecated?: never;
81305
- 'x-deprecated'?: never;
81306
- minLength?: never;
81307
- };
81308
81344
  } | {
81309
81345
  in: string;
81310
81346
  name: string;
@@ -81529,6 +81565,10 @@ declare const _default: {
81529
81565
  };
81530
81566
  type: string;
81531
81567
  };
81568
+ customer_key: {
81569
+ description: string;
81570
+ type: string;
81571
+ };
81532
81572
  device_ids: {
81533
81573
  description: string;
81534
81574
  items: {
@@ -82393,6 +82433,24 @@ declare const _default: {
82393
82433
  'x-deprecated'?: never;
82394
82434
  minLength?: never;
82395
82435
  };
82436
+ } | {
82437
+ in: string;
82438
+ name: string;
82439
+ schema: {
82440
+ description: string;
82441
+ type: string;
82442
+ items?: never;
82443
+ format?: never;
82444
+ oneOf?: never;
82445
+ enum?: never;
82446
+ default?: never;
82447
+ additionalProperties?: never;
82448
+ nullable?: never;
82449
+ 'x-undocumented'?: never;
82450
+ deprecated?: never;
82451
+ 'x-deprecated'?: never;
82452
+ minLength?: never;
82453
+ };
82396
82454
  } | {
82397
82455
  in: string;
82398
82456
  name: string;
@@ -82519,24 +82577,6 @@ declare const _default: {
82519
82577
  'x-deprecated'?: never;
82520
82578
  minLength?: never;
82521
82579
  };
82522
- } | {
82523
- in: string;
82524
- name: string;
82525
- schema: {
82526
- description: string;
82527
- type: string;
82528
- items?: never;
82529
- format?: never;
82530
- oneOf?: never;
82531
- enum?: never;
82532
- default?: never;
82533
- additionalProperties?: never;
82534
- nullable?: never;
82535
- 'x-undocumented'?: never;
82536
- deprecated?: never;
82537
- 'x-deprecated'?: never;
82538
- minLength?: never;
82539
- };
82540
82580
  } | {
82541
82581
  in: string;
82542
82582
  name: string;
@@ -82740,6 +82780,10 @@ declare const _default: {
82740
82780
  };
82741
82781
  type: string;
82742
82782
  };
82783
+ customer_key: {
82784
+ description: string;
82785
+ type: string;
82786
+ };
82743
82787
  device_ids: {
82744
82788
  description: string;
82745
82789
  items: {
@@ -84398,6 +84442,23 @@ declare const _default: {
84398
84442
  'x-deprecated'?: never;
84399
84443
  minLength?: never;
84400
84444
  };
84445
+ } | {
84446
+ in: string;
84447
+ name: string;
84448
+ schema: {
84449
+ description: string;
84450
+ type: string;
84451
+ items?: never;
84452
+ format?: never;
84453
+ enum?: never;
84454
+ default?: never;
84455
+ additionalProperties?: never;
84456
+ nullable?: never;
84457
+ 'x-undocumented'?: never;
84458
+ deprecated?: never;
84459
+ 'x-deprecated'?: never;
84460
+ minLength?: never;
84461
+ };
84401
84462
  } | {
84402
84463
  in: string;
84403
84464
  name: string;
@@ -84493,23 +84554,6 @@ declare const _default: {
84493
84554
  'x-deprecated'?: never;
84494
84555
  minLength?: never;
84495
84556
  };
84496
- } | {
84497
- in: string;
84498
- name: string;
84499
- schema: {
84500
- description: string;
84501
- type: string;
84502
- items?: never;
84503
- format?: never;
84504
- enum?: never;
84505
- default?: never;
84506
- additionalProperties?: never;
84507
- nullable?: never;
84508
- 'x-undocumented'?: never;
84509
- deprecated?: never;
84510
- 'x-deprecated'?: never;
84511
- minLength?: never;
84512
- };
84513
84557
  } | {
84514
84558
  in: string;
84515
84559
  name: string;
@@ -84722,6 +84766,10 @@ declare const _default: {
84722
84766
  };
84723
84767
  type: string;
84724
84768
  };
84769
+ customer_key: {
84770
+ description: string;
84771
+ type: string;
84772
+ };
84725
84773
  device_ids: {
84726
84774
  description: string;
84727
84775
  items: {
@@ -85229,6 +85277,23 @@ declare const _default: {
85229
85277
  'x-deprecated'?: never;
85230
85278
  minLength?: never;
85231
85279
  };
85280
+ } | {
85281
+ in: string;
85282
+ name: string;
85283
+ schema: {
85284
+ description: string;
85285
+ type: string;
85286
+ items?: never;
85287
+ format?: never;
85288
+ enum?: never;
85289
+ default?: never;
85290
+ additionalProperties?: never;
85291
+ nullable?: never;
85292
+ 'x-undocumented'?: never;
85293
+ deprecated?: never;
85294
+ 'x-deprecated'?: never;
85295
+ minLength?: never;
85296
+ };
85232
85297
  } | {
85233
85298
  in: string;
85234
85299
  name: string;
@@ -85324,23 +85389,6 @@ declare const _default: {
85324
85389
  'x-deprecated'?: never;
85325
85390
  minLength?: never;
85326
85391
  };
85327
- } | {
85328
- in: string;
85329
- name: string;
85330
- schema: {
85331
- description: string;
85332
- type: string;
85333
- items?: never;
85334
- format?: never;
85335
- enum?: never;
85336
- default?: never;
85337
- additionalProperties?: never;
85338
- nullable?: never;
85339
- 'x-undocumented'?: never;
85340
- deprecated?: never;
85341
- 'x-deprecated'?: never;
85342
- minLength?: never;
85343
- };
85344
85392
  } | {
85345
85393
  in: string;
85346
85394
  name: string;
@@ -85553,6 +85601,10 @@ declare const _default: {
85553
85601
  };
85554
85602
  type: string;
85555
85603
  };
85604
+ customer_key: {
85605
+ description: string;
85606
+ type: string;
85607
+ };
85556
85608
  device_ids: {
85557
85609
  description: string;
85558
85610
  items: {
@@ -92803,6 +92855,23 @@ declare const _default: {
92803
92855
  'x-deprecated'?: never;
92804
92856
  minLength?: never;
92805
92857
  };
92858
+ } | {
92859
+ in: string;
92860
+ name: string;
92861
+ schema: {
92862
+ description: string;
92863
+ type: string;
92864
+ items?: never;
92865
+ format?: never;
92866
+ enum?: never;
92867
+ default?: never;
92868
+ additionalProperties?: never;
92869
+ nullable?: never;
92870
+ 'x-undocumented'?: never;
92871
+ deprecated?: never;
92872
+ 'x-deprecated'?: never;
92873
+ minLength?: never;
92874
+ };
92806
92875
  } | {
92807
92876
  in: string;
92808
92877
  name: string;
@@ -92898,23 +92967,6 @@ declare const _default: {
92898
92967
  'x-deprecated'?: never;
92899
92968
  minLength?: never;
92900
92969
  };
92901
- } | {
92902
- in: string;
92903
- name: string;
92904
- schema: {
92905
- description: string;
92906
- type: string;
92907
- items?: never;
92908
- format?: never;
92909
- enum?: never;
92910
- default?: never;
92911
- additionalProperties?: never;
92912
- nullable?: never;
92913
- 'x-undocumented'?: never;
92914
- deprecated?: never;
92915
- 'x-deprecated'?: never;
92916
- minLength?: never;
92917
- };
92918
92970
  } | {
92919
92971
  in: string;
92920
92972
  name: string;
@@ -93127,6 +93179,10 @@ declare const _default: {
93127
93179
  };
93128
93180
  type: string;
93129
93181
  };
93182
+ customer_key: {
93183
+ description: string;
93184
+ type: string;
93185
+ };
93130
93186
  device_ids: {
93131
93187
  description: string;
93132
93188
  items: {
@@ -125505,6 +125561,8 @@ type Routes = {
125505
125561
  queryParams: {};
125506
125562
  jsonBody: {};
125507
125563
  commonParams: {
125564
+ /** Customer key for which you want to list entrances. */
125565
+ customer_key?: string | undefined;
125508
125566
  /** ID of the access system for which you want to retrieve all entrances. */
125509
125567
  acs_system_id?: string | undefined;
125510
125568
  /** ID of the credential for which you want to retrieve all entrances. */
@@ -125938,6 +125996,8 @@ type Routes = {
125938
125996
  queryParams: {};
125939
125997
  jsonBody: {};
125940
125998
  commonParams: {
125999
+ /** Customer key for which you want to list access systems. */
126000
+ customer_key?: string | undefined;
125941
126001
  /** ID of the connected account by which you want to filter the list of access systems. */
125942
126002
  connected_account_id?: string | undefined;
125943
126003
  };
@@ -130655,6 +130715,8 @@ type Routes = {
130655
130715
  queryParams: {};
130656
130716
  jsonBody: {};
130657
130717
  commonParams: {
130718
+ /** Customer key for which you want to list connect webviews. */
130719
+ customer_key?: string | undefined;
130658
130720
  /** Your user ID for the user by which you want to filter Connect Webviews. */
130659
130721
  user_identifier_key?: string | undefined;
130660
130722
  /** 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. */
@@ -132994,6 +133056,8 @@ type Routes = {
132994
133056
  jsonBody: {};
132995
133057
  commonParams: {
132996
133058
  customer_ids?: string[] | undefined;
133059
+ /** Customer key for which you want to list devices. */
133060
+ customer_key?: string | undefined;
132997
133061
  /** ID of the connected account for which you want to list devices. */
132998
133062
  connected_account_id?: string | undefined;
132999
133063
  /** Array of IDs of the connected accounts for which you want to list devices. */
@@ -134719,6 +134783,8 @@ type Routes = {
134719
134783
  jsonBody: {};
134720
134784
  commonParams: {
134721
134785
  customer_ids?: string[] | undefined;
134786
+ /** Customer key for which you want to list devices. */
134787
+ customer_key?: string | undefined;
134722
134788
  /** ID of the connected account for which you want to list devices. */
134723
134789
  connected_account_id?: string | undefined;
134724
134790
  /** Array of IDs of the connected accounts for which you want to list devices. */
@@ -141368,6 +141434,8 @@ type Routes = {
141368
141434
  jsonBody: {};
141369
141435
  commonParams: {
141370
141436
  customer_ids?: string[] | undefined;
141437
+ /** Customer key for which you want to list devices. */
141438
+ customer_key?: string | undefined;
141371
141439
  /** ID of the connected account for which you want to list devices. */
141372
141440
  connected_account_id?: string | undefined;
141373
141441
  /** Array of IDs of the connected accounts for which you want to list devices. */
@@ -148795,6 +148863,8 @@ type Routes = {
148795
148863
  jsonBody: {};
148796
148864
  commonParams: {
148797
148865
  customer_ids?: string[] | undefined;
148866
+ /** Customer key for which you want to list devices. */
148867
+ customer_key?: string | undefined;
148798
148868
  /** ID of the connected account for which you want to list devices. */
148799
148869
  connected_account_id?: string | undefined;
148800
148870
  /** Array of IDs of the connected accounts for which you want to list devices. */
@@ -167631,6 +167701,8 @@ type Routes = {
167631
167701
  jsonBody: {};
167632
167702
  commonParams: {
167633
167703
  customer_ids?: string[] | undefined;
167704
+ /** Customer key for which you want to list devices. */
167705
+ customer_key?: string | undefined;
167634
167706
  /** ID of the connected account for which you want to list devices. */
167635
167707
  connected_account_id?: string | undefined;
167636
167708
  /** Array of IDs of the connected accounts for which you want to list devices. */
package/dist/index.cjs CHANGED
@@ -35662,6 +35662,14 @@ var openapi_default = {
35662
35662
  description: "Returns a list of all [access system entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
35663
35663
  operationId: "acsEntrancesListGet",
35664
35664
  parameters: [
35665
+ {
35666
+ in: "query",
35667
+ name: "customer_key",
35668
+ schema: {
35669
+ description: "Customer key for which you want to list entrances.",
35670
+ type: "string"
35671
+ }
35672
+ },
35665
35673
  {
35666
35674
  in: "query",
35667
35675
  name: "acs_system_id",
@@ -35842,6 +35850,10 @@ var openapi_default = {
35842
35850
  format: "uuid",
35843
35851
  type: "string"
35844
35852
  },
35853
+ customer_key: {
35854
+ description: "Customer key for which you want to list entrances.",
35855
+ type: "string"
35856
+ },
35845
35857
  limit: {
35846
35858
  default: 900,
35847
35859
  description: "Maximum number of records to return per page.",
@@ -36149,6 +36161,14 @@ var openapi_default = {
36149
36161
  description: "Returns a list of all [access systems](https://docs.seam.co/latest/capability-guides/access-systems).\n\nTo filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace.",
36150
36162
  operationId: "acsSystemsListGet",
36151
36163
  parameters: [
36164
+ {
36165
+ in: "query",
36166
+ name: "customer_key",
36167
+ schema: {
36168
+ description: "Customer key for which you want to list access systems.",
36169
+ type: "string"
36170
+ }
36171
+ },
36152
36172
  {
36153
36173
  in: "query",
36154
36174
  name: "connected_account_id",
@@ -36207,6 +36227,10 @@ var openapi_default = {
36207
36227
  description: "ID of the connected account by which you want to filter the list of access systems.",
36208
36228
  format: "uuid",
36209
36229
  type: "string"
36230
+ },
36231
+ customer_key: {
36232
+ description: "Customer key for which you want to list access systems.",
36233
+ type: "string"
36210
36234
  }
36211
36235
  },
36212
36236
  type: "object"
@@ -39642,6 +39666,14 @@ var openapi_default = {
39642
39666
  description: "Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).",
39643
39667
  operationId: "connectWebviewsListGet",
39644
39668
  parameters: [
39669
+ {
39670
+ in: "query",
39671
+ name: "customer_key",
39672
+ schema: {
39673
+ description: "Customer key for which you want to list connect webviews.",
39674
+ type: "string"
39675
+ }
39676
+ },
39645
39677
  {
39646
39678
  in: "query",
39647
39679
  name: "user_identifier_key",
@@ -39734,6 +39766,10 @@ var openapi_default = {
39734
39766
  description: "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.",
39735
39767
  type: "object"
39736
39768
  },
39769
+ customer_key: {
39770
+ description: "Customer key for which you want to list connect webviews.",
39771
+ type: "string"
39772
+ },
39737
39773
  limit: {
39738
39774
  default: 500,
39739
39775
  description: "Maximum number of records to return per page.",
@@ -42172,6 +42208,14 @@ var openapi_default = {
42172
42208
  type: "array"
42173
42209
  }
42174
42210
  },
42211
+ {
42212
+ in: "query",
42213
+ name: "customer_key",
42214
+ schema: {
42215
+ description: "Customer key for which you want to list devices.",
42216
+ type: "string"
42217
+ }
42218
+ },
42175
42219
  {
42176
42220
  in: "query",
42177
42221
  name: "connected_account_id",
@@ -42613,6 +42657,10 @@ var openapi_default = {
42613
42657
  items: { format: "uuid", type: "string" },
42614
42658
  type: "array"
42615
42659
  },
42660
+ customer_key: {
42661
+ description: "Customer key for which you want to list devices.",
42662
+ type: "string"
42663
+ },
42616
42664
  device_ids: {
42617
42665
  description: "Array of device IDs for which you want to list devices.",
42618
42666
  items: { format: "uuid", type: "string" },
@@ -43412,6 +43460,14 @@ var openapi_default = {
43412
43460
  type: "array"
43413
43461
  }
43414
43462
  },
43463
+ {
43464
+ in: "query",
43465
+ name: "customer_key",
43466
+ schema: {
43467
+ description: "Customer key for which you want to list devices.",
43468
+ type: "string"
43469
+ }
43470
+ },
43415
43471
  {
43416
43472
  in: "query",
43417
43473
  name: "connected_account_id",
@@ -43850,6 +43906,10 @@ var openapi_default = {
43850
43906
  items: { format: "uuid", type: "string" },
43851
43907
  type: "array"
43852
43908
  },
43909
+ customer_key: {
43910
+ description: "Customer key for which you want to list devices.",
43911
+ type: "string"
43912
+ },
43853
43913
  device_ids: {
43854
43914
  description: "Array of device IDs for which you want to list devices.",
43855
43915
  items: { format: "uuid", type: "string" },
@@ -45681,6 +45741,14 @@ var openapi_default = {
45681
45741
  type: "array"
45682
45742
  }
45683
45743
  },
45744
+ {
45745
+ in: "query",
45746
+ name: "customer_key",
45747
+ schema: {
45748
+ description: "Customer key for which you want to list devices.",
45749
+ type: "string"
45750
+ }
45751
+ },
45684
45752
  {
45685
45753
  in: "query",
45686
45754
  name: "connected_account_id",
@@ -46059,6 +46127,10 @@ var openapi_default = {
46059
46127
  items: { format: "uuid", type: "string" },
46060
46128
  type: "array"
46061
46129
  },
46130
+ customer_key: {
46131
+ description: "Customer key for which you want to list devices.",
46132
+ type: "string"
46133
+ },
46062
46134
  device_ids: {
46063
46135
  description: "Array of device IDs for which you want to list devices.",
46064
46136
  items: { format: "uuid", type: "string" },
@@ -46554,6 +46626,14 @@ var openapi_default = {
46554
46626
  type: "array"
46555
46627
  }
46556
46628
  },
46629
+ {
46630
+ in: "query",
46631
+ name: "customer_key",
46632
+ schema: {
46633
+ description: "Customer key for which you want to list devices.",
46634
+ type: "string"
46635
+ }
46636
+ },
46557
46637
  {
46558
46638
  in: "query",
46559
46639
  name: "connected_account_id",
@@ -46847,6 +46927,10 @@ var openapi_default = {
46847
46927
  items: { format: "uuid", type: "string" },
46848
46928
  type: "array"
46849
46929
  },
46930
+ customer_key: {
46931
+ description: "Customer key for which you want to list devices.",
46932
+ type: "string"
46933
+ },
46850
46934
  device_ids: {
46851
46935
  description: "Array of device IDs for which you want to list devices.",
46852
46936
  items: { format: "uuid", type: "string" },
@@ -53061,6 +53145,14 @@ var openapi_default = {
53061
53145
  type: "array"
53062
53146
  }
53063
53147
  },
53148
+ {
53149
+ in: "query",
53150
+ name: "customer_key",
53151
+ schema: {
53152
+ description: "Customer key for which you want to list devices.",
53153
+ type: "string"
53154
+ }
53155
+ },
53064
53156
  {
53065
53157
  in: "query",
53066
53158
  name: "connected_account_id",
@@ -53375,6 +53467,10 @@ var openapi_default = {
53375
53467
  items: { format: "uuid", type: "string" },
53376
53468
  type: "array"
53377
53469
  },
53470
+ customer_key: {
53471
+ description: "Customer key for which you want to list devices.",
53472
+ type: "string"
53473
+ },
53378
53474
  device_ids: {
53379
53475
  description: "Array of device IDs for which you want to list devices.",
53380
53476
  items: { format: "uuid", type: "string" },