@seamapi/types 1.1116.0 → 1.1117.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.
@@ -55313,7 +55313,7 @@ export type Routes = {
55313
55313
  /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
55314
55314
  reason?: {
55315
55315
  /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
55316
- reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
55316
+ reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error' | 'connection_error';
55317
55317
  /** Human-readable explanation of why access was denied. */
55318
55318
  message: string;
55319
55319
  } | undefined;
@@ -58948,7 +58948,7 @@ export type Routes = {
58948
58948
  /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
58949
58949
  reason?: {
58950
58950
  /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
58951
- reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
58951
+ reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error' | 'connection_error';
58952
58952
  /** Human-readable explanation of why access was denied. */
58953
58953
  message: string;
58954
58954
  } | undefined;
@@ -95475,7 +95475,7 @@ export type Routes = {
95475
95475
  /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
95476
95476
  reason?: {
95477
95477
  /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
95478
- reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
95478
+ reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error' | 'connection_error';
95479
95479
  /** Human-readable explanation of why access was denied. */
95480
95480
  message: string;
95481
95481
  } | undefined;
@@ -97286,6 +97286,25 @@ export type Routes = {
97286
97286
  };
97287
97287
  maxDuration: undefined;
97288
97288
  };
97289
+ '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result': {
97290
+ route: '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result';
97291
+ method: 'POST';
97292
+ queryParams: {};
97293
+ jsonBody: {
97294
+ acs_credential_id: string;
97295
+ unlock_attempted_at: string;
97296
+ };
97297
+ commonParams: {};
97298
+ formData: {};
97299
+ jsonResponse: {
97300
+ unlock_result: {
97301
+ status: 'granted' | 'denied' | 'pending' | 'failed';
97302
+ acs_entrance_id?: string | undefined;
97303
+ occurred_at?: string | undefined;
97304
+ };
97305
+ };
97306
+ maxDuration: undefined;
97307
+ };
97289
97308
  '/seam/mobile_sdk/v1/acs/credentials/list': {
97290
97309
  route: '/seam/mobile_sdk/v1/acs/credentials/list';
97291
97310
  method: 'GET' | 'POST';
@@ -101170,7 +101189,7 @@ export type Routes = {
101170
101189
  /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
101171
101190
  reason?: {
101172
101191
  /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
101173
- reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
101192
+ reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error' | 'connection_error';
101174
101193
  /** Human-readable explanation of why access was denied. */
101175
101194
  message: string;
101176
101195
  } | undefined;
@@ -158137,7 +158156,7 @@ export type Routes = {
158137
158156
  /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
158138
158157
  reason?: {
158139
158158
  /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
158140
- reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
158159
+ reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error' | 'connection_error';
158141
158160
  /** Human-readable explanation of why access was denied. */
158142
158161
  message: string;
158143
158162
  } | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1116.0",
3
+ "version": "1.1117.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -65,6 +65,7 @@ export const lock_access_denied_reason = z
65
65
  'too_many_attempts',
66
66
  'blocked_by_privacy_mode',
67
67
  'credential_error',
68
+ 'connection_error',
68
69
  ])
69
70
  .describe(
70
71
  'Normalized reason a lock denied access. Provider-agnostic; not all providers report every value.',
@@ -29761,6 +29761,7 @@ const openapi: OpenAPISpec = {
29761
29761
  'too_many_attempts',
29762
29762
  'blocked_by_privacy_mode',
29763
29763
  'credential_error',
29764
+ 'connection_error',
29764
29765
  ],
29765
29766
  type: 'string',
29766
29767
  },
@@ -69399,6 +69400,72 @@ const openapi: OpenAPISpec = {
69399
69400
  'x-undocumented': 'Seam support agent only.',
69400
69401
  },
69401
69402
  },
69403
+ '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result': {
69404
+ post: {
69405
+ description:
69406
+ "Returns the lock's decision for a mobile key unlock attempt, read from the access system's event feed. Returns `pending` until the access system reports the attempt, and `failed` if it hasn't within 30 seconds of the attempt.",
69407
+ operationId: 'seamMobileSdkV1AcsCredentialsGetUnlockResultPost',
69408
+ requestBody: {
69409
+ content: {
69410
+ 'application/json': {
69411
+ schema: {
69412
+ properties: {
69413
+ acs_credential_id: { format: 'uuid', type: 'string' },
69414
+ unlock_attempted_at: { format: 'date-time', type: 'string' },
69415
+ },
69416
+ required: ['acs_credential_id', 'unlock_attempted_at'],
69417
+ type: 'object',
69418
+ },
69419
+ },
69420
+ },
69421
+ },
69422
+ responses: {
69423
+ '200': {
69424
+ content: {
69425
+ 'application/json': {
69426
+ schema: {
69427
+ properties: {
69428
+ ok: { type: 'boolean' },
69429
+ unlock_result: {
69430
+ properties: {
69431
+ acs_entrance_id: { format: 'uuid', type: 'string' },
69432
+ occurred_at: { format: 'date-time', type: 'string' },
69433
+ status: {
69434
+ enum: ['granted', 'denied', 'pending', 'failed'],
69435
+ type: 'string',
69436
+ },
69437
+ },
69438
+ required: ['status'],
69439
+ type: 'object',
69440
+ },
69441
+ },
69442
+ required: ['unlock_result', 'ok'],
69443
+ type: 'object',
69444
+ },
69445
+ },
69446
+ },
69447
+ description: 'OK',
69448
+ },
69449
+ '400': { description: 'Bad Request' },
69450
+ '401': { description: 'Unauthorized' },
69451
+ },
69452
+ security: [{ client_session: [] }],
69453
+ summary: '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result',
69454
+ tags: ['/acs'],
69455
+ 'x-fern-sdk-group-name': [
69456
+ 'seam',
69457
+ 'mobile_sdk',
69458
+ 'v1',
69459
+ 'acs',
69460
+ 'credentials',
69461
+ ],
69462
+ 'x-fern-sdk-method-name': 'get_unlock_result',
69463
+ 'x-fern-sdk-return-value': 'unlock_result',
69464
+ 'x-response-key': 'unlock_result',
69465
+ 'x-title': 'Get Unlock Result',
69466
+ 'x-undocumented': 'Mobile SDK only.',
69467
+ },
69468
+ },
69402
69469
  '/seam/mobile_sdk/v1/acs/credentials/list': {
69403
69470
  get: {
69404
69471
  description:
@@ -66511,6 +66511,7 @@ export type Routes = {
66511
66511
  | 'too_many_attempts'
66512
66512
  | 'blocked_by_privacy_mode'
66513
66513
  | 'credential_error'
66514
+ | 'connection_error'
66514
66515
  /** Human-readable explanation of why access was denied. */
66515
66516
  message: string
66516
66517
  }
@@ -70811,6 +70812,7 @@ export type Routes = {
70811
70812
  | 'too_many_attempts'
70812
70813
  | 'blocked_by_privacy_mode'
70813
70814
  | 'credential_error'
70815
+ | 'connection_error'
70814
70816
  /** Human-readable explanation of why access was denied. */
70815
70817
  message: string
70816
70818
  }
@@ -114023,6 +114025,7 @@ export type Routes = {
114023
114025
  | 'too_many_attempts'
114024
114026
  | 'blocked_by_privacy_mode'
114025
114027
  | 'credential_error'
114028
+ | 'connection_error'
114026
114029
  /** Human-readable explanation of why access was denied. */
114027
114030
  message: string
114028
114031
  }
@@ -116093,6 +116096,25 @@ export type Routes = {
116093
116096
  }
116094
116097
  maxDuration: undefined
116095
116098
  }
116099
+ '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result': {
116100
+ route: '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result'
116101
+ method: 'POST'
116102
+ queryParams: {}
116103
+ jsonBody: {
116104
+ acs_credential_id: string
116105
+ unlock_attempted_at: string
116106
+ }
116107
+ commonParams: {}
116108
+ formData: {}
116109
+ jsonResponse: {
116110
+ unlock_result: {
116111
+ status: 'granted' | 'denied' | 'pending' | 'failed'
116112
+ acs_entrance_id?: string | undefined
116113
+ occurred_at?: string | undefined
116114
+ }
116115
+ }
116116
+ maxDuration: undefined
116117
+ }
116096
116118
  '/seam/mobile_sdk/v1/acs/credentials/list': {
116097
116119
  route: '/seam/mobile_sdk/v1/acs/credentials/list'
116098
116120
  method: 'GET' | 'POST'
@@ -120711,6 +120733,7 @@ export type Routes = {
120711
120733
  | 'too_many_attempts'
120712
120734
  | 'blocked_by_privacy_mode'
120713
120735
  | 'credential_error'
120736
+ | 'connection_error'
120714
120737
  /** Human-readable explanation of why access was denied. */
120715
120738
  message: string
120716
120739
  }
@@ -187764,6 +187787,7 @@ export type Routes = {
187764
187787
  | 'too_many_attempts'
187765
187788
  | 'blocked_by_privacy_mode'
187766
187789
  | 'credential_error'
187790
+ | 'connection_error'
187767
187791
  /** Human-readable explanation of why access was denied. */
187768
187792
  message: string
187769
187793
  }