@seamapi/types 1.509.0 → 1.511.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.
@@ -10000,6 +10000,8 @@ export type Routes = {
10000
10000
  starts_at?: string | undefined;
10001
10001
  /** Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
10002
10002
  ends_at?: (string | undefined) | null;
10003
+ /** ID of the customization profile to apply to the Access Grant and its access methods. */
10004
+ customization_profile_id?: string | undefined;
10003
10005
  };
10004
10006
  formData: {};
10005
10007
  jsonResponse: {
@@ -10045,6 +10047,8 @@ export type Routes = {
10045
10047
  starts_at: string;
10046
10048
  /** Date and time at which the Access Grant ends. */
10047
10049
  ends_at: string | null;
10050
+ /** ID of the customization profile associated with the Access Grant. */
10051
+ customization_profile_id?: string | undefined;
10048
10052
  };
10049
10053
  };
10050
10054
  };
@@ -10116,6 +10120,8 @@ export type Routes = {
10116
10120
  starts_at: string;
10117
10121
  /** Date and time at which the Access Grant ends. */
10118
10122
  ends_at: string | null;
10123
+ /** ID of the customization profile associated with the Access Grant. */
10124
+ customization_profile_id?: string | undefined;
10119
10125
  };
10120
10126
  };
10121
10127
  };
@@ -11825,6 +11831,8 @@ export type Routes = {
11825
11831
  starts_at: string;
11826
11832
  /** Date and time at which the Access Grant ends. */
11827
11833
  ends_at: string | null;
11834
+ /** ID of the customization profile associated with the Access Grant. */
11835
+ customization_profile_id?: string | undefined;
11828
11836
  }[];
11829
11837
  };
11830
11838
  };
@@ -13153,6 +13161,8 @@ export type Routes = {
13153
13161
  is_encoding_required?: boolean | undefined;
13154
13162
  /** The actual PIN code for code access methods. */
13155
13163
  code?: string | undefined;
13164
+ /** ID of the customization profile associated with the access method. */
13165
+ customization_profile_id?: string | undefined;
13156
13166
  };
13157
13167
  };
13158
13168
  };
@@ -17153,6 +17163,8 @@ export type Routes = {
17153
17163
  is_encoding_required?: boolean | undefined;
17154
17164
  /** The actual PIN code for code access methods. */
17155
17165
  code?: string | undefined;
17166
+ /** ID of the customization profile associated with the access method. */
17167
+ customization_profile_id?: string | undefined;
17156
17168
  }[] | undefined;
17157
17169
  access_grants?: {
17158
17170
  /** ID of the Seam workspace associated with the Access Grant. */
@@ -17195,6 +17207,8 @@ export type Routes = {
17195
17207
  starts_at: string;
17196
17208
  /** Date and time at which the Access Grant ends. */
17197
17209
  ends_at: string | null;
17210
+ /** ID of the customization profile associated with the Access Grant. */
17211
+ customization_profile_id?: string | undefined;
17198
17212
  }[] | undefined;
17199
17213
  events?: ({
17200
17214
  /** ID of the event. */
@@ -20165,6 +20179,8 @@ export type Routes = {
20165
20179
  is_encoding_required?: boolean | undefined;
20166
20180
  /** The actual PIN code for code access methods. */
20167
20181
  code?: string | undefined;
20182
+ /** ID of the customization profile associated with the access method. */
20183
+ customization_profile_id?: string | undefined;
20168
20184
  }[];
20169
20185
  };
20170
20186
  };
@@ -30361,6 +30377,8 @@ export type Routes = {
30361
30377
  queryParams: {};
30362
30378
  jsonBody: {};
30363
30379
  commonParams: {
30380
+ /** Customer key for which you want to list connect webviews. */
30381
+ customer_key?: string | undefined;
30364
30382
  /** Your user ID for the user by which you want to filter Connect Webviews. */
30365
30383
  user_identifier_key?: string | undefined;
30366
30384
  /** 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. */
@@ -32700,6 +32718,8 @@ export type Routes = {
32700
32718
  jsonBody: {};
32701
32719
  commonParams: {
32702
32720
  customer_ids?: string[] | undefined;
32721
+ /** Customer key for which you want to list devices. */
32722
+ customer_key?: string | undefined;
32703
32723
  /** ID of the connected account for which you want to list devices. */
32704
32724
  connected_account_id?: string | undefined;
32705
32725
  /** Array of IDs of the connected accounts for which you want to list devices. */
@@ -34425,6 +34445,8 @@ export type Routes = {
34425
34445
  jsonBody: {};
34426
34446
  commonParams: {
34427
34447
  customer_ids?: string[] | undefined;
34448
+ /** Customer key for which you want to list devices. */
34449
+ customer_key?: string | undefined;
34428
34450
  /** ID of the connected account for which you want to list devices. */
34429
34451
  connected_account_id?: string | undefined;
34430
34452
  /** Array of IDs of the connected accounts for which you want to list devices. */
@@ -41074,6 +41096,8 @@ export type Routes = {
41074
41096
  jsonBody: {};
41075
41097
  commonParams: {
41076
41098
  customer_ids?: string[] | undefined;
41099
+ /** Customer key for which you want to list devices. */
41100
+ customer_key?: string | undefined;
41077
41101
  /** ID of the connected account for which you want to list devices. */
41078
41102
  connected_account_id?: string | undefined;
41079
41103
  /** Array of IDs of the connected accounts for which you want to list devices. */
@@ -48501,6 +48525,8 @@ export type Routes = {
48501
48525
  jsonBody: {};
48502
48526
  commonParams: {
48503
48527
  customer_ids?: string[] | undefined;
48528
+ /** Customer key for which you want to list devices. */
48529
+ customer_key?: string | undefined;
48504
48530
  /** ID of the connected account for which you want to list devices. */
48505
48531
  connected_account_id?: string | undefined;
48506
48532
  /** Array of IDs of the connected accounts for which you want to list devices. */
@@ -67337,6 +67363,8 @@ export type Routes = {
67337
67363
  jsonBody: {};
67338
67364
  commonParams: {
67339
67365
  customer_ids?: string[] | undefined;
67366
+ /** Customer key for which you want to list devices. */
67367
+ customer_key?: string | undefined;
67340
67368
  /** ID of the connected account for which you want to list devices. */
67341
67369
  connected_account_id?: string | undefined;
67342
67370
  /** Array of IDs of the connected accounts for which you want to list devices. */
@@ -82648,6 +82676,8 @@ export type Routes = {
82648
82676
  is_encoding_required?: boolean | undefined;
82649
82677
  /** The actual PIN code for code access methods. */
82650
82678
  code?: string | undefined;
82679
+ /** ID of the customization profile associated with the access method. */
82680
+ customization_profile_id?: string | undefined;
82651
82681
  }[] | undefined;
82652
82682
  access_grants?: {
82653
82683
  /** ID of the Seam workspace associated with the Access Grant. */
@@ -82690,6 +82720,8 @@ export type Routes = {
82690
82720
  starts_at: string;
82691
82721
  /** Date and time at which the Access Grant ends. */
82692
82722
  ends_at: string | null;
82723
+ /** ID of the customization profile associated with the Access Grant. */
82724
+ customization_profile_id?: string | undefined;
82693
82725
  }[] | undefined;
82694
82726
  events?: ({
82695
82727
  /** ID of the event. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.509.0",
3
+ "version": "1.511.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -63,6 +63,13 @@ export const access_grant = z.object({
63
63
  .datetime()
64
64
  .nullable()
65
65
  .describe('Date and time at which the Access Grant ends.'),
66
+ customization_profile_id: z
67
+ .string()
68
+ .uuid()
69
+ .optional()
70
+ .describe(
71
+ 'ID of the customization profile associated with the Access Grant.',
72
+ ),
66
73
  }).describe(`
67
74
  ---
68
75
  draft: Early access.
@@ -43,6 +43,13 @@ export const access_method = z.object({
43
43
  .string()
44
44
  .optional()
45
45
  .describe('The actual PIN code for code access methods.'),
46
+ customization_profile_id: z
47
+ .string()
48
+ .uuid()
49
+ .optional()
50
+ .describe(
51
+ 'ID of the customization profile associated with the access method.',
52
+ ),
46
53
  }).describe(`
47
54
  ---
48
55
  draft: Early access.
@@ -1850,6 +1850,12 @@ export default {
1850
1850
  format: 'date-time',
1851
1851
  type: 'string',
1852
1852
  },
1853
+ customization_profile_id: {
1854
+ description:
1855
+ 'ID of the customization profile associated with the Access Grant.',
1856
+ format: 'uuid',
1857
+ type: 'string',
1858
+ },
1853
1859
  display_name: {
1854
1860
  description: 'Display name of the Access Grant.',
1855
1861
  type: 'string',
@@ -1982,6 +1988,12 @@ export default {
1982
1988
  format: 'date-time',
1983
1989
  type: 'string',
1984
1990
  },
1991
+ customization_profile_id: {
1992
+ description:
1993
+ 'ID of the customization profile associated with the access method.',
1994
+ format: 'uuid',
1995
+ type: 'string',
1996
+ },
1985
1997
  display_name: {
1986
1998
  description: 'Display name of the access method.',
1987
1999
  type: 'string',
@@ -27894,6 +27906,12 @@ export default {
27894
27906
  items: { format: 'uuid', type: 'string' },
27895
27907
  type: 'array',
27896
27908
  },
27909
+ customization_profile_id: {
27910
+ description:
27911
+ 'ID of the customization profile to apply to the Access Grant and its access methods.',
27912
+ format: 'uuid',
27913
+ type: 'string',
27914
+ },
27897
27915
  device_ids: {
27898
27916
  default: [],
27899
27917
  description:
@@ -37448,6 +37466,15 @@ export default {
37448
37466
  'Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).',
37449
37467
  operationId: 'connectWebviewsListGet',
37450
37468
  parameters: [
37469
+ {
37470
+ in: 'query',
37471
+ name: 'customer_key',
37472
+ schema: {
37473
+ description:
37474
+ 'Customer key for which you want to list connect webviews.',
37475
+ type: 'string',
37476
+ },
37477
+ },
37451
37478
  {
37452
37479
  in: 'query',
37453
37480
  name: 'user_identifier_key',
@@ -37545,6 +37572,11 @@ export default {
37545
37572
  '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.',
37546
37573
  type: 'object',
37547
37574
  },
37575
+ customer_key: {
37576
+ description:
37577
+ 'Customer key for which you want to list connect webviews.',
37578
+ type: 'string',
37579
+ },
37548
37580
  limit: {
37549
37581
  default: 500,
37550
37582
  description:
@@ -40214,6 +40246,14 @@ export default {
40214
40246
  type: 'array',
40215
40247
  },
40216
40248
  },
40249
+ {
40250
+ in: 'query',
40251
+ name: 'customer_key',
40252
+ schema: {
40253
+ description: 'Customer key for which you want to list devices.',
40254
+ type: 'string',
40255
+ },
40256
+ },
40217
40257
  {
40218
40258
  in: 'query',
40219
40259
  name: 'connected_account_id',
@@ -40675,6 +40715,11 @@ export default {
40675
40715
  items: { format: 'uuid', type: 'string' },
40676
40716
  type: 'array',
40677
40717
  },
40718
+ customer_key: {
40719
+ description:
40720
+ 'Customer key for which you want to list devices.',
40721
+ type: 'string',
40722
+ },
40678
40723
  device_ids: {
40679
40724
  description:
40680
40725
  'Array of device IDs for which you want to list devices.',
@@ -41505,6 +41550,14 @@ export default {
41505
41550
  type: 'array',
41506
41551
  },
41507
41552
  },
41553
+ {
41554
+ in: 'query',
41555
+ name: 'customer_key',
41556
+ schema: {
41557
+ description: 'Customer key for which you want to list devices.',
41558
+ type: 'string',
41559
+ },
41560
+ },
41508
41561
  {
41509
41562
  in: 'query',
41510
41563
  name: 'connected_account_id',
@@ -41963,6 +42016,11 @@ export default {
41963
42016
  items: { format: 'uuid', type: 'string' },
41964
42017
  type: 'array',
41965
42018
  },
42019
+ customer_key: {
42020
+ description:
42021
+ 'Customer key for which you want to list devices.',
42022
+ type: 'string',
42023
+ },
41966
42024
  device_ids: {
41967
42025
  description:
41968
42026
  'Array of device IDs for which you want to list devices.',
@@ -43862,6 +43920,14 @@ export default {
43862
43920
  type: 'array',
43863
43921
  },
43864
43922
  },
43923
+ {
43924
+ in: 'query',
43925
+ name: 'customer_key',
43926
+ schema: {
43927
+ description: 'Customer key for which you want to list devices.',
43928
+ type: 'string',
43929
+ },
43930
+ },
43865
43931
  {
43866
43932
  in: 'query',
43867
43933
  name: 'connected_account_id',
@@ -44259,6 +44325,11 @@ export default {
44259
44325
  items: { format: 'uuid', type: 'string' },
44260
44326
  type: 'array',
44261
44327
  },
44328
+ customer_key: {
44329
+ description:
44330
+ 'Customer key for which you want to list devices.',
44331
+ type: 'string',
44332
+ },
44262
44333
  device_ids: {
44263
44334
  description:
44264
44335
  'Array of device IDs for which you want to list devices.',
@@ -44771,6 +44842,14 @@ export default {
44771
44842
  type: 'array',
44772
44843
  },
44773
44844
  },
44845
+ {
44846
+ in: 'query',
44847
+ name: 'customer_key',
44848
+ schema: {
44849
+ description: 'Customer key for which you want to list devices.',
44850
+ type: 'string',
44851
+ },
44852
+ },
44774
44853
  {
44775
44854
  in: 'query',
44776
44855
  name: 'connected_account_id',
@@ -45086,6 +45165,11 @@ export default {
45086
45165
  items: { format: 'uuid', type: 'string' },
45087
45166
  type: 'array',
45088
45167
  },
45168
+ customer_key: {
45169
+ description:
45170
+ 'Customer key for which you want to list devices.',
45171
+ type: 'string',
45172
+ },
45089
45173
  device_ids: {
45090
45174
  description:
45091
45175
  'Array of device IDs for which you want to list devices.',
@@ -51548,6 +51632,14 @@ export default {
51548
51632
  type: 'array',
51549
51633
  },
51550
51634
  },
51635
+ {
51636
+ in: 'query',
51637
+ name: 'customer_key',
51638
+ schema: {
51639
+ description: 'Customer key for which you want to list devices.',
51640
+ type: 'string',
51641
+ },
51642
+ },
51551
51643
  {
51552
51644
  in: 'query',
51553
51645
  name: 'connected_account_id',
@@ -51884,6 +51976,11 @@ export default {
51884
51976
  items: { format: 'uuid', type: 'string' },
51885
51977
  type: 'array',
51886
51978
  },
51979
+ customer_key: {
51980
+ description:
51981
+ 'Customer key for which you want to list devices.',
51982
+ type: 'string',
51983
+ },
51887
51984
  device_ids: {
51888
51985
  description:
51889
51986
  'Array of device IDs for which you want to list devices.',
@@ -11224,6 +11224,8 @@ export type Routes = {
11224
11224
  starts_at?: string | undefined
11225
11225
  /** Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
11226
11226
  ends_at?: (string | undefined) | null
11227
+ /** ID of the customization profile to apply to the Access Grant and its access methods. */
11228
+ customization_profile_id?: string | undefined
11227
11229
  }
11228
11230
  formData: {}
11229
11231
  jsonResponse: {
@@ -11269,6 +11271,8 @@ export type Routes = {
11269
11271
  starts_at: string
11270
11272
  /** Date and time at which the Access Grant ends. */
11271
11273
  ends_at: string | null
11274
+ /** ID of the customization profile associated with the Access Grant. */
11275
+ customization_profile_id?: string | undefined
11272
11276
  }
11273
11277
  }
11274
11278
  }
@@ -11342,6 +11346,8 @@ export type Routes = {
11342
11346
  starts_at: string
11343
11347
  /** Date and time at which the Access Grant ends. */
11344
11348
  ends_at: string | null
11349
+ /** ID of the customization profile associated with the Access Grant. */
11350
+ customization_profile_id?: string | undefined
11345
11351
  }
11346
11352
  }
11347
11353
  }
@@ -13514,6 +13520,8 @@ export type Routes = {
13514
13520
  starts_at: string
13515
13521
  /** Date and time at which the Access Grant ends. */
13516
13522
  ends_at: string | null
13523
+ /** ID of the customization profile associated with the Access Grant. */
13524
+ customization_profile_id?: string | undefined
13517
13525
  }[]
13518
13526
  }
13519
13527
  }
@@ -15023,6 +15031,8 @@ export type Routes = {
15023
15031
  is_encoding_required?: boolean | undefined
15024
15032
  /** The actual PIN code for code access methods. */
15025
15033
  code?: string | undefined
15034
+ /** ID of the customization profile associated with the access method. */
15035
+ customization_profile_id?: string | undefined
15026
15036
  }
15027
15037
  }
15028
15038
  }
@@ -19905,6 +19915,8 @@ export type Routes = {
19905
19915
  is_encoding_required?: boolean | undefined
19906
19916
  /** The actual PIN code for code access methods. */
19907
19917
  code?: string | undefined
19918
+ /** ID of the customization profile associated with the access method. */
19919
+ customization_profile_id?: string | undefined
19908
19920
  }[]
19909
19921
  | undefined
19910
19922
  access_grants?:
@@ -19949,6 +19961,8 @@ export type Routes = {
19949
19961
  starts_at: string
19950
19962
  /** Date and time at which the Access Grant ends. */
19951
19963
  ends_at: string | null
19964
+ /** ID of the customization profile associated with the Access Grant. */
19965
+ customization_profile_id?: string | undefined
19952
19966
  }[]
19953
19967
  | undefined
19954
19968
  events?:
@@ -23388,6 +23402,8 @@ export type Routes = {
23388
23402
  is_encoding_required?: boolean | undefined
23389
23403
  /** The actual PIN code for code access methods. */
23390
23404
  code?: string | undefined
23405
+ /** ID of the customization profile associated with the access method. */
23406
+ customization_profile_id?: string | undefined
23391
23407
  }[]
23392
23408
  }
23393
23409
  }
@@ -35200,6 +35216,8 @@ export type Routes = {
35200
35216
  queryParams: {}
35201
35217
  jsonBody: {}
35202
35218
  commonParams: {
35219
+ /** Customer key for which you want to list connect webviews. */
35220
+ customer_key?: string | undefined
35203
35221
  /** Your user ID for the user by which you want to filter Connect Webviews. */
35204
35222
  user_identifier_key?: string | undefined
35205
35223
  /** 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. */
@@ -37975,6 +37993,8 @@ export type Routes = {
37975
37993
  jsonBody: {}
37976
37994
  commonParams: {
37977
37995
  customer_ids?: string[] | undefined
37996
+ /** Customer key for which you want to list devices. */
37997
+ customer_key?: string | undefined
37978
37998
  /** ID of the connected account for which you want to list devices. */
37979
37999
  connected_account_id?: string | undefined
37980
38000
  /** Array of IDs of the connected accounts for which you want to list devices. */
@@ -40317,6 +40337,8 @@ export type Routes = {
40317
40337
  jsonBody: {}
40318
40338
  commonParams: {
40319
40339
  customer_ids?: string[] | undefined
40340
+ /** Customer key for which you want to list devices. */
40341
+ customer_key?: string | undefined
40320
40342
  /** ID of the connected account for which you want to list devices. */
40321
40343
  connected_account_id?: string | undefined
40322
40344
  /** Array of IDs of the connected accounts for which you want to list devices. */
@@ -48679,6 +48701,8 @@ export type Routes = {
48679
48701
  jsonBody: {}
48680
48702
  commonParams: {
48681
48703
  customer_ids?: string[] | undefined
48704
+ /** Customer key for which you want to list devices. */
48705
+ customer_key?: string | undefined
48682
48706
  /** ID of the connected account for which you want to list devices. */
48683
48707
  connected_account_id?: string | undefined
48684
48708
  /** Array of IDs of the connected accounts for which you want to list devices. */
@@ -57565,6 +57589,8 @@ export type Routes = {
57565
57589
  jsonBody: {}
57566
57590
  commonParams: {
57567
57591
  customer_ids?: string[] | undefined
57592
+ /** Customer key for which you want to list devices. */
57593
+ customer_key?: string | undefined
57568
57594
  /** ID of the connected account for which you want to list devices. */
57569
57595
  connected_account_id?: string | undefined
57570
57596
  /** Array of IDs of the connected accounts for which you want to list devices. */
@@ -79929,6 +79955,8 @@ export type Routes = {
79929
79955
  jsonBody: {}
79930
79956
  commonParams: {
79931
79957
  customer_ids?: string[] | undefined
79958
+ /** Customer key for which you want to list devices. */
79959
+ customer_key?: string | undefined
79932
79960
  /** ID of the connected account for which you want to list devices. */
79933
79961
  connected_account_id?: string | undefined
79934
79962
  /** Array of IDs of the connected accounts for which you want to list devices. */
@@ -98257,6 +98285,8 @@ export type Routes = {
98257
98285
  is_encoding_required?: boolean | undefined
98258
98286
  /** The actual PIN code for code access methods. */
98259
98287
  code?: string | undefined
98288
+ /** ID of the customization profile associated with the access method. */
98289
+ customization_profile_id?: string | undefined
98260
98290
  }[]
98261
98291
  | undefined
98262
98292
  access_grants?:
@@ -98301,6 +98331,8 @@ export type Routes = {
98301
98331
  starts_at: string
98302
98332
  /** Date and time at which the Access Grant ends. */
98303
98333
  ends_at: string | null
98334
+ /** ID of the customization profile associated with the Access Grant. */
98335
+ customization_profile_id?: string | undefined
98304
98336
  }[]
98305
98337
  | undefined
98306
98338
  events?: