@seamapi/types 1.415.0 → 1.416.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 (30) hide show
  1. package/dist/connect.cjs +24 -7
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +492 -6
  4. package/lib/seam/connect/models/acs/acs-access-group.js +1 -0
  5. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-credential-pool.js +1 -0
  7. package/lib/seam/connect/models/acs/acs-credential-pool.js.map +1 -1
  8. package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js +1 -0
  9. package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-credential.js +1 -0
  11. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  12. package/lib/seam/connect/models/acs/acs-users/acs-user.js +1 -0
  13. package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
  14. package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +3 -0
  15. package/lib/seam/connect/models/connected-accounts/connected-account.js +4 -0
  16. package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
  17. package/lib/seam/connect/models/partner/magic-link.d.ts +2 -2
  18. package/lib/seam/connect/openapi.d.ts +481 -4
  19. package/lib/seam/connect/openapi.js +11 -0
  20. package/lib/seam/connect/openapi.js.map +1 -1
  21. package/lib/seam/connect/route-types.d.ts +6 -0
  22. package/package.json +1 -1
  23. package/src/lib/seam/connect/models/acs/acs-access-group.ts +1 -0
  24. package/src/lib/seam/connect/models/acs/acs-credential-pool.ts +1 -0
  25. package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts +1 -0
  26. package/src/lib/seam/connect/models/acs/acs-credential.ts +1 -0
  27. package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +1 -0
  28. package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +6 -0
  29. package/src/lib/seam/connect/openapi.ts +12 -0
  30. package/src/lib/seam/connect/route-types.ts +6 -0
package/dist/connect.cjs CHANGED
@@ -849,6 +849,9 @@ var connected_account = zod.z.object({
849
849
  custom_metadata,
850
850
  automatically_manage_new_devices: zod.z.boolean().describe(
851
851
  "Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API."
852
+ ),
853
+ customer_key: zod.z.string().optional().describe(
854
+ "Your unique key for the customer associated with this connected account."
852
855
  )
853
856
  }).describe(`
854
857
  ---
@@ -2452,6 +2455,7 @@ var unmanaged_acs_access_group = common_acs_access_group.extend({
2452
2455
  }).describe(`
2453
2456
  ---
2454
2457
  route_path: /acs/access_groups/unmanaged
2458
+ undocumented: Unreleased.
2455
2459
  ---
2456
2460
  `);
2457
2461
  var acs_entrance_assa_abloy_vostio_metadata = zod.z.object({
@@ -2688,6 +2692,7 @@ var unmanaged_acs_credential = common_acs_credential.merge(
2688
2692
  ).describe(`
2689
2693
  ---
2690
2694
  route_path: /acs/credentials/unmanaged
2695
+ undocumented: Unreleased.
2691
2696
  ---
2692
2697
  Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The \`unmanaged_acs_credential\` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each \`acs_credential\` object, you define the access method. You can also specify additional properties, such as a PIN code.
2693
2698
  `);
@@ -3379,6 +3384,7 @@ var unmanaged_acs_user = common_acs_user.merge(
3379
3384
  ).describe(`
3380
3385
  ---
3381
3386
  route_path: /acs/users/unmanaged
3387
+ undocumented: Unreleased.
3382
3388
  ---
3383
3389
  Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
3384
3390
  `);
@@ -7177,7 +7183,8 @@ var openapi_default = {
7177
7183
  "workspace_id"
7178
7184
  ],
7179
7185
  type: "object",
7180
- "x-route-path": "/acs/credential_pools"
7186
+ "x-route-path": "/acs/credential_pools",
7187
+ "x-undocumented": "Will be removed."
7181
7188
  },
7182
7189
  acs_credential_provisioning_automation: {
7183
7190
  properties: {
@@ -7198,7 +7205,8 @@ var openapi_default = {
7198
7205
  "workspace_id"
7199
7206
  ],
7200
7207
  type: "object",
7201
- "x-route-path": "/acs/credential_provisioning_automations"
7208
+ "x-route-path": "/acs/credential_provisioning_automations",
7209
+ "x-undocumented": "Will be removed."
7202
7210
  },
7203
7211
  acs_encoder: {
7204
7212
  description: "Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSome access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:\n\n1. Credential creation\n Configure the access parameters for the credential.\n2. Card encoding\n Write the credential data onto the card using a compatible card encoder.\n\nSeparately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.\n\n See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).\n\nTo verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).",
@@ -9395,7 +9403,8 @@ var openapi_default = {
9395
9403
  "is_managed"
9396
9404
  ],
9397
9405
  type: "object",
9398
- "x-route-path": "/acs/credentials/unmanaged"
9406
+ "x-route-path": "/acs/credentials/unmanaged",
9407
+ "x-undocumented": "Unreleased."
9399
9408
  }
9400
9409
  ],
9401
9410
  "x-route-path": "/acs/credentials"
@@ -10454,7 +10463,8 @@ var openapi_default = {
10454
10463
  "is_managed"
10455
10464
  ],
10456
10465
  type: "object",
10457
- "x-route-path": "/acs/credentials/unmanaged"
10466
+ "x-route-path": "/acs/credentials/unmanaged",
10467
+ "x-undocumented": "Unreleased."
10458
10468
  }
10459
10469
  ]
10460
10470
  },
@@ -12129,6 +12139,10 @@ var openapi_default = {
12129
12139
  description: "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.",
12130
12140
  type: "object"
12131
12141
  },
12142
+ customer_key: {
12143
+ description: "Your unique key for the customer associated with this connected account.",
12144
+ type: "string"
12145
+ },
12132
12146
  errors: {
12133
12147
  description: "Errors associated with the connected account.",
12134
12148
  items: {
@@ -22592,7 +22606,8 @@ var openapi_default = {
22592
22606
  "is_managed"
22593
22607
  ],
22594
22608
  type: "object",
22595
- "x-route-path": "/acs/access_groups/unmanaged"
22609
+ "x-route-path": "/acs/access_groups/unmanaged",
22610
+ "x-undocumented": "Unreleased."
22596
22611
  },
22597
22612
  unmanaged_acs_credential: {
22598
22613
  description: "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.",
@@ -22904,7 +22919,8 @@ var openapi_default = {
22904
22919
  "is_managed"
22905
22920
  ],
22906
22921
  type: "object",
22907
- "x-route-path": "/acs/credentials/unmanaged"
22922
+ "x-route-path": "/acs/credentials/unmanaged",
22923
+ "x-undocumented": "Unreleased."
22908
22924
  },
22909
22925
  unmanaged_acs_user: {
22910
22926
  description: "Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
@@ -23494,7 +23510,8 @@ var openapi_default = {
23494
23510
  "is_managed"
23495
23511
  ],
23496
23512
  type: "object",
23497
- "x-route-path": "/acs/users/unmanaged"
23513
+ "x-route-path": "/acs/users/unmanaged",
23514
+ "x-undocumented": "Unreleased."
23498
23515
  },
23499
23516
  unmanaged_device: {
23500
23517
  description: "Represents an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).",