@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
@@ -19493,6 +19493,8 @@ export interface Routes {
19493
19493
  custom_metadata: Record<string, string | boolean>;
19494
19494
  /** 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. */
19495
19495
  automatically_manage_new_devices: boolean;
19496
+ /** Your unique key for the customer associated with this connected account. */
19497
+ customer_key?: string | undefined;
19496
19498
  };
19497
19499
  };
19498
19500
  };
@@ -19637,6 +19639,8 @@ export interface Routes {
19637
19639
  custom_metadata: Record<string, string | boolean>;
19638
19640
  /** 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. */
19639
19641
  automatically_manage_new_devices: boolean;
19642
+ /** Your unique key for the customer associated with this connected account. */
19643
+ customer_key?: string | undefined;
19640
19644
  }>;
19641
19645
  /** Information about the current page of results. */
19642
19646
  pagination: {
@@ -19800,6 +19804,8 @@ export interface Routes {
19800
19804
  custom_metadata: Record<string, string | boolean>;
19801
19805
  /** 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. */
19802
19806
  automatically_manage_new_devices: boolean;
19807
+ /** Your unique key for the customer associated with this connected account. */
19808
+ customer_key?: string | undefined;
19803
19809
  };
19804
19810
  };
19805
19811
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.415.0",
3
+ "version": "1.416.1",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -120,6 +120,7 @@ export const unmanaged_acs_access_group = common_acs_access_group.extend({
120
120
  }).describe(`
121
121
  ---
122
122
  route_path: /acs/access_groups/unmanaged
123
+ undocumented: Unreleased.
123
124
  ---
124
125
  `)
125
126
 
@@ -17,6 +17,7 @@ export const acs_credential_pool = z.object({
17
17
  }).describe(`
18
18
  ---
19
19
  route_path: /acs/credential_pools
20
+ undocumented: Will be removed.
20
21
  ---
21
22
  `)
22
23
 
@@ -9,6 +9,7 @@ export const acs_credential_provisioning_automation = z.object({
9
9
  }).describe(`
10
10
  ---
11
11
  route_path: /acs/credential_provisioning_automations
12
+ undocumented: Will be removed.
12
13
  ---
13
14
  `)
14
15
 
@@ -304,6 +304,7 @@ export const unmanaged_acs_credential = common_acs_credential.merge(
304
304
  ).describe(`
305
305
  ---
306
306
  route_path: /acs/credentials/unmanaged
307
+ undocumented: Unreleased.
307
308
  ---
308
309
  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.
309
310
  `)
@@ -336,6 +336,7 @@ export const unmanaged_acs_user = common_acs_user.merge(
336
336
  ).describe(`
337
337
  ---
338
338
  route_path: /acs/users/unmanaged
339
+ undocumented: Unreleased.
339
340
  ---
340
341
  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).
341
342
  `)
@@ -302,6 +302,12 @@ export const connected_account = z.object({
302
302
  .describe(
303
303
  '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.',
304
304
  ),
305
+ customer_key: z
306
+ .string()
307
+ .optional()
308
+ .describe(
309
+ 'Your unique key for the customer associated with this connected account.',
310
+ ),
305
311
  }).describe(`
306
312
  ---
307
313
  route_path: /connected_accounts
@@ -2238,6 +2238,7 @@ export default {
2238
2238
  ],
2239
2239
  type: 'object',
2240
2240
  'x-route-path': '/acs/credential_pools',
2241
+ 'x-undocumented': 'Will be removed.',
2241
2242
  },
2242
2243
  acs_credential_provisioning_automation: {
2243
2244
  properties: {
@@ -2259,6 +2260,7 @@ export default {
2259
2260
  ],
2260
2261
  type: 'object',
2261
2262
  'x-route-path': '/acs/credential_provisioning_automations',
2263
+ 'x-undocumented': 'Will be removed.',
2262
2264
  },
2263
2265
  acs_encoder: {
2264
2266
  description:
@@ -4736,6 +4738,7 @@ export default {
4736
4738
  ],
4737
4739
  type: 'object',
4738
4740
  'x-route-path': '/acs/credentials/unmanaged',
4741
+ 'x-undocumented': 'Unreleased.',
4739
4742
  },
4740
4743
  ],
4741
4744
  'x-route-path': '/acs/credentials',
@@ -5927,6 +5930,7 @@ export default {
5927
5930
  ],
5928
5931
  type: 'object',
5929
5932
  'x-route-path': '/acs/credentials/unmanaged',
5933
+ 'x-undocumented': 'Unreleased.',
5930
5934
  },
5931
5935
  ],
5932
5936
  },
@@ -7690,6 +7694,11 @@ export default {
7690
7694
  '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.',
7691
7695
  type: 'object',
7692
7696
  },
7697
+ customer_key: {
7698
+ description:
7699
+ 'Your unique key for the customer associated with this connected account.',
7700
+ type: 'string',
7701
+ },
7693
7702
  errors: {
7694
7703
  description: 'Errors associated with the connected account.',
7695
7704
  items: {
@@ -19090,6 +19099,7 @@ export default {
19090
19099
  ],
19091
19100
  type: 'object',
19092
19101
  'x-route-path': '/acs/access_groups/unmanaged',
19102
+ 'x-undocumented': 'Unreleased.',
19093
19103
  },
19094
19104
  unmanaged_acs_credential: {
19095
19105
  description:
@@ -19452,6 +19462,7 @@ export default {
19452
19462
  ],
19453
19463
  type: 'object',
19454
19464
  'x-route-path': '/acs/credentials/unmanaged',
19465
+ 'x-undocumented': 'Unreleased.',
19455
19466
  },
19456
19467
  unmanaged_acs_user: {
19457
19468
  description:
@@ -20109,6 +20120,7 @@ export default {
20109
20120
  ],
20110
20121
  type: 'object',
20111
20122
  'x-route-path': '/acs/users/unmanaged',
20123
+ 'x-undocumented': 'Unreleased.',
20112
20124
  },
20113
20125
  unmanaged_device: {
20114
20126
  description:
@@ -22568,6 +22568,8 @@ export interface Routes {
22568
22568
  custom_metadata: Record<string, string | boolean>
22569
22569
  /** 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. */
22570
22570
  automatically_manage_new_devices: boolean
22571
+ /** Your unique key for the customer associated with this connected account. */
22572
+ customer_key?: string | undefined
22571
22573
  }
22572
22574
  }
22573
22575
  }
@@ -22723,6 +22725,8 @@ export interface Routes {
22723
22725
  custom_metadata: Record<string, string | boolean>
22724
22726
  /** 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. */
22725
22727
  automatically_manage_new_devices: boolean
22728
+ /** Your unique key for the customer associated with this connected account. */
22729
+ customer_key?: string | undefined
22726
22730
  }>
22727
22731
  /** Information about the current page of results. */
22728
22732
  pagination: {
@@ -22897,6 +22901,8 @@ export interface Routes {
22897
22901
  custom_metadata: Record<string, string | boolean>
22898
22902
  /** 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. */
22899
22903
  automatically_manage_new_devices: boolean
22904
+ /** Your unique key for the customer associated with this connected account. */
22905
+ customer_key?: string | undefined
22900
22906
  }
22901
22907
  }
22902
22908
  }