@seamapi/types 1.529.0 → 1.531.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.
@@ -17022,6 +17022,10 @@ export type Routes = {
17022
17022
  })[];
17023
17023
  /** Date and time at which the device object was created. */
17024
17024
  created_at: string;
17025
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
17026
+ custom_metadata: {
17027
+ [x: string]: string | boolean;
17028
+ };
17025
17029
  is_managed: false;
17026
17030
  /** properties of the device. */
17027
17031
  properties: {
@@ -34095,6 +34099,18 @@ export type Routes = {
34095
34099
  formData: {};
34096
34100
  jsonResponse: {};
34097
34101
  };
34102
+ '/devices/simulate/paid_subscription': {
34103
+ route: '/devices/simulate/paid_subscription';
34104
+ method: 'POST';
34105
+ queryParams: {};
34106
+ jsonBody: {
34107
+ device_id: string;
34108
+ is_expired: boolean;
34109
+ };
34110
+ commonParams: {};
34111
+ formData: {};
34112
+ jsonResponse: {};
34113
+ };
34098
34114
  '/devices/simulate/remove': {
34099
34115
  route: '/devices/simulate/remove';
34100
34116
  method: 'POST';
@@ -34420,6 +34436,10 @@ export type Routes = {
34420
34436
  })[];
34421
34437
  /** Date and time at which the device object was created. */
34422
34438
  created_at: string;
34439
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
34440
+ custom_metadata: {
34441
+ [x: string]: string | boolean;
34442
+ };
34423
34443
  is_managed: false;
34424
34444
  /** properties of the device. */
34425
34445
  properties: {
@@ -34859,6 +34879,10 @@ export type Routes = {
34859
34879
  })[];
34860
34880
  /** Date and time at which the device object was created. */
34861
34881
  created_at: string;
34882
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
34883
+ custom_metadata: {
34884
+ [x: string]: string | boolean;
34885
+ };
34862
34886
  is_managed: false;
34863
34887
  /** properties of the device. */
34864
34888
  properties: {
@@ -34958,7 +34982,11 @@ export type Routes = {
34958
34982
  /** ID of the unmanaged device that you want to update. */
34959
34983
  device_id: string;
34960
34984
  /** Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed. */
34961
- is_managed: true;
34985
+ is_managed?: true | undefined;
34986
+ /** Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. */
34987
+ custom_metadata?: {
34988
+ [x: string]: string | boolean | null;
34989
+ } | undefined;
34962
34990
  };
34963
34991
  formData: {};
34964
34992
  jsonResponse: {};
@@ -82776,6 +82804,10 @@ export type Routes = {
82776
82804
  })[];
82777
82805
  /** Date and time at which the device object was created. */
82778
82806
  created_at: string;
82807
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
82808
+ custom_metadata: {
82809
+ [x: string]: string | boolean;
82810
+ };
82779
82811
  is_managed: false;
82780
82812
  /** properties of the device. */
82781
82813
  properties: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.529.0",
3
+ "version": "1.531.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -17,6 +17,7 @@ export const unmanaged_device = device
17
17
  errors: true,
18
18
  warnings: true,
19
19
  created_at: true,
20
+ custom_metadata: true,
20
21
  })
21
22
  .extend({
22
23
  is_managed: z.literal(false),
@@ -23704,6 +23704,14 @@ export default {
23704
23704
  format: 'date-time',
23705
23705
  type: 'string',
23706
23706
  },
23707
+ custom_metadata: {
23708
+ additionalProperties: {
23709
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
23710
+ },
23711
+ description:
23712
+ 'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
23713
+ type: 'object',
23714
+ },
23707
23715
  device_id: {
23708
23716
  description: 'ID of the device.',
23709
23717
  format: 'uuid',
@@ -25022,6 +25030,7 @@ export default {
25022
25030
  'errors',
25023
25031
  'warnings',
25024
25032
  'created_at',
25033
+ 'custom_metadata',
25025
25034
  'is_managed',
25026
25035
  'properties',
25027
25036
  ],
@@ -41530,6 +41539,55 @@ export default {
41530
41539
  'x-title': 'Simulate Hub Disconnection',
41531
41540
  },
41532
41541
  },
41542
+ '/devices/simulate/paid_subscription': {
41543
+ post: {
41544
+ description:
41545
+ 'Toggle the simulated Nuki Smart Hosting subscription for a device (sandbox only).\nSend `is_expired: true` to simulate an expired subscription, or `false` to simulate an active subscription.\nThe actual device error is created/cleared by the poller after this state change.',
41546
+ operationId: 'devicesSimulatePaidSubscriptionPost',
41547
+ requestBody: {
41548
+ content: {
41549
+ 'application/json': {
41550
+ schema: {
41551
+ properties: {
41552
+ device_id: { format: 'uuid', type: 'string' },
41553
+ is_expired: { type: 'boolean' },
41554
+ },
41555
+ required: ['device_id', 'is_expired'],
41556
+ type: 'object',
41557
+ },
41558
+ },
41559
+ },
41560
+ },
41561
+ responses: {
41562
+ 200: {
41563
+ content: {
41564
+ 'application/json': {
41565
+ schema: {
41566
+ properties: { ok: { type: 'boolean' } },
41567
+ required: ['ok'],
41568
+ type: 'object',
41569
+ },
41570
+ },
41571
+ },
41572
+ description: 'OK',
41573
+ },
41574
+ 400: { description: 'Bad Request' },
41575
+ 401: { description: 'Unauthorized' },
41576
+ },
41577
+ security: [
41578
+ { api_key: [] },
41579
+ { pat_with_workspace: [] },
41580
+ { console_session_with_workspace: [] },
41581
+ { client_session_with_customer: [] },
41582
+ ],
41583
+ summary: '/devices/simulate/paid_subscription',
41584
+ tags: ['/devices'],
41585
+ 'x-fern-sdk-group-name': ['devices', 'simulate'],
41586
+ 'x-fern-sdk-method-name': 'paid_subscription',
41587
+ 'x-response-key': null,
41588
+ 'x-title': 'Simulate Paid Subscription',
41589
+ },
41590
+ },
41533
41591
  '/devices/simulate/remove': {
41534
41592
  post: {
41535
41593
  description:
@@ -42496,6 +42554,18 @@ export default {
42496
42554
  'application/json': {
42497
42555
  schema: {
42498
42556
  properties: {
42557
+ custom_metadata: {
42558
+ additionalProperties: {
42559
+ nullable: true,
42560
+ oneOf: [
42561
+ { maxLength: 500, type: 'string' },
42562
+ { type: 'boolean' },
42563
+ ],
42564
+ },
42565
+ description:
42566
+ 'Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.',
42567
+ type: 'object',
42568
+ },
42499
42569
  device_id: {
42500
42570
  description:
42501
42571
  'ID of the unmanaged device that you want to update.',
@@ -42509,7 +42579,7 @@ export default {
42509
42579
  type: 'boolean',
42510
42580
  },
42511
42581
  },
42512
- required: ['device_id', 'is_managed'],
42582
+ required: ['device_id'],
42513
42583
  type: 'object',
42514
42584
  },
42515
42585
  },
@@ -42552,6 +42622,18 @@ export default {
42552
42622
  'application/json': {
42553
42623
  schema: {
42554
42624
  properties: {
42625
+ custom_metadata: {
42626
+ additionalProperties: {
42627
+ nullable: true,
42628
+ oneOf: [
42629
+ { maxLength: 500, type: 'string' },
42630
+ { type: 'boolean' },
42631
+ ],
42632
+ },
42633
+ description:
42634
+ 'Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.',
42635
+ type: 'object',
42636
+ },
42555
42637
  device_id: {
42556
42638
  description:
42557
42639
  'ID of the unmanaged device that you want to update.',
@@ -42565,7 +42647,7 @@ export default {
42565
42647
  type: 'boolean',
42566
42648
  },
42567
42649
  },
42568
- required: ['device_id', 'is_managed'],
42650
+ required: ['device_id'],
42569
42651
  type: 'object',
42570
42652
  },
42571
42653
  },
@@ -19785,6 +19785,10 @@ export type Routes = {
19785
19785
  )[]
19786
19786
  /** Date and time at which the device object was created. */
19787
19787
  created_at: string
19788
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
19789
+ custom_metadata: {
19790
+ [x: string]: string | boolean
19791
+ }
19788
19792
  is_managed: false
19789
19793
  /** properties of the device. */
19790
19794
  properties: {
@@ -39955,6 +39959,18 @@ export type Routes = {
39955
39959
  formData: {}
39956
39960
  jsonResponse: {}
39957
39961
  }
39962
+ '/devices/simulate/paid_subscription': {
39963
+ route: '/devices/simulate/paid_subscription'
39964
+ method: 'POST'
39965
+ queryParams: {}
39966
+ jsonBody: {
39967
+ device_id: string
39968
+ is_expired: boolean
39969
+ }
39970
+ commonParams: {}
39971
+ formData: {}
39972
+ jsonResponse: {}
39973
+ }
39958
39974
  '/devices/simulate/remove': {
39959
39975
  route: '/devices/simulate/remove'
39960
39976
  method: 'POST'
@@ -40361,6 +40377,10 @@ export type Routes = {
40361
40377
  )[]
40362
40378
  /** Date and time at which the device object was created. */
40363
40379
  created_at: string
40380
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
40381
+ custom_metadata: {
40382
+ [x: string]: string | boolean
40383
+ }
40364
40384
  is_managed: false
40365
40385
  /** properties of the device. */
40366
40386
  properties: {
@@ -41054,6 +41074,10 @@ export type Routes = {
41054
41074
  )[]
41055
41075
  /** Date and time at which the device object was created. */
41056
41076
  created_at: string
41077
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
41078
+ custom_metadata: {
41079
+ [x: string]: string | boolean
41080
+ }
41057
41081
  is_managed: false
41058
41082
  /** properties of the device. */
41059
41083
  properties: {
@@ -41159,7 +41183,13 @@ export type Routes = {
41159
41183
  /** ID of the unmanaged device that you want to update. */
41160
41184
  device_id: string
41161
41185
  /** Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed. */
41162
- is_managed: true
41186
+ is_managed?: true | undefined
41187
+ /** Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. */
41188
+ custom_metadata?:
41189
+ | {
41190
+ [x: string]: string | boolean | null
41191
+ }
41192
+ | undefined
41163
41193
  }
41164
41194
  formData: {}
41165
41195
  jsonResponse: {}
@@ -98516,6 +98546,10 @@ export type Routes = {
98516
98546
  )[]
98517
98547
  /** Date and time at which the device object was created. */
98518
98548
  created_at: string
98549
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
98550
+ custom_metadata: {
98551
+ [x: string]: string | boolean
98552
+ }
98519
98553
  is_managed: false
98520
98554
  /** properties of the device. */
98521
98555
  properties: {