@seamapi/types 1.302.1 → 1.303.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.302.1",
3
+ "version": "1.303.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -116,6 +116,12 @@ const common_acs_credential = z.object({
116
116
  .optional()
117
117
  .nullable()
118
118
  .describe('Access (PIN) code for the credential.'),
119
+ is_one_time_use: z
120
+ .boolean()
121
+ .optional()
122
+ .describe(
123
+ 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
124
+ ),
119
125
  card_number: z.string().optional().nullable(),
120
126
  is_issued: z.boolean().optional(),
121
127
  issued_at: z.string().datetime().optional().nullable(),
@@ -352,6 +352,11 @@ export default {
352
352
  'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
353
353
  type: 'boolean',
354
354
  },
355
+ is_one_time_use: {
356
+ description:
357
+ 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
358
+ type: 'boolean',
359
+ },
355
360
  issued_at: { format: 'date-time', nullable: true, type: 'string' },
356
361
  latest_desired_state_synced_with_provider_at: {
357
362
  description:
@@ -1717,6 +1722,11 @@ export default {
1717
1722
  'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
1718
1723
  type: 'boolean',
1719
1724
  },
1725
+ is_one_time_use: {
1726
+ description:
1727
+ 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
1728
+ type: 'boolean',
1729
+ },
1720
1730
  issued_at: {
1721
1731
  format: 'date-time',
1722
1732
  nullable: true,
@@ -2010,6 +2020,11 @@ export default {
2010
2020
  'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
2011
2021
  type: 'boolean',
2012
2022
  },
2023
+ is_one_time_use: {
2024
+ description:
2025
+ 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
2026
+ type: 'boolean',
2027
+ },
2013
2028
  issued_at: {
2014
2029
  format: 'date-time',
2015
2030
  nullable: true,
@@ -2430,6 +2445,11 @@ export default {
2430
2445
  'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
2431
2446
  type: 'boolean',
2432
2447
  },
2448
+ is_one_time_use: {
2449
+ description:
2450
+ 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
2451
+ type: 'boolean',
2452
+ },
2433
2453
  issued_at: {
2434
2454
  format: 'date-time',
2435
2455
  nullable: true,
@@ -2722,6 +2742,11 @@ export default {
2722
2742
  'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
2723
2743
  type: 'boolean',
2724
2744
  },
2745
+ is_one_time_use: {
2746
+ description:
2747
+ 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
2748
+ type: 'boolean',
2749
+ },
2725
2750
  issued_at: {
2726
2751
  format: 'date-time',
2727
2752
  nullable: true,
@@ -7153,6 +7178,8 @@ export default {
7153
7178
  },
7154
7179
  '/access_codes/pull_backup_access_code': {
7155
7180
  post: {
7181
+ description:
7182
+ 'Retrieves a backup access code for an access code. See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).',
7156
7183
  operationId: 'accessCodesPullBackupAccessCodePost',
7157
7184
  requestBody: {
7158
7185
  content: {
@@ -7173,12 +7200,13 @@ export default {
7173
7200
  'application/json': {
7174
7201
  schema: {
7175
7202
  properties: {
7203
+ access_code: { $ref: '#/components/schemas/access_code' },
7176
7204
  backup_access_code: {
7177
7205
  $ref: '#/components/schemas/access_code',
7178
7206
  },
7179
7207
  ok: { type: 'boolean' },
7180
7208
  },
7181
- required: ['backup_access_code', 'ok'],
7209
+ required: ['backup_access_code', 'access_code', 'ok'],
7182
7210
  type: 'object',
7183
7211
  },
7184
7212
  },
@@ -7198,8 +7226,8 @@ export default {
7198
7226
  tags: ['/access_codes'],
7199
7227
  'x-fern-sdk-group-name': ['access_codes'],
7200
7228
  'x-fern-sdk-method-name': 'pull_backup_access_code',
7201
- 'x-fern-sdk-return-value': 'backup_access_code',
7202
- 'x-response-key': 'backup_access_code',
7229
+ 'x-fern-sdk-return-value': 'access_code',
7230
+ 'x-response-key': 'access_code',
7203
7231
  },
7204
7232
  },
7205
7233
  '/access_codes/simulate/create_unmanaged_access_code': {
@@ -9049,7 +9077,7 @@ export default {
9049
9077
  type: 'string',
9050
9078
  },
9051
9079
  },
9052
- required: ['acs_user_id'],
9080
+ required: ['acs_user_id', 'allowed_acs_entrance_id'],
9053
9081
  type: 'object',
9054
9082
  },
9055
9083
  },
@@ -9633,6 +9661,11 @@ export default {
9633
9661
  'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
9634
9662
  type: 'boolean',
9635
9663
  },
9664
+ is_one_time_use: {
9665
+ description:
9666
+ 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
9667
+ type: 'boolean',
9668
+ },
9636
9669
  issued_at: {
9637
9670
  format: 'date-time',
9638
9671
  nullable: true,
@@ -10029,6 +10062,11 @@ export default {
10029
10062
  'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
10030
10063
  type: 'boolean',
10031
10064
  },
10065
+ is_one_time_use: {
10066
+ description:
10067
+ 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
10068
+ type: 'boolean',
10069
+ },
10032
10070
  issued_at: {
10033
10071
  format: 'date-time',
10034
10072
  nullable: true,