@seamapi/types 1.421.1 → 1.422.1

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 (55) hide show
  1. package/dist/connect.cjs +1638 -591
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +2655 -1028
  4. package/lib/seam/connect/internal/schemas.d.ts +1 -1
  5. package/lib/seam/connect/internal/schemas.js +1 -1
  6. package/lib/seam/connect/internal/schemas.js.map +1 -1
  7. package/lib/seam/connect/models/customer/access-grant-resources.d.ts +420 -0
  8. package/lib/seam/connect/models/customer/access-grant-resources.js +111 -0
  9. package/lib/seam/connect/models/customer/access-grant-resources.js.map +1 -0
  10. package/lib/seam/connect/models/customer/business-vertical.d.ts +3 -0
  11. package/lib/seam/connect/models/customer/business-vertical.js +11 -0
  12. package/lib/seam/connect/models/customer/business-vertical.js.map +1 -0
  13. package/lib/seam/connect/models/customer/customer-data.d.ts +597 -0
  14. package/lib/seam/connect/models/customer/customer-data.js +67 -0
  15. package/lib/seam/connect/models/customer/customer-data.js.map +1 -0
  16. package/lib/seam/connect/models/customer/customer-portal.d.ts +71 -0
  17. package/lib/seam/connect/models/customer/customer-portal.js +34 -0
  18. package/lib/seam/connect/models/customer/customer-portal.js.map +1 -0
  19. package/lib/seam/connect/models/customer/index.d.ts +3 -0
  20. package/lib/seam/connect/models/customer/index.js +4 -0
  21. package/lib/seam/connect/models/customer/index.js.map +1 -0
  22. package/lib/seam/connect/models/customer/location-resources.d.ts +229 -0
  23. package/lib/seam/connect/models/customer/location-resources.js +55 -0
  24. package/lib/seam/connect/models/customer/location-resources.js.map +1 -0
  25. package/lib/seam/connect/models/customer/user-identity-resources.d.ts +205 -0
  26. package/lib/seam/connect/models/customer/user-identity-resources.js +50 -0
  27. package/lib/seam/connect/models/customer/user-identity-resources.js.map +1 -0
  28. package/lib/seam/connect/models/index.d.ts +4 -0
  29. package/lib/seam/connect/models/index.js +4 -0
  30. package/lib/seam/connect/models/index.js.map +1 -1
  31. package/lib/seam/connect/models/partner/index.d.ts +0 -1
  32. package/lib/seam/connect/models/partner/index.js +0 -1
  33. package/lib/seam/connect/models/partner/index.js.map +1 -1
  34. package/lib/seam/connect/models/partner/magic-link.d.ts +2 -2
  35. package/lib/seam/connect/openapi.d.ts +1821 -658
  36. package/lib/seam/connect/openapi.js +1647 -600
  37. package/lib/seam/connect/openapi.js.map +1 -1
  38. package/lib/seam/connect/route-types.d.ts +580 -116
  39. package/package.json +2 -2
  40. package/src/lib/seam/connect/internal/schemas.ts +21 -3
  41. package/src/lib/seam/connect/models/customer/access-grant-resources.ts +129 -0
  42. package/src/lib/seam/connect/models/customer/business-vertical.ts +13 -0
  43. package/src/lib/seam/connect/models/customer/customer-data.ts +93 -0
  44. package/src/lib/seam/connect/models/customer/customer-portal.ts +39 -0
  45. package/src/lib/seam/connect/models/customer/index.ts +3 -0
  46. package/src/lib/seam/connect/models/customer/location-resources.ts +77 -0
  47. package/src/lib/seam/connect/models/customer/user-identity-resources.ts +68 -0
  48. package/src/lib/seam/connect/models/index.ts +4 -0
  49. package/src/lib/seam/connect/models/partner/index.ts +0 -1
  50. package/src/lib/seam/connect/openapi.ts +1802 -609
  51. package/src/lib/seam/connect/route-types.ts +670 -118
  52. package/lib/seam/connect/models/partner/resources.d.ts +0 -76
  53. package/lib/seam/connect/models/partner/resources.js +0 -87
  54. package/lib/seam/connect/models/partner/resources.js.map +0 -1
  55. package/src/lib/seam/connect/models/partner/resources.ts +0 -112
@@ -16412,69 +16412,6 @@ export default {
16412
16412
  required: ['next_page_cursor', 'has_next_page', 'next_page_url'],
16413
16413
  type: 'object',
16414
16414
  },
16415
- partner_resource: {
16416
- description: 'Represents a partner resource that enables you to send your user identity and access grant resources to Seam.',
16417
- properties: {
16418
- custom_metadata: {
16419
- additionalProperties: { type: 'string' },
16420
- description: 'Custom metadata associated with the partner resource.',
16421
- type: 'object',
16422
- },
16423
- customer_key: {
16424
- description: 'Customer key associated with the partner resource.',
16425
- type: 'string',
16426
- },
16427
- description: {
16428
- description: 'Description of the partner resource.',
16429
- type: 'string',
16430
- },
16431
- email_address: {
16432
- description: 'Email address associated with the user identity partner resource.',
16433
- type: 'string',
16434
- },
16435
- ends_at: {
16436
- description: 'Ending date and time associated with the access grant partner resource.',
16437
- type: 'string',
16438
- },
16439
- location_keys: {
16440
- description: 'Location keys associated with the access grant partner resource.',
16441
- items: { type: 'string' },
16442
- type: 'array',
16443
- },
16444
- name: {
16445
- description: 'Name of the partner resource.',
16446
- type: 'string',
16447
- },
16448
- partner_resource_key: {
16449
- description: 'Key of the partner resource.',
16450
- type: 'string',
16451
- },
16452
- partner_resource_type: {
16453
- description: 'Type of the partner resource.',
16454
- type: 'string',
16455
- },
16456
- phone_number: {
16457
- description: 'Phone number associated with the user identity partner resource.',
16458
- type: 'string',
16459
- },
16460
- starts_at: {
16461
- description: 'Starting date and time associated with the access grant partner resource.',
16462
- type: 'string',
16463
- },
16464
- user_identity_key: {
16465
- description: 'User identity key associated with the access grant partner resource.',
16466
- type: 'string',
16467
- },
16468
- },
16469
- required: [
16470
- 'partner_resource_type',
16471
- 'partner_resource_key',
16472
- 'customer_key',
16473
- ],
16474
- type: 'object',
16475
- 'x-route-path': '/unstable_partner/resources',
16476
- 'x-undocumented': 'Unreleased.',
16477
- },
16478
16415
  phone: {
16479
16416
  description: "Represents an app user's mobile phone.",
16480
16417
  properties: {
@@ -21632,7 +21569,7 @@ export default {
21632
21569
  type: 'string',
21633
21570
  },
21634
21571
  name: {
21635
- description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
21572
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
21636
21573
  type: 'string',
21637
21574
  },
21638
21575
  prefer_native_scheduling: {
@@ -21762,7 +21699,7 @@ export default {
21762
21699
  type: 'string',
21763
21700
  },
21764
21701
  name: {
21765
- description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
21702
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
21766
21703
  type: 'string',
21767
21704
  },
21768
21705
  prefer_native_scheduling: {
@@ -21883,7 +21820,7 @@ export default {
21883
21820
  type: 'string',
21884
21821
  },
21885
21822
  name: {
21886
- description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
21823
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
21887
21824
  type: 'string',
21888
21825
  },
21889
21826
  prefer_native_scheduling: {
@@ -23399,7 +23336,7 @@ export default {
23399
23336
  type: 'string',
23400
23337
  },
23401
23338
  name: {
23402
- description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23339
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23403
23340
  type: 'string',
23404
23341
  },
23405
23342
  prefer_native_scheduling: {
@@ -23533,7 +23470,7 @@ export default {
23533
23470
  type: 'string',
23534
23471
  },
23535
23472
  name: {
23536
- description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23473
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23537
23474
  type: 'string',
23538
23475
  },
23539
23476
  prefer_native_scheduling: {
@@ -23667,7 +23604,7 @@ export default {
23667
23604
  type: 'string',
23668
23605
  },
23669
23606
  name: {
23670
- description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23607
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23671
23608
  type: 'string',
23672
23609
  },
23673
23610
  prefer_native_scheduling: {
@@ -23760,7 +23697,7 @@ export default {
23760
23697
  type: 'string',
23761
23698
  },
23762
23699
  name: {
23763
- description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23700
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23764
23701
  type: 'string',
23765
23702
  },
23766
23703
  starts_at: {
@@ -23820,7 +23757,7 @@ export default {
23820
23757
  type: 'string',
23821
23758
  },
23822
23759
  name: {
23823
- description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23760
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23824
23761
  type: 'string',
23825
23762
  },
23826
23763
  starts_at: {
@@ -32779,198 +32716,1428 @@ export default {
32779
32716
  'x-title': 'Update a Connected Account',
32780
32717
  },
32781
32718
  },
32782
- '/devices/delete': {
32783
- delete: {
32784
- description: 'Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).',
32785
- operationId: 'devicesDeleteDelete',
32786
- parameters: [
32787
- {
32788
- in: 'query',
32789
- name: 'device_id',
32790
- required: true,
32791
- schema: {
32792
- description: 'ID of the device that you want to delete.',
32793
- format: 'uuid',
32794
- type: 'string',
32795
- },
32796
- },
32797
- ],
32798
- responses: {
32799
- 200: {
32800
- content: {
32801
- 'application/json': {
32802
- schema: {
32803
- properties: { ok: { type: 'boolean' } },
32804
- required: ['ok'],
32805
- type: 'object',
32806
- },
32807
- },
32808
- },
32809
- description: 'OK',
32810
- },
32811
- 400: { description: 'Bad Request' },
32812
- 401: { description: 'Unauthorized' },
32813
- },
32814
- security: [
32815
- { api_key: [] },
32816
- { pat_with_workspace: [] },
32817
- { console_session_with_workspace: [] },
32818
- ],
32819
- summary: '/devices/delete',
32820
- tags: ['/devices'],
32821
- 'x-deprecated': 'Deleting a device is no longer supported and will be removed.',
32822
- 'x-fern-sdk-group-name': ['devices'],
32823
- 'x-fern-sdk-method-name': 'delete',
32824
- 'x-response-key': null,
32825
- 'x-title': 'Delete a Device',
32826
- 'x-undocumented': 'Deleting a device is no longer supported and will be removed.',
32827
- },
32828
- post: {
32829
- description: 'Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).',
32830
- operationId: 'devicesDeletePost',
32831
- requestBody: {
32832
- content: {
32833
- 'application/json': {
32834
- schema: {
32835
- properties: {
32836
- device_id: {
32837
- description: 'ID of the device that you want to delete.',
32838
- format: 'uuid',
32839
- type: 'string',
32840
- },
32841
- },
32842
- required: ['device_id'],
32843
- type: 'object',
32844
- },
32845
- },
32846
- },
32847
- },
32848
- responses: {
32849
- 200: {
32850
- content: {
32851
- 'application/json': {
32852
- schema: {
32853
- properties: { ok: { type: 'boolean' } },
32854
- required: ['ok'],
32855
- type: 'object',
32856
- },
32857
- },
32858
- },
32859
- description: 'OK',
32860
- },
32861
- 400: { description: 'Bad Request' },
32862
- 401: { description: 'Unauthorized' },
32863
- },
32864
- security: [
32865
- { api_key: [] },
32866
- { pat_with_workspace: [] },
32867
- { console_session_with_workspace: [] },
32868
- ],
32869
- summary: '/devices/delete',
32870
- tags: ['/devices'],
32871
- 'x-deprecated': 'Deleting a device is no longer supported and will be removed.',
32872
- 'x-fern-sdk-group-name': ['devices'],
32873
- 'x-fern-sdk-method-name': 'delete',
32874
- 'x-response-key': null,
32875
- 'x-title': 'Delete a Device',
32876
- 'x-undocumented': 'Deleting a device is no longer supported and will be removed.',
32877
- },
32878
- },
32879
- '/devices/get': {
32880
- get: {
32881
- description: 'Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.',
32882
- operationId: 'devicesGetGet',
32883
- parameters: [
32884
- {
32885
- in: 'query',
32886
- name: 'device_id',
32887
- schema: {
32888
- description: 'ID of the device that you want to get.',
32889
- format: 'uuid',
32890
- type: 'string',
32891
- },
32892
- },
32893
- {
32894
- in: 'query',
32895
- name: 'name',
32896
- schema: {
32897
- description: 'Name of the device that you want to get.',
32898
- type: 'string',
32899
- },
32900
- },
32901
- ],
32902
- responses: {
32903
- 200: {
32904
- content: {
32905
- 'application/json': {
32906
- schema: {
32907
- properties: {
32908
- device: { $ref: '#/components/schemas/device' },
32909
- ok: { type: 'boolean' },
32910
- },
32911
- required: ['device', 'ok'],
32912
- type: 'object',
32913
- },
32914
- },
32915
- },
32916
- description: 'OK',
32917
- },
32918
- 400: { description: 'Bad Request' },
32919
- 401: { description: 'Unauthorized' },
32920
- },
32921
- security: [
32922
- { client_session: [] },
32923
- { client_session_with_customer: [] },
32924
- { pat_with_workspace: [] },
32925
- { console_session_with_workspace: [] },
32926
- { api_key: [] },
32927
- ],
32928
- summary: '/devices/get',
32929
- tags: ['/devices'],
32930
- 'x-fern-sdk-group-name': ['devices'],
32931
- 'x-fern-sdk-method-name': 'get',
32932
- 'x-fern-sdk-return-value': 'device',
32933
- 'x-response-key': 'device',
32934
- 'x-title': 'Get a Device',
32935
- },
32719
+ '/customers/create_portal': {
32936
32720
  post: {
32937
- description: 'Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.',
32938
- operationId: 'devicesGetPost',
32721
+ description: 'Creates a new customer portal magic link with configurable features.',
32722
+ operationId: 'customersCreatePortalPost',
32939
32723
  requestBody: {
32940
32724
  content: {
32941
32725
  'application/json': {
32942
32726
  schema: {
32943
- properties: {
32944
- device_id: {
32945
- description: 'ID of the device that you want to get.',
32946
- format: 'uuid',
32947
- type: 'string',
32948
- },
32949
- name: {
32950
- description: 'Name of the device that you want to get.',
32951
- type: 'string',
32952
- },
32953
- },
32954
- type: 'object',
32955
- },
32956
- },
32957
- },
32958
- },
32959
- responses: {
32960
- 200: {
32961
- content: {
32962
- 'application/json': {
32963
- schema: {
32964
- properties: {
32965
- device: { $ref: '#/components/schemas/device' },
32966
- ok: { type: 'boolean' },
32727
+ allOf: [
32728
+ {
32729
+ default: {
32730
+ features: {
32731
+ connect: { exclude: false },
32732
+ manage_devices: { exclude: false },
32733
+ organize: { exclude: false },
32734
+ },
32735
+ },
32736
+ description: 'Configuration for a customer portal',
32737
+ properties: {
32738
+ features: {
32739
+ default: {},
32740
+ properties: {
32741
+ connect: {
32742
+ default: {},
32743
+ description: 'Configuration for the connect accounts feature.',
32744
+ properties: {
32745
+ exclude: {
32746
+ default: false,
32747
+ description: 'Whether to exclude this feature from the portal.',
32748
+ type: 'boolean',
32749
+ },
32750
+ },
32751
+ type: 'object',
32752
+ },
32753
+ manage_devices: {
32754
+ default: {},
32755
+ description: 'Configuration for the manage devices feature.',
32756
+ properties: {
32757
+ exclude: {
32758
+ default: false,
32759
+ description: 'Whether to exclude this feature from the portal.',
32760
+ type: 'boolean',
32761
+ },
32762
+ },
32763
+ type: 'object',
32764
+ },
32765
+ organize: {
32766
+ default: {},
32767
+ description: 'Configuration for the organize feature.',
32768
+ properties: {
32769
+ exclude: {
32770
+ default: false,
32771
+ description: 'Whether to exclude this feature from the portal.',
32772
+ type: 'boolean',
32773
+ },
32774
+ },
32775
+ type: 'object',
32776
+ },
32777
+ },
32778
+ type: 'object',
32779
+ },
32780
+ },
32781
+ type: 'object',
32967
32782
  },
32968
- required: ['device', 'ok'],
32969
- type: 'object',
32970
- },
32971
- },
32972
- },
32973
- description: 'OK',
32783
+ {
32784
+ properties: {
32785
+ customer_data: {
32786
+ properties: {
32787
+ access_grants: {
32788
+ description: 'List of access grants.',
32789
+ items: {
32790
+ properties: {
32791
+ access_grant_key: {
32792
+ description: 'Your unique identifier for the access grant.',
32793
+ type: 'string',
32794
+ },
32795
+ building_keys: {
32796
+ description: 'Building keys associated with the access grant.',
32797
+ items: { type: 'string' },
32798
+ type: 'array',
32799
+ },
32800
+ common_area_keys: {
32801
+ description: 'Common area keys associated with the access grant.',
32802
+ items: { type: 'string' },
32803
+ type: 'array',
32804
+ },
32805
+ ends_at: {
32806
+ description: 'Ending date and time for the access grant.',
32807
+ type: 'string',
32808
+ },
32809
+ facility_keys: {
32810
+ description: 'Facility keys associated with the access grant.',
32811
+ items: { type: 'string' },
32812
+ type: 'array',
32813
+ },
32814
+ guest_key: {
32815
+ description: 'Guest key associated with the access grant.',
32816
+ type: 'string',
32817
+ },
32818
+ listing_keys: {
32819
+ description: 'Listing keys associated with the access grant.',
32820
+ items: { type: 'string' },
32821
+ type: 'array',
32822
+ },
32823
+ name: {
32824
+ description: 'Your display name for this access grant resource.',
32825
+ type: 'string',
32826
+ },
32827
+ property_keys: {
32828
+ description: 'Property keys associated with the access grant.',
32829
+ items: { type: 'string' },
32830
+ type: 'array',
32831
+ },
32832
+ resident_key: {
32833
+ description: 'Resident key associated with the access grant.',
32834
+ type: 'string',
32835
+ },
32836
+ room_keys: {
32837
+ description: 'Room keys associated with the access grant.',
32838
+ items: { type: 'string' },
32839
+ type: 'array',
32840
+ },
32841
+ space_keys: {
32842
+ description: 'Space keys associated with the access grant.',
32843
+ items: { type: 'string' },
32844
+ type: 'array',
32845
+ },
32846
+ starts_at: {
32847
+ description: 'Starting date and time for the access grant.',
32848
+ type: 'string',
32849
+ },
32850
+ tenant_key: {
32851
+ description: 'Tenant key associated with the access grant.',
32852
+ type: 'string',
32853
+ },
32854
+ unit_keys: {
32855
+ description: 'Unit keys associated with the access grant.',
32856
+ items: { type: 'string' },
32857
+ type: 'array',
32858
+ },
32859
+ user_identity_key: {
32860
+ description: 'User identity key associated with the access grant.',
32861
+ type: 'string',
32862
+ },
32863
+ user_key: {
32864
+ description: 'User key associated with the access grant.',
32865
+ type: 'string',
32866
+ },
32867
+ },
32868
+ required: ['name', 'access_grant_key'],
32869
+ type: 'object',
32870
+ },
32871
+ type: 'array',
32872
+ },
32873
+ bookings: {
32874
+ description: 'List of bookings.',
32875
+ items: {
32876
+ properties: {
32877
+ booking_key: {
32878
+ description: 'Your unique identifier for the booking.',
32879
+ type: 'string',
32880
+ },
32881
+ building_keys: {
32882
+ description: 'Building keys associated with the access grant.',
32883
+ items: { type: 'string' },
32884
+ type: 'array',
32885
+ },
32886
+ common_area_keys: {
32887
+ description: 'Common area keys associated with the access grant.',
32888
+ items: { type: 'string' },
32889
+ type: 'array',
32890
+ },
32891
+ ends_at: {
32892
+ description: 'Ending date and time for the access grant.',
32893
+ type: 'string',
32894
+ },
32895
+ facility_keys: {
32896
+ description: 'Facility keys associated with the access grant.',
32897
+ items: { type: 'string' },
32898
+ type: 'array',
32899
+ },
32900
+ guest_key: {
32901
+ description: 'Guest key associated with the access grant.',
32902
+ type: 'string',
32903
+ },
32904
+ listing_keys: {
32905
+ description: 'Listing keys associated with the access grant.',
32906
+ items: { type: 'string' },
32907
+ type: 'array',
32908
+ },
32909
+ name: {
32910
+ description: 'Your display name for this access grant resource.',
32911
+ type: 'string',
32912
+ },
32913
+ property_keys: {
32914
+ description: 'Property keys associated with the access grant.',
32915
+ items: { type: 'string' },
32916
+ type: 'array',
32917
+ },
32918
+ resident_key: {
32919
+ description: 'Resident key associated with the access grant.',
32920
+ type: 'string',
32921
+ },
32922
+ room_keys: {
32923
+ description: 'Room keys associated with the access grant.',
32924
+ items: { type: 'string' },
32925
+ type: 'array',
32926
+ },
32927
+ space_keys: {
32928
+ description: 'Space keys associated with the access grant.',
32929
+ items: { type: 'string' },
32930
+ type: 'array',
32931
+ },
32932
+ starts_at: {
32933
+ description: 'Starting date and time for the access grant.',
32934
+ type: 'string',
32935
+ },
32936
+ tenant_key: {
32937
+ description: 'Tenant key associated with the access grant.',
32938
+ type: 'string',
32939
+ },
32940
+ unit_keys: {
32941
+ description: 'Unit keys associated with the access grant.',
32942
+ items: { type: 'string' },
32943
+ type: 'array',
32944
+ },
32945
+ user_identity_key: {
32946
+ description: 'User identity key associated with the access grant.',
32947
+ type: 'string',
32948
+ },
32949
+ user_key: {
32950
+ description: 'User key associated with the access grant.',
32951
+ type: 'string',
32952
+ },
32953
+ },
32954
+ required: ['name', 'booking_key'],
32955
+ type: 'object',
32956
+ },
32957
+ type: 'array',
32958
+ },
32959
+ buildings: {
32960
+ description: 'List of buildings.',
32961
+ items: {
32962
+ properties: {
32963
+ building_key: {
32964
+ description: 'Your unique identifier for the building.',
32965
+ type: 'string',
32966
+ },
32967
+ name: {
32968
+ description: 'Your display name for this location resource.',
32969
+ type: 'string',
32970
+ },
32971
+ },
32972
+ required: ['name', 'building_key'],
32973
+ type: 'object',
32974
+ },
32975
+ type: 'array',
32976
+ },
32977
+ common_areas: {
32978
+ description: 'List of shared common areas.',
32979
+ items: {
32980
+ properties: {
32981
+ common_area_key: {
32982
+ description: 'Your unique identifier for the common area.',
32983
+ type: 'string',
32984
+ },
32985
+ name: {
32986
+ description: 'Your display name for this location resource.',
32987
+ type: 'string',
32988
+ },
32989
+ },
32990
+ required: ['name', 'common_area_key'],
32991
+ type: 'object',
32992
+ },
32993
+ type: 'array',
32994
+ },
32995
+ customer_key: {
32996
+ description: 'Your unique identifier for the customer.',
32997
+ type: 'string',
32998
+ },
32999
+ facilities: {
33000
+ description: 'List of gym or fitness facilities.',
33001
+ items: {
33002
+ properties: {
33003
+ facility_key: {
33004
+ description: 'Your unique identifier for the facility.',
33005
+ type: 'string',
33006
+ },
33007
+ name: {
33008
+ description: 'Your display name for this location resource.',
33009
+ type: 'string',
33010
+ },
33011
+ },
33012
+ required: ['name', 'facility_key'],
33013
+ type: 'object',
33014
+ },
33015
+ type: 'array',
33016
+ },
33017
+ guests: {
33018
+ description: 'List of guests.',
33019
+ items: {
33020
+ properties: {
33021
+ email_address: {
33022
+ description: 'Email address associated with the user identity.',
33023
+ type: 'string',
33024
+ },
33025
+ guest_key: {
33026
+ description: 'Your unique identifier for the guest.',
33027
+ type: 'string',
33028
+ },
33029
+ name: {
33030
+ description: 'Your display name for this user identity resource.',
33031
+ type: 'string',
33032
+ },
33033
+ phone_number: {
33034
+ description: 'Phone number associated with the user identity.',
33035
+ type: 'string',
33036
+ },
33037
+ },
33038
+ required: ['name', 'guest_key'],
33039
+ type: 'object',
33040
+ },
33041
+ type: 'array',
33042
+ },
33043
+ listings: {
33044
+ description: 'List of property listings.',
33045
+ items: {
33046
+ properties: {
33047
+ listing_key: {
33048
+ description: 'Your unique identifier for the listing.',
33049
+ type: 'string',
33050
+ },
33051
+ name: {
33052
+ description: 'Your display name for this location resource.',
33053
+ type: 'string',
33054
+ },
33055
+ },
33056
+ required: ['name', 'listing_key'],
33057
+ type: 'object',
33058
+ },
33059
+ type: 'array',
33060
+ },
33061
+ properties: {
33062
+ description: 'List of short-term rental properties.',
33063
+ items: {
33064
+ properties: {
33065
+ name: {
33066
+ description: 'Your display name for this location resource.',
33067
+ type: 'string',
33068
+ },
33069
+ property_key: {
33070
+ description: 'Your unique identifier for the property.',
33071
+ type: 'string',
33072
+ },
33073
+ },
33074
+ required: ['name', 'property_key'],
33075
+ type: 'object',
33076
+ },
33077
+ type: 'array',
33078
+ },
33079
+ reservations: {
33080
+ description: 'List of reservations.',
33081
+ items: {
33082
+ properties: {
33083
+ building_keys: {
33084
+ description: 'Building keys associated with the access grant.',
33085
+ items: { type: 'string' },
33086
+ type: 'array',
33087
+ },
33088
+ common_area_keys: {
33089
+ description: 'Common area keys associated with the access grant.',
33090
+ items: { type: 'string' },
33091
+ type: 'array',
33092
+ },
33093
+ ends_at: {
33094
+ description: 'Ending date and time for the access grant.',
33095
+ type: 'string',
33096
+ },
33097
+ facility_keys: {
33098
+ description: 'Facility keys associated with the access grant.',
33099
+ items: { type: 'string' },
33100
+ type: 'array',
33101
+ },
33102
+ guest_key: {
33103
+ description: 'Guest key associated with the access grant.',
33104
+ type: 'string',
33105
+ },
33106
+ listing_keys: {
33107
+ description: 'Listing keys associated with the access grant.',
33108
+ items: { type: 'string' },
33109
+ type: 'array',
33110
+ },
33111
+ name: {
33112
+ description: 'Your display name for this access grant resource.',
33113
+ type: 'string',
33114
+ },
33115
+ property_keys: {
33116
+ description: 'Property keys associated with the access grant.',
33117
+ items: { type: 'string' },
33118
+ type: 'array',
33119
+ },
33120
+ reservation_key: {
33121
+ description: 'Your unique identifier for the reservation.',
33122
+ type: 'string',
33123
+ },
33124
+ resident_key: {
33125
+ description: 'Resident key associated with the access grant.',
33126
+ type: 'string',
33127
+ },
33128
+ room_keys: {
33129
+ description: 'Room keys associated with the access grant.',
33130
+ items: { type: 'string' },
33131
+ type: 'array',
33132
+ },
33133
+ space_keys: {
33134
+ description: 'Space keys associated with the access grant.',
33135
+ items: { type: 'string' },
33136
+ type: 'array',
33137
+ },
33138
+ starts_at: {
33139
+ description: 'Starting date and time for the access grant.',
33140
+ type: 'string',
33141
+ },
33142
+ tenant_key: {
33143
+ description: 'Tenant key associated with the access grant.',
33144
+ type: 'string',
33145
+ },
33146
+ unit_keys: {
33147
+ description: 'Unit keys associated with the access grant.',
33148
+ items: { type: 'string' },
33149
+ type: 'array',
33150
+ },
33151
+ user_identity_key: {
33152
+ description: 'User identity key associated with the access grant.',
33153
+ type: 'string',
33154
+ },
33155
+ user_key: {
33156
+ description: 'User key associated with the access grant.',
33157
+ type: 'string',
33158
+ },
33159
+ },
33160
+ required: ['name', 'reservation_key'],
33161
+ type: 'object',
33162
+ },
33163
+ type: 'array',
33164
+ },
33165
+ residents: {
33166
+ description: 'List of residents.',
33167
+ items: {
33168
+ properties: {
33169
+ email_address: {
33170
+ description: 'Email address associated with the user identity.',
33171
+ type: 'string',
33172
+ },
33173
+ name: {
33174
+ description: 'Your display name for this user identity resource.',
33175
+ type: 'string',
33176
+ },
33177
+ phone_number: {
33178
+ description: 'Phone number associated with the user identity.',
33179
+ type: 'string',
33180
+ },
33181
+ resident_key: {
33182
+ description: 'Your unique identifier for the resident.',
33183
+ type: 'string',
33184
+ },
33185
+ },
33186
+ required: ['name', 'resident_key'],
33187
+ type: 'object',
33188
+ },
33189
+ type: 'array',
33190
+ },
33191
+ rooms: {
33192
+ description: 'List of hotel or hospitality rooms.',
33193
+ items: {
33194
+ properties: {
33195
+ name: {
33196
+ description: 'Your display name for this location resource.',
33197
+ type: 'string',
33198
+ },
33199
+ room_key: {
33200
+ description: 'Your unique identifier for the room.',
33201
+ type: 'string',
33202
+ },
33203
+ },
33204
+ required: ['name', 'room_key'],
33205
+ type: 'object',
33206
+ },
33207
+ type: 'array',
33208
+ },
33209
+ spaces: {
33210
+ description: 'List of general spaces or areas.',
33211
+ items: {
33212
+ properties: {
33213
+ name: {
33214
+ description: 'Your display name for this location resource.',
33215
+ type: 'string',
33216
+ },
33217
+ space_key: {
33218
+ description: 'Your unique identifier for the space.',
33219
+ type: 'string',
33220
+ },
33221
+ },
33222
+ required: ['name', 'space_key'],
33223
+ type: 'object',
33224
+ },
33225
+ type: 'array',
33226
+ },
33227
+ tenants: {
33228
+ description: 'List of tenants.',
33229
+ items: {
33230
+ properties: {
33231
+ email_address: {
33232
+ description: 'Email address associated with the user identity.',
33233
+ type: 'string',
33234
+ },
33235
+ name: {
33236
+ description: 'Your display name for this user identity resource.',
33237
+ type: 'string',
33238
+ },
33239
+ phone_number: {
33240
+ description: 'Phone number associated with the user identity.',
33241
+ type: 'string',
33242
+ },
33243
+ tenant_key: {
33244
+ description: 'Your unique identifier for the tenant.',
33245
+ type: 'string',
33246
+ },
33247
+ },
33248
+ required: ['name', 'tenant_key'],
33249
+ type: 'object',
33250
+ },
33251
+ type: 'array',
33252
+ },
33253
+ units: {
33254
+ description: 'List of multi-family residential units.',
33255
+ items: {
33256
+ properties: {
33257
+ name: {
33258
+ description: 'Your display name for this location resource.',
33259
+ type: 'string',
33260
+ },
33261
+ unit_key: {
33262
+ description: 'Your unique identifier for the unit.',
33263
+ type: 'string',
33264
+ },
33265
+ },
33266
+ required: ['name', 'unit_key'],
33267
+ type: 'object',
33268
+ },
33269
+ type: 'array',
33270
+ },
33271
+ user_identities: {
33272
+ description: 'List of user identities.',
33273
+ items: {
33274
+ properties: {
33275
+ email_address: {
33276
+ description: 'Email address associated with the user identity.',
33277
+ type: 'string',
33278
+ },
33279
+ name: {
33280
+ description: 'Your display name for this user identity resource.',
33281
+ type: 'string',
33282
+ },
33283
+ phone_number: {
33284
+ description: 'Phone number associated with the user identity.',
33285
+ type: 'string',
33286
+ },
33287
+ user_identity_key: {
33288
+ description: 'Your unique identifier for the user identity.',
33289
+ type: 'string',
33290
+ },
33291
+ },
33292
+ required: ['name', 'user_identity_key'],
33293
+ type: 'object',
33294
+ },
33295
+ type: 'array',
33296
+ },
33297
+ users: {
33298
+ description: 'List of users.',
33299
+ items: {
33300
+ properties: {
33301
+ email_address: {
33302
+ description: 'Email address associated with the user identity.',
33303
+ type: 'string',
33304
+ },
33305
+ name: {
33306
+ description: 'Your display name for this user identity resource.',
33307
+ type: 'string',
33308
+ },
33309
+ phone_number: {
33310
+ description: 'Phone number associated with the user identity.',
33311
+ type: 'string',
33312
+ },
33313
+ user_key: {
33314
+ description: 'Your unique identifier for the user.',
33315
+ type: 'string',
33316
+ },
33317
+ },
33318
+ required: ['name', 'user_key'],
33319
+ type: 'object',
33320
+ },
33321
+ type: 'array',
33322
+ },
33323
+ },
33324
+ required: ['customer_key'],
33325
+ type: 'object',
33326
+ },
33327
+ },
33328
+ type: 'object',
33329
+ },
33330
+ ],
33331
+ },
33332
+ },
33333
+ },
33334
+ },
33335
+ responses: {
33336
+ 200: {
33337
+ content: {
33338
+ 'application/json': {
33339
+ schema: {
33340
+ properties: {
33341
+ magic_link: { $ref: '#/components/schemas/magic_link' },
33342
+ ok: { type: 'boolean' },
33343
+ },
33344
+ required: ['magic_link', 'ok'],
33345
+ type: 'object',
33346
+ },
33347
+ },
33348
+ },
33349
+ description: 'OK',
33350
+ },
33351
+ 400: { description: 'Bad Request' },
33352
+ 401: { description: 'Unauthorized' },
33353
+ },
33354
+ security: [
33355
+ { pat_with_workspace: [] },
33356
+ { console_session_with_workspace: [] },
33357
+ { api_key: [] },
33358
+ ],
33359
+ summary: '/customers/create_portal',
33360
+ tags: [],
33361
+ 'x-fern-sdk-group-name': ['customers'],
33362
+ 'x-fern-sdk-method-name': 'create_portal',
33363
+ 'x-fern-sdk-return-value': 'magic_link',
33364
+ 'x-response-key': 'magic_link',
33365
+ 'x-title': 'Create Customer Portal',
33366
+ },
33367
+ },
33368
+ '/customers/push_data': {
33369
+ post: {
33370
+ description: 'Pushes customer data including resources like spaces, properties, rooms, users, etc.',
33371
+ operationId: 'customersPushDataPost',
33372
+ requestBody: {
33373
+ content: {
33374
+ 'application/json': {
33375
+ schema: {
33376
+ properties: {
33377
+ access_grants: {
33378
+ description: 'List of access grants.',
33379
+ items: {
33380
+ properties: {
33381
+ access_grant_key: {
33382
+ description: 'Your unique identifier for the access grant.',
33383
+ type: 'string',
33384
+ },
33385
+ building_keys: {
33386
+ description: 'Building keys associated with the access grant.',
33387
+ items: { type: 'string' },
33388
+ type: 'array',
33389
+ },
33390
+ common_area_keys: {
33391
+ description: 'Common area keys associated with the access grant.',
33392
+ items: { type: 'string' },
33393
+ type: 'array',
33394
+ },
33395
+ ends_at: {
33396
+ description: 'Ending date and time for the access grant.',
33397
+ type: 'string',
33398
+ },
33399
+ facility_keys: {
33400
+ description: 'Facility keys associated with the access grant.',
33401
+ items: { type: 'string' },
33402
+ type: 'array',
33403
+ },
33404
+ guest_key: {
33405
+ description: 'Guest key associated with the access grant.',
33406
+ type: 'string',
33407
+ },
33408
+ listing_keys: {
33409
+ description: 'Listing keys associated with the access grant.',
33410
+ items: { type: 'string' },
33411
+ type: 'array',
33412
+ },
33413
+ name: {
33414
+ description: 'Your display name for this access grant resource.',
33415
+ type: 'string',
33416
+ },
33417
+ property_keys: {
33418
+ description: 'Property keys associated with the access grant.',
33419
+ items: { type: 'string' },
33420
+ type: 'array',
33421
+ },
33422
+ resident_key: {
33423
+ description: 'Resident key associated with the access grant.',
33424
+ type: 'string',
33425
+ },
33426
+ room_keys: {
33427
+ description: 'Room keys associated with the access grant.',
33428
+ items: { type: 'string' },
33429
+ type: 'array',
33430
+ },
33431
+ space_keys: {
33432
+ description: 'Space keys associated with the access grant.',
33433
+ items: { type: 'string' },
33434
+ type: 'array',
33435
+ },
33436
+ starts_at: {
33437
+ description: 'Starting date and time for the access grant.',
33438
+ type: 'string',
33439
+ },
33440
+ tenant_key: {
33441
+ description: 'Tenant key associated with the access grant.',
33442
+ type: 'string',
33443
+ },
33444
+ unit_keys: {
33445
+ description: 'Unit keys associated with the access grant.',
33446
+ items: { type: 'string' },
33447
+ type: 'array',
33448
+ },
33449
+ user_identity_key: {
33450
+ description: 'User identity key associated with the access grant.',
33451
+ type: 'string',
33452
+ },
33453
+ user_key: {
33454
+ description: 'User key associated with the access grant.',
33455
+ type: 'string',
33456
+ },
33457
+ },
33458
+ required: ['name', 'access_grant_key'],
33459
+ type: 'object',
33460
+ },
33461
+ type: 'array',
33462
+ },
33463
+ bookings: {
33464
+ description: 'List of bookings.',
33465
+ items: {
33466
+ properties: {
33467
+ booking_key: {
33468
+ description: 'Your unique identifier for the booking.',
33469
+ type: 'string',
33470
+ },
33471
+ building_keys: {
33472
+ description: 'Building keys associated with the access grant.',
33473
+ items: { type: 'string' },
33474
+ type: 'array',
33475
+ },
33476
+ common_area_keys: {
33477
+ description: 'Common area keys associated with the access grant.',
33478
+ items: { type: 'string' },
33479
+ type: 'array',
33480
+ },
33481
+ ends_at: {
33482
+ description: 'Ending date and time for the access grant.',
33483
+ type: 'string',
33484
+ },
33485
+ facility_keys: {
33486
+ description: 'Facility keys associated with the access grant.',
33487
+ items: { type: 'string' },
33488
+ type: 'array',
33489
+ },
33490
+ guest_key: {
33491
+ description: 'Guest key associated with the access grant.',
33492
+ type: 'string',
33493
+ },
33494
+ listing_keys: {
33495
+ description: 'Listing keys associated with the access grant.',
33496
+ items: { type: 'string' },
33497
+ type: 'array',
33498
+ },
33499
+ name: {
33500
+ description: 'Your display name for this access grant resource.',
33501
+ type: 'string',
33502
+ },
33503
+ property_keys: {
33504
+ description: 'Property keys associated with the access grant.',
33505
+ items: { type: 'string' },
33506
+ type: 'array',
33507
+ },
33508
+ resident_key: {
33509
+ description: 'Resident key associated with the access grant.',
33510
+ type: 'string',
33511
+ },
33512
+ room_keys: {
33513
+ description: 'Room keys associated with the access grant.',
33514
+ items: { type: 'string' },
33515
+ type: 'array',
33516
+ },
33517
+ space_keys: {
33518
+ description: 'Space keys associated with the access grant.',
33519
+ items: { type: 'string' },
33520
+ type: 'array',
33521
+ },
33522
+ starts_at: {
33523
+ description: 'Starting date and time for the access grant.',
33524
+ type: 'string',
33525
+ },
33526
+ tenant_key: {
33527
+ description: 'Tenant key associated with the access grant.',
33528
+ type: 'string',
33529
+ },
33530
+ unit_keys: {
33531
+ description: 'Unit keys associated with the access grant.',
33532
+ items: { type: 'string' },
33533
+ type: 'array',
33534
+ },
33535
+ user_identity_key: {
33536
+ description: 'User identity key associated with the access grant.',
33537
+ type: 'string',
33538
+ },
33539
+ user_key: {
33540
+ description: 'User key associated with the access grant.',
33541
+ type: 'string',
33542
+ },
33543
+ },
33544
+ required: ['name', 'booking_key'],
33545
+ type: 'object',
33546
+ },
33547
+ type: 'array',
33548
+ },
33549
+ buildings: {
33550
+ description: 'List of buildings.',
33551
+ items: {
33552
+ properties: {
33553
+ building_key: {
33554
+ description: 'Your unique identifier for the building.',
33555
+ type: 'string',
33556
+ },
33557
+ name: {
33558
+ description: 'Your display name for this location resource.',
33559
+ type: 'string',
33560
+ },
33561
+ },
33562
+ required: ['name', 'building_key'],
33563
+ type: 'object',
33564
+ },
33565
+ type: 'array',
33566
+ },
33567
+ common_areas: {
33568
+ description: 'List of shared common areas.',
33569
+ items: {
33570
+ properties: {
33571
+ common_area_key: {
33572
+ description: 'Your unique identifier for the common area.',
33573
+ type: 'string',
33574
+ },
33575
+ name: {
33576
+ description: 'Your display name for this location resource.',
33577
+ type: 'string',
33578
+ },
33579
+ },
33580
+ required: ['name', 'common_area_key'],
33581
+ type: 'object',
33582
+ },
33583
+ type: 'array',
33584
+ },
33585
+ customer_key: {
33586
+ description: 'Your unique identifier for the customer.',
33587
+ type: 'string',
33588
+ },
33589
+ facilities: {
33590
+ description: 'List of gym or fitness facilities.',
33591
+ items: {
33592
+ properties: {
33593
+ facility_key: {
33594
+ description: 'Your unique identifier for the facility.',
33595
+ type: 'string',
33596
+ },
33597
+ name: {
33598
+ description: 'Your display name for this location resource.',
33599
+ type: 'string',
33600
+ },
33601
+ },
33602
+ required: ['name', 'facility_key'],
33603
+ type: 'object',
33604
+ },
33605
+ type: 'array',
33606
+ },
33607
+ guests: {
33608
+ description: 'List of guests.',
33609
+ items: {
33610
+ properties: {
33611
+ email_address: {
33612
+ description: 'Email address associated with the user identity.',
33613
+ type: 'string',
33614
+ },
33615
+ guest_key: {
33616
+ description: 'Your unique identifier for the guest.',
33617
+ type: 'string',
33618
+ },
33619
+ name: {
33620
+ description: 'Your display name for this user identity resource.',
33621
+ type: 'string',
33622
+ },
33623
+ phone_number: {
33624
+ description: 'Phone number associated with the user identity.',
33625
+ type: 'string',
33626
+ },
33627
+ },
33628
+ required: ['name', 'guest_key'],
33629
+ type: 'object',
33630
+ },
33631
+ type: 'array',
33632
+ },
33633
+ listings: {
33634
+ description: 'List of property listings.',
33635
+ items: {
33636
+ properties: {
33637
+ listing_key: {
33638
+ description: 'Your unique identifier for the listing.',
33639
+ type: 'string',
33640
+ },
33641
+ name: {
33642
+ description: 'Your display name for this location resource.',
33643
+ type: 'string',
33644
+ },
33645
+ },
33646
+ required: ['name', 'listing_key'],
33647
+ type: 'object',
33648
+ },
33649
+ type: 'array',
33650
+ },
33651
+ properties: {
33652
+ description: 'List of short-term rental properties.',
33653
+ items: {
33654
+ properties: {
33655
+ name: {
33656
+ description: 'Your display name for this location resource.',
33657
+ type: 'string',
33658
+ },
33659
+ property_key: {
33660
+ description: 'Your unique identifier for the property.',
33661
+ type: 'string',
33662
+ },
33663
+ },
33664
+ required: ['name', 'property_key'],
33665
+ type: 'object',
33666
+ },
33667
+ type: 'array',
33668
+ },
33669
+ reservations: {
33670
+ description: 'List of reservations.',
33671
+ items: {
33672
+ properties: {
33673
+ building_keys: {
33674
+ description: 'Building keys associated with the access grant.',
33675
+ items: { type: 'string' },
33676
+ type: 'array',
33677
+ },
33678
+ common_area_keys: {
33679
+ description: 'Common area keys associated with the access grant.',
33680
+ items: { type: 'string' },
33681
+ type: 'array',
33682
+ },
33683
+ ends_at: {
33684
+ description: 'Ending date and time for the access grant.',
33685
+ type: 'string',
33686
+ },
33687
+ facility_keys: {
33688
+ description: 'Facility keys associated with the access grant.',
33689
+ items: { type: 'string' },
33690
+ type: 'array',
33691
+ },
33692
+ guest_key: {
33693
+ description: 'Guest key associated with the access grant.',
33694
+ type: 'string',
33695
+ },
33696
+ listing_keys: {
33697
+ description: 'Listing keys associated with the access grant.',
33698
+ items: { type: 'string' },
33699
+ type: 'array',
33700
+ },
33701
+ name: {
33702
+ description: 'Your display name for this access grant resource.',
33703
+ type: 'string',
33704
+ },
33705
+ property_keys: {
33706
+ description: 'Property keys associated with the access grant.',
33707
+ items: { type: 'string' },
33708
+ type: 'array',
33709
+ },
33710
+ reservation_key: {
33711
+ description: 'Your unique identifier for the reservation.',
33712
+ type: 'string',
33713
+ },
33714
+ resident_key: {
33715
+ description: 'Resident key associated with the access grant.',
33716
+ type: 'string',
33717
+ },
33718
+ room_keys: {
33719
+ description: 'Room keys associated with the access grant.',
33720
+ items: { type: 'string' },
33721
+ type: 'array',
33722
+ },
33723
+ space_keys: {
33724
+ description: 'Space keys associated with the access grant.',
33725
+ items: { type: 'string' },
33726
+ type: 'array',
33727
+ },
33728
+ starts_at: {
33729
+ description: 'Starting date and time for the access grant.',
33730
+ type: 'string',
33731
+ },
33732
+ tenant_key: {
33733
+ description: 'Tenant key associated with the access grant.',
33734
+ type: 'string',
33735
+ },
33736
+ unit_keys: {
33737
+ description: 'Unit keys associated with the access grant.',
33738
+ items: { type: 'string' },
33739
+ type: 'array',
33740
+ },
33741
+ user_identity_key: {
33742
+ description: 'User identity key associated with the access grant.',
33743
+ type: 'string',
33744
+ },
33745
+ user_key: {
33746
+ description: 'User key associated with the access grant.',
33747
+ type: 'string',
33748
+ },
33749
+ },
33750
+ required: ['name', 'reservation_key'],
33751
+ type: 'object',
33752
+ },
33753
+ type: 'array',
33754
+ },
33755
+ residents: {
33756
+ description: 'List of residents.',
33757
+ items: {
33758
+ properties: {
33759
+ email_address: {
33760
+ description: 'Email address associated with the user identity.',
33761
+ type: 'string',
33762
+ },
33763
+ name: {
33764
+ description: 'Your display name for this user identity resource.',
33765
+ type: 'string',
33766
+ },
33767
+ phone_number: {
33768
+ description: 'Phone number associated with the user identity.',
33769
+ type: 'string',
33770
+ },
33771
+ resident_key: {
33772
+ description: 'Your unique identifier for the resident.',
33773
+ type: 'string',
33774
+ },
33775
+ },
33776
+ required: ['name', 'resident_key'],
33777
+ type: 'object',
33778
+ },
33779
+ type: 'array',
33780
+ },
33781
+ rooms: {
33782
+ description: 'List of hotel or hospitality rooms.',
33783
+ items: {
33784
+ properties: {
33785
+ name: {
33786
+ description: 'Your display name for this location resource.',
33787
+ type: 'string',
33788
+ },
33789
+ room_key: {
33790
+ description: 'Your unique identifier for the room.',
33791
+ type: 'string',
33792
+ },
33793
+ },
33794
+ required: ['name', 'room_key'],
33795
+ type: 'object',
33796
+ },
33797
+ type: 'array',
33798
+ },
33799
+ spaces: {
33800
+ description: 'List of general spaces or areas.',
33801
+ items: {
33802
+ properties: {
33803
+ name: {
33804
+ description: 'Your display name for this location resource.',
33805
+ type: 'string',
33806
+ },
33807
+ space_key: {
33808
+ description: 'Your unique identifier for the space.',
33809
+ type: 'string',
33810
+ },
33811
+ },
33812
+ required: ['name', 'space_key'],
33813
+ type: 'object',
33814
+ },
33815
+ type: 'array',
33816
+ },
33817
+ tenants: {
33818
+ description: 'List of tenants.',
33819
+ items: {
33820
+ properties: {
33821
+ email_address: {
33822
+ description: 'Email address associated with the user identity.',
33823
+ type: 'string',
33824
+ },
33825
+ name: {
33826
+ description: 'Your display name for this user identity resource.',
33827
+ type: 'string',
33828
+ },
33829
+ phone_number: {
33830
+ description: 'Phone number associated with the user identity.',
33831
+ type: 'string',
33832
+ },
33833
+ tenant_key: {
33834
+ description: 'Your unique identifier for the tenant.',
33835
+ type: 'string',
33836
+ },
33837
+ },
33838
+ required: ['name', 'tenant_key'],
33839
+ type: 'object',
33840
+ },
33841
+ type: 'array',
33842
+ },
33843
+ units: {
33844
+ description: 'List of multi-family residential units.',
33845
+ items: {
33846
+ properties: {
33847
+ name: {
33848
+ description: 'Your display name for this location resource.',
33849
+ type: 'string',
33850
+ },
33851
+ unit_key: {
33852
+ description: 'Your unique identifier for the unit.',
33853
+ type: 'string',
33854
+ },
33855
+ },
33856
+ required: ['name', 'unit_key'],
33857
+ type: 'object',
33858
+ },
33859
+ type: 'array',
33860
+ },
33861
+ user_identities: {
33862
+ description: 'List of user identities.',
33863
+ items: {
33864
+ properties: {
33865
+ email_address: {
33866
+ description: 'Email address associated with the user identity.',
33867
+ type: 'string',
33868
+ },
33869
+ name: {
33870
+ description: 'Your display name for this user identity resource.',
33871
+ type: 'string',
33872
+ },
33873
+ phone_number: {
33874
+ description: 'Phone number associated with the user identity.',
33875
+ type: 'string',
33876
+ },
33877
+ user_identity_key: {
33878
+ description: 'Your unique identifier for the user identity.',
33879
+ type: 'string',
33880
+ },
33881
+ },
33882
+ required: ['name', 'user_identity_key'],
33883
+ type: 'object',
33884
+ },
33885
+ type: 'array',
33886
+ },
33887
+ users: {
33888
+ description: 'List of users.',
33889
+ items: {
33890
+ properties: {
33891
+ email_address: {
33892
+ description: 'Email address associated with the user identity.',
33893
+ type: 'string',
33894
+ },
33895
+ name: {
33896
+ description: 'Your display name for this user identity resource.',
33897
+ type: 'string',
33898
+ },
33899
+ phone_number: {
33900
+ description: 'Phone number associated with the user identity.',
33901
+ type: 'string',
33902
+ },
33903
+ user_key: {
33904
+ description: 'Your unique identifier for the user.',
33905
+ type: 'string',
33906
+ },
33907
+ },
33908
+ required: ['name', 'user_key'],
33909
+ type: 'object',
33910
+ },
33911
+ type: 'array',
33912
+ },
33913
+ },
33914
+ required: ['customer_key'],
33915
+ type: 'object',
33916
+ },
33917
+ },
33918
+ },
33919
+ },
33920
+ responses: {
33921
+ 200: {
33922
+ content: {
33923
+ 'application/json': {
33924
+ schema: {
33925
+ properties: { ok: { type: 'boolean' } },
33926
+ required: ['ok'],
33927
+ type: 'object',
33928
+ },
33929
+ },
33930
+ },
33931
+ description: 'OK',
33932
+ },
33933
+ 400: { description: 'Bad Request' },
33934
+ 401: { description: 'Unauthorized' },
33935
+ },
33936
+ security: [
33937
+ { pat_with_workspace: [] },
33938
+ { console_session_with_workspace: [] },
33939
+ { api_key: [] },
33940
+ ],
33941
+ summary: '/customers/push_data',
33942
+ tags: [],
33943
+ 'x-fern-sdk-group-name': ['customers'],
33944
+ 'x-fern-sdk-method-name': 'push_data',
33945
+ 'x-response-key': null,
33946
+ 'x-title': 'Push Customer Data',
33947
+ },
33948
+ },
33949
+ '/devices/delete': {
33950
+ delete: {
33951
+ description: 'Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).',
33952
+ operationId: 'devicesDeleteDelete',
33953
+ parameters: [
33954
+ {
33955
+ in: 'query',
33956
+ name: 'device_id',
33957
+ required: true,
33958
+ schema: {
33959
+ description: 'ID of the device that you want to delete.',
33960
+ format: 'uuid',
33961
+ type: 'string',
33962
+ },
33963
+ },
33964
+ ],
33965
+ responses: {
33966
+ 200: {
33967
+ content: {
33968
+ 'application/json': {
33969
+ schema: {
33970
+ properties: { ok: { type: 'boolean' } },
33971
+ required: ['ok'],
33972
+ type: 'object',
33973
+ },
33974
+ },
33975
+ },
33976
+ description: 'OK',
33977
+ },
33978
+ 400: { description: 'Bad Request' },
33979
+ 401: { description: 'Unauthorized' },
33980
+ },
33981
+ security: [
33982
+ { api_key: [] },
33983
+ { pat_with_workspace: [] },
33984
+ { console_session_with_workspace: [] },
33985
+ ],
33986
+ summary: '/devices/delete',
33987
+ tags: ['/devices'],
33988
+ 'x-deprecated': 'Deleting a device is no longer supported and will be removed.',
33989
+ 'x-fern-sdk-group-name': ['devices'],
33990
+ 'x-fern-sdk-method-name': 'delete',
33991
+ 'x-response-key': null,
33992
+ 'x-title': 'Delete a Device',
33993
+ 'x-undocumented': 'Deleting a device is no longer supported and will be removed.',
33994
+ },
33995
+ post: {
33996
+ description: 'Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).',
33997
+ operationId: 'devicesDeletePost',
33998
+ requestBody: {
33999
+ content: {
34000
+ 'application/json': {
34001
+ schema: {
34002
+ properties: {
34003
+ device_id: {
34004
+ description: 'ID of the device that you want to delete.',
34005
+ format: 'uuid',
34006
+ type: 'string',
34007
+ },
34008
+ },
34009
+ required: ['device_id'],
34010
+ type: 'object',
34011
+ },
34012
+ },
34013
+ },
34014
+ },
34015
+ responses: {
34016
+ 200: {
34017
+ content: {
34018
+ 'application/json': {
34019
+ schema: {
34020
+ properties: { ok: { type: 'boolean' } },
34021
+ required: ['ok'],
34022
+ type: 'object',
34023
+ },
34024
+ },
34025
+ },
34026
+ description: 'OK',
34027
+ },
34028
+ 400: { description: 'Bad Request' },
34029
+ 401: { description: 'Unauthorized' },
34030
+ },
34031
+ security: [
34032
+ { api_key: [] },
34033
+ { pat_with_workspace: [] },
34034
+ { console_session_with_workspace: [] },
34035
+ ],
34036
+ summary: '/devices/delete',
34037
+ tags: ['/devices'],
34038
+ 'x-deprecated': 'Deleting a device is no longer supported and will be removed.',
34039
+ 'x-fern-sdk-group-name': ['devices'],
34040
+ 'x-fern-sdk-method-name': 'delete',
34041
+ 'x-response-key': null,
34042
+ 'x-title': 'Delete a Device',
34043
+ 'x-undocumented': 'Deleting a device is no longer supported and will be removed.',
34044
+ },
34045
+ },
34046
+ '/devices/get': {
34047
+ get: {
34048
+ description: 'Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.',
34049
+ operationId: 'devicesGetGet',
34050
+ parameters: [
34051
+ {
34052
+ in: 'query',
34053
+ name: 'device_id',
34054
+ schema: {
34055
+ description: 'ID of the device that you want to get.',
34056
+ format: 'uuid',
34057
+ type: 'string',
34058
+ },
34059
+ },
34060
+ {
34061
+ in: 'query',
34062
+ name: 'name',
34063
+ schema: {
34064
+ description: 'Name of the device that you want to get.',
34065
+ type: 'string',
34066
+ },
34067
+ },
34068
+ ],
34069
+ responses: {
34070
+ 200: {
34071
+ content: {
34072
+ 'application/json': {
34073
+ schema: {
34074
+ properties: {
34075
+ device: { $ref: '#/components/schemas/device' },
34076
+ ok: { type: 'boolean' },
34077
+ },
34078
+ required: ['device', 'ok'],
34079
+ type: 'object',
34080
+ },
34081
+ },
34082
+ },
34083
+ description: 'OK',
34084
+ },
34085
+ 400: { description: 'Bad Request' },
34086
+ 401: { description: 'Unauthorized' },
34087
+ },
34088
+ security: [
34089
+ { client_session: [] },
34090
+ { client_session_with_customer: [] },
34091
+ { pat_with_workspace: [] },
34092
+ { console_session_with_workspace: [] },
34093
+ { api_key: [] },
34094
+ ],
34095
+ summary: '/devices/get',
34096
+ tags: ['/devices'],
34097
+ 'x-fern-sdk-group-name': ['devices'],
34098
+ 'x-fern-sdk-method-name': 'get',
34099
+ 'x-fern-sdk-return-value': 'device',
34100
+ 'x-response-key': 'device',
34101
+ 'x-title': 'Get a Device',
34102
+ },
34103
+ post: {
34104
+ description: 'Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.',
34105
+ operationId: 'devicesGetPost',
34106
+ requestBody: {
34107
+ content: {
34108
+ 'application/json': {
34109
+ schema: {
34110
+ properties: {
34111
+ device_id: {
34112
+ description: 'ID of the device that you want to get.',
34113
+ format: 'uuid',
34114
+ type: 'string',
34115
+ },
34116
+ name: {
34117
+ description: 'Name of the device that you want to get.',
34118
+ type: 'string',
34119
+ },
34120
+ },
34121
+ type: 'object',
34122
+ },
34123
+ },
34124
+ },
34125
+ },
34126
+ responses: {
34127
+ 200: {
34128
+ content: {
34129
+ 'application/json': {
34130
+ schema: {
34131
+ properties: {
34132
+ device: { $ref: '#/components/schemas/device' },
34133
+ ok: { type: 'boolean' },
34134
+ },
34135
+ required: ['device', 'ok'],
34136
+ type: 'object',
34137
+ },
34138
+ },
34139
+ },
34140
+ description: 'OK',
32974
34141
  },
32975
34142
  400: { description: 'Bad Request' },
32976
34143
  401: { description: 'Unauthorized' },
@@ -39169,39 +40336,221 @@ export default {
39169
40336
  400: { description: 'Bad Request' },
39170
40337
  401: { description: 'Unauthorized' },
39171
40338
  },
39172
- security: [{ bridge_client_session: [] }],
39173
- summary: '/seam/bridge/v1/bridge_connected_systems/list',
40339
+ security: [{ bridge_client_session: [] }],
40340
+ summary: '/seam/bridge/v1/bridge_connected_systems/list',
40341
+ tags: [],
40342
+ 'x-fern-sdk-group-name': [
40343
+ 'seam',
40344
+ 'bridge',
40345
+ 'v1',
40346
+ 'bridge_connected_systems',
40347
+ ],
40348
+ 'x-fern-sdk-method-name': 'list',
40349
+ 'x-fern-sdk-return-value': 'bridge_connected_systems',
40350
+ 'x-response-key': 'bridge_connected_systems',
40351
+ 'x-title': 'List Bridge-Connected Systems',
40352
+ 'x-undocumented': 'Seam Bridge Client only.',
40353
+ },
40354
+ post: {
40355
+ description: 'Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)-connected systems associated with the client session token used for authentication.',
40356
+ operationId: 'seamBridgeV1BridgeConnectedSystemsListPost',
40357
+ responses: {
40358
+ 200: {
40359
+ content: {
40360
+ 'application/json': {
40361
+ schema: {
40362
+ properties: {
40363
+ bridge_connected_systems: {
40364
+ items: {
40365
+ $ref: '#/components/schemas/bridge_connected_systems',
40366
+ },
40367
+ type: 'array',
40368
+ },
40369
+ ok: { type: 'boolean' },
40370
+ },
40371
+ required: ['bridge_connected_systems', 'ok'],
40372
+ type: 'object',
40373
+ },
40374
+ },
40375
+ },
40376
+ description: 'OK',
40377
+ },
40378
+ 400: { description: 'Bad Request' },
40379
+ 401: { description: 'Unauthorized' },
40380
+ },
40381
+ security: [{ bridge_client_session: [] }],
40382
+ summary: '/seam/bridge/v1/bridge_connected_systems/list',
40383
+ tags: [],
40384
+ 'x-fern-sdk-group-name': [
40385
+ 'seam',
40386
+ 'bridge',
40387
+ 'v1',
40388
+ 'bridge_connected_systems',
40389
+ ],
40390
+ 'x-fern-sdk-method-name': 'list',
40391
+ 'x-fern-sdk-return-value': 'bridge_connected_systems',
40392
+ 'x-response-key': 'bridge_connected_systems',
40393
+ 'x-title': 'List Bridge-Connected Systems',
40394
+ 'x-undocumented': 'Seam Bridge Client only.',
40395
+ },
40396
+ },
40397
+ '/seam/customer/v1/portals/get': {
40398
+ get: {
40399
+ description: 'Retrieves the configuration for a customer portal identified by customer_portal_id.',
40400
+ operationId: 'seamCustomerV1PortalsGetGet',
40401
+ parameters: [
40402
+ {
40403
+ in: 'query',
40404
+ name: 'customer_portal_id',
40405
+ required: true,
40406
+ schema: { description: 'Customer portal ID.', type: 'string' },
40407
+ },
40408
+ ],
40409
+ responses: {
40410
+ 200: {
40411
+ content: {
40412
+ 'application/json': {
40413
+ schema: {
40414
+ properties: {
40415
+ customer_portal: {
40416
+ properties: {
40417
+ business_vertical: {
40418
+ description: 'Business vertical of the customer portal.',
40419
+ enum: [
40420
+ 'short_term_rental',
40421
+ 'hospitality',
40422
+ 'multi_family',
40423
+ 'gym_management',
40424
+ 'property_tours',
40425
+ ],
40426
+ type: 'string',
40427
+ },
40428
+ features: {
40429
+ properties: {
40430
+ connect: {
40431
+ properties: { exclude: { type: 'boolean' } },
40432
+ type: 'object',
40433
+ },
40434
+ manage_devices: {
40435
+ properties: { exclude: { type: 'boolean' } },
40436
+ type: 'object',
40437
+ },
40438
+ organize: {
40439
+ properties: { exclude: { type: 'boolean' } },
40440
+ type: 'object',
40441
+ },
40442
+ },
40443
+ type: 'object',
40444
+ },
40445
+ },
40446
+ type: 'object',
40447
+ },
40448
+ ok: { type: 'boolean' },
40449
+ },
40450
+ required: ['customer_portal', 'ok'],
40451
+ type: 'object',
40452
+ },
40453
+ },
40454
+ },
40455
+ description: 'OK',
40456
+ },
40457
+ 400: { description: 'Bad Request' },
40458
+ 401: { description: 'Unauthorized' },
40459
+ },
40460
+ security: [{ client_session_with_customer: [] }],
40461
+ summary: '/seam/customer/v1/portals/get',
40462
+ tags: [],
40463
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'portals'],
40464
+ 'x-fern-sdk-method-name': 'get',
40465
+ 'x-fern-sdk-return-value': 'portal_configuration',
40466
+ 'x-response-key': 'portal_configuration',
40467
+ 'x-title': 'Get Customer Portal Configuration',
40468
+ 'x-undocumented': 'Internal endpoint for customer portals.',
40469
+ },
40470
+ },
40471
+ '/seam/customer/v1/settings/update': {
40472
+ patch: {
40473
+ description: 'Updates the settings for a customer portal workspace.',
40474
+ operationId: 'seamCustomerV1SettingsUpdatePatch',
40475
+ requestBody: {
40476
+ content: {
40477
+ 'application/json': {
40478
+ schema: {
40479
+ properties: {
40480
+ business_vertical: {
40481
+ description: 'Business vertical to set on the workspace.',
40482
+ enum: [
40483
+ 'short_term_rental',
40484
+ 'hospitality',
40485
+ 'multi_family',
40486
+ 'gym_management',
40487
+ 'property_tours',
40488
+ ],
40489
+ type: 'string',
40490
+ },
40491
+ },
40492
+ type: 'object',
40493
+ },
40494
+ },
40495
+ },
40496
+ },
40497
+ responses: {
40498
+ 200: {
40499
+ content: {
40500
+ 'application/json': {
40501
+ schema: {
40502
+ properties: { ok: { type: 'boolean' } },
40503
+ required: ['ok'],
40504
+ type: 'object',
40505
+ },
40506
+ },
40507
+ },
40508
+ description: 'OK',
40509
+ },
40510
+ 400: { description: 'Bad Request' },
40511
+ 401: { description: 'Unauthorized' },
40512
+ },
40513
+ security: [{ console_session_with_workspace: [] }, { api_key: [] }],
40514
+ summary: '/seam/customer/v1/settings/update',
39174
40515
  tags: [],
39175
- 'x-fern-sdk-group-name': [
39176
- 'seam',
39177
- 'bridge',
39178
- 'v1',
39179
- 'bridge_connected_systems',
39180
- ],
39181
- 'x-fern-sdk-method-name': 'list',
39182
- 'x-fern-sdk-return-value': 'bridge_connected_systems',
39183
- 'x-response-key': 'bridge_connected_systems',
39184
- 'x-title': 'List Bridge-Connected Systems',
39185
- 'x-undocumented': 'Seam Bridge Client only.',
40516
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'settings'],
40517
+ 'x-fern-sdk-method-name': 'update',
40518
+ 'x-response-key': null,
40519
+ 'x-title': 'Update Customer Portal Settings',
40520
+ 'x-undocumented': 'Internal endpoint for customer portals.',
39186
40521
  },
39187
40522
  post: {
39188
- description: 'Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)-connected systems associated with the client session token used for authentication.',
39189
- operationId: 'seamBridgeV1BridgeConnectedSystemsListPost',
40523
+ description: 'Updates the settings for a customer portal workspace.',
40524
+ operationId: 'seamCustomerV1SettingsUpdatePost',
40525
+ requestBody: {
40526
+ content: {
40527
+ 'application/json': {
40528
+ schema: {
40529
+ properties: {
40530
+ business_vertical: {
40531
+ description: 'Business vertical to set on the workspace.',
40532
+ enum: [
40533
+ 'short_term_rental',
40534
+ 'hospitality',
40535
+ 'multi_family',
40536
+ 'gym_management',
40537
+ 'property_tours',
40538
+ ],
40539
+ type: 'string',
40540
+ },
40541
+ },
40542
+ type: 'object',
40543
+ },
40544
+ },
40545
+ },
40546
+ },
39190
40547
  responses: {
39191
40548
  200: {
39192
40549
  content: {
39193
40550
  'application/json': {
39194
40551
  schema: {
39195
- properties: {
39196
- bridge_connected_systems: {
39197
- items: {
39198
- $ref: '#/components/schemas/bridge_connected_systems',
39199
- },
39200
- type: 'array',
39201
- },
39202
- ok: { type: 'boolean' },
39203
- },
39204
- required: ['bridge_connected_systems', 'ok'],
40552
+ properties: { ok: { type: 'boolean' } },
40553
+ required: ['ok'],
39205
40554
  type: 'object',
39206
40555
  },
39207
40556
  },
@@ -39211,20 +40560,14 @@ export default {
39211
40560
  400: { description: 'Bad Request' },
39212
40561
  401: { description: 'Unauthorized' },
39213
40562
  },
39214
- security: [{ bridge_client_session: [] }],
39215
- summary: '/seam/bridge/v1/bridge_connected_systems/list',
40563
+ security: [{ console_session_with_workspace: [] }, { api_key: [] }],
40564
+ summary: '/seam/customer/v1/settings/update',
39216
40565
  tags: [],
39217
- 'x-fern-sdk-group-name': [
39218
- 'seam',
39219
- 'bridge',
39220
- 'v1',
39221
- 'bridge_connected_systems',
39222
- ],
39223
- 'x-fern-sdk-method-name': 'list',
39224
- 'x-fern-sdk-return-value': 'bridge_connected_systems',
39225
- 'x-response-key': 'bridge_connected_systems',
39226
- 'x-title': 'List Bridge-Connected Systems',
39227
- 'x-undocumented': 'Seam Bridge Client only.',
40566
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'settings'],
40567
+ 'x-fern-sdk-method-name': 'update',
40568
+ 'x-response-key': null,
40569
+ 'x-title': 'Update Customer Portal Settings',
40570
+ 'x-undocumented': 'Internal endpoint for customer portals.',
39228
40571
  },
39229
40572
  },
39230
40573
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
@@ -39624,103 +40967,6 @@ export default {
39624
40967
  'x-undocumented': 'Partner building blocks/UI only.',
39625
40968
  },
39626
40969
  },
39627
- '/seam/partner/v1/resources/list': {
39628
- get: {
39629
- description: 'Lists partner resources that have been pushed to Seam.',
39630
- operationId: 'seamPartnerV1ResourcesListGet',
39631
- parameters: [
39632
- {
39633
- in: 'query',
39634
- name: 'resource_type_alias',
39635
- schema: {
39636
- description: 'Resource type alias by which you want to filter partner resources.',
39637
- type: 'string',
39638
- },
39639
- },
39640
- ],
39641
- responses: {
39642
- 200: {
39643
- content: {
39644
- 'application/json': {
39645
- schema: {
39646
- properties: {
39647
- ok: { type: 'boolean' },
39648
- partner_resources: {
39649
- items: { $ref: '#/components/schemas/partner_resource' },
39650
- type: 'array',
39651
- },
39652
- },
39653
- required: ['partner_resources', 'ok'],
39654
- type: 'object',
39655
- },
39656
- },
39657
- },
39658
- description: 'OK',
39659
- },
39660
- 400: { description: 'Bad Request' },
39661
- 401: { description: 'Unauthorized' },
39662
- },
39663
- security: [{ client_session_with_customer: [] }],
39664
- summary: '/seam/partner/v1/resources/list',
39665
- tags: [],
39666
- 'x-fern-sdk-group-name': ['seam', 'partner', 'v1', 'resources'],
39667
- 'x-fern-sdk-method-name': 'list',
39668
- 'x-fern-sdk-return-value': 'partner_resources',
39669
- 'x-response-key': 'partner_resources',
39670
- 'x-title': 'List Partner Resources at Seam',
39671
- 'x-undocumented': 'Partner building blocks/UI only.',
39672
- },
39673
- post: {
39674
- description: 'Lists partner resources that have been pushed to Seam.',
39675
- operationId: 'seamPartnerV1ResourcesListPost',
39676
- requestBody: {
39677
- content: {
39678
- 'application/json': {
39679
- schema: {
39680
- properties: {
39681
- resource_type_alias: {
39682
- description: 'Resource type alias by which you want to filter partner resources.',
39683
- type: 'string',
39684
- },
39685
- },
39686
- type: 'object',
39687
- },
39688
- },
39689
- },
39690
- },
39691
- responses: {
39692
- 200: {
39693
- content: {
39694
- 'application/json': {
39695
- schema: {
39696
- properties: {
39697
- ok: { type: 'boolean' },
39698
- partner_resources: {
39699
- items: { $ref: '#/components/schemas/partner_resource' },
39700
- type: 'array',
39701
- },
39702
- },
39703
- required: ['partner_resources', 'ok'],
39704
- type: 'object',
39705
- },
39706
- },
39707
- },
39708
- description: 'OK',
39709
- },
39710
- 400: { description: 'Bad Request' },
39711
- 401: { description: 'Unauthorized' },
39712
- },
39713
- security: [{ client_session_with_customer: [] }],
39714
- summary: '/seam/partner/v1/resources/list',
39715
- tags: [],
39716
- 'x-fern-sdk-group-name': ['seam', 'partner', 'v1', 'resources'],
39717
- 'x-fern-sdk-method-name': 'list',
39718
- 'x-fern-sdk-return-value': 'partner_resources',
39719
- 'x-response-key': 'partner_resources',
39720
- 'x-title': 'List Partner Resources at Seam',
39721
- 'x-undocumented': 'Partner building blocks/UI only.',
39722
- },
39723
- },
39724
40970
  '/spaces/add_acs_entrances': {
39725
40971
  post: {
39726
40972
  description: 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.',
@@ -45471,30 +46717,18 @@ export default {
45471
46717
  schema: {
45472
46718
  description: 'Optional list of spaces that you want to include in the new building block magic link.',
45473
46719
  items: {
45474
- description: 'Represents a partner resource that enables you to send your space resources to Seam.',
45475
46720
  properties: {
45476
- custom_metadata: {
45477
- additionalProperties: { type: 'string' },
45478
- description: 'Custom metadata associated with the space resource.',
45479
- type: 'object',
45480
- },
45481
- description: {
45482
- description: 'Description of the space resource.',
45483
- type: 'string',
45484
- },
45485
46721
  name: {
45486
- description: 'Name of the space resource.',
46722
+ description: 'Your display name for this location resource.',
45487
46723
  type: 'string',
45488
46724
  },
45489
46725
  space_key: {
45490
- description: 'Key of the space for the resource.',
46726
+ description: 'Your unique identifier for the space.',
45491
46727
  type: 'string',
45492
46728
  },
45493
46729
  },
45494
- required: ['space_key', 'name'],
46730
+ required: ['name', 'space_key'],
45495
46731
  type: 'object',
45496
- 'x-route-path': '/unstable_partner/resources',
45497
- 'x-undocumented': 'Unreleased.',
45498
46732
  },
45499
46733
  type: 'array',
45500
46734
  },
@@ -45558,30 +46792,18 @@ export default {
45558
46792
  spaces: {
45559
46793
  description: 'Optional list of spaces that you want to include in the new building block magic link.',
45560
46794
  items: {
45561
- description: 'Represents a partner resource that enables you to send your space resources to Seam.',
45562
46795
  properties: {
45563
- custom_metadata: {
45564
- additionalProperties: { type: 'string' },
45565
- description: 'Custom metadata associated with the space resource.',
45566
- type: 'object',
45567
- },
45568
- description: {
45569
- description: 'Description of the space resource.',
45570
- type: 'string',
45571
- },
45572
46796
  name: {
45573
- description: 'Name of the space resource.',
46797
+ description: 'Your display name for this location resource.',
45574
46798
  type: 'string',
45575
46799
  },
45576
46800
  space_key: {
45577
- description: 'Key of the space for the resource.',
46801
+ description: 'Your unique identifier for the space.',
45578
46802
  type: 'string',
45579
46803
  },
45580
46804
  },
45581
- required: ['space_key', 'name'],
46805
+ required: ['name', 'space_key'],
45582
46806
  type: 'object',
45583
- 'x-route-path': '/unstable_partner/resources',
45584
- 'x-undocumented': 'Unreleased.',
45585
46807
  },
45586
46808
  type: 'array',
45587
46809
  },
@@ -45696,30 +46918,18 @@ export default {
45696
46918
  spaces: {
45697
46919
  description: 'Optional list of spaces that you want to include in the new building block magic link.',
45698
46920
  items: {
45699
- description: 'Represents a partner resource that enables you to send your space resources to Seam.',
45700
46921
  properties: {
45701
- custom_metadata: {
45702
- additionalProperties: { type: 'string' },
45703
- description: 'Custom metadata associated with the space resource.',
45704
- type: 'object',
45705
- },
45706
- description: {
45707
- description: 'Description of the space resource.',
45708
- type: 'string',
45709
- },
45710
46922
  name: {
45711
- description: 'Name of the space resource.',
46923
+ description: 'Your display name for this location resource.',
45712
46924
  type: 'string',
45713
46925
  },
45714
46926
  space_key: {
45715
- description: 'Key of the space for the resource.',
46927
+ description: 'Your unique identifier for the space.',
45716
46928
  type: 'string',
45717
46929
  },
45718
46930
  },
45719
- required: ['space_key', 'name'],
46931
+ required: ['name', 'space_key'],
45720
46932
  type: 'object',
45721
- 'x-route-path': '/unstable_partner/resources',
45722
- 'x-undocumented': 'Unreleased.',
45723
46933
  },
45724
46934
  type: 'array',
45725
46935
  },
@@ -45764,169 +46974,6 @@ export default {
45764
46974
  'x-undocumented': 'Experimental partner building blocks.',
45765
46975
  },
45766
46976
  },
45767
- '/unstable_partner/resources/push': {
45768
- post: {
45769
- description: 'Sends Seam some of your resources.',
45770
- operationId: 'unstablePartnerResourcesPushPost',
45771
- requestBody: {
45772
- content: {
45773
- 'application/json': {
45774
- schema: {
45775
- oneOf: [
45776
- {
45777
- items: {
45778
- description: 'Represents a partner resource that enables you to send your user identity and access grant resources to Seam.',
45779
- properties: {
45780
- custom_metadata: {
45781
- additionalProperties: { type: 'string' },
45782
- description: 'Custom metadata associated with the partner resource.',
45783
- type: 'object',
45784
- },
45785
- customer_key: {
45786
- description: 'Customer key associated with the resource that you want to push to Seam.',
45787
- type: 'string',
45788
- },
45789
- description: {
45790
- description: 'Description of the partner resource.',
45791
- type: 'string',
45792
- },
45793
- email_address: {
45794
- description: 'Email address associated with the user identity partner resource.',
45795
- type: 'string',
45796
- },
45797
- ends_at: {
45798
- description: 'Ending date and time associated with the access grant partner resource.',
45799
- type: 'string',
45800
- },
45801
- location_keys: {
45802
- description: 'Location keys associated with the access grant partner resource.',
45803
- items: { type: 'string' },
45804
- type: 'array',
45805
- },
45806
- name: {
45807
- description: 'Name of the partner resource.',
45808
- type: 'string',
45809
- },
45810
- partner_resource_key: {
45811
- description: 'Key of the resource that you want to push to Seam.',
45812
- type: 'string',
45813
- },
45814
- partner_resource_type: {
45815
- description: 'Type of the resource that you want to push to Seam.',
45816
- type: 'string',
45817
- },
45818
- phone_number: {
45819
- description: 'Phone number associated with the user identity partner resource.',
45820
- type: 'string',
45821
- },
45822
- starts_at: {
45823
- description: 'Starting date and time associated with the access grant partner resource.',
45824
- type: 'string',
45825
- },
45826
- user_identity_key: {
45827
- description: 'User identity key associated with the access grant partner resource.',
45828
- type: 'string',
45829
- },
45830
- },
45831
- type: 'object',
45832
- 'x-route-path': '/unstable_partner/resources',
45833
- 'x-undocumented': 'Unreleased.',
45834
- },
45835
- type: 'array',
45836
- },
45837
- {
45838
- description: 'Represents a partner resource that enables you to send your user identity and access grant resources to Seam.',
45839
- properties: {
45840
- custom_metadata: {
45841
- additionalProperties: { type: 'string' },
45842
- description: 'Custom metadata associated with the partner resource.',
45843
- type: 'object',
45844
- },
45845
- customer_key: {
45846
- description: 'Customer key associated with the resource that you want to push to Seam.',
45847
- type: 'string',
45848
- },
45849
- description: {
45850
- description: 'Description of the partner resource.',
45851
- type: 'string',
45852
- },
45853
- email_address: {
45854
- description: 'Email address associated with the user identity partner resource.',
45855
- type: 'string',
45856
- },
45857
- ends_at: {
45858
- description: 'Ending date and time associated with the access grant partner resource.',
45859
- type: 'string',
45860
- },
45861
- location_keys: {
45862
- description: 'Location keys associated with the access grant partner resource.',
45863
- items: { type: 'string' },
45864
- type: 'array',
45865
- },
45866
- name: {
45867
- description: 'Name of the partner resource.',
45868
- type: 'string',
45869
- },
45870
- partner_resource_key: {
45871
- description: 'Key of the resource that you want to push to Seam.',
45872
- type: 'string',
45873
- },
45874
- partner_resource_type: {
45875
- description: 'Type of the resource that you want to push to Seam.',
45876
- type: 'string',
45877
- },
45878
- phone_number: {
45879
- description: 'Phone number associated with the user identity partner resource.',
45880
- type: 'string',
45881
- },
45882
- starts_at: {
45883
- description: 'Starting date and time associated with the access grant partner resource.',
45884
- type: 'string',
45885
- },
45886
- user_identity_key: {
45887
- description: 'User identity key associated with the access grant partner resource.',
45888
- type: 'string',
45889
- },
45890
- },
45891
- type: 'object',
45892
- 'x-route-path': '/unstable_partner/resources',
45893
- 'x-undocumented': 'Unreleased.',
45894
- },
45895
- ],
45896
- },
45897
- },
45898
- },
45899
- },
45900
- responses: {
45901
- 200: {
45902
- content: {
45903
- 'application/json': {
45904
- schema: {
45905
- properties: { ok: { type: 'boolean' } },
45906
- required: ['ok'],
45907
- type: 'object',
45908
- },
45909
- },
45910
- },
45911
- description: 'OK',
45912
- },
45913
- 400: { description: 'Bad Request' },
45914
- 401: { description: 'Unauthorized' },
45915
- },
45916
- security: [
45917
- { pat_with_workspace: [] },
45918
- { console_session_with_workspace: [] },
45919
- { api_key: [] },
45920
- ],
45921
- summary: '/unstable_partner/resources/push',
45922
- tags: [],
45923
- 'x-fern-sdk-group-name': ['unstable_partner', 'resources'],
45924
- 'x-fern-sdk-method-name': 'push',
45925
- 'x-response-key': null,
45926
- 'x-title': 'Push Partner Resources at Seam',
45927
- 'x-undocumented': 'Experimental partner resources.',
45928
- },
45929
- },
45930
46977
  '/user_identities/add_acs_user': {
45931
46978
  post: {
45932
46979
  description: 'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',